rails_best_practices 0.4.0 → 0.4.1

data/{LICENSE → MIT_LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Richard Huang (flyerhzm@gmail.com)
+Copyright (c) 2009 - 2010 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

data/README.textile

@@ -4,21 +4,6 @@ rails_best_practices is a code metric tool to check the quality of rails codes.
 
 *************************************************
 
-h2. Resources
-
-Homepage: "http://rails-bestpractices.com":http://rails-bestpractices.com
-Wiki: "http://github.com/flyerhzm/rails_best_practices/wiki":http://github.com/flyerhzm/rails_best_practices/wiki
-
-*************************************************
-
-h2. Install
-
-<pre><code>
-sudo gem install rails_best_practices
-</code></pre>
-
-*************************************************
-
 h2. Usage
 
 At the root directory of rails app
@@ -44,6 +29,22 @@ Usage: rails_best_practices [options]
 
 *************************************************
 
+h2. Helpful links
+
+Homepage: "http://rails-bestpractices.com":http://rails-bestpractices.com
+Repository: "http://github.com/flyerhzm/rails_best_practices":http://github.com/flyerhzm/rails_best_practices
+Wiki: "http://github.com/flyerhzm/rails_best_practices/wiki":http://github.com/flyerhzm/rails_best_practices/wiki
+
+*************************************************
+
+h2. Install
+
+<pre><code>
+sudo gem install rails_best_practices
+</code></pre>
+
+*************************************************
+
 h2. Issue
 
 If you got NoMethodError or any syntax error, you should use debug mode to detect which file rails_best_practices is parsing and getting the error.
@@ -54,6 +55,8 @@ rails_best_practices -d .
 
 Then give me the error stack and the source code of the file that rails_best_practices is parsing error.
 
+"http://github.com/flyerhzm/rails_best_practices/issues":http://github.com/flyerhzm/rails_best_practices/issues
+
 *************************************************
 
 h2. Customize Configuration
@@ -120,10 +123,16 @@ h2. Implementation
 
 *************************************************
 
-h2. Links
+h2. Contribute
+
+If you want to add your rails best practices into the gem, please post your best practices on "http://rails-bestpractices.com":http://rails-bestpractices.com
+
+*************************************************
+
+h2. Contact
 
-"http://railsenvy.com/2009/12/07/rails-envy-podcast-episode-102":http://railsenvy.com/2009/12/07/rails-envy-podcast-episode-102
-"http://ruby5.envylabs.com/episodes/29-episode-28-november-17-2009":http://ruby5.envylabs.com/episodes/29-episode-28-november-17-2009
+Follow us on twitter: "http://twitter.com/railsbp":http://twitter.com/railsbp
+Send us email: "team@rails-bestpractices.com":mailto:team@rails-bestpractices.com
 
 *************************************************
 

data/lib/rails_best_practices/command.rb

@@ -1,5 +1,6 @@
 require 'optparse'
-
+require 'progressbar'
+require 'colored'
 
 options = {}
 OptionParser.new do |opts|
@@ -32,12 +33,14 @@ runner = RailsBestPractices::Core::Runner.new
 runner.set_debug if options['debug']
 
 files = RailsBestPractices::analyze_files(ARGV, options)
-files.each { |file| runner.check_file(file) }
+bar = ProgressBar.new('Analyzing', files.size)
+files.each { |file| runner.check_file(file); bar.inc }
+bar.finish
 
-runner.errors.each {|error| puts error}
-puts "\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices."
+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
 if runner.errors.size > 0
-  puts "\nFound #{runner.errors.size} errors."
+  puts "\nFound #{runner.errors.size} errors.".red
 end
 
 exit runner.errors.size

data/lib/rails_best_practices/version.rb

@@ -0,0 +1,4 @@
+module RailsBestPractices
+  VERSION = "0.4.1"
+end
+

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -14,154 +15,186 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-15 00:00:00 +08:00
+date: 2010-09-24 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ruby_parser
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         - 0
         - 4
         version: 2.0.4
+  name: ruby_parser
+  prerelease: false
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ruby2ruby
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 2
         - 4
         version: 1.2.4
+  name: ruby2ruby
+  prerelease: false
   type: :runtime
   version_requirements: *id002
-description: a code metric tool for rails codes.
-email: flyerhzm@gmail.com
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  name: progressbar
+  prerelease: false
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  name: colored
+  prerelease: false
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196431
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 3
+        - 0
+        - 18
+        version: 3.0.18
+  name: haml
+  prerelease: false
+  type: :development
+  version_requirements: *id006
+description: a code metric tool for rails codes, written in Ruby.
+email: 
+- flyerhzm@gmail.com
 executables: 
 - rails_best_practices
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
+- MIT_LICENSE
 - README.textile
 files: 
-- .gitignore
-- LICENSE
-- README.textile
-- Rakefile
-- VERSION
-- bin/rails_best_practices
-- identifier
 - lib/rails_best_practices.rb
-- lib/rails_best_practices/checks.rb
-- lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
-- lib/rails_best_practices/checks/always_add_db_index_check.rb
-- lib/rails_best_practices/checks/check.rb
-- lib/rails_best_practices/checks/isolate_seed_data_check.rb
+- lib/rails_best_practices/version.rb
+- lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
+- lib/rails_best_practices/checks/use_model_association_check.rb
 - lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb
+- lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
 - lib/rails_best_practices/checks/law_of_demeter_check.rb
+- lib/rails_best_practices/checks/use_scope_access_check.rb
 - lib/rails_best_practices/checks/move_code_into_controller_check.rb
-- lib/rails_best_practices/checks/move_code_into_helper_check.rb
-- lib/rails_best_practices/checks/move_code_into_model_check.rb
-- lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
 - lib/rails_best_practices/checks/move_model_logic_into_model_check.rb
-- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
 - lib/rails_best_practices/checks/not_use_default_route_check.rb
-- lib/rails_best_practices/checks/overuse_route_customizations_check.rb
 - lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb
+- lib/rails_best_practices/checks/isolate_seed_data_check.rb
+- lib/rails_best_practices/checks/always_add_db_index_check.rb
 - lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb
-- lib/rails_best_practices/checks/use_before_filter_check.rb
-- lib/rails_best_practices/checks/use_model_association_check.rb
+- lib/rails_best_practices/checks/needless_deep_nesting_check.rb
+- lib/rails_best_practices/checks/move_code_into_helper_check.rb
 - lib/rails_best_practices/checks/use_observer_check.rb
-- lib/rails_best_practices/checks/use_scope_access_check.rb
-- lib/rails_best_practices/command.rb
+- lib/rails_best_practices/checks/check.rb
+- lib/rails_best_practices/checks/overuse_route_customizations_check.rb
+- lib/rails_best_practices/checks/use_before_filter_check.rb
+- lib/rails_best_practices/checks/move_code_into_model_check.rb
 - lib/rails_best_practices/core.rb
+- lib/rails_best_practices/checks.rb
 - lib/rails_best_practices/core/checking_visitor.rb
 - lib/rails_best_practices/core/core_ext.rb
 - lib/rails_best_practices/core/error.rb
-- lib/rails_best_practices/core/runner.rb
 - lib/rails_best_practices/core/visitable_sexp.rb
-- rails_best_practices.gemspec
+- lib/rails_best_practices/core/runner.rb
+- lib/rails_best_practices/command.rb
 - rails_best_practices.yml
-- spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
-- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
-- spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb
-- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
-- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_model_check_spec.rb
-- spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
-- spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
-- spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
-- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
-- spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
-- spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
-- spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb
-- spec/rails_best_practices/checks/use_before_filter_check_spec.rb
-- spec/rails_best_practices/checks/use_model_association_check_spec.rb
-- spec/rails_best_practices/checks/use_observer_check_spec.rb
-- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- MIT_LICENSE
+- README.textile
+- bin/rails_best_practices
 has_rdoc: true
 homepage: http://rails-bestpractices.com
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: a code metric tool for rails codes.
-test_files: 
-- spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb
-- spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb
-- spec/rails_best_practices/checks/use_observer_check_spec.rb
-- spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
-- spec/rails_best_practices/checks/always_add_db_index_check_spec.rb
-- spec/rails_best_practices/checks/use_before_filter_check_spec.rb
-- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
-- spec/rails_best_practices/checks/use_scope_access_check_spec.rb
-- spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
-- spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
-- spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
-- spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
-- spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb
-- spec/rails_best_practices/checks/use_model_association_check_spec.rb
-- spec/rails_best_practices/checks/move_code_into_model_check_spec.rb
-- spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb
-- spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
-- spec/spec_helper.rb
+test_files: []
+

data/.gitignore

@@ -1,2 +0,0 @@
-.*.swp
-pkg/**

data/Rakefile

@@ -1,33 +0,0 @@
-require 'rake'
-require 'spec/rake/spectask'
-require 'rake/rdoctask'
-require 'jeweler'
-
-desc 'Default: run unit tests.'
-task :default => :spec
-
-desc 'Generate documentation for the rails_best_practices plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'rails_best_practices'
-  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 = "a code metric tool for rails codes."
-  gemspec.description = "a code metric tool for rails codes."
-  gemspec.email = "flyerhzm@gmail.com"
-  gemspec.homepage = "http://rails-bestpractices.com"
-  gemspec.authors = ["Richard Huang"]
-  gemspec.add_dependency 'ruby_parser', '>= 2.0.4'
-  gemspec.add_dependency 'ruby2ruby', '>= 1.2.4'
-end
-Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +0,0 @@
-0.4.0

data/rails_best_practices.gemspec

@@ -1,126 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{rails_best_practices}
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Richard Huang"]
-  s.date = %q{2010-08-15}
-  s.default_executable = %q{rails_best_practices}
-  s.description = %q{a code metric tool for rails codes.}
-  s.email = %q{flyerhzm@gmail.com}
-  s.executables = ["rails_best_practices"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.textile"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.textile",
-     "Rakefile",
-     "VERSION",
-     "bin/rails_best_practices",
-     "identifier",
-     "lib/rails_best_practices.rb",
-     "lib/rails_best_practices/checks.rb",
-     "lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb",
-     "lib/rails_best_practices/checks/always_add_db_index_check.rb",
-     "lib/rails_best_practices/checks/check.rb",
-     "lib/rails_best_practices/checks/isolate_seed_data_check.rb",
-     "lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb",
-     "lib/rails_best_practices/checks/law_of_demeter_check.rb",
-     "lib/rails_best_practices/checks/move_code_into_controller_check.rb",
-     "lib/rails_best_practices/checks/move_code_into_helper_check.rb",
-     "lib/rails_best_practices/checks/move_code_into_model_check.rb",
-     "lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb",
-     "lib/rails_best_practices/checks/move_model_logic_into_model_check.rb",
-     "lib/rails_best_practices/checks/needless_deep_nesting_check.rb",
-     "lib/rails_best_practices/checks/not_use_default_route_check.rb",
-     "lib/rails_best_practices/checks/overuse_route_customizations_check.rb",
-     "lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb",
-     "lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb",
-     "lib/rails_best_practices/checks/use_before_filter_check.rb",
-     "lib/rails_best_practices/checks/use_model_association_check.rb",
-     "lib/rails_best_practices/checks/use_observer_check.rb",
-     "lib/rails_best_practices/checks/use_scope_access_check.rb",
-     "lib/rails_best_practices/command.rb",
-     "lib/rails_best_practices/core.rb",
-     "lib/rails_best_practices/core/checking_visitor.rb",
-     "lib/rails_best_practices/core/core_ext.rb",
-     "lib/rails_best_practices/core/error.rb",
-     "lib/rails_best_practices/core/runner.rb",
-     "lib/rails_best_practices/core/visitable_sexp.rb",
-     "rails_best_practices.gemspec",
-     "rails_best_practices.yml",
-     "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
-     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
-     "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
-     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
-     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_model_check_spec.rb",
-     "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
-     "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
-     "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
-     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
-     "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
-     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
-     "spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb",
-     "spec/rails_best_practices/checks/use_before_filter_check_spec.rb",
-     "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
-     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
-     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://rails-bestpractices.com}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{a code metric tool for rails codes.}
-  s.test_files = [
-    "spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb",
-     "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb",
-     "spec/rails_best_practices/checks/use_observer_check_spec.rb",
-     "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
-     "spec/rails_best_practices/checks/always_add_db_index_check_spec.rb",
-     "spec/rails_best_practices/checks/use_before_filter_check_spec.rb",
-     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
-     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
-     "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
-     "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
-     "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
-     "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
-     "spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb",
-     "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
-     "spec/rails_best_practices/checks/move_code_into_model_check_spec.rb",
-     "spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb",
-     "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ruby_parser>, [">= 2.0.4"])
-      s.add_runtime_dependency(%q<ruby2ruby>, [">= 1.2.4"])
-    else
-      s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
-      s.add_dependency(%q<ruby2ruby>, [">= 1.2.4"])
-    end
-  else
-    s.add_dependency(%q<ruby_parser>, [">= 2.0.4"])
-    s.add_dependency(%q<ruby2ruby>, [">= 1.2.4"])
-  end
-end
-