cuki 0.0.6 → 0.0.7

data/Gemfile

@@ -2,6 +2,7 @@ source "http://rubygems.org"
 
 gem 'httpclient'
 gem 'nokogiri'
+gem "parallel"
 
 group :development do
   gem "shoulda", ">= 0"

data/Gemfile.lock

@@ -32,6 +32,7 @@ GEM
       rake
     json (1.6.1)
     nokogiri (1.5.0)
+    parallel (0.5.9)
     rack (1.3.4)
     rake (0.9.2)
     rcov (0.9.11)
@@ -60,6 +61,7 @@ DEPENDENCIES
   httpclient
   jeweler (~> 1.6.4)
   nokogiri
+  parallel
   rcov
   rspec
   shoulda

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/cucumber.yml

@@ -0,0 +1,2 @@
+---
+default: '--require features/'

data/cuki.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cuki"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Waite"]
-  s.date = "2011-10-16"
+  s.date = "2011-10-17"
   s.description = ""
   s.email = "andy@andywaite.com"
   s.executables = ["cuki"]
@@ -28,10 +28,12 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/cuki",
+    "cucumber.yml",
     "cuki.gemspec",
     "cuki.yaml.sample",
     "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",
@@ -43,6 +45,7 @@ Gem::Specification.new do |s|
     "features/support/env.rb",
     "lib/cuki.rb",
     "lib/pusher.rb",
+    "lib/string_utils.rb",
     "spec/cuki_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -58,6 +61,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httpclient>, [">= 0"])
       s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<parallel>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
@@ -66,6 +70,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<httpclient>, [">= 0"])
       s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<parallel>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
@@ -75,6 +80,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<httpclient>, [">= 0"])
     s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<parallel>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])

data/features/pull/pull.feature

@@ -38,12 +38,12 @@ Feature: Pull
       This feature describes removing a product
       </div>
       """
-    When I run `cuki pull`
+    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/editpage.action?pageId=123
+      http://example.com/pages/viewpage.action?pageId=123
 
 
       This feature describes adding a product
@@ -53,7 +53,7 @@ Feature: Pull
       """
       Feature: Remove Product
 
-      http://example.com/pages/editpage.action?pageId=456
+      http://example.com/pages/viewpage.action?pageId=456
 
 
       This feature describes removing a product

data/features/pull/pull_single.feature

@@ -23,7 +23,7 @@ Feature: Pull single
       This feature describes removing a product
       </div>
       """
-    When I run `cuki pull features/products/add_product.feature`
+    When I run `cuki pull features/products/add_product.feature --skip-autoformat --skip-header`
     Then a file named "features/products/add_product.feature" should exist
     But the file "features/products/remove_product.feature" should not exist
 

data/features/pull/splitting.feature

@@ -0,0 +1,67 @@
+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
+    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
+
+      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 --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
+
+
+      """
+    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
+
+
+      """
+

data/features/pull/tables.feature

@@ -21,12 +21,12 @@ Feature: Tables
       | b | 2 |
       </div>
       """
-    When I run `cuki pull`
+    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/editpage.action?pageId=123
+      http://example.com/pages/viewpage.action?pageId=123
 
 
       Scenario: Foo

data/features/pull/tags.feature

@@ -18,13 +18,13 @@ Feature: Tags
       h5. Scenario: Foo
       </div>
       """
-    When I run `cuki pull`
+    When I run `cuki pull --skip-autoformat --skip-header`
     Then the file "features/products/add_product.feature" should contain exactly:
       """
       @draft
       Feature: Add Product
 
-      http://example.com/pages/editpage.action?pageId=123
+      http://example.com/pages/viewpage.action?pageId=123
 
 
       Scenario: Foo

data/features/pull/textile.feature

@@ -17,12 +17,12 @@ Feature: Textile
       h6. Scenario Outline: Bar
       </div>
       """
-    When I run `cuki pull`
+    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/editpage.action?pageId=123
+      http://example.com/pages/viewpage.action?pageId=123
 
 
       Scenario: Foo

data/features/push/push.feature

@@ -19,7 +19,7 @@ Feature: Push
       """
       This is my feature
       """
-    When I run `cuki push features/products/add_product.feature`
+    When I run `cuki push features/products/add_product.feature --skip-autoformat
     Then the push should be successful
 
   @pending

data/features/step_defs/pull_steps.rb

@@ -4,7 +4,7 @@ Given /^a Confluence page on "([^"]*)" with id (\d+):$/ do |host, id, content|
   # the URLs to be stubbed
 
   @stubs ||= {}
-  @stubs["http://#{host}/pages/editpage.action?pageId=#{id}"] = content
+  @stubs["http://#{host}/pages/viewpage.action?pageId=#{id}"] = content
   
   File.open('stubs.json', 'w') do |f|
     f.write @stubs.to_json

data/lib/cuki.rb

@@ -4,6 +4,8 @@ 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')
@@ -25,18 +27,28 @@ class Cuki
     configure_http_client
 
     action = args.first
+    if args.include?('--skip-autoformat')
+      args.delete_if { |arg| '--skip-autoformat' == arg }
+      @skip_autoformat = true
+    end
+    if args.include?('--skip-header')
+      args.delete_if { |arg| '--skip-header' == arg }
+      @skip_header = true
+    end
     if 'pull' == action
       configure_pull_stubs
       verify_project
       file = args[1]
       if file
         id = @config['mappings'].invert[file]
-        raise "could not get id for #{file}"
+        raise "could not get id for #{file}" unless id
         pull_feature id, file
       else
-        @config['mappings'].each { |id, filepath|  pull_feature id, filepath }
+        Parallel.map(@config['mappings'], :in_processes => 4) do |id, filepath|
+          pull_feature id, filepath
+        end
       end
-      #autoformat
+      autoformat
     elsif 'push' == action
       configure_push_stubs
       Pusher.push file, @config
@@ -51,7 +63,7 @@ class Cuki
   def verify_project
     # check features folder exists
     raise "features folder not found" unless File.exists?('features')
-    #autoformat
+    autoformat
   end
   
   def read_config
@@ -72,35 +84,80 @@ class Cuki
   
   def pull_feature(id, filepath)
     @content = ''
-    wiki_link = @config['host'] + '/pages/editpage.action?pageId=' + id.to_s
-    puts "Downloading #{wiki_link}"
-    response = @client.get wiki_link
+    wiki_edit_link = @config['host'] + '/pages/editpage.action?pageId=' + id.to_s
+    wiki_view_link = @config['host'] + '/pages/viewpage.action?pageId=' + id.to_s
+    puts "Downloading #{wiki_edit_link}"
+    response = @client.get wiki_edit_link
     doc = Nokogiri(response.body)
-        
+
     unless doc.at('#content-title')
       puts "Not a valid confluence page:"
       puts doc.to_s
       exit(1)
     end
 
-    @content += "Feature: " + doc.at('#content-title')[:value] + "\n\n"
-    @content += "#{wiki_link}\n\n"
-    @content += CGI.unescapeHTML(doc.css('#markupTextarea').text)
+    if @config['container']
+      handle_multi doc, id
+    else
+
+      @content += "Feature: " + doc.at('#content-title')[:value] + "\n\n"
+      @content += "#{wiki_view_link}\n\n"
+      @content += get_markup(doc)
 
-    clean
+      clean
 
-    process_tags
+      process_tags
 
-    save_file filepath
+      @content = "# Generated by Cuki (#{Time.now})\n" + @content unless @skip_header
+
+      save_file filepath
+    end
   end
   
   def autoformat
-    `cucumber -a . --dry-run -P` unless ENV['SKIP_AUTOFORMAT']
+    `cucumber -a . --dry-run -P` unless @skip_autoformat
+  end
+  
+  def handle_multi doc, id
+    feature_title_compressed = doc.at('#content-title')[:value].anchorize
+
+    @content += get_markup(doc)
+    acceptance_criteria_matches = @content.match(@config['container'])
+    unless acceptance_criteria_matches
+      puts "Could not match #{config['container']}" 
+      exit(1)
+    end
+    acceptance_criteria = acceptance_criteria_matches[1]
+    scenario_titles = acceptance_criteria.scan(/h2. (.*)/).flatten
+    scenario_blocks = acceptance_criteria.split(/h2. .*/)
+    scenario_blocks.shift
+
+    combined = {}
+    scenario_titles.each_with_index do |title, index|
+      combined[title] = scenario_blocks[index].gsub(/h6. (.*)/, '\1')
+    end
+    combined.each do |title, content|
+      scenario_title_compressed = title.anchorize
+      feature_filename = title.parameterize
+
+      dirpath = @config['mappings'][id]
+
+      FileUtils.mkdir_p(dirpath)
+      
+      fname = "#{dirpath}/#{feature_filename.gsub("\r", '')}.feature"
+      File.open(fname, 'w') do |f|
+        puts "Writing #{fname}"
+        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 content
+      end
+    end
   end
   
   def clean
     
-    @content.gsub(' ', '')
+    @content.gsub!(' ', '')
     
     # remove the double pipes used for table headers in Confluence
     @content.gsub!('||', '|')
@@ -113,6 +170,13 @@ class Cuki
     # 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!('”', '"')
 
   end
   
@@ -134,7 +198,7 @@ class Cuki
   def save_file(filepath)
     dir_path = File.dirname(filepath)
 
-    Dir.mkdir(dir_path) unless File.exists?(dir_path)      
+    FileUtils.mkdir_p(dir_path) unless File.exists?(dir_path)
 
     File.open(filepath, 'w') do |f|
       puts "Writing #{filepath}"
@@ -172,4 +236,8 @@ class Cuki
     end
   end
   
+  def get_markup(doc)
+    CGI.unescapeHTML(doc.css('#markupTextarea').text)
+  end
+  
 end

data/lib/string_utils.rb

@@ -0,0 +1,9 @@
+class String
+  def anchorize
+    CGI.escape(self.gsub(' ', '').gsub("\r", ''))
+  end
+
+  def parameterize
+    self.downcase.gsub(' ', '_')
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuki
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Andy Waite
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-16 00:00:00 Z
+date: 2011-10-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -56,11 +56,25 @@ dependencies:
         - 0
         version: "0"
   version_requirements: *id003
+  name: parallel
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
   name: shoulda
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -71,12 +85,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id004
+  version_requirements: *id005
   name: bundler
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -87,12 +101,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  version_requirements: *id005
+  version_requirements: *id006
   name: jeweler
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -101,12 +115,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id006
+  version_requirements: *id007
   name: rcov
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -115,7 +129,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
+  version_requirements: *id008
   name: rspec
   prerelease: false
   type: :development
@@ -139,10 +153,12 @@ files:
 - Rakefile
 - VERSION
 - bin/cuki
+- cucumber.yml
 - cuki.gemspec
 - cuki.yaml.sample
 - 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
@@ -154,6 +170,7 @@ files:
 - features/support/env.rb
 - lib/cuki.rb
 - lib/pusher.rb
+- lib/string_utils.rb
 - spec/cuki_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/andyw8/cuki