RubyGems - rails_best_practices - Versions diffs - 1.0.1 → 1.1.0 - Mend

rails_best_practices 1.0.1 → 1.1.0

Files changed (35) hide show

data/.gitignore +0 -1
data/.travis.yml +1 -0
data/Gemfile +2 -0
data/Gemfile.lock +45 -0
data/README.md +2 -0
data/assets/result.html.erb +78 -0
data/lib/rails_best_practices.rb +5 -4
data/lib/rails_best_practices/core.rb +2 -0
data/lib/rails_best_practices/core/check.rb +27 -1
data/lib/rails_best_practices/core/controllers.rb +7 -0
data/lib/rails_best_practices/core/methods.rb +26 -0
data/lib/rails_best_practices/core/runner.rb +3 -1
data/lib/rails_best_practices/core_ext/sexp.rb +33 -8
data/lib/rails_best_practices/prepares.rb +13 -0
data/lib/rails_best_practices/prepares/controller_prepare.rb +74 -0
data/lib/rails_best_practices/prepares/mailer_prepare.rb +3 -2
data/lib/rails_best_practices/prepares/model_prepare.rb +12 -10
data/lib/rails_best_practices/reviews.rb +1 -0
data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb +1 -1
data/lib/rails_best_practices/reviews/not_use_default_route_review.rb +1 -1
data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb +1 -1
data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb +149 -0
data/lib/rails_best_practices/version.rb +1 -1
data/rails_best_practices.gemspec +3 -3
data/rails_best_practices.yml +1 -0
data/spec/rails_best_practices/core/controllers_spec.rb +5 -0
data/spec/rails_best_practices/core/methods_spec.rb +22 -0
data/spec/rails_best_practices/core_ext/sexp_spec.rb +28 -1
data/spec/rails_best_practices/prepares/controller_prepare_spec.rb +92 -0
data/spec/rails_best_practices/prepares/model_prepare_spec.rb +22 -0
data/spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb +4 -4
data/spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb +334 -0
data/spec/spec_helper.rb +6 -0
metadata +27 -13
data/assets/result.html.haml +0 -63

data/.gitignore CHANGED Viewed

@@ -6,7 +6,6 @@
 pkg/**
 *.gem
 .bundle
-Gemfile.lock
 rdoc/**
 doc/**
 .yardoc/**

data/.travis.yml ADDED Viewed

	@@ -0,0 +1 @@
1	+ rvm: 1.9.2

data/Gemfile CHANGED Viewed

@@ -1,2 +1,4 @@
 source "http://rubygems.org"
 gemspec
+gem "ripper", :platform => :mri_18

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    rails_best_practices (1.1.0)
+      activesupport
+      colored
+      erubis
+      i18n
+      progressbar
+      sexp_processor
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.7)
+    colored (1.2)
+    diff-lcs (1.1.2)
+    erubis (2.7.0)
+    haml (3.1.3)
+    i18n (0.5.0)
+    progressbar (0.9.1)
+    rake (0.8.7)
+    ripper (1.0.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    sexp_processor (3.0.5)
+    watchr (0.7)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  bundler
+  haml
+  rails_best_practices!
+  rake
+  ripper
+  rspec
+  watchr

data/README.md CHANGED Viewed

@@ -132,6 +132,7 @@ Now you can customize this configuration file, the default configuration is as f
     SimplifyRenderInControllersCheck: {}
     RemoveEmptyHelpersCheck: {}
     RemoveTabCheck: {}
+    RestrictAutoGeneratedRoutesCheck: { }
 You can remove or comment one review to disable it, and you can change the options.
@@ -152,6 +153,7 @@ RESTful Conventions
 1. Overuse route customizations
 2. Needless deep nesting
 3. Not use default route
+4. Restrict auto-generated routes
 Model

data/assets/result.html.erb ADDED Viewed

@@ -0,0 +1,78 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta charset='UTF-8' />
+    <title>Output of rails_best_practices</title>
+    <style type="text/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;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>rails_best_practices output</h1>
+    <h2>
+      Please go to
+      <a href='http://rails-bestpractices.com' target='_blank'>http://rails-bestpractices.com</a>
+      to see more useful Rails Best Practices.
+    </h2>
+    <h2>
+      <% if @errors.empty? %>
+        No error found. Cool!
+      <% else %>
+        Found <%= @errors.size %> errors.
+      <% end %>
+    </h2>
+    <table>
+      <tr>
+        <th>Filename</th>
+        <th>Line Number</th>
+        <th>Warning Message</th>
+      </tr>
+      <% @errors.each do |error| %>
+        <tr>
+          <td class='filename'>
+            <% if @textmate %>
+              <a href='txmt://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.filename %></a>
+            <% elsif @mvim %>
+              <a href='mvim://open/?url=file://<%= File.expand_path(error.filename) %>&amp;line=<%= error.line_number %>'><%= error.filename %></a>
+            <% else %>
+              <%= error.filename %>
+            <% end %>
+          </td>
+          <td class='line'><%= error.line_number %></td>
+          <td class='message'>
+            <a href='<%= error.url %>' target='_blank'><%= error.message %></a>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+  </body>
+</html>

data/lib/rails_best_practices.rb CHANGED Viewed

@@ -25,7 +25,6 @@
 require 'rubygems'
 require 'progressbar'
 require 'colored'
-require 'haml'
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'
@@ -113,7 +112,7 @@ module RailsBestPractices
     # @return [Array] all files for prepare process
     def prepare_files
       @prepare_files ||= begin
-        ['app/models', 'app/mailers', 'db/schema.rb'].inject([]) { |files, name|
+        ['app/models', 'app/mailers', 'db/schema.rb', 'app/controllers'].inject([]) { |files, name|
           files += expand_dirs_to_files(File.join(@path, name))
         }.compact
       end
@@ -223,10 +222,12 @@ module RailsBestPractices
     end
     def output_html_errors
-      template = File.read(File.join(File.dirname(__FILE__), "..", "assets", "result.html.haml"))
+      require 'erubis'
+      template = File.read(File.join(File.dirname(__FILE__), "..", "assets", "result.html.erb"))
       File.open("rails_best_practices_output.html", "w+") do |file|
-        file.puts Haml::Engine.new(template).render(Object.new, :errors => @runner.errors, :textmate => @options["with-textmate"], :mvim => @options["with-mvim"])
+        eruby = Erubis::Eruby.new(template)
+        file.puts eruby.evaluate(:errors => @runner.errors, :textmate => @options["with-textmate"], :mvim => @options["with-mvim"])
       end
     end
   end

data/lib/rails_best_practices/core.rb CHANGED Viewed

@@ -8,6 +8,8 @@ require 'rails_best_practices/core/models'
 require 'rails_best_practices/core/model_associations'
 require 'rails_best_practices/core/model_attributes'
 require 'rails_best_practices/core/mailers'
+require 'rails_best_practices/core/methods'
+require 'rails_best_practices/core/controllers'
 require 'rails_best_practices/core_ext/sexp'
 require 'rails_best_practices/core_ext/enumerable'

data/lib/rails_best_practices/core/check.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module RailsBestPractices
       MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
       VIEW_FILES = /views\/.*\.(erb|haml)$/
       PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)$/
-      ROUTE_FILE = /config\/routes\.rb/
+      ROUTE_FILES = /config\/routes(.*)?\.rb/
       SCHEMA_FILE = /db\/schema\.rb/
       HELPER_FILES = /helpers.*\.rb$/
@@ -83,6 +83,32 @@ module RailsBestPractices
           super
         end
       end
+      module Classable
+        # remember module name.
+        def start_module(node)
+          modules << node.module_name
+        end
+        # end of the module.
+        def end_module(node)
+          modules.pop
+        end
+        # get the class name with module name.
+        def class_name(node)
+          class_name = node.class_name.to_s
+          if modules.empty?
+            class_name
+          else
+            modules.map { |modu| "#{modu}::" }.join("") + class_name
+          end
+        end
+        def modules
+          @moduels ||= []
+        end
+      end
     end
   end
 end

data/lib/rails_best_practices/core/controllers.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class Controllers < Array
+    end
+  end
+end

data/lib/rails_best_practices/core/methods.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class Methods
+      def initialize
+        @methods = {}
+      end
+      def add_method(model_name, method_name)
+        @methods[model_name] ||= []
+        @methods[model_name] << method_name
+      end
+      def get_methods(model_name)
+        @methods[model_name] ||= []
+        @methods[model_name].to_a
+      end
+      def has_method?(model_name, method_name)
+        @methods[model_name] ||= []
+        @methods[model_name].include? method_name
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/runner.rb CHANGED Viewed

@@ -126,6 +126,8 @@ module RailsBestPractices
               content = Haml::Engine.new(content).precompiled
               # remove \xxx characters
               content.gsub!(/\\\d{3}/, '')
+            rescue LoadError
+              raise "In order to parse #{filename}, please install the haml gem"
             rescue Haml::Error
               # do nothing, just ignore the wrong haml files.
             end
@@ -149,7 +151,7 @@ module RailsBestPractices
         # load all prepares.
         def load_prepares
-          [Prepares::ModelPrepare.new, Prepares::MailerPrepare.new, Prepares::SchemaPrepare.new]
+          [Prepares::ModelPrepare.new, Prepares::MailerPrepare.new, Prepares::SchemaPrepare.new, Prepares::ControllerPrepare.new]
         end
         # load all reviews according to configuration.

data/lib/rails_best_practices/core_ext/sexp.rb CHANGED Viewed

@@ -120,6 +120,21 @@ class Sexp
     end
   end
+  # Get the module name of the module node.
+  #
+  #     s(:module,
+  #       s(:const_ref, s(:@const, "Admin", s(1, 7))),
+  #       s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil)
+  #     )
+  #         => s(:const_ref, s(:@const, "Admin", s(1, 7))),
+  #
+  # @return [Sexp] module name node
+  def module_name
+    if :module == sexp_type
+      self[1]
+    end
+  end
   # Get the class name of the class node.
   #
   #     s(:class,
@@ -234,6 +249,8 @@ class Sexp
       self[4]
     when :method_add_arg
       self[2].arguments
+    when :method_add_block
+      self[1].arguments
     when :arg_paren
       self[1]
     when :array
@@ -591,14 +608,16 @@ class Sexp
     if :array == sexp_type
       first_node = self[1]
       array_size = 0
-      while true
-        array_size += 1
-        first_node = s(:args_new) == first_node[1] ? first_node[2] : first_node[1]
-        if :args_add != first_node.sexp_type
-          if :array == first_node.sexp_type
-            array_size += first_node.array_size
+      if first_node
+        while true
+          array_size += 1
+          first_node = s(:args_new) == first_node[1] ? first_node[2] : first_node[1]
+          if :args_add != first_node.sexp_type
+            if :array == first_node.sexp_type
+              array_size += first_node.array_size
+            end
+            break
           end
-          break
         end
       end
       array_size
@@ -619,7 +638,13 @@ class Sexp
   def to_object
     case sexp_type
     when :array
-      arguments.all.map(&:to_s)
+      if nil == self[1]
+        []
+      else
+        arguments.all.map(&:to_s)
+      end
+    else
+      to_s
     end
   end

data/lib/rails_best_practices/prepares.rb CHANGED Viewed

@@ -2,6 +2,7 @@
 require 'rails_best_practices/prepares/model_prepare'
 require 'rails_best_practices/prepares/mailer_prepare'
 require 'rails_best_practices/prepares/schema_prepare'
+require 'rails_best_practices/prepares/controller_prepare'
 module RailsBestPractices
   module Prepares
@@ -23,6 +24,18 @@ module RailsBestPractices
       def mailers
         @mailers ||= Core::Mailers.new
       end
+      def controllers
+        @controllers ||= Core::Controllers.new
+      end
+      def controller_methods
+        @controller_methods ||= Core::Methods.new
+      end
+      def clear
+        @models = @model_associations = @model_attributes = @mailers = @controllers = @controller_methods = nil
+      end
     end
   end
 end

data/lib/rails_best_practices/prepares/controller_prepare.rb ADDED Viewed

@@ -0,0 +1,74 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+module RailsBestPractices
+  module Prepares
+    # Remember controllers and controller methods
+    class ControllerPrepare < Core::Check
+      include Core::Check::Classable
+      DEFAULT_ACTIONS = %w(index show new create edit update destroy)
+      def interesting_nodes
+        [:module, :class, :def, :command, :var_ref]
+      end
+      def interesting_files
+        CONTROLLER_FILES
+      end
+      def initialize
+        @controllers = Prepares.controllers
+        @methods = Prepares.controller_methods
+        @inherited_resources = false
+      end
+      # check class node to remember the class name.
+      # also check if the controller is inherit from InheritedResources::Base.
+      def start_class(node)
+        @class_name = class_name(node)
+        @controllers << @class_name
+        if "InheritedResources::Base" == node.base_class.to_s
+          @inherited_resources = true
+          @actions = DEFAULT_ACTIONS
+        end
+      end
+      # remember the action names at the end of class node if the controller is a InheritedResources.
+      def end_class(node)
+        if @inherited_resources
+          @actions.each do |action|
+            @methods.add_method(@class_name, action)
+          end
+        end
+      end
+      # check if there is a DSL call inherit_resources.
+      def start_var_ref(node)
+        if "inherit_resources" == node.to_s
+          @inherited_resources = true
+          @actions = DEFAULT_ACTIONS
+        end
+      end
+      # restrict actions for inherited_resources
+      def start_command(node)
+        if @inherited_resources && "actions" ==  node.message.to_s
+          @actions = node.arguments.all.map(&:to_s)
+        end
+      end
+      # check def node to remember all methods.
+      #
+      # the remembered methods (@methods) are like
+      #     {
+      #       "Post" => ["create", "destroy"],
+      #       "Comment" => ["create"]
+      #     }
+      def start_def(node)
+        method_name = node.method_name.to_s
+        @methods.add_method(@class_name, method_name)
+      end
+    end
+  end
+end