cuke-inspector 0.0.5 → 0.0.6

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 cuke-inspector.gemspec
+.specification

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/cuke-inspector/formatter/pickle_sanitizer.rb

@@ -0,0 +1,51 @@
+module Cucumber
+  module Formatter
+    class PickleSanitizer
+      @@pickle_parser = nil
+      @@pickle_capture_methods = ['capture_model',
+                                  'capture_fields',
+                                  'capture_factory',
+                                  'capture_plural_factory',
+                                  'capture_predicate']
+
+      def self.unpickle(regexp_string)
+        if Gem.available?('pickle')
+          @@pickle_parser ||= Pickle::Parser.new(:config => Pickle::Config.new)
+          @@pickle_capture_methods.each do |capture_method|
+            regexp_string.gsub!(@@pickle_parser.send(capture_method), "\#{#{capture_method}}")
+          end
+          regexp_string = hacky_capture_predicate_sanitizer(regexp_string)
+        end
+
+        regexp_string
+      end
+
+      # Because the capture_predicate method at the time of running
+      # this code seems to differ from when it was run in the step
+      # that defined it, the simple method of replacing it does not
+      # work. Here is a convoluted regexp that does it. Better
+      # suggestions are welcome.
+      def self.hacky_capture_predicate_sanitizer(regexp_string)
+        regexp_string.gsub(/\(\(\?:((?:\w+(?:\[_ \]\w+)*)(?:\|\w+(?:\[_ \]\w+)*)*)\)\)/, '#{capture_predicate}')
+      end
+
+      def self.find_methods_that_match(regexp_string)
+        methods = @@pickle_parser.methods.select { |m| m =~ /^match|capture/ }
+        methods.select do |method|
+          begin
+            foo = @@pickle_parser.send(method)
+            regexp_string.include?(foo)
+          rescue
+            false
+          end
+        end.sort
+      end
+
+      private
+
+      def self.reset
+        @@pickle_parser = nil
+      end
+    end
+  end
+end

data/lib/cuke-inspector/formatter/stepdefs_json.rb

@@ -1,5 +1,6 @@
 require 'cucumber'
 require 'cucumber/formatter/usage'
+require 'cuke-inspector/formatter/pickle_sanitizer'
 
 module Cucumber
   module Formatter
@@ -27,7 +28,7 @@ module Cucumber
         regexp.gsub!(/\(\[\^\\?\"\]\*\??\)/, prompt)
         regexp.gsub!('(.*)', prompt)
         regexp.gsub!('\/([^\/]*)\/', "/#{prompt}/")
-        regexp
+        return PickleSanitizer.unpickle(regexp)
       end
 
       def progress(status)

data/spec/cuke-inspector/formatter/pickle_sanitizer_spec.rb

@@ -0,0 +1,95 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'cuke-inspector/formatter/pickle_sanitizer'
+require 'pickle' # pickle is required to run the test suite
+
+module Cucumber
+  module Formatter
+    describe PickleSanitizer do
+      describe "when pickle is not loaded" do
+        before do
+          Gem.stub!(:available?).with('pickle').and_return false
+        end
+
+        it "returns any regexp string unmodified" do
+          regexp_string = "a user exists with name: \"??\""
+          PickleSanitizer.unpickle(regexp_string).should == regexp_string
+        end
+
+        it "never creates a pickle parser" do
+          Pickle::Parser.should_not_receive(:new)
+          PickleSanitizer.unpickle('foo')
+        end
+      end
+
+      describe "when pickle is loaded" do
+        before do
+          PickleSanitizer.reset
+          Gem.stub!(:available?).with('pickle').and_return true
+          @parser = mock('pickle parser')
+          @parser.stub!(:capture_model).and_return 'mock capture model'
+          @parser.stub!(:capture_fields).and_return 'mock capture fields'
+          @parser.stub!(:capture_factory).and_return 'mock capture factory'
+          @parser.stub!(:capture_plural_factory).and_return 'mock capture plural factory'
+          @parser.stub!(:capture_predicate).and_return 'mock capture predicate'
+          Pickle::Parser.stub!(:new).and_return @parser
+        end
+
+        it "creates a pickle parser with a new config" do
+          mock_config = mock('pickle config')
+          Pickle::Config.stub!(:new).and_return mock_config
+          Pickle::Parser.should_receive(:new).with hash_including(:config => mock_config)
+          PickleSanitizer.unpickle('foo')
+        end
+
+        it "only creates a pickle parser once" do
+          PickleSanitizer.unpickle('foo')
+          Pickle::Parser.should_not_receive(:new)
+          PickleSanitizer.unpickle('foo')
+        end
+
+        it "maps a model capture to a placeholder" do
+          @parser.stub!(:capture_model).and_return('stubbed model capture regexp')
+          regexp_string = "this is a stubbed model capture regexp example"
+          PickleSanitizer.unpickle(regexp_string).should ==
+            "this is a \#{capture_model} example"
+        end
+
+        it "maps a fields capture to a placeholder" do
+          @parser.stub!(:capture_fields).and_return('stubbed fields capture regexp')
+          regexp_string = "this is a stubbed fields capture regexp example"
+          PickleSanitizer.unpickle(regexp_string).should ==
+            "this is a \#{capture_fields} example"
+        end
+
+        it "maps capture_factory to a placeholder" do
+          @parser.stub!(:capture_factory).and_return('stubbed factory capture regexp')
+          regexp_string = "this is a stubbed factory capture regexp example"
+          PickleSanitizer.unpickle(regexp_string).should ==
+            "this is a \#{capture_factory} example"
+        end
+
+        it "maps capture_plural_factory to a place holder" do
+          @parser.stub!(:capture_plural_factory).and_return('stubbed plural factory capture regexp')
+          regexp_string = "this is a stubbed plural factory capture regexp example"
+          PickleSanitizer.unpickle(regexp_string).should ==
+            "this is a \#{capture_plural_factory} example"
+        end
+
+        it "maps capture_predicate" do
+          @parser.stub!(:capture_predicate).and_return('stubbed predicate capture regexp')
+          regexp_string = "this is a stubbed predicate capture regexp example"
+          PickleSanitizer.unpickle(regexp_string).should ==
+            "this is a \#{capture_predicate} example"
+        end
+
+        it "maps capture_predicate even if it has changed" do
+          predicate_example = "((?:position[_ ]by[_ ]type|respond[_ ]to[_ ]without[_ ]attributes|invalid|publishing[_ ]enabled|attribute[_ ]present|nil|updated[_ ]at|acts[_ ]like|first[_ ]item|present))"          
+          @parser.stub!(:capture_predicate).and_return(predicate_example)
+          regexp_string = "this string contains a simple predicate capture ((?:position[_ ]by[_ ]type|respond[_ ]to[_ ]without[_ ]attributes|invalid|publishing[_ ]enabled)) just before here"
+          PickleSanitizer.unpickle(regexp_string).should ==
+            'this string contains a simple predicate capture #{capture_predicate} just before here'
+        end
+      end
+    end
+  end
+end

data/spec/cuke-inspector/formatter/stepdefs_json_spec.rb

@@ -5,6 +5,13 @@ module Cucumber
   module Formatter
     describe StepdefsJson do
       describe "extracting text from regexp" do
+        before do
+          # Pretend that unpickle will always return its argument unmodified
+          def PickleSanitizer.unpickle(foo)
+            foo
+          end
+        end
+
         it "should just return a simple string" do
           StepdefsJson.extract_text_from_regexp("bla").should == "bla"
         end

data/spec/spec_helper.rb

@@ -5,5 +5,7 @@ require 'spec'
 require 'spec/autorun'
 
 Spec::Runner.configure do |config|
-  
 end
+
+require 'ruby-debug'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cuke-inspector
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Tom ten Thij
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-01 00:00:00 +00:00
+date: 2010-02-02 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,7 +67,9 @@ files:
 - generators/cuke_inspector_view/templates/stylesheets/cuke_inspector.css
 - generators/cuke_inspector_view/templates/stylesheets/tablesorter.css
 - lib/cuke-inspector.rb
+- lib/cuke-inspector/formatter/pickle_sanitizer.rb
 - lib/cuke-inspector/formatter/stepdefs_json.rb
+- spec/cuke-inspector/formatter/pickle_sanitizer_spec.rb
 - spec/cuke-inspector/formatter/stepdefs_json_spec.rb
 - spec/cuke-inspector_spec.rb
 - spec/spec.opts
@@ -101,6 +103,7 @@ signing_key:
 specification_version: 3
 summary: Inspect the steps in a cucumber suite
 test_files: 
+- spec/cuke-inspector/formatter/pickle_sanitizer_spec.rb
 - spec/cuke-inspector/formatter/stepdefs_json_spec.rb
 - spec/cuke-inspector_spec.rb
 - spec/spec_helper.rb