gdocs_features 0.1.0

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'cucumber/rake/task'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+desc "Run all features"
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty" 
+end
+
+desc "Run pending features"
+Cucumber::Rake::Task.new(:pending) do |t|
+  t.cucumber_opts = "--format pretty -e features/** features-pending" 
+end
+
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "gdocs_features"  
+    gemspec.summary = "Cucumber features in gdocs"  
+    gemspec.description = "Cucumber features merged locally from Google Docs"  
+    gemspec.email = "jody@alkema.ca"  
+    gemspec.homepage = "http://github.com/alkema/gdocs-features"  
+    gemspec.authors = ["Josh Chisholm"]  
+  end  
+  Jeweler::GemcutterTasks.new    
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/remotefeatures

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# Add '.rb' to work around a bug in IronRuby's File#dirname
+$:.unshift(File.dirname(__FILE__ + '.rb') + '/../lib') unless $:.include?(File.dirname(__FILE__ + '.rb') + '/../lib')
+
+require 'rubygems'
+require 'remote_features/cli/main'
+RemoteFeatures::Cli::Main.execute(ARGV.dup)

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --format progress features
+pending: --format pretty features-pending

data/features/patch_local_files_from_gdocs.feature

@@ -0,0 +1,33 @@
+Feature: Patch local files from Google docs
+
+	In order for non-technical stakeholders to specify user stories
+	As a developer
+	I want to merge in features from Google docs
+
+		Scenario: Diff features
+			
+			Given I have a local feature store
+			And a google docs feature store
+			And the local feature store contains:
+				| path 												   | version                   |
+				| fruit/yellow/banana.feature    | 2009-02-20T00:36:34.402Z  |
+				| fruit/green/apple.feature      | some-new-version          |
+				| fruit/yellow/pineapple.feature | some-old-version          |
+			And the google docs feature store contains:
+				| path 												   | version                   |
+				| fruit/yellow/banana.feature    | 2009-02-20T00:36:34.402Z  |
+				| fruit/yellow/pineapple.feature | 2009-02-20T01:12:36.130Z  |
+				| fruit/green/grape.feature      | 2009-02-21T10:27:16.971Z  |
+			When I run the program
+			Then I should see the following changes:
+				| path													 | change    |
+				| fruit/green/grape.feature      | created   |
+				| fruit/green/apple.feature      | deleted   |
+				| fruit/yellow/pineapple.feature | updated   |
+		  When I apply change 1
+			And  I run the program
+			Then I should see the following changes:
+				| path													 | change    |
+				| fruit/green/apple.feature      | deleted   |
+				| fruit/yellow/pineapple.feature | updated   |
+			

data/features/step_definitions/diff_steps.rb

@@ -0,0 +1,19 @@
+require 'feature_diff'
+require 'remote_features/cli/main'
+
+When /^I run the program$/ do
+  RemoteFeatures::Cli::Main.execute([@local_dir, "restapitest:testrestapi@docs.google.com"])
+end
+
+Then /^I should see the following changes:$/ do | table |
+  table.hashes.each do | row |
+    difference = @diff[row['path']]
+    raise "#{row['path']} not present -- #{@diff.inspect}" if difference.nil?
+    difference.change_description.should == row['change']
+  end
+  @diff.differences.each do | path, difference |
+    if table.hashes.find { |h| h['path'] == path }.nil?
+      raise "Unexpected change to #{path} (#{difference.change_description})"
+    end
+  end
+end

data/features/step_definitions/google_steps.rb

@@ -0,0 +1,19 @@
+require 'google_feature_store'
+require 'google_docs_client'
+
+Given /a google docs feature store$/ do
+  @client = GoogleDocsClient.new("restapitest@googlemail.com", "testrestapi")
+  @remote_store = GoogleFeatureStore.new(@client)
+end
+
+Given /^the google docs feature store contains:$/ do | table |
+  features = @remote_store.features
+  features.size.should == table.hashes.size
+  table.hashes.each do | row |
+    matches = features.find_all { |f| f.path == row['path'] }
+    matches.size.should == 1
+    if matches.first.version != row['version']
+      raise "expected '#{row['path']}' to have version '#{row['version']}', got '#{matches.first.version}'" 
+    end
+  end
+end

data/features/step_definitions/local_steps.rb

@@ -0,0 +1,16 @@
+require 'file_feature_store'
+require 'tmpdir'
+require 'fileutils'
+
+Given /a local feature store$/ do
+  @local_dir = File.join(Dir.tmpdir, 'feature_store')
+  FileUtils.rm_rf @local_dir
+  Dir.mkdir(@local_dir)
+  @local_store = FileFeatureStore.new(@local_dir)
+end
+
+Given /^the local feature store contains:$/ do |table|
+  table.hashes.each do | row |
+    @local_store.create_feature(row['path'], row['version'], 'any old thing')
+  end
+end

data/features/support/env.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/gdocs_features.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gdocs_features}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Chisholm"]
+  s.date = %q{2010-02-22}
+  s.default_executable = %q{remotefeatures}
+  s.description = %q{Cucumber features merged locally from Google Docs}
+  s.email = %q{jody@alkema.ca}
+  s.executables = ["remotefeatures"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "README",
+     "Rakefile",
+     "VERSION",
+     "bin/remotefeatures",
+     "cucumber.yml",
+     "features/patch_local_files_from_gdocs.feature",
+     "features/step_definitions/diff_steps.rb",
+     "features/step_definitions/google_steps.rb",
+     "features/step_definitions/local_steps.rb",
+     "features/support/env.rb",
+     "gdocs_features.gemspec",
+     "lib/difference.rb",
+     "lib/feature.rb",
+     "lib/feature_diff.rb",
+     "lib/file_feature.rb",
+     "lib/file_feature_store.rb",
+     "lib/google_authorization.rb",
+     "lib/google_docs_client.rb",
+     "lib/google_feature.rb",
+     "lib/google_feature_store.rb",
+     "lib/google_resource.rb",
+     "lib/remote_features/cli/main.rb",
+     "lib/remote_features/dialogue.rb",
+     "pkg/gdocs_features-0.1.0.gem",
+     "spec/cli_spec.rb",
+     "spec/dialogue_spec.rb",
+     "spec/feature_diff_spec.rb",
+     "spec/feature_reformat_spec.rb",
+     "spec/file_feature_spec.rb",
+     "spec/file_feature_store_spec.rb",
+     "spec/google_authorization_spec.rb",
+     "spec/google_docs_client_spec.rb",
+     "spec/google_feature_spec.rb",
+     "spec/google_feature_store_spec.rb",
+     "spec/google_resource_spec.rb",
+     "spec/integration_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/stubs/documents.atom.xml",
+     "spec/stubs/example.feature",
+     "spec/stubs/folders.atom.xml",
+     "spec/temp_file_system.rb",
+     "spec/temp_file_system_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/alkema/gdocs-features}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Cucumber features in gdocs}
+  s.test_files = [
+    "spec/cli_spec.rb",
+     "spec/dialogue_spec.rb",
+     "spec/feature_diff_spec.rb",
+     "spec/feature_reformat_spec.rb",
+     "spec/file_feature_spec.rb",
+     "spec/file_feature_store_spec.rb",
+     "spec/google_authorization_spec.rb",
+     "spec/google_docs_client_spec.rb",
+     "spec/google_feature_spec.rb",
+     "spec/google_feature_store_spec.rb",
+     "spec/google_resource_spec.rb",
+     "spec/integration_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/temp_file_system.rb",
+     "spec/temp_file_system_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/difference.rb

@@ -0,0 +1,31 @@
+class Difference
+  attr_reader :local, :remote
+  
+  def initialize(local, remote, local_store)
+    @local, @remote, @local_store = local, remote, local_store
+  end
+  
+  def local_only?
+    !@local.nil? && @remote.nil?
+  end
+  
+  def remote_only?
+    @local.nil? && !@remote.nil?
+  end
+  
+  def change_description
+    local_only? ? 'deleted' : remote_only? ? 'created' : 'updated'
+  end
+  
+  def patch
+    if remote_only?
+      @local_store.create_feature(@remote.path, @remote.version, @remote.reformat)
+    elsif !local_only?
+      @local.patch_from(@remote)
+    end
+  end
+  
+  def path
+    (@local || @remote).path
+  end
+end

data/lib/feature.rb

@@ -0,0 +1,26 @@
+class Feature
+  def reformat
+    indent(body).join("\n")
+  end
+  
+  def indent(lines)
+    result = []
+    tabs = ""
+    lines.map do |line|
+      if line =~ /^feature\:/i
+        result << line + "\n"
+        tabs = "  "
+      elsif line =~ /^scenario\:/i
+        result << "\n    " + line + "\n"
+        tabs = "      "
+      else
+        result << tabs + line
+      end
+    end
+    result
+  end
+  
+  def body
+    []
+  end
+end

data/lib/feature_diff.rb

@@ -0,0 +1,46 @@
+require 'difference'
+
+class FeatureDiff
+  attr_reader :differences
+  
+  def initialize(local_store, remote_store)
+    @local_store, @remote_store = local_store, remote_store
+    @differences = {}    
+    remote_features = Hash[*remote_store.features.map { | f | [f.path, f] }.flatten]
+    local_features = Hash[*local_store.features.map { | f | [f.path, f] }.flatten]
+    add_differences(local_features, remote_features)
+  end
+
+  def [](path)
+    @differences[path]
+  end
+
+  def patch(indices=nil)
+    @differences.values.each_with_index do | difference, index |
+      if indices.nil? || indices.include?(index + 1)
+        difference.patch
+      end
+    end
+  end
+  
+  private
+  
+  def add(local, remote)
+    @differences[(local || remote).path] = Difference.new(local, remote, @local_store)
+  end
+  
+  def add_differences(local_features, remote_features)
+    remote_features.each do | path, remote |
+      local = local_features[path]
+      if local
+        add(local, remote) unless local.version == remote.version
+      else
+        add(nil, remote)
+      end
+      local_features.delete(path)
+    end
+    local_features.each do | path, local |
+      add(local, nil)
+    end
+  end 
+end

data/lib/file_feature.rb

@@ -0,0 +1,37 @@
+require 'feature'
+require 'fileutils'
+
+class FileFeature < Feature
+  attr_reader :path
+  
+  def initialize(dir, path)
+    @dir, @path = dir, path
+    @physical_path = File.join(dir, path)
+  end
+
+  def title
+    File.basename(@path, ".feature")
+  end
+
+  def version
+    match = /#\s*version\s*:\s*(.+)/i.match(lines.first)
+    match && match[1].strip
+  end
+
+  def body
+    version ? lines[1..-1] : lines
+  end
+
+  def lines
+    File.readlines(@physical_path).map { |line| line.strip }.reject { |l| l == "" }
+  end
+  
+  def write(contents, version)
+    FileUtils.mkdir_p(File.dirname(@physical_path))
+    File.open(@physical_path, 'w') { |f| f.write("#version: #{version}\n#{contents}") }
+  end
+  
+  def patch_from(other)
+    write(other.reformat, other.version)
+  end
+end

data/lib/file_feature_store.rb

@@ -0,0 +1,17 @@
+require 'file_feature'
+
+class FileFeatureStore
+  def initialize(directory)
+    @directory = directory
+  end
+
+  def features
+    Dir.glob("#{@directory}/**/*.feature").map do | path |
+      FileFeature.new(@directory, path[(@directory.length+1)..-1])
+    end
+  end
+  
+  def create_feature(path, version, contents)
+    FileFeature.new(@directory, path).write(contents, version)
+  end
+end

data/lib/google_authorization.rb

@@ -0,0 +1,18 @@
+require 'rest_client'
+
+class GoogleAuthorization
+
+  def initialize(email, password)
+    @email, @password = email, password
+  end
+
+  def header
+    @header ||= "GoogleLogin auth=#{authorize}"
+  end
+
+  def authorize
+    params = { "accountType" => "HOSTED_OR_GOOGLE", "Email" => @email, "Passwd" => @password, "service" => "writely" }
+    result = RestClient.post "https://www.google.com/accounts/ClientLogin", params
+    result.to_s[/Auth=(.*)/, 1]
+  end
+end

data/lib/google_docs_client.rb

@@ -0,0 +1,20 @@
+require 'google_authorization'
+require 'google_resource'
+
+class GoogleDocsClient
+  def initialize(email, password)
+    @auth = GoogleAuthorization.new(email, password)
+  end
+
+  def documents_feed
+    GoogleResource.new(@auth, "http://docs.google.com/feeds/documents/private/full", :accept => "application/atom+xml")
+  end
+
+  def document_body(uri)
+    GoogleResource.new(@auth, uri, :accept => "text/html")
+  end
+
+  def folders
+    GoogleResource.new(@auth, "http://docs.google.com/feeds/documents/private/full/-/folder?showfolders=true", :accept => "application/atom+xml")
+  end
+end

data/lib/google_feature.rb

@@ -0,0 +1,51 @@
+require 'feature'
+require 'nokogiri'
+
+class GoogleFeature < Feature
+
+  def initialize(client, entry, folder)
+    @client, @entry, @folder = client, entry, folder
+  end
+
+  def title
+    underscore(camelize(@entry.css("title")[0].text))
+  end
+
+  def version
+    @version ||= @entry.css("updated")[0].text
+  end
+
+  def body
+    @body ||= remove_html(download_body).map {|line| line.strip}.reject { |l| l == "" }
+  end
+
+  def body_url
+    @entry.css("content").first.attributes["src"].value.gsub("justBody=false", "justBody=true")
+  end
+
+  def path
+    "#{@folder}/#{title}.feature"
+  end
+
+  def download_body
+    @client.document_body(body_url).get.to_s
+  end
+
+  def remove_html(html_body)
+    text = Nokogiri::HTML(html_body).at('body').inner_html
+    text.gsub("&nbsp;", " ").gsub("<br>", "\n").gsub("\n\n", "\n").gsub(/<\/?[^>]*>/, "")
+  end
+
+  def underscore(camel_cased_word)
+    camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+
+  def camelize(lower_case_and_underscored_word)
+    lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+
+end

data/lib/google_feature_store.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+require 'google_feature'
+
+class GoogleFeatureStore
+  PARENT_FOLDER_REL = "http://schemas.google.com/docs/2007#parent"
+  
+  def initialize(client)
+    @client = client
+  end
+
+  def features
+    feed = @client.documents_feed.get.to_s
+    folder_map = folders
+    Nokogiri::HTML(feed).css("entry").map do | entry |
+      parent_links = entry.xpath("link[@rel='#{PARENT_FOLDER_REL}']/@href")
+      href = parent_links.first.text.to_s
+      folder = folder_map[href]
+      GoogleFeature.new(@client, entry, folder)
+    end
+  end
+
+  def folders
+    feed = @client.folders.get.to_s
+    doc = Nokogiri::HTML(feed)
+    map = {}
+    doc.css("entry").each do | entry |
+      map[entry.css("id").text] = folder_path(doc, entry)
+    end
+    map
+  end
+
+  def folder_path(doc, entry)
+    title = entry.css("title").text
+    parent = parent_folder_entry(doc, entry)
+    ((parent ? folder_path(doc, parent) : '') + '/' + title).gsub(/^\//, '')
+  end
+
+  def parent_folder_entry(doc, entry)
+    parent_link = entry.css("link[rel='#{PARENT_FOLDER_REL}']").first
+    return nil if parent_link.nil?
+    doc.xpath("//entry[id='#{parent_link.attributes['href']}']").first
+  end
+end
+

data/lib/google_resource.rb

@@ -0,0 +1,11 @@
+require 'rest_client'
+
+class GoogleResource
+  def initialize(auth, url, headers={})
+    @auth, @url, @headers = auth, url, headers
+  end
+
+  def get(additional_headers={})
+    RestClient.get @url, @headers.merge(additional_headers).merge("Authorization" => @auth.header)
+  end
+end

data/lib/remote_features/cli/main.rb

@@ -0,0 +1,30 @@
+require 'file_feature_store'
+require 'google_feature_store'
+require 'google_docs_client'
+require 'remote_features/dialogue'
+
+module RemoteFeatures
+  module Cli
+    class Main
+      def self.execute(args)
+        new(args, $stdin, $stdout).execute
+      end
+      
+      def initialize(args, input, output)
+        if args.length != 2 || args[1] !~ /^(.+)\:(.+)@(.+)$/
+          output.puts "Usage: remotefeatures <directory> <user:password@host>"
+          Kernel.exit
+          return 
+        end
+        @local_store = FileFeatureStore.new(args[0])
+        m = /^(.+)\:(.+)@(.+)$/.match(args[1])
+        @remote_store = GoogleFeatureStore.new(GoogleDocsClient.new(m[1], m[2]))
+        @input, @output = input, output
+      end
+      
+      def execute
+        RemoteFeatures::Dialogue.new(@input, @output, @local_store, @remote_store).start
+      end
+    end
+  end
+end

data/lib/remote_features/dialogue.rb

@@ -0,0 +1,25 @@
+require 'feature_diff'
+
+module RemoteFeatures
+  class Dialogue
+    def initialize(input, output, local_store, remote_store)
+      @input, @output, @local_store, @remote_store = input, output, local_store, remote_store
+    end
+    
+    def start
+      diff = FeatureDiff.new(@local_store, @remote_store)
+      differences = diff.differences
+      if differences.empty?
+        @output.puts "No changes. Local store is up-to-date."
+        Kernel.exit
+      end
+      i = 0
+      lines = diff.differences.values.map do |d|
+        "#{(i += 1)}) #{d.change_description} - #{d.path}"
+      end
+      @output.puts lines.join("\n")
+      @output.puts "Enter changes to apply, 'all' to apply all, or blank to exit"
+      diff.patch(@input.gets.strip.split(/\s+/).map { |e| e.to_i })
+    end
+  end
+end