gdocs_features 0.1.0

data/spec/cli_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'file_feature_store'
+require 'google_feature_store'
+require 'remote_features/cli/main'
+require 'remote_features/dialogue'
+
+describe RemoteFeatures::Cli::Main do
+  before do
+    $stdout.stub!(:puts)
+    Kernel.stub!(:exit)
+    RemoteFeatures::Dialogue.stub!(:new).and_return(mock("dialogue", :start => nil))
+  end
+  
+  it "should create a file feature store with the first argument as the path" do
+    file_store = mock("file_store")
+    gdocs_store = mock("gdocs_store")
+    FileFeatureStore.should_receive(:new).with("some/dir").and_return(file_store)
+    GoogleFeatureStore.stub!(:new).and_return(gdocs_store)
+    RemoteFeatures::Cli::Main.execute(["some/dir", "joshski:pass@docs.google.com"])
+  end
+  
+  it "should create a google feature store when argument 2 matches user:pass@docs.google.com" do
+    file_store = mock("file_store")
+    gdocs_store = mock("gdocs_store")
+    client = mock("client")
+    FileFeatureStore.stub!(:new).and_return(file_store)
+    GoogleDocsClient.should_receive(:new).with("joshski", "pass").and_return(client)
+    GoogleFeatureStore.should_receive(:new).with(client).and_return(gdocs_store)
+    RemoteFeatures::Cli::Main.execute(["some/dir", "joshski:pass@docs.google.com"])
+  end
+  
+  describe "with invalid arguments", :shared => true do
+    it "should show usage" do
+      [FileFeatureStore, GoogleFeatureStore, GoogleDocsClient].each { |c| c.stub!(:new) }
+      $stdout.should_receive(:puts).with("Usage: remotefeatures <directory> <user:password@host>")
+      RemoteFeatures::Cli::Main.execute(@args)
+    end
+
+    it "should not create anything" do
+      [FileFeatureStore, GoogleFeatureStore, GoogleDocsClient].each do |c|
+        c.should_not_receive(:new)
+      end
+      RemoteFeatures::Cli::Main.execute(@args)
+      RemoteFeatures::Dialogue.should_not_receive(:new)
+    end    
+  end
+  
+  describe "with no arguments" do
+    before { @args = [] }
+    it_should_behave_like "with invalid arguments"
+  end
+  
+  describe "with only first argument" do
+    before { @args = ["."] }
+    it_should_behave_like "with invalid arguments"
+  end
+  
+  describe "with three arguments" do
+    before { @args = ["valid", "valid:valid@valid.com", "invalid"] }
+    it_should_behave_like "with invalid arguments"
+  end
+  
+  describe "with invalid url argument" do
+    before { @args = ["valid", "in-valid@valid.com"] }
+    it_should_behave_like "with invalid arguments"
+  end
+
+end

data/spec/dialogue_spec.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'remote_features/dialogue'
+require 'feature_diff'
+
+describe RemoteFeatures::Dialogue do
+  
+  before do
+    @local_store = mock("local_store")
+    @remote_store = mock("remote_store")
+    @io = mock("io", :puts => nil, :gets => "")
+    @diff = mock("diff", :differences => {}, :patch => nil)
+    @dialogue = RemoteFeatures::Dialogue.new(@io, @io, @local_store, @remote_store)
+    FeatureDiff.stub!(:new).with(@local_store, @remote_store).and_return(@diff)
+    
+    @first_local_feature = mock("first_local_feature", :path => 'first/example.feature')
+    @first_remote_feature = mock("first_remote_feature", :path => 'first/example.feature')
+    @second_local_feature = mock("second_local_feature", :path => 'second/example.feature')
+    @second_remote_feature = mock("second_remote_feature", :path => 'second/example.feature')
+    @first_difference = Difference.new(@first_local_feature, @first_remote_feature, @local_store)
+    @second_difference = Difference.new(@second_local_feature, @second_remote_feature, @local_store)
+    @diff.stub!(:differences).and_return({
+      @first_difference.path => @first_difference,
+      @second_difference.path => @second_difference
+    })
+    @expected_diff_output = "1) updated - first/example.feature\n2) updated - second/example.feature"
+  end
+  
+  it "should perform a feature diff" do
+    FeatureDiff.should_receive(:new).with(@local_store, @remote_store).and_return(@diff)
+    @dialogue.start
+  end
+
+  it "should render the results of the feature diff to the output" do
+    @io.should_receive(:puts).with(@expected_diff_output)
+    @dialogue.start
+  end
+  
+  it "should prompt for patch numbers to apply" do
+    @io.stub!(:puts).with(@expected_diff_output)
+    @io.should_receive(:puts).with("Enter changes to apply, 'all' to apply all, or blank to exit")
+    @dialogue.start
+  end
+  
+  it "should accept a list of change numbers to apply" do
+    @io.should_receive(:gets).and_return("1 67 99\n")
+    @dialogue.start
+  end
+  
+  it "should apply the selected patches" do
+    @io.stub!(:gets).and_return("1 67 99\n")
+    @diff.should_receive(:patch).with([1, 67, 99])
+    @dialogue.start
+  end
+
+  it "should exit when there are no differences" do
+    @diff.stub!(:differences).and_return({})
+    Kernel.should_receive(:exit)
+    @dialogue.start
+  end
+  
+  it "should write a message when there are no differences" do
+    @diff.stub!(:differences).and_return({})
+    Kernel.stub!(:exit)
+    @io.should_receive(:puts)
+    @dialogue.start
+  end
+  
+end

data/spec/feature_diff_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'feature_diff'
+require 'google_docs_client'
+require 'google_feature_store'
+require 'file_feature_store'
+
+describe FeatureDiff do
+
+  it "should find updated features where versions are different" do
+    local_feature = mock("local_feature", :path => '/the/same.feature', :version => '123')
+    remote_feature = mock("remote_feature", :path => '/the/same.feature', :version => '124')
+    local_store = mock("local_store", :features => [local_feature])
+    remote_store = mock("remote_store", :features => [remote_feature])
+    diff = FeatureDiff.new(local_store, remote_store)
+    diff['/the/same.feature'].local.should == local_feature
+    diff['/the/same.feature'].remote.should == remote_feature
+  end
+
+  it "should find remote only features" do
+    remote_feature = mock("remote_feature", :path => '/remote/only.feature', :version => '123')
+    local_store = mock("local_store", :features => [])
+    remote_store = mock("remote_store", :features => [remote_feature])
+    diff = FeatureDiff.new(local_store, remote_store)
+    diff['/remote/only.feature'].remote.should == remote_feature
+    diff['/remote/only.feature'].local.should be_nil
+  end
+
+  it "should find local only features" do
+    local_feature = mock("local_feature", :path => '/local/only.feature', :version => '123')
+    local_store = mock("local_store", :features => [local_feature])
+    remote_store = mock("remote_store", :features => [])
+    diff = FeatureDiff.new(local_store, remote_store)
+    diff['/local/only.feature'].local.should == local_feature
+    diff['/local/only.feature'].remote.should be_nil
+  end
+
+  it "should patch remote only features" do
+    remote_feature = mock("remote_feature", :path => 'any/old.feature', :version => '789', :reformat => 'OK!')
+    local_store = mock("local_store", :features => [])
+    remote_store = mock("remote_store", :features => [remote_feature])
+    diff = FeatureDiff.new(local_store, remote_store)
+    local_store.should_receive(:create_feature).with('any/old.feature', '789', 'OK!')
+    diff.patch
+  end
+  
+  it "should patch updated features" do
+    local_feature = mock("local_feature", :path => '/the/same.feature', :version => '123')
+    remote_feature = mock("remote_feature", :path => '/the/same.feature', :version => '124')
+    local_store = mock("local_store", :features => [local_feature])
+    remote_store = mock("remote_store", :features => [remote_feature])
+    diff = FeatureDiff.new(local_store, remote_store)
+    local_feature.should_receive(:patch_from).with(remote_feature)
+    diff.patch
+  end
+  
+  it "should patch subset of differences" do
+    local_one = mock("local_one", :path => '/the/one.feature', :version => '123')
+    local_two = mock("local_two", :path => '/the/two.feature', :version => '123')
+    remote_one = mock("remote_one", :path => '/the/one.feature', :version => 'higher')
+    remote_two = mock("remote_two", :path => '/the/two.feature', :version => 'higher')
+    local_store = mock("local_store", :features => [local_one, local_two])
+    remote_store = mock("remote_store", :features => [remote_one, remote_two])
+    diff = FeatureDiff.new(local_store, remote_store)
+    local_one.should_receive(:patch_from).with(remote_one)    
+    local_two.should_not_receive(:patch_from).with(remote_two)
+    diff.patch([1])
+  end
+
+  it "should not patch local only features" do
+    local_feature = mock("local_feature", :path => '/the/same.feature', :version => '123')
+    local_store = mock("local_store", :features => [local_feature])
+    remote_store = mock("remote_store", :features => [])
+    diff = FeatureDiff.new(local_store, remote_store)
+    local_feature.should_not_receive(:patch_from)
+    diff.patch
+  end
+
+end
+

data/spec/feature_reformat_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+$reformatted = %{Feature: Washing up
+
+  In order to reduce infection
+  As a user of kitchenware
+  I want to wash up after use
+
+    Scenario: Wash dishes
+
+      Given there is a dish
+      And it is dirty
+      Then I should wash it up
+
+    Scenario: Dishwasher
+
+      Given there are lots of dirty dishes
+      When I put them into the dishwasher
+      And I turn it on
+      Then it should wash the dishes}
+
+require 'feature'
+
+describe Feature, "reformat" do
+  
+  class StubFeature < Feature
+    def body
+      $reformatted.map { |line| line.strip }.reject { |l| l == "" }
+    end
+    
+    def version
+      123
+    end
+  end
+  
+  it "should reformat feature body" do
+    StubFeature.new.reformat.should == $reformatted
+  end
+  
+end

data/spec/file_feature_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'file_feature'
+
+describe FileFeature do
+
+  before do
+    @feature = FileFeature.new(File.dirname(__FILE__), "stubs/example.feature")
+  end
+
+  it "should expose a body from the file" do
+    @feature.body.first.should == "Feature: Example"
+  end
+
+  it "should expose a title from the filename" do
+    @feature.title.should == "example"
+  end
+
+  it "should get the version from the first line of comment in the file" do
+    @feature.version.should == "123"
+  end
+
+end

data/spec/file_feature_store_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/temp_file_system'
+
+require 'file_feature_store'
+
+describe FileFeatureStore do
+
+  before do
+    @fs = TempFileSystem.new(
+      'my/stuff/banana.feature' => 'OK'
+    )
+  end
+  
+  after do
+    @fs.destroy
+  end  
+
+  it "should find files with .feature extension" do
+    store = FileFeatureStore.new("/some/dir")
+    Dir.should_receive(:glob).with("/some/dir/**/*.feature").and_return([])
+    store.features
+  end
+  
+  describe "with a physical file store" do
+    
+    it "should find features" do
+      store = FileFeatureStore.new(@fs.root)
+      store.features.first.title.should == "banana"
+    end
+    
+  end
+
+end

data/spec/google_authorization_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'google_authorization'
+
+describe GoogleAuthorization do
+
+  it "should post to the authorization resource once on first access of header" do
+    RestClient.stub!(:post).and_return("xxxAuth=ABC")
+    auth = GoogleAuthorization.new("email", "pass")
+    auth.header.should == "GoogleLogin auth=ABC"
+    RestClient.stub!(:post).and_raise "shouldn't post twice"
+    auth.header
+  end
+
+  it "should post the correct url and parameters when authorizing" do
+    url = "https://www.google.com/accounts/ClientLogin"
+    params = { "accountType" => "HOSTED_OR_GOOGLE", "Email" => "email", "Passwd" => "pass", "service" => "writely" }
+    RestClient.should_receive(:post).with(url, hash_including(params))
+    GoogleAuthorization.new("email", "pass").authorize
+  end
+
+  it "should authorize with a real rest client" do
+    GoogleAuthorization.new("restapitest@googlemail.com", "testrestapi").authorize.size.should > 100
+  end
+
+end

data/spec/google_docs_client_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'google_docs_client'
+
+describe GoogleDocsClient do
+
+  it "should get the documents feed as a resource" do
+    client = GoogleDocsClient.new("restapitest", "testrestapi")
+    resource = mock("resource")
+    GoogleResource.should_receive(:new).and_return(resource)
+    resource.should_receive(:get).and_return("OK")
+    client.documents_feed.get.to_s.should == "OK"
+  end
+
+  describe "connected to Google" do
+
+    before do
+      @client = GoogleDocsClient.new("restapitest@googlemail.com", "testrestapi")
+    end
+
+    it "should get the documents feed" do
+      @client.documents_feed.get.to_s.should =~ /<feed/
+    end
+
+    it "should get folders" do
+      @client.folders.get.to_s.should =~ /<feed/
+    end
+    
+  end
+
+end
+

data/spec/google_feature_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+$reformatted = %{Feature: Washing up
+
+  In order to reduce infection
+  As a user of kitchenware
+  I want to wash up after use
+
+    Scenario: Wash dishes
+
+      Given there is a dish
+      And it is dirty
+      Then I should wash it up
+
+    Scenario: Dishwasher
+
+      Given there are lots of dirty dishes
+      When I put them into the dishwasher
+      And I turn it on
+      Then it should wash the dishes}
+
+require 'google_feature'
+
+describe Feature, "reformat" do
+  
+  class StubFeature < GoogleFeature
+    def body
+      $reformatted.map { |line| line.strip }.reject { |l| l == "" }
+    end
+    
+    def version
+      123
+    end
+  end
+  
+  it "should reformat feature body" do
+    it "should not have css in the file" do
+      auth = mock("auth", :header => "xxx")
+      RestClient.should_receive(:get).with("url", hash_including("Authorization" => "xxx"))
+      GoogleFeature.new(auth, "url").get
+
+    end
+    StubFeature.new.reformat.should == $reformatted
+  end
+  
+end

data/spec/google_feature_store_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'google_feature_store'
+require 'google_docs_client'
+
+def relative_path(path)
+  File.join(File.dirname(__FILE__), path)
+end
+
+def stub_folders_feed
+  mock("folders_feed", :get => File.readlines(relative_path('./stubs/folders.atom.xml')).map {|l| l.rstrip})
+end
+
+def stub_documents_feed
+  mock("documents_feed", :get => File.readlines(relative_path('./stubs/documents.atom.xml')).map {|l| l.rstrip})
+end
+
+describe GoogleFeatureStore do
+
+  describe "creating features from feed" do
+
+    before do
+      @body = "happy"
+      client = mock("client",
+        :folders => stub_folders_feed,
+        :documents_feed => stub_documents_feed,
+        :document_body => mock("document_body", :get => @body))
+      @features = GoogleFeatureStore.new(client).features
+      @banana = @features.first
+    end
+
+    it "should expose a list of features" do
+      @features.size.should == 1
+    end
+
+    it "should expose a body from a resource" do
+      @banana.body.should == [@body]
+    end
+
+    it "should expose a body from the entry" do
+      @banana.title.should == "banana"
+    end
+
+    it "should expose a version from the entry modified date" do
+      @banana.version.should == "2009-02-19T23:36:34.402Z"
+    end
+
+  end
+
+  it "should get a folder hierarchy from a feed" do
+    client = mock("client", :folders => stub_folders_feed, :documents_feed => stub_documents_feed)
+    folders = GoogleFeatureStore.new(client).folders
+    yellow = "http://docs.google.com/feeds/documents/private/full/folder%3Aa58446b0-772d-4ff7-bcb5-eb280b0cf53a"
+    folders[yellow].should == "fruit/yellow"
+  end
+
+  it "should attach paths to features" do
+    client = mock("client", :folders => stub_folders_feed, :documents_feed => stub_documents_feed)
+    features = GoogleFeatureStore.new(client).features
+    features.find_all { | f | f.path == "fruit/yellow/banana.feature" }.size.should == 1
+  end
+  
+end
+

data/spec/google_resource_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'google_resource'
+
+describe GoogleResource do
+  
+  it "should include the authorization header on get" do
+    auth = mock("auth", :header => "xxx")
+    RestClient.should_receive(:get).with("url", hash_including("Authorization" => "xxx"))
+    GoogleResource.new(auth, "url").get
+  end
+
+  it "should include additional headers on get" do
+    auth = mock("auth", :header => "xxx")
+    RestClient.should_receive(:get).with("url", hash_including("another" => "zzz"))
+    GoogleResource.new(auth, "url").get("another" => "zzz")
+  end
+
+  it "should include constructor headers on get" do
+    auth = mock("auth", :header => "xxx")
+    RestClient.should_receive(:get).with("url", hash_including("another" => "zzz"))
+    GoogleResource.new(auth, "url", {"another" => "zzz"}).get
+  end
+
+end

data/spec/integration_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/temp_file_system'
+
+require 'google_feature_store'
+require 'google_docs_client'
+require 'file_feature_store'
+require 'feature_diff'
+
+describe "integration with Google" do
+
+    before(:all) do
+      @client = GoogleDocsClient.new("restapitest@googlemail.com", "testrestapi")
+      @remote_store = GoogleFeatureStore.new(@client)
+      @features = @remote_store.features
+      @fs = TempFileSystem.new(
+        'fruit/yellow/banana.feature' => %{#version:123
+          Some other text
+        }
+      )
+    end
+    
+    after(:all) do
+      @fs.destroy
+    end
+
+    it "should get features" do
+      @features.size.should > 1
+      banana = @features.find { |f| f.title == "banana" }
+      banana.path.should == 'fruit/yellow/banana.feature'
+    end
+  
+    it "should patch differences" do
+      local_store = FileFeatureStore.new(@fs.root)
+      diff = FeatureDiff.new(local_store, @remote_store)
+      banana = diff["fruit/yellow/banana.feature"]
+      banana.local.version.should == "123"
+      banana.remote.version.should_not == "123"
+      banana.patch
+      banana.local.version.should == banana.remote.version
+    end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+lib_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'rubygems'
+require 'spec'

data/spec/stubs/documents.atom.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/" xmlns:gd="http://schemas.google.com/g/2005">
+  <id>http://docs.google.com/feeds/documents/private/full</id>
+  <updated>2009-02-19T23:42:26.569Z</updated>
+  <title type="text">Available Documents - restapitest@googlemail.com</title>
+  <link rel="alternate" type="text/html" href="http://docs.google.com"/>
+  <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="http://docs.google.com/feeds/documents/private/full"/>
+  <link rel="http://schemas.google.com/g/2005#post" type="application/atom+xml" href="http://docs.google.com/feeds/documents/private/full"/>
+  <link rel="self" type="application/atom+xml" href="http://docs.google.com/feeds/documents/private/full"/>
+  <author>
+    <name>restapitest</name>
+    <email>restapitest@googlemail.com</email>
+  </author>
+  <openSearch:totalResults>1</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <entry>
+    <id>http://docs.google.com/feeds/documents/private/full/document%3Adhmn2mkk_0d4rbv8d8</id>
+    <published>2009-02-19T23:04:11.560Z</published>
+    <updated>2009-02-19T23:36:34.402Z</updated>
+    <category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/docs/2007#document" label="document"/>
+    <category scheme="http://schemas.google.com/docs/2007/folders/restapitest@googlemail.com" term="yellow" label="yellow"/>
+    <title type="text">Banana</title>
+    <content type="text/html" src="http://docs.google.com/feeds/download/documents/RawDocContents?action=fetch&amp;justBody=false&amp;revision=_latest&amp;editMode=false&amp;docID=dhmn2mkk_0d4rbv8d8"/>
+    <link rel="http://schemas.google.com/docs/2007#parent" type="application/atom+xml" href="http://docs.google.com/feeds/documents/private/full/folder%3Aa58446b0-772d-4ff7-bcb5-eb280b0cf53a" title="yellow"/>
+    <link rel="alternate" type="text/html" href="http://docs.google.com/Doc?id=dhmn2mkk_0d4rbv8d8"/>
+    <link rel="self" type="application/atom+xml" href="http://docs.google.com/feeds/documents/private/full/document%3Adhmn2mkk_0d4rbv8d8"/>
+    <link rel="edit" type="application/atom+xml" href="http://docs.google.com/feeds/documents/private/full/document%3Adhmn2mkk_0d4rbv8d8/fre2o3fm"/>
+    <link rel="edit-media" type="text/html" href="http://docs.google.com/feeds/media/private/full/document%3Adhmn2mkk_0d4rbv8d8/fre2o3fm"/>
+    <author>
+      <name>restapitest</name>
+      <email>restapitest@gmail.com</email>
+    </author>
+    <gd:feedLink rel="http://schemas.google.com/acl/2007#accessControlList" href="http://docs.google.com/feeds/acl/private/full/document%3Adhmn2mkk_0d4rbv8d8"/>
+  </entry>
+</feed>
+

data/spec/stubs/example.feature

@@ -0,0 +1,16 @@
+# version:123
+
+Feature: Example
+
+  Narrative 1
+  Narrative 2
+
+  Scenario: First
+
+    Step 1
+    Step 2
+
+  Scenario: Second
+
+    Step 3
+    Step 4