fasterer 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fc06a003ad7ef35818e525f60ef7bc3bbc7b015
-  data.tar.gz: c33294e5d4ae9d8f731cf018ff4f6e834731e230
+  metadata.gz: a3553ce8184fc77f1acf47f6853044df9e21f5dc
+  data.tar.gz: cc19c0ab4f3e1f57d865d8dd734da0e5edaddc0a
 SHA512:
-  metadata.gz: 13e41010ea909bc9990f61ac6423b91855ce9ea8d17323ed10ed1ca8d44613e22e9929895dbc8e9cf213ebb1acc1613e24e89d2ffab2840f3d06c769ea52f278
-  data.tar.gz: 654bd69d4a16bffab862c955e50aba3e9364118a23436f6aaf10a912ac65376a6bb9e9db1e8cfabeeae3b850eb0f6c9c6dcfa0466e50da2370b1d6889bd593d5
+  metadata.gz: 81fdc75a473a31b92c754da7f7a71c93b3f632b03f3a3fb0a7b1e514e27c24429247de20298579663772e92ac447359b409ecad1d712ce4f77ac12ecd7caaa03
+  data.tar.gz: aa1a4e40b67a12654028fa0f2e2ec9e980436631f3437230a120f95349c608b209627d762e4b915cf88745f7e7b3e92e0be449814177ff1677729b67d18c1b91

data/.fasterer.yml

@@ -21,4 +21,9 @@ speedups:
   setter_vs_attr_writer: true
 
 exclude_paths:
+  - 'spec/support/analyzer/*.rb'
+  - 'spec/support/binary_call/*.rb'
+  - 'spec/support/method_call/*.rb'
+  - 'spec/support/method_definition/*.rb'
+  - 'spec/support/rescue_call/*.rb'
   - 'vendor/**/*.rb'

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
-  - 2.2.0
+- 1.9.3
+- 2.0.0
+- 2.1.7
+- 2.2.3
+env:
+  global:
+    secure: MBTxmpWCjrsNKPlOoFwJUMHze3GPMz8YCXQFQG3zJBh3WGNQnz4z91ra/1P/DClyVCxHGSFCOswxCNe4kJ2zAnPyQLqGSinXy9uDpqZQUEdaRoQbPnh4/bguZNSJ429gtTpMdDSNOgQ+Hra2EFnWwHA+rLF6ImksMsu3XGKGxGE=

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fasterer.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/DamirSvrtan/fasterer.svg?branch=master)](https://travis-ci.org/DamirSvrtan/fasterer)
 [![Code Climate](https://codeclimate.com/github/DamirSvrtan/fasterer/badges/gpa.svg)](https://codeclimate.com/github/DamirSvrtan/fasterer)
 [![Gem Version](https://badge.fury.io/rb/fasterer.svg)](http://badge.fury.io/rb/fasterer)
+[![Test Coverage](https://codeclimate.com/github/DamirSvrtan/fasterer/badges/coverage.svg)](https://codeclimate.com/github/DamirSvrtan/fasterer/coverage)
 # Fasterer
 
 Make your Rubies go faster with this command line tool highly inspired by [fast-ruby](https://github.com/JuanitoFatas/fast-ruby) and [Sferik's talk at Baruco Conf](https://speakerdeck.com/sferik/writing-fast-ruby).

data/lib/fasterer/cli.rb

@@ -5,6 +5,7 @@ module Fasterer
     def self.execute
       file_traverser = Fasterer::FileTraverser.new('.')
       file_traverser.traverse
+      abort if file_traverser.offenses_found?
     end
   end
 end

data/lib/fasterer/config.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+module Fasterer
+  class Config
+    FILE_NAME         = '.fasterer.yml'
+    SPEEDUPS_KEY      = 'speedups'
+    EXCLUDE_PATHS_KEY = 'exclude_paths'
+
+    def ignored_speedups
+      @ignored_speedups ||=
+        file[SPEEDUPS_KEY].select { |_, value| value == false }.keys.map(&:to_sym)
+    end
+
+    def ignored_files
+      @ignored_files ||=
+        file[EXCLUDE_PATHS_KEY].flat_map { |path| Dir[path] }
+    end
+
+    def file
+      @file ||= begin
+        return nil_file unless File.exist?(FILE_NAME)
+        # Yaml.load_file returns false if the content is blank
+        loaded = YAML.load_file(FILE_NAME) || nil_file
+        # if the loaded file misses any of the two keys.
+        loaded.merge!(nil_file) { |_k, v1, v2| v1 || v2 }
+      end
+    end
+
+    def nil_file
+      { SPEEDUPS_KEY => {}, EXCLUDE_PATHS_KEY => [] }
+    end
+  end
+end

data/lib/fasterer/file_traverser.rb

@@ -1,19 +1,21 @@
 require 'pathname'
 require 'colorize'
-require 'yaml'
 
 require_relative 'analyzer'
+require_relative 'config'
 
 module Fasterer
   class FileTraverser
+    CONFIG_FILE_NAME  = Config::FILE_NAME
+    SPEEDUPS_KEY      = Config::SPEEDUPS_KEY
+    EXCLUDE_PATHS_KEY = Config::EXCLUDE_PATHS_KEY
 
-    CONFIG_FILE_NAME  = '.fasterer.yml'
-    SPEEDUPS_KEY      = 'speedups'
-    EXCLUDE_PATHS_KEY = 'exclude_paths'
+    attr_reader :config
 
     def initialize(path)
       @path = Pathname(path)
       @parse_error_paths = []
+      @config = Config.new
     end
 
     def traverse
@@ -25,31 +27,18 @@ module Fasterer
       output_parse_errors if parse_error_paths.any?
     end
 
-    def ignored_speedups
-      @ignored_speedups ||=
-        config_file[SPEEDUPS_KEY].select { |_, value| value == false }.keys.map(&:to_sym)
+    def config_file
+      config.file
     end
 
-    def ignored_files
-      @ignored_files ||=
-        config_file[EXCLUDE_PATHS_KEY].flat_map { |path| Dir[path] }
-    end
-
-    def config_file
-      @config_file ||= if File.exists?(CONFIG_FILE_NAME)
-        YAML.load_file(CONFIG_FILE_NAME)
-      else
-        nil_config_file
-      end
+    def offenses_found?
+      !!offenses_found
     end
 
     private
 
     attr_reader :parse_error_paths
-
-    def nil_config_file
-      { SPEEDUPS_KEY => {}, EXCLUDE_PATHS_KEY => [] }
-    end
+    attr_accessor :offenses_found
 
     def scan_file(path)
       analyzer = Analyzer.new(path)
@@ -57,7 +46,10 @@ module Fasterer
     rescue RubyParser::SyntaxError, Racc::ParseError, Timeout::Error
       parse_error_paths.push(path)
     else
-      output(analyzer) if offenses_grouped_by_type(analyzer).any?
+      if offenses_grouped_by_type(analyzer).any?
+        output(analyzer)
+        self.offenses_found = true
+      end
     end
 
     def scannable_files
@@ -95,5 +87,17 @@ module Fasterer
       puts parse_error_paths
       puts
     end
+
+    def ignored_speedups
+      config.ignored_speedups
+    end
+
+    def ignored_files
+      config.ignored_files
+    end
+
+    def nil_config_file
+      config.nil_file
+    end
   end
 end

data/lib/fasterer/version.rb

@@ -1,3 +1,3 @@
 module Fasterer
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

data/spec/lib/fasterer/cli_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Fasterer::FileTraverser do
+  include FileHelper
+  include_context 'isolated environment'
+
+  describe 'exit status should be' do
+    context 'success' do
+      it 'when no files exist' do
+        `#{fasterer_bin}`
+        expect($?.exitstatus).to eq(0)
+      end
+
+      it 'when no files with offenses exist' do
+        create_file('user.rb', '[].sample')
+        `#{fasterer_bin}`
+        expect($?.exitstatus).to eq(0)
+      end
+    end
+
+    context 'fail' do
+      it 'when file with offenses exists' do
+        create_file('user.rb', '[].shuffle.first')
+        `#{fasterer_bin}`
+        expect($?.exitstatus).to eq(1)
+      end
+    end
+  end
+
+  def fasterer_bin
+    File.expand_path('../../../../bin/fasterer', __FILE__)
+  end
+end

data/spec/lib/fasterer/file_traverser_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe Fasterer::FileTraverser do
+  include FileHelper
+  include_context 'isolated environment'
+
+  describe 'config_file' do
+    context 'with no config file' do
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns nil_config_file' do
+        expect(file_traverser.config_file)
+          .to eq(file_traverser.send(:nil_config_file))
+      end
+    end
+
+    context 'with empty config file' do
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME, '')
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns nil_config_file' do
+        expect(file_traverser.config_file)
+          .to eq(file_traverser.send(:nil_config_file))
+      end
+    end
+
+    context 'missing exclude_paths key' do
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    ['speedups:'])
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns nil_config_file' do
+        expect(file_traverser.config_file)
+          .to eq(file_traverser.send(:nil_config_file))
+      end
+    end
+
+    context 'with speedups content but no exclude_paths' do
+      let(:config_file_content) do
+        "speedups:\n"\
+        "  keys_each_vs_each_key: true"
+      end
+
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    config_file_content)
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns config_file with added exclude paths key' do
+        expect(file_traverser.config_file)
+          .to eq('speedups' => { 'keys_each_vs_each_key' => true },
+                 'exclude_paths' => [])
+      end
+    end
+
+    context 'with exclude_paths content but no speedups' do
+      let(:config_file_content) do
+        "exclude_paths:\n"\
+        "  - 'spec/support/analyzer/*.rb'"
+      end
+
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    config_file_content)
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns config_file with added speedups key' do
+        expect(file_traverser.config_file)
+          .to eq('speedups' => {},
+                 'exclude_paths' => ['spec/support/analyzer/*.rb'])
+      end
+    end
+
+    context 'with exclude_paths and speedups content' do
+      let(:config_file_content) do
+        "speedups:\n"\
+        "  keys_each_vs_each_key: true\n"\
+        "exclude_paths:\n"\
+        "  - 'spec/support/analyzer/*.rb'"
+      end
+
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    config_file_content)
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns config_file' do
+        expect(file_traverser.config_file)
+          .to eq('speedups' => { 'keys_each_vs_each_key' => true },
+                 'exclude_paths' => ['spec/support/analyzer/*.rb'])
+      end
+    end
+
+    context 'with empty values' do
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    ['speedups:',
+                     '',
+                     'exclude_paths:'])
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns nil_config_file' do
+        expect(file_traverser.config_file)
+          .to eq(file_traverser.send(:nil_config_file))
+      end
+    end
+  end
+
+  describe 'scannable files' do
+    context 'when no files in folder' do
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns empty array' do
+        expect(file_traverser.send(:scannable_files)).to eq([])
+      end
+    end
+
+    context 'only a non-ruby file inside' do
+      before do
+        create_file('something.yml')
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns empty array' do
+        expect(file_traverser.send(:scannable_files)).to eq([])
+      end
+    end
+
+    context 'a ruby file inside' do
+      let(:file_name) { 'something.rb' }
+
+      before do
+        create_file(file_name)
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns array with that file inside' do
+        expect(file_traverser.send(:scannable_files)).to eq([file_name])
+      end
+    end
+
+    context 'a ruby file inside that is ignored' do
+      let(:file_name) { 'something.rb' }
+
+      let(:config_file_content) do
+        "exclude_paths:\n"\
+        "  - '#{file_name}'"
+      end
+
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    config_file_content)
+
+        create_file(file_name)
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns empty array' do
+        expect(file_traverser.send(:scannable_files)).to eq([])
+      end
+    end
+
+    context 'a ruby file inside that is not ignored' do
+      let(:file_name) { 'something.rb' }
+
+      let(:config_file_content) do
+        "exclude_paths:\n"\
+        "  - 'sumthing.rb'"
+      end
+
+      before(:each) do
+        create_file(Fasterer::FileTraverser::CONFIG_FILE_NAME,
+                    config_file_content)
+        create_file(file_name)
+      end
+
+      let(:file_traverser) { Fasterer::FileTraverser.new('.') }
+
+      it 'returns empty array' do
+        expect(file_traverser.send(:scannable_files)).to eq([file_name])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,19 @@
 require 'bundler/setup'
 require 'simplecov'
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/vendor/'
+end
 
 require 'fasterer'
+require 'fasterer/cli'
 require 'pry'
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each { |f| require f }
+
+if ENV['TRAVIS']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
 
 def RSpec.root
   @root_path = Pathname.new(File.dirname(__FILE__))

data/spec/support/file_helper.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+
+# Util methods for processing file.
+module FileHelper
+  # Create file with at given path with given content. Ensure parent directories
+  # exist.
+  #
+  # path    - An String path of file.
+  # content - An String or an Array of Strings content of file.
+  def create_file(path, content = '')
+    file_path = File.expand_path(path)
+    dir_path = File.dirname(file_path)
+    FileUtils.makedirs(dir_path) unless File.exist?(dir_path)
+    write_file(path, content)
+  end
+
+  # Write file content at given path.
+  #
+  # path    - An String path of file.
+  # content - An String or an Array of Strings content of file.
+  def write_file(path, content)
+    File.open(path, 'w') do |file|
+      case content
+      when ''
+        # Create empty file.
+      when String
+        file.puts content
+      when Array
+        file.puts content.join("\n")
+      end
+    end
+  end
+end

data/spec/support/isolated_environment.rb

@@ -0,0 +1,12 @@
+require 'tmpdir'
+
+shared_context 'isolated environment' do
+  around do |example|
+    Dir.mktmpdir do |tmpdir|
+      tmpdir = File.realpath(tmpdir)
+      Dir.chdir(tmpdir) do
+        example.run
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fasterer
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Damir Svrtan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -131,6 +131,7 @@ files:
 - lib/fasterer/analyzer.rb
 - lib/fasterer/binary_call.rb
 - lib/fasterer/cli.rb
+- lib/fasterer/config.rb
 - lib/fasterer/file_traverser.rb
 - lib/fasterer/method_call.rb
 - lib/fasterer/method_definition.rb
@@ -166,6 +167,8 @@ files:
 - spec/lib/fasterer/analyzer/29_include_vs_cover_on_range_spec.rb
 - spec/lib/fasterer/analyzer/98_misc_spec.rb
 - spec/lib/fasterer/analyzer/99_exceptional_files_spec.rb
+- spec/lib/fasterer/cli_spec.rb
+- spec/lib/fasterer/file_traverser_spec.rb
 - spec/lib/fasterer/method_call_spec.rb
 - spec/lib/fasterer/method_definition_spec.rb
 - spec/lib/fasterer/rescue_call_spec.rb
@@ -193,6 +196,8 @@ files:
 - spec/support/analyzer/98_misc.rb
 - spec/support/analyzer/99_exceptional_files.rb
 - spec/support/binary_call/simple_comparison.rb
+- spec/support/file_helper.rb
+- spec/support/isolated_environment.rb
 - spec/support/method_call/method_call_on_constant.rb
 - spec/support/method_call/method_call_on_integer.rb
 - spec/support/method_call/method_call_on_method_call.rb
@@ -242,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Run Ruby more than fast. Fasterer
@@ -269,6 +274,8 @@ test_files:
 - spec/lib/fasterer/analyzer/29_include_vs_cover_on_range_spec.rb
 - spec/lib/fasterer/analyzer/98_misc_spec.rb
 - spec/lib/fasterer/analyzer/99_exceptional_files_spec.rb
+- spec/lib/fasterer/cli_spec.rb
+- spec/lib/fasterer/file_traverser_spec.rb
 - spec/lib/fasterer/method_call_spec.rb
 - spec/lib/fasterer/method_definition_spec.rb
 - spec/lib/fasterer/rescue_call_spec.rb
@@ -296,6 +303,8 @@ test_files:
 - spec/support/analyzer/98_misc.rb
 - spec/support/analyzer/99_exceptional_files.rb
 - spec/support/binary_call/simple_comparison.rb
+- spec/support/file_helper.rb
+- spec/support/isolated_environment.rb
 - spec/support/method_call/method_call_on_constant.rb
 - spec/support/method_call/method_call_on_integer.rb
 - spec/support/method_call/method_call_on_method_call.rb
@@ -325,4 +334,3 @@ test_files:
 - spec/support/rescue_call/rescue_with_multiple_classes.rb
 - spec/support/rescue_call/rescue_with_multiple_classes_and_variable.rb
 - spec/support/rescue_call/rescue_with_variable.rb
-has_rdoc: