crystalball 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7640f5ca30ab5c0d596327158afebeafe350985f
-  data.tar.gz: 2e517c5f0ddbd4b2eab12bcb7d691de92ac50ad8
+SHA256:
+  metadata.gz: 51dd1b54ddce6da0c48bf4e7c0af2618179f882523e31c3b1c670b17638c6c7f
+  data.tar.gz: b82ae8f52e5000a846c8798e4c88905a1f62d0a1aed6ff81f9483d68a91d2581
 SHA512:
-  metadata.gz: ae358c9b67c5d9b6e2d5f045eac7b02ffb7ecb9e6297358a8e91c75f0af925402f4a5c8eba201d3dbf962ca0103ac0c48278f48c34f2558bb16b82e63ce3fa8c
-  data.tar.gz: de3db6bdda14d438b8a26a0981e91231df8c05339256009499b11bee01218d3d1456500d302d92118ce10faab2e7f959e5805db15b2dba46a6b301166ffcdd58
+  metadata.gz: 575147f129b34cf224ecf749eb85da0fe36944caa7b2ce9ef60bf606cdb3449f6f38866dfd0d1ba5b1d786f25167885af5700d940aa451e4224a5eb666801462
+  data.tar.gz: fb0d841b9af7eb7d6c0889520f1297ebed58786e2729580ffcdc5d152c7f1ad6bdc1988a7cb8c45900a05c5ca151e46a12823d17d92f10ed8520781c4114cd15

data/.rubocop.yml

@@ -20,3 +20,5 @@ Style/MethodMissingSuper:
   Enabled: false
 Lint/AmbiguousBlockAssociation:
   Enabled: false
+Style/DoubleNegation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## master (not released yet)
 
+- Map storing structure reworked. Map size should be times smaller.
+
 ## Version 0.6.0
 
 - Add ModifiedSupportSpecs predictor

data/crystalball.gemspec

@@ -36,7 +36,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'actionview'
   spec.add_development_dependency 'activerecord'
-  spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency 'factory_bot'
   spec.add_development_dependency 'i18n'
   spec.add_development_dependency 'parser'
@@ -47,6 +46,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', ">= 0.56"
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sqlite3', "~> 1.3.13"
   spec.add_development_dependency 'yard'
 end

data/docs/index.md

@@ -11,7 +11,7 @@ Please check our [installation instructions](https://github.com/toptal/crystalba
 
 1. Start MapGenerator in your `spec_helper` before you loaded any file of your app. E.g.
 
-        if ENV['CRYSTALBALL'] == 'true' do
+        if ENV['CRYSTALBALL'] == 'true'
           Crystalball::MapGenerator.start! do |config|
             config.register Crystalball::MapGenerator::CoverageStrategy.new
           end

data/docs/map_generators.md

@@ -135,6 +135,16 @@ Check out the [implementation](https://github.com/toptal/crystalball/tree/master
 
 Keep in mind that all the strategies configured for the map generator will run for each example of your test suite, so it may slow down the generation process considerably.
 
+### Debugging
+
+By default MapGenerator generates compact map. In case you need plain and easily readable map add to your config:
+```ruby
+Crystalball::MapGenerator.start! do |config|
+  #...
+  config.compact_map = false
+end
+``` 
+
 ## TablesMapGenerator
 
 TablesMapGenerator is a separate map generator for Rails applications. It collects information about tables-to-models mapping and stores it in a file. The file is used by `Crystalball::Rails::Predictor::ModifiedSchema`.
@@ -147,3 +157,5 @@ Crystalball::TablesMapGenerator.start! do |config|
   config.map_storage_path = 'my_custom_tables_map_name.yml'
 end
 ```
+
+

data/lib/crystalball.rb

@@ -19,6 +19,7 @@ require 'crystalball/map_generator/coverage_strategy'
 require 'crystalball/map_generator/allocated_objects_strategy'
 require 'crystalball/map_generator/described_class_strategy'
 require 'crystalball/map_storage/yaml_storage'
+require 'crystalball/map_compactor'
 require 'crystalball/version'
 
 # Main module for the library

data/lib/crystalball/map_compactor.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+require 'crystalball/example_group_map'
+require 'crystalball/execution_map'
+require 'crystalball/map_compactor/example_groups_data_compactor'
+
+module Crystalball
+  # a module for compacting execution map by moving out repeated used files to upper contexts records.
+  module MapCompactor
+    class << self
+      # @param [Crystalball::ExecutionMap] map execution map to be compacted
+      # @return [Crystalball::ExecutionMap] compact map
+      def compact_map!(map)
+        new_map = Crystalball::ExecutionMap.new(metadata: map.metadata.to_h)
+
+        compact_examples!(map.example_groups).each do |context, used_files|
+          new_map << ExampleGroupMap.new(OpenStruct.new(id: context, file_path: example_filename(context)), used_files)
+        end
+
+        new_map
+      end
+
+      def compact_examples!(example_groups)
+        result = {}
+        example_groups.group_by { |k, _v| example_filename(k) }.each do |filename, examples|
+          compact_data = ExampleGroupsDataCompactor.compact!(examples.to_h)
+
+          compact_data.each do |context_address, used_files|
+            result["#{filename}[#{context_address}]"] = used_files unless used_files.empty?
+          end
+        end
+        result
+      end
+
+      private
+
+      def example_filename(example_id)
+        example_id.split('[').first
+      end
+    end
+  end
+end

data/lib/crystalball/map_compactor/example_context.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Crystalball
+  module MapCompactor
+    # Class representing RSpec context data
+    class ExampleContext
+      attr_reader :address
+
+      def initialize(address)
+        @address = address
+      end
+
+      def parent
+        @parent ||= begin
+          parent_uid = address.split(':')[0..-2].join(':')
+          parent_uid.empty? ? nil : self.class.new(parent_uid)
+        end
+      end
+
+      def include?(example_id)
+        example_id =~ /\[#{address}[\:\]]/
+      end
+
+      def depth
+        @depth ||= address.split(':').size
+      end
+    end
+  end
+end

data/lib/crystalball/map_compactor/example_groups_data_compactor.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'crystalball/map_compactor/example_context'
+
+module Crystalball
+  module MapCompactor
+    # Class representing example groups data compacting logic for a single file
+    class ExampleGroupsDataCompactor
+      # @param [Hash] plain_data a hash of examples and used files
+      def self.compact!(plain_data)
+        new(plain_data).compact!
+      end
+
+      def compact!
+        contexts = extract_contexts(plain_data.keys).sort_by(&:depth)
+
+        contexts.each do |context|
+          compact_data[context.address] = compact_context!(context)
+        end
+        compact_data
+      end
+
+      private
+
+      attr_reader :compact_data, :plain_data
+
+      def initialize(plain_data)
+        @plain_data = plain_data
+        @compact_data = {}
+      end
+
+      def compact_context!(context) # rubocop:disable Metrics/MethodLength
+        result = nil
+        plain_data.each do |example_uid, used_files|
+          next unless context.include?(example_uid)
+
+          if result.nil?
+            result = used_files
+            result -= deep_used_files(context.parent) if context.parent
+          else
+            result &= used_files
+          end
+        end
+        result
+      end
+
+      def deep_used_files(context)
+        result = compact_data[context.address]
+        result += deep_used_files(context.parent) if context.parent
+        result
+      end
+
+      def extract_contexts(example_uids)
+        result = []
+        example_uids.each do |example_uid|
+          context_numbers = /\[(.*)\]/.match(example_uid)[1].split(':')
+          until context_numbers.empty?
+            result << ExampleContext.new(context_numbers.join(':'))
+            context_numbers.pop
+          end
+        end
+        result.compact.uniq(&:address)
+      end
+    end
+  end
+end

data/lib/crystalball/map_generator.rb

@@ -52,7 +52,11 @@ module Crystalball
       return unless started
 
       strategies.each(&:before_finalize)
-      map_storage.dump(map.example_groups) if map.size.positive?
+
+      return unless map.size.positive?
+
+      example_groups = (configuration.compact_map? ? MapCompactor.compact_map!(map) : map).example_groups
+      map_storage.dump(example_groups)
     end
 
     def map
@@ -70,6 +74,7 @@ module Crystalball
     end
 
     def check_dump_threshold
+      return if configuration.compact_map
       return unless dump_threshold.positive? && map.size >= dump_threshold
 
       map_storage.dump(map.example_groups)

data/lib/crystalball/map_generator/configuration.rb

@@ -9,13 +9,17 @@ module Crystalball
     class Configuration
       attr_writer :map_storage
       attr_writer :map_class
-      attr_accessor :commit
-      attr_accessor :version
+      attr_accessor :commit, :version, :compact_map
 
       attr_reader :strategies
 
       def initialize
         @strategies = StrategiesCollection.new
+        @compact_map = true
+      end
+
+      def compact_map?
+        !!@compact_map
       end
 
       def map_class

data/lib/crystalball/map_storage/yaml_storage.rb

@@ -21,7 +21,7 @@ module Crystalball
 
           guard_metadata_consistency(meta)
 
-          Object.const_get(meta.first[:type]).new(metadata: meta.first, example_groups: example_groups.inject(&:merge!))
+          Object.const_get(meta.first[:type]).new(metadata: meta.first, example_groups: example_groups.compact.inject(&:merge!))
         end
 
         private

data/lib/crystalball/source_diff.rb

@@ -2,6 +2,7 @@
 
 require 'crystalball/source_diff/file_diff'
 require 'crystalball/source_diff/formatting_checker'
+require 'forwardable'
 
 module Crystalball
   # Wrapper class representing Git source diff for given repo

data/lib/crystalball/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crystalball
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Pavel Shutsin
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -54,20 +54,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -212,16 +198,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +261,9 @@ files:
 - lib/crystalball/factory_bot.rb
 - lib/crystalball/git_repo.rb
 - lib/crystalball/logging.rb
+- lib/crystalball/map_compactor.rb
+- lib/crystalball/map_compactor/example_context.rb
+- lib/crystalball/map_compactor/example_groups_data_compactor.rb
 - lib/crystalball/map_generator.rb
 - lib/crystalball/map_generator/allocated_objects_strategy.rb
 - lib/crystalball/map_generator/allocated_objects_strategy/object_tracker.rb
@@ -350,8 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library for RSpec regression test selection