keepclean 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d53d71acf6dbc0ed3021281b4177a56208ea8024abb456fd8dcc777e9dac8a8b
+  data.tar.gz: 57851b8d5a96a49c13ba08cd2b7e26b151a7024dbd46fe31fced212645583efa
+SHA512:
+  metadata.gz: d14ffe8aad2e92b58b571f279c997e57ffc1e0532ffdbdae2b3562ca259120e8003f817ef85743ceddd6e920d85a16134c47049aedf04d107b1ba0038af87c6f
+  data.tar.gz: 2ee0ea8861beb7ddc30022849c6226588c6c6bbbb4d588f67979d15e05ec4490d3dbdf1b59228b817b63064385a02f5c82131251ffcc64aa0f2127ec05e65ead

data/bin/keepclean

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'keepclean'
+Keepclean.run(ARGV)

data/lib/integrations/base.rb

@@ -0,0 +1,37 @@
+require 'pronto'
+require 'pronto/cli'
+
+module Integration
+  class Base
+    def initialize(pronto: false)
+      @pronto = pronto
+    end
+
+    def pronto_enabled?
+      @pronto
+    end
+
+    def pronto_name
+      self.class.name.demodulize.underscore
+    end
+
+    def run_with(config)
+      raise NotImplementedError
+    end
+
+    def run_with_config_handling_exit(config)
+      if pronto_enabled?
+        args = ['run', '.', '--exit-code', '--runner', pronto_name]
+        Keepclean.logger.debug "Running pronto with args: #{args.inspect}"
+        ::Pronto::CLI.start(args)
+        ::Pronto::Runner.remove_instance_variable(:@repository)
+      else
+        Keepclean.logger.debug "Running on all project"
+        run_with(config)
+      end
+    rescue SystemExit => e
+      Keepclean.logger.debug "Handling SystemExit: #{e.inspect} => status: #{e.status} / success?: #{e.success?}"
+      return e.success?
+    end
+  end
+end

data/lib/integrations/brakeman.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+require 'brakeman'
+require 'brakeman/commandline'
+
+module Integration
+  class Brakeman < Base
+    def run_with(config)
+      args = {
+        quiet: true,
+        summary_only: :no_summary,
+      }
+      Keepclean.logger.debug "Running with args: #{args.inspect}"
+      ::Brakeman::Commandline.start(args)
+      true
+    end
+  end
+end

data/lib/integrations/bundle_audit.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+require 'bundler/audit/cli'
+
+module Integration
+  class BundleAudit < Base
+    def run_with(config)
+      args = ['check']
+
+      ignored_cves = config.fetch('ignored_cve', [])
+
+      if !ignored_cves.empty?
+        args += ["--ignore"]
+        ignored_cves.each do |ignored_cve|
+          args << ignored_cve
+        end
+      end
+
+      Keepclean.logger.debug "Updating CVE database"
+      Bundler::Audit::CLI.start(['update', '--quiet'])
+
+      Keepclean.logger.debug "Running with args: #{args.inspect}"
+      Bundler::Audit::CLI.start(args)
+      true
+    end
+  end
+end

data/lib/integrations/danger.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+require 'danger'
+
+module Integration
+  class Danger < Base
+    def run_with(config)
+      args = ['staging']
+      Keepclean.logger.debug "Running with args: #{args}"
+      ::Danger::Runner.run args
+    end
+  end
+end

data/lib/integrations/danger/Dangerfile

@@ -0,0 +1 @@
+warn "MR is classed as Work in Progress" if gitlab.mr_title.include? "WIP:"

data/lib/integrations/erb_lint.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+require 'erb_lint/cli'
+
+module Integration
+  class ErbLint < Base
+    def run_with(config)
+      args = ['--lint-all']
+      Keepclean.logger.debug "Running with args: #{args}"
+      ERBLint::CLI.new.run(args)
+    end
+  end
+end

data/lib/integrations/flay.rb

@@ -0,0 +1,33 @@
+require_relative 'base'
+require 'flay'
+
+module Integration
+  class Flay < Base
+    def run_with(config)
+      args = []
+
+      if mass_threshold = config['mass_threshold']
+        args += ['-m', mass_threshold.to_s]
+      end
+
+      should_delete_flayignore = false
+      if ignored = config['ignored']
+        if File.file?('.flayignore')
+          Keepclean.logger.warn('Using local .flayignore')
+        else
+          should_delete_flayignore = File.write('.flayignore', ignored.join("\n"), mode: 'a') != 0
+        end
+      end
+
+      args += ['-d', '-#']
+
+      Keepclean.logger.debug "Running with args: #{args.inspect}"
+      flay = ::Flay.run(args)
+      flay.report
+
+      File.delete('.flayignore') if should_delete_flayignore
+
+      flay.total == 0
+    end
+  end
+end

data/lib/integrations/flog.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require "flog_cli"
+
+module Integration
+  class Flog < Base
+    def run_with(config)
+      args = ['-m']
+      Keepclean.logger.debug "Running with args:  #{args.inspect}"
+      FlogCLI.run(args)
+      true
+    end
+  end
+end

data/lib/integrations/license_finder.rb

@@ -0,0 +1,27 @@
+require_relative 'base'
+require 'license_finder'
+
+module Integration
+  class LicenseFinder < Base
+    def run_with(config)
+      Tempfile.create(['dependency_decisions', '.yml']) do |f|
+        dependency_decisions = []
+
+        allowed_licenses = config.fetch('allowed_licenses', [])
+
+        allowed_licenses.each do |allowed_license|
+          dependency_decisions << [:permit, allowed_license, { who: 'Keepclean' }]
+        end
+
+        f.write dependency_decisions.to_yaml
+        f.close
+
+        args = ['--decisions_file', f.path]
+        Keepclean.logger.debug "Running with args: #{args.inspect}"
+        ::LicenseFinder::CLI::Main.start(args)
+      end
+
+      true
+    end
+  end
+end

data/lib/integrations/rails_best_practices.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+require 'rails_best_practices'
+
+module Integration
+  class RailsBestPractices < Base
+    def run_with(config)
+      args = ['.', { 'silent' => true }]
+      Keepclean.logger.debug "Running with args: #{args.inspect}"
+      analyzer = ::RailsBestPractices::Analyzer.new(*args)
+      analyzer.analyze
+      analyzer.output
+      analyzer.runner.errors.empty?
+    end
+  end
+end

data/lib/integrations/reek.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require 'reek'
+require 'reek/cli/application'
+
+module Integration
+  class Reek < Base
+    def run_with(config)
+      args = ['.']
+      Keepclean.logger.debug "Running with args: #{args.inspect}"
+      ::Reek::CLI::Application.new(args).execute == 0
+    end
+  end
+end

data/lib/integrations/rubocop.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+require 'rubocop'
+
+module Integration
+  class Rubocop < Base
+    def run_with(config)
+      Keepclean.logger.debug "Running with args:"
+      RuboCop::CLI.new.run == 0
+    end
+  end
+end

data/lib/keepclean.rb

@@ -0,0 +1,113 @@
+require 'net/http'
+require 'json'
+require 'active_support/core_ext/string/inflections.rb'
+
+require 'keepclean/version'
+require 'keepclean/formatter'
+
+module Keepclean
+  def self.project_name
+    ENV['KEEPCLEAN_PROJECT'] || ENV['DRONE_REPO']
+  end
+
+  def self.build_id
+    ENV['KEEPCLEAN_BUILD_ID'] || ENV['DRONE_BUILD_NUMBER']
+  end
+
+  def self.logger
+    return @logger if defined?(@logger)
+    @log_output = StringIO.new
+    @logger = ActiveSupport::TaggedLogging.new(Logger.new(@log_output)).tap do |l|
+      l.level = if ENV['KEEPCLEAN_DEBUG']
+        Logger::DEBUG
+      else
+        Logger::WARN
+      end
+      l.formatter = Formatter.new
+    end
+  end
+
+  def self.run(args)
+    at_exit do
+      logs = @log_output.string
+      unless logs.empty?
+        puts ""
+        puts "===== DEBUG ====="
+        puts ""
+        puts logs
+      end
+    end
+
+    puts "*** Keepclean v#{Keepclean::VERSION} ***"
+
+    token = ENV['KEEPCLEAN_TOKEN']
+    unless token
+      puts "Token no set, use KEEPCLEAN_TOKEN"
+      exit -1
+    end
+
+    unless project_name
+      puts "Project no set, use KEEPCLEAN_PROJECT"
+      exit -1
+    end
+
+    uri = URI('http://192.168.0.31:5000/manifest')
+    res = Net::HTTP.post_form(uri, {
+      version: Keepclean::VERSION,
+      token: token,
+      project: project_name
+    })
+
+    unless res['content-type'].start_with?('application/json')
+      puts res.body
+      exit -1
+    end
+
+    manifest = JSON.parse(res.body)
+    logger.debug "Manifest: #{manifest}"
+
+    puts "Configure at: #{manifest['configuration_url']}"
+
+    success = true
+
+    manifest.each do |key, metadata|
+      next unless metadata['enabled']
+
+      klass = case key
+      when 'custom'
+       class_name =  metadata.dig('config', 'class_name')
+       unless class_name
+         puts "#{key} check skipped because the class_name is not configured"
+         next
+       end
+       class_name.gsub('Integration::', '')
+      else
+        key.camelize
+      end
+
+      logger.tagged(klass) do
+        begin
+          puts ""
+          puts "*** #{klass} ***"
+          puts ""
+
+          require "integrations/#{klass.underscore}"
+          success &= "Integration::#{klass}".constantize.new(pronto: metadata['on_branch']).run_with_config_handling_exit(metadata['config']) || metadata['allowed_to_fail']
+          logger.debug "Success: #{success}"
+        rescue LoadError => e
+          puts "#{klass} check skipped because of error: #{e.message}"
+        ensure
+          if klass
+            puts ""
+            puts "*** /#{klass}/ ***"
+            puts ""
+          end
+        end
+      end
+    end
+
+    exit success
+  rescue Errno::ECONNREFUSED => e
+    puts "We couldn't reach the keepclean server: #{e.message}"
+  end
+end

data/lib/keepclean/formatter.rb

@@ -0,0 +1,15 @@
+require 'logger'
+require 'active_support/tagged_logging.rb'
+
+module Keepclean
+  class Formatter < Logger::Formatter
+    include ActiveSupport::TaggedLogging::Formatter
+
+    def call(severity, timestamp, progname, msg)
+      (String === msg ? msg : msg.inspect).split("\n").map do |line|
+        "%s %s[%s] %s%s: %s\n" % [Time.at(timestamp).strftime("%b %e %H:%M:%S"), Keepclean.project_name, Keepclean.build_id, tags_text, severity, line]
+      end.join
+    end
+  end
+end
+

data/lib/keepclean/version.rb

@@ -0,0 +1,3 @@
+module Keepclean
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,339 @@
+--- !ruby/object:Gem::Specification
+name: keepclean
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yoann Lecuyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.1
+- !ruby/object:Gem::Dependency
+  name: danger-gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: erb_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+- !ruby/object:Gem::Dependency
+  name: ruby2ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pronto-reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pronto-flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pronto-brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pronto-rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pronto-erb_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+description: Keep your repo clean with simple CI rules
+email: yoann.lecuyer@gmail.com
+executables:
+- keepclean
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/keepclean
+- lib/integrations/base.rb
+- lib/integrations/brakeman.rb
+- lib/integrations/bundle_audit.rb
+- lib/integrations/danger.rb
+- lib/integrations/danger/Dangerfile
+- lib/integrations/erb_lint.rb
+- lib/integrations/flay.rb
+- lib/integrations/flog.rb
+- lib/integrations/license_finder.rb
+- lib/integrations/rails_best_practices.rb
+- lib/integrations/reek.rb
+- lib/integrations/rubocop.rb
+- lib/keepclean.rb
+- lib/keepclean/formatter.rb
+- lib/keepclean/version.rb
+homepage: https://rubygems.org/gems/keepclean
+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.0
+signing_key: 
+specification_version: 4
+summary: Keep clean!
+test_files: []