flutter_rb 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d708635770d65db09e97f3864f6e35ebcba46c13c84d6a388e6f10e9adc72e4
-  data.tar.gz: 1db4f12f4a0d23ba569a1c885eb3db6b295f11f2954594207750e738c91fa885
+  metadata.gz: f13846c798d97f27a3f1aee5da6c2df8c62ad46f60e76064c00e278fe53f1c99
+  data.tar.gz: 31b0ad31e7eec759f2090070abad08fce769ffae5ea2efb875855258ba5c2f2c
 SHA512:
-  metadata.gz: ce685d7cfeb7b65bd31113f167d91aa59fb5ba23368f744a4d1efa14d7b2f5e97e32e7b4fa2012a32ba2fafb94f29c6d30e68602e25648aff0fe7695bafc0ce5
-  data.tar.gz: 6d11387d9654065b86410ab14612ec2ac4711f181d8c56d9551f762d408b6ba00ba0c1b81f72145af283d970e17b51dafa0c8d545925dae11df65b7630bfd70c
+  metadata.gz: 39f79dbc0e055a351c6f710f0ccfc059b90ff43a396c8ae9ebf5a8ee3c84b8e27b9f0c989f5677e0d1ff3e694127933c636bfd8ef585cc0b501b529467b0ccf1
+  data.tar.gz: b8adab81e7ed3e12e1dd8f6d2d4057fe94399505e6ceaeac1399398ebfefe3d5f81d8bb90e308969957ce4b89142f1e4e8f53de2bf25763a28d4d4d714f1c3e9

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020-2023 Artem Fomchenkov
+Copyright (c) 2020-2024 Artem Fomchenkov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,4 @@
-<!--suppress CheckImageSize -->
-<img src="media/logo/ic_lib.png" height="100px" alt="Project's logo">
+<img src="media/logo/ic_lib.jpg" height="100px" alt="Project's logo">
 
 # flutter_rb
 
@@ -84,7 +83,7 @@ $ gem i flutter_rb
 Then run from a Flutter plugin's project folder:
 
 ```shell
-$ frb
+$ frb inspect --path=./project_folder
 ```
 
 ### As local executable
@@ -93,15 +92,39 @@ 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
 
@@ -129,6 +152,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

@@ -2,20 +2,5 @@
 
 # frozen_string_literal: true
 
+require_relative 'cli'
 require 'flutter_rb'
-require 'colorize'
-
-def light_blue_text(text)
-  text.colorize(:light_blue)
-end
-
-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

data/lib/checkstyle_report/checkstyle_report.rb

@@ -2,21 +2,24 @@
 
 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|
@@ -26,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|
@@ -42,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|
@@ -55,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,
@@ -68,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 levels for Checkstyle errors.
     SEVERITY_NORMAL = 'normal'
     SEVERITY_WARNING = 'warning'
     SEVERITY_ERROR = 'error'
 
-    # 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
-    )
+    # 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
@@ -109,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,34 +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
+    # 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

@@ -4,31 +4,35 @@ 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

@@ -4,63 +4,78 @@ 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
       )