cuki 0.0.8 → 0.0.9

data/README.rdoc

@@ -2,14 +2,13 @@
 
 Cuki provides an easy way to import acceptance criteria from a Confluence wiki into Cucumber feature files
 
-* Supports a mapping between Confluence pages and feature files
-* Extracts only the acceptance criteria section of a wiki page
-* Converts Confluence tables to Cucumber tables
-* Strips out unnecessary Confluence formatting (headers., macros, 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
-* Assign tags to a feature based on the wiki page content
+- Supports a mapping between Confluence pages and 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
+- Assign tags to a feature based on the wiki page content
 
 It can be used as part of a CI process or just for ad-hoc imports.
 
@@ -23,6 +22,15 @@ Require the gem in your Gemfile:
 
 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:
+
+    h1. Acceptance Criteria
+  
+    h2. Feature Name
+  
+    h2. Another Feature Name
+
 == Usage
     
 Run it from the command line:
@@ -39,21 +47,21 @@ You can also pull a single feature:
 
 == Options
 
-* SKIP_AUTOFORMAT to avoid reformatting features (runs over the whole features directory)
-* PEM=/path/to/something.pem.cer (for client certificates)
-* CER=/path/to/something.pem (for client certificates)
+- SKIP_AUTOFORMAT to avoid reformatting features (runs over the whole features directory)
+- PEM=/path/to/something.pem.cer (for client certificates)
+- CER=/path/to/something.pem (for client certificates)
 
-== Known Issues and Limitation
+== Known Issues and Limitations
 
-* Expects the Cucumber scenarios to continue to the the last part of the the page
-* Will only work with Confluence setups which have no password, or use client certificates for authentcation
-* One provides one-way sync, i.e. you can't edit a file locally and push it to Confluence
-* Fails if the specified folder to save a feature to doesn't exist
+- Will only work with Confluence setups which have no password, or use client certificates for authentcation
+- Only provides one-way sync, i.e. you can't edit a file locally and push it to Confluence
+- Fails if the AC block is the last H1 section of the page
+- Should fail if no features found in container block
 
 == TODO
 
-* Handle links
-* Support for pushing features to Confluence (roundtrip editing)
+- Handle links
+- Support for pushing features to Confluence (roundtrip editing)
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/cuki.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cuki"
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Waite"]
-  s.date = "2011-10-17"
+  s.date = "2011-10-18"
   s.description = ""
   s.email = "andy@andywaite.com"
   s.executables = ["cuki"]

data/cuki.yaml.sample

@@ -6,5 +6,6 @@ tags:
   draft: "{info:title=Draft version}"
   signed_off: "{info:title=Signed-off}"
 mappings:
-  123: features/products/add_product.feature
-  124: features/products/remove_product.feature
+  123: features/products/add_product.feature # single file mapping
+  124: features/products/remove_product.feature # single file mapping
+  125: features/admin # folder mapping

data/features/pull/pull.feature

@@ -29,6 +29,10 @@ Feature: Pull
       <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:
@@ -47,6 +51,10 @@ Feature: Pull
 
 
       This feature describes adding a product
+      
+      - Some comment
+      
+      Blah
 
       """
     And the file "features/products/remove_product.feature" should contain exactly:

data/features/pull/splitting.feature

@@ -3,12 +3,11 @@ 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
+  Scenario: Pull all features (default container)
     Given a file named "config/cuki.yaml" with:
       """
       ---
       host: http://example.com
-      container: !ruby/regexp '/h1\. Acceptance Criteria(.*)h1\./m'
       mappings:
         123: features/products
       """
@@ -16,6 +15,8 @@ Feature: Splitting
       """
       <input id="content-title" value="Product Management">
       <div id="markupTextarea">
+      Pretext
+      
       h1. Acceptance Criteria
 
       Something
@@ -65,3 +66,45 @@ Feature: Splitting
 
       """
 
+@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\*(.*)h1\./m'
+    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 --skip-header`
+  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
+
+
+    """

data/lib/cuki.rb

@@ -95,8 +95,12 @@ class Cuki
       puts doc.to_s
       exit(1)
     end
-
-    if @config['container'] && !filepath.include?('.feature')
+    
+    
+    unless filepath.include?('.feature')
+      
+      @config['container'] ||= /h1\. Acceptance Criteria(.*)h1\./m
+      
       handle_multi doc, id
     else
 
@@ -108,12 +112,16 @@ class Cuki
 
       process_tags
 
-      @content = "# Generated by Cuki (#{Time.now})\n" + @content unless @skip_header
+      @content = generated_by + @content unless @skip_header
 
       save_file filepath
     end
   end
   
+  def generated_by
+    "# Generated by Cuki (#{Time.now})\n"
+  end
+  
   def autoformat
     `cucumber -a . --dry-run -P` unless @skip_autoformat
   end
@@ -122,9 +130,12 @@ class Cuki
     feature_title_compressed = doc.at('#content-title')[:value].anchorize
 
     @content += get_markup(doc)
+    
+    clean
+    
     acceptance_criteria_matches = @content.match(@config['container'])
     unless acceptance_criteria_matches
-      puts "Could not match #{config['container']}" 
+      puts "Could not match #{@config['container']} in #{id}" 
       exit(1)
     end
     acceptance_criteria = acceptance_criteria_matches[1]
@@ -147,6 +158,7 @@ class Cuki
       fname = "#{dirpath}/#{feature_filename.gsub("\r", '')}.feature"
       File.open(fname, 'w') do |f|
         puts "Writing #{fname}"
+        f.write generated_by unless @skip_header
         f.write "Feature: #{title}\n\n"
         link = @config['host'] + "/pages/viewpage.action?pageId=#{id}##{feature_title_compressed}-#{scenario_title_compressed}"
         f.write "\n\n" + link
@@ -177,6 +189,8 @@ class Cuki
     @content.gsub!('‘', "'")
     @content.gsub!('“', '"')
     @content.gsub!('”', '"')
+    
+    @content.gsub!(/^#(.*)/, '-' + '\1')
 
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuki
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Andy Waite
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-17 00:00:00 Z
+date: 2011-10-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement