bumbleworks 0.0.87 → 0.0.88

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddb99ff7e81ef79f450c5888713b862a3dd85673
-  data.tar.gz: 5b3de42cac468a392998375432725b33d1bbf501
+  metadata.gz: 8e7f5891aaff2d00d0129acf222c6a1ee06c74e2
+  data.tar.gz: 59288f755a48cd12069cbbe898037fde62cbfb2e
 SHA512:
-  metadata.gz: b91712d329d034b868e3aa1579d7b2a84ec4eab9bea15aea43e72ff1c9187ee3546d3c1e36d53d3f12c7095d246b8d592c3903126f9ca2b9b49057f0f3147f09
-  data.tar.gz: ff019980495f03d0c3622329cc8d3e9f3d7e516758b329ef49ac8ac287d2b3d462887179d39ccc59dc6003f2fc4afb06f6b89eb92ef2941c7816bb7f7f9efc12
+  metadata.gz: 3ec00ab19a09a29fe07dcf810282c0ad40ab83e0bfb876d491c7b9fb6f01c32022d39c0924bca8b9d49b3b674b67e6e2e1fca678a2b1e7eaad751f8410541673
+  data.tar.gz: 4c889ebea8ed536c90c16f0660030837c7f29c4c70b62a75d70762f9e12ac61979537dcb14730150e894c16356d62a0af0709ac6122620931bfff696f20a1b3b

data/lib/bumbleworks.rb

@@ -2,6 +2,7 @@ require "forwardable"
 require "bumbleworks/version"
 require "bumbleworks/configuration"
 require "bumbleworks/support"
+require "bumbleworks/support/wrapper_comparison"
 require "bumbleworks/process_definition"
 require "bumbleworks/process"
 require "bumbleworks/expression"

data/lib/bumbleworks/expression.rb

@@ -1,6 +1,9 @@
 module Bumbleworks
   class Expression
+    include Support::WrapperComparison
+
     attr_reader :expid, :fei
+    alias_method :id, :expid
 
     class << self
       def from_fei(fei)
@@ -15,11 +18,6 @@ module Bumbleworks
       @expid = @fei.expid
     end
 
-    def ==(other)
-      return false unless other.is_a?(self.class)
-      @fei == other.fei
-    end
-
     # Returns a Bumbleworks::Process instance for the expression's
     # wfid; effectively, the process instance this expression is
     # a part of.

data/lib/bumbleworks/process.rb

@@ -6,6 +6,7 @@ module Bumbleworks
     class EntityConflict < StandardError; end
 
     include WorkitemEntityStorage
+    include Support::WrapperComparison
 
     attr_reader :id
 
@@ -53,11 +54,6 @@ module Bumbleworks
       wfid <=> other.wfid
     end
 
-    def ==(other)
-      return false unless other.is_a?(self.class)
-      wfid == other.wfid
-    end
-
     def entity_workitem
       @entity_workitem ||= if workitems.map(&:entity_fields).uniq.length <= 1
         workitems.first

data/lib/bumbleworks/schedule.rb

@@ -1,6 +1,7 @@
 module Bumbleworks
   class Schedule
     attr_reader :id, :original_hash
+    include Support::WrapperComparison
 
     class << self
       def all
@@ -19,11 +20,6 @@ module Bumbleworks
       @id = @original_hash['_id']
     end
 
-    def ==(other)
-      return false unless other.is_a?(self.class)
-      @id == other.id
-    end
-
     def wfid
       @original_hash['wfid']
     end

data/lib/bumbleworks/support/wrapper_comparison.rb

@@ -0,0 +1,23 @@
+module Bumbleworks
+  module Support
+    module WrapperComparison
+      def identifier_for_comparison
+        id
+      end
+
+      def hash
+        identifier_for_comparison.hash
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          identifier_for_comparison &&
+          identifier_for_comparison == other.identifier_for_comparison
+      end
+
+      def eql?(other)
+        self == other
+      end
+    end
+  end
+end

data/lib/bumbleworks/task.rb

@@ -5,6 +5,7 @@ require "bumbleworks/task/finder"
 module Bumbleworks
   class Task
     include WorkitemEntityStorage
+    include Support::WrapperComparison
 
     class AlreadyClaimed < StandardError; end
     class MissingWorkitem < StandardError; end

data/lib/bumbleworks/tracker.rb

@@ -1,6 +1,7 @@
 module Bumbleworks
   class Tracker
     attr_reader :id, :original_hash
+    include Support::WrapperComparison
 
     class << self
       def all

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.87"
+  VERSION = "0.0.88"
 end

data/lib/bumbleworks/workitem.rb

@@ -1,14 +1,17 @@
 module Bumbleworks
   class Workitem
+    include Support::WrapperComparison
+
     attr_reader :raw_workitem
 
+    extend Forwardable
+
     def initialize(raw_workitem)
       @raw_workitem = raw_workitem
     end
 
-    def ==(other)
-      return false unless other.is_a?(self.class)
-      raw_workitem == other.raw_workitem
+    def identifier_for_comparison
+      raw_workitem
     end
 
     def entity(options = {})

data/spec/lib/bumbleworks/expression_spec.rb

@@ -11,24 +11,9 @@ describe Bumbleworks::Expression do
     end
   end
 
-  describe '#==' do
-    it 'returns true if other object has same flow expression id' do
-      exp1 = described_class.new(fexp)
-      exp2 = described_class.new(double('FlowExpression', :fei => fei))
-      expect(exp1).to eq(exp2)
-    end
-
-    it 'returns false if other object has different flow expression id' do
-      exp1 = described_class.new(fexp)
-      exp2 = described_class.new(double('FlowExpression', :fei => double(:expid => '4')))
-      expect(exp1).not_to eq(exp2)
-    end
-
-    it 'returns false if other object has is not an expression' do
-      exp1 = described_class.new(fexp)
-      exp2 = double('not an expression')
-      expect(exp1).not_to eq(exp2)
-    end
+  it_behaves_like "comparable" do
+    subject { described_class.new(fexp) }
+    let(:other) { described_class.new(fexp) }
   end
 
   describe '#expid' do

data/spec/lib/bumbleworks/process_spec.rb

@@ -36,6 +36,11 @@ describe Bumbleworks::Process do
     end
   end
 
+  it_behaves_like "comparable" do
+    subject { described_class.new('watchful_egret') }
+    let(:other) { described_class.new('lets_dance_yo') }
+  end
+
   describe '.all' do
     it 'returns sorted and filtered array of instances for all processes' do
       expect(described_class).to receive(:ids).with(:some_options).and_return([:a, :b, :c])

data/spec/lib/bumbleworks/schedule_spec.rb

@@ -8,6 +8,11 @@ describe Bumbleworks::Schedule do
     allow(Bumbleworks.dashboard).to receive_messages(:schedules => fake_schedules)
   end
 
+  it_behaves_like "comparable" do
+    subject { described_class.new({ '_id' => 'fooz'}) }
+    let(:other) { described_class.new({ '_id' => 'barn'}) }
+  end
+
   describe '.all' do
     it 'returns instances for each schedule in system' do
       schedules = described_class.all
@@ -33,26 +38,6 @@ describe Bumbleworks::Schedule do
     end
   end
 
-  describe '#==' do
-    it 'returns true if other object has same original hash _id' do
-      schedule1 = described_class.new({ '_id' => 'snaggletooth', 'who' => 'cares' })
-      schedule2 = described_class.new({ '_id' => 'snaggletooth', 'yeah' => 'whatevs' })
-      expect(schedule1).to eq(schedule2)
-    end
-
-    it 'returns false if other object has different original hash _id' do
-      schedule1 = described_class.new({ '_id' => 'snaggletooth', 'who' => 'cares' })
-      schedule2 = described_class.new({ '_id' => 'snooglebunk', 'yeah' => 'whatevs' })
-      expect(schedule1).not_to eq(schedule2)
-    end
-
-    it 'returns false if other object is not a schedule' do
-      schedule1 = described_class.new({ '_id' => 'snaggletooth', 'who' => 'cares' })
-      schedule2 = double('not a schedule')
-      expect(schedule1).not_to eq(schedule2)
-    end
-  end
-
   describe '#wfid' do
     it 'returns wfid from original hash' do
       expect(subject.wfid).to eq(fake_schedule['wfid'])

data/spec/lib/bumbleworks/task_spec.rb

@@ -18,6 +18,14 @@ describe Bumbleworks::Task do
     let(:storage_workitem) { Bumbleworks::Workitem.new(workflow_item) }
   end
 
+  it_behaves_like "comparable" do
+    subject { described_class.new(workflow_item) }
+    let(:other) { described_class.new(workflow_item) }
+    before(:each) do
+      allow(workflow_item).to receive(:sid).and_return('blah-123-blah')
+    end
+  end
+
   describe '#not_completable_error_message' do
     it 'defaults to generic message' do
       task = described_class.new(workflow_item)

data/spec/lib/bumbleworks/tracker_spec.rb

@@ -5,6 +5,11 @@ describe Bumbleworks::Tracker do
     allow(Bumbleworks.dashboard).to receive_messages(:get_trackers => fake_trackers)
   end
 
+  it_behaves_like "comparable" do
+    subject { described_class.new('a_tracker') }
+    let(:other) { described_class.new('another_tracker') }
+  end
+
   describe '.all' do
     it 'returns instances for each tracker in system' do
       trackers = described_class.all

data/spec/lib/bumbleworks/workitem_spec.rb

@@ -2,118 +2,109 @@ require File.expand_path(File.join(fixtures_path, 'entities', 'rainbow_loom'))
 
 describe Bumbleworks::Workitem do
   let(:ruote_workitem) { Ruote::Workitem.new('fields' => {'entity_id' => '123', 'entity_type' => 'RainbowLoom'} ) }
-  let(:workitem) { Bumbleworks::Workitem.new(ruote_workitem)}
+  subject { described_class.new(ruote_workitem) }
 
-  describe '#==' do
-    it 'returns true if other object has same raw workitem' do
-      bw1 = described_class.new('in_da_sky')
-      bw2 = described_class.new('in_da_sky')
-      expect(bw1).to eq(bw2)
-    end
-
-    it 'returns false if other object is not a workitem' do
-      bw1 = described_class.new('in_da_sky')
-      bw2 = double('not a workitem')
-      expect(bw1).not_to eq(bw2)
-    end
+  it_behaves_like "comparable" do
+    subject { described_class.new(ruote_workitem) }
+    let(:other) { described_class.new(ruote_workitem) }
   end
 
   describe '#has_entity_fields?' do
     it 'returns true if workitem fields include entity fields' do
-      expect(workitem).to have_entity_fields
+      expect(subject).to have_entity_fields
     end
 
     it 'returns true if workitem fields include symbolized version of entity fields' do
       ruote_workitem.fields = { :entity_id => '123', :entity_type => 'RainbowLoom' }
-      expect(workitem).to have_entity_fields
+      expect(subject).to have_entity_fields
     end
 
     it 'returns false if workitem fields do not include entity fields' do
       ruote_workitem.fields = {}
-      expect(workitem).not_to have_entity_fields
+      expect(subject).not_to have_entity_fields
     end
   end
 
   describe '#has_entity?' do
     it 'returns true if entity is not nil' do
-      allow(workitem).to receive(:entity).and_return(:a_real_boy_not_a_puppet)
-      expect(workitem.has_entity?).to be_truthy
+      allow(subject).to receive(:entity).and_return(:a_real_boy_not_a_puppet)
+      expect(subject.has_entity?).to be_truthy
     end
 
     it 'returns false if EntityNotFound' do
-      allow(workitem).to receive(:entity).and_raise(Bumbleworks::EntityNotFound)
-      expect(workitem.has_entity?).to be_falsy
+      allow(subject).to receive(:entity).and_raise(Bumbleworks::EntityNotFound)
+      expect(subject.has_entity?).to be_falsy
     end
   end
 
   describe '#entity' do
     it 'attempts to instantiate business entity from _id and _type fields' do
-      expect(workitem.entity.identifier).to eq('123')
+      expect(subject.entity.identifier).to eq('123')
     end
 
     it 'works with symbolized _id and _type fields' do
       ruote_workitem.fields = { :entity_id => '125', :entity_type => 'RainbowLoom' }
-      expect(workitem.entity.identifier).to eq('125')
+      expect(subject.entity.identifier).to eq('125')
     end
 
     it 'throw exception if entity fields not present' do
       ruote_workitem.fields = {}
       expect {
-        workitem.entity
+        subject.entity
       }.to raise_error Bumbleworks::EntityNotFound
     end
 
     it 'throw exception if entity returns nil' do
       ruote_workitem.fields['entity_id'] = nil
       expect {
-        workitem.entity
+        subject.entity
       }.to raise_error Bumbleworks::EntityNotFound, '{:entity_id=>nil, :entity_type=>"RainbowLoom"}'
     end
 
     it 'returns same instance when called twice' do
-      workitem.entity.identifier = 'nerfus'
-      expect(workitem.entity.identifier).to eq('nerfus')
+      subject.entity.identifier = 'nerfus'
+      expect(subject.entity.identifier).to eq('nerfus')
     end
 
     it 'reloads instance when called with reload option' do
-      workitem.entity.identifier = 'pickles'
-      expect(workitem.entity(:reload => true).identifier).to eq('123')
+      subject.entity.identifier = 'pickles'
+      expect(subject.entity(:reload => true).identifier).to eq('123')
     end
   end
 
   describe '#tokenized_entity_type' do
     it 'returns tokenized entity type' do
-      expect(workitem.tokenized_entity_type).to eq('rainbow_loom')
+      expect(subject.tokenized_entity_type).to eq('rainbow_loom')
     end
 
     it 'returns nil if no entity type' do
-      allow(workitem).to receive(:entity_type).and_return(nil)
-      expect(workitem.tokenized_entity_type).to be_nil
+      allow(subject).to receive(:entity_type).and_return(nil)
+      expect(subject.tokenized_entity_type).to be_nil
     end
   end
 
   describe "#entity_fields" do
     it 'returns empty hash if no entity' do
       ruote_workitem.fields = {}
-      expect(workitem.entity_fields).to eq({})
+      expect(subject.entity_fields).to eq({})
     end
 
     it 'returns class name and identifier by default' do
-      expect(workitem.entity_fields).to eq({ :type => 'RainbowLoom', :identifier => '123' })
+      expect(subject.entity_fields).to eq({ :type => 'RainbowLoom', :identifier => '123' })
     end
 
     it 'humanizes class name when requested' do
-      expect(workitem.entity_fields(:humanize => true)).to eq({ :type => 'Rainbow loom', :identifier => '123' })
+      expect(subject.entity_fields(:humanize => true)).to eq({ :type => 'Rainbow loom', :identifier => '123' })
     end
 
     it 'titleizes class name when requested' do
-      expect(workitem.entity_fields(:titleize => true)).to eq({ :type => 'Rainbow Loom', :identifier => '123' })
+      expect(subject.entity_fields(:titleize => true)).to eq({ :type => 'Rainbow Loom', :identifier => '123' })
     end
   end
 
   describe "#entity_name" do
     it 'returns entity fields in displayable string' do
-      expect(workitem.entity_name).to eq('Rainbow Loom 123')
+      expect(subject.entity_name).to eq('Rainbow Loom 123')
     end
   end
 end

data/spec/support/shared_examples.rb

@@ -13,4 +13,38 @@ shared_examples "an entity holder" do
       expect(holder.entity_storage_workitem).to eq(storage_workitem)
     end
   end
-end
+end
+
+shared_examples "comparable" do
+  describe "#hash" do
+    it 'returns hash of identifier_for_comparison' do
+      expect(subject.hash).to eq(subject.identifier_for_comparison.hash)
+    end
+  end
+
+  describe '#==' do
+    it 'returns true if identifier_for_comparison values are equal' do
+      allow(other).to receive(:identifier_for_comparison).
+        and_return(subject.identifier_for_comparison)
+      expect(subject).to be == other
+    end
+
+    it 'returns false if other is different class' do
+      different_classed_instance = double('whatever', :identifier_for_comparison => subject.identifier_for_comparison)
+      expect(subject).not_to be == different_classed_instance
+    end
+
+    it 'returns false if identifier_for_comparison is nil' do
+      allow(other).to receive(:identifier_for_comparison).and_return(nil)
+      allow(subject).to receive(:identifier_for_comparison).and_return(nil)
+      expect(subject).not_to be == other
+    end
+  end
+
+  describe '#eql?' do
+    it 'aliases to ==' do
+      expect(subject).to receive(:==).with(other)
+      subject.eql?(other)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.87
+  version: 0.0.88
 platform: ruby
 authors:
 - Maher Hawash
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote
@@ -174,6 +174,7 @@ files:
 - lib/bumbleworks/storage_adapter.rb
 - lib/bumbleworks/support.rb
 - lib/bumbleworks/support/flow_expression.rb
+- lib/bumbleworks/support/wrapper_comparison.rb
 - lib/bumbleworks/task.rb
 - lib/bumbleworks/task/base.rb
 - lib/bumbleworks/task/finder.rb