primedia-endeca 0.9.15 → 0.9.16

data/.gitignore

@@ -0,0 +1,7 @@
+*.swp
+.swn
+.swp
+.DS_Store
+coverage/
+pkg/
+doc/

data/endeca.gemspec

@@ -1,34 +1,32 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{endeca}
-  s.version = "0.9.15"
+  s.version = "0.9.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rein Henrichs", "Andy Stone"]
-  s.date = %q{2009-02-04}
+  s.date = %q{2009-02-05}
   s.description = %q{An Endeca client library for Ruby.}
   s.email = %q{}
   s.extra_rdoc_files = ["History.txt", "Manifest.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/breadcrumb.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/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.files = [".gitignore", "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/breadcrumb.rb", "lib/endeca/breadcrumbs.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/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"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{endeca-ruby}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.2.0}
   s.summary = %q{An Endeca client library for Ruby}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bones>, [">= 2.4.0"])
+    if current_version >= 3 then
+      s.add_development_dependency(%q<bones>, [">= 2.3.1"])
     else
-      s.add_dependency(%q<bones>, [">= 2.4.0"])
+      s.add_dependency(%q<bones>, [">= 2.3.1"])
     end
   else
-    s.add_dependency(%q<bones>, [">= 2.4.0"])
+    s.add_dependency(%q<bones>, [">= 2.3.1"])
   end
 end

data/lib/endeca/breadcrumb.rb

@@ -1,21 +1,34 @@
 module Endeca
+  
   class Breadcrumb
-    extend ClassToProc
     extend Readers
 
-    reader \
-      'DimensionName' => :name,
-      'Type' => :type,
-      'DimensionRemovalLink' => :to_params
+    def self.create(raw)
+      name = raw['Type']
+      breadcrumb_class = self
 
-    reader('DimensionValues' => :dimension_values) do |values|
-      values.map(&Dimension) if values
+      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
@@ -25,9 +38,5 @@ module Endeca
       "#<#{self.class}=0x#{self.object_id.to_s(16)} name=#{name.inspect}>"
     end
 
-    def attributes
-      (@raw['Dimensions'] || []).first || {}
-    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/dimension.rb

@@ -6,7 +6,8 @@ module Endeca
 
     reader \
       "DimValueName"  => :name,
-      "SelectionLink" => :to_params
+      "SelectionLink" => :selection_link,
+      "RemovalLink"   => :removal_link
 
     integer_reader \
       "DimValueID"      => :id,
@@ -17,6 +18,10 @@ module Endeca
       @raw=raw
     end
     alias_method :attributes, :raw
+    
+    def to_params
+      selection_link || removal_link
+    end
 
     def inspect
       "#<#{self.class}=0x#{self.object_id.to_s(16)} id=#{id} name=#{name.inspect}>"

data/lib/endeca.rb

@@ -12,6 +12,7 @@ require 'endeca/map'
 require 'endeca/transformer'
 require 'endeca/dimension'
 require 'endeca/refinement'
+require 'endeca/breadcrumbs'
 require 'endeca/breadcrumb'
 require 'endeca/request'
 require 'endeca/document_collection'
@@ -20,7 +21,7 @@ require 'endeca/document'
 module Endeca
 
   # :stopdoc:
-  VERSION = '0.9.15'
+  VERSION = '0.9.16'
   # :startdoc:
 
   # Returns the version string for the library.

data/spec/endeca/breadcrumb_spec.rb

@@ -1,23 +1,54 @@
 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=",
+      "DimValueID"   => "4343565665",
+      "RemovalLink"  => "N=",
       "DimValueName" => "Apartment"
     }
-
-    dimensions = { "Dimensions" => [ 
-      { 
-        "Type" => "Navigation",
-        "DimensionName" => "property type", 
-        "DimensionRemovalLink" => "N=", 
-        "DimensionValues" => [@dimension_value] 
-      }
-     ]
+    
+    @navigation_hash = { 
+      "Type"                 => "Navigation",
+      "DimensionName"        => "property type", 
+      "DimensionRemovalLink" => "N=", 
+      "DimensionValues"      => [@dimension_value] 
     }
-    @Breadcrumb = Endeca::Breadcrumb.new( dimensions )
+
+    @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
@@ -34,25 +65,26 @@ describe Endeca::Breadcrumb do
 
   describe '#inspect' do
     it "includes the class name" do
-      @Breadcrumb.inspect.should include(Endeca::Breadcrumb.name)
+      @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)}")
+      @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"')
+      @breadcrumb.stub!(:name).and_return('A Name')
+      @breadcrumb.inspect.should include('name="A Name"')
     end
   end
-
-  it "should return to_params on the dimension removal link " do
-    @Breadcrumb.to_params.should == "N="
+  
+  describe "#type" do
+    it "returns the Type value" do
+      Endeca::Breadcrumb.new('Type' => 'AType').type.should == 'AType'
+    end
   end
-
-  it "should return an array of dimensions for dimension_values" do
-    my_dimension = Endeca::Dimension.new(@dimension_value)
-    @Breadcrumb.dimension_values.should == [my_dimension]
+  
+  describe "#name" do
+    it {Endeca::Breadcrumb.new.name.should == ''}
   end
 end

data/spec/endeca/dimension_spec.rb

@@ -8,6 +8,32 @@ describe Endeca::Dimension do
       dimension.raw.should == :raw
     end
   end
+  
+  describe "#to_params" do
+    before do
+      @dimension = Endeca::Dimension.new
+      @selection = mock('selection link')
+      @removal = mock('removal link')
+    end
+
+    describe "with a selection link" do
+      it "should return the selection link" do
+        @dimension.stub!(:selection_link => @selection_link)
+        @dimension.stub!(:removal_link => nil)
+        
+        @dimension.to_params.should == @selection_link
+      end
+    end
+    
+    describe "with a removal link" do
+      it "should return the selection link" do
+        @dimension.stub!(:selection_link => nil)
+        @dimension.stub!(:removal_link => @removal_link)
+        
+        @dimension.to_params.should == @removal_link
+      end
+    end
+  end
 
   describe "#inspect" do
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca
 version: !ruby/object:Gem::Version 
-  version: 0.9.15
+  version: 0.9.16
 platform: ruby
 authors: 
 - Rein Henrichs
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-04 00:00:00 -08:00
+date: 2009-02-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: 2.3.1
     version: 
 description: An Endeca client library for Ruby.
 email: ""
@@ -33,6 +33,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.rdoc
 files: 
+- .gitignore
 - History.txt
 - Manifest.txt
 - README.rdoc
@@ -44,6 +45,7 @@ files:
 - lib/core_ext.rb
 - lib/endeca.rb
 - lib/endeca/breadcrumb.rb
+- lib/endeca/breadcrumbs.rb
 - lib/endeca/dimension.rb
 - lib/endeca/document.rb
 - lib/endeca/document_collection.rb