yard-cucumber 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b47e4ea0d0d5419c1ec4e655f0abd9c753ce3a9a
-  data.tar.gz: 520193860d1a8ad24df4cb19c860c812cd34d9cc
+SHA256:
+  metadata.gz: e15515841dcdc314151768f94ca174cc323c9cd40162fa6e475a7764e33a3190
+  data.tar.gz: 895ad012764d4bc979f22c9bc3476a1585496c3b89b071b76d37fefa2c07ae3d
 SHA512:
-  metadata.gz: a469a5f7efbea7ed3f0c042e26da076d9de5262926675809d2f91d60b1e04150e053bbfc3048b83e88b54a7c1d2e13d3e4d347321273219082659c15228ea26c
-  data.tar.gz: f151570da2884259715c99c4dfa7b71b90d13e304191b059ab7d54c221d8c642d2264018f26d9f9d67e6020b6f0e6a62505ca0a981aa184e35855b606b597135
+  metadata.gz: 0c10f928e6030dbc310b4ca093c24c0e96aeb85244ad7b5441fe44af9ce3b77ec552f85f3e7484e289337abc16aebd03e4c6907b46f218122c1b266608e8d9dd
+  data.tar.gz: fe07b11b56211fd1a1c5f82e9ab08ec9dccab4d6ccf5a1dc2365a15164a80c49cf51b94b1ae3e24e3bb259380346d86a6b778f9429b695e6f85a66187e0a9189

data/.yardopts

@@ -0,0 +1 @@
+--plugin yard-cucumber

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
 gem 'redcarpet'
-gem 'gherkin', '~> 4.0'
+gem 'gherkin', '>= 4.0', '< 6.0'
 
 gemspec

data/Gemfile.lock

@@ -1,42 +1,45 @@
 PATH
   remote: .
   specs:
-    yard-cucumber (3.0.0)
-      cucumber (~> 2)
-      gherkin (~> 4.0)
+    yard-cucumber (3.1.0)
+      cucumber (>= 2.0, < 4.0)
+      gherkin (>= 4.0, < 6.0)
       yard (~> 0.8, >= 0.8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    builder (3.2.2)
-    cucumber (2.4.0)
+    builder (3.2.3)
+    cucumber (2.2.0)
       builder (>= 2.1.2)
-      cucumber-core (~> 1.5.0)
+      cucumber-core (~> 1.3.0)
       cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 4.0)
+      event-bus (~> 0.1.0)
+      gherkin3 (~> 3.1.0)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
-    cucumber-core (1.5.0)
-      gherkin (~> 4.0)
+    cucumber-core (1.3.1)
+      gherkin3 (~> 3.1.0)
     cucumber-wire (0.0.1)
-    diff-lcs (1.2.5)
-    gherkin (4.0.0)
-    multi_json (1.12.1)
+    diff-lcs (1.3)
+    event-bus (0.1.0)
+    gherkin (5.0.0)
+    gherkin3 (3.1.2)
+    multi_json (1.13.1)
     multi_test (0.1.2)
-    rake (10.4.2)
-    redcarpet (2.2.2)
-    yard (0.9.5)
+    rake (10.5.0)
+    redcarpet (3.4.0)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  gherkin (~> 4.0)
+  gherkin (>= 4.0, < 6.0)
   rake (~> 10)
   redcarpet
   yard-cucumber!
 
 BUNDLED WITH
-   1.12.4
+   1.16.1

data/History.txt

@@ -1,3 +1,16 @@
+=== 4.0.0 / 2018-02-25
+
+* @wellavelino: Adjusts the indentation of several project classes
+  (https://github.com/burtlo/yard-cucumber/pull/89)
+* @elhuang: Adding example tags and scenarios counts
+  (https://github.com/burtlo/yard-cucumber/pull/87)
+* @weh: Update README.md
+  (https://github.com/burtlo/yard-cucumber/pull/84)
+* @weh: Fix Gem Load Error
+  (https://github.com/burtlo/yard-cucumber/pull/83)
+* @Stephen-Kaye: Transforms with CONSTANTS
+  (https://github.com/burtlo/yard-cucumber/pull/79)
+
 === 3.1.0/ 2016-12-06
 
 * Updates to Gherkin 4.0 and Cucumber 2.4.0

data/README.md

@@ -92,16 +92,16 @@ This can be configured through the yard configuration file `~/.yard/config` to
 add or remove these search fields.
 
 ```yaml
---- !map:SymbolHash
-:load_plugins: true
-:ignored_plugins: []
-
-:autoload_plugins: []
-
-:safe_mode: false
-
-:"yard-cucumber":
-  menus: [ 'features', 'directories', 'tags', 'steps', 'step definitions' ]
+--- !ruby/hash-with-ivars:SymbolHash
+elements:
+  :load_plugins: true
+  :ignored_plugins: []
+  :autoload_plugins: []
+  :safe_mode: false
+  :"yard-cucumber":
+    menus: [ 'features', 'directories', 'tags', 'steps', 'step definitions' ]
+ivars:
+  :@symbolize_value: false
 ```
 
 By default the configuration, yaml format, that is generate by the `yard config`

data/example/scenario_outline.feature

@@ -1,4 +1,4 @@
-@scenario_outlines @bvt
+@scenario_outlines @bvt @duplicate
 Feature: Displaying Scenario Outlines
   As a reader of the documentation I expect that scenario outlines are documented correctly
 
@@ -9,6 +9,7 @@ Feature: Displaying Scenario Outlines
     When the customer has purchased the product
     Then I expect the customer to be a member of the '<Product>' group
 
+    @tagged_examples
     Examples:
      | Customer   | Product   |
      | Customer A | Product A |
@@ -61,6 +62,7 @@ Feature: Displaying Scenario Outlines
      
   # This is an example of a scenario outline in development.
   # The example table has not been defined yet
+  @fifth
   Scenario Outline: Example Table Missing
     When I click on an example row
     Then I expect <name> to be replaced by the example name
@@ -70,6 +72,7 @@ Feature: Displaying Scenario Outlines
     
   # This is an example of a scenario outline in development.  
   # The examples table has been defined, but is missing data.
+  @sixth
   Scenario Outline: Empty Example Table
     When I click on an example row
     Then I expect <name> to be replaced by the example name
@@ -79,16 +82,19 @@ Feature: Displaying Scenario Outlines
     Examples:
       | name | price | denomination |
 
+  @seventh @duplicate
   Scenario Outline: Multiple Example Table
     Given that <Customer> is a valid customer
     And that the product, named '<Product>', is a valid product
     When the customer has purchased the product
     Then I expect the customer to be a member of the '<Product>' group
 
+    @groupA @duplicate
     Examples: Example group A
      | Customer   | Product   |
      | Customer A | Product A |
 
+    @groupB
     Examples: Example group B
      | Customer   | Product   |
-     | Customer B | Product A |
+     | Customer B | Product A |

data/example/step_definitions/example.step.rb

@@ -26,6 +26,13 @@ Transform /^((?:\d{1,2}[\/-]){2}(?:\d\d){1,2})?\s*(\w{3})?\s*(\d{1,2}:\d{2}\s*(?
   "#{date} #{day} #{time}"
 end
 
+#
+# Assign a trnasform to a variable to be interpolated later in a step definition
+#
+SUBSTITUTED_FILE = Transform(/^file '([^']*)'$/) do |filepath|
+  "Contents loaded from file"
+end 
+
 Given /^that (#{CUSTOMER}) is a valid customer$/ do |customer|
   pending "Customer #{customer} validation"  
 end
@@ -100,6 +107,12 @@ When /^the step definition has HTML escaped characters like: "([^"]+)"$/ do |cha
   pending characters
 end
 
+#
+# Step using interpolated transform to replace file reference with contents of file
+#
+Then /^the (#{SUBSTITUTED_FILE}) will be replaced with the file contents$/ do |content|
+  pending "File contained #{content}"
+end
 
 #
 # Some details about the helper method that might be picked up in the documentation.

data/example/transform.feature

@@ -11,3 +11,8 @@ Feature: Step Transforms
   Scenario: Step Transform uses a constant
     Given this first step
     Then I expect that the step, on the step transformer page, will link to the step transform
+
+  @third
+  Scenario: Step Transform uses an interpolated transform
+    Given this first step
+    Then the file './somelocation/somefile.input' will be replaced with the file contents

data/lib/cucumber/city_builder.rb

@@ -1,6 +1,6 @@
 module Cucumber
   module Parser
-    class CityBuilder < Gherkin::AstBuilder
+    class CityBuilder < ::Gherkin::AstBuilder
 
       #
       # The Gherkin Parser is going to call the various methods within this
@@ -74,7 +74,7 @@ module Cucumber
       def find_or_create_tag(tag_name,parent)
         #log.debug "Processing tag #{tag_name}"
         tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.value == tag_name } ||
-          YARD::CodeObjects::Cucumber::Tag.new(YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE,tag_name.gsub('@','')) {|t| t.owners = [] ; t.value = tag_name }
+          YARD::CodeObjects::Cucumber::Tag.new(YARD::CodeObjects::Cucumber::CUCUMBER_TAG_NAMESPACE,tag_name.gsub('@','')) {|t| t.owners = [] ; t.value = tag_name ; t.total_scenarios = 0}
 
         tag_code_object.add_file(@file,parent.line)
 
@@ -84,7 +84,7 @@ module Cucumber
 
       #
       # Each feature found will call this method, generating the feature object.
-      # This is once, as the gherking parser does not like multiple feature per
+      # This is once, as the gherkin parser does not like multiple feature per
       # file.
       #
       def feature(document)
@@ -103,16 +103,25 @@ module Cucumber
 
           feature[:tags].each {|feature_tag| find_or_create_tag(feature_tag[:name],f) }
         end
-        feature[:children].each { |s|
-          case s[:type]
+
+        background(feature[:background]) if feature[:background]
+
+        feature[:children].each do |child|
+          case child[:type]
             when :Background
-              background(s)
+              background(child)
             when :ScenarioOutline
-              scenario_outline(s)
+              outline = scenario_outline(child)
+              @feature.total_scenarios += outline.scenarios.size
             when :Scenario
-              scenario(s)
+              scenario(child)
           end
-      }
+        end
+
+        @feature.tags.each do |feature_tag|
+          tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.name.to_s == feature_tag[:name].to_s }
+          tag_code_object.total_scenarios += @feature.total_scenarios
+        end
       end
 
       #
@@ -172,6 +181,14 @@ module Cucumber
         statement[:steps].each { |s|
           step(s)
         }
+
+        # count scenarios for scenario level tags
+        scenario.tags.uniq.each { |scenario_tag|
+          if !scenario.feature.tags.include?(scenario_tag)
+            tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.name.to_s == scenario_tag[:name].to_s }
+            tag_code_object.total_scenarios += 1
+          end
+        }
       end
 
       #
@@ -197,16 +214,41 @@ module Cucumber
         end
 
         outline.feature = @feature
-        @feature.scenarios << outline
         @step_container = outline
         statement[:steps].each { |s|
           step(s)
         }
+
         statement[:examples].each { |e|
-          examples(e)
+          example = examples(e, outline)
+        }
+
+        @feature.scenarios << outline
+
+        # count scenarios for scenario outline level tags
+        outline.tags.uniq.each { |outline_tag|
+          if !outline.feature.tags.include?(outline_tag)
+            tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.name.to_s == outline_tag[:name].to_s }
+            tag_code_object.total_scenarios += outline.scenarios.size
+          end
+        }
+
+        # count scenarios for example table level tags
+        outline.examples.each { |example|
+          unless !example.tags.any?
+            example.tags.uniq.each { |example_tag|
+              if !outline.feature.tags.include?(example_tag) && !outline.tags.include?(example_tag)
+                tag_code_object = YARD::Registry.all(:tag).find {|tag| tag.name.to_s == example_tag[:name].to_s }
+                tag_code_object.total_scenarios += example.data.size
+              end
+            }
+          end
         }
+
+        return outline
       end
 
+
       #
       # Examples for a scenario outline are called here. This section differs
       # from the Cucumber parser because here each of the examples are exploded
@@ -214,15 +256,21 @@ module Cucumber
       # later we can ensure that we have all the variations of the scenario
       # outline defined to be displayed.
       #
-      def examples(examples)
+      def examples(examples, outline)
         #log.debug "EXAMPLES"
-
+        return if has_exclude_tags?(examples[:tags].map { |t| t[:name].gsub(/^@/, '') })
         example = YARD::CodeObjects::Cucumber::ScenarioOutline::Examples.new(:keyword => examples[:keyword],
                                                                              :name => examples[:name],
                                                                              :line => examples[:location][:line],
                                                                              :comments => examples[:comments] ? examples.comments.map{|comment| comment.value}.join("\n") : '',
-                                                                             :rows => []
-          )
+                                                                             :rows => [],
+                                                                             :tags => [],
+                                                                             :scenario => outline )
+
+        unless !examples[:tags].any?
+          examples[:tags].each {|example_tag| find_or_create_tag(example_tag[:name], example)}
+        end
+
         example.rows = [examples[:tableHeader][:cells].map{ |c| c[:value] }] if examples[:tableHeader]
         example.rows += matrix(examples[:tableBody]) if examples[:tableBody]
 
@@ -282,6 +330,7 @@ module Cucumber
 
         end
 
+        return example
       end
 
       #

data/lib/templates/default/featuretags/html/namespace.erb

@@ -1,4 +1,7 @@
 <% if @namespace %>
+  <% count = 0 %>
+  <% features.each {|f| count += f.total_scenarios } %>
+
   <div id="tags" class="requirements">
     <script type="text/javascript" charset="utf-8">
       var tag_list = [ <%= tags.collect{|t| "'#{t.value}'" }.join(',') %> ];
@@ -18,11 +21,13 @@
 
         $("#tag_search").keyup(function(evt) {
           updateTagFiltering($("#tag_search")[0].value);
+          updateScenarioCount();
         });
 
         
         $("#tag_search").keyup(function(evt) {
           updateTagFiltering($("#tag_search")[0].value);
+          updateScenarioCount();
         });
         
          $(".tag").click(function(evt) {
@@ -50,6 +55,7 @@
               
               tagSearchElement.value = (tagSearchElement.value != "" ? tagSearchElement.value + tagModifier : "") + tagToAdd;
               updateTagFiltering(tagSearchElement.value);
+              updateScenarioCount();
               
             }
         });
@@ -89,7 +95,7 @@
 
     <div id="features">
       <div class="title">
-        <span class="name">Features</span>
+        <span class="name">Features<span id="scenario_count"> (<%= count %>)</span></span>
       </div>
       <% n = 1 %>
       <ul style="padding-left: 0px;">
@@ -105,9 +111,9 @@
         <% if feature.scenarios %>
           <ul style="padding-left: 20px;">
           	<% feature.scenarios.each do |scenario| %>
-          	<li class="scenario <%= n % 2 == 0 ? 'even' : 'odd' %> <%= feature.tags.collect{|t| t.value }.join(" ") %> <%= scenario.tags.collect{|t| t.value }.join(" ") %>">
+          	<li class="scenario <%= n % 2 == 0 ? 'even' : 'odd' %> <%= feature.tags.collect{|t| t.value }.join(" ") %> <%= scenario.tags.collect{|t| t.value }.join(" ") %>" count="<%= scenario.outline? ? 0 : 1 %>">
           	  <span class='object_link'>
-             		<a href="<%= url_for(scenario.feature,"scenario#{scenario.feature.scenarios.index(scenario) }") %>">
+             		<a href="<%= url_for(scenario.feature,"scenario_#{scenario.feature.scenarios.index(scenario) }") %>">
              		  <%= h scenario.value %>
              		</a>
              	</span>
@@ -116,8 +122,30 @@
                 - <small><%= stags %></small>
               <% end %>
           	</li>
+
             <% n = n == 2 ? 1 : 2 %>
-          	<% end %>
+            
+                <% if scenario.outline? %>
+                  <ul style="padding-left: 40px;">
+                  <% scenario.examples.each do |example| %>
+                    <li class="scenario <%= n % 2 == 0 ? 'even' : 'odd' %> <%= feature.tags.collect{|t| t.value }.join(" ") %> <%= scenario.tags.collect{|t| t.value }.join(" ") %> <%= example.tags.collect{|t| t.value }.join(" ") %>" count="<%= example.data.size %>">
+
+                     <span class='object_link'>
+                       <a href="<%= url_for(scenario.feature,"scenario_#{scenario.feature.scenarios.index(scenario) }") %>">
+                          <%= example.name.nil? || example.name.empty? ? "Examples" : example.name %>
+                       </a>
+                     </span>
+
+                    <% etags = example.tags.collect{|t| tagify(t) }.join(", ") %>
+                    <% if etags && etags != "" %>
+                    - <small><%= etags %></small>
+                    <% end %>
+                    </li>
+                    <% n = n == 2 ? 1 : 2 %>
+                  <% end %>
+                  </ul>
+                <% end %>
+          <% end %>
           </ul>
         <% end %>
       <% end %>