flutter_rb 1.0.1 → 1.1.1

data/lib/flutter_rb/config/flutter_rb_config.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # FlutterRb configuration representation from config in Flutter plugin
   class FlutterRbConfig
-    def initialize(
-      flutter_checks,
-      android_checks,
-      ios_checks
-    )
+    # @param {Check[]} flutter_checks
+    # @param {Check[]} android_checks
+    # @param {Check[]} ios_checks
+    def initialize(flutter_checks, android_checks, ios_checks)
       @flutter_checks = flutter_checks
       @android_checks = android_checks
       @ios_checks = ios_checks

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 = [
@@ -28,23 +31,42 @@ module FlutterRb
       PluginPodspecSourceCheck.new
     ].freeze
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Layout/LineLength
+    # 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 = []
-      flutter_checks += config['flutter'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['flutter'].nil?
-      android_checks = []
-      android_checks += config['android'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['android'].nil?
-      ios_checks = []
-      ios_checks += config['ios'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['ios'].nil?
+      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
+
+        unless exclude_checks['android'].nil?
+          exclude_android_checks += exclude_checks['android'].map { |check| "FlutterRb::#{check}" }
+        end
+
+        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
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Layout/LineLength
 
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+    # @return {FlutterRbConfig}
     def default
       FlutterRbConfig.new(
         FLUTTER_CHECKS,

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'
@@ -10,12 +12,11 @@ require 'yaml'
 module FlutterRb
   # Project representation
   class Project
-    def initialize(
-      path,
-      pubspec,
-      android_folder,
-      ios_folder
-    )
+    # @param {String} path
+    # @param {Pubspec} pubspec
+    # @param {AndroidFolder} android_folder
+    # @param {IOSFolder} ios_folder
+    def initialize(path, pubspec, android_folder, ios_folder)
       @path = path
       @pubspec = pubspec
       @android_folder = android_folder
@@ -27,16 +28,19 @@ module FlutterRb
 
   # Flutter plugin project parser
   class ProjectParser
+    # @param {String} path
     def initialize(path)
       @path = path
     end
 
+    # @return {Project}
     def project
       File.exist?("#{@path}/pubspec.yaml") ? parse_project : nil
     end
 
     private
 
+    # @return {Project}
     def parse_project
       pubspec_path = "#{@path}/pubspec.yaml"
       android_path = "#{@path}/android"

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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require_relative './gradle'
 
 module FlutterRb
   # Android project representation
   class AndroidFolder
+    # @param {String} path
     def initialize(path)
       @path = path
       @gradle = GradleParser.new(@path).parse

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module FlutterRb
   # Gradle representation
   class Gradle
+    # @param {String} path
+    # @param {String} version
     def initialize(path, version)
       @path = path
       @version = version
@@ -13,10 +17,12 @@ module FlutterRb
 
   # Gradle parser
   class GradleParser
+    # @param {String} path
     def initialize(path)
       @path = path
     end
 
+    # @return {Gradle}
     def parse
       `gradle -p #{@path} -q prepareInfo`
       info_file = File.read "#{@path}/flutter_rb_gradle_plugin_output.json"

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

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Dev dependency, contains name and version
   class DevDependency
+    # @param {String} name
+    # @param {String} version
     def initialize(name, version)
       @name = name
       @version = version

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

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Flutter plugin, contains platform, package and plugin class
   class PlatformPlugin
+    # @param {String} platform
+    # @param {String} package
+    # @param {String} plugin_class
     def initialize(platform, package, plugin_class)
       @platform = platform
       @package = package
@@ -12,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'
@@ -5,12 +7,11 @@ require_relative './platform_plugin'
 module FlutterRb
   # pubspec.yaml representation
   class Pubspec
-    def initialize(
-      path,
-      pubspec_info,
-      dev_dependencies,
-      platform_plugins
-    )
+    # @param {String} path
+    # @param {PubspecInfo} pubspec_info
+    # @param {DevDependency[]} dev_dependencies
+    # @param {PlatformPlugin[]} platform_plugins
+    def initialize(path, pubspec_info, dev_dependencies, platform_plugins)
       @path = path
       @pubspec_info = pubspec_info
       @dev_dependencies = dev_dependencies
@@ -22,11 +23,14 @@ module FlutterRb
 
   # pubspec.yaml parser
   class PubspecParser
+    # @param {String} path
+    # @param {Pubspec} pubspec
     def initialize(path, pubspec)
       @path = path
       @pubspec = pubspec
     end
 
+    # @return {Pubspec}
     def parse
       Pubspec.new(
         @path,
@@ -36,6 +40,8 @@ module FlutterRb
       )
     end
 
+    # @param {Pubspec}
+    # @return {PubspecInfo}
     def pubspec_info(pubspec)
       PubspecInfo.new(
         pubspec['name'],
@@ -46,6 +52,8 @@ module FlutterRb
       )
     end
 
+    # @param {Pubspec} pubspec
+    # @return {DevDependency[]}
     def dev_dependencies(pubspec)
       pubspec['dev_dependencies']&.map do |dev_dependency|
         DevDependency.new(
@@ -55,6 +63,8 @@ module FlutterRb
       end
     end
 
+    # @param {Pubspec} pubspec
+    # @return {PlatformPlugin[]}
     def platform_plugins(pubspec)
       pubspec.dig('flutter', 'plugin', 'platforms')&.map do |platform_plugin|
         plugin_info = platform_plugin.last

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

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Flutter plugin info from pubspec.yaml
   class PubspecInfo
-    def initialize(
-      name,
-      description,
-      version,
-      author,
-      homepage
-    )
+    # @param {String} name
+    # @param {String} description
+    # @param {String} version
+    # @param {String} author
+    # @param {String} 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,8 +1,12 @@
+# frozen_string_literal: true
+
 require_relative './podspec'
 
 module FlutterRb
   # iOS representation
   class IOSFolder
+    # @param {String} path
+    # @param {Pubspec} pubspec
     def initialize(path, pubspec)
       @path = path
       podspec_path = "#{path}/#{pubspec.pubspec_info.name}.podspec"

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

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 require 'cocoapods'
 
 module FlutterRb
   # Podspec representation
   class Podspec
-    def initialize(
-      path,
-      name,
-      version,
-      authors,
-      source
-    )
+    # @param {String} path
+    # @param {String} name
+    # @param {String} version
+    # @param {String[]} authors
+    # @param {String} source
+    def initialize(path, name, version, authors, source)
       @path = path
       @name = name
       @version = version
@@ -22,10 +23,12 @@ module FlutterRb
 
   # Podspec parser
   class PodspecParser
+    # @param {String} path
     def initialize(path)
       @path = path
     end
 
+    # @return {Podspec}
     def parse
       podspec = Pod::Specification.from_file(@path)
       @podspec = Podspec.new(

data/lib/flutter_rb/report/check_report.rb

@@ -1,20 +1,23 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 module FlutterRb
   # Check report
   class CheckReport
-    def initialize(
-      check_name,
-      check_report_status,
-      message,
-      path
-    )
+    # @param {String} check_name
+    # @param {CheckReportStatus} check_report_status
+    # @param {String} message
+    # @param {String} path
+    def initialize(check_name, check_report_status, message, path)
       @check_name = check_name
       @check_report_status = check_report_status
       @message = message
       @path = path
     end
 
+    # @param {Bool} colorize
+    # @return {String}
     def print(colorize: true)
       if colorize
         status_color = color_for_report_status(@check_report_status)
@@ -24,6 +27,8 @@ module FlutterRb
       end
     end
 
+    # @param {CheckReportStatus} check_report_status
+    # @return {Presenter}
     def color_for_report_status(check_report_status)
       case check_report_status
       when CheckReportStatus::NORMAL
@@ -32,6 +37,8 @@ module FlutterRb
         :yellow
       when CheckReportStatus::ERROR
         :red
+      else
+        :blue
       end
     end
 
@@ -40,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,8 +10,11 @@ require_relative './flutter_rb/config/flutter_rb_config_initializer'
 require_relative './checkstyle_report/checkstyle_report'
 
 module FlutterRb
-  # Start FlutterRb checks
+  # 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?
@@ -23,12 +28,16 @@ module FlutterRb
       end
     end
 
+    # @return {Void}
     def exit_with_no_project
       puts 'No project'
       exit(-1)
     end
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # @param {Project} project
+    # @param {String} path
+    # @param {Bool} with_report
     def check_project(project, path, with_report)
       config_initializer = FlutterRbConfigInitializer.new
       config_path = "#{path}/.flutter_rb.yaml"
@@ -40,26 +49,44 @@ module FlutterRb
         config.ios_checks
       )
       checks.each { |check| puts check.print }
-      errors = checks.reject { |check| check.check_report_status == CheckReportStatus::NORMAL }
+      errors = checks.reject do |check|
+        check.check_report_status == CheckReportStatus::NORMAL
+      end
       create_report(path, checks) if with_report
       exit(errors.empty? ? 0 : -1)
     end
+
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    def explore_project(
-      project,
-      flutter_checks,
-      android_checks,
-      ios_checks
-    )
+    # rubocop:disable Metrics/MethodLength
+    # @param {Project} project
+    # @param {Check[]} flutter_checks
+    # @param {Check[]} android_checks
+    # @param {Check[]} ios_checks
+    def explore_project(project, flutter_checks, android_checks, ios_checks)
       result = []
-      result += flutter_checks.map { |check| check.check(project) }
-      result += android_checks.map { |check| check.check(project) } unless project.android_folder.nil?
-      result += ios_checks.map { |check| check.check(project) } unless project.ios_folder.nil?
+      result += flutter_checks.map do |check|
+        check.check(project)
+      end
+      unless project.android_folder.nil?
+        result += android_checks.map do |check|
+          check.check(project)
+        end
+      end
+      unless project.ios_folder.nil?
+        result += ios_checks.map do |check|
+          check.check(project)
+        end
+      end
       result
     end
 
+    # rubocop:enable Metrics/MethodLength
+
     # rubocop:disable Metrics/MethodLength
+    # @param {String} path
+    # @param {Check[]} checks
+    # @return {CheckstyleReport}
     def create_report(path, checks)
       errors = checks.map do |check|
         CheckstyleReport::CheckstyleError.new(
@@ -77,8 +104,11 @@ module FlutterRb
         errors
       ).create_report
     end
+
     # rubocop:enable Metrics/MethodLength
 
+    # @param {CheckReportStatus} check_report_status
+    # @return {CheckstyleReport}
     def level_for_report(check_report_status)
       case check_report_status
       when CheckReportStatus::NORMAL

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutter_rb
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-22 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
@@ -94,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description:
 email: artem.fomchenkov@outlook.com
 executables:
@@ -102,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