flutter_rb 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8564b7cdf9819a28ea1ca5c145f9dcb813556575998924fb9b6cc8db5224ca77
-  data.tar.gz: 51b4cc3dd7dbf3b0d0e7a653f29defc47293b685c3de05f6e5a99ce846df9e41
+  metadata.gz: 8fd9ab4300d4125491e760985c8d40ffc3fa5f96991591e175f944841982328f
+  data.tar.gz: b1458595c0f9f9ffdd6f288acb6ef38a2e008a6d692bdacfc1c91afb9512c193
 SHA512:
-  metadata.gz: 7b595e1256a18e7f74d5d273054f7608dae0c3674bd0467db4108fb4ef7c8936248cd3daf610ac5e11242fe169d97085bd008fee98bb5dca2a2461a72a7f01cc
-  data.tar.gz: 7b12583d8fad4af058cde7c45e560141a9f74db75fe215f70b57ebe3a0584a7979471a7b68680f7ded6ebdd469cbf4421cfb4822e8d9af29d18fe08f2638fef1
+  metadata.gz: 44ee511a8e2f5537d14eaa0097fcb0ba22e61fdfcb9b9300814b5b793cc23617a7017dd413384069f95cbd7f6ebd7a1cf3330a0011aa942318bc4224bdc5b2db
+  data.tar.gz: 42eb043999a521b44ec7a9950e6cb9e1fc8fb8fecf2f8d59cc0b9c6e0c369a69d43a071be6970bcac8780e3caa734f7c2ea9468b098e40d52daed92b6be43d29

data/README.md

@@ -5,6 +5,7 @@
 [![GitHubActions](https://github.com/flutter-rb/flutter-rb/workflows/Build/badge.svg)](https://github.com/flutter-rb/flutter-rb/actions?branch=master)
 [![Codebeat](https://codebeat.co/badges/9bb32e28-ca86-4cdc-ba66-bda7f989979a)](https://codebeat.co/projects/github-com-flutter-rb-flutter-rb-master)
 [![Gem Version](https://badge.fury.io/rb/flutter_rb.svg)](https://badge.fury.io/rb/flutter_rb)
+[![Gem Downloads](https://img.shields.io/gem/dt/flutter_rb)](https://badge.fury.io/rb/flutter_rb)
 
 ## About
 
@@ -54,7 +55,8 @@ Each issue has a `level` parameter that describes its significant importance.
 
 ### Android
 
-You should add [flutter-rb-gradle-plugin](https://github.com/flutter-rb/flutter-rb-gradle-plugin) to Android side of your plugin.
+You should add [flutter-rb-gradle-plugin](https://github.com/flutter-rb/flutter-rb-gradle-plugin) to Android side of
+your plugin.
 
 ### Download gem from RubyGems
 
@@ -85,7 +87,8 @@ $ frb
 
 ### As local executable
 
-Add `project_folder/bin` (where `project_folder` is path to project on your machine) to `PATH` variable in your environment. Then updated environment and run from a Flutter plugin's project folder:
+Add `project_folder/bin` (where `project_folder` is path to project on your machine) to `PATH` variable in your
+environment. Then updated environment and run from a Flutter plugin's project folder:
 
 ```shell
 $ local_frb
@@ -98,7 +101,6 @@ $ local_frb
 | `--help`              | Print help info                      |
 | `--checkstyle-report` | Generate report in Checkstyle format |
 
-
 ### Configuration
 
 Add `.flutter_rb.yaml` to root of a project for select checks that you are want to execute:
@@ -120,11 +122,13 @@ include:
 
 ### Output report
 
-Tool can make report in Checkstyle format. To enable this feature, pass `--checkstyle-report` as an CLI argument. The report file name is `frb-checkstyle-report.xml`.
+Tool can make report in Checkstyle format. To enable this feature, pass `--checkstyle-report` as an CLI argument. The
+report file name is `frb-checkstyle-report.xml`.
 
 ## How to contribute
 
-Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request. Then:
+Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request.
+Then:
 
 ```shell
 $ bundle exec rake

data/lib/checkstyle_report/checkstyle_report.rb

@@ -4,12 +4,17 @@ require 'nokogiri'
 module CheckstyleReport
   # Class for create report in Checkstyle format
   class CheckstyleReport
+    # @param {String} path
+    # @param {String} report_filename
+    # @param {CheckstyleError[]}
     def initialize(path, report_filename, checks)
       @path = path
       @report_filename = report_filename
       @checks = checks
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # noinspection RubyResolve
     def create_report
       checkstyle_files = sort_checks(@checks)
       report = Nokogiri::XML::Builder.new do |xml|
@@ -19,9 +24,15 @@ module CheckstyleReport
             .each { |file| write_file(xml, file) }
         end
       end
-      File.open("#{@path}/#{@report_filename}.xml", 'w') { |file| file.write(report.to_xml) }
+      File.open("#{@path}/#{@report_filename}.xml", 'w') do |file|
+        file.write(report.to_xml)
+      end
     end
 
+    # rubocop:enable Metrics/MethodLength
+
+    # @param {CheckstyleError} checks
+    # @return {CheckstyleFile[]}
     def sort_checks(checks)
       checkstyle_files = {}
       checks.each do |check|
@@ -32,6 +43,8 @@ module CheckstyleReport
       checkstyle_files
     end
 
+    # @param {XML} xml
+    # @param {CheckstyleFile} checkstyle_file
     def write_file(xml, checkstyle_file)
       xml.file(name: checkstyle_file.file) do
         checkstyle_file.errors.each do |error|
@@ -40,6 +53,8 @@ module CheckstyleReport
       end
     end
 
+    # @param {XML} xml
+    # @param {CheckstyleError} error
     def write_error(xml, error)
       xml.error(
         line: error.line,
@@ -53,6 +68,8 @@ module CheckstyleReport
 
   # File representation for Checkstyle format
   class CheckstyleFile
+    # @param {String} file
+    # @param {CheckstyleError[]} errors
     def initialize(file, errors)
       @file = file
       @errors = errors
@@ -68,6 +85,12 @@ module CheckstyleReport
     SEVERITY_ERROR = 'error'.freeze
 
     # rubocop:disable Metrics/ParameterLists
+    # @param {String} severity
+    # @param {String} message
+    # @param {String} source
+    # @param {Integer} line
+    # @param {Integer} column
+    # @param {String} name
     def initialize(
       severity,
       message,
@@ -83,6 +106,7 @@ module CheckstyleReport
       @column = column
       @name = name
     end
+
     # rubocop:enable Metrics/ParameterLists
 
     attr_reader :severity, :message, :source, :line, :column, :name

data/lib/flutter_rb/checks/check.rb

@@ -5,20 +5,28 @@ module FlutterRb
   class Check
     UNIMPLEMENTED_ERROR = 'Error: missing method'.freeze
 
+    # @return {String}
     def name
       raise UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def summary
       raise UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def description
       'No provided'
     end
 
-    def check
+    # rubocop:disable Lint/UnusedMethodArgument
+    # @param {Project} project
+    # @return {CheckReport}
+    def check(project)
       raise UNIMPLEMENTED_ERROR
     end
+
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/flutter_rb/checks/plugin_directories_check.rb

@@ -6,18 +6,23 @@ module FlutterRb
   # Example: if a Flutter plugin has only Android specific code
   # but not contains iOS folder with description, then iOS build fails
   class PluginDirectoriesCheck < Check
+    # @return {String}
     def name
       'PluginDirectoriesCheck'
     end
 
+    # @return {String}
     def summary
       'Validate Flutter plugin structure'
     end
 
+    # @return {String}
     def description
       'Check plugin directories structure in pubspec file'
     end
 
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       android_exists = !project.android_folder.nil?
       ios_exists = !project.ios_folder.nil?

data/lib/flutter_rb/checks/plugin_gradle_check.rb

@@ -4,18 +4,23 @@ require_relative '../report/check_report'
 module FlutterRb
   # Check 'android; import not exists in Gradle project config (build.gradle file)
   class PluginGradleAndroidPackageCheck < Check
+    # @return {String}
     def name
       'PluginGradleAndroidPackageCheck'
     end
 
+    # @return {String}
     def summary
       'Validate that \android\ package not exists in build.gradle config'
     end
 
+    # @return {String}
     def description
       'Validate that \android\ package not exists in Gradle project config (build.gradle file)'
     end
 
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       gradle = project.android_folder.gradle
       import_exist = File.readlines("#{gradle.path}/build.gradle").grep(/package android/).size.positive?
@@ -30,18 +35,23 @@ module FlutterRb
 
   # Check Flutter plugin version in Gradle project config (build.gradle file)
   class PluginGradleVersionCheck < Check
+    # @return {String}
     def name
       'PluginGradleVersionCheck'
     end
 
+    # @return {String}
     def summary
       'Validate Flutter plugin\s version in build.gradle file'
     end
 
+    # @return {String}
     def description
       'Check plugin version in Gradle project config (build.gradle file)'
     end
 
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       version_in_pubspec = project.pubspec.pubspec_info.version
       gradle = project.android_folder.gradle

data/lib/flutter_rb/checks/plugin_podspec_check.rb

@@ -4,14 +4,17 @@ require_relative '../report/check_report'
 module FlutterRb
   # Base class for all info parameters in Flutter plugin podspec file
   class PluginPodspecCheck < Check
+    # @return {String}
     def name
       "PluginPodspec#{podspec_parameter.capitalize}Check"
     end
 
+    # @return {String}
     def podspec_parameter
       UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def summary
       "Validate Flutter plugin's #{podspec_parameter} in podspec file"
     end
@@ -19,10 +22,18 @@ module FlutterRb
 
   # Check Flutter plugin name in podspec file. Exists or not
   class PluginPodspecNameCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'name'
     end
 
+    # @return {String}
+    def description
+      'Check plugin name in podspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       name_in_pubspec = project.pubspec.pubspec_info.name
       podspec = project.ios_folder.podspec
@@ -34,18 +45,22 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      'Check plugin name in podspec file'
-    end
   end
 
   # Check Flutter plugin version in podspec file. Exists or not
   class PluginPodspecVersionCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'version'
     end
 
+    # @return {String}
+    def description
+      'Check plugin version in podspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       version_in_pubspec = project.pubspec.pubspec_info.version
       podspec = project.ios_folder.podspec
@@ -57,18 +72,22 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      'Check plugin version in podspec file'
-    end
   end
 
   # Check Flutter plugin's authors. Exists or not
   class PluginPodspecAuthorsCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'authors'
     end
 
+    # @return {String}
+    def description
+      "Check plugin's authors in podspec file"
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       podspec = project.ios_folder.podspec
       author_exists = !podspec.authors.nil?
@@ -79,19 +98,23 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      "Check plugin's authors in podspec file"
-    end
   end
 
   # Check plugin iOS source path in podspec file.
   # If Flutter plugin cannot contains iOS specific code, source path must be '.'
   class PluginPodspecSourceCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'source'
     end
 
+    # @return {String}
+    def description
+      'Check plugin iOS source path in podspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       podspec = project.ios_folder.podspec
       CheckReport.new(
@@ -101,9 +124,5 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      'Check plugin iOS source path in podspec file'
-    end
   end
 end

data/lib/flutter_rb/checks/plugin_pubspec_check.rb

@@ -4,14 +4,17 @@ require_relative '../report/check_report'
 module FlutterRb
   # Base class for all info parameters in Flutter plugin pubspec.yaml file
   class PluginPubspecCheck < Check
+    # @return {String}
     def name
       "PluginPubspec#{pubspec_parameter.capitalize}Check"
     end
 
+    # @return {String}
     def pubspec_parameter
       raise UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def summary
       "Validate Flutter plugin's #{pubspec_parameter} in pubspec.yaml"
     end
@@ -19,10 +22,18 @@ module FlutterRb
 
   # Check Flutter plugin name in podspec file. Exists or not
   class PluginPubspecNameCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'name'
     end
 
+    # @return {String}
+    def description
+      'Check plugin name in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -32,18 +43,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin name in pubspec file'
-    end
   end
 
   # Check Flutter plugin description in pubspec file. Exists or not
   class PluginPubspecDescriptionCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'description'
     end
 
+    # @return {String}
+    def description
+      'Check plugin description in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -53,18 +68,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin description in pubspec file'
-    end
   end
 
   # Check Flutter plugin version in pubspec file. Exists or not
   class PluginPubspecVersionCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'version'
     end
 
+    # @return {String}
+    def description
+      'Check plugin version in pubspec'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -74,18 +93,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin version in pubspec'
-    end
   end
 
   # Check Flutter plugin author in pubspec file. Exists or not
   class PluginPubspecAuthorCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'author'
     end
 
+    # @return {String}
+    def description
+      'Check plugin author in pubspec'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -95,18 +118,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin author in pubspec'
-    end
   end
 
   # Check Flutter plugin homepage in pubspec file. Exists or not
   class PluginPubspecHomepageCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'homepage'
     end
 
+    # @return {String}
+    def description
+      'Check plugin homepage in pubspec'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -116,22 +143,28 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin homepage in pubspec'
-    end
   end
 
-  # Check Flutter plugin Effective Dart depencency in pubspec file. Exists or not
+  # Check Flutter plugin Effective Dart dependency in pubspec file. Exists or not
+  # noinspection RubyClassModuleNamingConvention
   class PluginPubspecEffectiveDartCheck < Check
+    # @return {String}
     def name
       'PluginPubspecEffectiveDartCheck'
     end
 
+    # @return {String}
     def summary
       'Validate Flutter plugin\'s Effective Dart rules implementation in pubspec.yaml'
     end
 
+    # @return {String}
+    def description
+      'Check Flutter plugin Effective Dart depencency in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       effective_dart = pubspec.dev_dependencies&.detect do |dev_dependency|
@@ -144,9 +177,5 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check Flutter plugin Effective Dart depencency in pubspec file'
-    end
   end
 end

data/lib/flutter_rb/config/flutter_rb_config.rb

@@ -1,11 +1,10 @@
 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

@@ -28,23 +28,38 @@ 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
     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?
+      unless config['flutter'].nil?
+        flutter_checks += config['flutter'].map do |check|
+          Object.const_get("FlutterRb::#{check}").new
+        end
+      end
       android_checks = []
-      android_checks += config['android'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['android'].nil?
+      unless config['android'].nil?
+        android_checks += config['android'].map do |check|
+          Object.const_get("FlutterRb::#{check}").new
+        end
+      end
       ios_checks = []
-      ios_checks += config['ios'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['ios'].nil?
+      unless config['ios'].nil?
+        ios_checks += config['ios'].map do |check|
+          Object.const_get("FlutterRb::#{check}").new
+        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
       )
     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

@@ -10,6 +10,10 @@ require 'yaml'
 module FlutterRb
   # Project representation
   class Project
+    # @param {String} path
+    # @param {Pubspec} pubspec
+    # @param {AndroidFolder} android_folder
+    # @param {IOSFolder} ios_folder
     def initialize(
       path,
       pubspec,
@@ -27,16 +31,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

@@ -3,6 +3,7 @@ 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

@@ -3,6 +3,8 @@ require 'json'
 module FlutterRb
   # Gradle representation
   class Gradle
+    # @param {String} path
+    # @param {String} version
     def initialize(path, version)
       @path = path
       @version = version
@@ -13,10 +15,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,8 @@
 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,9 @@
 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

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

@@ -5,6 +5,10 @@ require_relative './platform_plugin'
 module FlutterRb
   # pubspec.yaml representation
   class Pubspec
+    # @param {String} path
+    # @param {PubspecInfo} pubspec_info
+    # @param {DevDependency[]} dev_dependencies
+    # @param {PlatformPlugin[]} platform_plugins
     def initialize(
       path,
       pubspec_info,
@@ -22,11 +26,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 +43,8 @@ module FlutterRb
       )
     end
 
+    # @param {Pubspec}
+    # @return {PubspecInfo}
     def pubspec_info(pubspec)
       PubspecInfo.new(
         pubspec['name'],
@@ -46,6 +55,8 @@ module FlutterRb
       )
     end
 
+    # @param {Pubspec} pubspec
+    # @return {DevDependency[]}
     def dev_dependencies(pubspec)
       pubspec['dev_dependencies']&.map do |dev_dependency|
         DevDependency.new(
@@ -55,6 +66,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,6 +1,11 @@
 module FlutterRb
   # Flutter plugin info from pubspec.yaml
   class PubspecInfo
+    # @param {String} name
+    # @param {String} description
+    # @param {String} version
+    # @param {String} author
+    # @param {String} homepage
     def initialize(
       name,
       description,

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

@@ -3,6 +3,8 @@ 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

@@ -3,6 +3,11 @@ require 'cocoapods'
 module FlutterRb
   # Podspec representation
   class Podspec
+    # @param {String} path
+    # @param {String} name
+    # @param {String} version
+    # @param {String[]} authors
+    # @param {String} source
     def initialize(
       path,
       name,
@@ -22,10 +27,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

@@ -3,6 +3,10 @@ require 'colorize'
 module FlutterRb
   # Check report
   class CheckReport
+    # @param {String} check_name
+    # @param {CheckReportStatus} check_report_status
+    # @param {String} message
+    # @param {String} path
     def initialize(
       check_name,
       check_report_status,
@@ -15,6 +19,8 @@ module FlutterRb
       @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 +30,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 +40,8 @@ module FlutterRb
         :yellow
       when CheckReportStatus::ERROR
         :red
+      else
+        :blue
       end
     end
 

data/lib/flutter_rb.rb

@@ -9,6 +9,8 @@ require_relative './checkstyle_report/checkstyle_report'
 
 module FlutterRb
   # Start FlutterRb checks
+  # @param {String} path
+  # @param {Bool} with_report
   class FlutterRb
     def start(path, with_report)
       project = ProjectParser.new(path).project
@@ -29,6 +31,9 @@ module FlutterRb
     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 +45,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 +100,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.0.2
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-22 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -94,6 +94,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: