bleach 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d495ae25dc8b22b7f30ff8e9ccaac5267a1c435bef32903f53ae53d0b3b25da
+  data.tar.gz: 104bec8e24cf10dd466238c6c193a4ad9de47116c9d166ef217ac4042ef549c9
+SHA512:
+  metadata.gz: 2237b13fcec791ac257681a9f5144dc47178bb2f79baa5ce010d0e29b05d4a08d650fbebc855a3a7c9d8d1c3337af2f743438af477ffe4e113ac9ce30cfb12a0
+  data.tar.gz: 3fa27adb09c3d254af71ff040b5d8f8dbd311ef39f22272099da4b30e12c263f3d9c5649f10dae81f93f3a3a7977face32adf100deedc69000f177e7bd938d0f

data/bin/bleach

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Discover lib files to be included
+Dir.glob("#{__dir__}/../lib/**/*.rb").each do |lib_file|
+  require File.expand_path(lib_file, __dir__)
+end
+
+require 'linguist'
+require 'optparse'
+require 'tmpdir'
+require 'json'
+require 'fileutils'
+require 'isna'
+
+# OPTIONS BLOCK
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [OPTIONS]"
+  f_description = 'Filepath of the file that needs to be checked.'
+  opts.on('-f', '--file [STRING]', f_description) do |value|
+    options[:file] = value
+  end
+  i_description = 'Install Git commit hook'
+  opts.on('-i', '--install', i_description) do |value|
+    options[:install] = value
+  end
+end.parse!
+
+if options[:install]
+  if system('install-bleach-git-hooks')
+    exit 0
+  else
+    warn 'Git hook installation failed.'
+    exit 1
+  end
+end
+
+required_options = [:file]
+required_options.each do |option|
+  unless options[option]
+    warn "Cannot run, '--#{option}' was not given."
+    exit 1
+  end
+end
+unless File.exist?(options[:file])
+  warn "File to check not found: '#{options[:file]}'"
+  exit 1
+end
+
+# LANGUAGE BLOCK
+file_language = Linguist::FileBlob.new(options[:file]).language.to_s
+
+LANGUAGE_MAP = {
+  'Ruby' => 'ruby',
+  'JavaScript' => 'javascript'
+}.freeze
+
+if LANGUAGE_MAP.keys.include?(file_language)
+  tool_dir = "#{__dir__ }/../lib/command/code_check/#{file_language.downcase}"
+  unless File.directory?(tool_dir)
+    warn "No tools found for language: '#{file_language}'"
+    exit 0
+  end
+  puts "Found supported language: #{file_language}"
+else
+  warn "Language not supported: #{file_language}"
+  exit 0
+end
+
+# PRINT BANNER FUNCTION
+def print_banner(tool, file)
+  template = '# [%s]: Running checks with tool: %s'
+  bindings = []
+  bindings.push(Time.now)
+  bindings.push(tool.to_ansi.yellow.to_s)
+  banner = (template % bindings).to_ansi.cyan.to_s
+  ruler = ('# ' + ('-' * 78)).to_ansi.cyan.to_s
+  file_detail = ('# target: ' + file).to_ansi.cyan.to_s
+  puts ''
+  puts banner
+  puts file_detail
+  puts ruler
+end
+
+# MAIN CHECK LOOP
+Dir.glob("#{__dir__}/../languages/#{LANGUAGE_MAP[file_language]}/*").each do |tool_directory|
+  config_file = "#{tool_directory}/config.json"
+  config = JSON.parse(File.read(config_file))
+  tool = File.basename(tool_directory)
+
+  print_banner(tool, options[:file])
+
+  # Work is done on copies of the original files inside a temp dir
+  Dir.mktmpdir do |tmpdir|
+    config['requiredFiles'].each do |required_file|
+      unless File.exist?(required_file['file'])
+        warn "#{tool} checks need a '#{required_file['file']}' file present to run."
+        warn 'Check will be stopped.'
+        exit 1
+      end
+      FileUtils.cp(required_file['file'], tmpdir)
+    end
+
+    FileUtils.cp(options[:file], tmpdir)
+    FileUtils.cp(config_file, tmpdir)
+    file_copy = File.basename(options[:file])
+
+    # Verify if Docker image exists
+    inspect_command = DockerCommand::DockerImageInspect.new(tag: tool)
+    unless inspect_command.system
+      # Otherwise, build Docker image for tool
+      puts "Building container image for #{tool}."
+      build_command = DockerCommand::DockerBuild.new(
+        tag: tool,
+        dockerfile_dir: tool_directory
+      )
+      exit 1 unless build_command.system
+    end
+
+    tool_command = Command::CheckFile.new(
+      tool_directory: tool_directory,
+      tmpdir: tmpdir,
+      file_copy: file_copy
+    )
+
+    unless tool_command.system
+      warn 'Source file did not pass some checks.'
+      warn 'No more checks will be run.'
+      exit 1
+    end
+  end
+end

data/bin/install-bleach-git-hooks

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'fileutils'
+
+if File.exist?("#{Dir.pwd}/.git") && File.directory?("#{Dir.pwd}/.git")
+  # 'Found .git directory'
+  if File.exist?("#{Dir.pwd}/.git/hooks/pre-commit")
+    # 'Found pre-commit file'
+    if File.exist?("#{Dir.pwd}/.git/hooks/pre-commit.bleach-backup")
+      warn 'Git pre-commit hook backup found in "/.git/hooks/pre-commit.bleach-backup".'
+      warn 'Will stop installation.'
+      exit 1
+    else
+      # 'No backup found. Making one.'
+      FileUtils.cp("#{Dir.pwd}/.git/hooks/pre-commit",
+        "#{Dir.pwd}/.git/hooks/pre-commit.bleach-backup")
+      # 'Copying file'
+      FileUtils.cp("#{__dir__}/../script/pre-commit",
+        "#{Dir.pwd}/.git/hooks/pre-commit")
+      FileUtils.chmod(0755,"#{Dir.pwd}/.git/hooks/pre-commit")
+      puts 'Successfuly installed Git pre-commit hook in "/.git/hooks/pre-commit".'
+      puts 'I made a backup of your previous one in "/.git/hooks/pre-commit.bleach-backup".'
+    end
+  else
+    # 'No file found. Copying.'
+    FileUtils.cp("#{__dir__}/../script/pre-commit",
+      "#{Dir.pwd}/.git/hooks/pre-commit")
+    FileUtils.chmod(0755,"#{Dir.pwd}/.git/hooks/pre-commit")
+    puts 'Successfuly installed Git pre-commit hook in "/.git/hooks/pre-commit".'
+  end
+else
+  warn '".git" directory not found. Is this a Git repository?'
+  exit 1
+end

data/languages/javascript/eslint/Dockerfile

@@ -0,0 +1,7 @@
+FROM alpine:3.12.4
+RUN apk update
+RUN apk add npm bash
+RUN npm install -g n
+RUN n stable
+RUN PATH=$PATH
+RUN npm install -g eslint

data/languages/javascript/eslint/check-file

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Discover lib files to be included
+Dir.glob("#{__dir__}/../../../lib/**/*.rb").each do |lib_file|
+  require File.expand_path(lib_file, __dir__)
+end
+
+require 'optparse'
+require 'json'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS]"
+
+  opts.on('-f', '--file [STRING]', 'File.') do |value|
+    options[:file] = value
+  end
+end.parse!
+
+required_options = [:file]
+required_options.each do |option|
+  unless options[option]
+    warn "Can not run #{option} was not given."
+    exit 1
+  end
+end
+
+file = File.basename(options[:file])
+dir = File.dirname(options[:file])
+
+config_file = "#{dir}/config.json"
+config = JSON.parse(File.read(config_file))
+
+image_name = config['imageName']
+tool_config = config['requiredFiles'].find do |record|
+  record['type'] == 'ESLint Config'
+end['file']
+
+check_command = CodeCheck::ESLint.new(
+  pwd: dir,
+  image_name: image_name,
+  config_file: tool_config,
+  source_files: "/code/#{file}"
+)
+exit 1 unless check_command.system

data/languages/javascript/eslint/config.json

@@ -0,0 +1,9 @@
+{
+    "imageName" : "bleach/eslint",
+    "requiredFiles" : [
+        {
+            "type" : "ESLint Config",
+            "file" : ".eslintrc.json"
+        }
+    ]
+}

data/languages/javascript/jshint/Dockerfile

@@ -0,0 +1,4 @@
+FROM alpine:3.12.4
+RUN apk update
+RUN apk add npm
+RUN npm install -g jshint

data/languages/javascript/jshint/check-file

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Discover lib files to be included
+Dir.glob("#{__dir__}/../../../lib/**/*.rb").each do |lib_file|
+  require File.expand_path(lib_file, __dir__)
+end
+
+require 'optparse'
+require 'json'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS]"
+
+  opts.on('-f', '--file [STRING]', 'File.') do |value|
+    options[:file] = value
+  end
+end.parse!
+
+required_options = [:file]
+required_options.each do |option|
+  unless options[option]
+    warn "Can not run #{option} was not given."
+    exit 1
+  end
+end
+
+file = File.basename(options[:file])
+dir = File.dirname(options[:file])
+
+config_file = "#{dir}/config.json"
+config = JSON.parse(File.read(config_file))
+
+image_name = config['imageName']
+tool_config = config['requiredFiles'].find do |record|
+  record['type'] == 'JSHint Config'
+end['file']
+
+check_command = CodeCheck::JSHint.new(
+  pwd: dir,
+  image_name: image_name,
+  config_file: tool_config,
+  source_files: "/code/#{file}"
+)
+exit 1 unless check_command.system

data/languages/javascript/jshint/config.json

@@ -0,0 +1,9 @@
+{
+    "imageName" : "bleach/jshint",
+    "requiredFiles" : [
+        {
+            "type" : "JSHint Config",
+            "file" : ".jshintrc"
+        }
+    ]
+}

data/languages/ruby/brakeman/Dockerfile

@@ -0,0 +1 @@
+FROM presidentbeef/brakeman

data/languages/ruby/brakeman/check-file

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Discover lib files to be included
+Dir.glob("#{__dir__}/../../../lib/**/*.rb").each do |lib_file|
+  require File.expand_path(lib_file, __dir__)
+end
+
+require 'optparse'
+require 'json'
+require 'isna'
+
+def print_brakeman_results(file, target, color)
+  data = File.read(file)
+  hash = JSON.parse(data)
+  hash[target].each do |warning|
+    puts ''
+    puts ''
+    warning.each do |key, value|
+      if value.is_a?(Hash)
+        puts "#{key.rjust(20, ' ').to_ansi.send(color).to_s}: #{value.inspect}"
+        next
+      end
+      if value.is_a?(Array)
+        puts "#{key.rjust(20, ' ').to_ansi.send(color).to_s}: #{value.inspect}"
+        next
+      end
+      puts "#{key.rjust(20, ' ').to_ansi.send(color).to_s}: #{value}"
+    end
+  end
+  return hash[target].empty?
+end
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS]"
+
+  opts.on('-f', '--file [STRING]', 'File.') do |value|
+    options[:file] = value
+  end
+end.parse!
+
+required_options = [:file]
+required_options.each do |option|
+  unless options[option]
+    warn "Can not run #{option} was not given."
+    exit 1
+  end
+end
+
+file = File.basename(options[:file])
+dir = File.dirname(options[:file])
+
+config_file = "#{dir}/config.json"
+config = JSON.parse(File.read(config_file))
+
+image_name = config['imageName']
+tool_config = config['requiredFiles'].find do |record|
+  record['type'] == 'Brakeman Config'
+end['file']
+
+check_command = CodeCheck::Brakeman.new(
+  pwd: dir,
+  image_name: image_name,
+  config_file: tool_config,
+  source_files: "#{file}"
+)
+check_command.system
+
+exit 1 unless print_brakeman_results("#{dir}/report.json", 'errors', :red)
+if print_brakeman_results("#{dir}/report.json", 'warnings', :yellow)
+  puts 'No warnings or errors found.'
+end

data/languages/ruby/brakeman/config.json

@@ -0,0 +1,13 @@
+{
+    "imageName" : "bleach/brakeman",
+    "requiredFiles" : [
+        {
+            "type" : "Brakeman Config",
+            "file" : "brakeman.yml"
+        },
+        {
+            "type" : "Gemfile",
+            "file" : "Gemfile.lock"
+        }
+    ]
+}

data/languages/ruby/rubocop/Dockerfile

@@ -0,0 +1,6 @@
+FROM alpine:3.12.4
+RUN apk update
+RUN apk add build-base make ruby-full ruby-dev
+RUN gem install rubocop -v 0.73.0
+RUN gem install rubocop-gitlab-security -v 0.1.1
+

data/languages/ruby/rubocop/check-file

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Discover lib files to be included
+Dir.glob("#{__dir__}/../../../lib/**/*.rb").each do |lib_file|
+  require File.expand_path(lib_file, __dir__)
+end
+
+require 'optparse'
+require 'json'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [OPTIONS]"
+
+  opts.on('-f', '--file [STRING]', 'File.') do |value|
+    options[:file] = value
+  end
+end.parse!
+
+required_options = [:file]
+required_options.each do |option|
+  unless options[option]
+    warn "Can not run #{option} was not given."
+    exit 1
+  end
+end
+
+file = File.basename(options[:file])
+dir = File.dirname(options[:file])
+
+config_file = "#{dir}/config.json"
+config = JSON.parse(File.read(config_file))
+
+image_name = config['imageName']
+tool_config = config['requiredFiles'].find do |record|
+  record['type'] == 'Rubocop Config'
+end['file']
+
+check_command = CodeCheck::Rubocop.new(
+  pwd: dir,
+  image_name: image_name,
+  config_file: tool_config,
+  source_files: "/code/#{file}"
+)
+exit 1 unless check_command.system

data/languages/ruby/rubocop/config.json

@@ -0,0 +1,13 @@
+{
+    "imageName" : "bleach/rubocop",
+    "requiredFiles" : [
+        {
+            "type" : "Rubocop Config",
+            "file" : ".rubocop.yml"
+        },
+        {
+            "type" : "Ruby Version",
+            "file" : ".ruby-version"
+        }
+    ]
+}

data/lib/command/check_file.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module Command
+  # Template for check-file command
+  class CheckFile < AbstractCommand
+    def template
+      '%<tool_directory>s/check-file ' \
+      '--file %<tmpdir>s/%<file_copy>s'
+    end
+  end
+end

data/lib/command/code_check/javascript/eslint.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module CodeCheck
+  # Template for ESLint check
+  class ESLint < AbstractCommand
+    def template
+      'docker run ' \
+        '--rm ' \
+        '--volume %<pwd>s:/code ' \
+        '%<image_name>s ' \
+        'eslint ' \
+        '--config /code/%<config_file>s ' \
+        '--color ' \
+        '%<source_files>s'
+    end
+  end
+end

data/lib/command/code_check/javascript/jshint.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module CodeCheck
+  # Template for JSHint check
+  class JSHint < AbstractCommand
+    def template
+      'docker run ' \
+        '--rm ' \
+        '--volume %<pwd>s:/code ' \
+        '%<image_name>s ' \
+        'jshint ' \
+        '--config /code/%<config_file>s ' \
+        '%<source_files>s'
+    end
+  end
+end

data/lib/command/code_check/ruby/brakeman.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module CodeCheck
+  # Template for Brakeman check
+  class Brakeman < AbstractCommand
+    def template
+      'docker run ' \
+      '--rm ' \
+      '--volume %<pwd>s:/code ' \
+      '%<image_name>s ' \
+      '--config-file /code/%<config_file>s ' \
+      '--force-scan ' \
+      '--quiet ' \
+      '--output report.json ' \
+      '--only-files ' \
+      '%<source_files>s'
+    end
+  end
+end

data/lib/command/code_check/ruby/rubocop.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+module CodeCheck
+  # Template for Rubocop check
+  class Rubocop < AbstractCommand
+    def template
+      'docker run ' \
+        '--rm ' \
+        '--volume %<pwd>s:/code ' \
+        '%<image_name>s ' \
+        'rubocop ' \
+        '--display-style-guide ' \
+        '--extra-details ' \
+        '--color ' \
+        '--config /code/%<config_file>s ' \
+        '%<source_files>s'
+    end
+  end
+end

data/lib/command/docker_build.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'abstract_command'
+
+module DockerCommand
+  # Template for 'docker build' command
+  class DockerBuild < AbstractCommand
+    def template
+      'docker build ' +
+        # '--no-cache ' +
+        '--quiet ' \
+        '--tag bleach/' + '%<tag>s ' \
+        '%<dockerfile_dir>s >/dev/null'
+    end
+  end
+end

data/lib/command/docker_image_inspect.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'abstract_command'
+
+module DockerCommand
+  # Template for 'docker image inspect' command
+  class DockerImageInspect < AbstractCommand
+    def template
+      'docker image inspect ' \
+        'bleach/' + '%<tag>s' + ' >/dev/null 2>&1'
+      # We don't care about output, we just want to know if image exists
+    end
+  end
+end

data/lib/command/docker_remove_image.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'abstract_command'
+
+module DockerCommand
+  # Template for 'docker rmi' command
+  class DockerRemoveImage < AbstractCommand
+    def template
+      'docker rmi ' \
+        '--force ' \
+        'bleach/' + '%<tag>s'
+    end
+  end
+end

data/lib/docker_command.rb

@@ -0,0 +1,2 @@
+module DockerCommand
+end

data/script/pre-commit

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'abstract_command'
+
+module Command
+  # Template for Git 'diff-index' command
+  class GitDiffIndex < AbstractCommand
+    def template
+      'git diff-index --name-only --diff-filter=ACMR HEAD'
+    end
+  end
+  # Template for 'bleach' command
+  class Bleach < AbstractCommand
+    def template
+      'bleach -f %<filename>s'
+    end
+  end
+end
+
+Command::GitDiffIndex.new.backtick.each_line.map do |file|
+  exit 1 unless Command::Bleach.new(filename: file.chomp).system
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: bleach
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Luis Flores
+- Kazuyoshi Tlacaelel
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: abstract_command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.13'
+- !ruby/object:Gem::Dependency
+  name: isna
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+description:
+email:
+executables:
+- bleach
+- install-bleach-git-hooks
+extensions: []
+extra_rdoc_files: []
+files:
+- "./bin/bleach"
+- "./bin/install-bleach-git-hooks"
+- "./languages/javascript/eslint/Dockerfile"
+- "./languages/javascript/eslint/check-file"
+- "./languages/javascript/eslint/config.json"
+- "./languages/javascript/jshint/Dockerfile"
+- "./languages/javascript/jshint/check-file"
+- "./languages/javascript/jshint/config.json"
+- "./languages/ruby/brakeman/Dockerfile"
+- "./languages/ruby/brakeman/check-file"
+- "./languages/ruby/brakeman/config.json"
+- "./languages/ruby/rubocop/Dockerfile"
+- "./languages/ruby/rubocop/check-file"
+- "./languages/ruby/rubocop/config.json"
+- "./lib/command/check_file.rb"
+- "./lib/command/code_check/javascript/eslint.rb"
+- "./lib/command/code_check/javascript/jshint.rb"
+- "./lib/command/code_check/ruby/brakeman.rb"
+- "./lib/command/code_check/ruby/rubocop.rb"
+- "./lib/command/docker_build.rb"
+- "./lib/command/docker_image_inspect.rb"
+- "./lib/command/docker_remove_image.rb"
+- "./lib/docker_command.rb"
+- "./script/pre-commit"
+- bin/bleach
+- bin/install-bleach-git-hooks
+homepage: https://github.com/freshout-dev/bleach
+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.1.2
+signing_key:
+specification_version: 4
+summary: bleach - code check tool
+test_files: []