cuki 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,16 +1,54 @@
-= cuki
-
-Description goes here.
-
-== Contributing to cuki
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+= Overview
+
+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 unncessary Confluence formatting (h1., macros, etc.)
+* Adds a @pending tag if the wiki page is marked as a draft
+* Includes a link back to the original Confluence page
+* Formats the feature using Cucumber's autoformatter (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.
+
+== Installation
+
+Require the gem in your Gemfile:
+
+    gem 'cuki'
+
+== Setup
+
+Cuki expects a configuration file in config/cuki.yml. See the sample provided.
+
+== Usage
+    
+Run it from the command line:
+
+    bundle exec cuki
+
+or, if using Bundler binstubs:
+
+    bin/cuki
+
+== 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)
+
+== Known Issues and Limitation
+
+* 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
+
+== TODO
+
+* Handle links
+* Add tests
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/cuki.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cuki"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andy Waite"]
+  s.date = "2011-10-12"
+  s.description = ""
+  s.email = "andy@andywaite.com"
+  s.executables = ["cuki"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/cuki",
+    "cuki.gemspec",
+    "cuki.yaml.sample",
+    "lib/cuki.rb",
+    "test/helper.rb",
+    "test/test_cuki.rb"
+  ]
+  s.homepage = "http://github.com/andyw8/cuki"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Pull acceptance criteria from a Confluence wiki page into a Cucumber feature file"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<httpclient>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httpclient>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/cuki.yaml.sample

@@ -0,0 +1,7 @@
+# edit this and save it as config/cuki.yaml
+---
+base: http://mywiki/pages/editpage.action?pageId=
+draft: "{info:title=Draft version}"
+mappings:
+  123: products/add_product
+  124: products/remove_product

data/lib/cuki.rb

@@ -7,78 +7,99 @@ require 'CGI'
 class Cuki
 
   # we're assuming that the acceptance criteria starts at this point and continues to the end of the page
-  FEATURE_START = /\d\. \*Specification\*/
+  START_INDICATOR = /\d\. \*Specification\*/
 
   def self.invoke
+    new
+  end
 
+  def initialize
+    read_config
+    configure_http_client
+    @mappings.each { |key, value|  process_mapping key, value }    
+    autoformat
+  end
+  
+  private
+  
+  def read_config
     config_path = 'config/cuki.yaml'
 
     config = YAML::load( File.open( config_path ) )
 
-    base = config["base"]
-    raise "base not found in #{config_path}" unless base
-
-    mappings = config["mappings"]
-    raise "mappings not found in #{config_path}" unless mappings
+    @base = config["base"]
+    raise "base not found in #{config_path}" unless @base
 
-    client = HTTPClient.new
-    client.ssl_config.set_trust_ca(ENV['CER']) if ENV['CER']
-    client.ssl_config.set_client_cert_file(ENV['PEM'], ENV['PEM']) if ENV['PEM']
-
-    mappings.each do |key, value|
-      wiki_link = base + key.to_s
+    @mappings = config["mappings"]
+    raise "mappings not found in #{config_path}" unless @mappings
+    
+    @draft_indicator = config['draft']
+  end
+  
+  def configure_http_client
+    @client = HTTPClient.new
+    @client.ssl_config.set_trust_ca(ENV['CER']) if ENV['CER']
+    @client.ssl_config.set_client_cert_file(ENV['PEM'], ENV['PEM']) if ENV['PEM']
+  end
+  
+  def process_mapping(key, value)
+    wiki_link = @base + key.to_s
 
-      puts "Downloading #{wiki_link}"
+    puts "Downloading #{wiki_link}"
 
-      response = client.get wiki_link
+    response = @client.get wiki_link
 
-      doc = Nokogiri(response.body)
+    doc = Nokogiri(response.body)
 
-      title = doc.css('title').text
+    title = doc.css('title').text
 
-      wiki_text = CGI.unescapeHTML(doc.css('#markupTextarea').text)
+    wiki_text = CGI.unescapeHTML(doc.css('#markupTextarea').text)
+    wiki_text.gsub(' ', '')
 
-      cuke_text = ''
-      cuke_text += "@pending\n" if wiki_text.include?(config['draft'])
+    cuke_text = ''
+    cuke_text += "@pending\n" if wiki_text.include?(@draft_indicator)
 
-      # assuming that title is format REF - TITLE - PROJECT NAME - WIKI NAME
-      cuke_text += "Feature: " + title.split(' - ')[1] + "\n\n"
+    title = title.split(' - ').first
 
-      cuke_text += "[View on Confluence](#{wiki_link})\n\n"
+    # assuming that title is format REF - TITLE - PROJECT NAME - WIKI NAME
+    cuke_text += "Feature: " + title + "\n\n"
 
-      cuke_text += wiki_text.split(FEATURE_START).last
+    cuke_text += "#{wiki_link}\n\n"
 
-      # remove the double pipes used for table headers in Confluence
-      cuke_text.gsub!('||', '|')
+    raise "couldn't find start of acceptance criteria in #{title}" unless wiki_text.match(START_INDICATOR)
 
-      # remove other noise
-      cuke_text.gsub!('\\', '')
+    cuke_text += wiki_text.split(START_INDICATOR).last
 
-      # remove any unwanted headers
-      cuke_text.gsub!(/h\d\. /, '')
+    # remove the double pipes used for table headers in Confluence
+    cuke_text.gsub!('||', '|')
 
-      # remove an other confluence markup
-      cuke_text.gsub!(/\{.*\}/, '')
+    # remove other noise
+    cuke_text.gsub!('\\', '')
 
-      # check features folder exists
-      raise "features folder not found" unless File.exists?('features')
+    # remove any unwanted headers
+    cuke_text.gsub!(/h\d\. /, '')
 
-      file_path = "features/#{value}.feature"
-      dir_path = File.dirname(file_path)
+    # remove an other confluence markup
+    cuke_text.gsub!(/\{.*\}/, '')
 
-      unless File.exists?(dir_path)
-        Dir.mkdir(dir_path)
-      end
+    # check features folder exists
+    raise "features folder not found" unless File.exists?('features')
 
-      File.open(file_path, 'w') do |f|
-        puts "Writing #{file_path}"
-        f.puts cuke_text
-      end
+    file_path = "features/#{value}.feature"
+    dir_path = File.dirname(file_path)
 
+    unless File.exists?(dir_path)
+      Dir.mkdir(dir_path)
     end
 
-    # clean up with Cucumber's autoformatter
+    File.open(file_path, 'w') do |f|
+      puts "Writing #{file_path}"
+      f.puts cuke_text
+    end
+  end
+  
+  def autoformat
     `cucumber -a . --dry-run -P` unless ENV['SKIP_AUTOFORMAT']
-
   end
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuki
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andy Waite
@@ -123,6 +123,8 @@ files:
 - Rakefile
 - VERSION
 - bin/cuki
+- cuki.gemspec
+- cuki.yaml.sample
 - lib/cuki.rb
 - test/helper.rb
 - test/test_cuki.rb