flutter_rb 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b9c4ba6b6d7ede4690bf5d4c56db1690eebd150aed2280f2921d0ee42cf3dee
+  data.tar.gz: dc1abf19802d39f9448c79421a3b9086b460381a3de664d592e2f1df385c6f80
+SHA512:
+  metadata.gz: bd273e042215353d3b5ebfdcf058d303533e4495a1374642cf4a3202d321405b4fdf70a5c7100653921ae8f7e0751a41d4beb097ab2237379fb873abaad1eb02
+  data.tar.gz: ea9a7665e9b66602a15aaab0aa71730069bd01473df6302fdd7b19f5b2aff1c9d1f723b25a7bff4803af1ca8cdc7e6c6c4f57242b53d3447a0a474a2e3a74555

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020-2022 Artem Fomchenkov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+<img src="media/logo/ic_lib.png" height="100px">
+
+# flutter_rb
+
+[![GitHubActions](https://github.com/fartem/flutter_rb/workflows/Build/badge.svg)](https://github.com/fartem/flutter_rb/actions?query=workflow%3ARuby)
+[![Codebeat](https://codebeat.co/badges/9bb32e28-ca86-4cdc-ba66-bda7f989979a)](https://codebeat.co/projects/github-com-fartem-flutter_rb-master)
+[![Coveralls](https://coveralls.io/repos/github/fartem/flutter_rb/badge.svg?branch=master)](https://coveralls.io/github/fartem/flutter_rb?branch=master)
+
+## About
+
+A tool for checking a Flutter plugin structure.
+
+### Checks
+
+#### Levels
+
+Each issue has a `level` parameter that describes his significate level.
+
+| Level | Description |
+| --- | --- |
+| `NORMAL` | Issue was not found |
+| `WARNING` | Issue is not serious and cannot 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` |
+
+#### 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` |
+
+#### 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` |
+
+## How to use
+
+### Android
+
+You should add [flutter-rb-gradle-plugin](https://github.com/fartem/flutter-rb-gradle-plugin) to Android side of your plugin.
+
+### As local installed gem
+
+Build gem from sources:
+
+```shell
+gem build flutter_rb.gemspec
+```
+
+Install gem:
+
+```shell
+gem i flutter_rb
+```
+
+Then run from a Flutter plugin's project folder:
+
+```shell
+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:
+
+```shell
+local_frb
+```
+
+### Arguments
+
+| Argument | Description |
+| --- | --- |
+| `--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:
+
+```yaml
+include:
+  flutter:
+    - check1
+    - check2
+    - check3
+  android:
+    - check1
+    - check2
+  ios:
+    - check1
+    - check2
+
+```
+
+### 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`.
+
+## How to contribute
+
+Read [Commit Convention](https://github.com/fartem/repository-rules/blob/master/commit-convention/COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request. Then:
+
+```shell
+bundle exec rake
+```
+
+If you don't see any error messages, submit your pull request.
+
+## Contributors
+
+- [@fartem](https://github.com/fartem) as Artem Fomchenkov

data/bin/frb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'flutter_rb'
+require 'colorize'
+
+def light_blue_text(text)
+  text.colorize(:light_blue)
+end
+
+if ARGV.include?('--help')
+  puts "
+    Available aruments:
+    * #{light_blue_text('--help')}: print help info
+    * #{light_blue_text('--checkstyle-report')}: generate report in Checkstyle format
+    "
+else
+  flutter_rb = FlutterRb::FlutterRb.new
+  flutter_rb.start(Dir.pwd, ARGV.include?('--checkstyle-report'))
+end

data/lib/checkstyle_report/checkstyle_report.rb

@@ -0,0 +1,90 @@
+require 'nokogiri'
+
+# Module with classes for creating reports in Checkstyle format
+module CheckstyleReport
+  # Class for create report in Checkstyle format
+  class CheckstyleReport
+    def initialize(path, report_filename, checks)
+      @path = path
+      @report_filename = report_filename
+      @checks = checks
+    end
+
+    def create_report
+      checkstyle_files = sort_checks(@checks)
+      report = Nokogiri::XML::Builder.new do |xml|
+        xml.checkstyle(version: '8.38') do
+          checkstyle_files
+            .map { |file, errors| CheckstyleFile.new(file, errors) }
+            .each { |file| write_file(xml, file) }
+        end
+      end
+      File.open("#{@path}/#{@report_filename}.xml", 'w') { |file| file.write(report.to_xml) }
+    end
+
+    def sort_checks(checks)
+      checkstyle_files = {}
+      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
+      end
+      checkstyle_files
+    end
+
+    def write_file(xml, checkstyle_file)
+      xml.file(name: checkstyle_file.file) do
+        checkstyle_file.errors.each do |error|
+          write_error(xml, error)
+        end
+      end
+    end
+
+    def write_error(xml, error)
+      xml.error(
+        line: error.line,
+        column: error.column,
+        saverity: error.saverity,
+        message: error.message,
+        source: error.source
+      )
+    end
+  end
+
+  # File representation for Checkstyle format
+  class CheckstyleFile
+    def initialize(file, errors)
+      @file = file
+      @errors = errors
+    end
+
+    attr_reader :file, :errors
+  end
+
+  # Checkstyle error representation
+  class CheckstyleError
+    SAVERITY_NORMAL = 'normal'.freeze
+    SAVERITY_WARNING = 'warning'.freeze
+    SAVERITY_ERROR = 'error'.freeze
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(
+      saverity,
+      message,
+      source,
+      line,
+      column,
+      name
+    )
+      @saverity = saverity
+      @message = message
+      @source = source
+      @line = line
+      @column = column
+      @name = name
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    attr_reader :saverity, :message, :source, :line, :column, :name
+  end
+end

data/lib/flutter_rb/checks/check.rb

@@ -0,0 +1,24 @@
+module FlutterRb
+  # Base class for all checks
+  # Class provides default methods structure
+  # All methods using for create reports
+  class Check
+    UNIMPLEMENTATION_ERROR = 'Error: missing method'.freeze
+
+    def name
+      raise UNIMPLEMENTATION_ERROR
+    end
+
+    def summary
+      raise UNIMPLEMENTATION_ERROR
+    end
+
+    def description
+      'No provided'
+    end
+
+    def check
+      raise UNIMPLEMENTATION_ERROR
+    end
+  end
+end

data/lib/flutter_rb/checks/plugin_directories_check.rb

@@ -0,0 +1,33 @@
+require_relative 'check'
+require_relative '../report/check_report'
+
+module FlutterRb
+  # Check plugin directories structure.
+  # Example: if a Flutter plugin has only Android specific code
+  # but not contains iOS folder with description, then iOS build fails
+  class PluginDirectoriesCheck < Check
+    def name
+      'PluginDirectoriesCheck'
+    end
+
+    def summary
+      'Validate Flutter plugin structure'
+    end
+
+    def description
+      'Check plugin directories structure in pubspec file'
+    end
+
+    def check(project)
+      android_exists = !project.android_folder.nil?
+      ios_exists = !project.ios_folder.nil?
+      check_result = android_exists && ios_exists || !android_exists && !ios_exists
+      CheckReport.new(
+        name,
+        check_result ? CheckReportStatus::NORMAL : CheckReportStatus::ERROR,
+        description,
+        project.path
+      )
+    end
+  end
+end

data/lib/flutter_rb/checks/plugin_gradle_check.rb

@@ -0,0 +1,57 @@
+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
+    def name
+      'PluginGradleAndroidPackageCheck'
+    end
+
+    def summary
+      'Validate that \android\ package not exists in build.gradle config'
+    end
+
+    def description
+      'Validate that \android\ package not exists in Gradle project config (build.gradle file)'
+    end
+
+    def check(project)
+      gradle = project.android_folder.gradle
+      import_exist = File.readlines("#{gradle.path}/build.gradle").grep(/package android/).size.positive?
+      CheckReport.new(
+        name,
+        import_exist ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        gradle.path
+      )
+    end
+  end
+
+  # Check Flutter plugin version in Gradle project config (build.gradle file)
+  class PluginGradleVersionCheck < Check
+    def name
+      'PluginGradleVersionCheck'
+    end
+
+    def summary
+      'Validate Flutter plugin\s version in build.gradle file'
+    end
+
+    def description
+      'Check plugin version in Gradle project config (build.gradle file)'
+    end
+
+    def check(project)
+      version_in_pubspec = project.pubspec.pubspec_info.version
+      gradle = project.android_folder.gradle
+      version_in_gradle = gradle.version
+      CheckReport.new(
+        name,
+        version_in_pubspec == version_in_gradle ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        description,
+        gradle.path
+      )
+    end
+  end
+end

data/lib/flutter_rb/checks/plugin_podspec_check.rb

@@ -0,0 +1,109 @@
+require_relative 'check'
+require_relative '../report/check_report'
+
+module FlutterRb
+  # Base class for all info parameters in Flutter plugin podspec file
+  class PluginPodspecCheck < Check
+    def name
+      "PluginPodspec#{podspec_parameter.capitalize}Check"
+    end
+
+    def podspec_parameter
+      UNIMPLEMENTATION_ERROR
+    end
+
+    def summary
+      "Validate Flutter plugin's #{podspec_parameter} in podspec file"
+    end
+  end
+
+  # Check Flutter plugin name in podspec file. Exists or not
+  class PluginPodspecNameCheck < PluginPodspecCheck
+    def podspec_parameter
+      'name'
+    end
+
+    def check(project)
+      name_in_pubspec = project.pubspec.pubspec_info.name
+      podspec = project.ios_folder.podspec
+      name_in_podspec = podspec.name
+      CheckReport.new(
+        name,
+        name_in_pubspec == name_in_podspec ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        description,
+        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
+    def podspec_parameter
+      'version'
+    end
+
+    def check(project)
+      version_in_pubspec = project.pubspec.pubspec_info.version
+      podspec = project.ios_folder.podspec
+      version_in_podspec = podspec.version
+      CheckReport.new(
+        name,
+        version_in_pubspec == version_in_podspec ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        description,
+        podspec.path
+      )
+    end
+
+    def description
+      'Check plugin version in podspec file'
+    end
+  end
+
+  # Check Flutter plugin's authors. Exists or not
+  class PluginPodspecAuthorsCheck < PluginPodspecCheck
+    def podspec_parameter
+      'authors'
+    end
+
+    def check(project)
+      podspec = project.ios_folder.podspec
+      author_exists = !podspec.authors.nil?
+      CheckReport.new(
+        name,
+        author_exists ? CheckReportStatus::NORMAL : CheckReportStatus::ERROR,
+        description,
+        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
+    def podspec_parameter
+      'source'
+    end
+
+    def check(project)
+      podspec = project.ios_folder.podspec
+      CheckReport.new(
+        name,
+        podspec.source.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        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

@@ -0,0 +1,152 @@
+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
+    def name
+      "PluginPubspec#{pubspec_parameter.capitalize}Check"
+    end
+
+    def pubspec_parameter
+      raise UNIMPLEMENTATION_ERROR
+    end
+
+    def summary
+      "Validate Flutter plugin's #{pubspec_parameter} in pubspec.yaml"
+    end
+  end
+
+  # Check Flutter plugin name in podspec file. Exists or not
+  class PluginPubspecNameCheck < PluginPubspecCheck
+    def pubspec_parameter
+      'name'
+    end
+
+    def check(project)
+      pubspec = project.pubspec
+      CheckReport.new(
+        name,
+        pubspec.pubspec_info.name.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        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
+    def pubspec_parameter
+      'description'
+    end
+
+    def check(project)
+      pubspec = project.pubspec
+      CheckReport.new(
+        name,
+        pubspec.pubspec_info.description.nil? ? CheckReportStatus::WARNING : CheckReportStatus::NORMAL,
+        description,
+        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
+    def pubspec_parameter
+      'version'
+    end
+
+    def check(project)
+      pubspec = project.pubspec
+      CheckReport.new(
+        name,
+        pubspec.pubspec_info.version.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        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
+    def pubspec_parameter
+      'author'
+    end
+
+    def check(project)
+      pubspec = project.pubspec
+      CheckReport.new(
+        name,
+        pubspec.pubspec_info.author.nil? ? CheckReportStatus::NORMAL : CheckReportStatus::WARNING,
+        description,
+        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
+    def pubspec_parameter
+      'homepage'
+    end
+
+    def check(project)
+      pubspec = project.pubspec
+      CheckReport.new(
+        name,
+        pubspec.pubspec_info.homepage.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        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
+    def name
+      'PluginPubspecEffectiveDartCheck'
+    end
+
+    def summary
+      'Validate Flutter plugin\'s Effective Dart rules implementation in pubspec.yaml'
+    end
+
+    def check(project)
+      pubspec = project.pubspec
+      effective_dart = pubspec.dev_dependencies&.detect do |dev_dependency|
+        dev_dependency.name == 'effective_dart'
+      end
+      CheckReport.new(
+        name,
+        effective_dart.nil? ? CheckReportStatus::ERROR : CheckReportStatus::NORMAL,
+        description,
+        pubspec.path
+      )
+    end
+
+    def description
+      'Check Flutter plugin Effective Dart depencency in pubspec file'
+    end
+  end
+end

data/lib/flutter_rb/config/flutter_rb_config.rb

@@ -0,0 +1,16 @@
+module FlutterRb
+  # FlutterRb configuration representation from config in Flutter plugin
+  class FlutterRbConfig
+    def initialize(
+      flutter_checks,
+      android_checks,
+      ios_checks
+    )
+      @flutter_checks = flutter_checks
+      @android_checks = android_checks
+      @ios_checks = ios_checks
+    end
+
+    attr_accessor :flutter_checks, :android_checks, :ios_checks
+  end
+end

data/lib/flutter_rb/config/flutter_rb_config_initializer.rb

@@ -0,0 +1,56 @@
+require_relative './flutter_rb_config'
+require_relative '../checks/plugin_directories_check'
+
+require 'yaml'
+
+module FlutterRb
+  # Class that initialize configuration
+  class FlutterRbConfigInitializer
+    FLUTTER_CHECKS = [
+      PluginDirectoriesCheck.new,
+      PluginPubspecNameCheck.new,
+      PluginPubspecDescriptionCheck.new,
+      PluginPubspecVersionCheck.new,
+      PluginPubspecAuthorCheck.new,
+      PluginPubspecHomepageCheck.new,
+      PluginPubspecEffectiveDartCheck.new
+    ].freeze
+
+    ANDROID_CHECKS = [
+      PluginGradleAndroidPackageCheck.new,
+      PluginGradleVersionCheck.new
+    ].freeze
+
+    IOS_CHECKS = [
+      PluginPodspecNameCheck.new,
+      PluginPodspecVersionCheck.new,
+      PluginPodspecAuthorsCheck.new,
+      PluginPodspecSourceCheck.new
+    ].freeze
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Layout/LineLength
+    def parse(path)
+      config = YAML.load_file(path)['include']
+      flutter_checks = []
+      flutter_checks += config['flutter'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['flutter'].nil?
+      android_checks = []
+      android_checks += config['android'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['android'].nil?
+      ios_checks = []
+      ios_checks += config['ios'].map { |check| Object.const_get("FlutterRb::#{check}").new } unless config['ios'].nil?
+      FlutterRbConfig.new(
+        flutter_checks.empty? ? FLUTTER_CHECKS : flutter_checks,
+        android_checks.empty? ? ANDROID_CHECKS : android_checks,
+        ios_checks.empty? ? IOS_CHECKS : ios_checks
+      )
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity, Layout/LineLength
+
+    def default
+      FlutterRbConfig.new(
+        FLUTTER_CHECKS,
+        ANDROID_CHECKS,
+        IOS_CHECKS
+      )
+    end
+  end
+end

data/lib/flutter_rb/project/project.rb

@@ -0,0 +1,53 @@
+require_relative './specs/flutter/pubspec'
+require_relative './specs/flutter/dev_dependency'
+require_relative './specs/flutter/platform_plugin'
+require_relative './specs/android/android_folder'
+require_relative './specs/android/gradle'
+require_relative './specs/ios/ios_folder'
+
+require 'yaml'
+
+module FlutterRb
+  # Project representation
+  class Project
+    def initialize(
+      path,
+      pubspec,
+      android_folder,
+      ios_folder
+    )
+      @path = path
+      @pubspec = pubspec
+      @android_folder = android_folder
+      @ios_folder = ios_folder
+    end
+
+    attr_accessor :path, :pubspec, :android_folder, :ios_folder
+  end
+
+  # Flutter plugin project parser
+  class ProjectParser
+    def initialize(path)
+      @path = path
+    end
+
+    def project
+      File.exist?("#{@path}/pubspec.yaml") ? parse_project : nil
+    end
+
+    private
+
+    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,
+        File.exist?(android_path) ? AndroidFolder.new(android_path) : nil,
+        File.exist?(ios_path) ? IOSFolder.new(ios_path, pubspec) : nil
+      )
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative './gradle'
+
+module FlutterRb
+  # Android project representation
+  class AndroidFolder
+    def initialize(path)
+      @path = path
+      @gradle = GradleParser.new(@path).parse
+    end
+
+    attr_reader :path, :gradle
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'json'
+
+module FlutterRb
+  # Gradle representation
+  class Gradle
+    def initialize(path, version)
+      @path = path
+      @version = version
+    end
+
+    attr_reader :path, :version
+  end
+
+  # Gradle parser
+  class GradleParser
+    def initialize(path)
+      @path = path
+    end
+
+    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'])
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module FlutterRb
+  # Dev dependency, contains name and version
+  class DevDependency
+    def initialize(name, version)
+      @name = name
+      @version = version
+    end
+
+    attr_reader :name, :version
+  end
+end

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

@@ -0,0 +1,18 @@
+module FlutterRb
+  # Flutter plugin, contains platform, package and plugin class
+  class PlatformPlugin
+    def initialize(platform, package, plugin_class)
+      @platform = platform
+      @package = package
+      @plugin_class = plugin_class
+    end
+
+    attr_reader :platform, :package, :plugin_class
+  end
+
+  # Supported platforms for this tool
+  class Platform
+    ANDROID = 'android'.freeze
+    IOS = 'ios'.freeze
+  end
+end

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

@@ -0,0 +1,69 @@
+require_relative './pubspec_info'
+require_relative './dev_dependency'
+require_relative './platform_plugin'
+
+module FlutterRb
+  # pubspec.yaml representation
+  class Pubspec
+    def initialize(
+      path,
+      pubspec_info,
+      dev_dependencies,
+      platform_plugins
+    )
+      @path = path
+      @pubspec_info = pubspec_info
+      @dev_dependencies = dev_dependencies
+      @platform_plugins = platform_plugins
+    end
+
+    attr_reader :path, :pubspec_info, :dev_dependencies, :platform_plugins
+  end
+
+  # pubspec.yaml parser
+  class PubspecParser
+    def initialize(path, pubspec)
+      @path = path
+      @pubspec = pubspec
+    end
+
+    def parse
+      Pubspec.new(
+        @path,
+        pubspec_info(@pubspec),
+        dev_dependencies(@pubspec),
+        platform_plugins(@pubspec)
+      )
+    end
+
+    def pubspec_info(pubspec)
+      PubspecInfo.new(
+        pubspec['name'],
+        pubspec['description'],
+        pubspec['version'],
+        pubspec['author'],
+        pubspec['homepage']
+      )
+    end
+
+    def dev_dependencies(pubspec)
+      pubspec['dev_dependencies']&.map do |dev_dependency|
+        DevDependency.new(
+          dev_dependency.first,
+          dev_dependency.last
+        )
+      end
+    end
+
+    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'],
+          platform_plugin.first == Platform::ANDROID ? Platform::ANDROID : Platform::IOS
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module FlutterRb
+  # Flutter plugin info from pubspec.yaml
+  class PubspecInfo
+    def initialize(
+      name,
+      description,
+      version,
+      author,
+      homepage
+    )
+      @name = name
+      @description = description
+      @version = version
+      @author = author
+      @homepage = homepage
+    end
+
+    attr_reader :name, :description, :version, :author, :homepage
+  end
+end

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

@@ -0,0 +1,14 @@
+require_relative './podspec'
+
+module FlutterRb
+  # iOS representation
+  class IOSFolder
+    def initialize(path, pubspec)
+      @path = path
+      podspec_path = "#{path}/#{pubspec.pubspec_info.name}.podspec"
+      @podspec = File.exist?(podspec_path) ? PodspecParser.new(podspec_path).parse : nil
+    end
+
+    attr_reader :path, :podspec
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'cocoapods'
+
+module FlutterRb
+  # Podspec representation
+  class Podspec
+    def initialize(
+      path,
+      name,
+      version,
+      authors,
+      source
+    )
+      @path = path
+      @name = name
+      @version = version
+      @authors = authors
+      @source = source
+    end
+
+    attr_reader :path, :name, :version, :authors, :source
+  end
+
+  # Podspec parser
+  class PodspecParser
+    def initialize(path)
+      @path = path
+    end
+
+    def parse
+      podspec = Pod::Specification.from_file(@path)
+      @podspec = Podspec.new(
+        @path,
+        podspec.name,
+        podspec.version.version,
+        podspec.authors.nil? ? podspec.author : podspec.authors,
+        podspec.source
+      )
+    end
+  end
+end

data/lib/flutter_rb/report/check_report.rb

@@ -0,0 +1,47 @@
+require 'colorize'
+
+module FlutterRb
+  # Check report
+  class CheckReport
+    def initialize(
+      check_name,
+      check_report_status,
+      message,
+      path
+    )
+      @check_name = check_name
+      @check_report_status = check_report_status
+      @message = message
+      @path = path
+    end
+
+    def print(colorize: true)
+      if colorize
+        status_color = color_for_report_status(@check_report_status)
+        " * [#{@check_report_status.colorize(status_color)}] #{@check_name}: #{@message}"
+      else
+        " * [#{@check_report_status}] #{@check_name}: #{@message}"
+      end
+    end
+
+    def color_for_report_status(check_report_status)
+      case check_report_status
+      when CheckReportStatus::NORMAL
+        :green
+      when CheckReportStatus::WARNING
+        :yellow
+      when CheckReportStatus::ERROR
+        :red
+      end
+    end
+
+    attr_reader :check_name, :check_report_status, :message, :path
+  end
+
+  # Check report status
+  class CheckReportStatus
+    NORMAL = 'normal'.freeze
+    WARNING = 'warning'.freeze
+    ERROR = 'error'.freeze
+  end
+end

data/lib/flutter_rb.rb

@@ -0,0 +1,93 @@
+require_relative './flutter_rb/project/project'
+require_relative './flutter_rb/checks/plugin_directories_check'
+require_relative './flutter_rb/checks/plugin_pubspec_check'
+require_relative './flutter_rb/checks/plugin_gradle_check'
+require_relative './flutter_rb/checks/plugin_podspec_check'
+require_relative './flutter_rb/config/flutter_rb_config_initializer'
+
+require_relative './checkstyle_report/checkstyle_report'
+
+module FlutterRb
+  # Start FlutterRb checks
+  class FlutterRb
+    def start(path, with_report)
+      project = ProjectParser.new(path).project
+      if project.nil?
+        exit_with_no_project
+      else
+        check_project(
+          project,
+          path,
+          with_report
+        )
+      end
+    end
+
+    def exit_with_no_project
+      puts 'No project'
+      exit(-1)
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def check_project(project, path, with_report)
+      config_initializer = FlutterRbConfigInitializer.new
+      config_path = "#{path}/.flutter_rb.yaml"
+      config = File.exist?(config_path) ? config_initializer.parse(config_path) : config_initializer.default
+      checks = explore_project(
+        project,
+        config.flutter_checks,
+        config.android_checks,
+        config.ios_checks
+      )
+      checks.each { |check| puts check.print }
+      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
+
+    def explore_project(
+      project,
+      flutter_checks,
+      android_checks,
+      ios_checks
+    )
+      result = []
+      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:disable Metrics/MethodLength
+    def create_report(path, checks)
+      errors = checks.map do |check|
+        CheckstyleReport::CheckstyleError.new(
+          level_for_report(check.check_report_status),
+          check.message,
+          check.path,
+          0,
+          0,
+          check.check_name
+        )
+      end
+      CheckstyleReport::CheckstyleReport.new(
+        path,
+        'frb-checkstyle-report',
+        errors
+      ).create_report
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def level_for_report(check_report_status)
+      case check_report_status
+      when CheckReportStatus::NORMAL
+        CheckstyleReport::CheckstyleError::SAVERITY_NORMAL
+      when CheckReportStatus::WARNING
+        CheckstyleReport::CheckstyleError::SAVERITY_WARNING
+      when CheckReportStatus::ERROR
+        CheckstyleReport::CheckstyleError::SAVERITY_ERROR
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: flutter_rb
+version: !ruby/object:Gem::Version
+  version: 0.8.1
+platform: ruby
+authors:
+- Artem Fomchenkov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.13.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.13.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description:
+email: artem.fomchenkov@outlook.com
+executables:
+- frb
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/frb
+- lib/checkstyle_report/checkstyle_report.rb
+- lib/flutter_rb.rb
+- lib/flutter_rb/checks/check.rb
+- lib/flutter_rb/checks/plugin_directories_check.rb
+- lib/flutter_rb/checks/plugin_gradle_check.rb
+- lib/flutter_rb/checks/plugin_podspec_check.rb
+- lib/flutter_rb/checks/plugin_pubspec_check.rb
+- lib/flutter_rb/config/flutter_rb_config.rb
+- lib/flutter_rb/config/flutter_rb_config_initializer.rb
+- lib/flutter_rb/project/project.rb
+- lib/flutter_rb/project/specs/android/android_folder.rb
+- lib/flutter_rb/project/specs/android/gradle.rb
+- lib/flutter_rb/project/specs/flutter/dev_dependency.rb
+- lib/flutter_rb/project/specs/flutter/platform_plugin.rb
+- lib/flutter_rb/project/specs/flutter/pubspec.rb
+- lib/flutter_rb/project/specs/flutter/pubspec_info.rb
+- 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/fartem/flutter-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A Ruby tool for checking a Flutter plugin structure
+test_files: []