rails_best_practices 1.15.3 → 1.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cef5dd69f1ae647200ad40a7fd84b9bd758df233
-  data.tar.gz: 7852c75a5be3ddda15983cd75177e7d187449928
+  metadata.gz: 4f58c94e40ab3dcb7632dc9f975de4133eefb801
+  data.tar.gz: 5997c946de7c2a0f14a45d65882f6c47ae9b57dd
 SHA512:
-  metadata.gz: e6bd653c5accb78475a08c6e56be229e35f2a8175632e423e994a07835d65952094f30cfed3d50da5d44ce7a4cf4ef755f3121bba7d1c1b0f3152b08ff8eaebb
-  data.tar.gz: 3ea57d56bf747f9bfbeea1709f5a9d6128a7375356321205c36185e21bc16fe96a649e7eb9c5925f923cc0c9c0934cdca535bbdc0777589ef99c11fd29469667
+  metadata.gz: ec037490d306afd4d767eaebeb94c782b8c572a07a282f11d123dd964f6711876c4c7b4cbafa7b82b25d8a9bc8a8986dfd4bb6458ffbdcc30f94fe38d17f900d
+  data.tar.gz: cefcea37746e5a2a92005f5920f8ca7e5ba7a41040e8743a775a4a2ea12bcc4e8cd059b8daae6849a93f777b7e649e40ef8ea30dc5b886bfeb9b46be98c7281f

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.1

data/Rakefile

@@ -1,4 +1,6 @@
 require "bundler"
+require "bundler/gem_tasks"
+
 Bundler.setup
 
 require "rake"
@@ -8,23 +10,6 @@ require "rspec/core/rake_task"
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "rails_best_practices/version"
 
-task :build do
-  system "gem build rails_best_practices.gemspec"
-end
-
-task :install => :build do
-  system "sudo gem install rails_best_practices-#{RailsBestPractices::VERSION}.gem"
-end
-
-task :release => :build do
-  puts "Tagging #{RailsBestPractices::VERSION}..."
-  system "git tag -a #{RailsBestPractices::VERSION} -m 'Tagging #{RailsBestPractices::VERSION}'"
-  puts "Pushing to Github..."
-  system "git push --tags"
-  puts "Pushing to rubygems.org..."
-  system "gem push rails_best_practices-#{RailsBestPractices::VERSION}.gem"
-end
-
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end

data/lib/rails_best_practices/analyzer.rb

@@ -2,6 +2,7 @@
 require 'ap'
 require 'colored'
 require 'fileutils'
+require 'json'
 require 'ruby-progressbar'
 
 module RailsBestPractices
@@ -25,7 +26,7 @@ module RailsBestPractices
     #
     # @param [String] path where to generate the configuration yaml file
     # @param [Hash] options
-    def initialize(path, options={})
+    def initialize(path, options = {})
       @path = File.expand_path(path || ".")
 
       @options = options
@@ -59,10 +60,14 @@ module RailsBestPractices
 
     # Output the analyze result.
     def output
-      if @options["format"] == 'html'
+      case @options["format"]
+      when "html"
         @options["output-file"] ||= "rails_best_practices_output.html"
         output_html_errors
-      elsif @options["format"] == 'yaml'
+      when "json"
+        @options["output-file"] ||= "rails_best_practices_output.json"
+        output_json_errors
+      when "yaml"
         @options["output-file"] ||= "rails_best_practices_output.yaml"
         output_yaml_errors
       else
@@ -248,6 +253,21 @@ module RailsBestPractices
       end
     end
 
+    # output errors with json format.
+    def output_json_errors
+      errors_as_hashes = errors.map do |err|
+        {
+          filename:    err.filename,
+          line_number: err.line_number,
+          message:     err.message
+        }
+      end
+
+      File.open(@options["output-file"], "w+") do |file|
+        file.write JSON.dump(errors_as_hashes)
+      end
+    end
+
     # plain output with color.
     #
     # @param [String] message to output

data/lib/rails_best_practices/command.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
-require 'optparse'
+require "optparse"
 
 # Usage: rails_best_practices [options] path
 #    -d, --debug                      debug mode
 #        --silent                     silent mode
-#    -f, --format FORMAT              output format
+#    -f, --format FORMAT              output format (text, html, yml, json)
 #        --output-file FILE           output html file for the analyzing result
 #        --without-color              only output plain text without color
 #        --with-textmate              open file by textmate in html format
@@ -25,16 +25,18 @@ require 'optparse'
 #    -g, --generate                   generate configuration yaml
 #    -v, --version                    show this version
 #    -h, --help                       show this message
+
 options = {}
+
 OptionParser.new do |opts|
   opts.banner = "Usage: rails_best_practices [options] path"
 
   opts.on("-d", "--debug", "Debug mode") do
-    options['debug'] = true
+    options["debug"] = true
   end
 
-  opts.on("-f", "--format FORMAT", "output format") do |format|
-    options['format'] = format
+  opts.on("-f", "--format FORMAT", "output format (text, html, yml, json)") do |format|
+    options["format"] = format
   end
 
   opts.on("--without-color", "only output plain text without color") do
@@ -88,8 +90,8 @@ OptionParser.new do |opts|
     end
   end
 
-  opts.on_tail('-v', '--version', 'Show this version') do
-    require 'rails_best_practices/version'
+  opts.on_tail("-v", "--version", "Show this version") do
+    require "rails_best_practices/version"
     puts RailsBestPractices::VERSION
     exit
   end

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.15.3"
+  VERSION = "1.15.4"
 end

data/rails_best_practices.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency("i18n")
   s.add_dependency("require_all")
   s.add_dependency("ruby-progressbar")
+  s.add_dependency("json")
 
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")

data/spec/rails_best_practices/analyzer_spec.rb

@@ -40,6 +40,42 @@ module RailsBestPractices
       end
     end
 
+    describe "output" do
+      subject { described_class.new(".", "format" => format) }
+
+      before do
+        subject.stub(:output_terminal_errors)
+        subject.stub(:output_html_errors)
+        subject.stub(:output_yaml_errors)
+
+        subject.output
+      end
+
+      context "when format is not set" do
+        let(:format) { nil }
+
+        it "runs text output" do
+          expect(subject).to have_received(:output_terminal_errors)
+        end
+      end
+
+      context "when format is yaml" do
+        let(:format) { "yaml" }
+
+        it "runs yaml output" do
+          expect(subject).to have_received(:output_yaml_errors)
+        end
+      end
+
+      context "when format is html" do
+        let(:format) { "html" }
+
+        it "runs html output" do
+          expect(subject).to have_received(:output_html_errors)
+        end
+      end
+    end
+
     describe "output_terminal_errors" do
       it "should output errors in terminal" do
         check1 = Reviews::LawOfDemeterReview.new
@@ -59,6 +95,37 @@ module RailsBestPractices
       end
     end
 
+    describe "output_json_errors" do
+      let(:output_file) { "rails_best_practices_output.json" }
+
+      subject do
+        described_class.new(".", {
+          "format" => "json",
+          "output-file" => output_file
+        })
+      end
+
+      let(:check1) { Reviews::LawOfDemeterReview.new }
+      let(:check2) { Reviews::UseQueryAttributeReview.new }
+      let(:runner) { Core::Runner.new(reviews: [check1, check2]) }
+      let(:result) { File.read(output_file) }
+
+      before do
+        check1.add_error("law of demeter", "app/models/user.rb", 10)
+        check2.add_error("use query attribute", "app/models/post.rb", 100)
+        subject.runner = runner
+        subject.output
+      end
+
+      after do
+        File.delete(output_file) if File.exists?(output_file)
+      end
+
+      it "saves output as json into output file" do
+        expect(result).to eq '[{"filename":"app/models/user.rb","line_number":"10","message":"law of demeter"},{"filename":"app/models/post.rb","line_number":"100","message":"use query attribute"}]'
+      end
+    end
+
     describe 'parse_files' do
 
       it 'should not filter out all files when the path contains "vendor"' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.15.3
+  version: 1.15.4
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-30 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +216,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -400,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: a code metric tool for rails codes.

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.0