opal-rspec-formatter 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c18b7c448071807ba181cfe4aa8ac6b515265af1
-  data.tar.gz: 717b8483156f782172de643fb72dcab27b198144
+  metadata.gz: 7d4a38e1bec4f304a7304a6b7238654ca9b41651
+  data.tar.gz: 7579c4647dc630f846e0feed10808d0c3f0942c5
 SHA512:
-  metadata.gz: 61a36ba9e3817522f08bb980864d47147f1b158ee3af1ad2b335e970ab603fe8f73444e1f70e52ce88db5690ec17bd13071f2f5ef671759ab4fe235ae4735ad3
-  data.tar.gz: 62b14e729fc312ecc4084dfd895d433b620e62d7d400f135e93673e050211e9e625fe429b7c0a972d282abe5859438bfcf9106eea0069c5a1b7db6eaaadfc9c3
+  metadata.gz: bc545ae22aabe7becb1a17d303e65dd22dfd861afa3a3c412428974229e5ec4fd6ef2e2026f76ace0459268eb3e695f2f5b87d60c1269e10cdb7b46fadf795fa
+  data.tar.gz: ca724bd6cba020aa0eb4a159010df3319524f4e60091980541dec53faf9251d2b8b6fb7551d566f3e109b56ce48f4764cf7d5cbe3db5d193f9f800564a7ffee5

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.1
+* Don't complain if this formatter's require is used, but no SPEC_OPTS are supplied
+* Fix TeamCity issues and take advantage/work with of default formatter information set by TeamCity in SPEC_OPTS
+
+# 1.0.0
+
+Initial release

data/README.md

@@ -14,6 +14,8 @@ gem 'opal-rspec-formatter'
 
 ### Use in your application
 
+#### General
+
 In your Rakefile, make the following change
 
 ```ruby
@@ -23,6 +25,22 @@ require 'opal/rspec-formatter/rake_task'
 Opal::RSpec::RakeTask.new(:default)
 ```
 
+#### Opal-Rails
+
+If you are using opal-rails, you will not have require 'opal/rspec/rake_task' in your Rakefile because the opal:spec task is created from the opal-rails gem. You need to add the require to the top level Rakefile **before** opal-rails loads its task so that the formatter changes will take effect. It should look something like this:
+
+```ruby
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+# needs to go in before opal-rails (which is triggered by Rails.application.load_tasks)
+require 'opal/rspec-formatter/rake_task'
+
+Rails.application.load_tasks
+```
+
 #### JUnit
 
 Now on the command line, supply the SPEC_OPTS environment variable. Example:
@@ -37,10 +55,13 @@ If you omit either of these settings, the default opal-rspec formatter will be u
 
 Example:
 ```bash
-SPEC_OPTS="--append_exp_from_load_path patch/bdd --append_exp_from_load_path patch/common --require opal/rspec/formatters/teamcity --format Opal::RSpec::Formatters::TeamCity" rake
+# TeamCity/RubyMine will normally add all this for you and all you need to do is run your Rake task within its environment
+RUBYLIB="/Applications/RubyMine.app/Contents/rb/testing/patch/bdd:/Applications/RubyMine.app/Contents/rb/testing/patch/common" SPEC_OPTS="--require teamcity/spec/runner/formatter/teamcity/formatter --format Spec::Runner::Formatter::TeamcityFormatter" rake
 ```
 
-'append_exp_from_load_path' is there to avoid distributing a copy of the TeamCity formatter, we only include the patches here. TeamCity and Rubymine usually include the load path to their formatters when they launch Ruby. The append_exp_from_load_path parameter will cause this GEM to selectively add items in the Ruby load path that match the given expression to the Opal load path.
+This GEM will look for anything on the load path that matches patch/common or patch/bdd and add it to the Opal path for you. It will also change the formatter class from the stock one (Spec::Runner::Formatter::TeamcityFormatter) to Opal::RSpec::Formatters::TeamCity automatically. If these items change, you can supply 'append_exp_from_load_path' in SPEC_OPTS to specify different expressions for locating the TeamCity/RubyMine files in the load path.
+
+In order to avoid distributing a copy of the TeamCity formatter, we only include the patches here.
 
 #### Custom
 This GEM currently includes a JUnit XML formatter and patches to make the TeamCity/Rubymine runner work, but you can use any formatter you can get working with Opal.

data/lib/opal/rspec-formatter/rake_task.rb

@@ -4,6 +4,50 @@ class Opal::RSpec::RakeTask
   # Monkey patching the constructor without duplicating it here
   alias_method :orig_init, :initialize
   
+  def self.get_requires
+    spec_opts = ENV['SPEC_OPTS']
+    return [] unless spec_opts
+    spec_opts.scan(/--require (\S+)/).flatten
+  end
+  
+  def get_custom_load_path_expressions
+    spec_opts = ENV['SPEC_OPTS']
+    return [] unless spec_opts
+    matches = spec_opts.scan /--append_exp_from_load_path (\S+)/
+    matches.flatten.map {|m| Regexp.new(Regexp.escape(m))}
+  end
+  
+  def add_to_load_path(expressions, server)
+    expressions.each do |r|      
+      matches = $:.select {|path| r.match(path)}
+      matches.each do |load_path|
+        puts "Adding #{load_path} to Opal path"
+        server.append_path load_path
+      end
+    end
+  end
+  
+  def get_default_teamcity_load_path_expressions
+    [/patch\/bdd/, /patch\/common/]
+  end
+  
+  def teamcity_require_indicator
+    'teamcity/spec/runner/formatter/teamcity/formatter'
+  end
+  
+  def is_teamcity
+    Opal::RSpec::RakeTask.get_requires.include? teamcity_require_indicator
+  end
+  
+  def validate_teamcity_is_there(server)
+    filename = teamcity_require_indicator+'.rb'
+    paths = server.sprockets.paths
+    found = paths.find {|p| File.exist?(File.join(p, filename))}
+    unless found
+      raise "TeamCity formatter require (#{filename}) supplied, but was not able to find Teamcity classes in Opal paths #{Opal.paths}. By default, anything in the Ruby load path that matches #{get_default_teamcity_load_path_expressions} will be used. If this needs to be changed, supply -- append_exp_from_load_path in the SPEC_OPTS env variable with another regex."
+    end
+  end
+  
   def initialize(name = 'opal:rspec', &block)
     # We'll add our formatter set code before any main code that uses this task runs. This also should work
     # out of the box with opal-rails, which uses a different server.main util than others
@@ -13,15 +57,14 @@ class Opal::RSpec::RakeTask
       # TODO: Surely a better way than environment variables to pass this on?          
       ENV['opal_rspec_after_formatter_set'] = run_before_this
       server.main = 'opal/rspec/sprockets_runner_customformat'
-      regexes = ENV['SPEC_OPTS'].scan /--append_exp_from_load_path (\S+)/
-      regexes.each do |r|
-        exp = Regexp.new(Regexp.escape(r[0]))
-        matches = $:.select {|path| exp.match(path)}
-        matches.each do |load_path|
-          server.append_path load_path
-        end
+      
+      add_to_load_path get_custom_load_path_expressions, server
+      if is_teamcity        
+        add_to_load_path get_default_teamcity_load_path_expressions, server
+        validate_teamcity_is_there server
       end
     end
+    
     orig_init name, &runner_block
   end      
 end

data/lib/opal/rspec-formatter/version.rb

@@ -1,7 +1,7 @@
 module Opal
   module RSpec
     module Formatter
-      VERSION = '1.0.0'
+      VERSION = '1.0.1'
     end
   end
 end

data/opal/opal/rspec/sprockets_runner_customformat.rb.erb

@@ -2,21 +2,26 @@ require 'opal'
 require 'opal-rspec'
 <% 
 spec_opts = ENV['SPEC_OPTS']
-formatter_require_matches = spec_opts.scan /--require (\S+)/
-formatter_class_match = /--format (\S+)/.match(spec_opts)
-if formatter_require_matches.any? and formatter_class_match
-	formatter_class = formatter_class_match.captures[0]
-	
-	formatter_require_matches.flatten.each do |format_req|
+if spec_opts
+	requires = ::Opal::RSpec::RakeTask.get_requires
+	formatter_class_matches = spec_opts.scan /--format (\S+)/
+	if requires.any? and formatter_class_matches.any?
+		# TeamCity will add its own contents to SPEC_OPTS but we need to supercede those
+		requires = requires.map {|r| r == 'teamcity/spec/runner/formatter/teamcity/formatter' ? 'opal/rspec/formatters/teamcity' : r}
+		formats = formatter_class_matches.flatten.map {|f| f == 'Spec::Runner::Formatter::TeamcityFormatter' ? 'Opal::RSpec::Formatters::TeamCity' : f}		
+
+		formatter_class = formats.last	
+		requires.each do |format_req|
 %>	
-		require '<%= format_req %>'
+			require '<%= format_req %>'
 	<% end %>
 
-	RSpec.configure do |config|
-	  config.default_formatter = <%= formatter_class %>
+		RSpec.configure do |config|
+		  config.default_formatter = <%= formatter_class %>
+		end
+<% 
 	end
-
-<% end %>
+end %>
 
 # We've interrupted the usual opal-rspec flow to set the formatter, now run the rest of the 's.main' code
 # This environment variable was set in the Rake task monkey patch in this GEM

data/spec_mri/junit_spec.rb

@@ -1,42 +1,52 @@
 require 'nokogiri'
 
 describe 'JUnit' do
-  RSpec::Matchers.define :have_xpath do |xpath|
-    get_item = lambda do |document|
-      results = document.xpath(xpath)
-      results = results.map {|r| r.text }      
-      results.length == 1 ? results[0] : results
+  context 'no env variable set' do
+    subject do
+      `rake raw_specs`      
     end
     
-    match do |document|
-      actual = get_item[document]
-      @value.is_a?(Regexp) ? @value.match(actual) : (actual == @value)
-    end
+    it { is_expected.to match /2 examples, 1 failures, 0 pending/ }
+  end
+  
+  context 'env variable supplied' do
+    RSpec::Matchers.define :have_xpath do |xpath|
+      get_item = lambda do |document|
+        results = document.xpath(xpath)
+        results = results.map {|r| r.text }      
+        results.length == 1 ? results[0] : results
+      end
     
-    failure_message do |document|
-      "Expected #{@value} but got #{get_item[document]}"
-    end
+      match do |document|
+        actual = get_item[document]
+        @value.is_a?(Regexp) ? @value.match(actual) : (actual == @value)
+      end
     
-    chain :with_value do |value|
-      @value = value
+      failure_message do |document|
+        "Expected #{@value} but got #{get_item[document]}"
+      end
+    
+      chain :with_value do |value|
+        @value = value
+      end
     end
-  end
   
-  before :all do
-    # this is expensive to run!
-    output = `SPEC_OPTS="--require opal/rspec/formatters/junit --format Opal::RSpec::Formatters::Junit" rake raw_specs`
-    xml = /<\?xml.*\<\/testsuite\>/m.match(output)[0]
-    @@parsed = Nokogiri::XML xml do |config|
-      config.strict
+    before :context do
+      # this is expensive to run!
+      output = `SPEC_OPTS="--require opal/rspec/formatters/junit --format Opal::RSpec::Formatters::Junit" rake raw_specs`
+      xml = /<\?xml.*\<\/testsuite\>/m.match(output)[0]
+      @@parsed = Nokogiri::XML xml do |config|
+        config.strict
+      end
     end
-  end
   
-  subject { @@parsed }
+    subject { @@parsed }
   
-  it { is_expected.to have_xpath('/testsuite/@tests').with_value('2') }
-  it { is_expected.to have_xpath('/testsuite/@failures').with_value('1') }
-  it { is_expected.to have_xpath('/testsuite/@errors').with_value('0') }
-  it { is_expected.to have_xpath('/testsuite/testcase/@classname').with_value(%w{foobar::succeeds foobar::fails}) }
-  it { is_expected.to have_xpath('/testsuite/testcase/@name').with_value(['should eq true', 'should eq false']) }
-  it { is_expected.to have_xpath('/testsuite/testcase[@classname="foobar::fails"]/failure/@message').with_value(/expected: false.*got: true/m) }
+    it { is_expected.to have_xpath('/testsuite/@tests').with_value('2') }
+    it { is_expected.to have_xpath('/testsuite/@failures').with_value('1') }
+    it { is_expected.to have_xpath('/testsuite/@errors').with_value('0') }
+    it { is_expected.to have_xpath('/testsuite/testcase/@classname').with_value(%w{foobar::succeeds foobar::fails}) }
+    it { is_expected.to have_xpath('/testsuite/testcase/@name').with_value(['should eq true', 'should eq false']) }
+    it { is_expected.to have_xpath('/testsuite/testcase[@classname="foobar::fails"]/failure/@message').with_value(/expected: false.*got: true/m) }
+  end
 end

data/spec_mri/teamcity_spec.rb

@@ -0,0 +1,67 @@
+describe 'TeamCity', skip: 'No TeamCity on Travis' do
+  before do
+    raise "Ensure you've copied the /Applications/RubyMine.app/Contents/rb/testing directory to ../teamcity before running" unless Dir.exist?('../teamcity')
+  end
+  
+  let(:command) {
+    "RUBYLIB='#{load_path}' SPEC_OPTS='#{spec_opts}' rake raw_specs 2>&1"
+  }
+  
+  subject { `#{command}` }
+  
+  RSpec.shared_context :success_example do
+    it { is_expected.to match /##teamcity\[testSuiteFinished/ }
+  end
+  
+  RSpec.shared_context :fail_example do
+    it { is_expected.to match /TeamCity formatter require \(\S+\) supplied, but was not able to find Teamcity classes in Opal paths.*/ }
+  end 
+  
+  context 'default' do    
+    let(:spec_opts) {
+      '--require teamcity/spec/runner/formatter/teamcity/formatter --format Spec::Runner::Formatter::TeamcityFormatter'
+    }
+        
+    context 'found' do
+      let(:load_path) { '../teamcity/patch/common:../teamcity/patch/bdd' }
+      
+      include_context :success_example
+    end
+    
+    context 'not found' do
+      let(:load_path) { '../teamcity/patch_foo/common:../teamcity/patch/bdd_foo' }
+      
+      include_context :fail_example
+    end
+  end
+  
+  context 'custom append exp settings' do
+    before do
+      FileUtils.mv '../teamcity/patch/bdd', '../teamcity/patch/foo_bdd'
+      FileUtils.mv '../teamcity/patch/common', '../teamcity/patch/foo_common'
+    end
+    
+    after do
+      FileUtils.mv '../teamcity/patch/foo_bdd', '../teamcity/patch/bdd'
+      FileUtils.mv '../teamcity/patch/foo_common', '../teamcity/patch/common'
+    end
+    
+    let(:load_path) { '../teamcity/patch/foo_common:../teamcity/patch/foo_bdd' }
+    
+    context 'found' do
+      let(:spec_opts) {
+        '--append_exp_from_load_path patch/foo_bdd --append_exp_from_load_path patch/foo_common --require teamcity/spec/runner/formatter/teamcity/formatter --format Spec::Runner::Formatter::TeamcityFormatter'
+      } 
+      
+      include_context :success_example
+    end
+    
+    context 'not found' do
+      let(:spec_opts) {
+        '--append_exp_from_load_path patch/bdd_2 --append_exp_from_load_path patch/common_2 --require teamcity/spec/runner/formatter/teamcity/formatter --format Spec::Runner::Formatter::TeamcityFormatter'
+      }
+      
+      include_context :fail_example
+    end
+  end  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-rspec-formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brady Wied
@@ -96,6 +96,7 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -117,6 +118,7 @@ files:
 - opal/opal/rspec/sprockets_runner_customformat.rb.erb
 - spec/test_spec.rb
 - spec_mri/junit_spec.rb
+- spec_mri/teamcity_spec.rb
 homepage: https://github.com/wied03/opal-rspec-formatter
 licenses: []
 metadata: {}