crystalball 0.5.0 → 0.6.0

data/lib/crystalball/rspec/runner/configuration.rb

@@ -1,28 +1,30 @@
 # frozen_string_literal: true
 
-require 'crystalball/simple_predictor'
+require 'crystalball/rspec/standard_prediction_builder'
 
 module Crystalball
   module RSpec
     class Runner
       # Class for storing local runner configuration
       class Configuration
-        def initialize(config = {})
+        def initialize(config = {}) # rubocop:disable Metrics/MethodLength
           @values = {
-            'map_path' => 'tmp/execution_maps',
+            'execution_map_path' => 'tmp/crystalball_data.yml',
             'map_expiration_period' => 86_400,
             'repo_path' => Dir.pwd,
-            'predictor_class_name' => 'Crystalball::SimplePredictor',
             'requires' => [],
             'diff_from' => 'HEAD',
             'diff_to' => nil,
-            'runner_class_name' => 'Crystalball::RSpec::Runner'
+            'runner_class_name' => 'Crystalball::RSpec::Runner',
+            'prediction_builder_class_name' => 'Crystalball::RSpec::StandardPredictionBuilder',
+            'log_level' => :info,
+            'log_file' => 'log/crystalball.log'
           }.merge(config)
         end
 
         def to_h
           dynamic_values = {}
-          (private_methods - Object.private_instance_methods - %i[run_requires values]).each do |method|
+          (private_methods - Object.private_instance_methods - %i[run_requires values raw_value]).each do |method|
             dynamic_values[method.to_s] = send(method)
           end
 
@@ -30,16 +32,20 @@ module Crystalball
         end
 
         def [](key)
-          respond_to?(key, true) ? send(key) : values[key]
+          respond_to?(key, true) ? send(key) : raw_value(key)
         end
 
         private
 
-        def predictor_class
-          @predictor_class ||= begin
+        def raw_value(key)
+          ENV.fetch("CRYSTALBALL_#{key.to_s.upcase}", values[key])
+        end
+
+        def prediction_builder_class
+          @prediction_builder_class ||= begin
             run_requires
 
-            Object.const_get(self['predictor_class_name'])
+            Object.const_get(self['prediction_builder_class_name'])
           end
         end
 
@@ -51,18 +57,22 @@ module Crystalball
           end
         end
 
-        def map_path
-          @map_path ||= Pathname.new(values['map_path'])
+        def execution_map_path
+          @execution_map_path ||= Pathname.new(raw_value('execution_map_path'))
         end
 
         def repo_path
-          @repo_path ||= Pathname.new(values['repo_path'])
+          @repo_path ||= Pathname.new(raw_value('repo_path'))
+        end
+
+        def log_file
+          @log_file ||= Pathname.new(raw_value('log_file'))
         end
 
         attr_reader :values
 
         def run_requires
-          self['requires'].each { |f| require f }
+          Array(self['requires']).each { |f| require f }
         end
       end
     end

data/lib/crystalball/rspec/standard_prediction_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Crystalball
+  module RSpec
+    # Simple version of predictor
+    class StandardPredictionBuilder < PredictionBuilder
+      private
+
+      def predictor
+        super do |p|
+          p.use Crystalball::Predictor::ModifiedExecutionPaths.new
+          p.use Crystalball::Predictor::ModifiedSpecs.new
+        end
+      end
+    end
+  end
+end

data/lib/crystalball/source_diff.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'crystalball/source_diff/file_diff'
+require 'crystalball/source_diff/formatting_checker'
 
 module Crystalball
   # Wrapper class representing Git source diff for given repo
@@ -8,7 +9,8 @@ module Crystalball
     include Enumerable
     extend Forwardable
 
-    delegate %i[stats size lines from to] => :git_diff
+    delegate %i[stats lines from to] => :git_diff
+    alias size count
 
     # @param [Git::Diff] git_diff raw diff made by ruby-git gem
     def initialize(git_diff)
@@ -25,13 +27,21 @@ module Crystalball
       changeset.none?
     end
 
+    # @return [Git::Base]
+    def repository
+      @repository ||= git_diff.instance_variable_get(:@base)
+    end
+
     private
 
     attr_reader :git_diff
 
     # TODO: Include untracked to changeset
     def changeset
-      @changeset ||= git_diff.map { |file_diff| FileDiff.new(file_diff) }
+      @changeset ||= git_diff.map do |diff_file|
+        file_diff = FileDiff.new(diff_file)
+        file_diff unless FormattingChecker.pure_formatting?(file_diff)
+      end.compact
     end
   end
 end

data/lib/crystalball/source_diff/file_diff.rb

@@ -10,7 +10,7 @@ module Crystalball
       end
 
       def moved?
-        git_diff.patch =~ /rename from.*\nrename to/
+        !(git_diff.patch =~ /rename from.*\nrename to/).nil?
       end
 
       def modified?

data/lib/crystalball/source_diff/formatting_checker.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Crystalball
+  class SourceDiff
+    # Determinates if file_diff's patch contains changes for whitespaces or comments only
+    module FormattingChecker
+      class << self
+        # Returns `true` if file_diff's patch contains changes for whitespaces or comments only
+        #
+        # @param [Crystalball::SourceDiff::FileDiff] file_diff
+        # @return [Boolean]
+        def pure_formatting?(file_diff)
+          return false unless stripable_file?(file_diff.path) && file_diff.modified?
+
+          patch = file_diff.patch.to_s.lines
+
+          return true if patch.empty?
+
+          added = collect_patch(patch, '+')
+          removed = collect_patch(patch, '-')
+
+          trim_patch(added) == trim_patch(removed)
+        end
+
+        private
+
+        STRIPABLE_FILES = %w[.rb .erb].freeze # TODO: move to config
+
+        def stripable_file?(file_name)
+          STRIPABLE_FILES.include?(Pathname(file_name).extname)
+        end
+
+        def collect_patch(patch, sign)
+          patch.each.with_object([]) do |line, result|
+            next if line.start_with?('+++', '---', '@@') # Skip meta of a patch
+
+            result << line[1..-1] if line.start_with?(sign, ' ')
+          end
+        end
+
+        def trim_patch(patch)
+          patch.map do |line|
+            line = line.gsub(/\s/, '')
+            line.start_with?('#') || line.empty? ? nil : line
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/crystalball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crystalball
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/mkdocs.yml

@@ -0,0 +1,23 @@
+site_name: Crystalball Manual
+repo_url: https://github.com/toptal/crystalball
+edit_uri: edit/master/docs/
+#google_analytics: ['-', 'auto']
+theme:
+  name: material
+  logo: img/logo.png
+  favicon: img/favicon.ico
+  palette:
+    primary: indigo
+    accent: pink
+markdown_extensions:
+  - admonition
+  - codehilite:
+      guess_lang: false
+  - toc:
+      permalink: true
+copyright: 'Copyright © 2013 - 2018 Toptal'
+pages:
+  - Home: index.md
+  - "Map Generators": map_generators.md
+  - "Predictors": predictors.md
+  - "Runner": runner.md

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: crystalball
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Pavel Shutsin
+- Evgenii Pecherkin
+- Jaimerson Araujo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -38,6 +40,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +68,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +96,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +172,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.56'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.56'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +208,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +249,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -200,10 +259,22 @@ files:
 - bin/crystalball
 - bin/setup
 - crystalball.gemspec
+- docs/img/favicon.ico
+- docs/img/logo.png
+- docs/index.md
+- docs/map_generators.md
+- docs/predictors.md
+- docs/runner.md
 - lib/crystalball.rb
-- lib/crystalball/case_map.rb
+- lib/crystalball/active_record.rb
+- lib/crystalball/example_group_map.rb
 - lib/crystalball/execution_map.rb
+- lib/crystalball/extensions/git.rb
+- lib/crystalball/extensions/git/base.rb
+- lib/crystalball/extensions/git/lib.rb
+- lib/crystalball/factory_bot.rb
 - lib/crystalball/git_repo.rb
+- lib/crystalball/logging.rb
 - lib/crystalball/map_generator.rb
 - lib/crystalball/map_generator/allocated_objects_strategy.rb
 - lib/crystalball/map_generator/allocated_objects_strategy/object_tracker.rb
@@ -212,30 +283,54 @@ files:
 - lib/crystalball/map_generator/coverage_strategy.rb
 - lib/crystalball/map_generator/coverage_strategy/execution_detector.rb
 - lib/crystalball/map_generator/described_class_strategy.rb
+- lib/crystalball/map_generator/factory_bot_strategy.rb
+- lib/crystalball/map_generator/factory_bot_strategy/dsl_patch.rb
+- lib/crystalball/map_generator/factory_bot_strategy/dsl_patch/factory_path_fetcher.rb
+- lib/crystalball/map_generator/factory_bot_strategy/factory_gem_loader.rb
+- lib/crystalball/map_generator/factory_bot_strategy/factory_runner_patch.rb
 - lib/crystalball/map_generator/helpers/path_filter.rb
 - lib/crystalball/map_generator/object_sources_detector.rb
 - lib/crystalball/map_generator/object_sources_detector/definition_tracer.rb
 - lib/crystalball/map_generator/object_sources_detector/hierarchy_fetcher.rb
+- lib/crystalball/map_generator/parser_strategy.rb
+- lib/crystalball/map_generator/parser_strategy/processor.rb
 - lib/crystalball/map_generator/strategies_collection.rb
 - lib/crystalball/map_storage/yaml_storage.rb
 - lib/crystalball/prediction.rb
 - lib/crystalball/predictor.rb
 - lib/crystalball/predictor/associated_specs.rb
+- lib/crystalball/predictor/helpers/affected_example_groups_detector.rb
+- lib/crystalball/predictor/helpers/path_formatter.rb
 - lib/crystalball/predictor/modified_execution_paths.rb
 - lib/crystalball/predictor/modified_specs.rb
+- lib/crystalball/predictor/modified_support_specs.rb
+- lib/crystalball/predictor/strategy.rb
 - lib/crystalball/predictor_evaluator.rb
 - lib/crystalball/rails.rb
+- lib/crystalball/rails/helpers/base_schema_parser.rb
+- lib/crystalball/rails/helpers/schema_definition_parser.rb
+- lib/crystalball/rails/helpers/schema_definition_parser/active_record.rb
+- lib/crystalball/rails/helpers/schema_definition_parser/table_content_parser.rb
 - lib/crystalball/rails/map_generator/action_view_strategy.rb
 - lib/crystalball/rails/map_generator/action_view_strategy/patch.rb
 - lib/crystalball/rails/map_generator/i18n_strategy.rb
 - lib/crystalball/rails/map_generator/i18n_strategy/simple_patch.rb
+- lib/crystalball/rails/predictor/modified_schema.rb
+- lib/crystalball/rails/tables_map.rb
+- lib/crystalball/rails/tables_map_generator.rb
+- lib/crystalball/rails/tables_map_generator/configuration.rb
+- lib/crystalball/rspec/filtering.rb
 - lib/crystalball/rspec/prediction_builder.rb
+- lib/crystalball/rspec/prediction_pruning.rb
+- lib/crystalball/rspec/prediction_pruning/examples_pruner.rb
 - lib/crystalball/rspec/runner.rb
 - lib/crystalball/rspec/runner/configuration.rb
-- lib/crystalball/simple_predictor.rb
+- lib/crystalball/rspec/standard_prediction_builder.rb
 - lib/crystalball/source_diff.rb
 - lib/crystalball/source_diff/file_diff.rb
+- lib/crystalball/source_diff/formatting_checker.rb
 - lib/crystalball/version.rb
+- mkdocs.yml
 homepage: https://github.com/toptal/crystalball
 licenses: []
 metadata:
@@ -256,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A library for RSpec regression test selection