fasterer-github 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49ba5bd787cff824730deb57d4316bbd0e540365
-  data.tar.gz: 84875707f67e0c11fb0cc04676bc6fdb23386eef
+  metadata.gz: 27d42b5a400f4bf2d8acc16a2b30826fee2e9153
+  data.tar.gz: e66809d510a4ba74194471a9561c60d94330c9e5
 SHA512:
-  metadata.gz: 68af9b5d549e7642edd914d0c74e696e1c76f38cd88b346a94ee981d1b7b8399bf9bacb17a01383504d2386b0bf441500adf468ef4f5f4251c9032725d0f3db5
-  data.tar.gz: b6fce99cad4672f5237db5c6542fd0b656e503dc4e78c409a2e9b53d03c0644c578188263227ab0756ca75a999b539cd3fa1f5da4095ada8edd6657c84e241d9
+  metadata.gz: a6d0dfa7d0265abc82e5ea80cbd54baff7053eb119d4d007d0f0fefa6f635cdefe06ca5fbbd8a3bd0ead3969ad1101ee02b9245ea0f2f5793e85c1a69cfc8268
+  data.tar.gz: b63b791420162a94eae825e58d69f56b068e07af1bc9c39289df01fc036a68dbdd06cc4140322b4e7f03929435a2c4dce8bb056f72c2a083cda3cad9a9b62c8c

data/README.md

@@ -44,6 +44,38 @@ Fasterer::Github.configure do |config|
 end
 ```
 
+Additional configuration can be done using `.fasterer.yml` file, which has to be placed in the root folder of your project.
+Possible options: 
+* turn off speed suggestions
+* blacklist files or complete folder paths
+
+```yaml
+speedups:
+  parallel_assignment: false
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  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/'
+  - 'db/schema.rb'
+```
+
 ## Usage
 
 To scan whole repo, run:
@@ -51,7 +83,7 @@ To scan whole repo, run:
 Fasterer::Github.scan('owner', 'repo')
 ```
 
-You can also scan specific file:
+Or scan specific file:
 ```ruby
 Fasterer::Github.scan('owner', 'repo', 'lib/fasterer-github.rb')
 ```

data/lib/fasterer/github/api_wrapper.rb

@@ -3,7 +3,7 @@ require 'httparty'
 module Fasterer
   module Github
     class ApiWrapper
-      BASE_URL = 'https://api.github.com'
+      BASE_URI = 'https://api.github.com'
 
       def initialize(owner, repo)
         @owner = owner
@@ -14,27 +14,28 @@ module Fasterer
       end
 
       def contents(path)
-        url = build_url(path)
-        HTTParty.get(url)
+        HTTParty.get(build_uri(path), query: authorization_params)
       end
 
       private
 
       attr_reader :owner, :repo, :path, :client_id, :client_secret, :access_token
 
-      def build_url(path)
-        url = BASE_URL + "/repos/#{owner}/#{repo}/contents/#{path}"
-        return add_access_token(url) if access_token != ''
-        return add_client_id_and_secret(url) if client_id != '' && client_secret != ''
-        url
+      def build_uri(path)
+        BASE_URI + "/repos/#{owner}/#{repo}/contents/#{path}"
       end
 
-      def add_access_token(url)
-        url + "?access_token=#{access_token}"
+      def authorization_params
+        return access_token_hash unless access_token.empty?
+        return client_id_secret_hash unless client_id.empty? && client_secret.empty?
       end
 
-      def add_client_id_and_secret(url)
-        url + "?client_id=#{client_id}&client_secret=#{client_secret}"
+      def access_token_hash
+        { 'access_token' => access_token }
+      end
+
+      def client_id_secret_hash
+        { 'client_id' => client_id, 'client_secret' => client_secret }
       end
     end
   end

data/lib/fasterer/github/gh_traverser.rb

@@ -3,10 +3,11 @@ require_relative 'api_wrapper'
 module Fasterer
   module Github
     class GhTraverser
-      def initialize(owner, repo, path)
+      def initialize(owner, repo, path, ignored_paths)
         @owner = owner
         @repo = repo
         @path = path.to_s
+        @ignored_paths = ignored_paths.map { |i| i.chomp("/") }
       end
 
       def traverse
@@ -23,7 +24,7 @@ module Fasterer
 
       private
 
-      attr_reader :owner, :repo, :path
+      attr_reader :owner, :repo, :path, :ignored_paths
 
       def wrapper
         @wrapper ||= Fasterer::Github::ApiWrapper.new(owner, repo)
@@ -35,10 +36,13 @@ module Fasterer
         parsed_response = response.parsed_response
 
         if parsed_response.is_a?(Hash)
-          return unless match_regex?(parsed_response['path'])
           store_data(parsed_response)
         else
-          parsed_response.each { |item| collect_data(item['path']) }
+          parsed_response.each do |item|
+            next if ignored_paths.include?(item['path'])
+            next if item['type'] == 'file' && !ruby_file?(item['path'])
+            collect_data(item['path'])
+          end
         end
       end
 
@@ -57,8 +61,8 @@ module Fasterer
         collected_data << file_data
       end
 
-      def match_regex?(file_name)
-        file_name =~ /(.rb)$/
+      def ruby_file?(file_name)
+        file_name =~ /\.rb$/
       end
     end
   end

data/lib/fasterer/github/output_composer.rb

@@ -1,14 +1,20 @@
 module Fasterer
   module Github
     class OutputComposer
-      def initialize(owner, repo)
+
+      CONFIG_FILE_NAME = '.fasterer.yml'
+      SPEEDUPS_KEY     = 'speedups'
+
+      def initialize(owner, repo, ignored_offences)
         @repo_owner = owner
         @repo_name = repo
+        @ignored_offences = ignored_offences
       end
 
       def add_offences(offences, path)
         offences.each do |offence_name, lines|
           details = { path: path, lines: lines }
+          next if ignored_offences.include?(offence_name)
           (fasterer_offences[offence_name] ||= []) << details
         end
       end
@@ -33,7 +39,7 @@ module Fasterer
 
       private
 
-      attr_accessor :repo_owner, :repo_name
+      attr_accessor :repo_owner, :repo_name, :ignored_offences
 
       def fasterer_offences
         @fasterer_offenses ||= {}

data/lib/fasterer/github/scanner.rb

@@ -5,6 +5,11 @@ require 'fasterer/github/analyzer_extension'
 module Fasterer
   module Github
     class Scanner
+
+      CONFIG_FILE_NAME = '.fasterer.yml'
+      SPEEDUPS_KEY     = 'speedups'
+      EXCLUDE_PATHS_KEY = 'exclude_paths'
+
       def initialize(owner, repo, path)
         @owner = owner
         @repo = repo
@@ -25,11 +30,11 @@ module Fasterer
       attr_reader :owner, :repo, :path
 
       def traverser
-        @traverser ||= Fasterer::Github::GhTraverser.new(owner, repo, path)
+        @traverser ||= Fasterer::Github::GhTraverser.new(owner, repo, path, ignored_paths)
       end
 
       def output_composer
-        @output_composer ||= Fasterer::Github::OutputComposer.new(owner, repo)
+        @output_composer ||= Fasterer::Github::OutputComposer.new(owner, repo, ignored_offences)
       end
 
       def traverse_and_collect_data
@@ -46,6 +51,27 @@ module Fasterer
       else
         output_composer.add_offences(analyzer.offences, data[:path])
       end
+
+      def ignored_offences
+        loaded_config_file[SPEEDUPS_KEY].select { |_, v| v == false }.keys.map(&:to_sym)
+      end
+
+      def ignored_paths
+         loaded_config_file[EXCLUDE_PATHS_KEY]
+      end
+
+      def loaded_config_file
+        @loaded_config_file ||= load_config_file
+      end
+
+      def load_config_file
+        path_to_config = File.join(Dir.pwd, CONFIG_FILE_NAME)
+        if File.exist?(path_to_config)
+          YAML.load_file(path_to_config)
+        else
+          { SPEEDUPS_KEY => {}, EXCLUDE_PATHS_KEY => [] }
+        end
+      end
     end
   end
 end

data/lib/fasterer/github/version.rb

@@ -1,5 +1,5 @@
 module Fasterer
   module Github
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fasterer-github
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kacper Goliński
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-24 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,4 +171,3 @@ signing_key:
 specification_version: 4
 summary: Fasterer extension which allows to scan github repo.
 test_files: []
-has_rdoc: