bumbleworks 0.0.28 → 0.0.29

data/lib/bumbleworks/support.rb

@@ -33,5 +33,24 @@ module Bumbleworks
       end
       constant
     end
+
+    def tokenize(string)
+      return nil if string.nil?
+      string = string.gsub(/&/, ' and ').
+        gsub(/[ \/]+/, '_').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        downcase
+    end
+
+    def humanize(string)
+      return nil if string.nil?
+      tokenize(string).gsub(/_/, ' ').
+        gsub(/^\w/) { $&.upcase }
+    end
+
+    def titleize(string)
+      return nil if string.nil?
+      humanize(string).gsub(/\b('?[a-z])/) { $1.capitalize }
+    end
   end
 end

data/lib/bumbleworks/task.rb

@@ -157,8 +157,30 @@ module Bumbleworks
       })
     end
 
+    def to_s(options = {})
+      titleize(options)
+    end
+
+    def titleize(options = {})
+      displayify(:titleize, options)
+    end
+
+    def humanize(options = {})
+      displayify(:humanize, options)
+    end
+
   private
 
+    def displayify(modifier, options = {})
+      task_name = Bumbleworks::Support.send(modifier, nickname)
+
+      if options[:entity] != false && !(entity_fields = entity_fields(modifier => true)).empty?
+        "#{task_name}: #{entity_fields[:type]} #{entity_fields[:identifier]}"
+      else
+        task_name
+      end
+    end
+
     def storage_participant
       self.class.storage_participant
     end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.28"
+  VERSION = "0.0.29"
 end

data/lib/bumbleworks/workitem_entity_storage.rb

@@ -22,6 +22,21 @@ module Bumbleworks
       entity_id && entity_type
     end
 
+    def entity_fields(options = {})
+      return {} unless has_entity_fields?
+      type = if options[:humanize] == true
+        Bumbleworks::Support.humanize(entity_type)
+      elsif options[:titleize] == true
+        Bumbleworks::Support.titleize(entity_type)
+      else
+        entity_type
+      end
+      {
+        :type => type,
+        :identifier => entity_id
+      }
+    end
+
   private
 
     def entity_id

data/spec/lib/bumbleworks/support_spec.rb

@@ -59,4 +59,50 @@ describe Bumbleworks::Support do
       }.to raise_error(NameError)
     end
   end
+
+  describe '.tokenize' do
+    it 'creates snake_case version of string' do
+      described_class.tokenize('Albus Dumbledore & his_friend').should == 'albus_dumbledore_and_his_friend'
+    end
+
+    it 'uncamelizes' do
+      described_class.tokenize('thisStrangeJavalikeWord').should == 'this_strange_javalike_word'
+    end
+
+    it 'returns nil if given nil' do
+      described_class.tokenize(nil).should be_nil
+    end
+  end
+
+  describe '.humanize' do
+    it 'creates humanized version of snaky string' do
+      described_class.humanize('mops_are_so_moppy').should == 'Mops are so moppy'
+    end
+
+    it 'created humanized version of camely string' do
+      described_class.humanize('thisStrangeJavalikeWord').should == 'This strange javalike word'
+    end
+
+    it 'returns nil if given nil' do
+      described_class.humanize(nil).should be_nil
+    end
+  end
+
+  describe '.titleize' do
+    it 'creates titleized version of snaky string' do
+      described_class.titleize('mops_are_so_moppy').should == 'Mops Are So Moppy'
+    end
+
+    it 'created titleized version of camely string' do
+      described_class.titleize('thisStrangeJavalikeWord').should == 'This Strange Javalike Word'
+    end
+
+    it 'created titleized version of humany string' do
+      described_class.titleize('You are a wonderful toothbrush').should == 'You Are A Wonderful Toothbrush'
+    end
+
+    it 'returns nil if given nil' do
+      described_class.titleize(nil).should be_nil
+    end
+  end
 end

data/spec/lib/bumbleworks/task_spec.rb

@@ -672,4 +672,54 @@ describe Bumbleworks::Task do
       }.to raise_error(Bumbleworks::Task::AvailabilityTimeout)
     end
   end
+
+  describe '#humanize' do
+    it "returns humanized version of task name when no entity" do
+      task = described_class.new(workflow_item)
+      task.humanize.should == 'Go to work'
+    end
+
+    it "returns humanized version of task name with entity" do
+      task = described_class.new(workflow_item)
+      task[:entity_id] = '45'
+      task[:entity_type] = 'RhubarbSandwich'
+      task.humanize.should == 'Go to work: Rhubarb sandwich 45'
+    end
+
+    it "returns humanized version of task name without entity if requested" do
+      task = described_class.new(workflow_item)
+      task[:entity_id] = '45'
+      task[:entity_type] = 'RhubarbSandwich'
+      task.humanize(:entity => false).should == 'Go to work'
+    end
+  end
+
+  describe '#to_s' do
+    it "is aliased to #titleize" do
+      task = described_class.new(workflow_item)
+      task.stub(:titleize).with(:the_args).and_return(:see_i_told_you_so)
+      task.to_s(:the_args).should == :see_i_told_you_so
+    end
+  end
+
+  describe '#titleize' do
+    it "returns titleized version of task name when no entity" do
+      task = described_class.new(workflow_item)
+      task.titleize.should == 'Go To Work'
+    end
+
+    it "returns titleized version of task name with entity" do
+      task = described_class.new(workflow_item)
+      task[:entity_id] = '45'
+      task[:entity_type] = 'RhubarbSandwich'
+      task.titleize.should == 'Go To Work: Rhubarb Sandwich 45'
+    end
+
+    it "returns titleized version of task name without entity if requested" do
+      task = described_class.new(workflow_item)
+      task[:entity_id] = '45'
+      task[:entity_type] = 'RhubarbSandwich'
+      task.titleize(:entity => false).should == 'Go To Work'
+    end
+  end
 end

data/spec/lib/bumbleworks/workitem_entity_storage_spec.rb

@@ -98,4 +98,26 @@ describe Bumbleworks::WorkitemEntityStorage do
       feh.entity(:reload => true).identifier.should == '15'
     end
   end
+
+  describe "#entity_fields" do
+    it 'returns empty hash if no entity' do
+      feh = FakeEntityHolder.new
+      feh.entity_fields.should == {}
+    end
+
+    it 'returns class name and identifier by default' do
+      feh = FakeEntityHolder.new('entity_id' => '15', 'entity_type' => 'LovelyEntity')
+      feh.entity_fields.should == { :type => 'LovelyEntity', :identifier => '15' }
+    end
+
+    it 'humanizes class name when requested' do
+      feh = FakeEntityHolder.new('entity_id' => '15', 'entity_type' => 'LovelyEntity')
+      feh.entity_fields(:humanize => true).should == { :type => 'Lovely entity', :identifier => '15' }
+    end
+
+    it 'titleizes class name when requested' do
+      feh = FakeEntityHolder.new('entity_id' => '15', 'entity_type' => 'LovelyEntity')
+      feh.entity_fields(:titleize => true).should == { :type => 'Lovely Entity', :identifier => '15' }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.29
   prerelease: 
 platform: ruby
 authors: