flutter_rb 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f13846c798d97f27a3f1aee5da6c2df8c62ad46f60e76064c00e278fe53f1c99
-  data.tar.gz: 31b0ad31e7eec759f2090070abad08fce769ffae5ea2efb875855258ba5c2f2c
+  metadata.gz: ec74e4a22e3c03a2ac5b9febb602b419b92bb19e1574b4da9aad4456f0051de1
+  data.tar.gz: 3c4febcc88f4a79c469276b5a445c794937837b63b2cbc490a644d994ba9ab16
 SHA512:
-  metadata.gz: 39f79dbc0e055a351c6f710f0ccfc059b90ff43a396c8ae9ebf5a8ee3c84b8e27b9f0c989f5677e0d1ff3e694127933c636bfd8ef585cc0b501b529467b0ccf1
-  data.tar.gz: b8adab81e7ed3e12e1dd8f6d2d4057fe94399505e6ceaeac1399398ebfefe3d5f81d8bb90e308969957ce4b89142f1e4e8f53de2bf25763a28d4d4d714f1c3e9
+  metadata.gz: f8fb36b1d3e4c05f610dd486842d992b8345a3894bfc818e6beb62e0c93de2dd6116cfd153df098acc70f61c0efaac91e1a00da7a1428dc940014a7e3a7e4055
+  data.tar.gz: a2e659962f72aa5fd98510e4c434a35f4680db6ced9c7b60ef4dabdb6c944d57ce424a1089e06ae61df089c387579df039c4ce24118d6649c73699b22c5ce073

data/README.md

@@ -2,14 +2,14 @@
 
 # flutter_rb
 
-[![GitHubActions](https://github.com/flutter-rb/flutter-rb/workflows/Build/badge.svg)](https://github.com/flutter-rb/flutter-rb/actions?branch=master)
+[![GitHubActions](https://github.com/flutter-rb/flutter-rb/workflows/Checks/badge.svg)](https://github.com/flutter-rb/flutter-rb/actions?branch=master)
 [![Codebeat](https://codebeat.co/badges/9bb32e28-ca86-4cdc-ba66-bda7f989979a)](https://codebeat.co/projects/github-com-flutter-rb-flutter-rb-master)
 [![Gem Version](https://badge.fury.io/rb/flutter_rb.svg)](https://badge.fury.io/rb/flutter_rb)
 [![Gem Downloads](https://img.shields.io/gem/dt/flutter_rb)](https://badge.fury.io/rb/flutter_rb)
 
 ## About
 
-A tool for checking a Flutter plugin structure.
+CLI tool for checking a Flutter plugin structure.
 
 ### Checks
 
@@ -128,21 +128,30 @@ $ frb author
 
 ### Configuration
 
+#### CLI
+
+Since version `1.2.2` you can generate config by following command in terminal:
+
+```shell
+$ frb config
+```
+
+#### Manually
+
 Add `.flutter_rb.yaml` to root of a project for select checks that you are want to exclude:
 
 ```yaml
 exclude:
   flutter:
-    - check1
-    - check2
-    - check3
+    - PluginDirectoriesCheck
+    - PluginPubspecNameCheck
+    - PluginPubspecDescriptionCheck
   android:
-    - check1
-    - check2
+    - PluginGradleAndroidPackageCheck
   ios:
-    - check1
-    - check2
-
+    - PluginPodspecNameCheck
+    - PluginPodspecVersionCheck
+    - PluginPodspecAuthorsCheck
 ```
 
 ### Output report

data/bin/cli.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'rubygems'
+require 'yaml'
+
+module CLI
+  # Module for all CLI commands.
+  module Commands
+    extend Dry::CLI::Registry
+
+    # This class represents the inspect command for the CLI.
+    # It inherits from Dry::CLI::Command and provides functionality to inspect Dart/Flutter projects.
+    class Inspect < ::Dry::CLI::Command
+      # Description of the command.
+      # This will be displayed when the user runs `flutter-rb help inspect`.
+      desc 'Inspects Dart/Flutter project'
+
+      # Option for specifying the path to the Dart/Flutter project.
+      # If not provided, the current working directory will be used.
+      option :path,
+             default: '',
+             desc: 'Path to Dart/Flutter project. If empty, flutter-rb uses current path'
+
+      # Option for specifying the report system format.
+      # If not provided, no report will be generated.
+      option :report,
+             default: '',
+             values: ['', 'checkstyle'],
+             desc: "Report system format. If empty, flutter-rb won't generate report"
+
+      # The main method of the command.
+      # This method is called when the user runs `flutter-rb inspect`.
+      #
+      # Parameters:
+      # - options: A hash containing the command-line options.
+      #
+      # Returns:
+      #   nil: This method does not return any value. It only performs an action.
+      def call(**options)
+        # Create a new instance of FlutterRb::FlutterRb.
+        flutter_rb = FlutterRb::FlutterRb.new
+
+        # Fetch the path and report options from the command-line options.
+        path = options.fetch(:path)
+        report = options.fetch(:report)
+
+        # Start the inspection process with the provided path and report option.
+        flutter_rb.start(
+          path.empty? ? ::Dir.pwd : path,
+          report == options.fetch(:report)
+        )
+      end
+    end
+
+    # This class represents the version command for the CLI.
+    # It inherits from Dry::CLI::Command and provides functionality to print the current version of flutter-rb.
+    class Version < ::Dry::CLI::Command
+      # Description of the command.
+      # This will be displayed when the user runs `flutter-rb help version`.
+      desc 'Prints using version of flutter-rb'
+
+      # The main method of the command.
+      # This method is called when the user runs `flutter-rb version`.
+      #
+      # Returns:
+      #   nil: This method does not return any value. It only prints the version to the console.
+      def call
+        # Load the flutter-rb gemspec file to get the version.
+        # The gemspec file contains metadata about the gem.
+        spec = Gem::Specification.load('flutter_rb.gemspec')
+
+        # Print the version to the console.
+        puts spec.version
+      end
+    end
+
+    # This class represents the author command for the CLI.
+    # It inherits from Dry::CLI::Command and provides functionality to print the author of flutter-rb.
+    class Author < ::Dry::CLI::Command
+      # Description of the command.
+      # This will be displayed when the user runs `flutter-rb help author`.
+      desc 'Prints the author of flutter-rb'
+
+      # The main method of the command.
+      # This method is called when the user runs `flutter-rb author`.
+      #
+      # Returns:
+      #   nil: This method does not return any value. It only prints the author's information to the console.
+      def call
+        # Load the flutter-rb gemspec file to get the author's information.
+        # The gemspec file contains metadata about the gem.
+        spec = Gem::Specification.load('flutter_rb.gemspec')
+
+        # Print the author's information to the console.
+        puts "Authors: #{spec.authors.join(', ').strip}"
+        puts "Email: #{spec.email}"
+        puts "Homepage: #{spec.homepage}"
+      end
+    end
+
+    # This class represents the config command for the CLI.
+    # It inherits from Dry::CLI::Command and provides functionality to create a configuration file.
+    class Config < ::Dry::CLI::Command
+      # Description of the command.
+      # This will be displayed when the user runs `flutter-rb help config`.
+      desc 'Creates a config file'
+
+      # The main method of the command.
+      # This method is called when the user runs `flutter-rb config`.
+      #
+      # Returns:
+      #   nil: This method does not return any value. It only creates a configuration file.
+      def call
+        # Write an empty string to a file named '.flutter-rb.yaml' in the current directory.
+        # This will create a new configuration file.
+        File.write('.flutter-rb.yaml', '')
+
+        # Print a success message to the console.
+        puts 'Config file created!'
+      end
+    end
+
+    register 'inspect', Inspect.new, aliases: ['i']
+    register 'version', Version.new, aliases: ['v']
+    register 'author', Author.new, aliases: ['a']
+    register 'config', Config.new, aliases: ['c']
+  end
+end
+
+# rubocop:disable Layout/LineLength
+#
+if ::ARGV.empty?
+  puts '⚠️ WARNING ⚠️'.colorize(:yellow)
+  puts '👉 You are using legacy CLI for flutter-rb. To migrate to new CLI, you need to read documentation by following link: https://github.com/flutter-rb/flutter-rb/'
+  puts '👉 This message are showing only for versions that supports legacy CLI.'
+  puts '👉 You will need to upgrade your build setup for new CLI because old version will be removed in future versions of flutter-rb.'
+  puts '👉 If you have any questions, feel free to open an issue in our repository by following link: https://github.com/flutter-rb/flutter-rb/issues/new'
+  puts "\n"
+
+  flutter_rb = FlutterRb::FlutterRb.new
+
+  flutter_rb.start(::Dir.pwd, true)
+else
+  ::Dry::CLI.new(::CLI::Commands).call
+end
+
+# rubocop:enable Layout/LineLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutter_rb
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -146,6 +146,7 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
+- bin/cli.rb
 - bin/frb
 - lib/checkstyle_report/checkstyle_report.rb
 - lib/flutter_rb.rb
@@ -189,5 +190,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: A Ruby tool for checking a Flutter plugin structure
+summary: CLI tool for checking a Flutter plugin structure
 test_files: []