rails_best_practices 1.19.1 → 1.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0107d87cb5888b9ef62445563d9af1328cbc9761
-  data.tar.gz: 26ff059e4a7437ee9606afbd2c200d27615283fb
+  metadata.gz: e41de74a9e0a16b8a3b3feb2fb709f21aec80098
+  data.tar.gz: 98f10516376d7de5d3144b767196aa952b274748
 SHA512:
-  metadata.gz: 921598700949438fd5975a90e2091112a2c5296ddf14a11560f7b391a20c7cc6936c875e399327924990128944bdae455bd3311ffcf0473d0bcc4b8f40388719
-  data.tar.gz: 50585713ae56c85ee34c38c19c9b4cb13e0fe8e55a2f328b5f3609226ce77680dfc783edccde4614cd48658497161be5bf45c6ac76c863eb28ff2be93be92dc1
+  metadata.gz: 21e177d13d0f2137aebe7d683e87af1b97d53046e53b6bbd4722ae943a1061c5c6f740dee8efe9bc713c0be4550b70016849e17033faa6fd17e33a1204645963
+  data.tar.gz: 81473ba0611d37c8a4a005710983330d0aa6a8c4537ba976e71d93bc670f8ef4fda1d492a44fe1966d2dc0bd91452460ade65f250f252238c187bbe9064e5935

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+## 1.19.2
+
+* Integrate with awesomecode.io
+* Update to require_all 2.x
+
 ## 1.19.1
 
 * Add table_name and module_prefix to model ignored methods

data/Guardfile

@@ -1,7 +1,7 @@
 # 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' }

data/README.md

@@ -3,6 +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)
 
 [![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)

data/Rakefile

@@ -14,5 +14,5 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/bin/rails_best_practices

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

data/lib/rails_best_practices.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'code_analyzer'
 require 'require_all'
 require 'rails_best_practices/core'

data/lib/rails_best_practices/analyzer.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'json'
 require 'ruby-progressbar'
@@ -18,7 +19,7 @@ module RailsBestPractices
     attr_reader :path
 
     DEFAULT_CONFIG = File.join(File.dirname(__FILE__), '..', '..', 'rails_best_practices.yml')
-    GITHUB_URL = 'https://github.com/'
+    GITHUB_URL = 'https://github.com/'.freeze
 
     # initialize
     #
@@ -88,7 +89,7 @@ module RailsBestPractices
         begin
           puts file if @options['debug']
           @runner.send(process, file, File.read(file))
-        rescue
+        rescue StandardError
           if @options['debug']
             warning = "#{file} looks like it's not a valid Ruby file.  Skipping..."
             plain_output(warning, 'red')
@@ -112,7 +113,7 @@ module RailsBestPractices
         end
 
         # By default, tmp, vender, spec, test, features are ignored.
-        ['vendor', 'spec', 'test', 'features', 'tmp'].each do |dir|
+        %w[vendor spec test features tmp].each do |dir|
           files = file_ignore(files, File.join(@path, dir)) unless @options[dir]
         end
 
@@ -121,7 +122,7 @@ module RailsBestPractices
           files = file_ignore(files, pattern)
         end
 
-        %w(Capfile Gemfile Gemfile.lock).each do |file|
+        %w[Capfile Gemfile Gemfile.lock].each do |file|
           files.unshift File.join(@path, file)
         end
 
@@ -134,7 +135,7 @@ module RailsBestPractices
     # @param [Array] dirs what directories to expand
     # @return [Array] all files expanded
     def expand_dirs_to_files(*dirs)
-      extensions = ['rb', 'erb', 'rake', 'rhtml', 'haml', 'slim', 'builder', 'rxml', 'rabl']
+      extensions = %w[rb erb rake rhtml haml slim builder rxml rabl]
 
       dirs.flatten.map { |entry|
         next unless File.exist? entry
@@ -157,7 +158,7 @@ module RailsBestPractices
       mailers = files.find_all { |file| file =~ Core::Check::MAILER_FILES }
       helpers = files.find_all { |file| file =~ Core::Check::HELPER_FILES }
       others = files.find_all { |file| file !~ Core::Check::MAILER_FILES && file !~ Core::Check::MODEL_FILES && file !~ Core::Check::HELPER_FILES }
-      return models + mailers + helpers + others
+      models + mailers + helpers + others
     end
 
     # ignore specific files.
@@ -174,7 +175,7 @@ module RailsBestPractices
     # @param [Array] files
     # @param [Regexp] patterns, files match any pattern will be accepted
     def file_accept(files, patterns)
-      files.reject { |file| !patterns.any? { |pattern| file =~ pattern } }
+      files.select { |file| patterns.any? { |pattern| file =~ pattern } }
     end
 
     # output errors on terminal.
@@ -190,7 +191,7 @@ module RailsBestPractices
 
     # load hg commit and hg username info.
     def load_hg_info
-      hg_progressbar = ProgressBar.create(:title => 'Hg Info', :total => errors.size) if display_bar?
+      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 == ''
@@ -205,7 +206,7 @@ module RailsBestPractices
 
     # load git commit and git username info.
     def load_git_info
-      git_progressbar = ProgressBar.create(:title => 'Git Info', :total => errors.size) if display_bar?
+      git_progressbar = ProgressBar.create(title: 'Git Info', total: errors.size) if display_bar?
       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]}`
@@ -313,8 +314,8 @@ 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) }
+      @bar = ProgressBar.create(title: 'Source Code', total: parse_files.size * 3) if display_bar?
+      %w[lexical prepare review].each { |process| send(:process, process) }
       @bar.finish if display_bar?
     end
 

data/lib/rails_best_practices/colorize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsBestPractices
   class Colorize
     def self.red(message)

data/lib/rails_best_practices/command.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'optparse'
 
 # Usage: rails_best_practices [options] path
@@ -84,7 +85,7 @@ OptionParser.new do |opts|
     options['silent'] = true
   end
 
-  ['vendor', 'spec', 'test', 'features'].each do |pattern|
+  %w[vendor spec test features].each do |pattern|
     opts.on("--#{pattern}", "include #{pattern} files") do
       options[pattern] = true
     end
@@ -103,7 +104,7 @@ OptionParser.new do |opts|
 
   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
@@ -131,7 +132,7 @@ OptionParser.new do |opts|
   opts.parse!
 end
 
-if ARGV.size > 0 && !File.exists?(ARGV.first)
+if !ARGV.empty? && !File.exist?(ARGV.first)
   puts "#{ARGV.first} doesn't exist"
   exit 1
 end
@@ -142,5 +143,5 @@ else
   analyzer = RailsBestPractices::Analyzer.new(ARGV.first, options)
   analyzer.analyze
   analyzer.output
-  exit analyzer.runner.errors.size > 0 ? 1 : 0
+  exit !analyzer.runner.errors.empty? ? 1 : 0
 end

data/lib/rails_best_practices/core.rb

@@ -1,3 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require_rel 'core'
 require_rel 'core_ext'

data/lib/rails_best_practices/core/check.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # A Check class that takes charge of checking the sexp.
@@ -21,7 +22,7 @@ module RailsBestPractices
 
       SKIP_FILES = /db\/schema.rb/
 
-      def initialize(options={})
+      def initialize(options = {})
         options.each do |key, value|
           instance_variable_set("@#{key}", value)
         end
@@ -46,11 +47,11 @@ module RailsBestPractices
       end
 
       def is_ignored?(node_file)
-        regex_ignored_files.map{ |r| !!r.match(node_file) }.inject(:|)
+        regex_ignored_files.map { |r| !!r.match(node_file) }.inject(:|)
       end
 
       def regex_ignored_files
-        @regex_ignored_files ||= Array(@ignored_files).map{ |pattern| Regexp.new(pattern) }
+        @regex_ignored_files ||= Array(@ignored_files).map { |pattern| Regexp.new(pattern) }
       end
 
       # add error if source code violates rails best practice.
@@ -99,7 +100,7 @@ module RailsBestPractices
       end
 
       class <<self
-        def url(url=nil)
+        def url(url = nil)
           url ?  @url = url : @url
         end
 
@@ -124,7 +125,7 @@ module RailsBestPractices
             end
 
             # end of the module.
-            add_callback :end_module do |node|
+            add_callback :end_module do |_node|
               classable_modules.pop
             end
 
@@ -136,7 +137,7 @@ module RailsBestPractices
             end
 
             # end of the class
-            add_callback :end_class do |node|
+            add_callback :end_class do |_node|
               klasses.pop
               # @klass = nil
             end
@@ -175,7 +176,7 @@ module RailsBestPractices
             end
 
             # end of module
-            add_callback :end_module do |node|
+            add_callback :end_module do |_node|
               moduleable_modules.pop
             end
           end
@@ -272,7 +273,7 @@ module RailsBestPractices
               when 'try'
                 mark_used(node.arguments.all.first)
               when 'send'
-                if [:symbol_literal, :string_literal].include?(node.arguments.all.first.sexp_type)
+                if %i[symbol_literal string_literal].include?(node.arguments.all.first.sexp_type)
                   mark_used(node.arguments.all.first)
                 end
               else
@@ -281,6 +282,7 @@ module RailsBestPractices
             end
 
             private
+
               def mark_used(method_node)
                 return if method_node == :call
                 if :bare_assoc_hash == method_node.sexp_type
@@ -293,7 +295,7 @@ module RailsBestPractices
                 call_method(method_name)
               end
 
-              def call_method(method_name, class_name=nil)
+              def call_method(method_name, class_name = nil)
                 name ||= respond_to?(:current_class_name) ? current_class_name : current_module_name
                 if methods.has_method?(name, method_name)
                   methods.get_method(name, method_name).mark_used
@@ -314,7 +316,7 @@ module RailsBestPractices
             interesting_files CONTROLLER_FILES
 
             # check if the controller is inherit from InheritedResources::Base.
-            add_callback :start_class do |node|
+            add_callback :start_class do |_node|
               if 'InheritedResources::Base' == current_extend_class_name
                 @inherited_resources = true
               end
@@ -352,12 +354,12 @@ module RailsBestPractices
             end
 
             def internal_except_methods
-              raise NoMethodError.new 'no method internal_except_methods'
+              raise NoMethodError, 'no method internal_except_methods'
             end
           end
         end
 
-        def self.matches method, except_method
+        def self.matches(method, except_method)
           class_name, method_name = except_method.split('#')
 
           method_name = '.*' if method_name == '*'
@@ -389,25 +391,25 @@ module RailsBestPractices
 
             # remember the current access control for methods.
             add_callback :start_var_ref do |node|
-              if %w(public protected private).include? node.to_s
+              if %w[public protected private].include? node.to_s
                 @access_control = node.to_s
               end
             end
 
             # remember the current access control for methods.
             add_callback :start_vcall do |node|
-              if %w(public protected private).include? node.to_s
+              if %w[public protected private].include? node.to_s
                 @access_control = node.to_s
               end
             end
 
             # set access control to "public" by default.
-            add_callback :start_class do |node|
+            add_callback :start_class do |_node|
               @access_control = 'public'
             end
 
             # set access control to "public" by default.
-            add_callback :start_module do |node|
+            add_callback :start_module do |_node|
               @access_control = 'public'
             end
           end

data/lib/rails_best_practices/core/checks_loader.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     class ChecksLoader
@@ -46,4 +47,4 @@ module RailsBestPractices
         end
     end
   end
-end
+end

data/lib/rails_best_practices/core/configs.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     class Configs < Hash

data/lib/rails_best_practices/core/controllers.rb

@@ -1,4 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_rel 'klasses'
+
 module RailsBestPractices
   module Core
     # Controller classes.

data/lib/rails_best_practices/core/error.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Error is the violation to rails best practice.
@@ -8,7 +9,7 @@ module RailsBestPractices
       attr_reader :type, :url
       attr_accessor :git_commit, :git_username, :hg_commit, :hg_username
 
-      def initialize(options={})
+      def initialize(options = {})
         super
         @type = options[:type]
         @url = options[:url]

data/lib/rails_best_practices/core/gems.rb

@@ -1,13 +1,14 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     class Gems < Array
       def has_gem?(gem_name)
-        self.find { |gem| gem.name == gem_name }
+        find { |gem| gem.name == gem_name }
       end
 
       def gem_version(gem_name)
-        self.find { |gem| gem.name == gem_name }.try(:version)
+        find { |gem| gem.name == gem_name }.try(:version)
       end
     end
 

data/lib/rails_best_practices/core/helpers.rb

@@ -1,4 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_rel 'modules'
+
 module RailsBestPractices
   module Core
     # Helper moduels.

data/lib/rails_best_practices/core/klasses.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Klass container.
@@ -19,7 +20,7 @@ module RailsBestPractices
       def initialize(class_name, extend_class_name, modules)
         @modules = modules.dup
         base = @modules.map { |modu| "#{modu}::" }.join('')
-        @class_name =  base + class_name
+        @class_name = base + class_name
         if extend_class_name
           @extend_class_name = base + extend_class_name
         end