michael-ken 0.0.3 → 0.1.0

data/{spec/integration/ken_spec.rb → test/integration/ken_test.rb}

@@ -1,39 +1,44 @@
-require 'pathname'
+require 'test_helper'
 
-require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
-
-describe Ken do
-  before :all do
-    # Ken::Logger.new(STDOUT, :info)
-    Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
-  end
+class KenTest < Test::Unit::TestCase
+  context "Ken.get" do
+    setup do
+      Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+    end
   
-  describe "Ken.get('/en/the_police')" do
-    it "should return a Ken::Resource" do
+    should 'return a Ken::Resource' do
       the_police = Ken.get("/en/the_police")
       the_police.should be_kind_of(Ken::Resource)
     end
+    
+    should 'raise a Ken::ResourceNotFound error if id does not exist' do
+      lambda { Ken.get("/en/non_existent_resource") }.should raise_error(Ken::ResourceNotFound)
+    end
   end
   
-  describe "Ken.all" do
-    it "should return a Ken::Collection of Ken::Resources" do
+  context "Ken.all" do
+    should "return a Ken::Collection of Ken::Resources" do
       resources = Ken.all(:name => "Apple")
       resources.should be_kind_of(Ken::Collection)
       resources.first.should be_kind_of(Ken::Resource)
     end
-    
-    it "should work with a limit specified" do
+  
+    should "work with a limit specified" do
       resources = Ken.all(:name => "Apple", :limit => 3)
-      resources.should have(3).items
+      resources.length.should == 3
     end
     
-    it "should work with a type specified" do
-      resources = Ken.all(:name => "Apple", :type => "/music/album")
-      resources.should have_at_least(1).items
-      resources.each {|r| r.types.select {|t| t.id == "/music/album"}.should have(1).items }
+    should "be able to return more than 100 resources (using cursored queries) " do
+      Ken.all({:type => '/chemistry/chemical_element'}).length.should > 100
     end
     
-    it "should understand nested queries" do
+    should "work with a type specified" do
+      resources = Ken.all(:name => "Apple", :type => "/music/album")
+      resources.length.should >= 1
+      resources.each {|r| r.types.select {|t| t.id == "/music/album"}.length.should == 1 }
+    end
+      
+    should "understand nested queries" do
       query = {
         :directed_by => "George Lucas",
         :starring => [
@@ -43,26 +48,26 @@ describe Ken do
         ],
         :type => "/film/film"
       }
-      
+    
       resources = Ken.all(query)
-      resources.should have(3).items
+      resources.length.should == 3
       resources.first.name.should == "Star Wars Episode IV: A New Hope"
       resources.last.name.should == "The Star Wars Holiday Special"
     end
   end
   
-  describe "Ken::Resource" do
-    before :all do
+  context "A Ken::Resource Instance" do
+    setup do
       @the_police = Ken.get("/en/the_police")
     end
     
-    it "should provide attributes" do
-      @the_police.attributes.should have_at_least(1).items
+    should "provide attributes" do
+      @the_police.attributes.length.should >= 1
       @the_police.attributes.first.should be_kind_of(Ken::Attribute)
     end
     
-    it "should have views" do
-      @the_police.views.should have_at_least(1).items
+    should "have views" do
+      @the_police.views.length.should >= 1
       @the_police.views.first.should be_kind_of(Ken::View)
       @the_police.views.first.type.should be_kind_of(Ken::Type)
     end

data/test/test_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'pathname'
+require 'json'
+
+gem 'jnunemaker-matchy', '0.4.0'
+require 'matchy'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+TEST_ROOT = Pathname(__FILE__).dirname.expand_path
+require TEST_ROOT.parent + 'lib/ken'
+
+def load_fixture(fixture_name)
+  fname = "#{File.dirname(__FILE__)}/fixtures/#{fixture_name}.json"
+  unless File.exists?(fname)
+    open(fname, "w") do |file|
+      puts "WARNING: Fixtures could not be loaded."
+    end
+  end
+  JSON.parse open(fname,"r").read
+end
+
+class Test::Unit::TestCase
+  custom_matcher :be_nil do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be nil but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be nil but it was"
+    receiver.nil?
+  end
+  
+  custom_matcher :have do |receiver, matcher, args|
+    count = args[0]
+    something = matcher.chained_messages[0].name
+    actual = receiver.send(something).size
+    actual == count
+  end
+  
+  custom_matcher :be_true do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be true but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be true but it was"
+    receiver.eql?(true)
+  end
+  
+  custom_matcher :be_false do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be false but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be false but it was"
+    receiver.eql?(false)
+  end
+end

data/test/unit/attribute_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class AttributeTest < Test::Unit::TestCase
+  context "An Attribute instance" do
+    setup do
+      data = load_fixture('the_police')
+      @the_police = Ken::Resource.new(data)
+
+      @attribute = @unique_value_attribute = @the_police.attributes[2] # /music/artist/active_start
+      @unique_object_attribute = @the_police.attributes[12] # /music/artist/origin
+      @non_unique_value_attribute = @the_police.attributes[9] # /common/topic/alias
+      @non_unique_object_attribute = @the_police.attributes[5] # /music/artist/album
+    end
+  
+    should "should have values" do
+      @attribute.should have(1).values
+      @non_unique_object_attribute.should have(14).values
+    end
+
+    context "with unique value type" do
+      should "be unique and no object_type" do
+        @unique_value_attribute.unique?.should == true
+        @unique_value_attribute.object_type?.should == false
+      end
+    end
+    
+    context "with unique object type" do
+      should "be unique and an object type" do
+        @unique_object_attribute.unique?.should == true
+        @unique_object_attribute.object_type?.should == true
+      end
+    end
+    
+    context "with non-unique value type" do
+      should "not be unique and not an object type" do
+        @non_unique_value_attribute.unique?.should == false
+        @non_unique_value_attribute.object_type?.should == false
+      end
+    end
+    
+    context "with non-unique object type" do
+      should "be unique and an object type" do
+        @non_unique_object_attribute.unique?.should == false
+        @non_unique_object_attribute.object_type?.should == true
+      end
+    end
+  end # context
+end # AttributeTest

data/test/unit/property_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class PropertyTest < Test::Unit::TestCase
+  context "A Property instance" do
+    setup do
+      data = load_fixture('music_artist')
+      @type = Ken::Type.new(data)
+      @value_property = @type.properties[1]
+      @object_property = @type.properties[3]
+    end
+    
+    should 'be a valid property instance' do
+      @value_property.should be_kind_of(Ken::Property)
+      @object_property.should be_kind_of(Ken::Property)
+    end
+  
+    should 'have a type' do
+      @value_property.type.should be_kind_of(Ken::Type)
+      @object_property.type.should be_kind_of(Ken::Type)
+    end
+  
+    should 'distinguish wheter it is an object or value type' do
+      @value_property.object_type?.should == false
+      @object_property.object_type?.should == true
+    end
+  end # context
+end # PropertyTest

data/test/unit/resource_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class ResourceTest < Test::Unit::TestCase
+  context "A Resource instance" do
+    setup do
+      data = load_fixture('the_police')
+      @the_police = Ken::Resource.new(data)
+    end
+  
+    should "have types" do
+      @the_police.should have(6).types
+      @the_police.types.first.should be_kind_of(Ken::Type)
+    end
+    
+    should "have views" do
+      @the_police.should have(6).views
+      @the_police.views.first.should be_kind_of(Ken::View)
+      @the_police.views.first.type.should be_kind_of(Ken::Type)
+    end
+    
+    should 'have a full set of attributes' do
+      @the_police.attributes.should_not be_nil
+    end
+    
+    should "have id and name properties" do
+      @the_police.id.should be_kind_of(String)
+      @the_police.name.should be_kind_of(String)
+    end
+    
+    should 'load attributes only on demand' do
+      @the_police.attributes_loaded?.should == false
+      @the_police.attributes
+      @the_police.attributes_loaded?.should == true
+    end
+    
+    should 'load schema only on demand when calling types' do
+      @the_police.schema_loaded?.should == false
+      @the_police.types
+      @the_police.schema_loaded?.should == true
+    end
+
+    should 'load schema only on demand when calling views' do
+      @the_police.schema_loaded?.should == false
+      @the_police.views
+      @the_police.schema_loaded?.should == true
+    end
+  end # context
+end # ResourceTest

data/test/unit/session_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class SessionTest < Test::Unit::TestCase
+  context "A Session instance" do
+    setup do
+      Ken::Logger.new(STDOUT, :info)
+      Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+    end
+
+    should 'return the correct set of types' do
+      result = Ken.session.mqlread({:id => "/en/the_police", :type => []})
+      result['type'].length.should == 6
+    end
+
+    should 'raise a Ken::MqlReadError if node does not exist' do
+      lambda { Ken.session.mqlread({:id => "/en/the_police", :evil_property => []}) }.should raise_error(Ken::ReadError)
+    end
+    
+    should 'do uncursored queries' do
+      Ken.session.mqlread([{:type => '/chemistry/chemical_element'}]).length == 100
+    end
+    
+    should 'do cursored queries' do
+      Ken.session.mqlread([{:type => '/chemistry/chemical_element'}], :cursor => true).length.should >= 117
+    end
+  end # context
+end # SessionTest

data/test/unit/type_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class TypeTest < Test::Unit::TestCase
+  context "A Session instance" do
+    setup do
+      data = load_fixture('the_police')
+      @type = Ken::Resource.new(data).types.first
+    end
+  
+    should 'have an id and a name' do
+      @type.id.should be_kind_of(String)
+      @type.name.should be_kind_of(String)
+    end
+
+    should 'have properties' do
+      @type.should have(16).properties
+    end
+    
+    context "when accessing a property directly" do
+      setup do
+        @genre = @type.genre
+        @album = @type.album
+      end
+      
+      should "be kind of Ken::Property" do
+        @genre.should be_kind_of(Ken::Property)
+        @album.should be_kind_of(Ken::Property)
+      end
+      
+      should "raise AttributeNotFound when invalid propertyname is supplied" do
+        lambda { @type.not_existing_property }.should raise_error(Ken::PropertyNotFound)
+      end
+    end # context
+  end # context
+end # TypeTest

data/test/unit/view_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+class ViewTest < Test::Unit::TestCase
+  context "A View instance" do
+    setup do
+      Ken::Logger.new(STDOUT, :info)
+      data = load_fixture('the_police')
+      @the_police = Ken::Resource.new(data)
+      @view = @the_police.views.first
+    end
+  
+    should "have a type" do
+      @view.type.should_not be_nil
+      @view.type.should be_kind_of(Ken::Type)
+    end
+    
+    should "have properties" do
+      @view.properties.should_not be_nil
+      @view.properties.each { |p| p.should be_kind_of(Ken::Property)}
+    end
+    
+    should "have attributes" do
+      @view.attributes.should_not be_nil
+      @view.attributes.each { |p| p.should be_kind_of(Ken::Attribute)}
+    end
+    
+    context "when accessing a direct attribute" do
+      setup do
+        @genre = @view.genre
+        @album = @view.album
+      end
+      
+      should "be kind of Ken::Attribute" do
+        @genre.should be_kind_of(Ken::Attribute)
+        @album.should be_kind_of(Ken::Attribute)
+      end
+      
+      should "be able to get values" do
+        @genre.should have(6).values
+        @album.should have(14).values
+      end
+      
+      should "raise AttributeNotFound when invalid propertyname is supplied" do
+        lambda { @view.not_existing_attribute }.should raise_error(Ken::AttributeNotFound)
+      end
+    end # context
+  end # context
+end # ViewTest

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: michael-ken
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - michael
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-14 00:00:00 -07:00
+date: 2009-07-08 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: 
 email: ma[at]zive[dot]at
 executables: []
@@ -33,6 +42,8 @@ files:
 - TODO
 - VERSION
 - examples/artist.rb
+- examples/artist_links.rb
+- ken.gemspec
 - lib/ken.rb
 - lib/ken/attribute.rb
 - lib/ken/collection.rb
@@ -42,21 +53,21 @@ files:
 - lib/ken/session.rb
 - lib/ken/type.rb
 - lib/ken/util.rb
-- lib/ken/version.rb
 - lib/ken/view.rb
-- spec/fixtures/music_artist.json
-- spec/fixtures/the_police.json
-- spec/integration/ken_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/unit/attribute_spec.rb
-- spec/unit/property_spec.rb
-- spec/unit/resource_spec.rb
-- spec/unit/session_spec.rb
-- spec/unit/type_spec.rb
-- spec/unit/view_spec.rb
+- rails/init.rb
+- tasks/ken.rb
 - tasks/spec.rb
-has_rdoc: true
+- test/fixtures/music_artist.json
+- test/fixtures/the_police.json
+- test/integration/ken_test.rb
+- test/test_helper.rb
+- test/unit/attribute_test.rb
+- test/unit/property_test.rb
+- test/unit/resource_test.rb
+- test/unit/session_test.rb
+- test/unit/type_test.rb
+- test/unit/view_test.rb
+has_rdoc: false
 homepage: http://github.com/michael/ken
 post_install_message: 
 rdoc_options: 
@@ -80,15 +91,16 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ruby API for Accessing the Freebase
 test_files: 
-- spec/integration/ken_spec.rb
-- spec/spec_helper.rb
-- spec/unit/attribute_spec.rb
-- spec/unit/property_spec.rb
-- spec/unit/resource_spec.rb
-- spec/unit/session_spec.rb
-- spec/unit/type_spec.rb
-- spec/unit/view_spec.rb
+- test/integration/ken_test.rb
+- test/test_helper.rb
+- test/unit/attribute_test.rb
+- test/unit/property_test.rb
+- test/unit/resource_test.rb
+- test/unit/session_test.rb
+- test/unit/type_test.rb
+- test/unit/view_test.rb
 - examples/artist.rb
+- examples/artist_links.rb

data/lib/ken/version.rb

@@ -1,3 +0,0 @@
-module Ken
-  VERSION = '0.0.2'
-end