piggy 0.0.6 → 0.1.0

data/README.md

@@ -0,0 +1,4 @@
+
+## TODO
+* Autotest hook
+* Kermit hook

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

data/features/{git_hook.feature → bundled_hooks/git_hook.feature}

@@ -10,16 +10,16 @@ Feature: Use git hooks
 Successfully installed git hook.
 Piggy is now monitoring the git commits made in this project.
 """
-    And the file ".git/hooks/post-commit" should contain "Piggy"
+    And the file ".git/hooks/post-commit" should contain "piggy"
     And the file ".git/hooks/post-commit" should be executable
-    
-  # @wip
-  # Scenario: A git commit should trigger a Piggy event
-  #   Given the git hook is installed
-  #   And   an empty file named "foo.txt"
-  #   When  I run "git add foo.txt"
-  #   And   I run "git commit -m 'First commit'"
-  #   Then  an event should be triggered with title "First commit"
+  
+  Scenario: A git commit should publish a Piggy event
+    Given the git hook is installed
+    And   an empty file named "foo.txt"
+    When  I run "git add foo.txt"
+    And   I run "git commit -m 'First commit'"
+    And   I run "piggy history"
+    Then  the output should contain exactly "First commit\n"
   
   
   

data/features/event_and_history.feature

@@ -0,0 +1,19 @@
+Feature: Event and History
+  In order to test publishers
+  As a Piggy developer
+  I want to publish events, and discover events that Piggy has reported
+
+  Scenario: No history initially
+    When I run "piggy history"
+    Then the output should be empty
+  
+  Scenario: A published event is shown in the history
+    When I run "piggy event 'Hello world!'"
+    And  I run "piggy history"
+    Then the output should contain exactly "Hello world!\n"
+    
+  Scenario: Events are ordered most recent first in the history
+    When I run "piggy event first"
+    When I run "piggy event second"
+    And  I run "piggy history"
+    Then the output should contain exactly "second\nfirst\n"  

data/features/{get_help.feature → help.feature}

@@ -1,4 +1,4 @@
-Feature: Get help
+Feature: Help
   In order to find out how to use Piggy
   As a programmer
   I want to view help

data/features/step_definitions/git_steps.rb

@@ -1,4 +1,5 @@
 Given /^the git hook is installed$/ do
-  When "I run \"git init\""
+  When "I run \"rake install\""
+  And  "I run \"git init\""
   And  "I run \"piggy install\"" 
 end

data/features/step_definitions/output_steps.rb

@@ -0,0 +1,3 @@
+Then /^the output should be empty$/ do
+  Then "the output should contain exactly \"\""
+end

data/features/step_definitions/subscriber_steps.rb

@@ -0,0 +1,8 @@
+Given /^a subscriber at "([^"]*)" that writes to "([^"]*)"$/ do |sub_path, out_path|
+  Given "an executable file named \"#{sub_path}\" with:", subscriber(out_path)
+end
+
+def subscriber(out_path)
+  "#!/usr/bin/env ruby\n" + 
+  "File.open('#{out_path}', 'w') {|f| f.write(ARGV.first) }"
+end

data/features/subscription.feature

@@ -11,13 +11,18 @@ Piggy is now sending events to 'writer.rb'.
 """
 
   Scenario: Receive events from Piggy
-    Given an executable file named "writer.rb" with:
-"""
-#!/usr/bin/env ruby
+    Given a subscriber at "sub.rb" that writes to "output.txt"
+    And  I run "piggy subscribe sub.rb" 
+    And  I run "piggy event 'Hello world!'"
+    Then the output should be empty
+    And  the file "output.txt" should contain "Hello world!"   
 
-File.open('output.txt', 'w') {|f| f.write(ARGV.first) }
-"""
-    And  I run "piggy subscribe writer.rb" 
-    And  an event is triggered with title "Hello world!"
-    Then the file "output.txt" should contain "Hello world!"
-  
+  Scenario: All subscribers should receive the same event
+    Given a subscriber at "sub1.rb" that writes to "one.txt"
+    And   a subscriber at "sub2.rb" that writes to "two.txt"
+    And  I run "piggy subscribe sub1.rb" 
+    And  I run "piggy subscribe sub2.rb" 
+    And  I run "piggy event 'Hello world!'"
+    Then the output should be empty
+    And  the file "one.txt" should contain "Hello world!" 
+    And  the file "two.txt" should contain "Hello world!" 

data/lib/piggy/cli.rb

@@ -1,6 +1,8 @@
 require 'thor'
 
 require 'piggy/version'
+require 'piggy/event'
+require 'piggy/subscribers'
 
 module Piggy
   class CLI < Thor
@@ -26,8 +28,18 @@ module Piggy
     
     desc "subscribe PROGRAM", "Add a program that will receive Piggy events"
     def subscribe(subscriber)
-      create_file ".piggy/subscribers", subscriber
+      Subscribers.add subscriber
       puts "Piggy is now sending events to '#{subscriber}'."
     end
+    
+    desc "event", "Publish an event"
+    def event(title)
+      Event.create title
+    end
+    
+    desc "history", "List all published events"
+    def history
+      puts Event.all if Event.any?
+    end
   end
 end

data/lib/piggy/event.rb

@@ -1,5 +1,8 @@
 require 'active_model'
 
+require 'piggy/subscribers'
+require 'piggy/file_store'
+
 module Piggy
   class Event
     include ActiveModel::Serializers::Xml
@@ -7,12 +10,32 @@ module Piggy
     
     attr_accessor :title
     
-    def initialize(title)
-      @title = title
+    def self.create(title)
+      event = Event.new(title)
+      store.save(title)
+      Subscribers.notify(event)
+      event
+    end
+    
+    def self.all
+      store.all.reverse.join("\n")
+    end
+    
+    def self.any?
+      store.any?
     end
     
     def attributes
       @attributes ||= {'title' => 'nil'}
     end
+    
+    private
+      def initialize(title)
+        @title = title
+      end
+      
+      def self.store
+        Piggy::FileStore.new('events')
+      end
   end
 end

data/lib/piggy/file_store.rb

@@ -0,0 +1,41 @@
+module Piggy
+  class FileStore
+    def initialize(store)
+      @store = store
+    end
+    
+    def clear
+      delete_store if store_exists?
+    end
+    
+    def save(text)
+      create_store unless store_exists?
+      File.open(store, 'a') {|f| f.write(text + "\n") }
+    end
+    
+    def all
+      any? ? IO.readlines(store).map(&:chomp) : [] 
+    end
+    
+    def any?
+      store_exists?
+    end
+    
+    private
+      def store
+        ".piggy/#{@store}"
+      end
+      
+      def create_store
+        Dir.mkdir('.piggy') unless Dir.exists?('.piggy')
+      end
+    
+      def delete_store
+        File.delete(store)
+      end
+      
+      def store_exists?
+        File.exists? store
+      end
+  end
+end

data/lib/piggy/subscribers.rb

@@ -0,0 +1,20 @@
+require 'piggy/file_store'
+
+module Piggy
+  class Subscribers
+    def self.notify(event)
+      store.all.each do |subscriber|
+        `./#{subscriber} "#{event.title}"`
+      end
+    end
+    
+    def self.add(subscriber)
+      store.save(subscriber)
+    end
+    
+    private
+      def self.store
+        FileStore.new('subscribers')
+      end
+  end
+end

data/piggy.gemspec

@@ -5,39 +5,43 @@
 
 Gem::Specification.new do |s|
   s.name = %q{piggy}
-  s.version = "0.0.6"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Louis Rose"]
-  s.date = %q{2010-09-07}
+  s.date = %q{2010-09-09}
   s.default_executable = %q{piggy}
   s.description = %q{Record and analyse coding sessions}
   s.email = %q{louismrose@gmail.com}
   s.executables = ["piggy"]
   s.extra_rdoc_files = [
-    "README"
+    "README.md"
   ]
   s.files = [
     ".gitignore",
     "Gemfile",
     "Gemfile.lock",
-    "README",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/piggy",
-    "features/get_help.feature",
-    "features/git_hook.feature",
-    "features/step_definitions/event_steps.rb",
+    "features/bundled_hooks/git_hook.feature",
+    "features/event_and_history.feature",
+    "features/help.feature",
     "features/step_definitions/file_system_steps.rb",
     "features/step_definitions/git_steps.rb",
+    "features/step_definitions/output_steps.rb",
+    "features/step_definitions/subscriber_steps.rb",
     "features/subscription.feature",
     "features/support/env.rb",
     "lib/piggy/cli.rb",
     "lib/piggy/event.rb",
-    "lib/piggy/events.rb",
+    "lib/piggy/file_store.rb",
+    "lib/piggy/subscribers.rb",
     "lib/piggy/version.rb",
     "piggy.gemspec",
-    "spec/event.spec.rb",
+    "spec/piggy/event.spec.rb",
+    "spec/piggy/file_store.spec.rb",
     "spec/spec_helper.rb",
     "templates/git_hook"
   ]
@@ -46,7 +50,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Record and analyse coding sessions}
   s.test_files = [
-    "spec/event.spec.rb",
+    "spec/piggy/event.spec.rb",
+    "spec/piggy/file_store.spec.rb",
     "spec/spec_helper.rb"
   ]
 

data/spec/piggy/file_store.spec.rb

@@ -0,0 +1,52 @@
+require 'piggy/file_store'
+
+describe "file-based persistency" do
+  def store
+    Piggy::FileStore.new('.test')
+  end
+  
+  after(:all) do 
+    store.clear
+  end
+  
+  context "when empty" do
+    it "should not have any entries" do
+      store.any?.should be_false
+    end
+    
+    it "should return 0 entries when asked for all" do
+      store.all.should be_empty
+    end
+  end
+  
+  context "after saving one entry" do
+    before(:all) do
+      store.clear
+      store.save('foo')
+    end
+    
+    it "should have some entries" do
+      store.any?.should be_true
+    end
+    
+    it "should return a singleton as the list of all entries" do
+      store.all.should == %w{foo}
+    end
+  end
+  
+  context "after saving two entries" do
+    before(:all) do
+      store.clear
+      store.save('foo')
+      store.save('bar')
+    end
+    
+    it "should have some entries" do
+      store.any?.should be_true
+    end
+    
+    it "should return the list of all entries" do
+      store.all.should == %w{foo bar}
+    end
+  end
+end

data/templates/git_hook

@@ -1 +1,2 @@
-Piggy
+#!/bin/sh
+piggy event "`git log -n 1 --pretty=format:%s`"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Louis Rose
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-07 00:00:00 +01:00
+date: 2010-09-09 00:00:00 +01:00
 default_executable: piggy
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -109,28 +109,32 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
 - Rakefile
 - VERSION
 - bin/piggy
-- features/get_help.feature
-- features/git_hook.feature
-- features/step_definitions/event_steps.rb
+- features/bundled_hooks/git_hook.feature
+- features/event_and_history.feature
+- features/help.feature
 - features/step_definitions/file_system_steps.rb
 - features/step_definitions/git_steps.rb
+- features/step_definitions/output_steps.rb
+- features/step_definitions/subscriber_steps.rb
 - features/subscription.feature
 - features/support/env.rb
 - lib/piggy/cli.rb
 - lib/piggy/event.rb
-- lib/piggy/events.rb
+- lib/piggy/file_store.rb
+- lib/piggy/subscribers.rb
 - lib/piggy/version.rb
 - piggy.gemspec
-- spec/event.spec.rb
+- spec/piggy/event.spec.rb
+- spec/piggy/file_store.spec.rb
 - spec/spec_helper.rb
 - templates/git_hook
 has_rdoc: true
@@ -166,5 +170,6 @@ signing_key:
 specification_version: 3
 summary: Record and analyse coding sessions
 test_files: 
-- spec/event.spec.rb
+- spec/piggy/event.spec.rb
+- spec/piggy/file_store.spec.rb
 - spec/spec_helper.rb

data/features/step_definitions/event_steps.rb

@@ -1,9 +0,0 @@
-require 'piggy/events'
-
-When /^an event is triggered with title "([^"]*)"$/ do |title|
-  Piggy::Events.trigger title
-end
-
-Then /^an event should be triggered with title "([^"]*)"$/ do |title|
-  Piggy::Events.last.title.should == title
-end

data/lib/piggy/events.rb

@@ -1,11 +0,0 @@
-require 'piggy/event'
-
-module Piggy
-  class Events
-    def self.trigger(title)
-      xml = Event.new(title).to_xml
-      subscriber = IO.readlines("tmp/aruba/.piggy/subscribers").first
-      `cd tmp/aruba; ./#{subscriber} "#{xml}"`
-    end
-  end
-end