flutter_rb 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8564b7cdf9819a28ea1ca5c145f9dcb813556575998924fb9b6cc8db5224ca77
-  data.tar.gz: 51b4cc3dd7dbf3b0d0e7a653f29defc47293b685c3de05f6e5a99ce846df9e41
+  metadata.gz: 5d708635770d65db09e97f3864f6e35ebcba46c13c84d6a388e6f10e9adc72e4
+  data.tar.gz: 1db4f12f4a0d23ba569a1c885eb3db6b295f11f2954594207750e738c91fa885
 SHA512:
-  metadata.gz: 7b595e1256a18e7f74d5d273054f7608dae0c3674bd0467db4108fb4ef7c8936248cd3daf610ac5e11242fe169d97085bd008fee98bb5dca2a2461a72a7f01cc
-  data.tar.gz: 7b12583d8fad4af058cde7c45e560141a9f74db75fe215f70b57ebe3a0584a7979471a7b68680f7ded6ebdd469cbf4421cfb4822e8d9af29d18fe08f2638fef1
+  metadata.gz: ce685d7cfeb7b65bd31113f167d91aa59fb5ba23368f744a4d1efa14d7b2f5e97e32e7b4fa2012a32ba2fafb94f29c6d30e68602e25648aff0fe7695bafc0ce5
+  data.tar.gz: 6d11387d9654065b86410ab14612ec2ac4711f181d8c56d9551f762d408b6ba00ba0c1b81f72145af283d970e17b51dafa0c8d545925dae11df65b7630bfd70c

data/README.md

@@ -1,3 +1,4 @@
+<!--suppress CheckImageSize -->
 <img src="media/logo/ic_lib.png" height="100px" alt="Project's logo">
 
 # flutter_rb
@@ -5,6 +6,7 @@
 [![GitHubActions](https://github.com/flutter-rb/flutter-rb/workflows/Build/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
 
@@ -24,15 +26,16 @@ Each issue has a `level` parameter that describes its significant importance.
 
 #### Flutter
 
-| Check                             | Description                                                                                                                                                                        | Level     |
-|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
-| `PluginDirectoriesCheck`          | Check plugin directories structure in pubspec file. Example: if a Flutter plugin has only Android specific code but not contains iOS folder with description, then iOS build fails | `ERROR`   |
-| `PluginPubspecNameCheck`          | Check plugin name in pubspec file. Exists or not                                                                                                                                   | `ERROR`   |
-| `PluginPubspecDescriptionCheck`   | Check plugin description in pubspec file. Exists or not                                                                                                                            | `WARNING` |
-| `PluginPubspecVersionCheck`       | Check plugin version in pubspec. Exists or not                                                                                                                                     | `ERROR`   |
-| `PluginPubspecAuthorCheck`        | Check plugin author in pubspec. Exists or not. `author` section deprecated in `pubspec.yaml`                                                                                       | `WARNING` |
-| `PluginPubspecHomepageCheck`      | Check plugin homepage in pubspec. Exists or not                                                                                                                                    | `ERROR`   |
-| `PluginPubspecEffectiveDartCheck` | Check Flutter plugin Effective Dart depencency in pubspec file. Exists or not                                                                                                      | `ERROR`   |
+| Check                            | Description                                                                                                                                                                        | Level     |
+|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `PluginDirectoriesCheck`         | Check plugin directories structure in pubspec file. Example: if a Flutter plugin has only Android specific code but not contains iOS folder with description, then iOS build fails | `ERROR`   |
+| `PluginPubspecNameCheck`         | Check plugin name in pubspec file. Exists or not                                                                                                                                   | `ERROR`   |
+| `PluginPubspecDescriptionCheck`  | Check plugin description in pubspec file. Exists or not                                                                                                                            | `WARNING` |
+| `PluginPubspecVersionCheck`      | Check plugin version in pubspec. Exists or not                                                                                                                                     | `ERROR`   |
+| `PluginPubspecAuthorCheck`       | Check plugin author in pubspec. Exists or not. `author` section deprecated in `pubspec.yaml`                                                                                       | `WARNING` |
+| `PluginPubspecHomepageCheck`     | Check plugin homepage in pubspec. Exists or not                                                                                                                                    | `ERROR`   |
+| `PluginPubspecLintsCheck`        | Check Flutter plugin `lints` dependency in pubspec file. Exists or not                                                                                                             | `ERROR`   |
+| `PluginPubspecFlutterLintsCheck` | Check Flutter plugin `flutter_lints` dependency in pubspec file. Exists or not                                                                                                     | `ERROR`   |
 
 #### Android
 
@@ -54,7 +57,8 @@ Each issue has a `level` parameter that describes its significant importance.
 
 ### Android
 
-You should add [flutter-rb-gradle-plugin](https://github.com/flutter-rb/flutter-rb-gradle-plugin) to Android side of your plugin.
+You should add [flutter-rb-gradle-plugin](https://github.com/flutter-rb/flutter-rb-gradle-plugin) to Android side of
+your plugin.
 
 ### Download gem from RubyGems
 
@@ -85,7 +89,8 @@ $ frb
 
 ### As local executable
 
-Add `project_folder/bin` (where `project_folder` is path to project on your machine) to `PATH` variable in your environment. Then updated environment and run from a Flutter plugin's project folder:
+Add `project_folder/bin` (where `project_folder` is path to project on your machine) to `PATH` variable in your
+environment. Then updated environment and run from a Flutter plugin's project folder:
 
 ```shell
 $ local_frb
@@ -98,13 +103,12 @@ $ local_frb
 | `--help`              | Print help info                      |
 | `--checkstyle-report` | Generate report in Checkstyle format |
 
-
 ### Configuration
 
-Add `.flutter_rb.yaml` to root of a project for select checks that you are want to execute:
+Add `.flutter_rb.yaml` to root of a project for select checks that you are want to exclude:
 
 ```yaml
-include:
+exclude:
   flutter:
     - check1
     - check2
@@ -120,11 +124,13 @@ include:
 
 ### Output report
 
-Tool can make report in Checkstyle format. To enable this feature, pass `--checkstyle-report` as an CLI argument. The report file name is `frb-checkstyle-report.xml`.
+Tool can make report in Checkstyle format. To enable this feature, pass `--checkstyle-report` as an CLI argument. The
+report file name is `frb-checkstyle-report.xml`.
 
 ## How to contribute
 
-Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request. Then:
+Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request.
+Then:
 
 ```shell
 $ bundle exec rake

data/bin/frb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'flutter_rb'
 require 'colorize'
 

data/lib/checkstyle_report/checkstyle_report.rb

@@ -1,15 +1,22 @@
+# frozen_string_literal: true
+
 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[]}
     def initialize(path, report_filename, checks)
       @path = path
       @report_filename = report_filename
       @checks = checks
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # noinspection RubyResolve
     def create_report
       checkstyle_files = sort_checks(@checks)
       report = Nokogiri::XML::Builder.new do |xml|
@@ -19,9 +26,15 @@ module CheckstyleReport
             .each { |file| write_file(xml, file) }
         end
       end
-      File.open("#{@path}/#{@report_filename}.xml", 'w') { |file| file.write(report.to_xml) }
+      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[]}
     def sort_checks(checks)
       checkstyle_files = {}
       checks.each do |check|
@@ -32,6 +45,8 @@ module CheckstyleReport
       checkstyle_files
     end
 
+    # @param {XML} xml
+    # @param {CheckstyleFile} checkstyle_file
     def write_file(xml, checkstyle_file)
       xml.file(name: checkstyle_file.file) do
         checkstyle_file.errors.each do |error|
@@ -40,6 +55,8 @@ module CheckstyleReport
       end
     end
 
+    # @param {XML} xml
+    # @param {CheckstyleError} error
     def write_error(xml, error)
       xml.error(
         line: error.line,
@@ -53,6 +70,8 @@ module CheckstyleReport
 
   # File representation for Checkstyle format
   class CheckstyleFile
+    # @param {String} file
+    # @param {CheckstyleError[]} errors
     def initialize(file, errors)
       @file = file
       @errors = errors
@@ -63,11 +82,17 @@ module CheckstyleReport
 
   # Checkstyle error representation
   class CheckstyleError
-    SEVERITY_NORMAL = 'normal'.freeze
-    SEVERITY_WARNING = 'warning'.freeze
-    SEVERITY_ERROR = 'error'.freeze
+    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,
@@ -83,6 +108,7 @@ module CheckstyleReport
       @column = column
       @name = name
     end
+
     # rubocop:enable Metrics/ParameterLists
 
     attr_reader :severity, :message, :source, :line, :column, :name

data/lib/flutter_rb/checks/check.rb

@@ -1,24 +1,34 @@
+# frozen_string_literal: true
+
 module FlutterRb
   # Base class for all checks
   # Class provides default methods structure
   # All methods using for create reports
   class Check
-    UNIMPLEMENTED_ERROR = 'Error: missing method'.freeze
+    UNIMPLEMENTED_ERROR = 'Error: missing method'
 
+    # @return {String}
     def name
       raise UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def summary
       raise UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def description
       'No provided'
     end
 
-    def check
+    # rubocop:disable Lint/UnusedMethodArgument
+    # @param {Project} project
+    # @return {CheckReport}
+    def check(project)
       raise UNIMPLEMENTED_ERROR
     end
+
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/flutter_rb/checks/plugin_directories_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 
@@ -6,18 +8,23 @@ module FlutterRb
   # Example: if a Flutter plugin has only Android specific code
   # but not contains iOS folder with description, then iOS build fails
   class PluginDirectoriesCheck < Check
+    # @return {String}
     def name
       'PluginDirectoriesCheck'
     end
 
+    # @return {String}
     def summary
       'Validate Flutter plugin structure'
     end
 
+    # @return {String}
     def description
       'Check plugin directories structure in pubspec file'
     end
 
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       android_exists = !project.android_folder.nil?
       ios_exists = !project.ios_folder.nil?

data/lib/flutter_rb/checks/plugin_gradle_check.rb

@@ -1,21 +1,28 @@
+# frozen_string_literal: true
+
 require_relative './check'
 require_relative '../report/check_report'
 
 module FlutterRb
   # Check 'android; import not exists in Gradle project config (build.gradle file)
   class PluginGradleAndroidPackageCheck < Check
+    # @return {String}
     def name
       'PluginGradleAndroidPackageCheck'
     end
 
+    # @return {String}
     def summary
       'Validate that \android\ package not exists in build.gradle config'
     end
 
+    # @return {String}
     def description
       'Validate that \android\ package not exists in Gradle project config (build.gradle file)'
     end
 
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       gradle = project.android_folder.gradle
       import_exist = File.readlines("#{gradle.path}/build.gradle").grep(/package android/).size.positive?
@@ -30,18 +37,23 @@ module FlutterRb
 
   # Check Flutter plugin version in Gradle project config (build.gradle file)
   class PluginGradleVersionCheck < Check
+    # @return {String}
     def name
       'PluginGradleVersionCheck'
     end
 
+    # @return {String}
     def summary
       'Validate Flutter plugin\s version in build.gradle file'
     end
 
+    # @return {String}
     def description
       'Check plugin version in Gradle project config (build.gradle file)'
     end
 
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       version_in_pubspec = project.pubspec.pubspec_info.version
       gradle = project.android_folder.gradle

data/lib/flutter_rb/checks/plugin_podspec_check.rb

@@ -1,17 +1,22 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 
 module FlutterRb
   # Base class for all info parameters in Flutter plugin podspec file
   class PluginPodspecCheck < Check
+    # @return {String}
     def name
       "PluginPodspec#{podspec_parameter.capitalize}Check"
     end
 
+    # @return {String}
     def podspec_parameter
       UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def summary
       "Validate Flutter plugin's #{podspec_parameter} in podspec file"
     end
@@ -19,10 +24,18 @@ module FlutterRb
 
   # Check Flutter plugin name in podspec file. Exists or not
   class PluginPodspecNameCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'name'
     end
 
+    # @return {String}
+    def description
+      'Check plugin name in podspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       name_in_pubspec = project.pubspec.pubspec_info.name
       podspec = project.ios_folder.podspec
@@ -34,18 +47,22 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      'Check plugin name in podspec file'
-    end
   end
 
   # Check Flutter plugin version in podspec file. Exists or not
   class PluginPodspecVersionCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'version'
     end
 
+    # @return {String}
+    def description
+      'Check plugin version in podspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       version_in_pubspec = project.pubspec.pubspec_info.version
       podspec = project.ios_folder.podspec
@@ -57,18 +74,22 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      'Check plugin version in podspec file'
-    end
   end
 
   # Check Flutter plugin's authors. Exists or not
   class PluginPodspecAuthorsCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'authors'
     end
 
+    # @return {String}
+    def description
+      "Check plugin's authors in podspec file"
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       podspec = project.ios_folder.podspec
       author_exists = !podspec.authors.nil?
@@ -79,19 +100,23 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      "Check plugin's authors in podspec file"
-    end
   end
 
   # Check plugin iOS source path in podspec file.
   # If Flutter plugin cannot contains iOS specific code, source path must be '.'
   class PluginPodspecSourceCheck < PluginPodspecCheck
+    # @return {String}
     def podspec_parameter
       'source'
     end
 
+    # @return {String}
+    def description
+      'Check plugin iOS source path in podspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       podspec = project.ios_folder.podspec
       CheckReport.new(
@@ -101,9 +126,5 @@ module FlutterRb
         podspec.path
       )
     end
-
-    def description
-      'Check plugin iOS source path in podspec file'
-    end
   end
 end

data/lib/flutter_rb/checks/plugin_pubspec_check.rb

@@ -1,17 +1,22 @@
+# frozen_string_literal: true
+
 require_relative 'check'
 require_relative '../report/check_report'
 
 module FlutterRb
   # Base class for all info parameters in Flutter plugin pubspec.yaml file
   class PluginPubspecCheck < Check
+    # @return {String}
     def name
       "PluginPubspec#{pubspec_parameter.capitalize}Check"
     end
 
+    # @return {String}
     def pubspec_parameter
       raise UNIMPLEMENTED_ERROR
     end
 
+    # @return {String}
     def summary
       "Validate Flutter plugin's #{pubspec_parameter} in pubspec.yaml"
     end
@@ -19,10 +24,18 @@ module FlutterRb
 
   # Check Flutter plugin name in podspec file. Exists or not
   class PluginPubspecNameCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'name'
     end
 
+    # @return {String}
+    def description
+      'Check plugin name in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -32,18 +45,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin name in pubspec file'
-    end
   end
 
   # Check Flutter plugin description in pubspec file. Exists or not
   class PluginPubspecDescriptionCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'description'
     end
 
+    # @return {String}
+    def description
+      'Check plugin description in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -53,18 +70,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin description in pubspec file'
-    end
   end
 
   # Check Flutter plugin version in pubspec file. Exists or not
   class PluginPubspecVersionCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'version'
     end
 
+    # @return {String}
+    def description
+      'Check plugin version in pubspec'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -74,18 +95,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin version in pubspec'
-    end
   end
 
   # Check Flutter plugin author in pubspec file. Exists or not
   class PluginPubspecAuthorCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'author'
     end
 
+    # @return {String}
+    def description
+      'Check plugin author in pubspec'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -95,18 +120,22 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin author in pubspec'
-    end
   end
 
   # Check Flutter plugin homepage in pubspec file. Exists or not
   class PluginPubspecHomepageCheck < PluginPubspecCheck
+    # @return {String}
     def pubspec_parameter
       'homepage'
     end
 
+    # @return {String}
+    def description
+      'Check plugin homepage in pubspec'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
       CheckReport.new(
@@ -116,37 +145,71 @@ module FlutterRb
         pubspec.path
       )
     end
-
-    def description
-      'Check plugin homepage in pubspec'
-    end
   end
 
-  # Check Flutter plugin Effective Dart depencency in pubspec file. Exists or not
-  class PluginPubspecEffectiveDartCheck < Check
+  # Check Flutter plugin lints dependency in pubspec file. Exists or not
+  class PluginPubspecLintsCheck < Check
+    # @return {String}
     def name
-      'PluginPubspecEffectiveDartCheck'
+      'PluginPubspecLintsCheck'
     end
 
+    # @return {String}
     def summary
-      'Validate Flutter plugin\'s Effective Dart rules implementation in pubspec.yaml'
+      'Validate Flutter plugin\'s lints rules implementation in pubspec.yaml'
     end
 
+    # @return {String}
+    def description
+      'Check Flutter plugin lints dependency in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
     def check(project)
       pubspec = project.pubspec
-      effective_dart = pubspec.dev_dependencies&.detect do |dev_dependency|
-        dev_dependency.name == 'effective_dart'
+      lints = pubspec.dev_dependencies&.detect do |dev_dependency|
+        dev_dependency.name == 'lints'
       end
       CheckReport.new(
         name,
-        effective_dart.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        lints.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
         description,
         pubspec.path
       )
     end
+  end
+
+  # Check Flutter plugin flutter_lints dependency in pubspec file. Exists or not
+  class PluginPubspecFlutterLintsCheck < Check
+    # @return {String}
+    def name
+      'PluginPubspecFlutterLintsCheck'
+    end
+
+    # @return {String}
+    def summary
+      'Validate Flutter plugin\'s flutter_lints rules implementation in pubspec.yaml'
+    end
 
+    # @return {String}
     def description
-      'Check Flutter plugin Effective Dart depencency in pubspec file'
+      'Check Flutter plugin flutter_lints dependency in pubspec file'
+    end
+
+    # @param {Project} project
+    # @return {CheckReport}
+    def check(project)
+      pubspec = project.pubspec
+      flutter_lints = pubspec.dev_dependencies&.detect do |dev_dependency|
+        dev_dependency.name == 'flutter_lints'
+      end
+      CheckReport.new(
+        name,
+        flutter_lints.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        pubspec.path
+      )
     end
   end
 end