rails_best_practices 1.19.3 → 1.19.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a366fcb2bd3097eb1afcc7fa940b233a4177c6d
-  data.tar.gz: 45c9b324f42e0974e7314c1db9e634c782665e93
+  metadata.gz: 5465e0c3226433bf68485822ab52b54993f334c4
+  data.tar.gz: 05650ce6bef4b2c0bd89ac24401d3119c708313f
 SHA512:
-  metadata.gz: fa6aed2c8549d66e9650e456787a57cc32fb052011506e10cdc94ee43803d2016d644ec4e0aae1d9b08d583abb5d2eab7c4dd26eb8754e60bac46a02f8ad4459
-  data.tar.gz: 5558cb09e7a4a4f38af75078762d3dba880bd29a97ea2ba743df3e20edf8ca51a0fd3f440808f29043b8d00d99503257de3e18849ea3d6d355930728dd9187f6
+  metadata.gz: 514d93fb5333c09d93b65838aeaa3942d693c1e8c1e7b7bf388d198c5b2aca36be0820a97abf29825ef4e127233d1af0d7b911f3968f54e388530cc3e19c08f7
+  data.tar.gz: f502d73f187def721cbcb7df9c09fc2652b23cdd80f082b96a6301d1a3733f0dceafe0dd1c8c87dd089fcf678761c36aa7f81431908c44f2b9eb2b14a7014858

data/.gitignore

@@ -1,6 +1,5 @@
 .DS_STORE
 .*.swp
-Gemfile.lock
 pkg/**
 *.gem
 .bundle

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Next Release
 
+## 1.19.4
+
+* Add cli class
+
 ## 1.19.3
 
 * Fix false positive remove unused method for around_action in

data/Gemfile

@@ -3,10 +3,6 @@ gemspec
 
 gem 'coveralls', require: false
 
-if RUBY_PLATFORM =~ /darwin/i
-  gem 'growl'
-  gem 'rb-fsevent'
-end
 gem 'guard'
 gem 'guard-rspec'
 gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    rails_best_practices (1.19.4)
+      activesupport
+      code_analyzer (>= 0.4.8)
+      erubis
+      i18n
+      json
+      require_all (~> 2.0)
+      ruby-progressbar
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.6.1)
+    code_analyzer (0.4.8)
+      sexp_processor
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.11)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    haml (4.0.7)
+      tilt
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    require_all (2.0.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    ruby-progressbar (1.10.0)
+    sexp_processor (4.10.1)
+    shellany (0.0.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slim (3.0.6)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    slop (3.6.0)
+    temple (0.7.6)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.6)
+    tilt (2.0.2)
+    tins (1.6.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  coveralls
+  guard
+  guard-rspec
+  haml
+  pry
+  rails_best_practices!
+  rake (< 11.0)
+  rspec (~> 2.14.0)
+  slim
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/rails_best_practices.svg)](http://badge.fury.io/rb/rails_best_practices)
 [![Build Status](https://secure.travis-ci.org/flyerhzm/rails_best_practices.svg)](http://travis-ci.org/flyerhzm/rails_best_practices)
 [![Coverage Status](https://coveralls.io/repos/railsbp/rails_best_practices/badge.svg?branch=master)](https://coveralls.io/r/railsbp/rails_best_practices)
-[![AwesomeCode Status for flyerhzm/rails_best_practices](https://awesomecode.io/projects/d02ecd70-e068-4ad4-b61a-7003ac24b49a/status)](https://awesomecode.io/projects/8)
+[![AwesomeCode Status for flyerhzm/rails_best_practices](https://awesomecode.io/projects/d02ecd70-e068-4ad4-b61a-7003ac24b49a/status)](https://awesomecode.io/repos/flyerhzm/rails_best_practices)
 
 [![Coderwall Endorse](http://api.coderwall.com/flyerhzm/endorsecount.png)](http://coderwall.com/flyerhzm)
 [![Click here to lend your support to: rails best practices and make a donation at www.pledgie.com !](https://pledgie.com/campaigns/12057.png?skin_name=chrome)](https://pledgie.com/campaigns/12057)
@@ -182,6 +182,9 @@ Now you can customize this configuration file. The default configuration is as f
     UseScopeAccessCheck: { }
     UseTurboSprocketsRails3Check: { }
 
+Now, at the root directory of a Rails app, run:
+
+    rails_best_practices . -c config/rails_best_practices.yml
 
 You can remove or comment a review to disable it, and you can change the options.
 

data/lib/rails_best_practices.rb

@@ -8,6 +8,8 @@ require 'rails_best_practices/analyzer'
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'
+require 'rails_best_practices/option_parser'
+require 'rails_best_practices/cli'
 
 module RailsBestPractices
 end

data/lib/rails_best_practices/analyzer.rb

@@ -19,7 +19,7 @@ module RailsBestPractices
     attr_reader :path
 
     DEFAULT_CONFIG = File.join(File.dirname(__FILE__), '..', '..', 'rails_best_practices.yml')
-    GITHUB_URL = 'https://github.com/'.freeze
+    GITHUB_URL = 'https://github.com/'
 
     # initialize
     #
@@ -137,14 +137,15 @@ module RailsBestPractices
     def expand_dirs_to_files(*dirs)
       extensions = %w[rb erb rake rhtml haml slim builder rxml rabl]
 
-      dirs.flatten.map { |entry|
+      dirs.flatten.map do |entry|
         next unless File.exist? entry
+
         if File.directory? entry
           Dir[File.join(entry, '**', "*.{#{extensions.join(',')}}")]
         else
           entry
         end
-      }.flatten
+      end.flatten
     end
 
     # sort files, models first, mailers, helpers, and then sort other files by characters.
@@ -226,7 +227,7 @@ module RailsBestPractices
       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
+        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

data/lib/rails_best_practices/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBestPractices
+  class CLI
+    # Run analyze with ruby code
+    # @param [Array] argv command argments
+    # @return [Boolean] return true, if there is no violation.
+    # @example
+    #   RailsBestPractices::CLI.run(['-d', '-o', 'path/to/file'])
+    def self.run(argv)
+      options = OptionParser.parse!(argv)
+      if !argv.empty? && !File.exist?(argv.first)
+        raise Errno::ENOENT, "#{argv.first} doesn't exist"
+      end
+
+      analyzer = Analyzer.new(argv.first, options)
+      analyzer.analyze
+      analyzer.output
+      analyzer.runner.errors.empty?
+    end
+  end
+end

data/lib/rails_best_practices/command.rb

@@ -1,137 +1,7 @@
 # frozen_string_literal: true
 
 require 'optparse'
-
-# Usage: rails_best_practices [options] path
-#    -d, --debug                      debug mode
-#        --silent                     silent mode
-#    -f, --format FORMAT              output format (text, html, yml, json, xml)
-#        --output-file FILE           output html file for the analyzing result
-#        --without-color              only output plain text without color
-#        --with-textmate              open file by textmate in html format
-#        --with-sublime               open file by sublime in html format (requires subl-handler)
-#        --with-mvim                  open file by mvim in html format
-#        --with-github GITHUB_NAME    open file on github in html format, GITHUB_NAME is like railsbp/rails-bestpractices.com
-#        --with-git                   display git commit and username, only support html format
-#        --with-hg                    display hg commit and username, only support html format
-#        --template TEMPLATE          customize erb template
-#        --vendor                     include vendor files
-#        --spec                       include spec files
-#        --test                       include test files
-#        --features                   include features files
-#    -x, --exclude PATTERNS           don't analyze files matching a pattern
-#                                     (comma-separated regexp list)
-#    -o, --only PATTERNS              analyze files only matching a pattern
-#                                     (comma-separated regexp list)
-#    -g, --generate                   generate configuration yaml
-#    -v, --version                    show this version
-#    -h, --help                       show this message
-
-options = {}
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: rails_best_practices [options] path'
-
-  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
-  end
-
-  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
-  end
-
-  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
-  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
-  end
-
-  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
-  end
-
-  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
-  end
-
-  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
-  end
-
-  %w[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'
-    puts RailsBestPractices::VERSION
-    exit
-  end
-
-  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|
-    begin
-      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|
-    begin
-      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
-  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
-
+options = RailsBestPractices::OptionParser.parse!
 if !ARGV.empty? && !File.exist?(ARGV.first)
   puts "#{ARGV.first} doesn't exist"
   exit 1

data/lib/rails_best_practices/core/check.rb

@@ -240,7 +240,7 @@ module RailsBestPractices
               else
                 mark_used(node.message)
                 last_argument = node.arguments.all.last
-                if last_argument.present? && :bare_assoc_hash == last_argument.sexp_type
+                if last_argument.present? && last_argument.sexp_type == :bare_assoc_hash
                   last_argument.hash_values.each { |argument_value| mark_used(argument_value) }
                 end
               end
@@ -283,27 +283,28 @@ module RailsBestPractices
 
             private
 
-              def mark_used(method_node)
-                return if method_node == :call
-                if :bare_assoc_hash == method_node.sexp_type
-                  method_node.hash_values.each { |value_node| mark_used(value_node) }
-                elsif :array == method_node.sexp_type
-                  method_node.array_values.each { |value_node| mark_used(value_node) }
-                else
-                  method_name = method_node.to_s
-                end
-                call_method(method_name)
+            def mark_used(method_node)
+              return if method_node == :call
+
+              if method_node.sexp_type == :bare_assoc_hash
+                method_node.hash_values.each { |value_node| mark_used(value_node) }
+              elsif method_node.sexp_type == :array
+                method_node.array_values.each { |value_node| mark_used(value_node) }
+              else
+                method_name = method_node.to_s
               end
+              call_method(method_name)
+            end
 
-              def call_method(method_name, class_name = nil)
-                class_name ||= respond_to?(:current_class_name) ? current_class_name : current_module_name
-                if methods.has_method?(class_name, method_name)
-                  methods.get_method(class_name, method_name).mark_used
-                end
-                methods.mark_parent_class_method_used(class_name, method_name)
-                methods.mark_subclasses_method_used(class_name, method_name)
-                methods.possible_public_used(method_name)
+            def call_method(method_name, class_name = nil)
+              class_name ||= respond_to?(:current_class_name) ? current_class_name : current_module_name
+              if methods.has_method?(class_name, method_name)
+                methods.get_method(class_name, method_name).mark_used
               end
+              methods.mark_parent_class_method_used(class_name, method_name)
+              methods.mark_subclasses_method_used(class_name, method_name)
+              methods.possible_public_used(method_name)
+            end
           end
         end
       end
@@ -317,21 +318,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 current_extend_class_name == 'InheritedResources::Base'
                 @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 node.to_s == 'inherit_resources'
                 @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 node.to_s == 'inherit_resources'
                 @inherited_resources = true
               end
             end
@@ -350,7 +351,7 @@ module RailsBestPractices
             # check if the method is in the except methods list.
             def excepted?(method)
               is_ignored?(method.file) ||
-              except_methods.any? { |except_method| Exceptable.matches method, except_method }
+                except_methods.any? { |except_method| Exceptable.matches method, except_method }
             end
 
             def internal_except_methods