rails_best_practices 0.6.1 → 0.6.5

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_STORE
+.*.swp
+.rvmrc
+.rspec
+.watchr
+pkg/**
+*.gem
+.bundle
+Gemfile.lock
+rdoc/**
+doc/**
+.yardoc/**

data/.rspec.example

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/.rvmrc.example

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm gemset use rails_best_practices

data/.watchr

@@ -0,0 +1,65 @@
+# vim:set filetype=ruby:
+def growl
+  title = "Watchr Test Results"
+  image = $?.success? ? "~/.watchr/images/passed.png" : "~/.watchr/images/failed.png"
+  message = $?.success? ? "success" : "failed"
+  growlnotify = `which growlnotify`.chomp
+  options = "-w -n Watchr --image '#{File.expand_path(image)}' -m '#{message}' '#{title}'"
+  system %(#{growlnotify} #{options} &)
+end
+
+def run(cmd)
+  puts cmd
+  system(cmd)
+end
+
+def spec(file)
+  if File.exists?(file)
+    run("rspec #{file}")
+    growl
+  else
+    puts("Spec: #{file} does not exist.")
+  end
+end
+
+
+def run_all_specs
+  run "rake spec"
+  growl
+end
+
+def run_suite
+  system "clear"
+  run_all_specs
+end
+
+watch("spec/.*/*_spec\.rb") do |match|
+  puts(match[0])
+  spec(match[0])
+end
+
+watch("lib/(.*/.*)\.rb") do |match|
+  puts(match[1])
+  spec("spec/#{match[1]}_spec.rb")
+end
+
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts " --- Running all tests ---\n\n"
+  run_suite
+ end
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @interrupted then
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_suite
+    @interrupted = false
+  end
+end

data/.watchr.example

@@ -0,0 +1,65 @@
+# vim:set filetype=ruby:
+def growl
+  title = "Watchr Test Results"
+  image = $?.success? ? "~/.watchr/images/passed.png" : "~/.watchr/images/failed.png"
+  message = $?.success? ? "success" : "failed"
+  growlnotify = `which growlnotify`.chomp
+  options = "-w -n Watchr --image '#{File.expand_path(image)}' -m '#{message}' '#{title}'"
+  system %(#{growlnotify} #{options} &)
+end
+
+def run(cmd)
+  puts cmd
+  system(cmd)
+end
+
+def spec(file)
+  if File.exists?(file)
+    run("rspec #{file}")
+    growl
+  else
+    puts("Spec: #{file} does not exist.")
+  end
+end
+
+
+def run_all_specs
+  run "rake spec"
+  growl
+end
+
+def run_suite
+  system "clear"
+  run_all_specs
+end
+
+watch("spec/.*/*_spec\.rb") do |match|
+  puts(match[0])
+  spec(match[0])
+end
+
+watch("lib/(.*/.*)\.rb") do |match|
+  puts(match[1])
+  spec("spec/#{match[1]}_spec.rb")
+end
+
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts " --- Running all tests ---\n\n"
+  run_suite
+ end
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @interrupted then
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_suite
+    @interrupted = false
+  end
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem 'rake'
+gemspec

data/README.md

@@ -15,11 +15,17 @@ At the root directory of rails app
 
     rails_best_practices .
 
+or html output
+
+    rails_best_practices -f html .
+
 By default rails_best_practices will do parse codes in vendor, spec, test and features directories. If you need, see the command options:
 
     $ rails_best_practices -h
     Usage: rails_best_practices [options]
         -d, --debug                      Debug mode
+        -f, --format FORMAT              output format
+            --without-color              only output plain text without color
             --vendor                     include vendor files
             --spec                       include spec files
             --test                       include test files

data/Rakefile

@@ -0,0 +1,45 @@
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+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
+
+Rspec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "rails_best_practices #{RailsBestPractices::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+task :default => :spec

data/assets/result.html.haml

@@ -0,0 +1,53 @@
+!!!
+%html
+  %head
+    %meta{:charset => "UTF-8"}
+    %title Output of rails_best_practices
+    :css
+      body {
+        color: #333;
+        background: #eee;
+        padding: 0 20px;
+      }
+      h1 {
+        color: ##4E4E4E;
+      }
+      table {
+        background: white;
+        border: 1px solid #666;
+        border-collapse: collapse;
+        margin: 20px 0;
+        font-size: 14px;
+      }
+      table th, table td {
+        padding: 4px;
+        border: 1px solid #D0D0D0;
+      }
+      table th {
+        background-color: #DFC;
+        color: #337022;
+      }
+      table td.filename {
+        color: #ED1556;
+      }
+      table tr:hover {
+        background-color: #FFFFC0;
+      }
+  %body
+    %h1 rails_best_practices output
+    %h2 Please go to <a href="http://rails-bestpractices.com">http://rails-bestpractices.com</a> to see more useful Rails Best Practices.
+    %h2
+      - if errors.empty?
+        No error found. Cool!
+      - else
+        Found #{errors.size} errors.
+    %table
+      %tr
+        %th Filename
+        %th Line Number
+        %th Error Message
+      - errors.each do |error|
+        %tr
+          %td.filename= error.filename
+          %td.line-number= error.line_number
+          %td.message= error.message

data/lib/rails_best_practices.rb

@@ -25,6 +25,7 @@
 require 'rubygems'
 require 'progressbar'
 require 'colored'
+require 'haml'
 require 'rails_best_practices/checks'
 require 'rails_best_practices/core'
 
@@ -80,7 +81,11 @@ module RailsBestPractices
       process("review")
       @bar.finish
 
-      output_errors
+      if @options['format'] == 'html'
+        output_html_errors
+      else
+        output_terminal_errors
+      end
       exit @runner.errors.size
     end
 
@@ -103,11 +108,9 @@ module RailsBestPractices
     # @return [Array] all files for prepare process
     def prepare_files
       @prepare_files ||= begin
-        files = []
-        ['models', 'mailers'].each do |name|
+        ['models', 'mailers'].inject([]) { |files, name|
           files += expand_dirs_to_files(File.join(@path, 'app', name))
-        end
-        files.compact
+        }.compact
       end
     end
 
@@ -123,7 +126,7 @@ module RailsBestPractices
         end
 
         # Exclude files based on exclude regexes if the option is set.
-        for pattern in @options[:exclude]
+        @options[:exclude].each do |pattern|
           files = file_ignore(files, pattern)
         end
 
@@ -181,13 +184,29 @@ module RailsBestPractices
     end
 
     # output errors if exist.
-    def output_errors
-      @runner.errors.each { |error| puts error.to_s.red }
-      puts "\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices.".green
+    def output_terminal_errors
+      @runner.errors.each { |error| plain_output(error.to_s, 'red') }
+      plain_output("\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices.", 'green')
       if @runner.errors.empty?
-        puts "\nNo error found. Cool!".green
+        plain_output("\nNo error found. Cool!", 'green')
+      else
+        plain_output("\nFound #{@runner.errors.size} errors.", 'red')
+      end
+    end
+
+    def plain_output(message, color)
+      if @options["without-color"]
+        puts message
       else
-        puts "\nFound #{@runner.errors.size} errors.".red
+        puts message.send(color)
+      end
+    end
+
+    def output_html_errors
+      template = File.read(File.join(File.dirname(__FILE__), "..", "assets", "result.html.haml"))
+
+      File.open("rails_best_practices_output.html", "w+") do |file|
+        file.puts Haml::Engine.new(template).render(Object.new, :errors => @runner.errors)
       end
     end
   end

data/lib/rails_best_practices/checks/check.rb

@@ -62,21 +62,21 @@ module RailsBestPractices
         EOS
       end
 
-      # define all start and end process for each node type, like
+      # method_missing to catch all start and end process for each node type, like
       #
       #     prepare_start_defn
       #     prepare_end_defn
       #     review_start_call
       #     review_end_call
-      [:prepare, :review].each do |process|
-        NODE_TYPES.each do |node|
-          class_eval <<-EOS
-            def #{process}_start_#{node}(node)                    # def review_start_defn(node)
-            end                                                   # end
-                                                                  #
-            def #{process}_end_#{node}(node)                      # def review_end_defn(node)
-            end                                                   # end
-          EOS
+      #
+      # if there is a ""debug"" method defined in check, each node will be output.
+      def method_missing(method_name, *args)
+        if method_name.to_s =~ /^(prepare|review)_start_/
+          p args if respond_to?(:debug)
+        elsif method_name.to_s =~ /^(prepare|review)_end_/
+          # nothing to do
+        else
+          super
         end
       end
 

data/lib/rails_best_practices/command.rb

@@ -3,6 +3,7 @@ require 'optparse'
 
 # Usage: rails_best_practices [options] path
 #     -d, --debug                      Debug mode
+#     -f, --format FORMAT              output format
 #         --vendor                     include vendor files
 #         --spec                       include spec files
 #         --test                       include test files
@@ -20,6 +21,14 @@ OptionParser.new do |opts|
     options['debug'] = true
   end
 
+  opts.on("-f", "--format FORMAT", "output format") do |format|
+    options['format'] = format
+  end
+
+  opts.on("--without-color", "only output plain text without color") do
+    options["without-color"] = true
+  end
+
   ['vendor', 'spec', 'test', 'features'].each do |pattern|
     opts.on("--#{pattern}", "include #{pattern} files") do
       options[pattern] = true

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -393,21 +393,16 @@ class Sexp
     end
   end
 
-  # to_s for lvar, ivar, lit, const, array and hash node.
+  # to_s for lvar, ivar, lit, const, array, hash, and colon2 node.
   #
   # @return [String] to_s
   def to_s
-    if [:lvar, :ivar].include? node_type
+    case node_type
+    when :lvar, :ivar, :str, :lit, :const
       self[1].to_s
-    elsif :str == node_type
-      self[1]
-    elsif :lit == node_type
-      self[1].to_s
-    elsif :const == node_type
-      self[1].to_s
-    elsif :array == node_type
+    when :array
       "[\"#{self.children.collect(&:to_s).join('", "')}\"]"
-    elsif :hash == node_type
+    when :hash
       key_value = false # false is key, true is value
       result = ['{"']
       children.each do |child|
@@ -415,6 +410,10 @@ class Sexp
         key_value = !key_value
       end
       result.join("").sub(/, "$/, '') + '}'
+    when :colon2
+      "#{self[1]}::#{self[2]}"
+    else
+      ""
     end
   end
 end