copperizer 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d35006a3b16af2bd681628f90a690c062ed50fa7
+  data.tar.gz: c846bbcda43c3e9283362cb1f91a0616d59b1ea4
+SHA512:
+  metadata.gz: 24a4afad60afa535c4d1c9ad701346a9b0cbc220d931b7d29a2d529fca81733d71bb0bf57c61a2881216bfa2c702e9472555c66c6f8dfc00761adba236d6afcc
+  data.tar.gz: 916aa58d7bffaff2a2639629d268cfaf106b38dd2b33e0805f7c6a6d5527ae37b8a90e7f0b696c53c56c9a41f5bceb9002b2c8059a755c8482c32ec10f11f2c7

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org/'
+
+# Declare your gem's dependencies in lhc.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    copperizer (3.1.0)
+      lhc
+      railties
+      rubocop (= 0.36)
+      rubocop-rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.5.1)
+      actionview (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.1)
+      activesupport (= 4.2.5.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.5.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.2.0)
+    builder (3.2.2)
+    erubis (2.7.0)
+    ethon (0.8.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    i18n (0.7.0)
+    json (1.8.3)
+    lhc (3.4.0)
+      activesupport (~> 4.1)
+      typhoeus
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    parser (2.3.0.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.1)
+      actionpack (= 4.2.5.1)
+      activesupport (= 4.2.5.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rubocop (0.36.0)
+      parser (>= 2.3.0.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+    rubocop-rspec (1.3.1)
+    ruby-progressbar (1.7.5)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    typhoeus (1.0.1)
+      ethon (>= 0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  copperizer!
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,63 @@
+- Simplifies performing static code analysis for ruby
+- Creates line-based violation reports on Github
+
+![Copperizer](example.png)
+
+Setup
+=====
+
+  1. Add the following to `Gemfile`:
+    ```
+      gem 'copperizer'
+    ```
+
+  2. Generate configuration files:
+    ```
+      bundle exec rails generate copperizer:config
+    ```
+    This will create two files:
+      - `.rubocop.localch.yml` - with master configuration
+      - `.rubocop.yml` - for your specific tweaks per project
+
+      Keep in mind that `.rubocop.localch.yml` will always be overwritten and should never be modified.
+
+  3. If needed, tweak the configuration in `.rubocop.yml`
+
+  4. You're good to go
+
+Use Rubocop
+=====
+
+After configuration is generated you can run `rubocop`.
+
+Useful options:
+  - `rubocop --format offenses`
+
+     This will generate a list of offenses sorted by number of occurrences - useful for tweaking configuration
+
+  - `rubocop --auto-gen-config`
+
+    Generates `.rubocop_todo.yml` with a configuration that disables all offended cops. This way you can enable & fix them step by step.
+
+    If you want to use this approach remember to add `rubocop_todo.yml` to `inherit_from` list in the configuration
+
+  - `rubocop --auto-correct`
+
+   Tries to automatically fix some of the offenses. Might be a good starting point for fixing code style. Use with caution as it's marked as experimental.
+
+Run checkstyle
+========
+
+  Simply run the following rake task:
+
+  ```
+    GIT_REPOSITORY=https://github.com/local-ch/copperizer GITHUB_TOKEN=your_github_token rake checkstyle
+  ```
+
+  Exit code determines if static code analysis was successful or if any violations was found.
+
+  The `GIT_REPOSITORY` takes the link to the Github repo.
+
+  You can define the `RESULT_PATH` (e.g. RESULT_PATH='tmp/checkstyle.json') to define where violation reports are stored.
+
+  The `GITHUB_TOKEN` is required to make line-based violation comments on Github.

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/copperizer.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "copperizer/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'copperizer'
+  s.version     = Copperizer::VERSION
+  s.authors     = 'https://github.com/local-ch/copperizer/graphs/contributors'
+  s.email       = ['ws-operations@local.ch']
+  s.homepage    = 'https://github.com/local-ch/copperizer'
+  s.description = "Simplifies performing static code analysis and creates line-based violation reports on Github."
+  s.summary     = s.description
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.requirements << 'Ruby >= 1.9.2'
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_dependency 'rubocop', '= 0.36'
+  s.add_dependency 'rubocop-rspec'
+  s.add_dependency 'lhc'
+  s.add_dependency 'railties'
+end

data/lib/checkstyle/file_reviewer.rb

@@ -0,0 +1,126 @@
+require 'json'
+
+module Checkstyle
+  class FileReviewer
+
+    HEADERS = { 'Authorization' => "token #{ENV['GITHUB_TOKEN']}" }
+
+    RUBOCOP_QUOTES = [
+      "> - Robo, excuse me, Robo. Any special message for all the kids watching at home?\n> - Stay out of trouble.",
+      '> Four... three... two... one... I am now authorized to use physical force!',
+      '> Thank you for your co-operation. Good night.',
+      '> Serve the public trust. Protect the innocent. Uphold the law.',
+      '> Your move, creep.',
+      '> Come quietly or there will be trouble.',
+      '> You are under arrest.',
+      "> Dead or alive, you're coming with me!",
+      '> Oooh, guns guns guns!',
+      '> Excuse me, I have to go. Somewhere there is a crime happening.'
+    ]
+
+    attr_reader :file_path, :repository, :violations
+
+    def initialize(repository, file_path, violations)
+      @file_path = file_path
+      @violations = violations
+      @repository = repository
+    end
+
+    def review
+      log "Reviewing file #{file_path}"
+
+      violations.each { |violation| comment_violation(violation) }
+    end
+
+    private
+
+    def line_for_violation(patch, violation)
+      violating_line = violation['location']['line']
+      meta, *patch_lines = patch.split("\n")
+
+      start = meta.match(/\+(\d+)/)[1].to_i
+      patch_index = 0
+
+      patch_lines.each_with_index do |content, patch_position|
+        next if content.first == '-'
+
+        line_number = start + patch_index
+        return { number: line_number, patch_position: patch_position + 1, content: content } if line_number == violating_line
+
+        patch_index += 1
+      end
+
+      {}
+    end
+
+    def comment_violation(violation)
+      commit_sha = violating_commit_sha(violation)
+      commit = get("#{commit_url(commit_sha)}?v=3", cache: true).data
+
+      file_object = commit.files.find { |f| f.filename == file_path }
+      line = line_for_violation(file_object.patch, violation)
+
+      comment_on_line(file_object, line[:number], line[:patch_position], violation, commit)
+    end
+
+    # Gets SHA of the commit where line was last changed
+    def violating_commit_sha(violation)
+      line = violation['location']['line']
+      `git log --format="%H" -1 -L #{line},#{line}:#{file_path} | head -n 1`.strip
+    end
+
+    def commit_url(sha)
+      "https://api.github.com/repos/#{repository}/commits/#{sha}"
+    end
+
+    def already_commented?(file, line_number, violation, commit)
+      comments = get(commit.comments_url).data
+      comments.any? do |comment|
+        comment.body.scan(comment_signature(file, line_number, violation)).any?
+      end
+    end
+
+    def comment_on_line(file, line_number, patch_position, violation, commit)
+      if already_commented?(file, line_number, violation, commit)
+        log "\tI already commented on this"
+        return
+      end
+
+      body = {
+        body: line_comment(file, line_number, violation),
+        path: file.filename,
+        position: patch_position
+      }
+      LHC.post(commit.comments_url, headers: HEADERS, body: body.to_json)
+      log "\tfile change commented on Github"
+    rescue LHC::Error
+      log "\tencountered problems while trying to post comment file change on Github"
+    end
+
+    def comment_signature(file, line_number, violation)
+      "*#{file.filename}:#{line_number} #{violation['cop_name']}*"
+    end
+
+    def get(url, options = {})
+      LHC.get(url, options.reverse_merge(headers: HEADERS))
+    end
+
+    def line_comment(file, line_number, violation)
+      return line_comment_with_quote(file, line_number, violation) if rand > 0.6
+
+      plain_line_comment(file, line_number, violation)
+    end
+
+    def line_comment_with_quote(file, line_number, violation)
+      "#{plain_line_comment(file, line_number, violation)}\n\n#{RUBOCOP_QUOTES.sample}"
+    end
+
+    def plain_line_comment(file, line_number, violation)
+      "**[#{violation['severity']}]** #{violation['message']}\n#{comment_signature(file, line_number, violation)}"
+    end
+
+    def log(text)
+      puts "[CHECKSTYLE][Review file] #{text}"
+    end
+  end
+end

data/lib/checkstyle/reviewer.rb

@@ -0,0 +1,37 @@
+require_relative './file_reviewer.rb'
+
+module Checkstyle
+  class Reviewer
+
+    attr_reader :repository, :report_file_path, :syntax_violation_report
+
+    def initialize(repository, report_file_path)
+      @report_file_path = report_file_path
+      @syntax_violation_report = JSON.parse(File.open(report_file_path).read).fetch('files', [])
+      @repository = repository
+    end
+
+    def review
+      log "Reviewing based on #{report_file_path}"
+
+      syntax_violation_report.each do |file_report|
+        next if file_report.fetch('offenses', []).empty?
+
+        review_file(file_report)
+      end
+    end
+
+    private
+
+    def review_file(file_report)
+      path = file_report.fetch('path', "")
+      violations = file_report.fetch('offenses', [])
+
+      FileReviewer.new(repository, path, violations).review
+    end
+
+    def log(text)
+      puts "[CHECKSTYLE][Review] #{text}"
+    end
+  end
+end

data/lib/copperizer.rb

@@ -0,0 +1,11 @@
+require 'checkstyle/reviewer'
+
+module Checkstyle
+  class Railtie < Rails::Railtie
+    railtie_name :checkstyle
+
+    rake_tasks do
+      load 'tasks/checkstyle.rake'
+    end
+  end
+end

data/lib/copperizer/version.rb

@@ -0,0 +1,3 @@
+module Copperizer
+  VERSION = '3.1.0'
+end

data/lib/generators/ruby_static_code_analysis/config_generator.rb

@@ -0,0 +1,19 @@
+module Copperizer
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc <<DESC
+Description:
+  Copies master configuration file to your project root directory as `rubocop.local.yml`.
+  Creates project specific settings in `rubocop.yml` that inherit from master congig.
+DESC
+
+    def master_config
+      copy_file 'rubocop.localch.yml', '.rubocop.localch.yml', force: true
+    end
+
+    def project_config
+      copy_file 'rubocop.yml', '.rubocop.yml'
+    end
+  end
+end

data/lib/generators/ruby_static_code_analysis/templates/rubocop.localch.yml

@@ -0,0 +1,190 @@
+# This is master rubocop configuration.
+# DO NOT EDIT THIS FILE - it WILL be overwriten on every config update
+AllCops:
+  TargetRubyVersion: 2.1
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+    - '**/Capfile'
+  Exclude:
+    - 'db/**/*'
+    - 'script/**/*'
+    - 'vendor/bundle/**/*'
+    - 'bin/**/*'
+    - 'config/unicorn.rb'
+    - 'config/compass.rb'
+    - 'Rakefile'
+
+Rails:
+  Enabled: true
+
+require:
+  - rubocop-rspec
+
+Lint/HandleExceptions:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Performance/StringReplacement:
+  Enabled: false
+
+Performance/TimesMap:
+  Enabled: false
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Performance/RedundantMatch:
+  Enabled: false
+
+Performance/RedundantMerge:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Exclude:
+    - spec/**/*
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/UnneededCapitalW:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Exclude:
+    - spec/support/pages/**/*
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/views/**/*
+    - spec/routing/**/*
+    - spec/requests/**/*
+    - spec/features/**/*
+
+RSpec/FilePath:
+  Enabled: false
+
+Rails/Output:
+  Exclude:
+    - 'config/application.rb'
+    - 'config/initializers/asset_manifest_warning.rb'

data/lib/generators/ruby_static_code_analysis/templates/rubocop.yml

@@ -0,0 +1,4 @@
+# This is project specific rubocop configuration file.
+# You can tweak project settings here
+inherit_from:
+  - ./.rubocop.localch.yml

data/lib/tasks/checkstyle.rake

@@ -0,0 +1,13 @@
+task :checkstyle do
+  puts "[CHECKSTYLE] start task"
+  begin
+    Checkstyle::Reviewer.new(
+      ENV['GIT_REPOSITORY'],
+      ENV['RESULT_PATH'] || 'tmp/checkstyle.json'
+    ).review
+  rescue => e
+    puts "[CHECKSTYLE][ERROR] #{e}"
+    puts e.backtrace
+    exit 1
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: copperizer
+version: !ruby/object:Gem::Version
+  version: 3.1.0
+platform: ruby
+authors:
+- https://github.com/local-ch/copperizer/graphs/contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.36'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: lhc
+  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: railties
+  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'
+description: Simplifies performing static code analysis and creates line-based violation
+  reports on Github.
+email:
+- ws-operations@local.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- copperizer.gemspec
+- example.png
+- lib/checkstyle/file_reviewer.rb
+- lib/checkstyle/reviewer.rb
+- lib/copperizer.rb
+- lib/copperizer/version.rb
+- lib/generators/ruby_static_code_analysis/config_generator.rb
+- lib/generators/ruby_static_code_analysis/templates/rubocop.localch.yml
+- lib/generators/ruby_static_code_analysis/templates/rubocop.yml
+- lib/tasks/checkstyle.rake
+homepage: https://github.com/local-ch/copperizer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Ruby >= 1.9.2
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simplifies performing static code analysis and creates line-based violation
+  reports on Github.
+test_files: []