flockdb 0.3.2 → 0.4.0

data/README.md

@@ -47,9 +47,10 @@ The client supports a rich query api to build up complex set operations:
 CONTRIBUTORS
 ------------
 
-Nick Kallen  
-Matt Freels  
-Rael Dornfest  
+Nick Kallen
+Matt Freels
+Rael Dornfest
+Tina Huang
 
 
 LICENSE

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/flockdb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{flockdb}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Freels", "Rael Dornfest", "Nick Kallen"]
-  s.date = %q{2010-04-29}
+  s.date = %q{2010-05-11}
   s.description = %q{Get your flock on in Ruby.}
   s.email = %q{freels@twitter.com}
   s.extra_rdoc_files = [
@@ -41,8 +41,11 @@ Gem::Specification.new do |s|
      "lib/flock/thrift/flock_types.rb",
      "lib/flock/thrift/shards.rb",
      "lib/flockdb.rb",
+     "spec/execute_operations_spec.rb",
      "spec/flock_spec.rb",
      "spec/mock_service_spec.rb",
+     "spec/query_term_spec.rb",
+     "spec/simple_operation_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -52,8 +55,11 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby Flock client}
   s.test_files = [
-    "spec/flock_spec.rb",
+    "spec/execute_operations_spec.rb",
+     "spec/flock_spec.rb",
      "spec/mock_service_spec.rb",
+     "spec/query_term_spec.rb",
+     "spec/simple_operation_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/flock.rb

@@ -30,6 +30,12 @@ module Flock
     end
   end
 
+  class UnknownStateError < FlockException
+    def initialize(state)
+      super("Unable to look up id for state #{state.inspect}. Valid states are #{ Flock::Client::STATES.keys.sort.map{|s| s.inspect }.join(', ') }")
+    end
+  end
+
   class << self
     attr_accessor :default_service_class, :graphs
 

data/lib/flock/client.rb

@@ -1,5 +1,10 @@
 class Flock::Client
 
+  # symbol => state_id map
+  STATES = Flock::Edges::EdgeState::VALUE_MAP.inject({}) do |states, (id, name)|
+    states.update name.downcase.to_sym => id
+  end.freeze
+
   attr_accessor :graphs
   attr_reader :service
 
@@ -49,7 +54,7 @@ class Flock::Client
   end
 
   def contains(*query)
-    query = _query_args(query)
+    query = _query_args(query)[0, 3]
     _cache :contains, query do
       service.contains(*query)
     end
@@ -68,14 +73,17 @@ class Flock::Client
   def update(method, source_id, graph, destination_id, priority = Flock::Priority::High)
     _cache_clear
     ops = current_transaction || Flock::ExecuteOperations.new(@service, priority)
-    ops.send(method, *_query_args([source_id, graph, destination_id]))
+    ops.send(method, *_query_args([source_id, graph, destination_id])[0, 3])
     ops.apply unless in_transaction?
   end
 
-  [:add, :remove, :archive, :unarchive].each do |method|
+  Flock::Edges::ExecuteOperationType::VALUE_MAP.values.each do |method|
+    method = method.downcase
     class_eval "def #{method}(*args); update(#{method.inspect}, *args) end", __FILE__, __LINE__
   end
 
+  alias unarchive add
+
   def transaction(priority = Flock::Priority::High, &block)
     new_transaction = !in_transaction?
 
@@ -113,9 +121,19 @@ class Flock::Client
     end
   end
 
+  def _lookup_states(states)
+    states = states.flatten.compact.map do |s|
+      if s.is_a? Integer
+        s
+      else
+        STATES[s] or raise UnknownStateError.new(s)
+      end
+    end
+  end
+
   def _query_args(args)
-    source, graph, destination = *((args.length == 1) ? args.first : args)
-    [_node_arg(source), _lookup_graph(graph), _node_arg(destination)]
+    source, graph, destination, *states = *((args.length == 1) ? args.first : args)
+    [_node_arg(source), _lookup_graph(graph), _node_arg(destination), _lookup_states(states)]
   end
 
   def _node_arg(node)

data/lib/flock/mock_service.rb

@@ -5,7 +5,8 @@ module Flock
     EXEC_OPS = {
       Edges::ExecuteOperationType::Add => :add,
       Edges::ExecuteOperationType::Remove => :remove,
-      Edges::ExecuteOperationType::Archive => :archive
+      Edges::ExecuteOperationType::Archive => :archive,
+      Edges::ExecuteOperationType::Negate => :negate
     }
 
     attr_accessor :timeout, :fixtures
@@ -51,7 +52,7 @@ module Flock
     end
 
     def contains(source, graph, dest)
-      forward_edges[graph][:normal][source].include?(dest)
+      forward_edges[graph][Edges::EdgeState::Positive][source].include?(dest)
     end
 
     def count(select_operations)
@@ -67,7 +68,8 @@ module Flock
         when Edges::SelectOperationType::SimpleQuery
           term = select_operation.term
           source = term.is_forward ? forward_edges : backward_edges
-          data = source[term.graph_id][:normal][term.source_id]
+          states = term.state_ids || [Edges::EdgeState::Positive]
+          data = source[term.graph_id].inject([]) {|r, (s, e)| states.include?(s) ? r.concat(e[term.source_id]) : r }.uniq
           stack.push(term.destination_ids ? (term.destination_ids.unpack('Q*') & data) : data)
         when Edges::SelectOperationType::Intersection
           stack.push(stack.pop & stack.pop)
@@ -158,39 +160,36 @@ module Flock
       end.compact
     end
 
-    def unarchive_node(source, graph, dest)
-      remove_node(source, graph, dest, :archived).tap do |deleted|
-        deleted.each {|d| add_edge(source, graph, dest, :normal) }
-      end
-    end
+    def color_node(source, graph, dest, dest_state)
+      raise ArgumentError unless Edges::EdgeState::VALUE_MAP.keys.include? dest_state
 
-    # actual graph helpers
+      source_states = (Edges::EdgeState::VALUE_MAP.keys - [dest_state])
 
-    def add(source, graph, dest)
       if source.nil? or dest.nil?
-        unarchive_node(source, graph, dest)
+        source_states.each do |source_state|
+          remove_node(source, graph, dest, source_state).tap do |deleted|
+            deleted.each {|source, graph, dest| add_edge(source, graph, dest, dest_state) }
+          end
+        end
+
       else
         sources, dests = Array(source), Array(dest)
 
         sources.each do |s|
           dests.each do |d|
-            add_edge(s, graph, d, :normal)
-            remove_edge(s, graph, d, :archived)
+            add_edge(s, graph, d, dest_state)
+            source_states.each { |state| remove_edge(s, graph, d, state) }
           end
         end
       end
     end
 
-    def remove(source, graph, dest)
-      remove_node(source, graph, dest, :archived)
-      remove_node(source, graph, dest, :normal)
-    end
+    # must map manually since execute operations do not line up with
+    # their actual colors
+    op_color_map = {:add => 0, :remove => 1, :archive => 2, :negate => 3}
 
-    def archive(source, graph, dest)
-      remove_node(source, graph, dest, :normal).tap do |deleted|
-        p deleted
-        deleted.each {|source, graph, dest| add_edge(source, graph, dest, :archived) }
-      end
+    op_color_map.each do |op, color|
+      class_eval "def #{op}(s, g, d); color_node(s, g, d, #{color}) end", __FILE__, __LINE__
     end
   end
 end

data/lib/flock/operations/execute_operation.rb

@@ -11,4 +11,4 @@ module Flock
       op
     end
   end
-end
+end

data/lib/flock/operations/execute_operations.rb

@@ -4,19 +4,9 @@ module Flock
       @service, @operations, @priority = service, [], priority
     end
 
-    def add(source_id, graph_id, destination_id)
-      @operations << ExecuteOperation.new(Edges::ExecuteOperationType::Add, [source_id, graph_id, destination_id])
-      self
-    end
-
-    def remove(source_id, graph_id, destination_id)
-      @operations << ExecuteOperation.new(Edges::ExecuteOperationType::Remove, [source_id, graph_id, destination_id])
-      self
-    end
-
-    def archive(source_id, graph_id, destination_id)
-      @operations << ExecuteOperation.new(Edges::ExecuteOperationType::Archive, [source_id, graph_id, destination_id])
-      self
+    Flock::Edges::ExecuteOperationType::VALUE_MAP.each do |op_id, op|
+      op = op.downcase
+      class_eval "def #{op}(s, g, d); @operations << ExecuteOperation.new(#{op_id}, [s, g, d]); self end", __FILE__, __LINE__
     end
 
     def apply
@@ -29,7 +19,5 @@ module Flock
       operations.priority = @priority
       operations
     end
-
-    alias_method :unarchive, :add
   end
 end

data/lib/flock/operations/query_term.rb

@@ -1,25 +1,37 @@
 module Flock
   class QueryTerm
+    attr_accessor :source, :graph, :destination, :states
+
     def initialize(query)
-      @query = query
+      case query.size
+      when 3, 4
+        @source, @graph, @destination, @states = *query
+      else
+        raise ArgumentError
+      end
     end
 
-    def to_thrift
-      raise ArgumentError unless @query.size == 3
+    def forward?
+      @source.is_a? Numeric
+    end
 
+    def to_thrift
       term = Edges::QueryTerm.new
-      case @query.first
-      when Numeric
-        term.source_id = @query.first
-        term.destination_ids = Array(@query.last).pack("Q*") if @query.last
-        term.is_forward = true
-      else
-        term.source_id = @query.last
-        term.destination_ids = Array(@query.first).pack("Q*") if @query.first
-        term.is_forward = false
-      end
-      term.graph_id = @query[1]
+      term.graph_id = @graph
+      term.state_ids = @states unless @states.nil? or @states.empty?
+      term.is_forward = forward?
+
+      source, destination =
+        if term.is_forward
+          [@source, @destination]
+        else
+          [@destination, @source]
+        end
+
+      term.source_id = source
+      term.destination_ids = Array(destination).pack("Q*") if destination
+
       term
     end
   end
-end
+end

data/spec/execute_operations_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Flock::ExecuteOperations do
+  describe "#negate" do
+    it "should create a negate opperation" do
+      mock(Flock::ExecuteOperation).new(Flock::Edges::ExecuteOperationType::Negate, [1,1,3])
+      operation = Flock::ExecuteOperations.new(Flock::Client.new(Flock::MockService), nil)
+      operation.negate(1,1,3)
+    end
+  end
+end

data/spec/flock_spec.rb

@@ -6,20 +6,29 @@ describe Flock do
   before do
     @flock = new_flock_client
 
-    flock.add(1,1,1)
     flock.add(1,1,2)
+    flock.add(1,1,3)
+    flock.add(2,1,1)
+    flock.add(4,1,1)
   end
 
   describe 'add' do
     it 'works' do
-      flock.contains(1,1,1).should == true
+      flock.contains(1,1,2).should == true
     end
   end
 
   describe 'remove' do
     it 'works' do
-      flock.remove(1,1,1)
-      flock.contains(1,1,1).should == false
+      flock.remove(1,1,2)
+      flock.contains(1,1,2).should == false
+    end
+  end
+
+  describe 'negate' do
+    it 'works' do
+      flock.negate(1,1,2)
+      flock.contains(1,1,2).should == false
     end
   end
 
@@ -29,6 +38,104 @@ describe Flock do
     end
   end
 
+  describe 'archive' do
+    describe 'forward' do
+      describe 'one' do
+        it 'works' do
+          flock.archive(1,1,2)
+          flock.contains(1,1,2).should == false
+        end
+      end
+
+      describe 'many' do
+        it 'works' do
+          flock.archive(1,1,[2, 3])
+          flock.contains(1,1,2).should == false
+          flock.contains(1,1,3).should == false
+        end
+      end
+
+      describe 'all' do
+        it 'works' do
+          flock.archive(1,1,nil)
+          flock.contains(1,1,2).should == false
+          flock.contains(1,1,3).should == false
+        end
+      end
+    end
+
+    describe 'backwards' do
+      describe 'many' do
+        it 'works' do
+          flock.archive([2,4],1,1)
+          flock.contains(2,1,1).should == false
+          flock.contains(4,1,1).should == false
+        end
+      end
+
+      describe 'all' do
+        it 'works' do
+          flock.archive(nil,1,1)
+          flock.contains(2,1,1).should == false
+          flock.contains(4,1,1).should == false
+        end
+      end
+    end
+  end
+
+  describe 'unarchive' do
+    describe 'forward' do
+      before do
+        flock.archive(1,1,nil)
+      end
+
+      describe 'one' do
+        it 'works' do
+          flock.unarchive(1,1,2)
+          flock.contains(1,1,2).should == true
+        end
+      end
+
+      describe 'many' do
+        it 'works' do
+          flock.unarchive(1,1,[2,3])
+          flock.contains(1,1,2).should == true
+          flock.contains(1,1,3).should == true
+        end
+      end
+
+      describe 'all' do
+        it 'works' do
+          flock.unarchive(1,1,nil)
+          flock.contains(1,1,2).should == true
+          flock.contains(1,1,3).should == true
+        end
+      end
+    end
+
+    describe 'backwards' do
+      before do
+        flock.archive(nil,1,1)
+      end
+
+      describe 'many' do
+        it 'works' do
+          flock.unarchive([2,4],1,1)
+          flock.contains(2,1,1).should == true
+          flock.contains(4,1,1).should == true
+        end
+      end
+
+      describe 'all' do
+        it 'works' do
+          flock.unarchive(nil,1,1)
+          flock.contains(2,1,1).should == true
+          flock.contains(4,1,1).should == true
+        end
+      end
+    end
+  end
+
   describe 'select' do
     attr_accessor :query
 
@@ -37,21 +144,21 @@ describe Flock do
     end
 
     it "supports old style of select" do
-      flock.select([1,1,nil]).to_a.sort.should == [1,2]
+      flock.select([1,1,nil]).to_a.sort.should == [2, 3]
     end
 
     it "supports selecting multiple nodes" do
-      flock.select(1,1,[1,2]).to_a.sort.should == [1,2]
+      flock.select(1,1,[2,3]).to_a.sort.should == [2, 3]
     end
 
     it "turns nodes into ints if possible" do
       user = mock!.to_i { 1 }.subject
-      flock.select(user, 1, nil).to_a.sort.should == [1,2]
+      flock.select(user, 1, nil).to_a.sort.should == [2, 3]
     end
 
     describe 'to_a' do
       it 'works' do
-        flock.select(1,1,nil).to_a.sort.should == [1,2]
+        flock.select(1,1,nil).to_a.sort.should == [2, 3]
       end
     end
 
@@ -59,13 +166,13 @@ describe Flock do
       it 'works' do
         page, next_cursor, prev_cursor = query.paginate(1).unapply
 
-        page.should == [1]
+        page.should == [2]
         prev_cursor.should == Flock::CursorEnd
         next_cursor.should_not == Flock::CursorEnd
 
         page, next_cursor, prev_cursor = query.paginate(1, next_cursor).unapply
 
-        page.should == [2]
+        page.should == [3]
         prev_cursor.should == Flock::CursorStart
         next_cursor.should == Flock::CursorEnd
       end
@@ -75,10 +182,10 @@ describe Flock do
           results = query.paginate(1)
 
           results.next_page?.should == true
-          results.next_page.should == [1]
+          results.next_page.should == [2]
 
           results.next_page?.should == true
-          results.next_page.should == [2]
+          results.next_page.should == [3]
 
           results.next_page?.should == false
         end
@@ -89,10 +196,10 @@ describe Flock do
           results = query.paginate(2)
 
           results.next?.should == true
-          results.next.should == 1
+          results.next.should == 2
 
           results.next?.should == true
-          results.next.should == 2
+          results.next.should == 3
 
           results.next?.should == false
         end

data/spec/query_term_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Flock::QueryTerm do
+  describe '#new' do
+    it 'requires a query of length 4' do
+      lambda { Flock::QueryTerm.new([1, 1, 1, 1, 1]) }.should raise_error(ArgumentError)
+    end
+
+    it 'has a source, graph, destination, and states' do
+      qt = Flock::QueryTerm.new([1, 1, 2, [Flock::Edges::EdgeState::Positive, Flock::Edges::EdgeState::Negative]])
+      qt.source.should == 1
+      qt.graph.should == 1
+      qt.destination.should == 2
+      qt.states.should == [Flock::Edges::EdgeState::Positive, Flock::Edges::EdgeState::Negative]
+    end
+  end
+
+  it "is forward if source is a single integer" do
+    qt = Flock::QueryTerm.new([1, 1, 2, []])
+    qt.should be_forward
+
+    qt = Flock::QueryTerm.new([1, 1, nil, []])
+    qt.should be_forward
+
+    qt = Flock::QueryTerm.new([1, 1, [2, 3], []])
+    qt.should be_forward
+  end
+
+  it "is not forward if source is not a single integer" do
+    qt = Flock::QueryTerm.new([[1, 2], 1, 3, []])
+    qt.should_not be_forward
+
+    qt = Flock::QueryTerm.new([nil, 1, 3, []])
+    qt.should_not be_forward
+  end
+
+  describe "#to_thrift" do
+    before do
+      @term = Flock::QueryTerm.new([1, 1, 2, [Flock::Edges::EdgeState::Positive, Flock::Edges::EdgeState::Negative]])
+      @backward = Flock::QueryTerm.new([nil, 1, 2, [Flock::Edges::EdgeState::Positive, Flock::Edges::EdgeState::Negative]])
+    end
+
+    it "should set is_forward correctly" do
+      @term.to_thrift.is_forward.should == true
+      @term.source = nil
+      @term.to_thrift.is_forward.should == false
+    end
+
+    it "should switch source and destination ids for a backwards term" do
+      @term.to_thrift.source_id.should == @term.source
+      @term.to_thrift.destination_ids.should == [@term.destination].pack('Q*')
+
+      @term.source = nil
+      @term.to_thrift.source_id.should == @term.destination
+      @term.to_thrift.destination_ids.should == nil
+
+      @term.source = [1, 2]
+      @term.to_thrift.destination_ids.should == @term.source.pack('Q*')
+    end
+
+    it "should add state to thrift object" do
+      @term.to_thrift.state_ids.should == [Flock::Edges::EdgeState::Positive, Flock::Edges::EdgeState::Negative]
+    end
+  end
+end

data/spec/simple_operation_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Flock::ExecuteOperations do
+  describe "#negate" do
+    it "should create a negate operation" do
+      mock(Flock::ExecuteOperation).new(Flock::Edges::ExecuteOperationType::Negate, [1,1,3])
+      operation = Flock::ExecuteOperations.new(Flock::Client.new(Flock::MockService), nil)
+      operation.negate(1,1,3)
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Matt Freels
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 -07:00
+date: 2010-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,8 +105,11 @@ files:
 - lib/flock/thrift/flock_types.rb
 - lib/flock/thrift/shards.rb
 - lib/flockdb.rb
+- spec/execute_operations_spec.rb
 - spec/flock_spec.rb
 - spec/mock_service_spec.rb
+- spec/query_term_spec.rb
+- spec/simple_operation_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -140,6 +143,9 @@ signing_key:
 specification_version: 3
 summary: Ruby Flock client
 test_files: 
+- spec/execute_operations_spec.rb
 - spec/flock_spec.rb
 - spec/mock_service_spec.rb
+- spec/query_term_spec.rb
+- spec/simple_operation_spec.rb
 - spec/spec_helper.rb