mrspec 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3716393cd836e1e228ee410a752fa456251a14a
-  data.tar.gz: db2dd4b64131c69a5e515553851200758f07b7d9
+  metadata.gz: cdd22bb539e153f142c4077fdce46540ceee9a7f
+  data.tar.gz: b4452df608986b9ffea6c42c4d04c32309f30e43
 SHA512:
-  metadata.gz: 2a337f4dff9c32fe226680d45d3168a5de4ccd22dc133d9f99c77e49d9fe14806a0634df8b0633840bb7ba3cc0d3a04b3ff99edb5663f9a9da742bf5f72b8663
-  data.tar.gz: bb1f71b60212884a1bebc4e591fbd2e820f79dd7285365ebccadff6f2a19c9b424a59d3f4ac389c2da8724282409f92bbb5cdfe2b9bd212d9acfacebaf199bce
+  metadata.gz: ca074f1e8fccb7bc5d7a16c66f37b9587294b97859655dab04c003923cfb6f52a21b4df80eca30df1c402a3e62a318e67bcb56f75163953575b4703e20e814d8
+  data.tar.gz: b1a4c586ffe977c060fd0e2d4a653e2496582b19e598ec2b06d8c5282c07e6c471e791a39707396165a06b101d447a567908aa964b86e3a8e5794f0f6a7de190

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 script:   bin/mrspec --colour --format documentation && cucumber
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.2
   - 2.2.2

data/Readme.md

@@ -235,6 +235,26 @@ because I don't currently have any features I'm trying to add.
 As I maintain this, though, I'll begin implementing them,
 as it will be easier in the end :)
 
+Run mrpsec as the Rake Test Task
+-------------------------------
+Add this to your `Rakefile` in your Rails App Root Dir
+below`Rails.application.load_tasks`
+
+```ruby
+# ----- To run minitest is the bit that I added -----
+# I know it's ridiculous, but there isn't a better way, it's what RSpec does, too:
+# https://github.com/rspec/rspec-rails/blob/682a12067eab233c646057f984692e3b70749f32/lib/rspec/rails/tasks/rspec.rake#L2-L4
+tasks = Rake.application.instance_variable_get('@tasks')
+tasks['test'].clear_actions if tasks['test']
+tasks['spec'].clear_actions if tasks['spec']
+
+mrspec = Proc.new do
+  sh 'mrspec', '--fail-fast'
+end
+
+task :test, &mrspec
+task :spec, &mrspec
+```
 
 Attribution
 -----------

data/features/mrspec.feature

@@ -592,6 +592,7 @@ Feature: mrspec
     Then the program ran successfully
     And stdout includes "I got loaded!"
 
+
   Scenario: Correctly hooks up everything up to enable advanced analysis features
     Given the file "whatev.rb":
     """
@@ -611,3 +612,27 @@ Feature: mrspec
     """
     When I run 'mrspec whatev.rb'
     Then stdout includes "misspell"
+
+
+  Scenario: Can invoke Minitest::Spec with line numbers (#21)
+    Given the file "line_nums_spec.rb":
+    """
+    require 'minitest/spec'
+    describe "group" do
+      it "passing-example" do
+        assert_equal true, true
+      end
+      it "failing-example" do
+        assert_equal true, false
+      end
+    end
+    """
+
+    When I run "mrspec line_nums_spec.rb --format progress"
+    Then stdout includes "2 examples, 1 failure"
+
+    When I run "mrspec line_nums_spec.rb:3 --format progress"
+    Then stdout includes "1 example, 0 failures"
+
+    When I run "mrspec line_nums_spec.rb:6 --format progress"
+    Then stdout includes "1 example, 1 failure"

data/lib/mrspec/add_options_to_rspec_parser.rb

@@ -1,5 +1,10 @@
-require 'rspec/core/option_parser'
+# Since 3.5, it's worth checking to see if we can get rid of this class and just
+# hijack it in the runner or something. Essentially, they moved away from having
+# the parser calling exit and printing directly, so we might be able to sit above
+# it and compose it rather than going into its guts and guerilla patching it.
+# But not going to do that now b/c got shit to do w/ my life, yo.
 
+require 'rspec/core/option_parser'
 class RSpec::Core::Parser
   # Trying to mitigate the invasiveness of this code.
   # It's not great, but it's better than unconditionally overriding the method.
@@ -13,8 +18,8 @@ class RSpec::Core::Parser
   public :rspec_parser
 
   # Ours calls RSpec's, then modifies values on the returned parser
-  def mrspec_parser(*args, &b)
-    option_parser = rspec_parser(*args, &b)
+  def mrspec_parser(options, *args, &b)
+    option_parser = rspec_parser(options, *args, &b)
 
     # update the program name
     option_parser.banner.gsub! /\brspec\b/, 'mrspec'
@@ -23,11 +28,7 @@ class RSpec::Core::Parser
     # calling exit and toplevel puts, b/c that's what RSpec's does https://github.com/rspec/rspec-core/blob/c7c1154934c42b5f6905bb7bd22025fe6c8a816c/lib/rspec/core/option_parser.rb#L290
     # and I don't feel like figuring out how to work around it.
     option_parser.on('-v', '--version', 'Display the version.') do
-      $stdout.puts "mrspec     #{MRspec::VERSION}\n"\
-                   "rspec-core #{RSpec::Core::Version::STRING}\n"\
-                   "minitest   #{Minitest::VERSION}\n"\
-                   "wwhhiae2c  #{ErrorToCommunicate::VERSION}\n"
-      exit
+      options[:runner] = method :print_mrspec_version
     end
 
     format_description = option_parser.top.short['f'].desc
@@ -50,4 +51,12 @@ class RSpec::Core::Parser
   define_method :parser do |*args, &b|
     self.class.parser_method.bind(self).call(*args, &b)
   end
+
+  def print_mrspec_version(_opts, _err, out)
+    out.puts "mrspec     #{MRspec::VERSION}\n"\
+             "rspec-core #{RSpec::Core::Version::STRING}\n"\
+             "minitest   #{Minitest::VERSION}\n"\
+             "wwhhiae2c  #{ErrorToCommunicate::VERSION}\n"
+  end
 end
+

data/lib/mrspec/declare_minitests.rb

@@ -39,15 +39,18 @@ module MRspec
     end
 
     def wrap_class(rspec, klass)
-      example_group = rspec.describe group_name(klass), klass.class_metadata
-      klass.runnable_methods.each do |method_name|
-        wrap_test example_group, klass, method_name
-      end
+      tests    = get_tests(klass)
+      metadata = initial_metadata tests, klass.class_metadata, -1
+      group    = rspec.describe group_name(klass), metadata
+      tests.each { |mname, file, line| wrap_test group, klass, mname, file, line }
     end
 
-    def wrap_test(example_group, klass, mname)
-      metadata = klass.example_metadata[mname.intern]
-      example  = example_group.example example_name(mname), metadata do
+    def wrap_test(example_group, klass, mname, file, line)
+      metadata = initial_metadata [[mname, file, line]],
+                                  klass.example_metadata[mname.intern],
+                                  0
+
+      example = example_group.example example_name(mname), metadata do
         instance = Minitest.run_one_method klass, mname
         next              if instance.passed?
         pending 'skipped' if instance.skipped?
@@ -55,16 +58,38 @@ module MRspec
         raise error unless error.kind_of? Minitest::Assertion
         raise MinitestAssertionForRSpec.new error
       end
-      fix_metadata example.metadata, klass.instance_method(mname)
     end
 
-    def fix_metadata(metadata, method)
-      file, line = method.source_location
-      return unless file && line # not sure when this wouldn't be true, so no tests on it, but hypothetically it could happen
-      metadata[:file_path]          = file
-      metadata[:line_number]        = line
-      metadata[:location]           = "#{file}:#{line}"
-      metadata[:absolute_file_path] = File.expand_path(file)
+    def get_tests(klass)
+      klass.runnable_methods
+           .map { |mname| [mname, *klass.instance_method(mname).source_location] }
+           .sort_by { |name, file, line| line }
+    end
+
+    def initial_metadata(tests, existing_metadat, offset)
+      # There is a disagreement here:
+      # In RSpec, each describe block is its own example group, so the group will
+      # all be defined in the same file. In Minitest, the example group is a class,
+      # which can be reopened, thus the group can exist in multiple files.
+      # I'm just going to ignore it for now, but prob the right thing to do is
+      # to split the test methods into groups based on what file they are defined
+      # in, and then what class they are defined in (currently, it is only what
+      # class they are defined in)
+      #
+      # Leaving mrspec stuff in the backtrace, though, that way if we can't
+      # successfully guess the caller, then it's more helpful as someone tries
+      # to figure out wtf happened
+      guessed_caller_entry = nil
+      tests
+        .select { |name, file, line| file && line }
+        .take(1)
+        .each { |_, file, line| guessed_caller_entry = "#{file}:#{line+offset}" }
+
+      metadata = {}
+      metadata[:caller] = [guessed_caller_entry, *caller] if guessed_caller_entry
+      metadata.merge! existing_metadat
+
+      metadata
     end
   end
 end

data/lib/mrspec/version.rb

@@ -1,3 +1,3 @@
 module MRspec
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/mrspec.gemspec

@@ -16,7 +16,11 @@ Gem::Specification.new do |s|
   s.executables   = ['mrspec']
   s.require_paths = ['lib']
 
-  s.add_dependency "rspec-core", "~> 3.2"
+  # b/c we go into the guts of RSpec, we're sensitive to private API changes,
+  # in this case, we need https://github.com/rspec/rspec-core/commit/d52c969
+  # which was released as part of v3.5.0
+  s.add_dependency "rspec-core", "~> 3.5"
+
   s.add_dependency "minitest",   "~> 5.0"
   s.add_dependency "what_weve_got_here_is_an_error_to_communicate", "~> 0.0.8"
 

data/test/test_parser_monkey_patches.rb

@@ -3,6 +3,7 @@ require 'support/helper'
 
 class TestParserMonkeyPatches < Minitest::Spec
   Parser = RSpec::Core::Parser
+  ConfigurationOptions = RSpec::Core::ConfigurationOptions
 
   def rspec_parser
     Parser.instance_method :rspec_parser
@@ -26,15 +27,19 @@ class TestParserMonkeyPatches < Minitest::Spec
   end
 
   describe '#mrspec_parser' do
-    def record_hostile_parsing(option_parser, flag)
-      stdout, stderr, *rest = capture_io do
-        begin option_parser.parse([flag])
-        rescue SystemExit
-        end
-      end
-      assert_empty rest
-      assert_empty stderr
-      stdout
+    def record_hostile_parsing(parser_method_name, flag)
+      # This is performed by Runner.run
+      original_parser_method = Parser.parser_method
+      Parser.parser_method   = Parser.instance_method parser_method_name
+      options = ConfigurationOptions.new([])
+      result  = Parser.parse([flag])
+      stderr  = StringIO.new
+      stdout  = StringIO.new
+      result[:runner].call(options, stderr, stdout)
+      assert_empty stderr.string
+      stdout.string
+    ensure
+      Parser.parser_method = original_parser_method
     end
 
     it 'returns the original #rspec_parser' do
@@ -50,10 +55,10 @@ class TestParserMonkeyPatches < Minitest::Spec
     end
 
     it 'overrides -v and --version includes the Mrspec version, the RSpec::Core version, the Minitest version, and the ErrorToCommunicate version' do
-      rspec_version  = record_hostile_parsing Parser.new([]).rspec_parser({}),  '--version'
-      rspec_v        = record_hostile_parsing Parser.new([]).rspec_parser({}),  '-v'
-      mrspec_version = record_hostile_parsing Parser.new([]).mrspec_parser({}), '--version'
-      mrspec_v       = record_hostile_parsing Parser.new([]).mrspec_parser({}), '-v'
+      rspec_version  = record_hostile_parsing :rspec_parser,  '--version'
+      rspec_v        = record_hostile_parsing :rspec_parser,  '-v'
+      mrspec_version = record_hostile_parsing :mrspec_parser, '--version'
+      mrspec_v       = record_hostile_parsing :mrspec_parser, '-v'
 
       # RSpec version parser defines both of these flags to return its version
       assert_equal rspec_version, rspec_v
@@ -73,8 +78,7 @@ class TestParserMonkeyPatches < Minitest::Spec
     it 'sets the correct description for the versions'
 
     it 'includes the what_weve_got_here_is_an_error_to_communicate formatter in the help screen' do
-      parser     = Parser.new([]).mrspec_parser({})
-      help       = record_hostile_parsing parser, '--help'
+      help       = record_hostile_parsing :mrspec_parser, '--help'
       formatters = help.lines
                        .drop_while { |l| l !~ /--format/ }
                        .drop(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mrspec
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Josh Cheek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Minitest and RSpec, sitting in a tree, T. E. S. T. I. N. G!
@@ -153,4 +153,3 @@ test_files:
 - test/test_configuration.rb
 - test/test_mrspec.rb
 - test/test_parser_monkey_patches.rb
-has_rdoc: