flutter_rb 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd9ab4300d4125491e760985c8d40ffc3fa5f96991591e175f944841982328f
-  data.tar.gz: b1458595c0f9f9ffdd6f288acb6ef38a2e008a6d692bdacfc1c91afb9512c193
+  metadata.gz: 5d708635770d65db09e97f3864f6e35ebcba46c13c84d6a388e6f10e9adc72e4
+  data.tar.gz: 1db4f12f4a0d23ba569a1c885eb3db6b295f11f2954594207750e738c91fa885
 SHA512:
-  metadata.gz: 44ee511a8e2f5537d14eaa0097fcb0ba22e61fdfcb9b9300814b5b793cc23617a7017dd413384069f95cbd7f6ebd7a1cf3330a0011aa942318bc4224bdc5b2db
-  data.tar.gz: 42eb043999a521b44ec7a9950e6cb9e1fc8fb8fecf2f8d59cc0b9c6e0c369a69d43a071be6970bcac8780e3caa734f7c2ea9468b098e40d52daed92b6be43d29
+  metadata.gz: ce685d7cfeb7b65bd31113f167d91aa59fb5ba23368f744a4d1efa14d7b2f5e97e32e7b4fa2012a32ba2fafb94f29c6d30e68602e25648aff0fe7695bafc0ce5
+  data.tar.gz: 6d11387d9654065b86410ab14612ec2ac4711f181d8c56d9551f762d408b6ba00ba0c1b81f72145af283d970e17b51dafa0c8d545925dae11df65b7630bfd70c

data/README.md

@@ -1,3 +1,4 @@
+<!--suppress CheckImageSize -->
 <img src="media/logo/ic_lib.png" height="100px" alt="Project's logo">
 
 # flutter_rb
@@ -25,15 +26,16 @@ Each issue has a `level` parameter that describes its significant importance.
 
 #### Flutter
 
-| Check                             | Description                                                                                                                                                                        | Level     |
-|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
-| `PluginDirectoriesCheck`          | Check plugin directories structure in pubspec file. Example: if a Flutter plugin has only Android specific code but not contains iOS folder with description, then iOS build fails | `ERROR`   |
-| `PluginPubspecNameCheck`          | Check plugin name in pubspec file. Exists or not                                                                                                                                   | `ERROR`   |
-| `PluginPubspecDescriptionCheck`   | Check plugin description in pubspec file. Exists or not                                                                                                                            | `WARNING` |
-| `PluginPubspecVersionCheck`       | Check plugin version in pubspec. Exists or not                                                                                                                                     | `ERROR`   |
-| `PluginPubspecAuthorCheck`        | Check plugin author in pubspec. Exists or not. `author` section deprecated in `pubspec.yaml`                                                                                       | `WARNING` |
-| `PluginPubspecHomepageCheck`      | Check plugin homepage in pubspec. Exists or not                                                                                                                                    | `ERROR`   |
-| `PluginPubspecEffectiveDartCheck` | Check Flutter plugin Effective Dart depencency in pubspec file. Exists or not                                                                                                      | `ERROR`   |
+| Check                            | Description                                                                                                                                                                        | Level     |
+|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `PluginDirectoriesCheck`         | Check plugin directories structure in pubspec file. Example: if a Flutter plugin has only Android specific code but not contains iOS folder with description, then iOS build fails | `ERROR`   |
+| `PluginPubspecNameCheck`         | Check plugin name in pubspec file. Exists or not                                                                                                                                   | `ERROR`   |
+| `PluginPubspecDescriptionCheck`  | Check plugin description in pubspec file. Exists or not                                                                                                                            | `WARNING` |
+| `PluginPubspecVersionCheck`      | Check plugin version in pubspec. Exists or not                                                                                                                                     | `ERROR`   |
+| `PluginPubspecAuthorCheck`       | Check plugin author in pubspec. Exists or not. `author` section deprecated in `pubspec.yaml`                                                                                       | `WARNING` |
+| `PluginPubspecHomepageCheck`     | Check plugin homepage in pubspec. Exists or not                                                                                                                                    | `ERROR`   |
+| `PluginPubspecLintsCheck`        | Check Flutter plugin `lints` dependency in pubspec file. Exists or not                                                                                                             | `ERROR`   |
+| `PluginPubspecFlutterLintsCheck` | Check Flutter plugin `flutter_lints` dependency in pubspec file. Exists or not                                                                                                     | `ERROR`   |
 
 #### Android
 
@@ -103,10 +105,10 @@ $ local_frb
 
 ### Configuration
 
-Add `.flutter_rb.yaml` to root of a project for select checks that you are want to execute:
+Add `.flutter_rb.yaml` to root of a project for select checks that you are want to exclude:
 
 ```yaml
-include:
+exclude:
   flutter:
     - check1
     - check2

data/bin/frb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'flutter_rb'
 require 'colorize'
 

data/lib/checkstyle_report/checkstyle_report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 # Module with classes for creating reports in Checkstyle format
@@ -80,9 +82,9 @@ module CheckstyleReport
 
   # Checkstyle error representation
   class CheckstyleError
-    SEVERITY_NORMAL = 'normal'.freeze
-    SEVERITY_WARNING = 'warning'.freeze
-    SEVERITY_ERROR = 'error'.freeze
+    SEVERITY_NORMAL = 'normal'
+    SEVERITY_WARNING = 'warning'
+    SEVERITY_ERROR = 'error'
 
     # rubocop:disable Metrics/ParameterLists
     # @param {String} severity

data/lib/flutter_rb/checks/check.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Base class for all checks
   # Class provides default methods structure
   # All methods using for create reports
   class Check
-    UNIMPLEMENTED_ERROR = 'Error: missing method'.freeze
+    UNIMPLEMENTED_ERROR = 'Error: missing method'
 
     # @return {String}
     def name

data/lib/flutter_rb/checks/plugin_directories_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 

data/lib/flutter_rb/checks/plugin_gradle_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './check'
 require_relative '../report/check_report'
 

data/lib/flutter_rb/checks/plugin_podspec_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 

data/lib/flutter_rb/checks/plugin_pubspec_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 
@@ -145,34 +147,66 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin Effective Dart dependency in pubspec file. Exists or not
-  # noinspection RubyClassModuleNamingConvention
-  class PluginPubspecEffectiveDartCheck < Check
+  # Check Flutter plugin lints dependency in pubspec file. Exists or not
+  class PluginPubspecLintsCheck < Check
+    # @return {String}
+    def name
+      'PluginPubspecLintsCheck'
+    end
+
+    # @return {String}
+    def summary
+      'Validate Flutter plugin\'s lints rules implementation in pubspec.yaml'
+    end
+
+    # @return {String}
+    def description
+      'Check Flutter plugin lints dependency in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
+    def check(project)
+      pubspec = project.pubspec
+      lints = pubspec.dev_dependencies&.detect do |dev_dependency|
+        dev_dependency.name == 'lints'
+      end
+      CheckReport.new(
+        name,
+        lints.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        pubspec.path
+      )
+    end
+  end
+
+  # Check Flutter plugin flutter_lints dependency in pubspec file. Exists or not
+  class PluginPubspecFlutterLintsCheck < Check
     # @return {String}
     def name
-      'PluginPubspecEffectiveDartCheck'
+      'PluginPubspecFlutterLintsCheck'
     end
 
     # @return {String}
     def summary
-      'Validate Flutter plugin\'s Effective Dart rules implementation in pubspec.yaml'
+      'Validate Flutter plugin\'s flutter_lints rules implementation in pubspec.yaml'
     end
 
     # @return {String}
     def description
-      'Check Flutter plugin Effective Dart depencency in pubspec file'
+      'Check Flutter plugin flutter_lints dependency in pubspec file'
     end
 
     # @param {Project} project
     # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
-      effective_dart = pubspec.dev_dependencies&.detect do |dev_dependency|
-        dev_dependency.name == 'effective_dart'
+      flutter_lints = pubspec.dev_dependencies&.detect do |dev_dependency|
+        dev_dependency.name == 'flutter_lints'
       end
       CheckReport.new(
         name,
-        effective_dart.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        flutter_lints.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
         description,
         pubspec.path
       )

data/lib/flutter_rb/config/flutter_rb_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # FlutterRb configuration representation from config in Flutter plugin
   class FlutterRbConfig

data/lib/flutter_rb/config/flutter_rb_config_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './flutter_rb_config'
 require_relative '../checks/plugin_directories_check'
 
@@ -13,7 +15,8 @@ module FlutterRb
       PluginPubspecVersionCheck.new,
       PluginPubspecAuthorCheck.new,
       PluginPubspecHomepageCheck.new,
-      PluginPubspecEffectiveDartCheck.new
+      PluginPubspecLintsCheck.new,
+      PluginPubspecFlutterLintsCheck.new
     ].freeze
 
     ANDROID_CHECKS = [
@@ -30,30 +33,34 @@ module FlutterRb
 
     # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
     # @param {String} path
+    # @return {FlutterRbConfig}
     def parse(path)
-      config = YAML.load_file(path)['include']
-      flutter_checks = []
-      unless config['flutter'].nil?
-        flutter_checks += config['flutter'].map do |check|
-          Object.const_get("FlutterRb::#{check}").new
+      config = YAML.load_file(path)
+
+      exclude_flutter_checks = ::Set.new
+      exclude_android_checks = ::Set.new
+      exclude_ios_checks = ::Set.new
+
+      unless config.nil?
+        exclude_checks = YAML.load_file(path)['exclude']
+
+        unless exclude_checks['flutter'].nil?
+          exclude_flutter_checks += exclude_checks['flutter'].map { |check| "FlutterRb::#{check}" }
         end
-      end
-      android_checks = []
-      unless config['android'].nil?
-        android_checks += config['android'].map do |check|
-          Object.const_get("FlutterRb::#{check}").new
+
+        unless exclude_checks['android'].nil?
+          exclude_android_checks += exclude_checks['android'].map { |check| "FlutterRb::#{check}" }
         end
-      end
-      ios_checks = []
-      unless config['ios'].nil?
-        ios_checks += config['ios'].map do |check|
-          Object.const_get("FlutterRb::#{check}").new
+
+        unless exclude_checks['ios'].nil?
+          exclude_ios_checks += exclude_checks['ios'].map { |check| "FlutterRb::#{check}" }
         end
       end
+
       FlutterRbConfig.new(
-        flutter_checks.empty? ? FLUTTER_CHECKS : flutter_checks,
-        android_checks.empty? ? ANDROID_CHECKS : android_checks,
-        ios_checks.empty? ? IOS_CHECKS : ios_checks
+        FLUTTER_CHECKS.reject { |check| exclude_flutter_checks&.include?(check.class.name) },
+        ANDROID_CHECKS.reject { |check| exclude_android_checks&.include?(check.class.name) },
+        IOS_CHECKS.reject { |check| exclude_ios_checks&.include?(check.class.name) }
       )
     end
 

data/lib/flutter_rb/project/project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './specs/flutter/pubspec'
 require_relative './specs/flutter/dev_dependency'
 require_relative './specs/flutter/platform_plugin'
@@ -14,12 +16,7 @@ module FlutterRb
     # @param {Pubspec} pubspec
     # @param {AndroidFolder} android_folder
     # @param {IOSFolder} ios_folder
-    def initialize(
-      path,
-      pubspec,
-      android_folder,
-      ios_folder
-    )
+    def initialize(path, pubspec, android_folder, ios_folder)
       @path = path
       @pubspec = pubspec
       @android_folder = android_folder

data/lib/flutter_rb/project/specs/android/android_folder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './gradle'
 
 module FlutterRb

data/lib/flutter_rb/project/specs/android/gradle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module FlutterRb

data/lib/flutter_rb/project/specs/flutter/dev_dependency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Dev dependency, contains name and version
   class DevDependency

data/lib/flutter_rb/project/specs/flutter/platform_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Flutter plugin, contains platform, package and plugin class
   class PlatformPlugin
@@ -15,7 +17,7 @@ module FlutterRb
 
   # Supported platforms for this tool
   class Platform
-    ANDROID = 'android'.freeze
-    IOS = 'ios'.freeze
+    ANDROID = 'android'
+    IOS = 'ios'
   end
 end

data/lib/flutter_rb/project/specs/flutter/pubspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './pubspec_info'
 require_relative './dev_dependency'
 require_relative './platform_plugin'
@@ -9,12 +11,7 @@ module FlutterRb
     # @param {PubspecInfo} pubspec_info
     # @param {DevDependency[]} dev_dependencies
     # @param {PlatformPlugin[]} platform_plugins
-    def initialize(
-      path,
-      pubspec_info,
-      dev_dependencies,
-      platform_plugins
-    )
+    def initialize(path, pubspec_info, dev_dependencies, platform_plugins)
       @path = path
       @pubspec_info = pubspec_info
       @dev_dependencies = dev_dependencies

data/lib/flutter_rb/project/specs/flutter/pubspec_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Flutter plugin info from pubspec.yaml
   class PubspecInfo
@@ -6,13 +8,7 @@ module FlutterRb
     # @param {String} version
     # @param {String} author
     # @param {String} homepage
-    def initialize(
-      name,
-      description,
-      version,
-      author,
-      homepage
-    )
+    def initialize(name, description, version, author, homepage)
       @name = name
       @description = description
       @version = version

data/lib/flutter_rb/project/specs/ios/ios_folder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './podspec'
 
 module FlutterRb

data/lib/flutter_rb/project/specs/ios/podspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cocoapods'
 
 module FlutterRb
@@ -8,13 +10,7 @@ module FlutterRb
     # @param {String} version
     # @param {String[]} authors
     # @param {String} source
-    def initialize(
-      path,
-      name,
-      version,
-      authors,
-      source
-    )
+    def initialize(path, name, version, authors, source)
       @path = path
       @name = name
       @version = version

data/lib/flutter_rb/report/check_report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 module FlutterRb
@@ -7,12 +9,7 @@ module FlutterRb
     # @param {CheckReportStatus} check_report_status
     # @param {String} message
     # @param {String} path
-    def initialize(
-      check_name,
-      check_report_status,
-      message,
-      path
-    )
+    def initialize(check_name, check_report_status, message, path)
       @check_name = check_name
       @check_report_status = check_report_status
       @message = message
@@ -50,8 +47,8 @@ module FlutterRb
 
   # Check report status
   class CheckReportStatus
-    NORMAL = 'normal'.freeze
-    WARNING = 'warning'.freeze
-    ERROR = 'error'.freeze
+    NORMAL = 'normal'
+    WARNING = 'warning'
+    ERROR = 'error'
   end
 end

data/lib/flutter_rb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './flutter_rb/project/project'
 require_relative './flutter_rb/checks/plugin_directories_check'
 require_relative './flutter_rb/checks/plugin_pubspec_check'
@@ -8,10 +10,11 @@ require_relative './flutter_rb/config/flutter_rb_config_initializer'
 require_relative './checkstyle_report/checkstyle_report'
 
 module FlutterRb
-  # Start FlutterRb checks
-  # @param {String} path
-  # @param {Bool} with_report
+  # FlutterRb entry
   class FlutterRb
+    # Start FlutterRb checks
+    # @param {String} path
+    # @param {Boolean} with_report
     def start(path, with_report)
       project = ProjectParser.new(path).project
       if project.nil?
@@ -25,6 +28,7 @@ module FlutterRb
       end
     end
 
+    # @return {Void}
     def exit_with_no_project
       puts 'No project'
       exit(-1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutter_rb
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-19 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +130,6 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- CODE_OF_CONDUCT.md
-- COMMIT_CONVENTION.md
 - LICENSE
 - README.md
 - bin/frb

data/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at jaman.smlnsk@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

data/COMMIT_CONVENTION.md

@@ -1,58 +0,0 @@
-# Commit Convention
-
-## How to work with a project
-
-### As a repository maintainer
-
-#### New update
-
-1. clone a project from a repository to local workspace;
-2. create a new branch for an update;
-3. complete the update;
-4. perform a Code Review;
-5. merge your branch with `master`;
-6. delete your branch.
-
-#### Notes
-
-1. always delete development branches;
-2. always push squashed commit to `master`.
-
-### As a contributor
-
-1. clone a project from a repository to local workspace;
-2. create a new branch for an update;
-3. complete the update;
-4. perform a Code Review;
-5. create a Pull Request to the original repository.
-
-## Branches
-
-### In projects using next types of branches
-
-* `master` - master branch. Contains a production version of the project. Don't push working changes to `master`!
-* `version` - branch for a specific version.
-* `issue` - branch for a specific issue.
-
-## Commit message structure
-
-### Template
-
-```text
-[DATE] [VERSION]: [MESSAGE]
-```
-
-### Example
-
-```text
-2019-05-12 v. 2.1.3: fixed bugs in History screen
-```
-
-#### Commit body sections order
-
-1. `added` - what was added in the commit;
-2. `closed` - what issues closed in the commit;
-3. `fixed` - what was fixed in the commit;
-4. `updated` - what was updated in the commit;
-5. `deleted` - what was deleted in the commit;
-6. `refactored` - what was refactored in the commit.