mingle_events 0.1.3 → 0.1.4

data/lib/mingle_events/xml.rb

@@ -0,0 +1,101 @@
+module MingleEvents
+  module Xml
+
+    class Element
+      attr_reader :node, :namespaces
+      def initialize(node, namespaces)
+        @node = node
+        @namespaces = namespaces
+      end
+
+      def nil?
+        @node.nil?
+      end
+
+      ["inner_text", "optional_inner_text", "select", "select_all", "attr", "children", "tag_name", "raw_xml", "attributes", "to_hash"].each do |method|
+        self.class_eval(%{def #{method}(*args, &block)  Xml.#{method}(self, *args); end})
+      end
+
+      alias :[] :attr
+    end
+
+
+    module_function
+
+    def parse(str, namespaces={})
+      Element.new(Nokogiri::XML(str), namespaces)
+    end
+
+    def inner_text(element, xpath=nil)
+      return inner_text(select(element, xpath)) if xpath
+      return nil if attr(element, "nil") && attr(element, "nil") == "true"
+      element.node.inner_text
+    end
+
+    def optional_inner_text(parent_element, xpath)
+      element = select(parent_element, xpath)
+      element.node.nil? ? nil : element.inner_text
+    end
+
+    def select(element, xpath)
+      Element.new(element.node.at(xpath, element.namespaces), element.namespaces)
+    end
+
+    def select_all(element, xpath)
+      element.node.search(xpath, element.namespaces).map { |n| Element.new(n, element.namespaces) }
+    end
+
+    def attr(element, attr_name)
+      raise 'element selection is empty!' if element.nil?
+      element.node[attr_name]
+    end
+
+    def children(element)
+      element.node.children.select { |e| e.is_a?(Nokogiri::XML::Element) }.map { |n| Element.new(n, element.namespaces) }
+    end
+
+    def tag_name(element)
+      element.node.name
+    end
+
+    def raw_xml(element)
+      patching_namespaces(element.node).to_s
+    end
+
+    def attributes(element)
+      element.node.attribute_nodes.inject({}) do |memo, a|
+        memo[a.name] = a.value
+        memo
+      end
+    end
+
+    def to_hash(element, hash={})
+      hash_for_element = (hash[tag_name(element).to_sym] ||= {})
+
+      attributes(element).each do |name, value|
+        hash_for_element[name.to_sym] = value
+      end
+
+      children(element).each do |child|
+        if children(child).any?
+          to_hash(child, hash_for_element)
+        else
+          hash_for_element[tag_name(child).to_sym] = inner_text(child)
+        end
+      end
+
+      hash
+    end
+
+    def patching_namespaces(node)
+      ns_scopes = node.namespace_scopes
+      return node if ns_scopes.empty?
+
+      result = node.clone
+      ns_scopes.each do |ns|
+        result.add_namespace_definition(ns.prefix, ns.href)
+      end
+      result
+    end
+  end
+end

data/lib/mingle_events/zip_directory.rb

@@ -0,0 +1,98 @@
+module MingleEvents
+  class ZipDirectory
+    
+    def initialize(name)
+      FileUtils.mkdir_p(File.dirname(name))
+      @root = name
+      @entry_map = nil
+      @readio = nil
+    end
+
+    def write_file(path, &block)
+      measure('write_file') do
+        exists = File.exists?(@root) && File.lstat(@root).size > 1024
+        writeio = File.open(@root, exists ? 'r+b' : 'wb')
+        # for a existing tar, seek to -1024 from end to skip 1024 '\0' in tar format
+        writeio.seek(-1024, IO::SEEK_END) if exists
+
+        Archive::Tar::Minitar::Output.open(writeio) do |output|
+          stat = {:mode => 0100644, :mtime => Time.now}
+          output.tar.add_file(path, stat) { |io, opts| yield(io) }
+        end
+      end
+    end
+
+    def file(path, &block)
+      measure("read file") do
+        raise "File at '#{path}' in archive '#{@root}' dose not exisits" unless exists?(path)
+        entry_map[path].open { |entry_stream| yield(entry_stream) }
+      end
+    end
+
+    def exists?(path)
+      return unless File.exists?(@root)
+      entry_map.include?(path)
+    end
+
+    def delete
+      close
+      FileUtils.rm_rf(@root)
+    end
+
+    def close
+      @readio.close if @readio
+      @readio = nil
+      @entry_map = nil
+    end
+
+    alias :reload :close
+
+    private
+
+    class ReusableEntryStream < Archive::Tar::Minitar::Reader::EntryStream
+      def open(&block)
+        rewind
+        yield(self)
+      end
+
+      def close
+        # do nothing
+      end
+
+      def external_encoding
+        "UTF-8"
+      end
+    end
+
+    def entry_map
+      return @entry_map if @entry_map
+      
+      @entry_map = {}
+      measure("entries archive loading") do
+        @readio = File.open(@root, 'rb')
+        loop do
+          break if @readio.eof?
+        
+          header = Archive::Tar::PosixHeader.new_from_stream(@readio)
+          break if header.empty?
+          
+          entry = ReusableEntryStream.new(header, @readio)
+          size  = entry.size
+          @entry_map[entry.name] = entry
+
+          skip = (512 - (size % 512)) % 512
+          @readio.seek(size - entry.bytes_read, IO::SEEK_CUR)
+          @readio.read(skip) # discard trailing zeros
+        end
+        @readio.rewind
+      end
+      @entry_map
+    end
+
+    def measure(label=nil, &block)
+      return yield unless ENV['MINGLE_EVENTS_VERBOSE']
+      start = Time.now
+      yield.tap { puts "ZipDirectory##{label}: using #{Time.now - start}s"}
+    end
+  end
+end

data/test/mingle_events/entry_cache_test.rb

@@ -0,0 +1,75 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+module MingleEvents
+  class EntryCacheTest < Test::Unit::TestCase
+    
+    def setup
+      @entry_cache = EntryCache.new("/tmp/foo")
+      @entry_cache.clear
+    end
+    
+    def test_stores_first_entry_under_root
+      fetched_entry = entry(1)
+      @entry_cache.write(fetched_entry, nil)
+      @entry_cache.update_current_state(fetched_entry, fetched_entry)
+      assert_equal [entry(1)], @entry_cache.all_entries.to_a
+      assert_equal entry(1), @entry_cache.first
+      assert_equal entry(1), @entry_cache.latest
+    end
+
+    def test_store_multiple_entries
+      @entry_cache.write(entry(3), nil)
+      @entry_cache.write(entry(2), entry(3))
+      @entry_cache.write(entry(1), entry(2))
+      @entry_cache.update_current_state(entry(1), entry(3))
+      assert_equal [entry(1), entry(2), entry(3)], @entry_cache.all_entries.to_a
+    end
+
+    def test_store_multiple_entries_multiple_times
+      @entry_cache.write(entry(3), nil)
+      @entry_cache.write(entry(2), entry(3))
+      @entry_cache.write(entry(1), entry(2))
+      @entry_cache.update_current_state(entry(1), entry(3))
+
+      @entry_cache.write(entry(6), nil)
+      @entry_cache.write(entry(5), entry(6))
+      @entry_cache.write(entry(4), entry(5))
+      @entry_cache.write(entry(3), entry(4))
+      @entry_cache.update_current_state(entry(3), entry(6))
+
+      assert_equal((1..6).map { |id| entry(id) }, @entry_cache.all_entries.to_a)
+    end
+
+    def test_entries_returned_can_be_lazily_evaluated
+      @entry_cache.write(entry(3), nil)
+      @entry_cache.write(entry(2), entry(3))
+      @entry_cache.write(entry(1), entry(2))
+      @entry_cache.update_current_state(entry(1), entry(3))
+      enumerator = @entry_cache.all_entries.each
+      assert_equal entry(1), enumerator.next()
+      assert_equal entry(2), enumerator.next()
+      assert_equal entry(3), enumerator.next()
+      assert_raise(StopIteration) { enumerator.next() }
+    end
+    
+    private
+    
+    def entry(id)
+      element_xml_text = %{
+        <entry xmlns="http://www.w3.org/2005/Atom">
+          <id>https://mingle.example.com/projects/mingle/events/index/#{id}</id>
+          <title>Page Special:HeaderActions changed</title>
+          <updated>2011-02-03T08:12:42Z</updated>
+          <author>
+            <name>Sammy Soso</name>
+            <email>sammy@example.com</email>
+            <uri>https://mingle.example.com/api/v2/users/233.xml</uri>
+          </author>
+        </entry>
+      }
+      Feed::Entry.from_snippet(element_xml_text)
+    end
+    
+    
+  end
+end

data/test/mingle_events/feed/author_test.rb

@@ -7,7 +7,7 @@ module MingleEvents
   
       def test_parse_attributes
         author_xml = %{
-          <author >
+          <author xmlns="http://www.w3.org/2005/Atom" xmlns:mingle="http://www.thoughtworks-studios.com/ns/mingle">
             <name>Sammy Soso</name>
             <email>sammy@example.com</email>
             <uri>https://mingle.example.com/api/v2/users/233.xml</uri>
@@ -23,7 +23,7 @@ module MingleEvents
     
       def test_parse_attributes_when_no_optional_fields
         author_xml = %{
-          <author>
+          <author xmlns="http://www.w3.org/2005/Atom" xmlns:mingle="http://www.thoughtworks-studios.com/ns/mingle">
             <name>Sammy Soso</name>
           </author>
         }

data/test/mingle_events/feed/changes_test.rb

@@ -7,9 +7,9 @@ module MingleEvents
       
       def test_parse_multiple_changes
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="card-creation"/>
                 <change type="card-type-change">
                   <old_value nil="true"></old_value>
@@ -41,13 +41,13 @@ module MingleEvents
             
       def test_parse_name_change_from_nil
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="name-change">
                   <old_value nil="true" />
                   <new_value>Basic email integration</new_value>
-                </change
+                </change>
               </changes>
             </content>
           </entry>}
@@ -62,9 +62,9 @@ module MingleEvents
       
       def test_parse_name_change
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="name-change">
                   <old_value>Work with email</old_value>
                   <new_value>Basic email integration</new_value>
@@ -83,9 +83,9 @@ module MingleEvents
       
       def test_parse_type_info_when_no_custom_builder_specified
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="card-creation"/>
               </changes>
             </content>
@@ -98,9 +98,9 @@ module MingleEvents
       
       def test_parse_card_type_change_from_nil
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="card-type-change">
                   <old_value nil="true"></old_value>
                   <new_value>
@@ -125,13 +125,13 @@ module MingleEvents
       
       def test_parse_card_type_change
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="card-type-change">
                   <old_value>
                     <card_type url="https://mingle.example.com/api/v2/projects/atlas/card_types/30.xml">
-                      <name>Story</name
+                      <name>Story</name>
                     </card_type>
                   </old_value>
                   <new_value>
@@ -156,9 +156,9 @@ module MingleEvents
       
       def test_parse_card_type_change_to_deleted_type
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="card-type-change">
                   <old_value>
                     <card_type url="https://mingle.example.com/api/v2/projects/atlas/card_types/30.xml">
@@ -187,9 +187,9 @@ module MingleEvents
       
       def test_parse_card_property_change
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="property-change">
                   <property_definition 
                       url="http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml">
@@ -220,9 +220,9 @@ module MingleEvents
       
       def test_parse_card_property_change_from_nil
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="property-change">
                   <property_definition 
                       url="http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml">
@@ -246,9 +246,9 @@ module MingleEvents
       
       def test_parse_card_property_change_to_nil
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <content type="application/vnd.mingle+xml">
-              <changes>
+              <changes xmlns="http://www.thoughtworks-studios.com/ns/mingle">
                 <change type="property-change">
                   <property_definition 
                       url="http://mingle.example.com/api/v2/projects/atlas/property_definitions/10418.xml">

data/test/mingle_events/feed/entry_test.rb

@@ -7,7 +7,7 @@ module MingleEvents
   
       def test_parse_basic_attributes
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom" >
             <id>https://mingle.example.com/projects/mingle/events/index/234443</id>
             <title>Page Special:HeaderActions changed</title>
             <updated>2011-02-03T08:12:42Z</updated>
@@ -22,13 +22,13 @@ module MingleEvents
         # assert_equal(element_xml_text.inspect, entry.raw_xml.inspect) 
         assert_equal("https://mingle.example.com/projects/mingle/events/index/234443", entry.entry_id)
         assert_equal("Page Special:HeaderActions changed", entry.title)
-        assert_equal("Thu Feb 03 08:12:42 UTC 2011", entry.updated.to_s)
+        assert_equal(Time.utc(2011, 2, 3, 8, 12, 42), entry.updated)
         assert_equal("Sammy Soso", entry.author.name)
       end
     
       def test_parse_categories
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <category term="foo" scheme='http://tws.com/ns#mingle' />
             <category term="bar" scheme="http://tws.com/ns#go" />
           </entry>}
@@ -45,7 +45,7 @@ module MingleEvents
         # that the card number is derived from a single, precise position
       
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <category term="card" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
             <link href="https://mingle.example.com/projects/atlas/cards/102" rel="http://www.thoughtworks-studios.com/ns/mingle#event-source" type="text/html" title="bug #103"/>
             <link href="https://mingle.example.com/api/v2/projects/atlas/cards/104.xml?version=7" rel="http://www.thoughtworks-studios.com/ns/mingle#version" type="application/vnd.mingle+xml" title="bug #105 (v7)"/>
@@ -59,7 +59,7 @@ module MingleEvents
     
       def test_card_number_and_version_throws_error_when_event_not_related_to_a_card      
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <category term="page" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
@@ -86,7 +86,7 @@ module MingleEvents
         # that the card number is derived from a single, precise position
       
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <category term="card" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
             <link href="https://mingle.example.com/projects/atlas/cards/102" rel="http://www.thoughtworks-studios.com/ns/mingle#event-source" type="text/html" title="bug #103"/>
             <link href="https://mingle.example.com/api/v2/projects/atlas/cards/104.xml?version=7" rel="http://www.thoughtworks-studios.com/ns/mingle#version" type="application/vnd.mingle+xml" title="bug #105 (v7)"/>
@@ -99,7 +99,7 @@ module MingleEvents
     
       def test_card_version_resource_uri_throws_error_when_not_card_event
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <category term="page" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
@@ -113,7 +113,7 @@ module MingleEvents
     
       def test_entry_id_aliased_as_event_id
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <id>https://mingle.example.com/projects/mingle/events/index/234443</id>
           </entry>}
         entry = Entry.from_snippet(element_xml_text)
@@ -123,21 +123,21 @@ module MingleEvents
       
       def test_entry_id_determines_equality
         element_xml_text_1 = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <id>https://mingle.example.com/projects/mingle/events/index/234443</id>
             <category term="page" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
           </entry>}
         entry_1 = Entry.from_snippet(element_xml_text_1)
         
         element_xml_text_2 = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <id>https://mingle.example.com/projects/mingle/events/index/234443</id>
             <category term="card" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
           </entry>}
         entry_2 = Entry.from_snippet(element_xml_text_2)
         
         element_xml_text_3 = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <id>https://mingle.example.com/projects/mingle/events/index/234</id>
             <category term="card" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
           </entry>}
@@ -151,7 +151,7 @@ module MingleEvents
       
       def test_construct_links
         element_xml_text = %{
-          <entry>
+          <entry xmlns="http://www.w3.org/2005/Atom">
             <category term="card" scheme="http://www.thoughtworks-studios.com/ns/mingle#categories"/>
             <link href="https://mingle.example.com/projects/atlas/cards/102" rel="http://www.thoughtworks-studios.com/ns/mingle#event-source" type="text/html" title="bug #103"/>
             <link href="https://mingle.example.com/api/v2/projects/atlas/cards/104.xml?version=7" rel="http://www.thoughtworks-studios.com/ns/mingle#version" type="application/vnd.mingle+xml" title="bug #105 (v7)"/>