rails_best_practices 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0b67ef3e8abe665b14bf2dd398755f5b1d84e05
-  data.tar.gz: 4ea8cfbcb9a26b10b070e86b2deac14e2f9ea751
+  metadata.gz: 4eb57bfb18f02e91c08dbfef14f970acc55e3a3a
+  data.tar.gz: f7f14c66689cf3cc3bd3a1efd7ea1b533b41d2c7
 SHA512:
-  metadata.gz: c032c3904c6f27437c7b8be4a728c74ab543d6f14d1c2d620d8dac8dda029de46aa15f52c31b86d07e45dee2544f7165d991c7dc652731c7227e76970574eefe
-  data.tar.gz: dada2172b41c479b90ec443f8a99a9a04bf68833ceea23b5f39ba5e9c572b8686797079c1c15eead93c2a7ea066fe40970f4257342055215574b804e6049e0a9
+  metadata.gz: d2d1f2d5ed8eb36cdcdfb3936c81c6e75eb50565751d3489dac9f36aa6575715f8044c9728a3c1a33171d476d099f86fcfe7486ee7480d01073c5bfcd61d9553
+  data.tar.gz: 22aa1432ef5b0ce38a69f9ea2b14344e967a00b1f7f2ddbcc4c67ba7ee67e3dd657ba176acdd492185ec980345c03ef4c063c3791a8fb06ae6ac345462cec28c

data/.rubocop_todo.yml

@@ -71,7 +71,7 @@ Metrics/BlockNesting:
 # Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 223
+  Max: 224
 
 # Offense count: 3
 Metrics/CyclomaticComplexity:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Next Release
 
+## 1.18.0 (2017-03-01)
+
+* Add --config option
+
 ## 1.17.0 (2016-07-14)
 
 * Detect index option in column creation

data/README.md

@@ -80,6 +80,7 @@ To see the full list of command-line options, run:
         -o, --only PATTERNS              analyze files only matching a pattern
                                          (comma-separated regexp list)
         -g, --generate                   Generate configuration yaml
+        -c, --config CONFIG_PATH         configuration file location (defaults to config/rails_best_practices.yml)
         -v, --version                    Show this version
         -h, --help                       Show this message
 
@@ -113,6 +114,12 @@ or add it to the Gemfile
 
 Install <https://github.com/asuth/subl-handler>
 
+## Editor Integration
+
+#### TextMate 2
+
+If you use `TextMate 2`, you can install the [RailsBestPractices.tmbundle](https://github.com/jjuliano/RailsBestPractices.tmbundle) bundle.
+
 ## Issues
 
 If you install the rails_best_practices with bundler-installed GitHub-sourced gem, please use the following command instead.
@@ -138,6 +145,7 @@ Now you can customize this configuration file. The default configuration is as f
     AddModelVirtualAttributeCheck: { }
     AlwaysAddDbIndexCheck: { }
     #CheckSaveReturnValueCheck: { }
+    #CheckDestroyReturnValueCheck: { }
     DefaultScopeIsEvilCheck: { }
     DryBundlerInCapistranoCheck: { }
     #HashSyntaxCheck: { }
@@ -152,12 +160,12 @@ Now you can customize this configuration file. The default configuration is as f
     MoveModelLogicIntoModelCheck: { use_count: 4 }
     NeedlessDeepNestingCheck: { nested_count: 2 }
     NotRescueExceptionCheck: { }
-    NotUseDefaultRouteCheck: {  }
-    NotUseTimeAgoInWordsCheck: {}
+    NotUseDefaultRouteCheck: { }
+    NotUseTimeAgoInWordsCheck: { }
     OveruseRouteCustomizationsCheck: { customize_count: 3 }
-    ProtectMassAssignmentCheck: {}
-    RemoveEmptyHelpersCheck: {}
-    #RemoveTabCheck: {}
+    ProtectMassAssignmentCheck: { }
+    RemoveEmptyHelpersCheck: { }
+    #RemoveTabCheck: { }
     RemoveTrailingWhitespaceCheck: { }
     RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
     RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
@@ -165,18 +173,19 @@ Now you can customize this configuration file. The default configuration is as f
     ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
     ReplaceInstanceVariableWithLocalVariableCheck: { }
     RestrictAutoGeneratedRoutesCheck: { }
-    SimplifyRenderInControllersCheck: {}
-    SimplifyRenderInViewsCheck: {}
+    SimplifyRenderInControllersCheck: { }
+    SimplifyRenderInViewsCheck: { }
     #UseBeforeFilterCheck: { customize_count: 2 }
     UseModelAssociationCheck: { }
-    UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
+    UseMultipartAlternativeAsContentTypeOfEmailCheck: { }
     UseObserverCheck: { }
-    #UseParenthesesInMethodDefCheck: {}
+    #UseParenthesesInMethodDefCheck: { }
     UseQueryAttributeCheck: { }
     UseSayWithTimeInMigrationsCheck: { }
     UseScopeAccessCheck: { }
     UseTurboSprocketsRails3Check: { }
 
+
 You can remove or comment a review to disable it, and you can change the options.
 
 You can apply the `ignored_files` option on any rule by giving a regexp or array of regexps describing the path of the files you don't want to be checked:
@@ -211,6 +220,7 @@ Model
 4. Use query attribute
 5. Remove unused methods in models
 6. Protect mass assignment
+7. Destroy return value (disabled by default)
 
 Mailer
 

data/lib/rails_best_practices/analyzer.rb

@@ -50,6 +50,7 @@ module RailsBestPractices
     # @param [Hash] options
     def analyze
       Core::Runner.base_path = @path
+      Core::Runner.config_path = @options['config']
       @runner = Core::Runner.new
 
       analyze_source_codes

data/lib/rails_best_practices/command.rb

@@ -121,6 +121,13 @@ OptionParser.new do |opts|
     options["generate"] = true
   end
 
+  opts.on(
+    '-c',
+    '--config CONFIG_PATH', 'configuration file location (defaults to config/rails_best_practices.yml)'
+  ) do |config_path|
+    options['config'] = config_path
+  end
+
   opts.parse!
 end
 
@@ -135,5 +142,5 @@ else
   analyzer = RailsBestPractices::Analyzer.new(ARGV.first, options)
   analyzer.analyze
   analyzer.output
-  exit analyzer.runner.errors.size
+  exit analyzer.runner.errors.size > 0 ? 1 : 0
 end

data/lib/rails_best_practices/core/runner.rb

@@ -33,12 +33,26 @@ module RailsBestPractices
         @base_path || "."
       end
 
+      # set the configuration path
+      #
+      # @param path [String] path to rbc config file
+      def self.config_path=(path)
+        @config_path = path
+      end
+
+      # get the configuration path, if will default to config/rails_best_practices.yml
+      #
+      # @return [String] the config path
+      def self.config_path
+        custom_config = @config_path || File.join(Runner.base_path, 'config/rails_best_practices.yml')
+        File.exists?(custom_config) ? custom_config : RailsBestPractices::Analyzer::DEFAULT_CONFIG
+      end
+
       # initialize the runner.
       #
       # @param [Hash] options pass the prepares and reviews.
       def initialize(options={})
-        custom_config = File.join(Runner.base_path, 'config/rails_best_practices.yml')
-        @config = File.exists?(custom_config) ? custom_config : RailsBestPractices::Analyzer::DEFAULT_CONFIG
+        @config = self.class.config_path
 
         lexicals = Array(options[:lexicals])
         prepares = Array(options[:prepares])

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency("ruby-progressbar")
   s.add_dependency("json")
 
-  s.add_development_dependency("rake")
+  s.add_development_dependency("rake", '< 11.0')
   s.add_development_dependency("rspec")
   s.add_development_dependency("haml")
   s.add_development_dependency("slim")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,16 +112,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -343,8 +343,8 @@ files:
 - spec/rails_best_practices/prepares/schema_prepare_spec.rb
 - spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb
-- spec/rails_best_practices/reviews/check_destroy_return_value_spec.rb
-- spec/rails_best_practices/reviews/check_save_return_value_spec.rb
+- spec/rails_best_practices/reviews/check_destroy_return_value_review_spec.rb
+- spec/rails_best_practices/reviews/check_save_return_value_review_spec.rb
 - spec/rails_best_practices/reviews/default_scope_is_evil_review_spec.rb
 - spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb
 - spec/rails_best_practices/reviews/hash_syntax_review_spec.rb
@@ -357,9 +357,9 @@ files:
 - spec/rails_best_practices/reviews/move_finder_to_named_scope_review_spec.rb
 - spec/rails_best_practices/reviews/move_model_logic_into_model_review_spec.rb
 - spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb
-- spec/rails_best_practices/reviews/not_rescue_exception_spec.rb
+- spec/rails_best_practices/reviews/not_rescue_exception_review_spec.rb
 - spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb
-- spec/rails_best_practices/reviews/not_use_times_ago_in_words_review_spec.rb
+- spec/rails_best_practices/reviews/not_use_time_ago_in_words_review_spec.rb
 - spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb
 - spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb
 - spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
@@ -375,7 +375,7 @@ files:
 - spec/rails_best_practices/reviews/use_model_association_review_spec.rb
 - spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb
 - spec/rails_best_practices/reviews/use_observer_review_spec.rb
-- spec/rails_best_practices/reviews/use_parenthesis_in_method_def_spec.rb
+- spec/rails_best_practices/reviews/use_parentheses_in_method_def_review_spec.rb
 - spec/rails_best_practices/reviews/use_query_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/use_say_with_time_in_migrations_review_spec.rb
 - spec/rails_best_practices/reviews/use_scope_access_review_spec.rb
@@ -419,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: a code metric tool for rails codes.
@@ -458,8 +458,8 @@ test_files:
 - spec/rails_best_practices/prepares/schema_prepare_spec.rb
 - spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb
-- spec/rails_best_practices/reviews/check_destroy_return_value_spec.rb
-- spec/rails_best_practices/reviews/check_save_return_value_spec.rb
+- spec/rails_best_practices/reviews/check_destroy_return_value_review_spec.rb
+- spec/rails_best_practices/reviews/check_save_return_value_review_spec.rb
 - spec/rails_best_practices/reviews/default_scope_is_evil_review_spec.rb
 - spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb
 - spec/rails_best_practices/reviews/hash_syntax_review_spec.rb
@@ -472,9 +472,9 @@ test_files:
 - spec/rails_best_practices/reviews/move_finder_to_named_scope_review_spec.rb
 - spec/rails_best_practices/reviews/move_model_logic_into_model_review_spec.rb
 - spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb
-- spec/rails_best_practices/reviews/not_rescue_exception_spec.rb
+- spec/rails_best_practices/reviews/not_rescue_exception_review_spec.rb
 - spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb
-- spec/rails_best_practices/reviews/not_use_times_ago_in_words_review_spec.rb
+- spec/rails_best_practices/reviews/not_use_time_ago_in_words_review_spec.rb
 - spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb
 - spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb
 - spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
@@ -490,7 +490,7 @@ test_files:
 - spec/rails_best_practices/reviews/use_model_association_review_spec.rb
 - spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb
 - spec/rails_best_practices/reviews/use_observer_review_spec.rb
-- spec/rails_best_practices/reviews/use_parenthesis_in_method_def_spec.rb
+- spec/rails_best_practices/reviews/use_parentheses_in_method_def_review_spec.rb
 - spec/rails_best_practices/reviews/use_query_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/use_say_with_time_in_migrations_review_spec.rb
 - spec/rails_best_practices/reviews/use_scope_access_review_spec.rb