rails_best_practices 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com)
+
+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/README.textile

@@ -0,0 +1,41 @@
+* Lesson 1. Move code from Controller to Model
+## [-Move finder to named_scope-]
+## [-Use model association-]
+## [-Use scope access-]
+## [-Add model virtual attribute-]
+## Use model callback
+## [-Replace Complex Creation with Factory Method-]
+## [-Move Model Logic into the Model-]
+## model.collection_model_ids (many-to-many)
+## Nested Model Forms (one-to-one)
+## Nested Model Forms (one-to-many)
+
+* Lesson 2. RESTful Conventions
+## Overuse route customizations
+## Needless deep nesting
+## Not use default route
+
+* Lesson 3. Model
+## Keep Finders on Their Own Model
+## Love named_scope
+## the Law of Demeter
+## DRY: metaprogramming
+## Extract into Module
+## Extract to composed class
+## Use Observer
+
+* Lesson 4. Migration
+## Isolating Seed Data
+## Always add DB index
+
+* Lesson 5. Controller
+## Use before_filter
+## DRY Controller
+
+* Lesson 6. View
+## Move code into controller
+## Move code into model
+## Move code into helper
+## Replace instance variable with local variable
+## Use Form Builder
+## Organize Helper files

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+require 'jeweler'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc 'Generate documentation for the sitemap plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bullet'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name = "rails_best_practices"
+  gemspec.summary = ""
+  gemspec.description = ""
+  gemspec.email = "flyerhzm@gmail.com"
+  gemspec.homepage = "http://github.com/flyerhzm/rails_best_practices"
+  gemspec.authors = ["Richard Huang"]
+end
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/rails_best_practices

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'rails_best_practices'
+require 'rails_best_practices/command'

data/lib/rails_best_practices.rb

@@ -0,0 +1,5 @@
+require 'rails_best_practices/checks'
+require 'rails_best_practices/core'
+
+module RailsBestPractices
+end

data/lib/rails_best_practices/checks.rb

@@ -0,0 +1,9 @@
+require 'rails_best_practices/checks/move_finder_to_named_scope_check'
+require 'rails_best_practices/checks/use_model_association_check'
+require 'rails_best_practices/checks/use_scope_access_check'
+require 'rails_best_practices/checks/add_model_virtual_attribute_check'
+require 'rails_best_practices/checks/use_model_callback_check'
+require 'rails_best_practices/checks/replace_complex_creation_with_factory_method_check'
+require 'rails_best_practices/checks/move_model_logic_into_model_check'
+require 'rails_best_practices/checks/many_to_many_collection_check'
+require 'rails_best_practices/checks/nested_model_forms_check'

data/lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb

@@ -0,0 +1,57 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a controller to make sure adding a model virual attribute to simplify model creation.
+    #
+    # Implementation: check arguments of params#[]= before calling save, 
+    # if they have duplicated arguments, then the model may need to add a model virtual attribute.
+    class AddModelVirtualAttributeCheck < Check
+      
+      def interesting_nodes
+        [:defn]
+      end
+      
+      def interesting_files
+        /_controller.rb$/
+      end
+
+      def evaluate_start(node)
+        @variables = {}
+        node.recursive_children do |child|
+          case child.node_type
+          when :attrasgn
+            attribute_assignment(child)
+          when :call
+            call_assignment(child)
+          else
+          end
+        end
+        @variables = nil
+      end
+      
+      private
+      
+      def attribute_assignment(node)
+        variable = node.subject
+        return if variable.nil?
+        @variables[variable] ||= []
+        @variables[variable] << {:message => node.message, :arguments => node.arguments}
+      end
+      
+      def call_assignment(node)
+        if node.message == :save
+          variable = node.subject
+          add_error "add model virtual attribute" if params_dup?(@variables[variable].collect {|h| h[:arguments] })
+        end
+      end
+      
+      def params_dup?(nodes)
+        return false if nodes.nil?
+        params_nodes = nodes.collect {|node| node.grep_nodes({:subject => s(:call, nil, :params, s(:arglist)), :message => :[]}).first}.compact
+        params_arguments = params_nodes.collect(&:arguments)
+        !params_arguments.dups.empty?
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/check.rb

@@ -0,0 +1,59 @@
+require 'rails_best_practices/core/error'
+
+module RailsBestPractices
+  module Checks
+    class Check
+      NODE_TYPES = [:call, :defn, :if, :unless]
+
+      def initialize
+        @errors = []
+      end
+      
+      def interesting_files
+        /.*/
+      end
+  
+      NODE_TYPES.each do |node|
+        start_node_method = "evaluate_start_#{node}"
+        end_node_method = "evaluate_end_#{node}"
+        define_method(start_node_method) { } unless self.respond_to?(start_node_method)
+        define_method(end_node_method) { } unless self.respond_to?(end_node_method)
+      end
+
+      def position(offset = 0)
+        "#{@line[2]}:#{@line[1] + offset}"
+      end
+      
+      def evaluate_start(node)
+      end
+
+      def evaluate_end(node)
+      end
+
+      def evaluate_node(position, node)
+        @node = node
+        eval_method = "evaluate_#{position}_#{node.node_type}"
+        self.send(eval_method, node)
+      end
+
+      def evaluate_node_start(node)
+        evaluate_node(:start, node)
+        evaluate_start(node)
+      end
+  
+      def evaluate_node_end(node)
+        evaluate_node(:end, node)
+        evaluate_end(node)
+      end
+      
+      def add_error(error, line = nil)
+        line = @node.line if line.nil?
+        @errors << RailsBestPractices::Core::Error.new("#{@node.file}", "#{line}", error)
+      end
+  
+      def errors
+        @errors
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/many_to_many_collection_check.rb

@@ -0,0 +1,12 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # TODO: unknown how to realize it.
+    class ManyToManyCollectionCheck < Check
+      
+      def interesting_nodes
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb

@@ -0,0 +1,33 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a controller file to make sure finder is simple.
+    #
+    # Complex finder in controller is a code smell, use namd_scope instead.
+    #
+    # Implementation: check method :find, :all, :first, :last with hash parameters.
+    class MoveFinderToNamedScopeCheck < Check
+      
+      FINDER = [:find, :all, :first, :last]
+      
+      def interesting_nodes
+        [:call]
+      end
+      
+      def interesting_files
+        /_controller.rb$/
+      end
+
+      def evaluate_start(node)
+        add_error "move finder to named_scope" if finder?(node)
+      end
+      
+      private
+      
+      def finder?(node)
+        node.subject.node_type == :const && FINDER.include?(node.message) && node.arguments.children.any? {|node| node.node_type == :hash}
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/move_model_logic_into_model_check.rb

@@ -0,0 +1,48 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a controller file to make sure that model logic should not exist in controller, move it into a model.
+    #
+    # Implementation: check the count of method calling of a model, 
+    # if it is more than defined called count, then it contains model logic.
+    class MoveModelLogicIntoModelCheck < Check
+      
+      def interesting_nodes
+        [:defn]
+      end
+      
+      def interesting_files
+        /_controller.rb$/
+      end
+
+      def initialize(options = {})
+        super()
+        @called_count = options['called_count'] || 4
+      end
+
+      def evaluate_start(node)
+        @variables = {}
+        node.recursive_children do |child|
+          case child.node_type
+          when :attrasgn, :call
+            call_node(child)
+          end
+        end
+        if @variables.values.any? { |count| count > @called_count }
+          add_error "move model logic into model"
+        end
+        @variables = nil
+      end
+
+      private
+      
+      def call_node(node)
+        variable = node.subject
+        return if variable.nil?
+        @variables[variable] ||= 0
+        @variables[variable] += 1
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/nested_model_forms_check.rb

@@ -0,0 +1,12 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # TODO: unknown how to realize it.
+    class NestedModelFormsCheck < Check
+      
+      def interesting_nodes
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb

@@ -0,0 +1,55 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a controller file to make sure that complex model creation should not exist in controller, move it to model factory method
+    #
+    # Implementation: check the count of variable attribute assignment calling before saving, 
+    # if more than defined attribute assignment count, then it's a complex creation.
+    class ReplaceComplexCreationWithFactoryMethodCheck < Check
+      
+      def interesting_nodes
+        [:defn]
+      end
+      
+      def interesting_files
+        /_controller.rb$/
+      end
+      
+      def initialize(options = {})
+        super()
+        @attrasgn_count = options['attribute_assignment_count'] || 2
+      end
+      
+      def evaluate_start(node)
+        @variables = {}
+        node.recursive_children do |child|
+          case child.node_type
+          when :attrasgn
+            attribute_assignment(child)
+          when :call
+            call_assignment(child)
+          else
+          end
+        end
+        @variables = nil
+      end
+      
+      private
+      
+      def attribute_assignment(node)
+        variable = node.subject
+        return if variable.nil?
+        @variables[variable] ||= 0
+        @variables[variable] += 1
+      end
+      
+      def call_assignment(node)
+        if node.message == :save
+          variable = node.subject
+          add_error "replace complex creation with factory method" if @variables[variable] > @attrasgn_count
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks/use_model_association_check.rb

@@ -0,0 +1,47 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a model creation to make sure using model association.
+    #
+    # Implementation: 
+    # 1. check :attrasgn, if xxx_id is assigned to a variable, set the value of the assigned variable to true.
+    # 2. check :call, if call message :save and caller is included in variables, add error.
+    class UseModelAssociationCheck < Check
+      
+      def interesting_nodes
+        [:defn]
+      end
+
+      def evaluate_start(node)
+        @variables = {}
+        node.recursive_children do |child|
+          case child.node_type
+          when :attrasgn
+            attribute_assignment(child)
+          when :call
+            call_assignment(child)
+          else
+          end
+        end
+        @variables = nil
+      end
+      
+      private
+      
+      def attribute_assignment(node)
+        if node.message.to_s =~ /_id=$/
+          variable = node.subject[1]
+          @variables[variable] = true
+        end
+      end
+      
+      def call_assignment(node)
+        if node.message == :save
+          variable = node.subject[1]
+          add_error "use model association" if @variables[variable]
+        end
+      end
+    end
+  end
+end