cuki 0.0.9 → 0.0.10

data/README.rdoc

@@ -47,15 +47,20 @@ 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)
+
+== Configuration
+
+If your Confluence installation requires a client certificate, you can supply the paths for these:
+
+- CER=/path/to/ca.pem.cer
+- PEM=/path/to/something.pem
 
 == Known Issues and Limitations
 
-- Will only work with Confluence setups which have no password, or use client certificates for authentcation
+- 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
-- Fails if the AC block is the last H1 section of the page
+- Fails if the AC block is the last h1. section of the page
 - Should fail if no features found in container block
 
 == TODO

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/cucumber.yml

@@ -1,2 +1,2 @@
 ---
-default: '--require features/'
+default: '--require features/ -t ~@pending'

data/cuki.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cuki"
-  s.version = "0.0.9"
+  s.version = "0.0.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Waite"]
-  s.date = "2011-10-18"
+  s.date = "2011-10-22"
   s.description = ""
   s.email = "andy@andywaite.com"
   s.executables = ["cuki"]
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "cucumber.yml",
     "cuki.gemspec",
     "cuki.yaml.sample",
+    "features/pull/error_handling.feature",
     "features/pull/pull.feature",
     "features/pull/pull_single.feature",
     "features/pull/splitting.feature",
@@ -43,9 +44,14 @@ Gem::Specification.new do |s|
     "features/step_defs/pull_steps.rb",
     "features/step_defs/push_steps.rb",
     "features/support/env.rb",
+    "lib/cleaner.rb",
+    "lib/confluence_page.rb",
     "lib/cuki.rb",
+    "lib/feature_file.rb",
+    "lib/link_builder.rb",
     "lib/pusher.rb",
     "lib/string_utils.rb",
+    "lib/test_bits.rb",
     "spec/cuki_spec.rb",
     "spec/spec_helper.rb"
   ]

data/features/pull/error_handling.feature

@@ -0,0 +1,16 @@
+Feature: Error Handling
+
+  Scenario: Missing action
+    When I run `cuki`
+    Then it should fail with:
+      """
+      No action given
+      """
+
+  Scenario: Missing config
+    Given no file named "config/cuki.yaml" exists
+    When I run `cuki pull`
+    Then it should fail with:
+      """
+      No config file found at config/cuki.yaml
+      """

data/features/pull/pull.feature

@@ -1,20 +1,5 @@
 Feature: Pull
 
-  Scenario: Missing action
-    When I run `cuki`
-    Then it should fail with:
-      """
-      No action given
-      """
-
-  Scenario: Missing config
-    Given no file named "config/cuki.yaml" exists
-    When I run `cuki pull`
-    Then it should fail with:
-      """
-      No config file found at config/cuki.yaml
-      """
-
   Scenario: Pull all features
     Given a file named "config/cuki.yaml" with:
       """

data/features/pull/splitting.feature

@@ -16,7 +16,7 @@ Feature: Splitting
       <input id="content-title" value="Product Management">
       <div id="markupTextarea">
       Pretext
-      
+
       h1. Acceptance Criteria
 
       Something
@@ -41,8 +41,6 @@ Feature: Splitting
       """
       Feature: Add Product
 
-
-
       http://example.com/pages/viewpage.action?pageId=123#ProductManagement-AddProduct
 
       This feature describes adding a product
@@ -55,8 +53,6 @@ Feature: Splitting
       """
       Feature: Remove Product
 
-
-
       http://example.com/pages/viewpage.action?pageId=123#ProductManagement-RemoveProduct
 
       This feature describes removing a product
@@ -66,45 +62,83 @@ 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*
+  @announce @focus
+  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
 
-    Something
+      h2. Add Product
 
-    h2. Add Product
+      This feature describes adding a product
 
-    This feature describes adding a product
+      h6. Scenario: Scenario A
 
-    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
 
-    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
 
-    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 --skip-header`
+    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/push/push.feature

@@ -1,6 +1,6 @@
 Feature: Push
 
-  @focus @pending
+  @pending
   Scenario: Push a feature with no scenarios
     Given a file named "config/cuki.yaml" with:
       """

data/lib/cleaner.rb

@@ -0,0 +1,32 @@
+class Cleaner
+  
+  def self.clean(content)
+    
+    content.gsub!(' ', '')
+    
+    # remove the double pipes used for table headers in Confluence
+    content.gsub!('||', '|')
+
+    # remove other noise
+    content.gsub!("\r\n", "\n")
+    content.gsub!("\\\\\n", '')
+    content.gsub!('\\', '')
+
+    # remove any unwanted headers
+    content.gsub!(/h\d\. (Scenario: .*)/, '\1')
+    content.gsub!(/h\d\. (Scenario Outline: .*)/, '\1')
+    content.gsub!(/h\d\. (Background: .*)/, '\1')
+    
+    #Remove fancy quotes
+    content.gsub!('’', "'")
+    content.gsub!('‘', "'")
+    content.gsub!('“', '"')
+    content.gsub!('”', '"')
+    
+    content.gsub!(/^#(.*)/, '-' + '\1')
+    
+    content
+    
+  end
+  
+end

data/lib/confluence_page.rb

@@ -0,0 +1,17 @@
+require 'nokogiri'
+
+class ConfluencePage
+  
+  def initialize(response)
+    @doc = Nokogiri(response)
+  end
+  
+  def title
+    @doc.at('#content-title')[:value]
+  end
+  
+  def content
+    CGI.unescapeHTML @doc.css('#markupTextarea').text
+  end
+
+end

data/lib/cuki.rb

@@ -1,17 +1,15 @@
 require 'rubygems'
 require 'httpclient'
-require 'nokogiri'
 require 'yaml'
 require 'CGI'
 require 'json'
 require 'parallel'
-require File.dirname(__FILE__) + '/string_utils.rb'
-
-# terrible hack
-if File.exist?('stubs.json') || File.exist?('stubs.json')
-  require 'webmock'
-  include WebMock::API
-end
+require File.dirname(__FILE__) + '/string_utils'
+require File.dirname(__FILE__) + '/link_builder'
+require File.dirname(__FILE__) + '/cleaner'
+require File.dirname(__FILE__) + '/confluence_page'
+require File.dirname(__FILE__) + '/feature_file'
+require File.dirname(__FILE__) + '/test_bits'
 
 class Cuki
 
@@ -49,9 +47,6 @@ class Cuki
         end
       end
       autoformat
-    elsif 'push' == action
-      configure_push_stubs
-      Pusher.push file, @config
     else
       puts "Unknown action '#{action}"
       exit(1)
@@ -72,8 +67,14 @@ class Cuki
       exit(1)
     end
     @config = YAML::load( File.open( CONFIG_PATH ) )
-    raise "Host not found in #{CONFIG_PATH}" unless @config["host"]
-    raise "Mappings not found in #{CONFIG_PATH}" unless @config["mappings"]
+    unless @config["host"]
+      puts "Host not found in #{CONFIG_PATH}"
+      exit(1)
+    end
+    unless @config["mappings"]
+      puts "Mappings not found in #{CONFIG_PATH}"
+      exit(1)
+    end
   end
   
   def configure_http_client
@@ -84,37 +85,42 @@ class Cuki
   
   def pull_feature(id, filepath)
     @content = ''
-    wiki_edit_link = @config['host'] + '/pages/editpage.action?pageId=' + id.to_s
-    wiki_view_link = @config['host'] + '/pages/viewpage.action?pageId=' + id.to_s
+    
+    link_builder = LinkBuilder.new(@config['host'])
+    
+    wiki_edit_link = link_builder.edit(id)
+    wiki_view_link = link_builder.view(id)
+    
     puts "Downloading #{wiki_edit_link}"
     response = @client.get wiki_edit_link
-    doc = Nokogiri(response.body)
+    
+    confluence_page = ConfluencePage.new(response.body)
 
-    unless doc.at('#content-title')
+    unless confluence_page.content
       puts "Not a valid confluence page:"
-      puts doc.to_s
+      puts response.body
       exit(1)
     end
     
-    
     unless filepath.include?('.feature')
       
-      @config['container'] ||= /h1\. Acceptance Criteria(.*)h1\./m
+      @config['container'] ||= /h1\. Acceptance Criteria/
       
-      handle_multi doc, id
+      handle_multi response.body, id
     else
 
-      @content += "Feature: " + doc.at('#content-title')[:value] + "\n\n"
-      @content += "#{wiki_view_link}\n\n"
-      @content += get_markup(doc)
+      feature_file = FeatureFile.new
+      feature_file.title = confluence_page.title
+      feature_file.link = wiki_view_link
+      feature_file.content = confluence_page.content
 
-      clean
+      content = Cleaner.clean(feature_file.to_s)
 
-      process_tags
+      content = process_tags content
 
-      @content = generated_by + @content unless @skip_header
+      content = generated_by + content unless @skip_header
 
-      save_file filepath
+      save_file content, filepath
     end
   end
   
@@ -126,28 +132,57 @@ class Cuki
     `cucumber -a . --dry-run -P` unless @skip_autoformat
   end
   
-  def handle_multi doc, id
-    feature_title_compressed = doc.at('#content-title')[:value].anchorize
+  def handle_multi response_body, id
+    confluence_page = ConfluencePage.new(response_body)
+    
+    feature_title_compressed = confluence_page.title.anchorize
 
-    @content += get_markup(doc)
+    @content += confluence_page.content
     
-    clean
+    @content = Cleaner.clean(@content)
     
-    acceptance_criteria_matches = @content.match(@config['container'])
-    unless acceptance_criteria_matches
+    unless @content.match(@config['container'])
+      puts "Could not find acceptance criteria container"
+      exit(1)
+    end
+    acceptance_criteria_block = @content.split(@config['container']).last
+    if acceptance_criteria_block.match(/h1\./)
+      acceptance_criteria_block = acceptance_criteria_block.split(/h1\./).first
+    end
+    unless acceptance_criteria_block
       puts "Could not match #{@config['container']} in #{id}" 
       exit(1)
     end
-    acceptance_criteria = acceptance_criteria_matches[1]
-    scenario_titles = acceptance_criteria.scan(/h2. (.*)/).flatten
-    scenario_blocks = acceptance_criteria.split(/h2. .*/)
+    acceptance_criteria = acceptance_criteria_block
+    scenario_titles = acceptance_criteria.scan(/h2\. (.*)/).flatten
+    scenario_blocks = acceptance_criteria.split(/h2\. .*/)
     scenario_blocks.shift
 
     combined = {}
+    found = 0
     scenario_titles.each_with_index do |title, index|
       combined[title] = scenario_blocks[index].gsub(/h6. (.*)/, '\1')
+      found += 1
+    end
+    if 0 == found
+      puts "No scenarios found in doc #{id}"
+      exit(1)
     end
     combined.each do |title, content|
+      
+      tags = []
+      if @config['tags']
+        @config['tags'].each_pair do |tag, snippet|
+          tags << "@#{tag}"  if @content.include?(snippet)
+        end
+      end
+      unless tags.empty?
+        content = tags.join(' ') + "\n" + content
+        # tags.each do |tag|
+        #   content.gsub!(@config['tags'][tag.gsub('@', '')], '')
+        # end
+      end
+      
       scenario_title_compressed = title.anchorize
       feature_filename = title.parameterize
 
@@ -155,94 +190,45 @@ class Cuki
 
       FileUtils.mkdir_p(dirpath)
       
-      fname = "#{dirpath}/#{feature_filename.gsub("\r", '')}.feature"
+      fname = "#{dirpath}/#{feature_filename.gsub("\r", '').parameterize}.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
+        f.write link
         f.write content
       end
     end
   end
   
-  def clean
-    
-    @content.gsub!('&nbsp;', '')
-    
-    # remove the double pipes used for table headers in Confluence
-    @content.gsub!('||', '|')
-
-    # remove other noise
-    @content.gsub!("\r\n", "\n")
-    @content.gsub!("\\\\\n", '')
-    @content.gsub!('\\', '')
-
-    # remove any unwanted headers
-    @content.gsub!(/h\d\. (Scenario: .*)/, '\1')
-    @content.gsub!(/h\d\. (Scenario Outline: .*)/, '\1')
-    @content.gsub!(/h\d\. (Background: .*)/, '\1')
-    
-    #Remove fancy quotes
-    @content.gsub!('’', "'")
-    @content.gsub!('‘', "'")
-    @content.gsub!('“', '"')
-    @content.gsub!('”', '"')
-    
-    @content.gsub!(/^#(.*)/, '-' + '\1')
-
-  end
-  
-  def process_tags
+  def process_tags(content)
     tags = []
     if @config['tags']
       @config['tags'].each_pair do |tag, snippet|
-        tags << "@#{tag}"  if @content.include?(snippet)
+        tags << "@#{tag}"  if content.include?(snippet)
       end
     end
     unless tags.empty?
-      @content = tags.join(' ') + "\n" + @content
+      content = tags.join(' ') + "\n" + content
       tags.each do |tag|
-        @content.gsub!(@config['tags'][tag.gsub('@', '')], '')
+        content.gsub!(@config['tags'][tag.gsub('@', '')], '')
       end
     end
+    content
   end
   
-  def save_file(filepath)
+  def save_file(content, filepath)
     dir_path = File.dirname(filepath)
 
     FileUtils.mkdir_p(dir_path) unless File.exists?(dir_path)
 
     File.open(filepath, 'w') do |f|
       puts "Writing #{filepath}"
-      f.puts @content
+      f.puts content
     end
   end
-  
-  def configure_pull_stubs
-    if File.exist?('stubs.json')
-      stubs = JSON.parse(File.open('stubs.json').read)
-      stubs.each_pair do |url, body|
-        stub_request(:get, url).to_return(:status => 200, :body => body, :headers => {})
-      end
-      FileUtils.rm 'stubs.json'
-    end
-  end
-  
-  def configure_push_stubs
-    if File.exist?('push_stubs.json')
-      stubs = JSON.parse(File.open('push_stubs.json').read)
-      stubs.each do |a|
-        stub_request(:post, "http://mywiki/").
-                with(:body => {"title" => a['title'], "content"=> "\n\n" + a['content']},
-                     :headers => {'Content-Type'=>'application/x-www-form-urlencoded'}).
-                to_return(:status => 200, :body => "", :headers => {})
-      end
-      FileUtils.rm 'push_stubs.json'
-    end
-  end
-  
+
   def validate_args args
     if args.empty?
       puts "No action given"
@@ -250,8 +236,4 @@ class Cuki
     end
   end
   
-  def get_markup(doc)
-    CGI.unescapeHTML(doc.css('#markupTextarea').text)
-  end
-  
 end

data/lib/feature_file.rb

@@ -0,0 +1,18 @@
+class FeatureFile
+  
+  attr_accessor :title, :link, :content
+  
+  def initialize
+    @title = nil
+    @link = nil
+    @content = nil
+  end
+  
+  def to_s
+    result = "Feature: " + title + "\n\n"
+    result += "#{link}\n\n"
+    result += content
+    result
+  end
+  
+end

data/lib/link_builder.rb

@@ -0,0 +1,15 @@
+class LinkBuilder
+  
+  def initialize(host)
+    @host = host
+  end
+  
+  def edit(id)
+    @host + '/pages/editpage.action?pageId=' + id.to_s
+  end
+  
+  def view(id)
+    @host + '/pages/viewpage.action?pageId=' + id.to_s
+  end
+  
+end

data/lib/string_utils.rb

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

data/lib/test_bits.rb

@@ -0,0 +1,15 @@
+# terrible hack
+if File.exist?('stubs.json') || File.exist?('stubs.json')
+  require 'webmock'
+  include WebMock::API
+end
+
+def configure_pull_stubs
+  if File.exist?('stubs.json')
+    stubs = JSON.parse(File.open('stubs.json').read)
+    stubs.each_pair do |url, body|
+      stub_request(:get, url).to_return(:status => 200, :body => body, :headers => {})
+    end
+    FileUtils.rm 'stubs.json'
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuki
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Andy Waite
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 Z
+date: 2011-10-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -156,6 +156,7 @@ files:
 - cucumber.yml
 - cuki.gemspec
 - cuki.yaml.sample
+- features/pull/error_handling.feature
 - features/pull/pull.feature
 - features/pull/pull_single.feature
 - features/pull/splitting.feature
@@ -168,9 +169,14 @@ files:
 - features/step_defs/pull_steps.rb
 - features/step_defs/push_steps.rb
 - features/support/env.rb
+- lib/cleaner.rb
+- lib/confluence_page.rb
 - lib/cuki.rb
+- lib/feature_file.rb
+- lib/link_builder.rb
 - lib/pusher.rb
 - lib/string_utils.rb
+- lib/test_bits.rb
 - spec/cuki_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/andyw8/cuki