fastlane-plugin-oclint_json_compilation_database 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92d026b17be5d6a31b81998c6a52e337228bdc80562680c0cba8600028a09bbe
+  data.tar.gz: 75ad7c86bc673b04521b9cab9ca94296135e5d2f3ad58206e596dfeb4a70c6b3
+SHA512:
+  metadata.gz: d82493ef6c7570c1b2ea93cde04cb6fe30e218ce1f1d6601cbcaaa29b7e359d6feb176be52b249a6bad12e6b5a5fa6e9660efe45427d067319b45d450a184d88
+  data.tar.gz: d73da06169264e48d35479ea228cf3261e0d5bb503fb2c9f6fdd6a01fa797ef4d501c13716e63005e642e75a38a8507a5166bcd62d44a0520d9893cfce8dc4d0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marcin Stepnowski <marcin.s@meniga.com>
+
+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,52 @@
+# oclint_json_compilation_database plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-oclint_json_compilation_database)
+[![Build Status](https://travis-ci.org/meniga/fastlane-plugin-oclint_json_compilation_database.svg?branch=master)](https://travis-ci.org/meniga/fastlane-plugin-oclint_json_compilation_database)
+[![codecov](https://codecov.io/gh/meniga/fastlane-plugin-oclint_json_compilation_database/branch/master/graph/badge.svg)](https://codecov.io/gh/meniga/fastlane-plugin-oclint_json_compilation_database)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-oclint_json_compilation_database`, add it to your project by running:
+
+```bash
+fastlane add_plugin oclint_json_compilation_database
+```
+
+## About oclint_json_compilation_database
+
+Run OCLint validation with oclint-json-compilation-database and fastlane :dart: :rocket:
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/oclint_json_compilation_database.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/oclint_json_compilation_database/version'
+
+module Fastlane
+  module OclintJsonCompilationDatabase
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::OclintJsonCompilationDatabase.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/oclint_json_compilation_database/actions/oclint_json_compilation_database_action.rb

@@ -0,0 +1,140 @@
+require 'fastlane'
+
+module Fastlane
+  module Actions
+    class OclintJsonCompilationDatabaseAction < Action
+      def self.run(params)
+        cmd = []
+        cmd << (params[:executable] || "oclint-json-compilation-database").dup
+
+        build_path = params[:build_path]
+        if build_path
+          cmd << '-p'
+          cmd << build_path
+        end
+
+        include = Array(params[:include])
+        include.each do |path|
+          cmd << "--include"
+          cmd << path
+        end
+
+        exclude = Array(params[:exclude])
+        exclude.each do |path|
+          cmd << "--exclude"
+          cmd << path
+        end
+
+        oclint_args = []
+        report_type = params[:report_type]
+        if report_type
+          oclint_args << "-report-type"
+          oclint_args << report_type
+        end
+
+        oclint_args << "-enable-clang-static-analyzer" if params[:enable_clang_static_analyzer]
+
+        if oclint_args.any?
+          cmd << "--"
+          cmd << oclint_args
+        end
+
+        report_path = params[:report_path]
+        if report_path
+          cmd << ">>"
+          cmd << report_path
+        end
+
+        begin
+          Actions.sh(cmd.join(' '))
+        rescue
+          handle_error(params[:ignore_exit_status])
+        end
+      end
+
+      def self.handle_error(ignore_exit_status)
+        if ignore_exit_status
+          failure_suffix = 'which would normally fail the build.'
+          secondary_message = 'fastlane will continue because the `ignore_exit_status` option was used! 🙈'
+        else
+          failure_suffix = 'which represents a failure.'
+          secondary_message = 'If you want fastlane to continue anyway, use the `ignore_exit_status` option. 🙈'
+        end
+
+        UI.important("")
+        UI.important("oclint-json-compilation-database finished with status code other than 0, #{failure_suffix}")
+        UI.important(secondary_message)
+        UI.important("")
+        UI.user_error!("oclint-json-compilation-database finished with errors") unless ignore_exit_status
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :executable,
+                                       env_name: 'FL_OCLJCD_EXECUTABLE',
+                                       description: 'Path to the `oclint-json-compilation-database` executable on your machine',
+                                       optional: true,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find executable path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :build_path,
+                                       env_name: 'FL_OCLJCD_BUILD_PATH',
+                                       description: 'Specify the directory containing compile_commands.json',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :include,
+                                       env_name: 'FL_OCLJCD_INCLUDE',
+                                       description: 'Extract files matching pattern',
+                                       optional: true,
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :exclude,
+                                       env_name: 'FL_OCLJCD_EXCLUDE',
+                                       description: 'Remove files matching pattern',
+                                       optional: true,
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :enable_clang_static_analyzer,
+                                       env_name: 'FL_OCLJCD_EXCLUDE_ENABLE_CLANG_STATIC_ANALYZER',
+                                       description: 'Enable Clang Static Analyzer, and integrate results into OCLint report',
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :report_path,
+                                       env_name: 'FL_OCLJCD_REPORT_PATH',
+                                       description: 'The reports file path',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :report_type,
+                                       env_name: 'FL_OCLJCD_REPORT_TYPE',
+                                       description: 'The type of the report. Available: text, html, xml, json, pmd, xcode',
+                                       optional: true,
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         available = ['text', 'html', 'xml', 'json', 'pmd', 'xcode']
+                                         UI.user_error!("Available values are '#{available.join("', '")}'") unless available.include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :ignore_exit_status,
+                                       env_name: "FL_OCLJCD_IGNORE_EXIT_STATUS",
+                                       description: "Ignore the exit status of the oclint-json-compilation-database command, so that serious violations \
+                                                     don't fail the build (true/false)",
+                                       default_value: false,
+                                       type: Boolean,
+                                       optional: true)
+
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+
+      def self.authors
+        ["Marcin Stepnowski"]
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/oclint_json_compilation_database/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module OclintJsonCompilationDatabase
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-oclint_json_compilation_database
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Meniga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.146.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.146.1
+description: 
+email: mobile.dev@meniga.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/oclint_json_compilation_database.rb
+- lib/fastlane/plugin/oclint_json_compilation_database/actions/oclint_json_compilation_database_action.rb
+- lib/fastlane/plugin/oclint_json_compilation_database/version.rb
+homepage: https://github.com/meniga/fastlane-plugin-oclint_json_compilation_database
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: 'Run OCLint validation with oclint-json-compilation-database and fastlane
+  :dart: :rocket:'
+test_files: []