primedia-endeca 0.9.23 → 0.9.24

data/Manifest.txt

@@ -8,15 +8,21 @@ example/listing.rb
 lib/class_to_proc.rb
 lib/core_ext.rb
 lib/endeca.rb
+lib/endeca/benchmarking.rb
+lib/endeca/breadcrumb.rb
+lib/endeca/breadcrumbs.rb
 lib/endeca/dimension.rb
 lib/endeca/document.rb
 lib/endeca/document_collection.rb
+lib/endeca/logging.rb
 lib/endeca/map.rb
 lib/endeca/readers.rb
 lib/endeca/refinement.rb
 lib/endeca/request.rb
 lib/endeca/transformer.rb
 spec/core_ext_spec.rb
+spec/endeca/benchmarking_spec.rb
+spec/endeca/breadcrumb_spec.rb
 spec/endeca/dimension_spec.rb
 spec/endeca/document_collection_spec.rb
 spec/endeca/document_spec.rb

data/endeca.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "0.9.23"
+  s.version = "0.9.24"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rein Henrichs", "Andy Stone"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = %q{An Endeca client library for Ruby.}
   s.email = %q{}
   s.extra_rdoc_files = ["History.txt", "README.rdoc"]
-  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "endeca.gemspec", "example/benchmark.rb", "example/listing.rb", "lib/class_to_proc.rb", "lib/core_ext.rb", "lib/endeca.rb", "lib/endeca/dimension.rb", "lib/endeca/document.rb", "lib/endeca/document_collection.rb", "lib/endeca/map.rb", "lib/endeca/readers.rb", "lib/endeca/refinement.rb", "lib/endeca/request.rb", "lib/endeca/transformer.rb", "spec/core_ext_spec.rb", "spec/endeca/dimension_spec.rb", "spec/endeca/document_collection_spec.rb", "spec/endeca/document_spec.rb", "spec/endeca/map_spec.rb", "spec/endeca/readers_spec.rb", "spec/endeca/refinement_spec.rb", "spec/endeca/request_spec.rb", "spec/endeca/transformer_spec.rb", "spec/endeca_spec.rb", "spec/rcov.opts", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "endeca.gemspec", "example/benchmark.rb", "example/listing.rb", "lib/class_to_proc.rb", "lib/core_ext.rb", "lib/endeca.rb", "lib/endeca/benchmarking.rb", "lib/endeca/breadcrumb.rb", "lib/endeca/breadcrumbs.rb", "lib/endeca/dimension.rb", "lib/endeca/document.rb", "lib/endeca/document_collection.rb", "lib/endeca/logging.rb", "lib/endeca/map.rb", "lib/endeca/readers.rb", "lib/endeca/refinement.rb", "lib/endeca/request.rb", "lib/endeca/transformer.rb", "spec/core_ext_spec.rb", "spec/endeca/benchmarking_spec.rb", "spec/endeca/breadcrumb_spec.rb", "spec/endeca/dimension_spec.rb", "spec/endeca/document_collection_spec.rb", "spec/endeca/document_spec.rb", "spec/endeca/map_spec.rb", "spec/endeca/readers_spec.rb", "spec/endeca/refinement_spec.rb", "spec/endeca/request_spec.rb", "spec/endeca/transformer_spec.rb", "spec/endeca_spec.rb", "spec/rcov.opts", "spec/spec.opts", "spec/spec_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/primedia/endeca-ruby}
   s.rdoc_options = ["--main", "README.rdoc"]

data/lib/endeca/benchmarking.rb

@@ -0,0 +1,18 @@
+require 'benchmark'
+
+module Endeca
+  module Benchmarking
+    # Log and benchmark the workings of a single block. Will only be called if
+    # Endeca.debug and Endeca.benchmark are true.
+    def bm(title)
+      if Endeca.debug && Endeca.logger && Endeca.benchmark
+        result = nil
+        ms = ::Benchmark.ms { result = yield }
+        Endeca.logger.debug("#{title}#{'%.1f' % ms}ms")
+        result
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/endeca/breadcrumb.rb

@@ -0,0 +1,42 @@
+module Endeca
+  
+  class Breadcrumb
+    extend Readers
+
+    def self.create(raw)
+      name = raw['Type']
+      breadcrumb_class = self
+
+      if name    
+        unless Breadcrumbs.include?(name)
+          raise Breadcrumbs::TypeError, "Unknown breadcrumb type: #{name.inspect}" 
+        end
+        breadcrumb_class = Breadcrumbs[name]
+      end
+
+      breadcrumb_class.new(raw)
+    end
+    
+    def self.to_proc
+      proc(&method(:create))
+    end
+
+    attr_reader :raw
+    def initialize(raw={})
+      @raw = raw
+    end
+    alias_method :attributes, :raw
+    
+    reader 'Type' => :type    
+    def name; '' end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def inspect
+      "#<#{self.class}=0x#{self.object_id.to_s(16)} name=#{name.inspect}>"
+    end
+
+  end
+end

data/lib/endeca/breadcrumbs.rb

@@ -0,0 +1,13 @@
+module Endeca
+  module Breadcrumbs
+    class TypeError < StandardError; end
+    
+    def self.include?(klass)
+      self.const_defined?(klass)
+    end
+    
+    def self.[](klass)
+      self.const_get(klass)
+    end
+  end
+end

data/lib/endeca/logging.rb

@@ -0,0 +1,9 @@
+module Endeca
+  module Logging
+    # Log and benchmark the workings of a single block. Will only be called if
+    # Endeca.benchmark is true
+    def log(message)
+      Endeca.logger.debug(message) if Endeca.debug && Endeca.logger
+    end
+  end
+end

data/lib/endeca.rb

@@ -25,7 +25,7 @@ module Endeca
   extend Logging
 
   # :stopdoc:
-  VERSION = '0.9.23'
+  VERSION = '0.9.24'
   # :startdoc:
 
   # Returns the version string for the library.

data/spec/endeca/benchmarking_spec.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+describe Endeca::Benchmarking do
+  class Helper
+    extend Endeca::Benchmarking
+  end
+  describe "#benchmark" do
+    before do
+      @logger = mock('Logger')
+
+      Endeca.stub!(:logger).and_return(@logger)
+      Endeca.stub!(:debug => true, :benchmark => true)
+
+      Benchmark.stub!(:ms => 1)
+    end
+
+    it "should log the title and the time to the Endeca logger" do
+      @logger.should_receive(:debug).with("title => 1.0ms")
+      Endeca.bm("title => "){ 1 }
+    end
+  end
+end

data/spec/endeca/breadcrumb_spec.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+module Endeca
+  module Breadcrumbs
+    class Navigation < Endeca::Breadcrumb
+    end
+  end
+end
+
+describe Endeca::Breadcrumb do
+  before do
+    @dimension_value = {
+      "DimValueID"   => "4343565665",
+      "RemovalLink"  => "N=",
+      "DimValueName" => "Apartment"
+    }
+    
+    @navigation_hash = { 
+      "Type"                 => "Navigation",
+      "DimensionName"        => "property type", 
+      "DimensionRemovalLink" => "N=", 
+      "DimensionValues"      => [@dimension_value] 
+    }
+
+    @dimensions = { "Dimensions" => [@navigation_hash] }
+    @breadcrumb = Endeca::Breadcrumb.new( @dimensions )
+  end
+  
+  describe ".create" do
+    before do
+      @navigation = Endeca::Breadcrumb.create(@navigation_hash)
+    end
+    
+    it "should create a breadcrumb of the appropriate type" do
+      Endeca::Breadcrumb.create(@navigation_hash).
+        should be_a_kind_of(Endeca::Breadcrumbs::Navigation)
+    end
+    
+    describe "with an invalid type" do
+      it do
+        creating_invalid_breadcrumb = lambda{Endeca::Breadcrumb.create({'Type' => 'Invalid'})}
+        creating_invalid_breadcrumb.should raise_error(Endeca::Breadcrumbs::TypeError)
+      end
+    end
+  end
+  
+  describe ".to_proc" do
+    it "should call create" do
+      Endeca::Breadcrumb.should_receive(:create).with(:obj)
+      [:obj].map(&Endeca::Breadcrumb)
+    end
+  end
+
+  describe '#==' do
+    it "should compare Breadcrumbs by name" do
+      doc_1, doc_2 = Endeca::Breadcrumb.new, Endeca::Breadcrumb.new
+      doc_1.stub!(:name).and_return('property type')
+      doc_2.stub!(:name).and_return('property type')
+      (doc_1 == doc_2).should be_true
+
+      doc_2.stub!(:name).and_return('something else')
+      (doc_1 == doc_2).should be_false
+    end
+  end
+
+  describe '#inspect' do
+    it "includes the class name" do
+      @breadcrumb.inspect.should include(Endeca::Breadcrumb.name)
+    end
+
+    it "includes the hex string of the object id" do
+      @breadcrumb.inspect.should include("0x#{@breadcrumb.object_id.to_s(16)}")
+    end
+
+    it "includes the inspected name" do
+      @breadcrumb.stub!(:name).and_return('A Name')
+      @breadcrumb.inspect.should include('name="A Name"')
+    end
+  end
+  
+  describe "#type" do
+    it "returns the Type value" do
+      Endeca::Breadcrumb.new('Type' => 'AType').type.should == 'AType'
+    end
+  end
+  
+  describe "#name" do
+    it {Endeca::Breadcrumb.new.name.should == ''}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 0.9.23
+  version: 0.9.24
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -42,15 +42,21 @@ files:
 - lib/class_to_proc.rb
 - lib/core_ext.rb
 - lib/endeca.rb
+- lib/endeca/benchmarking.rb
+- lib/endeca/breadcrumb.rb
+- lib/endeca/breadcrumbs.rb
 - lib/endeca/dimension.rb
 - lib/endeca/document.rb
 - lib/endeca/document_collection.rb
+- lib/endeca/logging.rb
 - lib/endeca/map.rb
 - lib/endeca/readers.rb
 - lib/endeca/refinement.rb
 - lib/endeca/request.rb
 - lib/endeca/transformer.rb
 - spec/core_ext_spec.rb
+- spec/endeca/benchmarking_spec.rb
+- spec/endeca/breadcrumb_spec.rb
 - spec/endeca/dimension_spec.rb
 - spec/endeca/document_collection_spec.rb
 - spec/endeca/document_spec.rb