flutter_rb 0.8.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1db2ea3e3da806520668035df504eb714a412a6e7a9b4e457ac12eca7cd5af4b
-  data.tar.gz: abdcbd7b3ff710447fa05ed62d04d7e13c81eb976d2872d31eff01e62d9f64f3
+  metadata.gz: c2085d887e060a00177dfef11e0a1219b7fa146064c315c409cf30ceccea494b
+  data.tar.gz: 7bbba89d78ed94e75e95f43180ae4f59449a04019b47f81e01e697174c482121
 SHA512:
-  metadata.gz: 1817f3abe2db562095fcf0245ea166510ed67b203729a5e518fb1f53fdf6c31dec6fe4b69ef163000446e03505be3fedca683d3f97369bd3cd3a426a78f3dd02
-  data.tar.gz: ccf54c91294479924bd310ef3af7986ddcd4efb337405e4f817bca2797cd56103836887661e647ea06fd1bd1729831c795b175605bedf9334f6e18c240ca3a94
+  metadata.gz: 9545fa39016e347701d743ebca162d70cbc599271db993f406d6262b9d1e72c120def9c47bbc2a9a7e3b941c490437558f4ecb285830becf1f6904265bd35413
+  data.tar.gz: 0070f79ba964624b33ece2ea1db4b8e3b9035a46be64d7f1d6f8da75f1abe5fc3ec0d2cbddc52c35d3cb8ffb8f6935d553374aa7dbeb0c3ce8fd5d9656a8a7eb

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020-2022 Artem Fomchenkov
+Copyright (c) 2020-2023 Artem Fomchenkov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-<img src="media/logo/ic_lib.png" height="100px">
+<img src="media/logo/ic_lib.png" height="100px" alt="Project's logo">
 
 # flutter_rb
 
@@ -16,39 +16,39 @@ A tool for checking a Flutter plugin structure.
 
 Each issue has a `level` parameter that describes his significate level.
 
-| Level | Description |
-| --- | --- |
-| `NORMAL` | Issue was not found |
+| Level     | Description                                 |
+|-----------|---------------------------------------------|
+| `NORMAL`  | Issue was not found                         |
 | `WARNING` | Issue is not serious and cannot break build |
-| `ERROR` | Issue is critical and can break build |
+| `ERROR`   | Issue is critical and can break build       |
 
 #### 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`   |
+| `PluginPubspecEffectiveDartCheck` | Check Flutter plugin Effective Dart depencency in pubspec file. Exists or not                                                                                                      | `ERROR`   |
 
 #### Android
 
-| Check | Description | Level |
-| --- | --- | --- |
-| `PluginGradleAndroidPackageCheck` | Validate that \android\ package not exists in Gradle project config (build.gradle file) | `ERROR` |
-| `PluginGradleVersionCheck` | Check plugin version in Gradle project config (build.gradle file). Version must be the same as plugin version in pubspec file | `WARNING` |
+| Check                             | Description                                                                                                                   | Level     |
+|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `PluginGradleAndroidPackageCheck` | Validate that \android\ package not exists in Gradle project config (build.gradle file)                                       | `ERROR`   |
+| `PluginGradleVersionCheck`        | Check plugin version in Gradle project config (build.gradle file). Version must be the same as plugin version in pubspec file | `WARNING` |
 
 #### iOS
 
-| Check | Description | Level |
-| --- | --- | --- |
-| `PluginPodspecNameCheck` | Check plugin name in podspec file. Exists or not | `WARNING` |
-| `PluginPodspecVersionCheck` | Check plugin version in podspec file. Exists or not | `WARNING` |
-| `PluginPodspecAuthorsCheck` | Check plugin's authors in podspec file. Exists or not | `ERROR` |
-| `PluginPodspecSourceCheck` | Check plugin iOS source path in podspec file. If Flutter plugin cannot contains iOS specific code, source path must be `'.'` | `ERROR` |
+| Check                       | Description                                                                                                                  | Level     |
+|-----------------------------|------------------------------------------------------------------------------------------------------------------------------|-----------|
+| `PluginPodspecNameCheck`    | Check plugin name in podspec file. Exists or not                                                                             | `WARNING` |
+| `PluginPodspecVersionCheck` | Check plugin version in podspec file. Exists or not                                                                          | `WARNING` |
+| `PluginPodspecAuthorsCheck` | Check plugin's authors in podspec file. Exists or not                                                                        | `ERROR`   |
+| `PluginPodspecSourceCheck`  | Check plugin iOS source path in podspec file. If Flutter plugin cannot contains iOS specific code, source path must be `'.'` | `ERROR`   |
 
 ## How to use
 
@@ -100,9 +100,9 @@ local_frb
 
 ### Arguments
 
-| Argument | Description |
-| --- | --- |
-| `--help` | Print help info |
+| Argument              | Description                          |
+|-----------------------|--------------------------------------|
+| `--help`              | Print help info                      |
 | `--checkstyle-report` | Generate report in Checkstyle format |
 
 

data/bin/frb

@@ -9,7 +9,7 @@ end
 
 if ARGV.include?('--help')
   puts "
-    Available aruments:
+    Available arguments:
     * #{light_blue_text('--help')}: print help info
     * #{light_blue_text('--checkstyle-report')}: generate report in Checkstyle format
     "

data/lib/checkstyle_report/checkstyle_report.rb

@@ -27,7 +27,7 @@ module CheckstyleReport
       checks.each do |check|
         checkstyle_file = checkstyle_files[check.source]
         checkstyle_files[check.source] = [] if checkstyle_file.nil?
-        checkstyle_files[check.source] += [check] if check.saverity != CheckstyleError::SAVERITY_NORMAL
+        checkstyle_files[check.source] += [check] if check.severity != CheckstyleError::SEVERITY_NORMAL
       end
       checkstyle_files
     end
@@ -44,7 +44,7 @@ module CheckstyleReport
       xml.error(
         line: error.line,
         column: error.column,
-        saverity: error.saverity,
+        severity: error.severity,
         message: error.message,
         source: error.source
       )
@@ -63,20 +63,20 @@ module CheckstyleReport
 
   # Checkstyle error representation
   class CheckstyleError
-    SAVERITY_NORMAL = 'normal'.freeze
-    SAVERITY_WARNING = 'warning'.freeze
-    SAVERITY_ERROR = 'error'.freeze
+    SEVERITY_NORMAL = 'normal'.freeze
+    SEVERITY_WARNING = 'warning'.freeze
+    SEVERITY_ERROR = 'error'.freeze
 
     # rubocop:disable Metrics/ParameterLists
     def initialize(
-      saverity,
+      severity,
       message,
       source,
       line,
       column,
       name
     )
-      @saverity = saverity
+      @severity = severity
       @message = message
       @source = source
       @line = line
@@ -85,6 +85,6 @@ module CheckstyleReport
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_reader :saverity, :message, :source, :line, :column, :name
+    attr_reader :severity, :message, :source, :line, :column, :name
   end
 end

data/lib/flutter_rb/checks/check.rb

@@ -3,14 +3,14 @@ module FlutterRb
   # Class provides default methods structure
   # All methods using for create reports
   class Check
-    UNIMPLEMENTATION_ERROR = 'Error: missing method'.freeze
+    UNIMPLEMENTED_ERROR = 'Error: missing method'.freeze
 
     def name
-      raise UNIMPLEMENTATION_ERROR
+      raise UNIMPLEMENTED_ERROR
     end
 
     def summary
-      raise UNIMPLEMENTATION_ERROR
+      raise UNIMPLEMENTED_ERROR
     end
 
     def description
@@ -18,7 +18,7 @@ module FlutterRb
     end
 
     def check
-      raise UNIMPLEMENTATION_ERROR
+      raise UNIMPLEMENTED_ERROR
     end
   end
 end

data/lib/flutter_rb/checks/plugin_podspec_check.rb

@@ -9,7 +9,7 @@ module FlutterRb
     end
 
     def podspec_parameter
-      UNIMPLEMENTATION_ERROR
+      UNIMPLEMENTED_ERROR
     end
 
     def summary

data/lib/flutter_rb/checks/plugin_pubspec_check.rb

@@ -9,7 +9,7 @@ module FlutterRb
     end
 
     def pubspec_parameter
-      raise UNIMPLEMENTATION_ERROR
+      raise UNIMPLEMENTED_ERROR
     end
 
     def summary

data/lib/flutter_rb.rb

@@ -82,11 +82,13 @@ module FlutterRb
     def level_for_report(check_report_status)
       case check_report_status
       when CheckReportStatus::NORMAL
-        CheckstyleReport::CheckstyleError::SAVERITY_NORMAL
+        CheckstyleReport::CheckstyleError::SEVERITY_NORMAL
       when CheckReportStatus::WARNING
-        CheckstyleReport::CheckstyleError::SAVERITY_WARNING
+        CheckstyleReport::CheckstyleError::SEVERITY_WARNING
       when CheckReportStatus::ERROR
-        CheckstyleReport::CheckstyleError::SAVERITY_ERROR
+        CheckstyleReport::CheckstyleError::SEVERITY_ERROR
+      else
+        throw 'Unknown CheckReportStatus'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flutter_rb
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Artem Fomchenkov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -94,7 +94,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '1.7'
-description: 
+description:
 email: artem.fomchenkov@outlook.com
 executables:
 - frb
@@ -124,11 +124,11 @@ files:
 - lib/flutter_rb/project/specs/ios/ios_folder.rb
 - lib/flutter_rb/project/specs/ios/podspec.rb
 - lib/flutter_rb/report/check_report.rb
-homepage: http://github.com/flutter-rb/flutter-rb
+homepage: https://github.com/flutter-rb/flutter-rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,15 +137,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A Ruby tool for checking a Flutter plugin structure
 test_files: []