rails_best_practices 1.4.0 → 1.5.0

data/lib/rails_best_practices/prepares/schema_prepare.rb

@@ -17,14 +17,14 @@ module RailsBestPractices
 
       def start_command(node)
         if "create_table" == node.message.to_s
-          @last_klazz = node.arguments.all[0].to_s.classify
+          @last_klazz = node.arguments.all.first.to_s.classify
         end
       end
 
       # check command_call node to remember the model attributes.
       def start_command_call(node)
         if ATTRIBUTE_TYPES.include? node.message.to_s
-          attribute_name = node.arguments.all[0].to_s
+          attribute_name = node.arguments.all.first.to_s
           @model_attributes.add_attribute(@last_klazz, attribute_name, node.message.to_s)
         end
       end

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -88,7 +88,7 @@ module RailsBestPractices
       private
         # remember the node as index columns
         def remember_index_columns(node)
-          table_name = node.arguments.all[0].to_s
+          table_name = node.arguments.all.first.to_s
           index_column = node.arguments.all[1].to_object
 
           @index_columns[table_name] ||= []
@@ -97,7 +97,7 @@ module RailsBestPractices
 
         # remember table nodes
         def remember_table_nodes(node)
-          @table_name = node.arguments.all[0].to_s
+          @table_name = node.arguments.all.first.to_s
           @table_nodes[@table_name] = node
         end
 
@@ -105,7 +105,7 @@ module RailsBestPractices
         # remember foreign key columns
         def remember_foreign_key_columns(node)
           table_name = @table_name
-          foreign_key_column = node.arguments.all[0].to_s
+          foreign_key_column = node.arguments.all.first.to_s
           @foreign_keys[table_name] ||= []
           if foreign_key_column =~ /(.*?)_id$/
             if @foreign_keys[table_name].delete("#{$1}_type")

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -48,8 +48,8 @@ module RailsBestPractices
         # then it is complext.
         def complex_select_options?(node)
           "options_for_select" == node[1].message.to_s &&
-            :array == node.arguments.all[0].sexp_type &&
-            node.arguments.all[0].array_size > @array_count
+            :array == node.arguments.all.first.sexp_type &&
+            node.arguments.all.first.array_size > @array_count
         end
     end
   end

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -29,8 +29,8 @@ module RailsBestPractices
       # check all command call nodes, compare with rails2 default route
       def start_command_call(node)
         if "map" == node.subject.to_s && "connect" == node.message.to_s &&
-          (":controller/:action/:id" == node.arguments.all[0].to_s ||
-           ":controller/:action/:id.:format" == node.arguments.all[0].to_s)
+          (":controller/:action/:id" == node.arguments.all.first.to_s ||
+           ":controller/:action/:id.:format" == node.arguments.all.first.to_s)
           add_error "not use default route"
         end
       end
@@ -38,7 +38,7 @@ module RailsBestPractices
       # check all command nodes, compare with rails3 default route
       def start_command(node)
         if "match" == node.message.to_s &&
-          ":controller(/:action(/:id(.:format)))" == node.arguments.all[0].to_s
+          ":controller(/:action(/:id(.:format)))" == node.arguments.all.first.to_s
           add_error "not use default route"
         end
       end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -7,19 +7,19 @@ module RailsBestPractices
       include Klassable
       include Completeable
       include Callable
+      include Exceptable
       include InheritedResourcesable
 
-      interesting_nodes :class
-      interesting_files CONTROLLER_FILES
+      interesting_nodes :class, :command, :method_add_arg
+      interesting_files CONTROLLER_FILES, VIEW_FILES
 
-      EXCEPT_METHODS = %w(rescue_action)
       INHERITED_RESOURCES_METHODS = %w(resource collection begin_of_association_chain build_resource)
 
       def initialize(options={})
+        super
         @controller_methods = Prepares.controller_methods
         @routes = Prepares.routes
         @inherited_resources = false
-        @except_methods = EXCEPT_METHODS + options['except_methods']
       end
 
       # mark custom inherited_resources methods as used.
@@ -31,6 +31,22 @@ module RailsBestPractices
         end
       end
 
+      def start_command(node)
+        case node.message.to_s
+        when "render_cell"
+          controller_name, action_name, _ = *node.arguments.all.map(&:to_s)
+          call_method(action_name, "#{controller_name}_cell".classify)
+        when "render"
+          first_argument = node.arguments.all.first
+          if first_argument.present? && first_argument.hash_value("state").present?
+            action_name = first_argument.hash_value("state").to_s
+            call_method(action_name, current_class_name)
+          end
+        end
+      end
+
+      alias :start_method_add_arg :start_command
+
       # get all unused methods at the end of review process.
       def on_complete
         @routes.each do |route|
@@ -42,7 +58,7 @@ module RailsBestPractices
           end
         end
         @controller_methods.get_all_unused_methods.each do |method|
-          if !@except_methods.include?(method.method_name)
+          if !excepted?(method)
             add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
           end
         end
@@ -52,6 +68,10 @@ module RailsBestPractices
         def methods
           @controller_methods
         end
+
+        def internal_except_methods
+          %w(rescue_action).map { |method_name| "*\##{method_name}" }
+        end
     end
   end
 end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -15,21 +15,19 @@ module RailsBestPractices
       include Klassable
       include Completeable
       include Callable
+      include Exceptable
 
       interesting_files ALL_FILES
 
-      EXCEPT_METHODS = %w(initialize validate to_xml to_json assign_attributes after_find after_initialize)
-
       def initialize(options={})
-        super()
+        super
         @model_methods = Prepares.model_methods
-        @except_methods = EXCEPT_METHODS + options['except_methods']
       end
 
       # get all unused methods at the end of review process.
       def on_complete
         @model_methods.get_all_unused_methods.each do |method|
-          if !@except_methods.include?(method.method_name) && method.method_name !~ /=$/
+          if !excepted?(method) && method.method_name !~ /=$/
             add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
           end
         end
@@ -39,6 +37,10 @@ module RailsBestPractices
         def methods
           @model_methods
         end
+
+        def internal_except_methods
+          %w(initialize validate to_xml to_json assign_attributes after_find after_initialize).map { |method_name| "*\##{method_name}" }
+        end
     end
   end
 end

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -42,7 +42,7 @@ module RailsBestPractices
       # remember the namespace.
       def start_method_add_block(node)
         if "namespace" == node.message.to_s
-          @namespaces << node.arguments.all[0].to_s
+          @namespaces << node.arguments.all.first.to_s
         end
       end
 
@@ -86,10 +86,10 @@ module RailsBestPractices
             if hash_key_exist?(option_node,"controller")
               name = option_node.hash_value("controller").to_s
             else
-              name = node.arguments.all[0].to_s.tableize
+              name = node.arguments.all.first.to_s.tableize
             end
           else
-            name = node.arguments.all[0].to_s.tableize
+            name = node.arguments.all.first.to_s.tableize
           end
           namespaced_class_name(name)
         end

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -26,7 +26,7 @@ module RailsBestPractices
       # then it should be replaced by simplified syntax.
       def start_command(node)
         if "render" == node.message.to_s
-          keys = node.arguments.all[0].hash_keys
+          keys = node.arguments.all.first.hash_keys
           if keys && keys.size == 1 &&
              (keys.include?("action") || keys.include?("template") || keys.include?("file"))
             add_error 'simplify render in controllers'

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -25,7 +25,7 @@ module RailsBestPractices
       # then it should be replaced by simplified syntax.
       def start_command(node)
         if "render" == node.message.to_s
-          hash_node =  node.arguments.all[0]
+          hash_node =  node.arguments.all.first
           if hash_node && :bare_assoc_hash == hash_node.sexp_type &&
             hash_node.hash_keys.include?("partial") &&
             !hash_node.hash_value("partial").to_s.include?('/')

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -22,9 +22,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")
-  s.add_development_dependency("watchr")
   s.add_development_dependency("haml")
   s.add_development_dependency("bundler")
+  s.add_development_dependency("spork", "0.9.0.rc9")
+  s.add_development_dependency("guard")
+  s.add_development_dependency("guard-spork")
+  s.add_development_dependency("guard-rspec")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/rails_best_practices/core/routes_spec.rb

@@ -7,4 +7,16 @@ describe RailsBestPractices::Core::Routes do
     routes.add_route(["admin", "test"], "posts", "new")
     routes.map(&:to_s).should == ["Admin::Test::PostsController#new"]
   end
+
+  context "route" do
+    it "should add namesapces, controller name and action name" do
+      route = RailsBestPractices::Core::Route.new(['admin', 'test'], 'posts', 'new')
+      route.to_s.should == "Admin::Test::PostsController#new"
+    end
+
+    it "should add controller name with namespace" do
+      route = RailsBestPractices::Core::Route.new(['admin'], 'test/posts', 'new')
+      route.to_s.should == "Admin::Test::PostsController#new"
+    end
+  end
 end

data/spec/rails_best_practices/core_ext/erubis_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Erubis::OnlyRuby do
+  subject {
+    content =<<-EOF
+    <h1>Title</h1>
+    <% if current_user %>
+      <%= link_to 'account', edit_user_path(current_user) %>
+      <%= "Hello \#{current_user.email}" %>
+    <% else %>
+      Not logged in
+    <% end %>
+    EOF
+    Erubis::OnlyRuby.new(content).src
+  }
+
+  it { should_not include("h1") }
+  it { should_not include("Title") }
+  it { should_not include("Not logged in") }
+  it { should include("current_user") }
+  it { should include("if") }
+  it { should include("else") }
+  it { should include("end") }
+end

data/spec/rails_best_practices/core_ext/sexp_spec.rb

@@ -463,6 +463,11 @@ describe Sexp do
       node.to_object.should == ["first_name", "last_name"]
     end
 
+    it "should to array with symbols" do
+      node = parse_content("[:first_name, :last_name]").grep_node(:sexp_type => :array)
+      node.to_object.should == ["first_name", "last_name"]
+    end
+
     it "should to empty array" do
       node = parse_content("[]").grep_node(:sexp_type => :array)
       node.to_object.should == []

data/spec/rails_best_practices/prepares/model_prepare_spec.rb

@@ -94,6 +94,44 @@ describe RailsBestPractices::Prepares::ModelPrepare do
         model_associations.get_association("Citizen", "nations").should == {"meta" => "has_and_belongs_to_many", "class_name" => "Country"}
       end
     end
+
+    context "mongoid embed" do
+      it "should parse embeds_many" do
+        content =<<-EOF
+        class Person
+          include Mongoid::Document
+          embeds_many :addresses
+        end
+        EOF
+        runner.prepare("app/models/person.rb", content)
+        model_associations = RailsBestPractices::Prepares.model_associations
+        model_associations.get_association("Person", "addresses").should == {"meta" => "embeds_many", "class_name" => "Address"}
+      end
+
+      it "should parse embeds_one" do
+        content =<<-EOF
+        class Lush
+          include Mongoid::Document
+          embeds_one :whiskey, class_name: "Drink", inverse_of: :alcoholic
+        end
+        EOF
+        runner.prepare("app/models/lush.rb", content)
+        model_associations = RailsBestPractices::Prepares.model_associations
+        model_associations.get_association("Lush", "whiskey").should == {"meta" => "embeds_one", "class_name" => "Drink"}
+      end
+
+      it "should parse embedded_in" do
+        content =<<-EOF
+        class Drink
+          include Mongoid::Document
+          embedded_in :alcoholic, class_name: "Lush", inverse_of: :whiskey
+        end
+        EOF
+        runner.prepare("app/models/drink.rb", content)
+        model_associations = RailsBestPractices::Prepares.model_associations
+        model_associations.get_association("Drink", "alcoholic").should == {"meta" => "embedded_in", "class_name" => "Lush"}
+      end
+    end
   end
 
   context "methods" do
@@ -216,6 +254,28 @@ describe RailsBestPractices::Prepares::ModelPrepare do
     end
   end
 
+  context "attributes" do
+    it "should parse mongoid field" do
+      content =<<-EOF
+      class Post
+        include Mongoid::Document
+        field :title
+        field :tags, type: Array
+        field :comments_count, type: Integer
+        field :deleted_at, type: DateTime
+        field :active, type: Boolean
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      model_attributes = RailsBestPractices::Prepares.model_attributes
+      model_attributes.get_attribute_type("Post", "title").should == "String"
+      model_attributes.get_attribute_type("Post", "tags").should == "Array"
+      model_attributes.get_attribute_type("Post", "comments_count").should == "Integer"
+      model_attributes.get_attribute_type("Post", "deleted_at").should == "DateTime"
+      model_attributes.get_attribute_type("Post", "active").should == "Boolean"
+    end
+  end
+
   context "no error" do
     it "should raised for finder_sql option" do
       content =<<-EOF

data/spec/rails_best_practices/prepares/route_prepare_spec.rb

@@ -242,6 +242,19 @@ describe RailsBestPractices::Prepares::RoutePrepare do
       routes = RailsBestPractices::Prepares.routes
       routes.map(&:to_s).should == ["SessionsController#new"]
     end
+
+    it "should add named route with with_options" do
+      content =<<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.with_options(:controller => "admin_session") do |session|
+          session.login '/login', :action => 'new', :method => :get
+        end
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.map(&:to_s).should == ["AdminSessionController#new"]
+    end
   end
 
   context "rails3" do
@@ -464,39 +477,66 @@ describe RailsBestPractices::Prepares::RoutePrepare do
         routes = RailsBestPractices::Prepares.routes
         routes.map(&:to_s).should == ["Admin::Test::PostsController#index"]
       end
+    end
 
-      it "should add match route" do
-        content =<<-EOF
-        RailsBestPracticesCom::Application.routes.draw do
-          match '/auth/:provider/callback' => 'authentications#create'
-        end
-        EOF
-        runner.prepare('config/routes.rb', content)
-        routes = RailsBestPractices::Prepares.routes
-        routes.map(&:to_s).should == ["AuthenticationsController#create"]
+    it "should add route for direct get/post" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        get 'posts/show'
+        post '/posts' => 'posts#create'
+        put '/posts/:id' => 'posts#update'
+        delete '/post/:id' => 'posts#destroy'
+        get '/agb' => 'high_voltage/pages#show', :id => 'agb'
       end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.size.should == 5
+      routes.map(&:to_s).should == ["PostsController#show", "PostsController#create", "PostsController#update", "PostsController#destroy", "HighVoltage::PagesController#show"]
+    end
 
-      it "should add match route with all actions" do
-        content =<<-EOF
-        RailsBestPracticesCom::Application.routes.draw do
-          match 'internal/:action/*whatever', :controller => "internal"
-        end
-        EOF
-        runner.prepare('config/routes.rb', content)
-        routes = RailsBestPractices::Prepares.routes
-        routes.map(&:to_s).should == ["InternalController#*"]
+    it "should add match route" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        match '/auth/:provider/callback' => 'authentications#create'
       end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.map(&:to_s).should == ["AuthenticationsController#create"]
+    end
 
-      it "should add root route" do
-        content =<<-EOF
-        RailsBestPracticesCom::Application.routes.draw do
-          root :to => 'home#index'
-        end
-        EOF
-        runner.prepare('config/routes.rb', content)
-        routes = RailsBestPractices::Prepares.routes
-        routes.map(&:to_s).should == ["HomeController#index"]
+    it "should add match route with all actions" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        match 'internal/:action/*whatever', :controller => "internal"
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.map(&:to_s).should == ["InternalController#*"]
+    end
+
+    it "should add root route" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        root :to => 'home#index'
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.map(&:to_s).should == ["HomeController#index"]
+    end
+
+    it "should do nothing for default route" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        match ':controller(/:action(/:id(.:format)))'
       end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.size.should == 0
     end
   end
 end