cuki 0.0.11 → 0.0.12

data/README.rdoc

@@ -1,52 +1,42 @@
 = Overview
 
-Cuki provides an easy way to import acceptance criteria from a Confluence wiki into Cucumber feature files
-
-- Converts Confluence tables to Cucumber tables
-- Strips out unnecessary Confluence formatting (headers, etc.)
-- Includes a link back to the original Confluence page
-- Formats the feature using Cucumber's auto-formatter (optional)
-- Support client SSL certificates for use within an organisation's secure intranet
-
-It can be used as part of a CI process or just for ad-hoc imports.
+Cuki provides an easy way to import acceptance criteria from a Confluence wiki into Cucumber feature files. It can be used as part of a CI process or just for ad-hoc imports.
 
 == Installation
 
-Require the gem in your Gemfile:
+    gem install cuki
 
-    gem 'cuki'
+(or use Bundler)
 
 == Setup
 
 Cuki expects a configuration file in config/cuki.yml. See the sample provided.
 
-You can have a one-to-one association between Confluences pages, or you can split a single Confluence
-pages into multiple features. The splitter is a little fussy about structure, it must be:
+A single Confluence page maps to one or more features. The page should contain the structure:
 
     h1. Acceptance Criteria
-  
+
     h2. Feature Name
-  
+
+    Scenario: ...
+
     h2. Another Feature Name
 
+    Scenario: ...
+
 == Usage
     
 Run it from the command line:
 
-    bundle exec cuki pull
-
-or, if using binstubs:
-
-    bin/cuki pull
+    cuki pull
     
-You can also pull a single feature:
+You can also pull from a particular Confluence page:
 
-    cuki pull features/add_product.feature
+    cuki pull features/products
 
 == Tags
 
-You can add tags to a feature based on the wiki page content. See the sample configuration file.
-
+You can add tags to a feature based on the wiki page markup. See the sample configuration file.
 
 == Options
 
@@ -54,23 +44,25 @@ You can add tags to a feature based on the wiki page content. See the sample con
 
 == Configuration
 
-If your Confluence installation requires a client certificate, you can supply the paths for these:
+If your Confluence installation requires a client certificate, you can supply the paths for these as environment variables:
 
-- CER=/path/to/ca.pem.cer
-- PEM=/path/to/something.pem
+    CER=/path/to/ca.pem.cer PEM=/path/to/something.pem cuki pull
 
 == Known Issues and Limitations
 
 - Will only work with Confluence setups which have no password, or use client certificates for authentication
-- Only provides one-way sync, i.e. you can't edit a file locally and push it to Confluence
+- Expects a two level hierarchy, with folders used for epics/themes, containing one or more feature files
 
-== TODO
+== Bugs and To Do
 
-- Handle links
-- Support for pushing features to Confluence (roundtrip editing)
+- Should exit before importing features if the current features aren't valid syntax
+
+== Future Plans
+
+- Add roundtrip editing, i.e. edit a file locally and push it to Confluence
+- Some way to update the wiki to indicate which scenarios are passing, failing or not yet implemented
 
 == Copyright
 
 Copyright (c) 2011 Andy Waite. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

data/cuki.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cuki"
-  s.version = "0.0.11"
+  s.version = "0.0.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Waite"]
-  s.date = "2011-10-23"
+  s.date = "2011-10-25"
   s.description = ""
   s.email = "andy@andywaite.com"
   s.executables = ["cuki"]
@@ -34,7 +34,6 @@ Gem::Specification.new do |s|
     "features/pull/error_handling.feature",
     "features/pull/pull.feature",
     "features/pull/pull_single.feature",
-    "features/pull/splitting.feature",
     "features/pull/tables.feature",
     "features/pull/tags.feature",
     "features/pull/textile.feature",

data/cuki.yaml.sample

@@ -1,5 +1,5 @@
-# edit this and save it as config/cuki.yaml
-# the mappings associate the page IDs on Confluence with local feature files
+# edit this file and save it as config/cuki.yaml
+# each mapping associates a Confluence page with a folder containing one or more feature files
 ---
 host: http://mywiki
 container: "h1. Acceptance Criteria"

data/features/pull/pull.feature

@@ -1,56 +1,142 @@
-# Feature: Pull
-# 
-#   @focus @announc
-#   Scenario: Pull all features
-#     Given a file named "config/cuki.yaml" with:
-#       """
-#       ---
-#       host: http://example.com
-#       mappings:
-#         123: features/products/add_product.feature
-#         456: features/products/remove_product.feature
-#       """
-#     And a Confluence page on "example.com" with id 123:
-#       """
-#       <input id="content-title" value="Add Product">
-#       <div id="markupTextarea">
-#       This feature describes adding a product
-# 
-#       # Some comment
-# 
-#       Blah
-#       </div>
-#       """
-#     And a Confluence page on "example.com" with id 456:
-#       """
-#       <input id="content-title" value="Remove Product">
-#       <div id="markupTextarea">
-#       This feature describes removing a product
-#       </div>
-#       """
-#     When I run `cuki pull --skip-autoformat`
-#     Then the file "features/products/add_product.feature" should contain exactly:
-#       """
-#       Feature: Add Product
-# 
-#       http://example.com/pages/viewpage.action?pageId=123
-# 
-# 
-#       This feature describes adding a product
-# 
-#       - Some comment
-# 
-#       Blah
-# 
-#       """
-#     And the file "features/products/remove_product.feature" should contain exactly:
-#       """
-#       Feature: Remove Product
-# 
-#       http://example.com/pages/viewpage.action?pageId=456
-# 
-# 
-#       This feature describes removing a product
-# 
-#       """
-# 
+Feature: Splitting
+  
+  Instead of association one wiki page per feature file, you can split a wiki file across multiple feature files.
+
+  Scenario: Pull all features (default container)
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      mappings:
+        123: features/products
+      """
+    And a Confluence page on "example.com" with id 123:
+      """
+      <input id="content-title" value="Product Management">
+      <div id="markupTextarea">
+      Pretext
+
+      h1. Acceptance Criteria
+
+      Something
+
+      h2. Add Product
+
+      This feature describes adding a product
+
+      h6. Scenario: Scenario A
+
+      h2. Remove Product
+
+      This feature describes removing a product
+
+      h6. Scenario Outline: Scenario B
+
+      h1. Next Section
+      </div>
+      """
+    When I run `cuki pull --skip-autoformat`
+    Then the file "features/products/add_product.feature" should contain exactly:
+      """
+      Feature: Add Product
+
+      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-AddProduct
+
+      This feature describes adding a product
+
+      Scenario: Scenario A
+
+
+      """
+    And the file "features/products/remove_product.feature" should contain exactly:
+      """
+      Feature: Remove Product
+
+      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-RemoveProduct
+
+      This feature describes removing a product
+
+      Scenario Outline: Scenario B
+
+
+      """
+
+  Scenario: Pull all features (specified container)
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      container: !ruby/regexp '/h1\. \*Acceptance Criteria\*/'
+      mappings:
+        123: features/products
+      """
+    And a Confluence page on "example.com" with id 123:
+      """
+      <input id="content-title" value="Product Management">
+      <div id="markupTextarea">
+      h1. *Acceptance Criteria*
+
+      Something
+
+      h2. Add Product
+
+      This feature describes adding a product
+
+      h6. Scenario: Scenario A
+
+      h1. Next Section
+      </div>
+      """
+    When I run `cuki pull --skip-autoformat`
+    Then the file "features/products/add_product.feature" should contain exactly:
+      """
+      Feature: Add Product
+
+      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-AddProduct
+
+      This feature describes adding a product
+
+      Scenario: Scenario A
+
+
+      """
+
+  Scenario: Special Chars
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      mappings:
+        123: features/products
+      """
+    And a Confluence page on "example.com" with id 123:
+      """
+      <input id="content-title" value="Product Management">
+      <div id="markupTextarea">
+      h1. Acceptance Criteria
+
+      Something
+
+      h2. Add/Remove Product
+
+      This feature describes adding a product
+
+      h6. Scenario: Scenario A
+
+      h1. Next Section
+      </div>
+      """
+    When I run `cuki pull --skip-autoformat`
+    Then the file "features/products/add_remove_product.feature" should contain exactly:
+      """
+      Feature: Add/Remove Product
+
+      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-Add%2FRemoveProduct
+
+      This feature describes adding a product
+
+      Scenario: Scenario A
+
+
+      """
+

data/features/pull/pull_single.feature

@@ -1,6 +1,5 @@
 Feature: Pull single
 
-  @focus @announce
   Scenario: Pull single feature
     Given a file named "config/cuki.yaml" with:
       """

data/features/pull/tags.feature

@@ -1,5 +1,6 @@
 Feature: Tags
 
+  @announce
   Scenario: 
     Given a file named "config/cuki.yaml" with:
       """
@@ -7,7 +8,8 @@ Feature: Tags
       host: http://example.com
       tags:
         draft: "{info:title=Draft version}"
-        signed_off: "{info:title=Signed-off}"
+        pending: "{info:title=Pending}"
+        another: "{info:title=Another}"
       mappings:
         123: features/products
       """
@@ -16,11 +18,13 @@ Feature: Tags
       <input id="content-title" value="Products">
       <div id="markupTextarea">
       h1. Acceptance Criteria
-      
       {info:title=Draft version}
       
       h2. Add Product
       
+      {info:title=Pending}
+      {info:title=Another}
+      
       h6. Scenario: Foo
       </div>
       """
@@ -32,6 +36,11 @@ Feature: Tags
 
       http://example.com/pages/viewpage.action?pageId=123#Products-AddProduct
 
+      @pending
+
+      @another
+
+
       Scenario: Foo
 
       """

data/lib/confluence_page.rb

@@ -13,7 +13,7 @@ class ConfluencePage
   def content
     content = CGI.unescapeHTML @doc.css('#markupTextarea').text
     
-    content.gsub!(' ', '')
+    content.gsub!(' ', ' ')
     
     # remove the double pipes used for table headers in Confluence
     content.gsub!('||', '|')

data/lib/cuki.rb

@@ -54,7 +54,9 @@ class Cuki
 
   def verify_project
     terminate "features folder not found" unless File.exists?('features')
+    puts "Verifying existing features"
     `cucumber --dry-run -P`
+    terminate "Validation of existing features failed" unless 0 == $? 
   end
 
   def read_config
@@ -82,17 +84,21 @@ class Cuki
   end
 
   def autoformat!
-    `cucumber -a . --dry-run -P` unless @skip_autoformat
+    unless @skip_autoformat
+      `cucumber -a . --dry-run -P`
+      puts "Running autoformat"
+    end
   end
 
   def handle_multi response_body, id
     confluence_page = ConfluencePage.new(response_body)
 
-    content = confluence_page.content
+    full_content = confluence_page.content
 
-    terminate "Could not find acceptance criteria container" unless content.match(container)
+    terminate "Could not find acceptance criteria container" unless full_content.match(container)
 
-    acceptance_criteria = content.split(container).last
+    acceptance_criteria = full_content.split(container).last
+    
     if acceptance_criteria.include?(PRIMARY_HEADER)
       acceptance_criteria = acceptance_criteria.split(/#{PRIMARY_HEADER}/).first
     end
@@ -103,14 +109,15 @@ class Cuki
     scenario_blocks = acceptance_criteria.split(/#{FEATURE_HEADER} .*/)
     scenario_blocks.shift
 
+    puts "Warning: No scenarios found in doc #{id}" if scenario_titles.empty?
+
+    pretext = acceptance_criteria.split(/#{FEATURE_HEADER}/).first
+
     combined = {}
-    found = 0
     scenario_titles.each_with_index do |title, index|
-      combined[title] = scenario_blocks[index].gsub(/#{SCENARIO_HEADER} (.*)/, '\1')
-      found += 1
+      combined[title] = scenario_blocks[index].gsub(/h\d. ([Scenario|Scenario Outline].*)/, '\1')
     end
 
-    terminate "No scenarios found in doc #{id}" if 0 == found
     combined.each do |title, content|
 
       feature_filename = title.parameterize
@@ -122,7 +129,12 @@ class Cuki
       File.open(fname, 'w') do |f|
         if @config['tags']
           @config['tags'].each do |tag, token|
-            f.write "@#{tag}\n" if acceptance_criteria.include?(token)
+            f.write "@#{tag}\n" if pretext.include?(token)
+          end
+        end
+        if @config['tags']
+          @config['tags'].each do |tag, token|
+            content.gsub!(token, "@#{tag}\n")
           end
         end
         f.write "Feature: #{title}\n\n"

data/lib/string_utils.rb

@@ -4,6 +4,6 @@ class String
   end
 
   def parameterize
-    self.downcase.gsub(/[^a-z0-9\-]/, '_')
+    self.downcase.gsub(/[^a-z0-9\-\(\)]/, '_')
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuki
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - Andy Waite
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-23 00:00:00 Z
+date: 2011-10-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -159,7 +159,6 @@ files:
 - features/pull/error_handling.feature
 - features/pull/pull.feature
 - features/pull/pull_single.feature
-- features/pull/splitting.feature
 - features/pull/tables.feature
 - features/pull/tags.feature
 - features/pull/textile.feature

data/features/pull/splitting.feature

@@ -1,145 +0,0 @@
-Feature: Splitting
-  
-  Instead of association one wiki page per feature file, you can split a wiki file across multiple feature files.
-
-  @announce
-  Scenario: Pull all features (default container)
-    Given a file named "config/cuki.yaml" with:
-      """
-      ---
-      host: http://example.com
-      mappings:
-        123: features/products
-      """
-    And a Confluence page on "example.com" with id 123:
-      """
-      <input id="content-title" value="Product Management">
-      <div id="markupTextarea">
-      Pretext
-
-      h1. Acceptance Criteria
-
-      Something
-
-      h2. Add Product
-
-      This feature describes adding a product
-
-      h6. Scenario: Scenario A
-
-      h2. Remove Product
-
-      This feature describes removing a product
-
-      h6. Scenario Outline: Scenario B
-
-      h1. Next Section
-      </div>
-      """
-    When I run `cuki pull --skip-autoformat`
-    Then the file "features/products/add_product.feature" should contain exactly:
-      """
-      Feature: Add Product
-
-      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-AddProduct
-
-      This feature describes adding a product
-
-      Scenario: Scenario A
-
-
-      """
-    And the file "features/products/remove_product.feature" should contain exactly:
-      """
-      Feature: Remove Product
-
-      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-RemoveProduct
-
-      This feature describes removing a product
-
-      Scenario Outline: Scenario B
-
-
-      """
-
-  @announce
-  Scenario: Pull all features (specified container)
-    Given a file named "config/cuki.yaml" with:
-      """
-      ---
-      host: http://example.com
-      container: !ruby/regexp '/h1\. \*Acceptance Criteria\*/'
-      mappings:
-        123: features/products
-      """
-    And a Confluence page on "example.com" with id 123:
-      """
-      <input id="content-title" value="Product Management">
-      <div id="markupTextarea">
-      h1. *Acceptance Criteria*
-
-      Something
-
-      h2. Add Product
-
-      This feature describes adding a product
-
-      h6. Scenario: Scenario A
-
-      h1. Next Section
-      </div>
-      """
-    When I run `cuki pull --skip-autoformat`
-    Then the file "features/products/add_product.feature" should contain exactly:
-      """
-      Feature: Add Product
-
-      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-AddProduct
-
-      This feature describes adding a product
-
-      Scenario: Scenario A
-
-
-      """
-
-  @announce
-  Scenario: Special Chars
-    Given a file named "config/cuki.yaml" with:
-      """
-      ---
-      host: http://example.com
-      mappings:
-        123: features/products
-      """
-    And a Confluence page on "example.com" with id 123:
-      """
-      <input id="content-title" value="Product Management">
-      <div id="markupTextarea">
-      h1. Acceptance Criteria
-
-      Something
-
-      h2. Add/Remove Product
-
-      This feature describes adding a product
-
-      h6. Scenario: Scenario A
-
-      h1. Next Section
-      </div>
-      """
-    When I run `cuki pull --skip-autoformat`
-    Then the file "features/products/add_remove_product.feature" should contain exactly:
-      """
-      Feature: Add/Remove Product
-
-      http://example.com/pages/viewpage.action?pageId=123#ProductManagement-Add%2FRemoveProduct
-
-      This feature describes adding a product
-
-      Scenario: Scenario A
-
-
-      """
-