flutter_rb 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd9ab4300d4125491e760985c8d40ffc3fa5f96991591e175f944841982328f
-  data.tar.gz: b1458595c0f9f9ffdd6f288acb6ef38a2e008a6d692bdacfc1c91afb9512c193
+  metadata.gz: a5fb993e2dda5603c2b554cc6170bc6fc35fc5e1ffa66bf297d6e58831848f57
+  data.tar.gz: a6cdb39bcfbeced31b795c35ad29afe8aa77610114db5983af2f7c6f537f514e
 SHA512:
-  metadata.gz: 44ee511a8e2f5537d14eaa0097fcb0ba22e61fdfcb9b9300814b5b793cc23617a7017dd413384069f95cbd7f6ebd7a1cf3330a0011aa942318bc4224bdc5b2db
-  data.tar.gz: 42eb043999a521b44ec7a9950e6cb9e1fc8fb8fecf2f8d59cc0b9c6e0c369a69d43a071be6970bcac8780e3caa734f7c2ea9468b098e40d52daed92b6be43d29
+  metadata.gz: ba389f8bfbe506225b2fa88463e33ccb43ebcc77d3d1796c6736f8c0c57f2ba03a473a7ecfcd9a153afe3116cb4e18019e1c2a7ac690395deebb07f5eed90449
+  data.tar.gz: f57858e70b86497b3413cb04f95431981470d2eae4d5f137f4bfe72ab67e32120e66c383fd1f5faf35f2669cf41c5a81bf93ffe671f9ca49eee4ded7a5c7e670

data/README.md

@@ -1,4 +1,5 @@
-<img src="media/logo/ic_lib.png" height="100px" alt="Project's logo">
+<!--suppress CheckImageSize -->
+<img src="media/logo/ic_lib.jpg" 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
 
@@ -82,7 +84,7 @@ $ gem i flutter_rb
 Then run from a Flutter plugin's project folder:
 
 ```shell
-$ frb
+$ frb inspect --path=./project_folder
 ```
 
 ### As local executable
@@ -91,22 +93,46 @@ Add `project_folder/bin` (where `project_folder` is path to project on your mach
 environment. Then updated environment and run from a Flutter plugin's project folder:
 
 ```shell
-$ local_frb
+$ local_frb inspect --path=./project_folder
+```
+
+### Commands
+
+#### Inspect
+
+Starts the flutter-rb.
+
+```shell
+$ frb inspect --path=./project_folder --report
+```
+
+| Argument   | Description                                                                                        |
+|------------|----------------------------------------------------------------------------------------------------|
+| `--path`   | Path to Dart/Flutter project. flutter-rb will be use current directory if this parameter are empty |
+| `--report` | Generate report in Checkstyle format                                                               |
+
+#### Version
+
+Puts using version of flutter-rb.
+
+```shell
+$ frb version
 ```
 
-### Arguments
+#### Author
+
+Puts author and our contacts.
 
-| Argument              | Description                          |
-|-----------------------|--------------------------------------|
-| `--help`              | Print help info                      |
-| `--checkstyle-report` | Generate report in Checkstyle format |
+```shell
+$ frb author
+```
 
 ### 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
@@ -127,6 +153,16 @@ report file name is `frb-checkstyle-report.xml`.
 
 ## How to contribute
 
+### Documentation
+
+Just run:
+
+```shell
+$ rdoc
+```
+
+### Contribution
+
 Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request.
 Then:
 

data/bin/frb

@@ -1,19 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'flutter_rb'
-require 'colorize'
-
-def light_blue_text(text)
-  text.colorize(:light_blue)
-end
+# frozen_string_literal: true
 
-if ARGV.include?('--help')
-  puts "
-    Available arguments:
-    * #{light_blue_text('--help')}: print help info
-    * #{light_blue_text('--checkstyle-report')}: generate report in Checkstyle format
-    "
-else
-  flutter_rb = FlutterRb::FlutterRb.new
-  flutter_rb.start(Dir.pwd, ARGV.include?('--checkstyle-report'))
-end
+require_relative 'cli'
+require 'flutter_rb'

data/lib/checkstyle_report/checkstyle_report.rb

@@ -1,20 +1,25 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
-# Module with classes for creating reports in Checkstyle format
 module CheckstyleReport
   # Class for create report in Checkstyle format
   class CheckstyleReport
-    # @param {String} path
-    # @param {String} report_filename
-    # @param {CheckstyleError[]}
+    # Initializes a new instance of CheckstyleReport
+    #
+    # @param path [String] The path where the report file will be saved
+    # @param report_filename [String] The name of the report file
+    # @param checks [Array<CheckstyleError>] An array of CheckstyleError objects
     def initialize(path, report_filename, checks)
       @path = path
       @report_filename = report_filename
       @checks = checks
     end
 
-    # rubocop:disable Metrics/MethodLength
-    # noinspection RubyResolve
+    # Creates a Checkstyle report XML file
+    #
+    # This method groups the errors by file, creates a new CheckstyleFile object for each file,
+    # and writes the report to an XML file.
     def create_report
       checkstyle_files = sort_checks(@checks)
       report = Nokogiri::XML::Builder.new do |xml|
@@ -24,15 +29,17 @@ module CheckstyleReport
             .each { |file| write_file(xml, file) }
         end
       end
+
       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[]}
+    # Sorts the checks by file
+    #
+    # @param checks [Array<CheckstyleError>] An array of CheckstyleError objects
+    # @return [Hash<String, Array<CheckstyleError>>] A hash where the keys are file names
+    # and the values are arrays of CheckstyleError objects
     def sort_checks(checks)
       checkstyle_files = {}
       checks.each do |check|
@@ -40,11 +47,14 @@ module CheckstyleReport
         checkstyle_files[check.source] = [] if checkstyle_file.nil?
         checkstyle_files[check.source] += [check] if check.severity != CheckstyleError::SEVERITY_NORMAL
       end
+
       checkstyle_files
     end
 
-    # @param {XML} xml
-    # @param {CheckstyleFile} checkstyle_file
+    # Writes a file element to the XML report
+    #
+    # @param xml [Nokogiri::XML::Builder] The XML builder object
+    # @param checkstyle_file [CheckstyleFile] The CheckstyleFile object to be written
     def write_file(xml, checkstyle_file)
       xml.file(name: checkstyle_file.file) do
         checkstyle_file.errors.each do |error|
@@ -53,8 +63,10 @@ module CheckstyleReport
       end
     end
 
-    # @param {XML} xml
-    # @param {CheckstyleError} error
+    # Writes an error element to the XML report
+    #
+    # @param xml [Nokogiri::XML::Builder] The XML builder object
+    # @param error [CheckstyleError] The CheckstyleError object to be written
     def write_error(xml, error)
       xml.error(
         line: error.line,
@@ -66,39 +78,45 @@ module CheckstyleReport
     end
   end
 
-  # File representation for Checkstyle format
+  # Represents a file in Checkstyle format.
   class CheckstyleFile
-    # @param {String} file
-    # @param {CheckstyleError[]} errors
+    # Initializes a new instance of CheckstyleFile.
+    #
+    # @param file [String] The name of the file.
+    # @param errors [Array<CheckstyleError>] An array of CheckstyleError objects related to this file.
     def initialize(file, errors)
       @file = file
       @errors = errors
     end
 
-    attr_reader :file, :errors
+    # Returns the name of the file.
+    #
+    # @return [String] The name of the file.
+    attr_reader :file
+
+    # Returns the array of CheckstyleError objects related to this file.
+    #
+    # @return [Array<CheckstyleError>] An array of CheckstyleError objects related to this file.
+    attr_reader :errors
   end
 
-  # Checkstyle error representation
+  # Represents a single error in Checkstyle format.
   class CheckstyleError
-    SEVERITY_NORMAL = 'normal'.freeze
-    SEVERITY_WARNING = 'warning'.freeze
-    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,
-      source,
-      line,
-      column,
-      name
-    )
+    # Severity levels for Checkstyle errors.
+    SEVERITY_NORMAL = 'normal'
+    SEVERITY_WARNING = 'warning'
+    SEVERITY_ERROR = 'error'
+
+    # Initializes a new instance of CheckstyleError.
+    #
+    # @param severity [CheckstyleError] The severity level of the error.
+    # Must be one of SEVERITY_NORMAL, SEVERITY_WARNING, or SEVERITY_ERROR.
+    # @param message [String] The error message.
+    # @param source [String] The source of the error.
+    # @param line [Integer] The line number where the error occurred.
+    # @param column [Integer] The column number where the error occurred.
+    # @param name [String] The name of the error.
+    def initialize(severity, message, source, line, column, name)
       @severity = severity
       @message = message
       @source = source
@@ -107,8 +125,34 @@ module CheckstyleReport
       @name = name
     end
 
-    # rubocop:enable Metrics/ParameterLists
+    # Returns the severity level of the error.
+    #
+    # @return [String] The severity level of the error.
+    attr_reader :severity
+
+    # Returns the error message.
+    #
+    # @return [String] The error message.
+    attr_reader :message
+
+    # Returns the source of the error.
+    #
+    # @return [String] The source of the error.
+    attr_reader :source
+
+    # Returns the line number where the error occurred.
+    #
+    # @return [Integer] The line number where the error occurred.
+    attr_reader :line
+
+    # Returns the column number where the error occurred.
+    #
+    # @return [Integer] The column number where the error occurred.
+    attr_reader :column
 
-    attr_reader :severity, :message, :source, :line, :column, :name
+    # Returns the name of the error.
+    #
+    # @return [String] The name of the error.
+    attr_reader :name
   end
 end

data/lib/flutter_rb/checks/check.rb

@@ -1,32 +1,34 @@
+# frozen_string_literal: true
+
 module FlutterRb
-  # Base class for all checks
-  # Class provides default methods structure
-  # All methods using for create reports
+  # A class representing a check to be performed on a project.
   class Check
-    UNIMPLEMENTED_ERROR = 'Error: missing method'.freeze
+    # Error message to be raised when a method is not implemented.
+    UNIMPLEMENTED_ERROR = 'Error: missing method'
 
-    # @return {String}
+    # Returns the name of the check.
+    #
+    # @return [String] the name of the check
+    # @raise [RuntimeError] if the method is not implemented
     def name
       raise UNIMPLEMENTED_ERROR
     end
 
-    # @return {String}
-    def summary
-      raise UNIMPLEMENTED_ERROR
-    end
-
-    # @return {String}
+    # Returns a description of the check.
+    #
+    # @return [String] a description of the check
+    # @raise [RuntimeError] if the method is not implemented
     def description
-      'No provided'
+      raise UNIMPLEMENTED_ERROR
     end
 
-    # rubocop:disable Lint/UnusedMethodArgument
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check on the given project and returns a report.
+    #
+    # @param project [Project, nil] the project to be checked
+    # @return [CheckReport] the report of the check
+    # @raise [RuntimeError] if the method is not implemented
     def check(project)
       raise UNIMPLEMENTED_ERROR
     end
-
-    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/flutter_rb/checks/plugin_directories_check.rb

@@ -1,32 +1,38 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 
 module FlutterRb
-  # Check plugin directories structure.
-  # Example: if a Flutter plugin has only Android specific code
-  # but not contains iOS folder with description, then iOS build fails
+  # This class represents a check for plugin directories structure in a Flutter project.
   class PluginDirectoriesCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    #
+    # @return [String] The name of the check.
     def name
       'PluginDirectoriesCheck'
     end
 
-    # @return {String}
-    def summary
-      'Validate Flutter plugin structure'
-    end
-
-    # @return {String}
+    # Returns a description of the check.
+    #
+    # @return [String] A description of the check.
     def description
       'Check plugin directories structure in pubspec file'
     end
 
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check on the given project.
+    #
+    # @param project [Project] The project to perform the check on.
+    # @return [CheckReport] The report of the check result.
     def check(project)
+      # Check if android and ios folders exist.
       android_exists = !project.android_folder.nil?
       ios_exists = !project.ios_folder.nil?
+
+      # Determine the check result based on the existence of android and ios folders.
       check_result = android_exists && ios_exists || !android_exists && !ios_exists
+
+      # Create a new CheckReport with the result.
       CheckReport.new(
         name,
         check_result ? CheckReportStatus::NORMAL : CheckReportStatus::ERROR,

data/lib/flutter_rb/checks/plugin_gradle_check.rb

@@ -1,64 +1,81 @@
+# frozen_string_literal: true
+
 require_relative './check'
 require_relative '../report/check_report'
 
 module FlutterRb
-  # Check 'android; import not exists in Gradle project config (build.gradle file)
+  # This class represents a check for validating that the 'android' package
+  # does not exist in the Gradle project configuration.
   class PluginGradleAndroidPackageCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    #
+    # @return [String] The name of the check.
     def name
       'PluginGradleAndroidPackageCheck'
     end
 
-    # @return {String}
-    def summary
-      'Validate that \android\ package not exists in build.gradle config'
-    end
-
-    # @return {String}
+    # Returns the description of the check.
+    #
+    # @return [String] The description of the check.
     def description
       'Validate that \android\ package not exists in Gradle project config (build.gradle file)'
     end
 
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check on the given project.
+    #
+    # @param project [Project] The project to perform the check on.
+    # @return [CheckReport] The report of the check result.
     def check(project)
+      # Get the Gradle configuration file.
       gradle = project.android_folder.gradle
+
+      # Check if the 'package android' line exists in the build.gradle file.
       import_exist = File.readlines("#{gradle.path}/build.gradle").grep(/package android/).size.positive?
+
+      # Create a check report based on the result.
       CheckReport.new(
         name,
-        import_exist ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        import_exist ? ::CheckReportStatus::ERROR : ::CheckReportStatus::NORMAL,
         description,
         gradle.path
       )
     end
   end
 
-  # Check Flutter plugin version in Gradle project config (build.gradle file)
+  # This class represents a check for validating the version of the plugin in the Gradle project configuration.
   class PluginGradleVersionCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    #
+    # @return [String] The name of the check.
     def name
       'PluginGradleVersionCheck'
     end
 
-    # @return {String}
-    def summary
-      'Validate Flutter plugin\s version in build.gradle file'
-    end
-
-    # @return {String}
+    # Returns the description of the check.
+    #
+    # @return [String] The description of the check.
     def description
       'Check plugin version in Gradle project config (build.gradle file)'
     end
 
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check on the given project.
+    #
+    # @param project [Project] The project to perform the check on.
+    # @return [CheckReport] The report of the check result.
     def check(project)
+      # Get the version of the plugin from the pubspec file.
       version_in_pubspec = project.pubspec.pubspec_info.version
+
+      # Get the Gradle configuration file.
       gradle = project.android_folder.gradle
+
+      # Get the version of the plugin from the Gradle build file.
       version_in_gradle = gradle.version
+
+      # Create a check report based on the result.
       CheckReport.new(
         name,
-        version_in_pubspec == version_in_gradle ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        version_in_pubspec == version_in_gradle ? ::CheckReportStatus::NORMAL : ::CheckReportStatus::WARNING,
         description,
         gradle.path
       )