gherkin_generator 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1252b9c59effa14e97e71eb82a6d1a3d6abcd66
-  data.tar.gz: 6154bddbccc55a7b65b9266532f8e8c53e9fa4b6
+  metadata.gz: 8a1bd5e59eeb1e2030c5426a7911825508e4ffbd
+  data.tar.gz: 0388574fbf0e3d67cbaccb8e60d25ab51329679b
 SHA512:
-  metadata.gz: a2a650dbdb55be2e173a8de6ab08e3407f306ca0b80508c4007b12149bdc1bb9ae7717f3e76333f65fa0e5d0f85b14f61ef3217877bda4169c3eee68e4c51fc9
-  data.tar.gz: a4eb5bd8531bafe74fbcd10c10b623166d196b32dc6f9130f6aa5b13f9e37ec0c2ccd38acb26b92549db56aa82abda57746fc5b6f1684e8ca84de5cf57ce5ab2
+  metadata.gz: d8d1f3e368b82c4dbc897045bb8cd198bfcc889bbdee17dd5ef7b68ca2f2b10d84d2ce05a8767aa2d5a726364660aba1ef696e4f652ea90a5c87317face9691a
+  data.tar.gz: 0e14be4e9c523ec2b8845e60903b63a21d0130befaa5c8537a09e25f62c704ba69d33095ca12a2141744b29b815241045698a1d101b3e7b4c24f625bb667ed2b

data/lib/gherkin_generator.rb

@@ -1,12 +1,45 @@
+# A simple tool for generating Gherkin Feature Files programmatically.
+#
+# = Example
+#
+#   gg = GherkinGenerator.new("My Feature")
+#   gg.add_scenario("Something: When I do something Then something should have happened")
+#   gg.add_scenario("Something Else: When I do something else Then something else should have happened")
+#   puts gg.to_gherkin
+#
 class GherkinGenerator
+  ##
+  # A multiline feature description
+  #
+  # = Example
+  #
+  #   GherkinGenerator.new("My Feature").description = <<EOS
+  #   All sorts of information about my feature
+  #   This info is not parsed, it's just a description of the feature
+  #   EOS
   attr_accessor :description
 
+  ##
+  # Generate a new feature
+  #
+  # = Example
+  #
+  #   GherkinGenerator.new("Feature name goes here")
   def initialize(feature_name)
     @feature_name = feature_name
     @scenarios = []
     @tag = ''
   end
 
+
+  ##
+  # Add a scenario to the feature.  The format is a single line string
+  # with capital letters for the GWTA's
+  #
+  # = Example
+  #
+  #   myFeature.add_scenario("My Scenario: Given I ... When I ... And I ... Then I ...")
+  #
   def add_scenario(scenario)
     examples_keyword = 'Examples '
     scenario_parts = scenario.split examples_keyword
@@ -18,10 +51,36 @@ class GherkinGenerator
     result
   end
 
+  ##
+  # Examples in Gherkin don't suite the one-line input well.  This
+  #
+  # = Example
+  #
+  #   myFeature.exampleHandler do |reference|
+  #     puts "looking up examples with ref: #{reference}"
+  #     <<EOS
+  #   | something | another |
+  #   | abc       | def     |
+  #   | def       | ghi     |
+  #   EOS
+  #   end
+  #   myFeature.add_scenario("My Scenario With" +
+  #     " Examples: Given I ... Then I ... Examples http://example.org/example1")
+  #
   def example_handler(&block)
     @ex_yield = block
   end
 
+  ##
+  # Output the Gherkin formatted string, this can be saved in a Feature file.
+  #
+  # = Example
+  #
+  #   gg = GherkinGenerator.new("My Feature")
+  #   gg.add_scenario("Something: When I do something Then something should have happened")
+  #   gg.add_scenario("Something Else: When I do something else Then something else should have happened")
+  #   puts gg.to_gherkin
+  #
   def to_gherkin
     feature = 'Feature: ' + @feature_name
     desc = @description.nil? ? '' : "\n\t" + @description.sub("\n", "\n\t")
@@ -34,7 +93,11 @@ class GherkinGenerator
     feature + desc + scenarios + "\n"
   end
 
+  ##
+  # Object oriented representation of scenarios.  This is designed for internal use by GherkinGenerator.
   class Scenario
+    ##
+    # Takes a single-line scenario and a formatted example table
     def initialize(scenario, examples)
       @scenario = scenario
       @tag = []
@@ -45,10 +108,15 @@ class GherkinGenerator
                   end
     end
 
+    ##
+    # Adding a tag - the formatting is applied, you just supply the tag name
     def add_tag(tag)
       @tag << '@' + tag
     end
 
+    ##
+    # The output of the current scenario, a feature file is made up of a description
+    # and multiple scenarios formatted as a string.
     def format_string
       keywords = %w(Given And When Then)
       steps = @scenario.split(':')[1].strip

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_generator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Mat Carey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies: []
 description: A simple tool for generating Gherkin Feature Files programmatically.
 email: opensource+gherkin-formatter@dorightdigital.com
@@ -17,7 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gherkin_generator.rb
-homepage: 
+homepage: https://github.com/dorightdigital/gherkin-generator
 licenses:
 - MIT
 metadata: {}