flutter_rb 1.0.2 → 1.2.0

data/lib/flutter_rb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './flutter_rb/project/project'
 require_relative './flutter_rb/checks/plugin_directories_check'
 require_relative './flutter_rb/checks/plugin_pubspec_check'
@@ -8,12 +10,19 @@ require_relative './flutter_rb/config/flutter_rb_config_initializer'
 require_relative './checkstyle_report/checkstyle_report'
 
 module FlutterRb
-  # Start FlutterRb checks
-  # @param {String} path
-  # @param {Bool} with_report
+  # FlutterRb entry
   class FlutterRb
+    # This class is the entry point for FlutterRb checks.
+    # It provides methods to start the checks, handle project parsing,
+    # explore project directories, create reports, and handle exit codes.
+
+    # Start FlutterRb checks
+    #
+    # @param path [String] The path to the Flutter project directory
+    # @param with_report [Boolean] Whether to generate a report or not
     def start(path, with_report)
       project = ProjectParser.new(path).project
+
       if project.nil?
         exit_with_no_project
       else
@@ -25,15 +34,21 @@ module FlutterRb
       end
     end
 
+    # Exit the program with a message indicating no project found
+    #
+    # @return [Void]
     def exit_with_no_project
       puts 'No project'
+
       exit(-1)
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    # @param {Project} project
-    # @param {String} path
-    # @param {Bool} with_report
+    # Check the Flutter project
+    #
+    # @param project [Project] The parsed Flutter project
+    # @param path [String] The path to the Flutter project directory
+    # @param with_report [Boolean] Whether to generate a report or not
+    # @return [Void]
     def check_project(project, path, with_report)
       config_initializer = FlutterRbConfigInitializer.new
       config_path = "#{path}/.flutter_rb.yaml"
@@ -44,45 +59,36 @@ module FlutterRb
         config.android_checks,
         config.ios_checks
       )
+
       checks.each { |check| puts check.print }
-      errors = checks.reject do |check|
-        check.check_report_status == CheckReportStatus::NORMAL
-      end
+      errors = checks.reject { |check| check.check_report_status == CheckReportStatus::NORMAL }
+
       create_report(path, checks) if with_report
+
       exit(errors.empty? ? 0 : -1)
     end
 
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-    # rubocop:disable Metrics/MethodLength
-    # @param {Project} project
-    # @param {Check[]} flutter_checks
-    # @param {Check[]} android_checks
-    # @param {Check[]} ios_checks
+    # Explore the Flutter project directories and perform checks
+    #
+    # @param project [Project] The parsed Flutter project
+    # @param flutter_checks [Check[]] The checks to perform on the Flutter project
+    # @param android_checks [Check[]] The checks to perform on the Android project
+    # @param ios_checks [Check[]] The checks to perform on the iOS project
+    # @return [Check[]] The results of the performed checks
     def explore_project(project, flutter_checks, android_checks, ios_checks)
       result = []
-      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 += 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
     end
 
-    # rubocop:enable Metrics/MethodLength
-
-    # rubocop:disable Metrics/MethodLength
-    # @param {String} path
-    # @param {Check[]} checks
-    # @return {CheckstyleReport}
+    # Create a report based on the performed checks
+    #
+    # @param path [String] The path to the Flutter project directory
+    # @param checks [Check[]] The results of the performed checks
+    # @return [CheckstyleReport] The created report
     def create_report(path, checks)
       errors = checks.map do |check|
         CheckstyleReport::CheckstyleError.new(
@@ -101,10 +107,10 @@ module FlutterRb
       ).create_report
     end
 
-    # rubocop:enable Metrics/MethodLength
-
-    # @param {CheckReportStatus} check_report_status
-    # @return {CheckstyleReport}
+    # Determine the severity level for a check report status
+    #
+    # @param check_report_status [CheckReportStatus] The status of the check report
+    # @return [String] The severity level for the report
     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.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-19 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -38,6 +38,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.6.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +144,6 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- CODE_OF_CONDUCT.md
-- COMMIT_CONVENTION.md
 - LICENSE
 - README.md
 - bin/frb

data/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at jaman.smlnsk@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

data/COMMIT_CONVENTION.md

@@ -1,58 +0,0 @@
-# Commit Convention
-
-## How to work with a project
-
-### As a repository maintainer
-
-#### New update
-
-1. clone a project from a repository to local workspace;
-2. create a new branch for an update;
-3. complete the update;
-4. perform a Code Review;
-5. merge your branch with `master`;
-6. delete your branch.
-
-#### Notes
-
-1. always delete development branches;
-2. always push squashed commit to `master`.
-
-### As a contributor
-
-1. clone a project from a repository to local workspace;
-2. create a new branch for an update;
-3. complete the update;
-4. perform a Code Review;
-5. create a Pull Request to the original repository.
-
-## Branches
-
-### In projects using next types of branches
-
-* `master` - master branch. Contains a production version of the project. Don't push working changes to `master`!
-* `version` - branch for a specific version.
-* `issue` - branch for a specific issue.
-
-## Commit message structure
-
-### Template
-
-```text
-[DATE] [VERSION]: [MESSAGE]
-```
-
-### Example
-
-```text
-2019-05-12 v. 2.1.3: fixed bugs in History screen
-```
-
-#### Commit body sections order
-
-1. `added` - what was added in the commit;
-2. `closed` - what issues closed in the commit;
-3. `fixed` - what was fixed in the commit;
-4. `updated` - what was updated in the commit;
-5. `deleted` - what was deleted in the commit;
-6. `refactored` - what was refactored in the commit.