build: structural configurations

Author: rultor

.github/workflows/build.yml

@@ -2,11 +2,11 @@
 # building, and deploying using Github Actions.
 name: Flutter CI
 
-# Controls when the action will run. 
+# 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 ]
+    branches: [master]
   pull_request:
 
   # Allows you to run this workflow manually from the Actions tab
@@ -31,19 +31,14 @@ jobs:
       - 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/ example/
-    
       # Statically analyze the Dart code for any errors.
       - run: flutter analyze --no-current-package lib/ test/ example/
-    
       # Run widget tests for our flutter project.
       - run: flutter test --no-pub --coverage
-      
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:

.rultor.yml

@@ -21,9 +21,11 @@ release:
   # repository.
   script: |-
     sed -i "s/^\(version:\).*/\1 $tag/" pubspec.yaml
-    sed -i "/\[Unreleased\]/a\\\n## [$tag] - $(date '+%F')" CHANGELOG.md
+    sed -i "/\[[Uu]nreleased\]/a\\\n## [$tag] - $(date '+%F')" CHANGELOG.md
     mkdir -p ~/.pub-cache
     mv ../credentials.json ~/.pub-cache/credentials.json
+    flutter clean
+    flutter pub get
     flutter pub publish -f
     git commit -am "version $tag"
     git checkout master

CHANGELOG.md

@@ -8,4 +8,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 <!-- @todo #1 Describe initial release. -->
-## [0.1.0]
+
+## [0.0.1]

README.md

@@ -1,39 +1,51 @@
-## json_cache
+# json_cache
 
 <center>
   <img width="406" hight="192" alt="json cache logo" src="https://user-images.githubusercontent.com/24878574/119276278-56ef4a80-bbf0-11eb-8701-53a94f24f75b.png" align="middle">
 </center>
 
-[![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/json_cache)](https://www.rultor.com/p/dartoos-dev/json_cache)
+[![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/json_cache)](https://www.rultor.com/p/dartoos-dev/json_cache)
 
 [![pub](https://img.shields.io/pub/v/json_cache)](https://pub.dev/packages/json_cache)
 [![license](https://img.shields.io/badge/license-mit-green.svg)](https://github.com/dartoos-dev/json_cache/blob/master/LICENSE)
-[![style: lint](https://img.shields.io/badge/style-lint-4BC0F5.svg)](https://pub.dev/packages/lint)
 [![PDD status](https://www.0pdd.com/svg?name=dartoos-dev/json_cache)](https://www.0pdd.com/p?name=dartoos-dev/json_cache)
+
 [![build](https://github.com/dartoos-dev/json_cache/actions/workflows/build.yml/badge.svg)](https://github.com/dartoos-dev/json_cache/actions/)
-[![codecov](https://codecov.io/gh/dartoos-dev/json_cache/branch/master/graph/badge.svg?token=7T5VNQIIMZ)](https://codecov.io/gh/dartoos-dev/json_cache)
-[![Hits-of-Code](https://hitsofcode.com/github/dartoos-dev/json_cache)](https://hitsofcode.com/github/dartoos-dev/json_cache/view)
+[![codecov](https://codecov.io/gh/dartoos-dev/json_cache/branch/master/graph/badge.svg?token=W6spF0S796)](https://codecov.io/gh/dartoos-dev/json_cache)
+[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/rafamizes/json_cache)](https://www.codefactor.io/repository/github/rafamizes/json_cache)
+[![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/json_cache?branch=master)](https://hitsofcode.com/github/dartoos-dev/json_cache/view?branch=master)
+
+## Contents
+
+- [Overview](#overview)
+- [Getting Started](#getting-started)
+- [Demo application](#demo-application)
+- [References](#references)
+
+## Overview
 
 **Json Cache** is an object-oriented package to serve as a layer on top of local
-storage packages - packages that persist data locally on the user's device
--, unifying them as an elegant cache API.
+storage packages, unifying them as an elegant caching API.
 
-In addition, this package gives the programmer great flexibility; it provides a
-set of classes that can be selected and combined in various ways to address
-specific caching requirements.
+In addition, this package gives developers great flexibility by providing a set
+of classes that can be selected and combined in various ways to meet specific
+requirements.
 
 **Why Json?**
 
 - Because most of the local storage packages available for Flutter applications
   use json as the data format.
 - There is an one-to-one relationship between the Dart's built-in type
-  ```Map<String, dynamic>``` and json, which makes json encoding/decoding a
+  `Map<String, dynamic>` and json, which makes json encoding/decoding a
   trivial task.
 
 ## Getting Started
 
-```JsonCache``` - the core interface of this package - represents the concept of
+`JsonCache` is the core interface of this package and represents the concept of
 cached data. It is defined as:
 
 ```dart
@@ -53,9 +65,9 @@ abstract class JsonCache {
 }
 ```
 
-It's reasonable to consider each cache entry (pair of key/data) as a group of
-related data. Thus, it is expected to cache user data in groups, in which a key
-represents the name of a single group of data. Example:
+It is reasonable to consider each cache entry (a key/data pair) as a group of
+related data. Thus, it is expected to cache user data into groups where a key
+represents the name of a single data group. For example:
 
 ```dart
 'profile': {'name': 'John Doe', 'email': '[email protected]', 'accountType': 'premium'};
@@ -66,3 +78,21 @@ Above the _'profile'_ key is associated with the group of profile related data;
 _'preferences'_, with preferences data.
 
 <!-- @todo #10 Some implementation is needed to add more examples -->
+
+## Demo application
+
+The demo application provides a fully working example, focused on demonstrating
+the caching API in action. You can take the code in this demo and experiment
+with it.
+
+To run the demo application:
+
+```shell
+git clone https://github.com/dartoos-dev/json_cache.git
+cd json_cache/example/
+flutter run -d chrome
+```
+
+This should launch the demo application on Chrome in debug mode.
+
+## References

analysis_options.yaml

@@ -1,9 +1,20 @@
 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:
-    # Always await.
-    unawaited_futures: true
     # Make constructors the first thing in every class
     sort_constructors_first: true
     # Good packages document everything
     public_member_api_docs: true
+    always_declare_return_types: true
+    cancel_subscriptions: true
+    close_sinks: true
+    only_throw_errors: true
+    package_api_docs: true

pubspec.lock

@@ -7,7 +7,7 @@ packages:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.6.1"
+    version: "2.7.0"
   boolean_selector:
     dependency: transitive
     description:
@@ -28,7 +28,7 @@ packages:
       name: charcode
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.1"
   clock:
     dependency: transitive
     description:
@@ -80,7 +80,7 @@ packages:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.3.0"
+    version: "1.7.0"
   path:
     dependency: transitive
     description:
@@ -134,7 +134,7 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.3.0"
+    version: "0.4.1"
   typed_data:
     dependency: transitive
     description:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: json_cache
-description: A set of object-oriented classes for local caching of user data in json; a highly combinable layer on top of local storage packages, unifying them as an elegant cache API.
-version: 0.1.0
+description: An object-oriented package for caching user data locally in json; a combinable layer on top of local storage packages that unifies them as an elegant caching API.
+version: 0.0.1
 homepage: https://dartoos.dev
 repository: https://github.com/dartoos-dev/json_cache