cuki 0.0.4 → 0.0.5

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7

data/Gemfile

@@ -8,9 +8,11 @@ group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
+  gem "rspec"
 end
 
-group :test do
-  gem "rspec"
+group :test do  
   gem "cucumber"
+  gem "aruba"
+  gem "webmock"
 end

data/Gemfile.lock

@@ -1,7 +1,19 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.2.6)
+    aruba (0.4.6)
+      bcat (>= 0.6.1)
+      childprocess (>= 0.2.0)
+      cucumber (>= 1.0.2)
+      rdiscount (>= 1.6.8)
+      rspec (>= 2.6.0)
+    bcat (0.6.2)
+      rack (~> 1.0)
     builder (3.0.0)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    crack (0.3.1)
     cucumber (1.1.0)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
@@ -9,6 +21,7 @@ GEM
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
+    ffi (1.0.9)
     gherkin (2.5.1)
       json (>= 1.4.6)
     git (1.2.5)
@@ -19,8 +32,10 @@ GEM
       rake
     json (1.6.1)
     nokogiri (1.5.0)
+    rack (1.3.4)
     rake (0.9.2)
     rcov (0.9.11)
+    rdiscount (1.6.8)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -31,11 +46,15 @@ GEM
     rspec-mocks (2.6.0)
     shoulda (2.11.3)
     term-ansicolor (1.0.6)
+    webmock (1.7.7)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  aruba
   bundler (~> 1.0.0)
   cucumber
   httpclient
@@ -44,3 +63,4 @@ DEPENDENCIES
   rcov
   rspec
   shoulda
+  webmock

data/README.rdoc

@@ -32,6 +32,10 @@ Run it from the command line:
 or, if using binstubs:
 
     bin/cuki pull
+    
+You can also pull a single feature:
+
+    cuki pull features/add_product.feature
 
 == Options
 
@@ -49,7 +53,7 @@ or, if using binstubs:
 == TODO
 
 * Handle links
-* Add tests
+* Support for pushing features to Confluence (roundtrip editing)
 
 == Copyright
 

data/Rakefile

@@ -25,22 +25,18 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/cuki.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cuki"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Waite"]
-  s.date = "2011-10-15"
+  s.date = "2011-10-16"
   s.description = ""
   s.email = "andy@andywaite.com"
   s.executables = ["cuki"]
@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rspec",
+    ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -28,9 +30,19 @@ Gem::Specification.new do |s|
     "bin/cuki",
     "cuki.gemspec",
     "cuki.yaml.sample",
+    "features/pull/pull.feature",
+    "features/pull/pull_single.feature",
+    "features/pull/tables.feature",
+    "features/pull/tags.feature",
+    "features/pull/textile.feature",
+    "features/push/push.feature",
+    "features/push/tables.feature",
+    "features/push/tags.feature",
+    "features/step_defs/pull_steps.rb",
+    "features/support/env.rb",
     "lib/cuki.rb",
-    "test/helper.rb",
-    "test/test_cuki.rb"
+    "spec/cuki_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/andyw8/cuki"
   s.licenses = ["MIT"]
@@ -48,6 +60,7 @@ Gem::Specification.new do |s|
       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"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<httpclient>, [">= 0"])
       s.add_dependency(%q<nokogiri>, [">= 0"])
@@ -55,6 +68,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<httpclient>, [">= 0"])
@@ -63,6 +77,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/features/pull/pull.feature

@@ -0,0 +1,62 @@
+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:
+      """
+      ---
+      host: http://example.com
+      mappings:
+        123: products/add_product
+        456: products/remove_product
+      """
+    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
+      </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`
+    Then the file "features/products/add_product.feature" should contain exactly:
+      """
+      Feature: Add Product
+
+      http://example.com/pages/editpage.action?pageId=123
+
+
+      This feature describes adding a product
+
+      """
+    Then the file "features/products/remove_product.feature" should contain exactly:
+      """
+      Feature: Remove Product
+
+      http://example.com/pages/editpage.action?pageId=456
+
+
+      This feature describes removing a product
+
+      """
+

data/features/pull/pull_single.feature

@@ -0,0 +1,28 @@
+Feature: Pull single
+
+  Scenario: Pull all features
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      mappings:
+        123: products/add_product
+        456: products/remove_product
+      """
+    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
+      </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 features/products/add_product.feature`
+    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/tables.feature

@@ -0,0 +1,40 @@
+# Assume no header for single column tables?
+Feature: Tables
+
+  Scenario: Table with more than one column
+
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      mappings:
+        123: products/add_product
+      """
+    And a Confluence page on "example.com" with id 123:
+      """
+      <input id="content-title" value="Add Product">
+      <div id="markupTextarea">
+      h5. Scenario: Foo
+
+      Given this:
+      || foo || bar ||
+      | a | 1 |
+      | b | 2 |
+      </div>
+      """
+    When I run `cuki pull`
+    Then the file "features/products/add_product.feature" should contain exactly:
+      """
+      Feature: Add Product
+
+      http://example.com/pages/editpage.action?pageId=123
+
+
+      Scenario: Foo
+
+      Given this:
+      | foo | bar |
+      | a | 1 |
+      | b | 2 |
+
+      """

data/features/pull/tags.feature

@@ -0,0 +1,32 @@
+Feature: Tags
+
+  Scenario:
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      tags:
+        draft: "{info:title=Draft version}"
+        signed_off: "{info:title=Signed-off}"
+      mappings:
+        123: products/add_product
+      """
+    And a Confluence page on "example.com" with id 123:
+      """
+      <input id="content-title" value="Add Product">
+      <div id="markupTextarea">{info:title=Draft version}
+      h5. Scenario: Foo
+      </div>
+      """
+    When I run `cuki pull`
+    Then the file "features/products/add_product.feature" should contain exactly:
+      """
+      @draft
+      Feature: Add Product
+
+      http://example.com/pages/editpage.action?pageId=123
+
+
+      Scenario: Foo
+
+      """

data/features/pull/textile.feature

@@ -0,0 +1,32 @@
+Feature: Textile
+
+  Scenario: 
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://example.com
+      mappings:
+        123: products/add_product
+      """
+    And a Confluence page on "example.com" with id 123:
+      """
+      <input id="content-title" value="Add Product">
+      <div id="markupTextarea">
+      h5. Scenario: Foo
+      
+      h6. Scenario Outline: Bar
+      </div>
+      """
+    When I run `cuki pull`
+    Then the file "features/products/add_product.feature" should contain exactly:
+      """
+      Feature: Add Product
+
+      http://example.com/pages/editpage.action?pageId=123
+
+
+      Scenario: Foo
+      
+      Scenario Outline: Bar
+
+      """

data/features/push/push.feature

@@ -0,0 +1,79 @@
+@pending
+Feature: Push
+
+  Background: 
+    Given a file named "config/cuki.yaml" with:
+      """
+      ---
+      host: http://mywiki
+      mappings:
+        123: products/add_product
+      """
+
+  Scenario: Push a feature with no scenarios
+    Given a file named "config/cuki.yaml" with:
+      """
+      Feature: Hello world & all
+
+      This is my feature
+      """
+    When I run `cuki push features/products/add_product.feature`
+    Then the feature should be pushed to "http://mywiki/pages/editpage.action?pageId=123"
+    And the Confluence content should be:
+      """
+      This is my feature
+      """
+    And the Confluence title should be:
+      """
+      Hello world & all
+      """
+
+  Scenario: Push a feature containing a scenario
+    Given a file named "config/cuki.yaml" with:
+      """
+      Scenario: My scenario
+        Given something
+        When something
+        Then something
+      """
+    When I push that feature
+    Then the Confluence content should include:
+      """
+      h2. My scenario
+
+      Given something
+      When something
+      Then something
+      """
+
+  Scenario: Push a feature containing a scenario outline
+    
+    The first row of the examples table should be a header row.
+    Given a feature file in "features/hello_world.feature"
+    And that feature includes the scenario:
+      """
+      Scenario: My scenario
+        Given <condition>
+        When <action>
+        Then <outcome>
+        Examples:
+          | condition | action | outcome |
+          | a         | b      | c       |
+      """
+    When I push that feature
+    Then the Confluence content should include:
+      """
+      h2. My scenario
+
+      Given <condition>
+      When <action>
+      Then <outcome>
+      Examples:
+         || condition || action || outcome ||
+         | a         | b      | c       |
+
+      """
+
+  Scenario: Push a feature containing a scenario outline with multiple example
+    Pending
+

data/features/push/tables.feature

@@ -0,0 +1,3 @@
+@pending
+Feature: Tables
+

data/features/push/tags.feature

@@ -0,0 +1,25 @@
+@pending
+Feature: Tags
+  
+  Tags on a feature or scenario should be turned into {info} macros.
+
+  Scenario: Tagged feature
+    
+    Tag names should be titleised, with underscores converted to spaces.
+    Given the feature:
+      """
+      @pending @in_progress @some-other
+      Feature: Hello world
+
+      Here is the feature
+      """
+    When I push that feature to Confluence
+    Then the Confluence content should be:
+      """
+      {info:Pending}
+      {info:In Progress}
+      {info:Some-other}
+
+      Here is a feature
+      """
+

data/features/step_defs/pull_steps.rb

@@ -0,0 +1,17 @@
+Given /^a Confluence page on "([^"]*)" with id (\d+):$/ do |host, id, content|
+
+  # Since the command-line app runs in a difference process, we need serialize
+  # the URLs to be stubbed
+
+  @stubs ||= {}
+  @stubs["http://#{host}/pages/editpage.action?pageId=#{id}"] = content
+  
+  File.open('stubs.json', 'w') do |f|
+    f.write @stubs.to_json
+  end
+
+end
+
+Given /^no file named "([^"]*)" exists$/ do |file|
+  File.delete(file) if File.exist?(file)
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+#ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+require 'aruba/cucumber'
+require 'webmock/cucumber'
+
+Before do
+  @dirs = ["."]
+  FileUtils.rm_rf 'features/products'
+end

data/lib/cuki.rb

@@ -3,6 +3,16 @@ require 'httpclient'
 require 'nokogiri'
 require 'yaml'
 require 'CGI'
+require 'webmock'
+require 'json'
+
+include WebMock::API
+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
+end
 
 class Cuki
 
@@ -13,21 +23,35 @@ class Cuki
   end
 
   def initialize(args)
-    raise "No command given" if args.empty?
+    if args.empty?
+      puts "No action given"
+      exit(1)
+    end
     parse_config_file
-    command = args.first
-    if 'pull' == command
+    action = args.first
+    if 'pull' == action
       verify_project
       configure_http_client
-      @config['mappings'].each { |id, filepath|  process_feature id, filepath }    
-      autoformat
-    elsif 'push' == command
+      file = args[1]
+      if file
+        puts "got file: #{file}"
+        key = file.gsub('features/', '').gsub('.feature', '')
+        puts "key: #{key}"
+        id = @config['mappings'].invert[key]
+        filepath = key
+        process_feature id, filepath
+      else
+        @config['mappings'].each { |id, filepath|  process_feature id, filepath }
+      end
+      #autoformat
+    elsif 'push' == action
       feature_to_be_pushed = args[1] # e.g. features/products/add_product.feature
       feature_as_in_yaml = feature_to_be_pushed.gsub('features/', '').gsub('.feature', '')
       id = @config['mappings'].invert[feature_as_in_yaml]
       raise "No mapping found for #{feature_as_in_yaml}" unless id
     else
-      raise "Unknown command '#{command}"
+      puts "Unknown action '#{action}"
+      exit(1)
     end
   end
 
@@ -36,10 +60,14 @@ class Cuki
   def verify_project
     # check features folder exists
     raise "features folder not found" unless File.exists?('features')
-    autoformat
+    #autoformat
   end
   
   def parse_config_file
+    unless File.exist?(CONFIG_PATH)
+      puts "No config file found at #{CONFIG_PATH}"
+      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"]
@@ -58,13 +86,20 @@ class Cuki
     response = @client.get wiki_link
     doc = Nokogiri(response.body)
         
-    process_tags
+    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)
 
     clean
+
+    process_tags
+
     save_file filepath
   end
   
@@ -85,20 +120,24 @@ class Cuki
     @content.gsub!('\\', '')
 
     # remove any unwanted headers
-    @content.gsub!(/h\d\. /, '')
+    @content.gsub!(/h\d\. (Scenario: .*)/, '\1')
+    @content.gsub!(/h\d\. (Scenario Outline: .*)/, '\1')
 
-    # remove any other confluence markup
-    @content.gsub!(/\{.*\}/, '')
   end
   
   def process_tags
     tags = []
     if @config['tags']
-      @config['tags'].each do |tag, snippet|
-        tags << "@#{tag}" if @content.include?(snippet)
+      @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
-    @content += tags.join(' ') + "\n" unless tags.empty?
   end
   
   def save_file(filepath)

data/spec/cuki_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Cuki" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'cuki'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuki
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Andy Waite
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-15 00:00:00 Z
+date: 2011-10-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -105,6 +105,20 @@ dependencies:
   name: rcov
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: rspec
+  prerelease: false
+  type: :development
 description: ""
 email: andy@andywaite.com
 executables: 
@@ -116,6 +130,8 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .rspec
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -125,9 +141,19 @@ files:
 - bin/cuki
 - cuki.gemspec
 - cuki.yaml.sample
+- features/pull/pull.feature
+- features/pull/pull_single.feature
+- features/pull/tables.feature
+- features/pull/tags.feature
+- features/pull/textile.feature
+- features/push/push.feature
+- features/push/tables.feature
+- features/push/tags.feature
+- features/step_defs/pull_steps.rb
+- features/support/env.rb
 - lib/cuki.rb
-- test/helper.rb
-- test/test_cuki.rb
+- spec/cuki_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/andyw8/cuki
 licenses: 
 - MIT

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'cuki'
-
-class Test::Unit::TestCase
-end

data/test/test_cuki.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestCuki < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end