renuo-bin-check 0.2.0

data/bin/setup

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def run(name, file_which_must_not_exist = nil)
+  unless file_which_must_not_exist && File.exist?(file_which_must_not_exist)
+    puts "== #{name} =="
+    yield
+    puts
+  end
+end
+
+def install_or_update_gem(gem)
+  if ENV['UPDATE']
+    system "gem install #{gem}"
+  else
+    system "which #{gem.gsub('_', '-')} || gem install #{gem}"
+  end
+end
+
+Dir.chdir APP_ROOT do
+  run 'Installing dependencies' do
+    system 'gem install bundler --conservative'
+    system 'bundle check || bundle install --jobs=3 --retry=3'
+    install_or_update_gem('pry')
+    install_or_update_gem('rubocop')
+    install_or_update_gem('reek')
+    install_or_update_gem('filewatcher')
+  end
+
+  run 'Installing JS dependencies' do
+    system 'which coffeelint || npm install -g coffeelint'
+    system 'which tsc || npm install -g typescript'
+    system 'which tslint || npm install -g tslint'
+  end
+
+  run 'Copying config/application.yml', 'config/application.yml' do
+    system 'cp config/application.example.yml config/application.yml'
+  end
+
+  run('Preparing database') do
+    system 'bin/rake db:version >> /dev/null 2>&1 || bin/rake db:create:all && bin/rake db:setup'
+  end
+
+  run 'Removing old logs and tempfiles' do
+    system 'rm -f log/*'
+    system 'rm -rf tmp/cache'
+  end
+
+  run 'Creating pre-commit hook link', '.git/hooks/pre-commit' do
+    system 'ln -s ../../bin/check .git/hooks/pre-commit'
+  end
+
+  run('Setting dev host in /etc/hosts') do
+    system 'grep \'<appname>.dev\' /etc/hosts || echo \'127.0.0.1 <appname>.dev\' | sudo tee -a /etc/hosts'
+  end
+
+  run('Running checks') { abort('bin/check failed') unless system('bin/check') }
+end

data/lib/renuo-bin-check.rb

@@ -0,0 +1,8 @@
+require 'renuo_bin_check/cacher'
+require 'renuo_bin_check/initializer'
+require 'renuo_bin_check/master_thread'
+require 'renuo_bin_check/printer'
+require 'renuo_bin_check/result'
+require 'renuo_bin_check/script_config'
+require 'renuo_bin_check/servant_thread'
+require 'renuo_bin_check/version'

data/lib/renuo_bin_check/cacher.rb

@@ -0,0 +1,46 @@
+require 'digest'
+require 'fileutils'
+require 'renuo_bin_check/result'
+
+module RenuoBinCheck
+  class Cacher
+    def initialize(name, paths)
+      @name = name
+      @file_names = paths.map { |path| Dir[path] }.flatten.sort
+      @hash = hash_files
+    end
+
+    def exists?
+      File.exist?("tmp/bin-check/#{@name}/#{@hash}")
+    end
+
+    def result
+      read
+    end
+
+    def cache(result)
+      FileUtils.mkdir_p "tmp/bin-check/#{@name}/#{@hash}"
+      File.write "tmp/bin-check/#{@name}/#{@hash}/standard_output", result.standard_output
+      File.write "tmp/bin-check/#{@name}/#{@hash}/error_output", result.error_output
+      File.write "tmp/bin-check/#{@name}/#{@hash}/exit_code", result.exit_code
+    end
+
+    private
+
+    def read
+      standard_output = File.read("tmp/bin-check/#{@name}/#{@hash}/standard_output")
+      error_output = File.read("tmp/bin-check/#{@name}/#{@hash}/error_output")
+      exit_code = File.read("tmp/bin-check/#{@name}/#{@hash}/exit_code").to_i
+      Result.new(standard_output, error_output, exit_code)
+    end
+
+    def hash_files
+      Digest::MD5.hexdigest @file_names.map { |file_name| hash_file(file_name) if File.file? file_name }.to_s
+    end
+
+    #:reek:UtilityFunction
+    def hash_file(file_name)
+      Digest::MD5.file(file_name).hexdigest + Digest::MD5.hexdigest(file_name)
+    end
+  end
+end

data/lib/renuo_bin_check/default_scripts/default_rails.rb

@@ -0,0 +1,160 @@
+module RenuoBinCheck
+  # rubocop:disable Metrics/ModuleLength
+  module DefaultScripts
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    # :reek:TooManyStatements
+    def rails
+      bin_check = RenuoBinCheck::Initializer.new
+
+      mini_profiler(bin_check)
+      todo(bin_check)
+      console_log(bin_check)
+      put_without_brackets(bin_check)
+      put_with_brackets(bin_check)
+      pp_and_p(bin_check)
+      p_with_brackets(bin_check)
+      rubocop_autocorrect(bin_check)
+      slim_lint(bin_check)
+      scss_lint(bin_check)
+      tslint(bin_check)
+      brakeman(bin_check)
+      reek(bin_check)
+      rspec(bin_check)
+
+      bin_check.run
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    def mini_profiler(bin_check)
+      bin_check.check do |config|
+        config.command "grep 'rack-mini-profiler' Gemfile.lock >> /dev/null"
+        config.reversed_exit true
+        config.files ['Gemfile.lock']
+      end
+    end
+
+    def todo(bin_check)
+      bin_check.check do |config|
+        config.command "grep --exclude-dir='app/assets/typings/**' -i -r 'TODO' app spec config db Rakefile README.md"\
+        ' Gemfile'
+        config.reversed_exit true
+        config.files ['app/**/*', 'spec/**/*', 'config/**/*', 'db/**/*', 'Rakefile', 'README.md', 'Gemfile']
+      end
+    end
+
+    def console_log(bin_check)
+      bin_check.check do |config|
+        config.command "grep -i -r 'console.log' app spec"
+        config.reversed_exit true
+        config.files ['app/**/*', 'spec/**/*']
+      end
+    end
+
+    def put_without_brackets(bin_check)
+      bin_check.check do |config|
+        config.command "grep -i -r '  puts ' app spec"
+        config.reversed_exit true
+        config.files ['app/**/*', 'spec/**/*']
+      end
+    end
+
+    def put_with_brackets(bin_check)
+      bin_check.check do |config|
+        config.command "grep -i -r '  puts(' app spec"
+        config.reversed_exit true
+        config.files ['app/**/*', 'spec/**/*']
+      end
+    end
+
+    def pp_and_p(bin_check)
+      bin_check.check do |config|
+        config.command "grep -i -r '(  pp? [^=])|(= pp? )' app spec"
+        config.reversed_exit true
+        config.files ['app/**/*', 'spec/**/*']
+      end
+    end
+
+    def p_with_brackets(bin_check)
+      bin_check.check do |config|
+        config.command "grep -i -r '  p(' app spec"
+        config.reversed_exit true
+        config.files ['app/**/*', 'spec/**/*']
+      end
+    end
+
+    def rubocop_autocorrect(bin_check)
+      bin_check.check do |config|
+        config.command 'bundle exec rubocop -a -D -c .rubocop.yml'
+        config.files ['app/**/*.rb', 'spec/**/*.rb']
+      end
+    end
+
+    def slim_lint(bin_check)
+      bin_check.check do |config|
+        config.command 'bundle exec slim-lint app/views/ -c .slim-lint.yml'
+        config.files ['app/views/**/*.slim']
+      end
+    end
+
+    def scss_lint(bin_check)
+      bin_check.check do |config|
+        config.command 'scss-lint app/assets/stylesheets/**/*.scss'
+        config.files ['app/assets/stylesheets/**/*.scss']
+      end
+    end
+
+    def tslint(bin_check)
+      bin_check.check do |config|
+        config.command 'tslint -c tslint.json app/assets/javascripts/**/*.ts'
+        config.files ['app/assets/javascripts/**/*.ts']
+      end
+    end
+
+    def coffeelint(bin_check)
+      bin_check.check do |config|
+        config.command 'coffeelint -f .coffeelint.json app/assets/javascripts/**/*.coffee'
+        config.files ['app/assets/javascripts/**/*.coffee']
+      end
+    end
+
+    def brakeman(bin_check)
+      bin_check.check do |config|
+        config.command 'bundle exec brakeman -q -z --summary > /dev/null'
+      end
+    end
+
+    def reek(bin_check)
+      bin_check.check do |config|
+        config.command 'bundle exec reek'
+        config.files ['app/**/*.rb']
+      end
+    end
+
+    def rspec(bin_check)
+      bin_check.check do |config|
+        config.command 'bundle exec rspec'
+        config.files ['app/**/*.rb', 'spec/**/*.rb']
+      end
+    end
+
+    module_function :rails
+    module_function :mini_profiler
+    module_function :todo
+    module_function :console_log
+    module_function :put_without_brackets
+    module_function :put_with_brackets
+    module_function :pp_and_p
+    module_function :p_with_brackets
+    module_function :rubocop_autocorrect
+    module_function :slim_lint
+    module_function :scss_lint
+    module_function :tslint
+    module_function :coffeelint
+    module_function :brakeman
+    module_function :reek
+    module_function :rspec
+  end
+  # rubocop:enable Metrics/ModuleLength
+end

data/lib/renuo_bin_check/initializer.rb

@@ -0,0 +1,21 @@
+require 'renuo_bin_check/printer'
+
+module RenuoBinCheck
+  class Initializer
+    attr_reader :master_thread
+
+    def initialize
+      @master_thread = MasterThread.new(Printer.new)
+    end
+
+    def check
+      config = ScriptConfig.new
+      yield(config)
+      @master_thread.add_thread(config)
+    end
+
+    def run
+      @master_thread.finalize
+    end
+  end
+end

data/lib/renuo_bin_check/master_thread.rb

@@ -0,0 +1,42 @@
+require 'thwait'
+
+module RenuoBinCheck
+  class MasterThread
+    attr_reader :threads, :printer
+
+    def initialize(printer)
+      @threads = []
+      @results = []
+      @printer = printer
+    end
+
+    def add_thread(script_config)
+      threads << Thread.new do
+        servant = ServantThread.new(script_config)
+        Thread.current[:result] = servant.run
+      end
+    end
+
+    def finalize
+      waiter = ThreadsWait.new(threads)
+      until waiter.empty?
+        result = waiter.next_wait[:result]
+        @results << result
+        exit_with_error(result) if result.exit_code == 1
+      end
+      exit_with_success
+    end
+
+    private
+
+    def exit_with_error(result)
+      @printer.print_error_output(result)
+      exit 1
+    end
+
+    def exit_with_success
+      @printer.print_standard_output(@results)
+      exit 0
+    end
+  end
+end

data/lib/renuo_bin_check/printer.rb

@@ -0,0 +1,15 @@
+module RenuoBinCheck
+  class Printer
+    # :reek:UtilityFunction
+    def print_standard_output(results)
+      results.each { |result| $stdout.puts result.standard_output }
+    end
+
+    # :reek:UtilityFunction
+    def print_error_output(result)
+      error_output = result.error_output
+      error_output = result.standard_output if error_output == ''
+      $stderr.puts error_output
+    end
+  end
+end

data/lib/renuo_bin_check/result.rb

@@ -0,0 +1,10 @@
+module RenuoBinCheck
+  class Result
+    attr_reader :standard_output, :error_output, :exit_code
+    def initialize(standard_output, error_output, exit_code)
+      @standard_output = standard_output
+      @error_output = error_output
+      @exit_code = exit_code
+    end
+  end
+end

data/lib/renuo_bin_check/script_config.rb

@@ -0,0 +1,61 @@
+module RenuoBinCheck
+  # :reek:TooManyInstanceVariables:
+  class ScriptConfig
+    attr_accessor :script_command, :script_files, :script_name, :script_reversed_exit, :script_standard_output,
+                  :script_error_output, :appended_standard_output, :appended_error_output
+
+    def command(command)
+      @script_command = command
+    end
+
+    def files(files)
+      @script_files = files
+    end
+
+    def name(name)
+      @script_name = name
+    end
+
+    def success_message(standard_output)
+      if standard_output[0] == '+'
+        @appended_standard_output = standard_output.sub('+', '')
+      else
+        @script_standard_output = standard_output
+      end
+    end
+
+    def error_message(error_output)
+      if error_output[0] == '+'
+        @appended_error_output = error_output.sub('+', '')
+      else
+        @script_error_output = error_output
+      end
+    end
+
+    def reversed_exit(reversed_exit)
+      @script_reversed_exit = reversed_exit
+    end
+
+    def script_name
+      @script_name ||= Digest::MD5.hexdigest(@script_command)
+    end
+
+    def reversed_exit?
+      @script_reversed_exit
+    end
+
+    def appended_standard_output
+      @appended_standard_output ||= ''
+    end
+
+    def appended_error_output
+      @appended_error_output ||= ''
+    end
+
+    def script_command
+      raise 'There must be a command set for each script you want to run. Find further instruction on how to use this' \
+' Gem here in the Readme: https://github.com/renuo/renuo-bin-check' unless @script_command
+      @script_command
+    end
+  end
+end

data/lib/renuo_bin_check/servant_thread.rb

@@ -0,0 +1,43 @@
+require 'open3'
+require 'renuo_bin_check/result'
+
+module RenuoBinCheck
+  class ServantThread
+    attr_reader :script_config
+    def initialize(script_config)
+      @script_config = script_config
+      script_files = @script_config.script_files
+      @cacher = Cacher.new(@script_config.script_name, script_files) if script_files
+    end
+
+    def run
+      @script_config.script_files ? run_with_cache : run_command
+    end
+
+    private
+
+    def run_with_cache
+      @cacher.cache(run_command) unless @cacher.exists?
+      @cacher.result
+    end
+
+    def run_command
+      standard_output, error_output, process = Open3.capture3(@script_config.script_command)
+      @result = Result.new(standard_output, error_output, process.exitstatus)
+      override_output
+      @script_config.reversed_exit? ? reverse_result : @result
+    end
+
+    def override_output
+      standard_output = @script_config.script_standard_output ||= @result.standard_output
+      error_output = @script_config.script_error_output ||= @result.error_output
+      @result = Result.new(standard_output + @script_config.appended_standard_output,
+                           error_output + @script_config.appended_error_output,
+                           @result.exit_code)
+    end
+
+    def reverse_result
+      Result.new(@result.error_output, @result.standard_output, @result.exit_code == 0 ? 1 : 0)
+    end
+  end
+end