fasterer 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a9044b0734156a715894ea721ea8a13105c55fc
-  data.tar.gz: 5cee39bd66ce0513d1fa3a6175d3b5f35de4ba70
+  metadata.gz: 9166a1cbd984ee3e8af00277252f430d7efcc817
+  data.tar.gz: 35ec0f0a4953e38f0145106c3523622461e9467c
 SHA512:
-  metadata.gz: 2d89297fc809382f092941e12f52dd092e999af45d521d07c7bdca0350d070e096fe0235ddf7b56a6d82d5fbead89bbd3d1c9d177a4d5e6bda56d0efa80fd3c4
-  data.tar.gz: 4f50e5a4512471e8f812541a432970712e0c94f3336a80400d5226e29553f50ccf4a74df53981d50d5b952161fa1686dd8e9b0b13e17f160d648212f5dadf2bd
+  metadata.gz: 8f9774ae496a60c30b619155a53e1cf306ee1beed19e63fb601e4de2a40e3c435c0352daafeeb6d3de19ee7b9fde694d3493089cf36901197be939d80e376ca5
+  data.tar.gz: 0bac8bc68e9f4d5032d12d9dd29a8b4cc99efc59338aefe15a262590f955fb97f2af2ed4cb6b25b0502992f48cc1b4e983d54aee2879789c81b9a1c9442073e3

data/.fasterer.yml

@@ -16,5 +16,9 @@ speedups:
   block_vs_symbol_to_proc: true
   proc_call_vs_yield: true
   gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
+
 exclude_paths:
   - 'vendor/**/*.rb'

data/README.md

@@ -74,6 +74,9 @@ speedups:
   block_vs_symbol_to_proc: true
   proc_call_vs_yield: true
   gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
 
 exclude_paths:
   - 'vendor/**/*.rb'

data/fasterer.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',    '~> 10.0'
   spec.add_development_dependency 'rspec',   '~> 3.2'
   spec.add_development_dependency 'pry',     '~> 0.10'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
 end

data/lib/fasterer/file_traverser.rb

@@ -7,50 +7,50 @@ require_relative 'analyzer'
 module Fasterer
   class FileTraverser
 
-    CONFIG_FILE_NAME = '.fasterer.yml'
-
-    SPEEDUPS_KEY = 'speedups'
-
+    CONFIG_FILE_NAME  = '.fasterer.yml'
+    SPEEDUPS_KEY      = 'speedups'
     EXCLUDE_PATHS_KEY = 'exclude_paths'
 
-    attr_reader :ignored_speedups, :ignored_paths
-
     def initialize(path)
       @path = Pathname(path)
       @parse_error_paths = []
-      set_ignored_speedups
-      set_ignored_paths
     end
 
     def traverse
       if @path.directory?
-        traverse_directory(@path)
+        scannable_files.each { |ruby_file| scan_file(ruby_file) }
       else
         scan_file(@path)
       end
       output_parse_errors if parse_error_paths.any?
     end
 
-    def set_ignored_speedups
-      @ignored_speedups = if config_file && config_file[SPEEDUPS_KEY]
-        config_file[SPEEDUPS_KEY].select {|_, value| value == false }.keys.map(&:to_sym)
-      end || []
+    def ignored_speedups
+      @ignored_speedups ||=
+        config_file[SPEEDUPS_KEY].select { |_, value| value == false }.keys.map(&:to_sym)
     end
 
-    def set_ignored_paths
-      @ignored_paths = if config_file && config_file[EXCLUDE_PATHS_KEY]
-        config_file[EXCLUDE_PATHS_KEY].flat_map {|path| Dir[path] }
-      end || []
+    def ignored_files
+      @ignored_files ||=
+        config_file[EXCLUDE_PATHS_KEY].flat_map { |path| Dir[path] }
     end
 
     def config_file
-      File.exists?(CONFIG_FILE_NAME) && YAML.load_file(CONFIG_FILE_NAME)
+      @config_file ||= if File.exists?(CONFIG_FILE_NAME)
+        YAML.load_file(CONFIG_FILE_NAME)
+      else
+        nil_config_file
+      end
     end
 
     private
 
     attr_reader :parse_error_paths
 
+    def nil_config_file
+      { SPEEDUPS_KEY => {}, EXCLUDE_PATHS_KEY => [] }
+    end
+
     def scan_file(path)
       analyzer = Analyzer.new(path)
       analyzer.scan
@@ -60,12 +60,13 @@ module Fasterer
       output(analyzer) if offenses_grouped_by_type(analyzer).any?
     end
 
-    def traverse_directory(path)
-      Dir["#{path}/**/*.rb"].each do |ruby_file_path|
-        relative_ruby_file_path = Pathname(ruby_file_path).relative_path_from(path)
-        unless ignored_paths.include?(relative_ruby_file_path.to_s)
-          scan_file(relative_ruby_file_path)
-        end
+    def scannable_files
+      all_files - ignored_files
+    end
+
+    def all_files
+      Dir["#{@path}/**/*.rb"].map do |ruby_file_path|
+        Pathname(ruby_file_path).relative_path_from(@path).to_s
       end
     end
 
@@ -73,20 +74,23 @@ module Fasterer
       puts analyzer.file_path.colorize(:red)
 
       offenses_grouped_by_type(analyzer).each do |error_group_name, error_occurences|
-        puts "#{Fasterer::Offense::EXPLANATIONS[error_group_name]}. Occured at lines: #{error_occurences.map(&:line_number).join(', ')}."
+        puts "#{Fasterer::Offense::EXPLANATIONS[error_group_name]}."\
+             " Occurred at lines: #{error_occurences.map(&:line_number).join(', ')}."
       end
 
       puts
     end
 
     def offenses_grouped_by_type(analyzer)
-      analyzer.errors.group_by(&:name).delete_if {|offense_name, _| ignored_speedups.include?(offense_name) }
+      analyzer.errors.group_by(&:name).delete_if do |offense_name, _|
+        ignored_speedups.include?(offense_name)
+      end
     end
 
     def output_parse_errors
       puts 'Fasterer was unable to process some files because the'
       puts 'internal parser is not able to read some characters or'
-      puts 'has timeouted. Unprocessable files were:'
+      puts 'has timed out. Unprocessable files were:'
       puts '-----------------------------------------------------'
       puts parse_error_paths
       puts

data/lib/fasterer/method_call.rb

@@ -42,8 +42,6 @@ module Fasterer
                         @element
                       when :iter
                         @element[1]
-                      else
-                        fail '!!!!!!!'
                       end
     end
 
@@ -77,33 +75,17 @@ module Fasterer
         element[2].drop(1).map { |argument| argument }
       end || []
     end
-
-    def token
-      element[0]
-    end
   end
 
-  # For now, used for determening if
-  # the receiver is a reference or not.
+  # For now, used for determening if the
+  # receiver is a reference or a method call.
   class ReceiverFactory
-    attr_reader :name
-    attr_reader :method
-
     def self.new(receiver_info)
-      return if receiver_info.nil?
-      token = receiver_info.first
+      return unless receiver_info.is_a?(Sexp)
 
-      case token
+      case receiver_info.sexp_type
       when :lvar
         return VariableReference.new(receiver_info)
-      when :method_add_arg, :method_add_block
-        case receiver_info[1][0]
-        when :call, :fcall
-          return MethodCall.new(receiver_info[1])
-        else
-          # binding.pry watch out for :method_add_arg
-          # raise 'nije ni metoda'
-        end
       when :call, :iter
         return MethodCall.new(receiver_info)
       end

data/lib/fasterer/method_definition.rb

@@ -4,34 +4,40 @@ module Fasterer
     attr_reader :method_name
     attr_reader :block_argument_name
     attr_reader :body
+    attr_reader :arguments
+
+    alias_method :name, :method_name
 
     def initialize(element)
       @element = element # Ripper element
       set_method_name
       set_body
-
-      if arguments_element.any?
-        set_argument_names
-        set_block_argument_name
-      end
+      set_arguments
+      set_block_argument_name
     end
 
     def has_block?
       !!@block_argument_name
     end
 
+    def setter?
+      name.to_s.end_with?('=')
+    end
+
     private
 
     def arguments_element
-      element[2].drop(1)
+      element[2].drop(1) || []
     end
 
     def set_method_name
       @method_name = @element[1]
     end
 
-    def set_argument_names
-      # TODO
+    def set_arguments
+      @arguments = arguments_element.map do |argument_element|
+        MethodDefinitionArgument.new(argument_element)
+      end
     end
 
     def set_body
@@ -39,13 +45,53 @@ module Fasterer
     end
 
     def set_block_argument_name
-      if last_argument.to_s.start_with?('&')
-        @block_argument_name = last_argument.to_s[1..-1].to_sym
+      if last_argument_element.to_s.start_with?('&')
+        @block_argument_name = last_argument_element.to_s[1..-1].to_sym
       end
     end
 
-    def last_argument
+    def last_argument_element
       arguments_element.last
     end
   end
+
+  class MethodDefinitionArgument
+
+    attr_reader :element, :name, :type
+
+    def initialize(element)
+      @element = element
+      set_name
+      set_argument_type
+    end
+
+    def regular_argument?
+      @type == :regular_argument
+    end
+
+    def default_argument?
+      @type == :default_argument
+    end
+
+    def keyword_argument?
+      @type == :keyword_argument
+    end
+
+    private
+
+    def set_name
+      @name = element.is_a?(Symbol) ? element : element[1]
+    end
+
+    def set_argument_type
+      @type = if element.is_a?(Symbol)
+        :regular_argument
+      elsif element.is_a?(Sexp) && element.sexp_type == :lasgn
+        :default_argument
+      elsif element.is_a?(Sexp) && element.sexp_type == :kwarg
+        :keyword_argument
+      end
+    end
+  end
+
 end

data/lib/fasterer/offense.rb

@@ -38,7 +38,7 @@ module Fasterer
         'Array#map.flatten(1) is slower than Array#flat_map',
 
       reverse_each_vs_reverse_each:
-        'Array#reverese.each is slower than Array#reverse_each',
+        'Array#reverse.each is slower than Array#reverse_each',
 
       select_first_vs_detect:
         'Array#select.first is slower than Array#detect',
@@ -65,7 +65,13 @@ module Fasterer
         'Using tr is faster than gsub when replacing a single character in a string with another single character',
 
       select_last_vs_reverse_detect:
-        'Array#select.last is slower than Array#reverse.detect'
+        'Array#select.last is slower than Array#reverse.detect',
+
+      getter_vs_attr_reader:
+        'Use attr_reader for reading ivars',
+
+      setter_vs_attr_writer:
+        'Use attr_writer for writing to ivars'
     }
 
   end

data/lib/fasterer/rescue_call.rb

@@ -21,16 +21,5 @@ module Fasterer
       end.compact
     end
 
-    def set_multiple_rescue_classes
-      @rescue_classes = element[1].drop(1).map do |rescue_reference|
-        rescue_reference.flatten[2]
-      end
-    end
-
-    def set_single_rescue_class
-      if element[1][0][0] == :var_ref
-        @rescue_classes = Array(element[1][0][1][1])
-      end
-    end
   end
 end

data/lib/fasterer/scanners/method_definition_scanner.rb

@@ -19,6 +19,8 @@ module Fasterer
     def check_offense
       if method_definition.has_block?
         scan_block_call_offense
+      else
+        scan_getter_and_setter_offense
       end
     end
 
@@ -48,5 +50,37 @@ module Fasterer
         traverse_tree(element, &block)
       end
     end
+
+    def scan_getter_and_setter_offense
+      method_definition.setter? ? scan_setter_offense : scan_getter_offense
+    end
+
+    def scan_setter_offense
+      return if method_definition.arguments.size != 1
+      return if method_definition.body.size != 1
+
+      first_argument = method_definition.arguments.first
+      return if first_argument.type != :regular_argument
+
+      if method_definition.body.first.sexp_type == :iasgn &&
+        method_definition.body.first[1].to_s == "@#{method_definition.name.to_s[0..-2]}" &&
+        method_definition.body.first[2][1] == first_argument.name
+
+        add_offense(:setter_vs_attr_writer)
+      end
+    end
+
+    def scan_getter_offense
+      return if method_definition.arguments.size > 0
+      return if method_definition.body.size != 1
+
+      if method_definition.body.first.sexp_type == :ivar &&
+        method_definition.body.first[1].to_s == "@#{method_definition.name}"
+
+        add_offense(:getter_vs_attr_reader)
+      end
+    end
+
   end
+
 end

data/lib/fasterer/version.rb

@@ -1,3 +1,3 @@
 module Fasterer
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/spec/lib/fasterer/analyzer/{04_find_vs_bsearch_spec.rb → 26_getter_vs_attr_reader_spec.rb}

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe Fasterer::Analyzer do
 
-  let(:test_file_path) { RSpec.root.join('support', 'analyzer', '04_find_vs_bsearch.rb') }
+  let(:test_file_path) { RSpec.root.join('support', 'analyzer', '26_getter_vs_attr_reader.rb') }
 
-  xit 'should detect Array#find' do
+  it 'should detect 2 getters' do
     analyzer = Fasterer::Analyzer.new(test_file_path)
     analyzer.scan
-    # expect(analyzer.error_occurrence[:module_eval]).to eq(1)
+    expect(analyzer.errors[:getter_vs_attr_reader].count).to eq(2)
   end
 end

data/spec/lib/fasterer/analyzer/27_setter_vs_attr_writer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Fasterer::Analyzer do
+
+  let(:test_file_path) { RSpec.root.join('support', 'analyzer', '27_setter_vs_attr_writer.rb') }
+
+  it 'should detect 2 setters' do
+    analyzer = Fasterer::Analyzer.new(test_file_path)
+    analyzer.scan
+    expect(analyzer.errors[:setter_vs_attr_writer].count).to eq(2)
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'bundler/setup'
-Bundler.setup
+require 'simplecov'
+SimpleCov.start
 
 require 'fasterer'
 require 'pry'

data/spec/support/analyzer/26_getter_vs_attr_reader.rb

@@ -0,0 +1,16 @@
+def name
+	@name
+end
+
+
+class User
+
+	def name
+		@name
+	end
+end
+
+
+def name
+	@name = rand(1..100)
+end

data/spec/support/analyzer/27_setter_vs_attr_writer.rb

@@ -0,0 +1,13 @@
+def name=(value)
+	@name = value
+end
+
+class User
+	def name=(value)
+		@name = value
+	end
+end
+
+def name=(value)
+	@name = [value]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fasterer
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Damir Svrtan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Use Fasterer to check various places in your code that could be faster.
 email:
 - damir.svrtan@gmail.com
@@ -133,7 +147,6 @@ files:
 - spec/lib/fasterer/analyzer/01_parallel_assignment_spec.rb
 - spec/lib/fasterer/analyzer/02_rescue_vs_respond_to_spec.rb
 - spec/lib/fasterer/analyzer/03_module_eval_spec.rb
-- spec/lib/fasterer/analyzer/04_find_vs_bsearch_spec.rb
 - spec/lib/fasterer/analyzer/06_shuffle_first_vs_sample_spec.rb
 - spec/lib/fasterer/analyzer/08_for_loop_vs_each_spec.rb
 - spec/lib/fasterer/analyzer/09_each_with_index_vs_while_spec.rb
@@ -148,6 +161,8 @@ files:
 - spec/lib/fasterer/analyzer/19_proc_call_vs_yield_spec.rb
 - spec/lib/fasterer/analyzer/24_gsub_vs_tr_spec.rb
 - spec/lib/fasterer/analyzer/25_select_last_vs_reverse_detect_spec.rb
+- spec/lib/fasterer/analyzer/26_getter_vs_attr_reader_spec.rb
+- spec/lib/fasterer/analyzer/27_setter_vs_attr_writer_spec.rb
 - spec/lib/fasterer/analyzer/98_misc_spec.rb
 - spec/lib/fasterer/analyzer/99_exceptional_files_spec.rb
 - spec/lib/fasterer/method_call_spec.rb
@@ -157,7 +172,6 @@ files:
 - spec/support/analyzer/01_parallel_assignment.rb
 - spec/support/analyzer/02_rescue_vs_respond_to.rb
 - spec/support/analyzer/03_module_eval.rb
-- spec/support/analyzer/04_find_vs_bsearch.rb
 - spec/support/analyzer/06_shuffle_first_vs_sample.rb
 - spec/support/analyzer/08_for_loop_vs_each.rb
 - spec/support/analyzer/09_each_with_index_vs_while.rb
@@ -172,6 +186,8 @@ files:
 - spec/support/analyzer/19_proc_call_vs_yield.rb
 - spec/support/analyzer/24_gsub_vs_tr.rb
 - spec/support/analyzer/25_select_last_vs_reverse_detect.rb
+- spec/support/analyzer/26_getter_vs_attr_reader.rb
+- spec/support/analyzer/27_setter_vs_attr_writer.rb
 - spec/support/analyzer/98_misc.rb
 - spec/support/analyzer/99_exceptional_files.rb
 - spec/support/binary_call/simple_comparison.rb
@@ -232,7 +248,6 @@ test_files:
 - spec/lib/fasterer/analyzer/01_parallel_assignment_spec.rb
 - spec/lib/fasterer/analyzer/02_rescue_vs_respond_to_spec.rb
 - spec/lib/fasterer/analyzer/03_module_eval_spec.rb
-- spec/lib/fasterer/analyzer/04_find_vs_bsearch_spec.rb
 - spec/lib/fasterer/analyzer/06_shuffle_first_vs_sample_spec.rb
 - spec/lib/fasterer/analyzer/08_for_loop_vs_each_spec.rb
 - spec/lib/fasterer/analyzer/09_each_with_index_vs_while_spec.rb
@@ -247,6 +262,8 @@ test_files:
 - spec/lib/fasterer/analyzer/19_proc_call_vs_yield_spec.rb
 - spec/lib/fasterer/analyzer/24_gsub_vs_tr_spec.rb
 - spec/lib/fasterer/analyzer/25_select_last_vs_reverse_detect_spec.rb
+- spec/lib/fasterer/analyzer/26_getter_vs_attr_reader_spec.rb
+- spec/lib/fasterer/analyzer/27_setter_vs_attr_writer_spec.rb
 - spec/lib/fasterer/analyzer/98_misc_spec.rb
 - spec/lib/fasterer/analyzer/99_exceptional_files_spec.rb
 - spec/lib/fasterer/method_call_spec.rb
@@ -256,7 +273,6 @@ test_files:
 - spec/support/analyzer/01_parallel_assignment.rb
 - spec/support/analyzer/02_rescue_vs_respond_to.rb
 - spec/support/analyzer/03_module_eval.rb
-- spec/support/analyzer/04_find_vs_bsearch.rb
 - spec/support/analyzer/06_shuffle_first_vs_sample.rb
 - spec/support/analyzer/08_for_loop_vs_each.rb
 - spec/support/analyzer/09_each_with_index_vs_while.rb
@@ -271,6 +287,8 @@ test_files:
 - spec/support/analyzer/19_proc_call_vs_yield.rb
 - spec/support/analyzer/24_gsub_vs_tr.rb
 - spec/support/analyzer/25_select_last_vs_reverse_detect.rb
+- spec/support/analyzer/26_getter_vs_attr_reader.rb
+- spec/support/analyzer/27_setter_vs_attr_writer.rb
 - spec/support/analyzer/98_misc.rb
 - spec/support/analyzer/99_exceptional_files.rb
 - spec/support/binary_call/simple_comparison.rb

data/spec/support/analyzer/04_find_vs_bsearch.rb

@@ -1,5 +0,0 @@
-data = [1,2,3]
-
-data.bsearch { |number| number > 77_777_777 }
-data.find    { |number| number > 77_777_777 }
-