sanelint 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc85ea74de47b387775f34e827e9c11d25eb5594
-  data.tar.gz: 69b64a8ade3cef20fa47daf628edc332b62fd60f
+  metadata.gz: 9a3483b9aba844ac10705259db29d175f20a307e
+  data.tar.gz: c5a5146197ca7835117b1daa7803a2db6159c93b
 SHA512:
-  metadata.gz: ffe36a81f8f2b13b89094776b2ee59377585ca3cbd8cc99cfabde9f2547f9f0b65547e9205785b3b8697d8200edfe377e79d2572a6b4fd9ba9cc40f4979f9da1
-  data.tar.gz: e24d1b9cf27160fa63059b03450590afe60d1842c135aac5b6cf981969b62b79355c85817714c2ba3637a986ba0afcac0e12363a2e05f934a76caf0d337791d3
+  metadata.gz: af50341fc86fd10e16571053ed17b212aef4a35c60e357903bdc831120629bd227d7e7d2df77b0157acdbb78d6bba59efcd00b163d5fb53227f898556dd2817b
+  data.tar.gz: 791bc10ece4b1c774c0694eab835ad3974d94ab71a984b266f97ed0fc0261a14859cf1601762e6d181ba578c4483b63bf263c0fde5eaa64587afa5f467a52929

data/.gitignore

@@ -1,17 +1,9 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/README.md

@@ -1,32 +1,58 @@
 # Sanelint
 
-Code lint utility with sane configuration
+This gem encapsulate rubocop config for [Monterail](monterail.com).
 
 ## Installation
 
-```bash
-gem install sanelint
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sanelint'
 ```
 
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanelint
+
 ## Usage
 
-Go to project directory and nd then execute:
+You need to tell RuboCop to load the Sanelint config. There are three ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`:
+
+```yaml
+require: rubocop-cask
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Cask cops together with the standard cops.
+
+### Command line
 
 ```bash
-sanelint
+rubocop --require rubocop-cask
 ```
 
-## About
+### Rake task
 
-sanelint make use of two well known projects:
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-cask'
+end
+```
+
+## Development
 
-- [rails_best_practices](https://github.com/railsbp/rails_best_practices)
-- [brakeman](https://github.com/presidentbeef/brakeman)
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( http://github.com/monterail/sanelint/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sanelint.
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sanelint"
+
+# 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

data/bin/setup

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

data/config/default.yml

@@ -0,0 +1,82 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'config.ru'
+    - 'Rakefile'
+    - 'db/migrate/*'
+    - 'db/schema.rb'
+    - 'config/**/*'
+    - 'bin/*'
+    - 'script/*'
+    # Other common or autogenerated ignores
+    - 'lib/tasks/cucumber.rake'
+    # Project specific ignores goes here
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Exclude:
+    - 'app/controllers/**/*.rb'
+    - 'app/helpers/**/*.rb'
+    - 'app/mailers/**/*.rb'
+
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 150
+
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'features/step_definitions/**/*.rb'

data/lib/rubocop/sanelint/inject.rb

@@ -0,0 +1,23 @@
+module RuboCop
+  module Sanelint
+    # After
+    #   https://github.com/nevir/rubocop-rspec/blob/v1.4.1/lib/rubocop/rspec/inject.rb
+    #   https://github.com/caskroom/rubocop-cask/blob/v0.6.1/lib/rubocop/cask/inject.rb
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      DEFAULT_FILE = File.expand_path(
+        '../../../../config/default.yml', __FILE__
+      )
+
+      def self.defaults!
+        hash = ConfigLoader.send(:load_yaml_configuration, DEFAULT_FILE)
+        config = Config.new(hash, DEFAULT_FILE)
+        puts "configuration from #{DEFAULT_FILE}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, DEFAULT_FILE)
+
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/sanelint/version.rb

@@ -1,3 +1,3 @@
 module Sanelint
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/sanelint.rb

@@ -1,183 +1,6 @@
 require "sanelint/version"
 
-require "tempfile"
-module Sanelint
-  class Linter < Struct.new(:root)
-    def call
-      raise "Not Implemented"
-    end
+require "rubocop"
+require "rubocop/sanelint/inject"
 
-    def lint
-      call
-    end
-
-    def output
-      @output ||= JSON.parse(File.read(output_file))
-    end
-
-    def output_file
-      @output_file ||= Tempfile.new(["sanelint", ".json"]).path
-    end
-  end
-
-  class Entry < Struct.new(:level, :file, :line, :message, :code, :link,
-                            :git_commit, :git_username, :git_date)
-
-    def initialize(attrs = {})
-      super()
-
-      attrs.each {|k,v| send("#{k}=", v) }
-    end
-  end
-end
-
-
-require "brakeman"
-module Sanelint
-  class Brakeman < Linter
-    def call
-      ::Brakeman.run(options)
-
-      ["warnings", "errors"].inject([]) do |list, type|
-        entries = output[type].map do |e|
-          Entry.new(
-            :level      => type,
-            :file       => e["file"],
-            :line       => e["line"],
-            :message    => e["message"],
-            :code       => e["code"],
-            :link       => e["link"]
-          )
-        end
-
-        list + entries
-      end
-    end
-
-
-    def options
-      {
-        :app_path             => root,
-        :print_report         => true,
-        :interprocedural      => true,
-        :summary_only         => true,
-        :output_files         => [output_file]
-      }
-    end
-  end
-end
-
-
-require "rails_best_practices"
-module Sanelint
-  class RailsBestPractices < Linter
-    def call
-      analyzer = ::RailsBestPractices::Analyzer.new(root, options)
-      analyzer.analyze
-      analyzer.output
-
-      output.map {|e| Entry.new(e) }
-    end
-
-    def options
-      {
-        "with-git"      => true,
-        "format"        => "html",
-        "template"      => results_template_path,
-        "output-file"   => output_file
-      }
-    end
-
-    def results_template_path
-      File.expand_path("../sanelint/rails_best_practices/results.html.erb", __FILE__)
-    end
-  end
-end
-
-
-
-module Sanelint
-  class Runner < Struct.new(:root)
-    LINTERS = [
-      Sanelint::RailsBestPractices,
-      Sanelint::Brakeman
-    ]
-
-    def call
-      run_linters
-      fill_missing_info
-      print_report
-      save_report
-    end
-
-    def run_linters
-      @entries = LINTERS.inject([]) do |entries, linter_klazz|
-        linter = linter_klazz.new(root)
-        entries + linter.lint
-      end
-    end
-
-    def fill_missing_info
-      @entries.each do |entry|
-        if info = blame(entry.file, entry.line)
-          entry.git_commit    = info[:commit]
-          entry.git_date      = info[:date]
-          entry.git_username  = info[:user]
-          entry.code          = info[:code]
-        end
-      end
-    end
-
-    def blame(file, line)
-      line = line.to_s.split(',').first
-
-      # taken from rails_best_practices
-      info = `cd #{root} && git blame -L #{line},+1 #{file}`
-      if m = info.strip.match(/^\^?([0-9a-f]+)\s\((.+)\s+(\d{4}-\d{2}-\d{2}).+?\)(.+)$/)
-        {
-          :commit => m[1],
-          :user   => m[2],
-          :date   => m[3],
-          :code   => m[4]
-        }
-      else
-        nil
-      end
-    end
-
-    def git_repo
-      @git_repo ||= `git remote -v`[/github\.com(?:\/|:)(.+\/.+).git/, 1]
-    end
-
-    def print_report
-      long_file = @entries.map {|e| e.file.size + e.line.to_s.size }.max
-
-      puts
-      @entries.each do |entry|
-        puts "%-8s %-15s %-#{long_file+2}s %-40s" % [
-          entry.git_commit,
-          entry.git_username,
-          "#{entry.file}:#{entry.line}",
-          entry.message
-        ]
-      end
-      puts
-    end
-
-    def save_report
-      renderer = ERB.new(report_template)
-      report = renderer.result(binding)
-      File.open(File.join(root, "sanelint.html"), "w") {|f| f.write report }
-      puts "Report saved to sanelint.html"
-    end
-
-    def report_template
-      File.read(File.expand_path("../sanelint/report.html.erb", __FILE__))
-    end
-  end
-
-  def self.run!
-    runner = Runner.new(Dir.pwd)
-    runner.call
-  end
-end
+RuboCop::Sanelint::Inject.defaults!

data/sanelint.gemspec

@@ -6,21 +6,21 @@ require 'sanelint/version'
 Gem::Specification.new do |spec|
   spec.name          = "sanelint"
   spec.version       = Sanelint::VERSION
-  spec.authors       = ["Tymon Tobolski"]
-  spec.email         = ["tymon.tobolski@monterail.com"]
-  spec.summary       = %q{Sane Ruby/Rails linter.}
-  spec.description   = %q{Ruby/Rails linter. Sane stuff only}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ["Michał Simka"]
+  spec.email         = ["michal.simka@monterail.com"]
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.summary       = %q{Gem to encapsulate Monterail's company-wide rubocop setup.}
+  spec.description   = %q{Gem to encapsulate Monterail's company-wide rubocop setup.}
+  spec.homepage      = "https://github.com/monterail/sanelint"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails_best_practices"
-  spec.add_dependency "brakeman"
+  spec.add_runtime_dependency "rubocop", "~> 0.40.0"
+  spec.add_runtime_dependency "rubocop-rspec", "~> 1.5.0"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,93 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: sanelint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Tymon Tobolski
+- Michał Simka
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails_best_practices
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
-  name: brakeman
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Ruby/Rails linter. Sane stuff only
+        version: '10.0'
+description: Gem to encapsulate Monterail's company-wide rubocop setup.
 email:
-- tymon.tobolski@monterail.com
-executables:
-- sanelint
+- michal.simka@monterail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
-- bin/sanelint
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop/sanelint/inject.rb
 - lib/sanelint.rb
-- lib/sanelint/rails_best_practices/results.html.erb
-- lib/sanelint/report.html.erb
 - lib/sanelint/version.rb
 - sanelint.gemspec
-homepage: ''
-licenses:
-- MIT
+homepage: https://github.com/monterail/sanelint
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -95,18 +93,18 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Sane Ruby/Rails linter.
+summary: Gem to encapsulate Monterail's company-wide rubocop setup.
 test_files: []

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Tymon Tobolski
-
-MIT License
-
-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/bin/sanelint

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require "sanelint"
-Sanelint.run!

data/lib/sanelint/rails_best_practices/results.html.erb

@@ -1,13 +0,0 @@
-<%=
-@errors.map do |error|
-  {
-    :level        => "warning",
-    :file         => error.short_filename,
-    :line         => error.line_number,
-    :message      => error.message,
-    :link         => error.url,
-    :git_commit   => error.git_commit,
-    :git_username => error.git_username
-  }
-end.to_json
-%>

data/lib/sanelint/report.html.erb

@@ -1,95 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <meta charset="utf-8">
-  <title><%= File.basename(root) %> Sanelint Report</title>
-
-  <link href='http://fonts.googleapis.com/css?family=Inconsolata' rel='stylesheet' type='text/css'>
-
-  <style>
-    /* Eric Meyer's Reset CSS v2.0 - http://cssreset.com */
-    html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,menu,nav,output,ruby,section,summary,time,mark,audio,video{border:0;font-size:100%;font:inherit;vertical-align:baseline;margin:0;padding:0}article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}body{line-height:1}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:none}table{border-collapse:collapse;border-spacing:0}
-
-    body {
-      font-size: 14px;
-      font-family: 'Inconsolata', monospace;
-
-      width:1200px;
-      margin: 20px auto;
-    }
-
-    table {
-      border-collapse: collapse;
-      border: 0px;
-    }
-
-    tr:nth-child(even) {background: #e4e4e4}
-    tr:nth-child(odd) {background: #f4f4f4}
-
-    td {
-      padding: 15px 10px;
-    }
-    tr.small > td {
-      color: #333;
-      padding: 15px 10px;
-      padding-bottom: 0px;
-    }
-    td.narrow {
-      width:20px;
-    }
-    td.wide {
-      max-width:570px;
-    }
-
-    a {
-      text-decoration: none;
-      color: #f56200;
-    }
-    .code {
-      padding: 5px;
-      border-radius: 3px;
-      background-color: #556;
-      color: #ddd;
-      line-height: 1.5em;
-    }
-
-  </style>
-
-</head>
-<body>
-  <div class="container">
-
-    <table>
-
-      <% @entries.each_with_index do |entry, index| %>
-
-      <tr class="small">
-        <td class="narrow">
-          <%= index + 1 %>
-        </td>
-
-        <td class="wide">
-            <%= entry.git_date %>, <%= entry.git_username %>
-            <br />
-            <% if entry.link %>
-              <a href="<%= entry.link %>"><%= entry.message %></a>
-            <% else %>
-              <%= entry.message %>
-            <% end %>
-        </td>
-
-        <td class="wide">
-          <%= entry.file %>:<%= entry.line %> →
-          <a href="http://github.com/<%= git_repo %>/commit/<%= entry.git_commit %>"><%= entry.git_commit %></a>
-          <br />
-          <div class="code"><%= entry.line %>: <%= entry.code %></div>
-        </td>
-      </tr>
-
-      <% end %>
-
-    </table>
-  </div>
-
-</body>
-</html>