flutter_rb 1.1.1 → 1.2.0

data/lib/flutter_rb/project/project.rb

@@ -10,12 +10,14 @@ require_relative './specs/ios/ios_folder'
 require 'yaml'
 
 module FlutterRb
-  # Project representation
+  # Represents a Flutter project.
   class Project
-    # @param {String} path
-    # @param {Pubspec} pubspec
-    # @param {AndroidFolder} android_folder
-    # @param {IOSFolder} ios_folder
+    # Initializes a new instance of Project.
+    #
+    # @param path [String] The path to the Flutter project.
+    # @param pubspec [Pubspec] The parsed pubspec of the project.
+    # @param android_folder [AndroidFolder, nil] The parsed Android folder of the project.
+    # @param ios_folder [IOSFolder, nil] The parsed iOS folder of the project.
     def initialize(path, pubspec, android_folder, ios_folder)
       @path = path
       @pubspec = pubspec
@@ -23,29 +25,54 @@ module FlutterRb
       @ios_folder = ios_folder
     end
 
-    attr_accessor :path, :pubspec, :android_folder, :ios_folder
+    # Accessor for the path of the project.
+    #
+    # @return [String] The path of the project.
+    attr_accessor :path
+
+    # Accessor for the pubspec of the project.
+    #
+    # @return [Pubspec] The pubspec of the project.
+    attr_accessor :pubspec
+
+    # Accessor for the Android folder of the project.
+    #
+    # @return [AndroidFolder] The Android folder of the project.
+    attr_accessor :android_folder
+
+    # Accessor for the iOS folder of the project.
+    #
+    # @return [IOSFolder] The iOS folder of the project.
+    attr_accessor :ios_folder
   end
 
-  # Flutter plugin project parser
+  # Class to parse and represent a Flutter project.
   class ProjectParser
-    # @param {String} path
+    # Initializes a new instance of ProjectParser.
+    #
+    # @param path [String] The path to the Flutter project.
     def initialize(path)
       @path = path
     end
 
-    # @return {Project}
+    # Parses the Flutter project at the given path and returns a Project object.
+    #
+    # @return [Project, nil] A Project object if the project exists and can be parsed, otherwise nil.
     def project
       File.exist?("#{@path}/pubspec.yaml") ? parse_project : nil
     end
 
     private
 
-    # @return {Project}
+    # Parses the project at the given path and returns a Project object.
+    #
+    # @return [Project] A Project object representing the parsed project.
     def parse_project
       pubspec_path = "#{@path}/pubspec.yaml"
       android_path = "#{@path}/android"
       ios_path = "#{@path}/ios"
       pubspec = PubspecParser.new(pubspec_path, YAML.load_file(pubspec_path)).parse
+
       Project.new(
         @path,
         pubspec,

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

@@ -3,14 +3,25 @@
 require_relative './gradle'
 
 module FlutterRb
-  # Android project representation
+  # Represents an Android project folder.
   class AndroidFolder
-    # @param {String} path
+    # Initializes a new instance of AndroidFolder.
+    #
+    # @param path [String] The path to the Android project folder.
     def initialize(path)
       @path = path
+      # Parse the Gradle build file and store the parsed data.
       @gradle = GradleParser.new(@path).parse
     end
 
-    attr_reader :path, :gradle
+    # Returns the path to the Android project folder.
+    #
+    # @return [String] The path to the Android project folder.
+    attr_reader :path
+
+    # Returns the parsed Gradle build file data.
+    #
+    # @return [GradleParser] The parsed Gradle build file data.
+    attr_reader :gradle
   end
 end

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

@@ -3,31 +3,55 @@
 require 'json'
 
 module FlutterRb
-  # Gradle representation
+  # Represents a Gradle project.
   class Gradle
-    # @param {String} path
-    # @param {String} version
+    # Initializes a new Gradle instance.
+    #
+    # @param path [String] The path to the Gradle project.
+    # @param version [String] The version of Gradle being used.
     def initialize(path, version)
       @path = path
       @version = version
     end
 
-    attr_reader :path, :version
+    # Returns the path to the Gradle project.
+    #
+    # @return [String] The path to the Gradle project.
+    attr_reader :path
+
+    # Returns the version of Gradle being used.
+    #
+    # @return [String] The version of Gradle being used.
+    attr_reader :version
   end
 
-  # Gradle parser
+  # This class is responsible for parsing Gradle project information.
   class GradleParser
-    # @param {String} path
+    # Initializes a new GradleParser instance.
+    #
+    # @param path [String] The path to the Gradle project.
     def initialize(path)
       @path = path
     end
 
-    # @return {Gradle}
+    # Parses the Gradle project information.
+    #
+    # Executes the 'prepareInfo' task in the Gradle project and reads the generated JSON file.
+    # If the JSON file does not exist, it raises an error.
+    #
+    # @return [Gradle] An instance of Gradle with the parsed information.
     def parse
-      `gradle -p #{@path} -q prepareInfo`
-      info_file = File.read "#{@path}/flutter_rb_gradle_plugin_output.json"
-      info = JSON.parse info_file
-      Gradle.new(@path, info['version'])
+      `gradle -p #{@path} -q prepareInfo` # Execute the 'prepareInfo' task in the Gradle project
+      info_file_path = "#{@path}/flutter_rb_gradle_plugin_output.json" # Path to the JSON file
+
+      unless File.exist?(info_file_path) # Check if the JSON file exists
+        raise "Could not find Gradle info file at #{info_file_path}" # Raise an error if the JSON file does not exist
+      end
+
+      info_file = File.read info_file_path # Read the JSON file
+      info = JSON.parse info_file # Parse the JSON content
+
+      Gradle.new(@path, info['version']) # Create a new Gradle instance with the parsed information
     end
   end
 end

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

@@ -1,15 +1,25 @@
 # frozen_string_literal: true
 
 module FlutterRb
-  # Dev dependency, contains name and version
+  # Represents a development dependency in a Flutter project.
   class DevDependency
-    # @param {String} name
-    # @param {String} version
+    # Initializes a new instance of DevDependency.
+    #
+    # @param name [String] The name of the development dependency.
+    # @param version [String] The version of the development dependency.
     def initialize(name, version)
       @name = name
       @version = version
     end
 
-    attr_reader :name, :version
+    # Returns the name of the development dependency.
+    #
+    # @return [String] The name of the development dependency.
+    attr_reader :name
+
+    # Returns the version of the development dependency.
+    #
+    # @return [String] The version of the development dependency.
+    attr_reader :version
   end
 end

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

@@ -1,23 +1,41 @@
 # frozen_string_literal: true
 
 module FlutterRb
-  # Flutter plugin, contains platform, package and plugin class
+  # Represents a Flutter platform plugin.
   class PlatformPlugin
-    # @param {String} platform
-    # @param {String} package
-    # @param {String} plugin_class
+    # Initializes a new instance of PlatformPlugin.
+    #
+    # @param platform [String] The platform this plugin is for.
+    # @param package [String] The package name of the plugin.
+    # @param plugin_class [String] The class name of the plugin.
     def initialize(platform, package, plugin_class)
       @platform = platform
       @package = package
       @plugin_class = plugin_class
     end
 
-    attr_reader :platform, :package, :plugin_class
+    # Returns the platform this plugin is for.
+    #
+    # @return [String] The platform.
+    attr_reader :platform
+
+    # Returns the package name of the plugin.
+    #
+    # @return [String] The package name.
+    attr_reader :package
+
+    # Returns the class name of the plugin.
+    #
+    # @return [String] The class name.
+    attr_reader :plugin_class
   end
 
-  # Supported platforms for this tool
+  # Represents a platform in Flutter.
   class Platform
+    # The Android platform constant.
     ANDROID = 'android'
+
+    # The iOS platform constant.
     IOS = 'ios'
   end
 end

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

@@ -5,12 +5,14 @@ require_relative './dev_dependency'
 require_relative './platform_plugin'
 
 module FlutterRb
-  # pubspec.yaml representation
+  # Represents a parsed pubspec.yaml file.
   class Pubspec
-    # @param {String} path
-    # @param {PubspecInfo} pubspec_info
-    # @param {DevDependency[]} dev_dependencies
-    # @param {PlatformPlugin[]} platform_plugins
+    # Initializes a new instance of Pubspec.
+    #
+    # @param path [String] The path to the pubspec.yaml file.
+    # @param pubspec_info [PubspecInfo] The parsed information from the pubspec.yaml file.
+    # @param dev_dependencies [Array<DevDependency>] An array of parsed dev dependencies.
+    # @param platform_plugins [Array<PlatformPlugin>] An array of parsed platform plugins.
     def initialize(path, pubspec_info, dev_dependencies, platform_plugins)
       @path = path
       @pubspec_info = pubspec_info
@@ -18,19 +20,41 @@ module FlutterRb
       @platform_plugins = platform_plugins
     end
 
-    attr_reader :path, :pubspec_info, :dev_dependencies, :platform_plugins
+    # Returns the path to the pubspec.yaml file.
+    #
+    # @return [String] The path to the pubspec.yaml file.
+    attr_reader :path
+
+    # Returns the parsed information from the pubspec.yaml file.
+    #
+    # @return [PubspecInfo] The parsed information from the pubspec.yaml file.
+    attr_reader :pubspec_info
+
+    # Returns an array of parsed dev dependencies.
+    #
+    # @return [Array<DevDependency>] An array of parsed dev dependencies.
+    attr_reader :dev_dependencies
+
+    # Returns an array of parsed platform plugins.
+    #
+    # @return [Array<PlatformPlugin>] An array of parsed platform plugins.
+    attr_reader :platform_plugins
   end
 
-  # pubspec.yaml parser
+  # This class is responsible for parsing a pubspec.yaml file and creating a Pubspec object.
   class PubspecParser
-    # @param {String} path
-    # @param {Pubspec} pubspec
+    # Initializes a new instance of PubspecParser.
+    #
+    # @param path [String] The path to the pubspec.yaml file.
+    # @param pubspec [Hash] The parsed pubspec.yaml file as a Hash.
     def initialize(path, pubspec)
       @path = path
       @pubspec = pubspec
     end
 
-    # @return {Pubspec}
+    # Parses the pubspec.yaml file and creates a Pubspec object.
+    #
+    # @return [Pubspec] The parsed Pubspec object.
     def parse
       Pubspec.new(
         @path,
@@ -40,8 +64,10 @@ module FlutterRb
       )
     end
 
-    # @param {Pubspec}
-    # @return {PubspecInfo}
+    # Parses the pubspec.yaml file and extracts the general information.
+    #
+    # @param pubspec [Hash] The parsed pubspec.yaml file as a Hash.
+    # @return [PubspecInfo] The parsed PubspecInfo object.
     def pubspec_info(pubspec)
       PubspecInfo.new(
         pubspec['name'],
@@ -52,8 +78,10 @@ module FlutterRb
       )
     end
 
-    # @param {Pubspec} pubspec
-    # @return {DevDependency[]}
+    # Parses the pubspec.yaml file and extracts the dev dependencies.
+    #
+    # @param pubspec [Hash] The parsed pubspec.yaml file as a Hash.
+    # @return [Array<DevDependency>] An array of parsed DevDependency objects.
     def dev_dependencies(pubspec)
       pubspec['dev_dependencies']&.map do |dev_dependency|
         DevDependency.new(
@@ -63,11 +91,14 @@ module FlutterRb
       end
     end
 
-    # @param {Pubspec} pubspec
-    # @return {PlatformPlugin[]}
+    # Parses the pubspec.yaml file and extracts the platform plugins.
+    #
+    # @param pubspec [Hash] The parsed pubspec.yaml file as a Hash.
+    # @return [Array<PlatformPlugin>] An array of parsed PlatformPlugin objects.
     def platform_plugins(pubspec)
       pubspec.dig('flutter', 'plugin', 'platforms')&.map do |platform_plugin|
         plugin_info = platform_plugin.last
+
         PlatformPlugin.new(
           plugin_info['package'],
           plugin_info['pluginClass'],

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

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 module FlutterRb
-  # Flutter plugin info from pubspec.yaml
+  # Represents the information contained in a Flutter project's pubspec.yaml file.
   class PubspecInfo
-    # @param {String} name
-    # @param {String} description
-    # @param {String} version
-    # @param {String} author
-    # @param {String} homepage
+    # Initializes a new instance of PubspecInfo.
+    #
+    # @param name [String] The name of the Flutter project.
+    # @param description [String] A brief description of the Flutter project.
+    # @param version [String] The version number of the Flutter project.
+    # @param author [String] The author of the Flutter project.
+    # @param homepage [String] The homepage URL of the Flutter project.
     def initialize(name, description, version, author, homepage)
       @name = name
       @description = description
@@ -16,6 +18,24 @@ module FlutterRb
       @homepage = homepage
     end
 
-    attr_reader :name, :description, :version, :author, :homepage
+    # Returns the name of the Flutter project.
+    # @return [String] The name of the Flutter project.
+    attr_reader :name
+
+    # Returns the brief description of the Flutter project.
+    # @return [String] The brief description of the Flutter project.
+    attr_reader :description
+
+    # Returns the version number of the Flutter project.
+    # @return [String] The version number of the Flutter project.
+    attr_reader :version
+
+    # Returns the author of the Flutter project.
+    # @return [String] The author of the Flutter project.
+    attr_reader :author
+
+    # Returns the homepage URL of the Flutter project.
+    # @return [String] The homepage URL of the Flutter project.
+    attr_reader :homepage
   end
 end

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

@@ -3,16 +3,30 @@
 require_relative './podspec'
 
 module FlutterRb
-  # iOS representation
+  # Represents the iOS folder structure and its associated podspec file.
   class IOSFolder
-    # @param {String} path
-    # @param {Pubspec} pubspec
+    # Initializes a new instance of IOSFolder.
+    #
+    # @param path [String] The path to the iOS folder.
+    # @param pubspec [Pubspec] The parsed pubspec information.
+    #
+    # @return [IOSFolder] A new instance of IOSFolder.
     def initialize(path, pubspec)
       @path = path
+      # Construct the path to the podspec file.
       podspec_path = "#{path}/#{pubspec.pubspec_info.name}.podspec"
+      # If the podspec file exists, parse it; otherwise, set @podspec to nil.
       @podspec = File.exist?(podspec_path) ? PodspecParser.new(podspec_path).parse : nil
     end
 
-    attr_reader :path, :podspec
+    # Returns the path to the iOS folder.
+    #
+    # @return [String] The path to the iOS folder.
+    attr_reader :path
+
+    # Returns the parsed podspec information.
+    #
+    # @return [Podspec, nil] The parsed podspec information, or nil if the podspec file does not exist.
+    attr_reader :podspec
   end
 end

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

@@ -3,13 +3,15 @@
 require 'cocoapods'
 
 module FlutterRb
-  # Podspec representation
+  # Represents a parsed Podspec file.
   class Podspec
-    # @param {String} path
-    # @param {String} name
-    # @param {String} version
-    # @param {String[]} authors
-    # @param {String} source
+    # Initializes a new instance of Podspec.
+    #
+    # @param path [String] The path to the Podspec file.
+    # @param name [String] The name of the Podspec.
+    # @param version [String] The version of the Podspec.
+    # @param authors [Array<String>] The authors of the Podspec.
+    # @param source [String] The source of the Podspec.
     def initialize(path, name, version, authors, source)
       @path = path
       @name = name
@@ -18,19 +20,51 @@ module FlutterRb
       @source = source
     end
 
-    attr_reader :path, :name, :version, :authors, :source
+    # Returns the path to the Podspec file.
+    #
+    # @return [String] The path to the Podspec file.
+    attr_reader :path
+
+    # Returns the name of the Podspec.
+    #
+    # @return [String] The name of the Podspec.
+    attr_reader :name
+
+    # Returns the version of the Podspec.
+    #
+    # @return [String] The version of the Podspec.
+    attr_reader :version
+
+    # Returns the authors of the Podspec.
+    #
+    # @return [Array<String>] The authors of the Podspec.
+    attr_reader :authors
+
+    # Returns the source of the Podspec.
+    #
+    # @return [String] The source of the Podspec.
+    attr_reader :source
   end
 
-  # Podspec parser
+  # Represents a parser for Podspec files.
   class PodspecParser
-    # @param {String} path
+    # Initializes a new instance of PodspecParser.
+    #
+    # @param path [String] The path to the Podspec file to be parsed.
     def initialize(path)
       @path = path
     end
 
-    # @return {Podspec}
+    # Parses the Podspec file at the given path and returns a Podspec object.
+    #
+    # @return [Podspec] A Podspec object representing the parsed Podspec file.
+    #
+    # @raise [Pod::DSLError] If there is an error parsing the Podspec file.
     def parse
+      # Parse the Podspec file using CocoaPods' Pod::Specification.
       podspec = Pod::Specification.from_file(@path)
+
+      # Create a new Podspec object with the parsed data.
       @podspec = Podspec.new(
         @path,
         podspec.name,

data/lib/flutter_rb/report/check_report.rb

@@ -4,11 +4,14 @@ require 'colorize'
 
 module FlutterRb
   # Check report
+  # Represents a report for a specific check.
   class CheckReport
-    # @param {String} check_name
-    # @param {CheckReportStatus} check_report_status
-    # @param {String} message
-    # @param {String} path
+    # Initializes a new instance of CheckReport.
+    #
+    # @param check_name [String] The name of the check.
+    # @param check_report_status [String] The status of the check report.
+    # @param message [String] The message associated with the check report.
+    # @param path [String] The path associated with the check report.
     def initialize(check_name, check_report_status, message, path)
       @check_name = check_name
       @check_report_status = check_report_status
@@ -16,8 +19,10 @@ module FlutterRb
       @path = path
     end
 
-    # @param {Bool} colorize
-    # @return {String}
+    # Prints the check report.
+    #
+    # @param colorize [Bool] Whether to colorize the output or not. Default is true.
+    # @return [String] The formatted check report.
     def print(colorize: true)
       if colorize
         status_color = color_for_report_status(@check_report_status)
@@ -27,8 +32,10 @@ module FlutterRb
       end
     end
 
-    # @param {CheckReportStatus} check_report_status
-    # @return {Presenter}
+    # Determines the color for the check report status.
+    #
+    # @param check_report_status [CheckReportStatus] The status of the check report.
+    # @return [Symbol] The color associated with the check report status.
     def color_for_report_status(check_report_status)
       case check_report_status
       when CheckReportStatus::NORMAL
@@ -42,13 +49,28 @@ module FlutterRb
       end
     end
 
-    attr_reader :check_name, :check_report_status, :message, :path
+    # Reader for check_name attribute.
+    attr_reader :check_name
+
+    # Reader for check_report_status attribute.
+    attr_reader :check_report_status
+
+    # Reader for message attribute.
+    attr_reader :message
+
+    # Reader for path attribute.
+    attr_reader :path
   end
 
-  # Check report status
+  # Represents the status of a check report.
   class CheckReportStatus
+    # Constant representing a normal status.
     NORMAL = 'normal'
+
+    # Constant representing a warning status.
     WARNING = 'warning'
+
+    # Constant representing an error status.
     ERROR = 'error'
   end
 end