flutter_rb 1.1.1 → 1.2.0

data/lib/flutter_rb/checks/plugin_podspec_check.rb

@@ -4,124 +4,155 @@ require_relative 'check'
 require_relative '../report/check_report'
 
 module FlutterRb
-  # Base class for all info parameters in Flutter plugin podspec file
+  # This class represents a check for Flutter plugin's podspec file.
+  # It is an abstract class and should be subclassed to perform specific checks.
   class PluginPodspecCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    # The name is constructed by appending the capitalized podspec_parameter to "PluginPodspecCheck".
+    #
+    # @return [String] the name of the check
     def name
       "PluginPodspec#{podspec_parameter.capitalize}Check"
     end
 
-    # @return {String}
+    # Returns the parameter for which the check is performed in the podspec file.
+    # This method should be implemented in subclasses to specify the specific parameter.
+    #
+    # @raise [RuntimeError] if the method is not implemented in a subclass
+    # @return [String] the parameter for which the check is performed
     def podspec_parameter
-      UNIMPLEMENTED_ERROR
+      raise UNIMPLEMENTED_ERROR
     end
 
-    # @return {String}
-    def summary
+    # Returns the description of the check.
+    # The description explains the purpose of the check,
+    # which is to validate a specific parameter in the Flutter plugin's podspec file.
+    #
+    # @return [String] the description of the check
+    def description
       "Validate Flutter plugin's #{podspec_parameter} in podspec file"
     end
   end
 
-  # Check Flutter plugin name in podspec file. Exists or not
+  # This class represents a check for Flutter plugin's name in the podspec file.
+  # It is a subclass of PluginPodspecCheck and overrides the necessary methods to perform the specific check.
   class PluginPodspecNameCheck < PluginPodspecCheck
-    # @return {String}
+    # Returns the parameter for which the check is performed in the podspec file.
+    # In this case, it returns 'name'.
+    #
+    # @return [String] the parameter for which the check is performed
     def podspec_parameter
       'name'
     end
 
-    # @return {String}
-    def description
-      'Check plugin name in podspec file'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the plugin's name in the podspec file.
+    # It compares the name in the pubspec file with the name in the podspec file.
+    # If they match, it returns a CheckReport with a normal status.
+    # If they do not match, it returns a CheckReport with a warning status.
+    #
+    # @param project [Project] the project for which the check is performed
+    # @return [CheckReport] the report of the check
     def check(project)
       name_in_pubspec = project.pubspec.pubspec_info.name
       podspec = project.ios_folder.podspec
       name_in_podspec = podspec.name
+
       CheckReport.new(
         name,
-        name_in_pubspec == name_in_podspec ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        name_in_pubspec == name_in_podspec ? ::CheckReportStatus::NORMAL : ::CheckReportStatus::WARNING,
         description,
         podspec.path
       )
     end
   end
 
-  # Check Flutter plugin version in podspec file. Exists or not
+  # This class represents a check for Flutter plugin's version in the podspec file.
+  # It is a subclass of PluginPodspecCheck and overrides the necessary methods to perform the specific check.
   class PluginPodspecVersionCheck < PluginPodspecCheck
-    # @return {String}
+    # Returns the parameter for which the check is performed in the podspec file.
+    # In this case, it returns 'version'.
+    #
+    # @return [String] the parameter for which the check is performed
     def podspec_parameter
       'version'
     end
 
-    # @return {String}
-    def description
-      'Check plugin version in podspec file'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the plugin's version in the podspec file.
+    # It compares the version in the pubspec file with the version in the podspec file.
+    # If they match, it returns a CheckReport with a normal status.
+    # If they do not match, it returns a CheckReport with a warning status.
+    #
+    # @param project [Project] the project for which the check is performed
+    # @return [CheckReport] the report of the check
     def check(project)
       version_in_pubspec = project.pubspec.pubspec_info.version
       podspec = project.ios_folder.podspec
       version_in_podspec = podspec.version
+
       CheckReport.new(
         name,
-        version_in_pubspec == version_in_podspec ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        version_in_pubspec == version_in_podspec ? ::CheckReportStatus::NORMAL : ::CheckReportStatus::WARNING,
         description,
         podspec.path
       )
     end
   end
 
-  # Check Flutter plugin's authors. Exists or not
+  # This class represents a check for Flutter plugin's authors in the podspec file.
+  # It is a subclass of PluginPodspecCheck and overrides the necessary methods to perform the specific check.
   class PluginPodspecAuthorsCheck < PluginPodspecCheck
-    # @return {String}
+    # Returns the parameter for which the check is performed in the podspec file.
+    # In this case, it returns 'authors'.
+    #
+    # @return [String] the parameter for which the check is performed
     def podspec_parameter
       'authors'
     end
 
-    # @return {String}
-    def description
-      "Check plugin's authors in podspec file"
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the plugin's authors in the podspec file.
+    # It checks if the 'authors' parameter is present in the podspec file.
+    # If it is present, it returns a CheckReport with a normal status.
+    # If it is not present, it returns a CheckReport with an error status.
+    #
+    # @param project [Project] the project for which the check is performed
+    # @return [CheckReport] the report of the check
     def check(project)
       podspec = project.ios_folder.podspec
       author_exists = !podspec.authors.nil?
+
       CheckReport.new(
         name,
-        author_exists ? CheckReportStatus::NORMAL : CheckReportStatus::ERROR,
+        author_exists ? ::CheckReportStatus::NORMAL : ::CheckReportStatus::ERROR,
         description,
         podspec.path
       )
     end
   end
 
-  # Check plugin iOS source path in podspec file.
-  # If Flutter plugin cannot contains iOS specific code, source path must be '.'
+  # This class represents a check for Flutter plugin's source in the podspec file.
+  # It is a subclass of PluginPodspecCheck and overrides the necessary methods to perform the specific check.
   class PluginPodspecSourceCheck < PluginPodspecCheck
-    # @return {String}
+    # Returns the parameter for which the check is performed in the podspec file.
+    # In this case, it returns 'source'.
+    #
+    # @return [String] the parameter for which the check is performed
     def podspec_parameter
       'source'
     end
 
-    # @return {String}
-    def description
-      'Check plugin iOS source path in podspec file'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the plugin's source in the podspec file.
+    # It checks if the 'source' parameter is present in the podspec file.
+    # If it is present, it returns a CheckReport with a normal status.
+    # If it is not present, it returns a CheckReport with an error status.
+    #
+    # @param project [Project] the project for which the check is performed
+    # @return [CheckReport] the report of the check
     def check(project)
       podspec = project.ios_folder.podspec
+
       CheckReport.new(
         name,
-        podspec.source.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        podspec.source.nil? ? ::CheckReportStatus::ERROR : ::CheckReportStatus::NORMAL,
         description,
         podspec.path
       )

data/lib/flutter_rb/checks/plugin_pubspec_check.rb

@@ -4,40 +4,54 @@ require_relative 'check'
 require_relative '../report/check_report'
 
 module FlutterRb
-  # Base class for all info parameters in Flutter plugin pubspec.yaml file
+  # This class represents a check for Flutter plugin's pubspec.yaml file.
+  # It is an abstract class and should be subclassed to perform specific checks.
   class PluginPubspecCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    # The name is constructed by appending the capitalized pubspec_parameter to "PluginPubspecCheck".
+    #
+    # @return [String] the name of the check
     def name
       "PluginPubspec#{pubspec_parameter.capitalize}Check"
     end
 
-    # @return {String}
+    # Returns the parameter to be checked in the pubspec.yaml file.
+    # This method should be implemented in subclasses to specify the specific parameter to be checked.
+    #
+    # @raise [NotImplementedError] if not implemented in subclasses
+    # @return [String] the parameter to be checked
     def pubspec_parameter
       raise UNIMPLEMENTED_ERROR
     end
 
-    # @return {String}
-    def summary
+    # Returns the description of the check.
+    # The description explains what the check is validating.
+    #
+    # @return [String] the description of the check
+    def description
       "Validate Flutter plugin's #{pubspec_parameter} in pubspec.yaml"
     end
   end
 
-  # Check Flutter plugin name in podspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'name' parameter.
+  # It inherits from PluginPubspecCheck class.
   class PluginPubspecNameCheck < PluginPubspecCheck
-    # @return {String}
+    # Returns the parameter to be checked in the pubspec.yaml file.
+    # In this case, it returns 'name'.
+    #
+    # @return [String] the parameter to be checked
     def pubspec_parameter
       'name'
     end
 
-    # @return {String}
-    def description
-      'Check plugin name in pubspec file'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'name' parameter in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+
       CheckReport.new(
         name,
         pubspec.pubspec_info.name.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
@@ -47,22 +61,25 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin description in pubspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'description' parameter.
+  # It inherits from PluginPubspecCheck class.
   class PluginPubspecDescriptionCheck < PluginPubspecCheck
-    # @return {String}
+    # Returns the parameter to be checked in the pubspec.yaml file.
+    # In this case, it returns 'description'.
+    #
+    # @return [String] the parameter to be checked
     def pubspec_parameter
       'description'
     end
 
-    # @return {String}
-    def description
-      'Check plugin description in pubspec file'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'description' parameter in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+
       CheckReport.new(
         name,
         pubspec.pubspec_info.description.nil? ? CheckReportStatus::WARNING : CheckReportStatus::NORMAL,
@@ -72,22 +89,25 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin version in pubspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'version' parameter.
+  # It inherits from PluginPubspecCheck class.
   class PluginPubspecVersionCheck < PluginPubspecCheck
-    # @return {String}
+    # Returns the parameter to be checked in the pubspec.yaml file.
+    # In this case, it returns 'version'.
+    #
+    # @return [String] the parameter to be checked
     def pubspec_parameter
       'version'
     end
 
-    # @return {String}
-    def description
-      'Check plugin version in pubspec'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'version' parameter in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+
       CheckReport.new(
         name,
         pubspec.pubspec_info.version.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
@@ -97,22 +117,25 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin author in pubspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'author' parameter.
+  # It inherits from PluginPubspecCheck class.
   class PluginPubspecAuthorCheck < PluginPubspecCheck
-    # @return {String}
+    # Returns the parameter to be checked in the pubspec.yaml file.
+    # In this case, it returns 'author'.
+    #
+    # @return [String] the parameter to be checked
     def pubspec_parameter
       'author'
     end
 
-    # @return {String}
-    def description
-      'Check plugin author in pubspec'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'author' parameter in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+
       CheckReport.new(
         name,
         pubspec.pubspec_info.author.nil? ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
@@ -122,22 +145,25 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin homepage in pubspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'homepage' parameter.
+  # It inherits from PluginPubspecCheck class.
   class PluginPubspecHomepageCheck < PluginPubspecCheck
-    # @return {String}
+    # Returns the parameter to be checked in the pubspec.yaml file.
+    # In this case, it returns 'homepage'.
+    #
+    # @return [String] the parameter to be checked
     def pubspec_parameter
       'homepage'
     end
 
-    # @return {String}
-    def description
-      'Check plugin homepage in pubspec'
-    end
-
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'homepage' parameter in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+
       CheckReport.new(
         name,
         pubspec.pubspec_info.homepage.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
@@ -147,30 +173,37 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin lints dependency in pubspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'lints' dependency.
+  # It inherits from the Check class.
   class PluginPubspecLintsCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    #
+    # @return [String] the name of the check
     def name
       'PluginPubspecLintsCheck'
     end
 
-    # @return {String}
-    def summary
-      'Validate Flutter plugin\'s lints rules implementation in pubspec.yaml'
-    end
-
-    # @return {String}
+    # Returns the description of the check.
+    # The description explains what the check is validating.
+    #
+    # @return [String] the description of the check
     def description
       'Check Flutter plugin lints dependency in pubspec file'
     end
 
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'lints' dependency in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+      # Detects if 'lints' is a dependency in the pubspec file
       lints = pubspec.dev_dependencies&.detect do |dev_dependency|
         dev_dependency.name == 'lints'
       end
+
+      # Creates a CheckReport object with the result of the check
       CheckReport.new(
         name,
         lints.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
@@ -180,30 +213,37 @@ module FlutterRb
     end
   end
 
-  # Check Flutter plugin flutter_lints dependency in pubspec file. Exists or not
+  # This class represents a check for Flutter plugin's pubspec.yaml file for 'flutter_lints' dependency.
+  # It inherits from the Check class.
   class PluginPubspecFlutterLintsCheck < Check
-    # @return {String}
+    # Returns the name of the check.
+    #
+    # @return [String] the name of the check
     def name
       'PluginPubspecFlutterLintsCheck'
     end
 
-    # @return {String}
-    def summary
-      'Validate Flutter plugin\'s flutter_lints rules implementation in pubspec.yaml'
-    end
-
-    # @return {String}
+    # Returns the description of the check.
+    # The description explains what the check is validating.
+    #
+    # @return [String] the description of the check
     def description
       'Check Flutter plugin flutter_lints dependency in pubspec file'
     end
 
-    # @param {Project} project
-    # @return {CheckReport}
+    # Performs the check for the 'flutter_lints' dependency in the pubspec.yaml file.
+    # It creates a CheckReport object with the result of the check.
+    #
+    # @param project [Project] the project to be checked
+    # @return [CheckReport] the report of the check result
     def check(project)
       pubspec = project.pubspec
+      # Detects if 'flutter_lints' is a dependency in the pubspec file
       flutter_lints = pubspec.dev_dependencies&.detect do |dev_dependency|
         dev_dependency.name == 'flutter_lints'
       end
+
+      # Creates a CheckReport object with the result of the check
       CheckReport.new(
         name,
         flutter_lints.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,

data/lib/flutter_rb/config/flutter_rb_config.rb

@@ -1,17 +1,27 @@
 # frozen_string_literal: true
 
 module FlutterRb
-  # FlutterRb configuration representation from config in Flutter plugin
+  # This class represents the configuration for FlutterRb checks.
+  # It holds arrays of checks for Flutter, Android, and iOS platforms.
   class FlutterRbConfig
-    # @param {Check[]} flutter_checks
-    # @param {Check[]} android_checks
-    # @param {Check[]} ios_checks
+    # Initializes a new instance of FlutterRbConfig.
+    #
+    # @param flutter_checks [Array<Check>] An array of Flutter checks.
+    # @param android_checks [Array<Check>] An array of Android checks.
+    # @param ios_checks [Array<Check>] An array of iOS checks.
     def initialize(flutter_checks, android_checks, ios_checks)
       @flutter_checks = flutter_checks
       @android_checks = android_checks
       @ios_checks = ios_checks
     end
 
-    attr_accessor :flutter_checks, :android_checks, :ios_checks
+    # Provides read and write access to the flutter_checks attribute.
+    attr_accessor :flutter_checks
+
+    # Provides read and write access to the android_checks attribute.
+    attr_accessor :android_checks
+
+    # Provides read and write access to the ios_checks attribute.
+    attr_accessor :ios_checks
   end
 end

data/lib/flutter_rb/config/flutter_rb_config_initializer.rb

@@ -6,8 +6,9 @@ require_relative '../checks/plugin_directories_check'
 require 'yaml'
 
 module FlutterRb
-  # Class that initialize configuration
+  # This class is responsible for initializing a FlutterRbConfig object.
   class FlutterRbConfigInitializer
+    # An array of Flutter checks to be performed.
     FLUTTER_CHECKS = [
       PluginDirectoriesCheck.new,
       PluginPubspecNameCheck.new,
@@ -19,11 +20,13 @@ module FlutterRb
       PluginPubspecFlutterLintsCheck.new
     ].freeze
 
+    # An array of Android checks to be performed.
     ANDROID_CHECKS = [
       PluginGradleAndroidPackageCheck.new,
       PluginGradleVersionCheck.new
     ].freeze
 
+    # An array of iOS checks to be performed.
     IOS_CHECKS = [
       PluginPodspecNameCheck.new,
       PluginPodspecVersionCheck.new,
@@ -31,9 +34,10 @@ module FlutterRb
       PluginPodspecSourceCheck.new
     ].freeze
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-    # @param {String} path
-    # @return {FlutterRbConfig}
+    # Parses a YAML configuration file and initializes a FlutterRbConfig object.
+    #
+    # @param path [String] The path to the YAML configuration file.
+    # @return [FlutterRbConfig] A FlutterRbConfig object initialized with the parsed configuration.
     def parse(path)
       config = YAML.load_file(path)
 
@@ -64,9 +68,9 @@ module FlutterRb
       )
     end
 
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-
-    # @return {FlutterRbConfig}
+    # Initializes a FlutterRbConfig object with the default checks.
+    #
+    # @return [FlutterRbConfig] A FlutterRbConfig object initialized with the default checks.
     def default
       FlutterRbConfig.new(
         FLUTTER_CHECKS,