feat: initial structure

Author: rafamizes

.gitattributes

@@ -0,0 +1,34 @@
+# Auto detect text files and perform LF normalization
+*        text=auto
+
+# Always perform LF normalization on these files
+*.dart   text
+*.gradle text
+*.html   text
+*.java   text
+*.json   text
+*.md     text
+*.py     text
+*.sh     text
+*.txt    text
+*.xml    text
+*.yaml   text
+
+# Make sure that these Windows files always have CRLF line endings in checkout
+*.bat             text eol=crlf
+*.ps1             text eol=crlf
+*.rc              text eol=crlf
+*.sln             text eol=crlf
+*.props           text eol=crlf
+*.vcxproj         text eol=crlf
+*.vcxproj.filters text eol=crlf
+# Including templatized versions.
+*.sln.tmpl        text eol=crlf
+*.props.tmpl      text eol=crlf
+*.vcxproj.tmpl    text eol=crlf
+
+# Never perform LF normalization on these files
+*.ico    binary
+*.jar    binary
+*.png    binary
+*.zip    binary

.github/workflows/build.yml

@@ -0,0 +1,52 @@
+# Automates the process of testing, analyzing, checking the code format,
+# building, and deploying using Github Actions.
+name: Flutter CI
+
+# Controls when the action will run. 
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      # Java environment.
+      - uses: actions/setup-java@v1
+        with:
+          java-version: '12.x'
+      # Setup the flutter environment.
+      - uses: subosito/flutter-action@v1
+        with:
+          channel: 'stable'
+          
+      # Get flutter dependencies.
+      - run: flutter pub get
+    
+      # Check for any formatting issues in the code.
+      - run: flutter format --set-exit-if-changed lib/ test/
+    
+      # Statically analyze the Dart code for any errors.
+      - run: flutter analyze --no-current-package lib/ test/
+    
+      # Run widget tests for our flutter project.
+      - run: flutter test --no-pub --coverage
+      
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage/lcov.info

.gitignore

@@ -0,0 +1,46 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release

.metadata

@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 77d935af4db863f6abd0b9c31c7e6df2a13de57b
+  channel: stable
+
+project_type: app

.rultor.yml

@@ -0,0 +1,33 @@
+docker:
+  image: cirrusci/flutter:stable
+  as_root: true
+architect:
+  - rafamizes
+assets:
+  credentials.json: rafamizes/secret#assets/publishing/flutter/credentials.json
+merge:
+  rebase: true
+  script: |
+    flutter clean
+    flutter pub get
+    flutter format --set-exit-if-changed lib/ test/
+    flutter analyze --no-current-package lib/ test/
+    flutter test --no-pub --coverage
+    bash <(curl -s https://codecov.io/bash)
+    flutter pub publish --dry-run
+release:
+  # updates pubspec.yaml's version attribute to $tag;
+  # in CHANGELOG, places section '[$tag] - YYYY-mm-dd' under [Unreleaded];
+  # commits the $tag version and publishes to pub.dev;
+  # Rultor tags the lastest commit as $tag and push the new tag to the
+  # repository.
+  script: |-
+    sed -i "s/^\(version:\).*/\1 $tag/" pubspec.yaml
+    sed -i "/\[Unreleased\]/a\\\n## [$tag] - $(date '+%F')" CHANGELOG.md
+    mkdir -p ~/.pub-cache
+    mv ../credentials.json ~/.pub-cache/credentials.json
+    flutter pub publish -f
+    git commit -am "version $tag"
+    git checkout master
+    git merge __rultor
+    git checkout __rultor

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Dart Package Versioning](https://dart.dev/tools/pub/versioning).
+
+## [Unreleased]
+
+### Added
+
+- Initial structure
+  - set lint 1.8.2 as the linting package.
+  - set linting rules.
+  - scaffold code of MainPage, NewsPage, NotesPage, SettingsPage.
+  - README
+  - CHANGELOG
+  - .rultor.yml file for configuring the DevOps assistant [Rultor](https://doc.rultor.com/).
+  - build.yml file in .github/workflow to set up [GitHub Actions CI/CD](https://github.com/features/actions).
+
+## [0.0.1] - 2022-01-09

README.md

@@ -0,0 +1,42 @@
+# state_man_examples
+
+[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
+[![DevOps By Rultor.com](https://www.rultor.com/b/dartoos-dev/state_man_examples)](https://www.rultor.com/p/dartoos-dev/state_man_examples)
+
+[![pub](https://img.shields.io/pub/v/state_man_examples)](https://pub.dev/packages/state_man_examples)
+[![license](https://img.shields.io/badge/license-mit-green.svg)](https://github.com/dartoos-dev/state_man_examples/blob/master/LICENSE)
+[![build](https://github.com/dartoos-dev/state_man_examples/actions/workflows/build.yml/badge.svg)](https://github.com/dartoos-dev/state_man_examples/actions/)
+[![codecov](https://codecov.io/gh/dartoos-dev/state_man_examples/branch/master/graph/badge.svg?token=jYfO55O22s)](https://codecov.io/gh/dartoos-dev/state_man_examples)
+[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/rafamizes/state_man_examples)](https://www.codefactor.io/repository/github/rafamizes/state_man_examples)
+[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
+[![Hits-of-Code](https://hitsofcode.com/github/dartoos-dev/state_man_examples?branch=master)](https://hitsofcode.com/github/dartoos-dev/state_man_examples/view?branch=master)
+
+## Overview
+
+State Management Examples
+
+Simple application with several state managements approaches.
+
+This project is heavily inspired by the Bachelor's thesis of [Dmitrii Slepnev](https://github.com/sdim2016/flutter-state-management)
+
+## Getting Started
+
+The application has 3 features:
+
+- Some pages with bottom navigation; the Settings page allows us to
+  see the immediate effect of a state change, which affects the entire
+  application.
+- Local persistence.
+- Simple remote API calls — GET requests are enough for the showcase.
+
+In this way, the application does not need to solve any real-world problems, it
+aims to demonstrate how some state management approaches work from a technical
+point of view.
+
+The UI is created once for all apps, as well as the classes from the data access
+layer (local persistence, remote API calls). The only thing that will change is
+the state management approach.
+
+## References
+
+[State Management in Flutter — Dmitrii Slepnev](https://www.theseus.fi/handle/10024/355086).

analysis_options.yaml

@@ -0,0 +1,24 @@
+include: package:lint/analysis_options_package.yaml
+analyzer:
+  strong-mode:
+    # A value of false ensures that the type inference engine never implicitly casts
+    # from dynamic to a more specific type.
+    implicit-casts: false
+    # A value of false ensures that the type inference engine never chooses the
+    # dynamic type when it can’t determine a static type.
+    # implicit-dynamic: false
+linter:
+  rules:
+    # Make constructors the first thing in every class
+    sort_constructors_first: true
+    # Good packages document everything
+    public_member_api_docs: true
+    # Always await.
+    # unawaited_futures: true
+    # It's a good practice to expose the ability to provide a key when creating public widgets.
+    use_key_in_widget_constructors: true
+    always_declare_return_types: true
+    cancel_subscriptions: true
+    close_sinks: true
+    only_throw_errors: true
+    package_api_docs: true

android/.gitignore

@@ -0,0 +1,13 @@
+gradle-wrapper.jar
+/.gradle
+/captures/
+/gradlew
+/gradlew.bat
+/local.properties
+GeneratedPluginRegistrant.java
+
+# Remember to never publicly share your keystore.
+# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
+key.properties
+**/*.keystore
+**/*.jks

android/app/build.gradle

@@ -0,0 +1,68 @@
+def localProperties = new Properties()
+def localPropertiesFile = rootProject.file('local.properties')
+if (localPropertiesFile.exists()) {
+    localPropertiesFile.withReader('UTF-8') { reader ->
+        localProperties.load(reader)
+    }
+}
+
+def flutterRoot = localProperties.getProperty('flutter.sdk')
+if (flutterRoot == null) {
+    throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
+}
+
+def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
+if (flutterVersionCode == null) {
+    flutterVersionCode = '1'
+}
+
+def flutterVersionName = localProperties.getProperty('flutter.versionName')
+if (flutterVersionName == null) {
+    flutterVersionName = '1.0'
+}
+
+apply plugin: 'com.android.application'
+apply plugin: 'kotlin-android'
+apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
+
+android {
+    compileSdkVersion flutter.compileSdkVersion
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
+    defaultConfig {
+        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+        applicationId "dev.dartoos.state_man_examples"
+        minSdkVersion flutter.minSdkVersion
+        targetSdkVersion flutter.targetSdkVersion
+        versionCode flutterVersionCode.toInteger()
+        versionName flutterVersionName
+    }
+
+    buildTypes {
+        release {
+            // TODO: Add your own signing config for the release build.
+            // Signing with the debug keys for now, so `flutter run --release` works.
+            signingConfig signingConfigs.debug
+        }
+    }
+}
+
+flutter {
+    source '../..'
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}

android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="dev.dartoos.state_man_examples">
+    <!-- Flutter needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

android/app/src/main/AndroidManifest.xml

@@ -0,0 +1,34 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="dev.dartoos.state_man_examples">
+   <application
+        android:label="state_man_examples"
+        android:name="${applicationName}"
+        android:icon="@mipmap/ic_launcher">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:launchMode="singleTop"
+            android:theme="@style/LaunchTheme"
+            android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
+            android:hardwareAccelerated="true"
+            android:windowSoftInputMode="adjustResize">
+            <!-- Specifies an Android theme to apply to this Activity as soon as
+                 the Android process has started. This theme is visible to the user
+                 while the Flutter UI initializes. After that, this theme continues
+                 to determine the Window background behind the Flutter UI. -->
+            <meta-data
+              android:name="io.flutter.embedding.android.NormalTheme"
+              android:resource="@style/NormalTheme"
+              />
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN"/>
+                <category android:name="android.intent.category.LAUNCHER"/>
+            </intent-filter>
+        </activity>
+        <!-- Don't delete the meta-data below.
+             This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
+        <meta-data
+            android:name="flutterEmbedding"
+            android:value="2" />
+    </application>
+</manifest>