rails_best_practices 1.19.0 → 1.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a21a8ed1b2556fb543a2e0198c20cc0e1717408c
-  data.tar.gz: 5590f1f768fbe89156474a9b6c6e2d3876f0ab7b
+  metadata.gz: 0107d87cb5888b9ef62445563d9af1328cbc9761
+  data.tar.gz: 26ff059e4a7437ee9606afbd2c200d27615283fb
 SHA512:
-  metadata.gz: 9ade021d411ca4b45c36628ba5a9bed899b0ffcde8b5ca7289171c08aa2493b5c9a04cad2af7758cb50a0f8fdae1f9b5ec4d40396a97145a33d7b32c7630ea82
-  data.tar.gz: 4ac6bfab4420bac0d7476b2694123fa43d21eb5936a85bdea86f0cb3a17e86d308efac99927aa5325d467bc4bb4b1d6e4c41b7d67405198491add9ee63bf60dc
+  metadata.gz: 921598700949438fd5975a90e2091112a2c5296ddf14a11560f7b391a20c7cc6936c875e399327924990128944bdae455bd3311ffcf0473d0bcc4b8f40388719
+  data.tar.gz: 50585713ae56c85ee34c38c19c9b4cb13e0fe8e55a2f328b5f3609226ce77680dfc783edccde4614cd48658497161be5bf45c6ac76c863eb28ff2be93be92dc1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+## 1.19.1
+
+* Add table_name and module_prefix to model ignored methods
+* Forcing requrie_all version
+
 ## 1.19.0 (2017-07-26)
 
 * RestrictAutoGeneratedRoutesCheck is compatibale with rails api_only

data/Guardfile

@@ -1,8 +1,8 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2, :all_after_pass => false, :all_on_start => false, :cli => "--color --format nested --fail-fast" do
+guard 'rspec', :version => 2, :all_after_pass => false, :all_on_start => false, :cli => '--color --format nested --fail-fast' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/Rakefile

@@ -1,17 +1,17 @@
-require "bundler"
-require "bundler/gem_tasks"
+require 'bundler'
+require 'bundler/gem_tasks'
 
 Bundler.setup
 
-require "rake"
-require "rspec"
-require "rspec/core/rake_task"
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
 
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "rails_best_practices/version"
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rails_best_practices/version'
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
 task :default => :spec

data/bin/rails_best_practices

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

data/lib/rails_best_practices/analyzer.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
     attr_accessor :runner
     attr_reader :path
 
-    DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "rails_best_practices.yml")
+    DEFAULT_CONFIG = File.join(File.dirname(__FILE__), '..', '..', 'rails_best_practices.yml')
     GITHUB_URL = 'https://github.com/'
 
     # initialize
@@ -25,11 +25,11 @@ module RailsBestPractices
     # @param [String] path where to generate the configuration yaml file
     # @param [Hash] options
     def initialize(path, options = {})
-      @path = File.expand_path(path || ".")
+      @path = File.expand_path(path || '.')
 
       @options = options
-      @options["exclude"] ||= []
-      @options["only"] ||= []
+      @options['exclude'] ||= []
+      @options['only'] ||= []
     end
 
     # generate configuration yaml file.
@@ -59,18 +59,18 @@ module RailsBestPractices
 
     # Output the analyze result.
     def output
-      case @options["format"]
-      when "html"
-        @options["output-file"] ||= "rails_best_practices_output.html"
+      case @options['format']
+      when 'html'
+        @options['output-file'] ||= 'rails_best_practices_output.html'
         output_html_errors
-      when "json"
-        @options["output-file"] ||= "rails_best_practices_output.json"
+      when 'json'
+        @options['output-file'] ||= 'rails_best_practices_output.json'
         output_json_errors
-      when "yaml"
-        @options["output-file"] ||= "rails_best_practices_output.yaml"
+      when 'yaml'
+        @options['output-file'] ||= 'rails_best_practices_output.yaml'
         output_yaml_errors
-      when "xml"
-        @options["output-file"] ||= "rails_best_practices_output.xml"
+      when 'xml'
+        @options['output-file'] ||= 'rails_best_practices_output.xml'
         output_xml_errors
       else
         output_terminal_errors
@@ -86,10 +86,10 @@ module RailsBestPractices
     def process(process)
       parse_files.each do |file|
         begin
-          puts file if @options["debug"]
+          puts file if @options['debug']
           @runner.send(process, file, File.read(file))
         rescue
-          if @options["debug"]
+          if @options['debug']
             warning = "#{file} looks like it's not a valid Ruby file.  Skipping..."
             plain_output(warning, 'red')
           end
@@ -107,17 +107,17 @@ module RailsBestPractices
         files = expand_dirs_to_files(@path)
         files = file_sort(files)
 
-        if @options["only"].present?
-          files = file_accept(files, @options["only"])
+        if @options['only'].present?
+          files = file_accept(files, @options['only'])
         end
 
         # By default, tmp, vender, spec, test, features are ignored.
-        ["vendor", "spec", "test", "features", "tmp"].each do |dir|
+        ['vendor', 'spec', 'test', 'features', 'tmp'].each do |dir|
           files = file_ignore(files, File.join(@path, dir)) unless @options[dir]
         end
 
         # Exclude files based on exclude regexes if the option is set.
-        @options["exclude"].each do |pattern|
+        @options['exclude'].each do |pattern|
           files = file_ignore(files, pattern)
         end
 
@@ -192,8 +192,8 @@ module RailsBestPractices
     def load_hg_info
       hg_progressbar = ProgressBar.create(:title => 'Hg Info', :total => errors.size) if display_bar?
       errors.each do |error|
-        hg_info = `cd #{@runner.class.base_path} && hg blame -lvcu #{error.filename[@runner.class.base_path.size..-1].gsub(/^\//, "")} | sed -n /:#{error.line_number.split(',').first}:/p`
-        unless hg_info == ""
+        hg_info = `cd #{@runner.class.base_path} && hg blame -lvcu #{error.filename[@runner.class.base_path.size..-1].gsub(/^\//, '')} | sed -n /:#{error.line_number.split(',').first}:/p`
+        unless hg_info == ''
           hg_commit_username = hg_info.split(':')[0].strip
           error.hg_username = hg_commit_username.split(/\ /)[0..-2].join(' ')
           error.hg_commit = hg_commit_username.split(/\ /)[-1]
@@ -209,9 +209,9 @@ module RailsBestPractices
       start = @runner.class.base_path =~ /\/$/ ? @runner.class.base_path.size : @runner.class.base_path.size + 1
       errors.each do |error|
         git_info = `cd #{@runner.class.base_path} && git blame -L #{error.line_number.split(',').first},+1 #{error.filename[start..-1]}`
-        unless git_info == ""
-          git_commit, git_username = git_info.split(/\d{4}-\d{2}-\d{2}/).first.split("(")
-          error.git_commit = git_commit.split(" ").first.strip
+        unless git_info == ''
+          git_commit, git_username = git_info.split(/\d{4}-\d{2}-\d{2}/).first.split('(')
+          error.git_commit = git_commit.split(' ').first.strip
           error.git_username = git_username.strip
         end
         git_progressbar.increment if display_bar?
@@ -222,27 +222,27 @@ module RailsBestPractices
     # output errors with html format.
     def output_html_errors
       require 'erubis'
-      template = @options["template"] ? File.read(File.expand_path(@options["template"])) : File.read(File.join(File.dirname(__FILE__), "..", "..", "assets", "result.html.erb"))
+      template = @options['template'] ? File.read(File.expand_path(@options['template'])) : File.read(File.join(File.dirname(__FILE__), '..', '..', 'assets', 'result.html.erb'))
 
-      if @options["with-github"]
-        last_commit_id = @options["last-commit-id"] ? @options["last-commit-id"] : `cd #{@runner.class.base_path} && git rev-parse HEAD`.chomp
-        unless @options["github-name"].start_with?('https')
-          @options["github-name"] = GITHUB_URL + @options["github-name"]
+      if @options['with-github']
+        last_commit_id = @options['last-commit-id'] ? @options['last-commit-id'] : `cd #{@runner.class.base_path} && git rev-parse HEAD`.chomp
+        unless @options['github-name'].start_with?('https')
+          @options['github-name'] = GITHUB_URL + @options['github-name']
         end
       end
-      File.open(@options["output-file"], "w+") do |file|
+      File.open(@options['output-file'], 'w+') do |file|
         eruby = Erubis::Eruby.new(template)
         file.puts eruby.evaluate(
           errors: errors,
           error_types: error_types,
-          textmate: @options["with-textmate"],
-          sublime: @options["with-sublime"],
-          mvim: @options["with-mvim"],
-          github: @options["with-github"],
-          github_name: @options["github-name"],
+          textmate: @options['with-textmate'],
+          sublime: @options['with-sublime'],
+          mvim: @options['with-mvim'],
+          github: @options['with-github'],
+          github_name: @options['github-name'],
           last_commit_id: last_commit_id,
-          git: @options["with-git"],
-          hg: @options["with-hg"]
+          git: @options['with-git'],
+          hg: @options['with-hg']
         )
       end
     end
@@ -272,14 +272,14 @@ module RailsBestPractices
       end
 
       formatter = REXML::Formatters::Default.new
-      File.open(@options["output-file"], 'w+') do |result|
+      File.open(@options['output-file'], 'w+') do |result|
         formatter.write(document, result)
       end
     end
 
     # output errors with yaml format.
     def output_yaml_errors
-      File.open(@options["output-file"], "w+") do |file|
+      File.open(@options['output-file'], 'w+') do |file|
         file.write YAML.dump(errors)
       end
     end
@@ -294,7 +294,7 @@ module RailsBestPractices
         }
       end
 
-      File.open(@options["output-file"], "w+") do |file|
+      File.open(@options['output-file'], 'w+') do |file|
         file.write JSON.dump(errors_as_hashes)
       end
     end
@@ -304,7 +304,7 @@ module RailsBestPractices
     # @param [String] message to output
     # @param [String] color
     def plain_output(message, color)
-      if @options["without-color"]
+      if @options['without-color']
         puts message
       else
         puts Colorize.send(color, message)
@@ -314,19 +314,19 @@ module RailsBestPractices
     # analyze source codes.
     def analyze_source_codes
       @bar = ProgressBar.create(:title => 'Source Code', :total => parse_files.size * 3) if display_bar?
-      ["lexical", "prepare", "review"].each { |process| send(:process, process) }
+      ['lexical', 'prepare', 'review'].each { |process| send(:process, process) }
       @bar.finish if display_bar?
     end
 
     # analyze version control system info.
     def analyze_vcs
-      load_git_info if @options["with-git"]
-      load_hg_info if @options["with-hg"]
+      load_git_info if @options['with-git']
+      load_hg_info if @options['with-hg']
     end
 
     # if disaply progress bar.
     def display_bar?
-      !@options["debug"] && !@options["silent"]
+      !@options['debug'] && !@options['silent']
     end
 
     # unique error types.

data/lib/rails_best_practices/command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require "optparse"
+require 'optparse'
 
 # Usage: rails_best_practices [options] path
 #    -d, --debug                      debug mode
@@ -29,96 +29,96 @@ require "optparse"
 options = {}
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: rails_best_practices [options] path"
+  opts.banner = 'Usage: rails_best_practices [options] path'
 
-  opts.on("-d", "--debug", "Debug mode") do
-    options["debug"] = true
+  opts.on('-d', '--debug', 'Debug mode') do
+    options['debug'] = true
   end
 
-  opts.on("-f", "--format FORMAT", "output format (text, html, yml, json, xml)") do |format|
-    options["format"] = format
+  opts.on('-f', '--format FORMAT', 'output format (text, html, yml, json, xml)') do |format|
+    options['format'] = format
   end
 
-  opts.on("--without-color", "only output plain text without color") do
-    options["without-color"] = true
+  opts.on('--without-color', 'only output plain text without color') do
+    options['without-color'] = true
   end
 
-  opts.on("--with-textmate", "open file by textmate in html format") do
-    options["with-textmate"] = true
+  opts.on('--with-textmate', 'open file by textmate in html format') do
+    options['with-textmate'] = true
   end
 
-  opts.on("--with-sublime", "open file by sublime in html format") do
-    options["with-sublime"] = true
+  opts.on('--with-sublime', 'open file by sublime in html format') do
+    options['with-sublime'] = true
   end
 
-  opts.on("--with-mvim", "open file by mvim in html format") do
-    options["with-mvim"] = true
+  opts.on('--with-mvim', 'open file by mvim in html format') do
+    options['with-mvim'] = true
   end
 
-  opts.on("--with-github GITHUB_NAME", "open file on github in html format") do |github_name|
-    options["with-github"] = true
-    options["github-name"] = github_name
+  opts.on('--with-github GITHUB_NAME', 'open file on github in html format') do |github_name|
+    options['with-github'] = true
+    options['github-name'] = github_name
   end
 
-  opts.on("--last-commit-id COMMIT_ID", "last commit id") do |commit_id|
-    options["last-commit-id"] = commit_id
+  opts.on('--last-commit-id COMMIT_ID', 'last commit id') do |commit_id|
+    options['last-commit-id'] = commit_id
   end
 
-  opts.on("--with-hg", "display hg commit and username, only support html format") do
-    options["with-hg"] = true
+  opts.on('--with-hg', 'display hg commit and username, only support html format') do
+    options['with-hg'] = true
   end
 
-  opts.on("--with-git", "display git commit and username, only support html format") do
-    options["with-git"] = true
+  opts.on('--with-git', 'display git commit and username, only support html format') do
+    options['with-git'] = true
   end
 
-  opts.on("--template TEMPLATE", "customize erb template") do |template|
-    options["template"] = template
+  opts.on('--template TEMPLATE', 'customize erb template') do |template|
+    options['template'] = template
   end
 
-  opts.on("--output-file OUTPUT_FILE", "output html file for the analyzing result") do |output_file|
-    options["output-file"] = output_file
+  opts.on('--output-file OUTPUT_FILE', 'output html file for the analyzing result') do |output_file|
+    options['output-file'] = output_file
   end
 
-  opts.on("--silent", "silent mode") do
-    options["silent"] = true
+  opts.on('--silent', 'silent mode') do
+    options['silent'] = true
   end
 
-  ["vendor", "spec", "test", "features"].each do |pattern|
+  ['vendor', 'spec', 'test', 'features'].each do |pattern|
     opts.on("--#{pattern}", "include #{pattern} files") do
       options[pattern] = true
     end
   end
 
-  opts.on_tail("-v", "--version", "Show this version") do
-    require "rails_best_practices/version"
+  opts.on_tail('-v', '--version', 'Show this version') do
+    require 'rails_best_practices/version'
     puts RailsBestPractices::VERSION
     exit
   end
 
-  opts.on_tail("-h", "--help", "Show this message") do
+  opts.on_tail('-h', '--help', 'Show this message') do
     puts opts
     exit
   end
 
-  opts.on("-x", "--exclude PATTERNS", "Don't analyze files matching a pattern", "(comma-separated regexp list)") do |list|
+  opts.on('-x', '--exclude PATTERNS', "Don't analyze files matching a pattern", '(comma-separated regexp list)') do |list|
     begin
-      options["exclude"] = list.split(",").map{|x| Regexp.new x}
+      options['exclude'] = list.split(',').map{|x| Regexp.new x}
     rescue RegexpError => e
       raise OptionParser::InvalidArgument, e.message
     end
   end
 
-  opts.on("-o", "--only PATTERNS", "Analyze files only matching a pattern", "(comma-separated regexp list)") do |list|
+  opts.on('-o', '--only PATTERNS', 'Analyze files only matching a pattern', '(comma-separated regexp list)') do |list|
     begin
-      options["only"] = list.split(",").map { |x| Regexp.new x }
+      options['only'] = list.split(',').map { |x| Regexp.new x }
     rescue RegexpError => e
       raise OptionParser::InvalidArgument e.message
     end
   end
 
-  opts.on("-g", "--generate", "Generate configuration yaml") do
-    options["generate"] = true
+  opts.on('-g', '--generate', 'Generate configuration yaml') do
+    options['generate'] = true
   end
 
   opts.on(
@@ -136,7 +136,7 @@ if ARGV.size > 0 && !File.exists?(ARGV.first)
   exit 1
 end
 
-if options["generate"]
+if options['generate']
   RailsBestPractices::Analyzer.new(ARGV.first).generate
 else
   analyzer = RailsBestPractices::Analyzer.new(ARGV.first, options)

data/lib/rails_best_practices/core/check.rb

@@ -183,7 +183,7 @@ module RailsBestPractices
 
         # get the current module name.
         def current_module_name
-          moduleable_modules.join("::")
+          moduleable_modules.join('::')
         end
 
         # modules.
@@ -229,9 +229,9 @@ module RailsBestPractices
               case node.message.to_s
               when *skip_command_callback_nodes
                 # nothing
-              when "alias_method"
+              when 'alias_method'
                 mark_used(node.arguments.all[1])
-              when "alias_method_chain"
+              when 'alias_method_chain'
                 method, feature = *node.arguments.all.map(&:to_s)
                 call_method("#{method}_with_#{feature}")
               when /^(before|after)_/
@@ -261,17 +261,17 @@ module RailsBestPractices
             #       super options.merge(exclude: :visible, methods: [:is_discussion_conversation])
             #     end
             add_callback :start_bare_assoc_hash do |node|
-              if node.hash_keys.include? "methods"
-                mark_used(node.hash_value("methods"))
+              if node.hash_keys.include? 'methods'
+                mark_used(node.hash_value('methods'))
               end
             end
 
             # remember the first argument for try and send method.
             add_callback :start_method_add_arg do |node|
               case node.message.to_s
-              when "try"
+              when 'try'
                 mark_used(node.arguments.all.first)
-              when "send"
+              when 'send'
                 if [:symbol_literal, :string_literal].include?(node.arguments.all.first.sexp_type)
                   mark_used(node.arguments.all.first)
                 end
@@ -315,21 +315,21 @@ module RailsBestPractices
 
             # check if the controller is inherit from InheritedResources::Base.
             add_callback :start_class do |node|
-              if "InheritedResources::Base" == current_extend_class_name
+              if 'InheritedResources::Base' == current_extend_class_name
                 @inherited_resources = true
               end
             end
 
             # check if there is a DSL call inherit_resources.
             add_callback :start_var_ref do |node|
-              if "inherit_resources" == node.to_s
+              if 'inherit_resources' == node.to_s
                 @inherited_resources = true
               end
             end
 
             # check if there is a DSL call inherit_resources.
             add_callback :start_vcall do |node|
-              if "inherit_resources" == node.to_s
+              if 'inherit_resources' == node.to_s
                 @inherited_resources = true
               end
             end
@@ -352,7 +352,7 @@ module RailsBestPractices
             end
 
             def internal_except_methods
-              raise NoMethodError.new "no method internal_except_methods"
+              raise NoMethodError.new 'no method internal_except_methods'
             end
           end
         end
@@ -360,12 +360,12 @@ module RailsBestPractices
         def self.matches method, except_method
           class_name, method_name = except_method.split('#')
 
-          method_name = ".*" if method_name == "*"
+          method_name = '.*' if method_name == '*'
           method_expression = Regexp.new method_name
           matched = method.method_name =~ method_expression
 
           if matched
-            class_name = ".*" if class_name == "*"
+            class_name = '.*' if class_name == '*'
             class_expression = Regexp.new class_name
 
             class_names = Prepares.klasses
@@ -403,12 +403,12 @@ module RailsBestPractices
 
             # set access control to "public" by default.
             add_callback :start_class do |node|
-              @access_control = "public"
+              @access_control = 'public'
             end
 
             # set access control to "public" by default.
             add_callback :start_module do |node|
-              @access_control = "public"
+              @access_control = 'public'
             end
           end