miss_cleo 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 630dc170c4e5fa41d6b7065b750dc9f07616b1bf
-  data.tar.gz: 3add2d4e3b0a222a3e1f0f9c4736829d6e42c39a
+  metadata.gz: ff4da2d11102916af50405184a3d1ee99179c42a
+  data.tar.gz: 678874911854e9a25391e862bf25fc0b421a487e
 SHA512:
-  metadata.gz: 44af7a7fecb387a9cd5909beb63583889b3d64450de17f2718279c454875894eae901878a35f762aeeea5a0f4c300b0a32860076353a91abd1402cbb97090ca9
-  data.tar.gz: 986641acb95593f84854d59c17b2873d4a98e15e320a74ebc047ddf80be0983a78b20e4fc20d93950fbcf738a7a6fea1b040d8200bcc2cdf14148a767a74289f
+  metadata.gz: 3f4c17cc829f5f124a563f06afcef8e85e962dd57e00edab71371afc2c8368f844ff6df4c1b831f3b400758b493a42a0b19098c8d2eafecc69be00c5774de8c7
+  data.tar.gz: 6248365c072bfeef740ad36401decad5942a9474909bbd7a8d37e624407da27b74060c801b7037e5a46f6df5e34a0ac31daf9e4af14594f54920e45e20da4dad

data/bin/miss_cleo

@@ -1,18 +1,32 @@
 #!/usr/bin/env ruby
 
 require "miss_cleo"
-include ::MissCleo::CoverageMapHelper
 
 case ARGV.first
 when "build_deck"
-  build_deck(ARGV[1..-1])
+  files = ARGV[1..-1]
+  puts "Building your deck with #{files}"
+  coverage_map = ::MissCleo::CoverageMap.build(files)
+  puts "Saving map as zip file"
+  ::MissCleo::CoverageMapUtilities::SaveZip.zip(coverage_map)
 when "predict"
   unless ARGV[1]
     puts "Specify a coverage map."
     puts "e.g. 'miss_cleo predict map.json.gz"
   else
-    map = File.open(ARGV[1]).read.gunzip
-    predict(map)
+    raw_map = File.open(ARGV[1]).read.gunzip
+    map = ::MissCleo::CoverageMap.new(JSON.parse(raw_map))
+    lines_changed = ::MissCleo::DiffDetector.lines_changed
+    tests_to_run = ::MissCleo::TestSelector.predict(map, lines_changed)
+    if lines_changed.empty?
+      puts "No line changes detected."
+    elsif tests_to_run.empty?
+      puts "No tests found. May be due to blind spot, new tests you've just written, or the changes may be untested."
+    else
+      puts "Run these tests:"
+      puts tests_to_run.sort.reverse
+      ::MissCleo::TestRunner.new(tests_to_run, lines_changed).run_tests
+    end
   end
 else
   puts "Please run miss_cleo with 'build_deck' or 'predict'."

data/lib/miss_cleo.rb

@@ -11,9 +11,13 @@ require 'miss_cleo/coverage_filter'
 require 'miss_cleo/coverage_map'
 require 'miss_cleo/test_configurations/cucumber_config'
 require 'miss_cleo/test_configurations/rspec_config'
-require 'miss_cleo/coverage_map_helper.rb'
 require 'miss_cleo/test_configurations/rails_action_view_config'
 require 'miss_cleo/template_tracker'
+require 'miss_cleo/tests_to_files_map_logger'
+require 'miss_cleo/coverage_map_utilities/save_zip'
+require 'miss_cleo/test_selector'
+require 'miss_cleo/diff_detector'
+require 'miss_cleo/test_runner'
 
 module MissCleo
 end

data/lib/miss_cleo/coverage_filter.rb

@@ -1,17 +1,17 @@
 module MissCleo
-  class CoverageFilter
+  module CoverageFilter
+    module_function
     GEM_PATHS = ENV["GEM_PATH"].split(":")
     RUBY_PATH = `which ruby`.chomp.gsub("/bin/ruby","")
 
-    def self.filter_core(result_hash)
-
+    def filter_core(result_hash)
       # Don't include gems in coverage map
       result_hash.reject do |file, line|
         ([RUBY_PATH] + GEM_PATHS).any? { |path| file.include?(path) }
       end
     end
 
-    def self.normalize_paths(result_hash)
+    def normalize_paths(result_hash)
       normalized_hash = Hash.new
       result_hash.each do |key, value|
         trimmed_key = key.gsub(/#{Regexp.quote(`pwd`.chomp)}\//, "")
@@ -21,11 +21,13 @@ module MissCleo
       normalized_hash
     end
 
-    def self.filter_and_trim(result_hash)
+    def filter_and_trim(result_hash)
       filtered = filter_core(result_hash)
       normalize_paths(filtered)
     end
 
+    private_class_method :filter_core
+    private_class_method :normalize_paths
   end
 
 end

data/lib/miss_cleo/coverage_map.rb

@@ -1,6 +1,23 @@
 module MissCleo
   class CoverageMap
 
+    def self.build(file_names)
+      cov_map = self.new
+      file_names.each do |file_name|
+        File.open(file_name, "r") do |f|
+          f.read
+        end.tap do |contents|
+          begin
+            cov_map.add_to_coverage_map(JSON.parse(contents))
+          rescue
+            puts "#{file_name} is malformed, this may affect test predictons"
+          end
+        end
+      end
+
+      cov_map
+    end
+
     attr_reader :map
 
     def initialize(map = nil)

data/lib/miss_cleo/coverage_map_utilities/save_zip.rb

@@ -0,0 +1,13 @@
+module MissCleo
+  module CoverageMapUtilities
+    module SaveZip
+      module_function
+
+      def zip(coverage_map)
+        File.open("total_coverage_map.json.gz", "w") do |f|
+          f.write(JSON.dump(coverage_map.map).gzip)
+        end
+      end
+    end
+  end
+end

data/lib/miss_cleo/diff_detector.rb

@@ -0,0 +1,35 @@
+module MissCleo
+  module DiffDetector
+    module_function
+    def lines_changed
+      Set.new.tap do |changed_lines|
+        repo = Rugged::Repository.new '.'
+        repo.index.diff.each_patch do |patch|
+          file = patch.delta.old_file[:path]
+
+          patch.each_hunk do |hunk|
+            hunk.each_line do |line|
+              case line.line_origin
+              when :addition
+                changed_lines << [file, line.new_lineno] unless exclude_from_map?(file)
+              when :deletion
+                changed_lines << [file, line.old_lineno] unless exclude_from_map?(file)
+              when :context
+                # do nothing
+              end
+            end
+          end
+        end
+
+      end
+    end
+
+
+    def exclude_from_map?(file_name)
+      # Let's add a configuration for ignored files
+      file_name == "db/structure.sql"
+    end
+
+    private_class_method :exclude_from_map?
+  end
+end

data/lib/miss_cleo/test_configurations/cucumber_config.rb

@@ -2,27 +2,25 @@ module MissCleo
   module TestConfigurations
     class CucumberConfig
       CUCUMBER_MAP = "cucumber_map.json"
-      LOGS = []
 
       def self.setup_hooks(context)
-        if ENV["COVERAGE"]
-          MissCleo::TemplateTracker.initialize_tracker
-          ActionView::Template.prepend MissCleo::TestConfigurations::ActionViewConfig if defined? ActionView::Template
-          Coverage.start
-          context.Around do |scenario, execute|
-            MissCleo::TemplateTracker.clear_templates
-            before = Coverage.peek_result
-            execute.call
-            after = Coverage.peek_result
-            templates = MissCleo::TemplateTracker.templates.uniq
-            if file_and_line = scenario.try(:file_colon_line)
-              LOGS << [ file_and_line, { before: CoverageFilter.filter_and_trim(before), after: CoverageFilter.filter_and_trim(after), templates: templates } ]
-            end
+        map_logger = MissCleo::TestsToFilesMapLogger.new(CUCUMBER_MAP)
+        MissCleo::TemplateTracker.initialize_tracker
+        ActionView::Template.prepend MissCleo::TestConfigurations::ActionViewConfig if defined? ActionView::Template
+        Coverage.start
+        context.Around do |scenario, execute|
+          MissCleo::TemplateTracker.clear_templates
+          before = Coverage.peek_result
+          execute.call
+          after = Coverage.peek_result
+          templates = MissCleo::TemplateTracker.templates.uniq
+          if file_and_line = scenario.try(:file_colon_line)
+            map_logger.add_to_log(file_and_line, before, after, templates)
           end
+        end
 
-          at_exit do
-            File.open(CUCUMBER_MAP, 'w') { |f| f.write JSON.dump LOGS }
-          end
+        at_exit do
+          map_logger.export_logs
         end
       end
     end

data/lib/miss_cleo/test_configurations/rspec_config.rb

@@ -2,29 +2,23 @@ module MissCleo
   module TestConfigurations
     class RspecConfig
       RSPEC_MAP = "rspec_map.json"
-      LOGS = []
 
-      def self.setup_hooks(context)
-        if ENV["COVERAGE"]
-          MissCleo::TemplateTracker.initialize_tracker
-          ActionView::Template.prepend MissCleo::TestConfigurations::ActionViewConfig if defined? ActionView::Template
-          Coverage.start
-          RSpec.configuration.after(:suite) do
-            File.open(RSPEC_MAP, 'w') { |f| f.write JSON.dump LOGS }
-          end
+      def self.setup_hooks
+        logger = MissCleo::TestsToFilesMapLogger.new(RSPEC_MAP)
+        MissCleo::TemplateTracker.initialize_tracker
+        ActionView::Template.prepend MissCleo::TestConfigurations::ActionViewConfig if defined? ActionView::Template
+        Coverage.start
+        RSpec.configuration.after(:suite) do
+          logger.export_logs
+        end
 
-          RSpec.configuration.around(:example) do |example|
-            MissCleo::TemplateTracker.clear_templates
-            before = Coverage.peek_result
-            example.call
-            after = Coverage.peek_result
-            templates = MissCleo::TemplateTracker.templates.uniq
-            LOGS << [ example.location, {
-              before: CoverageFilter.filter_and_trim(before),
-              after: CoverageFilter.filter_and_trim(after),
-              templates: templates
-            } ]
-          end
+        RSpec.configuration.around(:example) do |example|
+          MissCleo::TemplateTracker.clear_templates
+          before = Coverage.peek_result
+          example.call
+          after = Coverage.peek_result
+          templates = MissCleo::TemplateTracker.templates.uniq
+          logger.add_to_log(example.location, before, after, templates)
         end
       end
     end

data/lib/miss_cleo/test_runner.rb

@@ -0,0 +1,38 @@
+module MissCleo
+  class TestRunner
+    def initialize(tests_to_run, lines_changed)
+      @tests_to_run = tests_to_run
+      @lines_changed = lines_changed
+    end
+
+    def run_tests
+      # come up with a better way to register tests and test execution
+      exec_command = "bundle exec"
+      cukes = tests_to_run.select { |test| test.match(/^feature/) }
+      specs = tests_to_run.select { |test| test.match(/^\.\/spec/) }
+      run_cukes = cukes.empty? ? "" : "#{exec_command} cucumber #{cukes.join(" ")}"
+      run_specs = specs.empty? ? "" : "#{exec_command} rspec #{specs.join(" ")}"
+      spec_line = specs.empty? ? nil : "(s)pecs"
+      cuke_line = cukes.empty? ? nil : "(c)ukes"
+      both_line = specs.empty? || cukes.empty? ? nil : "(B)oth cukes and specs"
+      puts "Run: " + [spec_line, cuke_line, both_line].compact.join(", ") + " or (n)othing:"
+      response = STDIN.gets.chomp
+      case response
+      when "s"
+        puts "Running only specs..."
+        exec run_specs
+      when "c"
+        puts "Running only cukes..."
+        exec run_cukes
+      when "n"
+      else
+        puts "Running both specs and cukes..."
+        exec [run_cukes, run_specs].join("; ")
+      end
+    end
+
+    private
+
+    attr_reader :tests_to_run, :lines_changed
+  end
+end

data/lib/miss_cleo/test_selector.rb

@@ -0,0 +1,14 @@
+module MissCleo
+  module TestSelector
+    module_function
+
+    def predict(coverage_map, lines_changed)
+      tests_to_run = []
+      lines_changed.each do |file, line|
+        tests_to_run |= coverage_map.tests_for_lines(file, line)
+      end
+
+      tests_to_run.sort.reverse
+    end
+  end
+end

data/lib/miss_cleo/tests_to_files_map_logger.rb

@@ -0,0 +1,30 @@
+module MissCleo
+  class TestsToFilesMapLogger
+
+    def initialize(file_name)
+      @logs = []
+      @file_name = file_name
+    end
+
+    def add_to_log(test_file_and_line, lines_run_before, lines_run_after, templates)
+      logs << [ test_file_and_line, {
+        before: filter(lines_run_before),
+        after: filter(lines_run_after),
+        templates: templates
+      }]
+    end
+
+    def export_logs
+      File.open(file_name, 'w') { |f| f.write JSON.dump logs }
+    end
+
+    private
+
+    attr_accessor :logs
+    attr_reader :file_name
+
+    def filter(lines_run)
+      MissCleo::CoverageFilter.filter_and_trim(lines_run)
+    end
+  end
+end

data/lib/miss_cleo/version.rb

@@ -1,3 +1,3 @@
 module MissCleo
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

data/miss_cleo.gemspec

@@ -17,10 +17,12 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = ["miss_cleo"]
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7.6"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.5.0"
   spec.add_development_dependency "pry", "~> 0.9.12"
+  spec.add_development_dependency "rspec"
   spec.add_runtime_dependency "rugged", "~> 0.23.3"
   spec.add_runtime_dependency "gzip", "~> 1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miss_cleo
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Dean Hu
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -105,11 +119,15 @@ files:
 - lib/miss_cleo.rb
 - lib/miss_cleo/coverage_filter.rb
 - lib/miss_cleo/coverage_map.rb
-- lib/miss_cleo/coverage_map_helper.rb
+- lib/miss_cleo/coverage_map_utilities/save_zip.rb
+- lib/miss_cleo/diff_detector.rb
 - lib/miss_cleo/template_tracker.rb
 - lib/miss_cleo/test_configurations/cucumber_config.rb
 - lib/miss_cleo/test_configurations/rails_action_view_config.rb
 - lib/miss_cleo/test_configurations/rspec_config.rb
+- lib/miss_cleo/test_runner.rb
+- lib/miss_cleo/test_selector.rb
+- lib/miss_cleo/tests_to_files_map_logger.rb
 - lib/miss_cleo/version.rb
 - miss_cleo.gemspec
 homepage: http://github.com/gust/miss_cleo
@@ -124,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -132,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Regression Test Selection

data/lib/miss_cleo/coverage_map_helper.rb

@@ -1,73 +0,0 @@
-module MissCleo
-  module CoverageMapHelper
-
-    def build_deck(file_names)
-      cov_map = ::MissCleo::CoverageMap.new
-      file_names.each do |file_name|
-        File.open(file_name, "r") do |f|
-          f.read
-        end.tap do |contents|
-          begin
-            cov_map.add_to_coverage_map(JSON.parse(contents))
-          rescue
-            puts "#{file_name} is malformed, this may affect test predictons"
-          end
-        end
-      end
-
-      File.open("total_coverage_map.json.gz", "w") do |f|
-        f.write(JSON.dump(cov_map.map).gzip)
-      end
-    end
-
-    def predict(unzipped_file)
-      coverage_map = ::MissCleo::CoverageMap.new(JSON.parse(unzipped_file))
-      tests_to_run = []
-      lines_changed.each do |file, line|
-        tests_to_run |= coverage_map.tests_for_lines(file, line)
-      end
-      if lines_changed.empty?
-        puts "No line changes detected."
-      elsif tests_to_run.empty?
-        puts "No tests found. May be due to blind spot, new tests you've just written, or the changes may be untested."
-      else
-        puts "Run these tests:"
-        puts tests_to_run.sort.reverse
-      end
-
-      tests_to_run
-    end
-
-
-    private
-
-    def exclude_from_map?(file_name)
-      # Let's add a configuration for ignored files
-      file_name == "db/structure.sql"
-    end
-
-
-    def lines_changed
-      @_lines_changed ||= Set.new.tap do |changed_lines|
-        repo = Rugged::Repository.new '.'
-        repo.index.diff.each_patch do |patch|
-          file = patch.delta.old_file[:path]
-
-          patch.each_hunk do |hunk|
-            hunk.each_line do |line|
-              case line.line_origin
-              when :addition
-                changed_lines << [file, line.new_lineno] unless exclude_from_map?(file)
-              when :deletion
-                changed_lines << [file, line.old_lineno] unless exclude_from_map?(file)
-              when :context
-                # do nothing
-              end
-            end
-          end
-        end
-
-      end
-    end
-  end
-end