linters 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f98842c199ffe4239b74cfe191ab410cfd69a656419f5ece6c40e3cb915b081
+  data.tar.gz: bf2bea64cec935d8956b6f76080c32e070d539dab871162fb83968dd8ab049f7
+SHA512:
+  metadata.gz: e095916980ae878fd9d7dfca9d9c4bb5dc48ab046fadf8754ffd3500e2b3f0d6dd60236e32b1b7a9819df14522bfdc06fc5e3a582591a79c43e3f3626eedbf69
+  data.tar.gz: d6903ad6dcd855510c6e9fbbd62673182ff43faf7edb802d86ac76941a7d8611e3b2531713e8193ff6bc2e85600bf109847ce265b167ba2bcd8a7cf87412011c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+*.gem

data/.reek.yml

@@ -0,0 +1,7 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false
+  TooManyStatements:
+    max_statements: 10
+  FeatureEnvy:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+Style/Documentation:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - linters.gemspec

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{ repo_name }" }
+
+# Specify your gem's dependencies in linters.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    linters (1.0.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    byebug (11.0.1)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    colorize (0.8.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    fasterer (0.5.1)
+      colorize (~> 0.7)
+      ruby_parser (>= 3.13.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.2)
+    kwalify (0.7.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    reek (5.4.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.13.1)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.12.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    unicode-display_width (1.6.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  bundler-audit (~> 0.6.1)
+  byebug (~> 11.0.1)
+  fasterer (~> 0.5.1)
+  linters!
+  reek (~> 5.4.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.71.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ruby-pianist
+
+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,111 @@
+# Linters
+
+Linters is a tool which checks ruby applications using different code's analyzers.
+Default available analyzers are:
+* rubocop
+* reek
+* brakeman
+* bundle-audit
+* fasterer
+
+## Installation
+
+* Using RubyGems:
+
+  ```gem install linters```
+
+  Install the linters which you want to use:
+
+  ```gem install rubocop reek and etc...```
+
+* Using Bundler:
+
+  ```ruby
+  group :development do
+    gem 'linters'
+  end
+  ```
+
+  Add linters which you want to use:
+  ```ruby
+    group :development do
+      gem 'rubocop'
+      gem 'reek'
+      and etc...
+    end
+  ```
+
+And then execute:
+
+  $ bundle
+
+## Usage
+
+### Configuration
+
+Settings with default values:
+
+```ruby
+  Linters.configure do |config|
+    config.custom_linters = {}
+    config.linters = %i[rubocop reek bundle_audit fasterer]
+    config.settings_path = 'config/settings.yml'
+  end
+```
+
+Default config/settings.yml:
+
+```
+rubocop:
+  warnings_number: 0
+reek:
+  warnings_number: 0
+bundle_audit:
+  warnings_number: 0
+fasterer:
+  warnings_number: 0
+```
+
+If settings is absent that warnings_number equal zero.
+
+### Adding a customer linter
+```ruby
+  Linters.configure do |config|
+    config.custom_linters = {
+      name: {
+        command: 'execute command',
+        parse_output: 'parse output of the command for getting quantity of warnings'
+      }
+    }
+  end
+```
+
+### Rewrite an available linter
+```ruby
+  Linters.configure do |config|
+    config.custom_linters = {
+      rubocop: {
+        command: 'your command',
+        parse_output: 'your parsing output'
+      }
+    }
+  end
+```
+
+### Run a check
+* Run all linters
+```
+  rake linters:run_all
+```
+* Run a specific linter
+```
+  rake linters:run[name of linter]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-pianist/linters.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+import 'lib/tasks/linters.rake'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'linters'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/settings.yml

@@ -0,0 +1,9 @@
+linters:
+  rubocop:
+    warnings_number: 0
+  reek:
+    warnings_number: 0
+  bundle_audit:
+    warnings_number: 0
+  fasterer:
+    warnings_number: 0

data/lib/linters.rb

@@ -0,0 +1,19 @@
+require 'linters/version'
+require 'linters/configuration'
+require 'linters/linter_settings'
+require 'linters/builder'
+require 'linters/linter'
+require 'linters/manager'
+require 'linters/railtie' if defined?(Rails)
+
+module Linters
+  class << self
+    def configuration
+      @configuration ||= Linters::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/linters/builder.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+module Linters
+  class Builder
+    def initialize
+      @config = Linters.configuration
+    end
+
+    def perform
+      result = config.linters.map { |linter| Linter.new(linter) }
+
+      result + config.custom_linters.map { |linter, settings| Linter.new(linter, settings) }
+    end
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/linters/configuration.rb

@@ -0,0 +1,12 @@
+module Linters
+  class Configuration
+    # :reek:Attribute
+    attr_accessor :custom_linters, :linters, :settings_path
+
+    def initialize
+      @custom_linters = {}
+      @linters = %i[rubocop reek bundle_audit fasterer]
+      @settings_path = 'config/settings.yml'
+    end
+  end
+end

data/lib/linters/linter.rb

@@ -0,0 +1,30 @@
+module Linters
+  class Linter
+    def initialize(name, custom_settings = {})
+      @settings = LinterSettings.new(name, custom_settings)
+    end
+
+    def perform
+      command_output = `#{ settings.command }`
+
+      settings.parse_output.call(command_output)
+    end
+
+    def method_missing(method, *args, &block)
+      if %i[warnings_number name].include?(method)
+        settings.send(method)
+      else
+        super
+      end
+    end
+
+    # :reek:BooleanParameter
+    def respond_to_missing?(method, include_private = false)
+      %i[warnings_number name].include?(method) || super
+    end
+
+    private
+
+    attr_reader :settings
+  end
+end

data/lib/linters/linter_settings.rb

@@ -0,0 +1,68 @@
+require 'yaml'
+require 'json'
+
+module Linters
+  class LinterSettings
+    DEFAULT_SETTINGS = {
+      brakeman: {
+        default_command: 'brakeman --quiet --skip-libs -f json',
+        parse_output: ->(output) { JSON.parse(output)['scan_info']['security_warnings'] }
+      },
+      bundle_audit: {
+        default_command: 'bundle-audit update > /dev/null 2>&1 && bundle-audit',
+        parse_output: ->(output) { output.scan(/Name:/).count }
+      },
+      fasterer: {
+        default_command: 'fasterer',
+        parse_output: lambda { |output, lines_per_warning = 3|
+          output.split("\n").length / lines_per_warning
+        }
+      },
+      reek: {
+        default_command: 'reek --format json *',
+        parse_output: ->(output) { JSON.parse(output).size }
+      },
+      rubocop: {
+        default_command: 'rubocop --format json',
+        parse_output: ->(output) { JSON.parse(output)['summary']['offense_count'] }
+      }
+    }.freeze
+
+    def initialize(name, custom_settings = {})
+      @name = name
+      @settings = DEFAULT_SETTINGS.fetch(name) { {} }
+      @settings = @settings.merge(load_settings(name)).merge(custom_settings)
+    end
+
+    def name
+      settings.fetch(:name) { @name }
+    end
+
+    def warnings_number
+      settings.fetch(:warnings_number) { 0 }
+    end
+
+    def command
+      settings.fetch(:command) { settings.fetch(:default_command) }
+    end
+
+    def parse_output
+      settings[:parse_output]
+    end
+
+    private
+
+    attr_reader :settings
+
+    # :reek:UtilityFunction
+    def load_settings(name)
+      path = Linters.configuration.settings_path
+
+      return {} unless File.exist?(path)
+
+      (YAML.load_file(path)['linters'][name.to_s] || {}).each_with_object({}) do |item, result|
+        result[item[0].to_sym] = item[1]
+      end
+    end
+  end
+end

data/lib/linters/manager.rb

@@ -0,0 +1,44 @@
+module Linters
+  class Manager
+    def initialize
+      @linters = Builder.new.perform
+    end
+
+    def perform_all
+      linters.each do |linter|
+        linter_name = linter.name
+
+        warnings = linter.perform
+
+        handle_warnings(linter_name, warnings, linter.warnings_number)
+      end
+    end
+
+    def perform_by_name(name)
+      linter = linters.select { |item| item.name == name }[0]
+
+      warnings = linter.perform
+
+      handle_warnings(linter.name, warnings, linter.warnings_number)
+    end
+
+    private
+
+    attr_reader :linters
+
+    def handle_warnings(linter_name, warnings, max_warnings)
+      result = warnings <= max_warnings
+
+      message = if result
+        "#{ linter_name }: quantity of warnings - #{ warnings }/#{ max_warnings }"
+      else
+        "#{ linter_name }: quantity of warnings shouldn't be more "\
+        "#{ max_warnings } (now #{ warnings })"
+      end
+
+      puts message
+
+      exit(1) unless result
+    end
+  end
+end

data/lib/linters/railtie.rb

@@ -0,0 +1,7 @@
+module Linters
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/linters.rake'
+    end
+  end
+end

data/lib/linters/version.rb

@@ -0,0 +1,3 @@
+module Linters
+  VERSION = '1.0.0'.freeze
+end

data/lib/tasks/linters.rake

@@ -0,0 +1,19 @@
+require_relative '../linters'
+
+namespace :linters do
+  desc 'Run linters or the linter with the specific name'
+  task :run, [:name] do |_, args|
+    raise "Please, set the linter's name" if args.name.nil?
+
+    manager = Linters::Manager.new
+
+    manager.perform_by_name(args.name.to_sym)
+  end
+
+  desc 'Run all linters'
+  task :run_all do
+    manager = Linters::Manager.new
+
+    manager.perform_all
+  end
+end

data/linters.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'linters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'linters'
+  spec.version       = Linters::VERSION
+  spec.authors       = ['Ruby Pianist']
+  spec.email         = ['rubypianist@gmail.com']
+
+  spec.summary       = "Tool checks ruby applications using different code's analyzers."
+  spec.description   = 'Check of ruby applications using rubocop, reek, brakeman, fasterer, bundle_audit and the other custom linters'
+  spec.homepage      = 'https://github.com/ruby-pianist/linters'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rake'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6.1'
+  spec.add_development_dependency 'byebug', '~> 11.0.1'
+  spec.add_development_dependency 'fasterer', '~> 0.5.1'
+  spec.add_development_dependency 'reek', '~> 5.4.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.71.0'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: linters
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ruby Pianist
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.0.1
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+description: Check of ruby applications using rubocop, reek, brakeman, fasterer, bundle_audit
+  and the other custom linters
+email:
+- rubypianist@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/settings.yml
+- lib/linters.rb
+- lib/linters/builder.rb
+- lib/linters/configuration.rb
+- lib/linters/linter.rb
+- lib/linters/linter_settings.rb
+- lib/linters/manager.rb
+- lib/linters/railtie.rb
+- lib/linters/version.rb
+- lib/tasks/linters.rake
+- linters.gemspec
+homepage: https://github.com/ruby-pianist/linters
+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.3
+signing_key: 
+specification_version: 4
+summary: Tool checks ruby applications using different code's analyzers.
+test_files: []