michael-ken 0.0.1 → 0.0.2

data/spec/integration/ken_spec.rb

@@ -0,0 +1,34 @@
+require 'pathname'
+
+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
+  
+  describe "Ken.get('/en/the_police')" do
+    it 'should return a Ken::Resource' do
+      the_police = Ken.get("/en/the_police")
+      the_police.should be_kind_of(Ken::Resource)
+    end
+  end
+  
+  describe "Ken::Resource" do
+    before :all do
+      @the_police = Ken.get("/en/the_police")
+    end
+    
+    it "should provide attributes" do
+      @the_police.attributes.should have_at_least(1).items
+      @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
+      @the_police.views.first.should be_kind_of(Ken::View)
+      @the_police.views.first.type.should be_kind_of(Ken::Type)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,40 @@
 require 'pathname'
 require 'rubygems'
 require 'spec'
+require 'json'
 
 SPEC_ROOT = Pathname(__FILE__).dirname.expand_path
 require SPEC_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
+
+# this will append a <br /> to every logged message, which produces
+# nicely formatted DataMapper debug outputs in Textmate's RSpec Bundle's output
+module Ken
+  class Logger
+    def prep_msg(message, level)
+      level << delimiter << message << "<br/>"
+    end
+  end
+end
+
+# debugging helper (textmate rspec bundle)
+# TODO remove before release
+ESCAPE_TABLE = { '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;', '"'=>'&quot;', "'"=>'&#039;', }
+def h(value)
+ value.to_s.gsub(/[&<>"]/) {|s| ESCAPE_TABLE[s] }
+end
 
 Spec::Runner.configure do |config|
   config.after(:all) do
-
+    
   end
 end

data/spec/unit/attribute_spec.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Ken::Attribute do
+  before :all do
+    Ken::Logger.new(STDOUT, :info)
+    Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+    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[11] # /music/artist/origin
+    @non_unique_value_attribute = @the_police.attributes[8] # /common/topic/alias
+    @non_unique_object_attribute = @the_police.attributes[4] # /music/artist/album
+  end
+  
+  it "should have values" do
+    @attribute.values.should_not be_nil
+  end
+  
+  describe "with unique value type" do
+    it "should be unique and no object_type" do
+      @unique_value_attribute.unique?.should == true
+      @unique_value_attribute.object_type?.should == false
+    end
+  end
+  
+  describe "with unique object type" do
+    it "be unique and an object type" do
+      @unique_object_attribute.unique?.should == true
+      @unique_object_attribute.object_type?.should == true
+    end
+  end
+  
+  describe "with non-unique value type" do
+    it "be unique and an object type" do
+      @non_unique_value_attribute.unique?.should == false
+      @non_unique_value_attribute.object_type?.should == false
+    end
+  end
+  
+  describe "with non-unique object type" do
+    it "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
+

data/spec/unit/property_spec.rb

@@ -0,0 +1,30 @@
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Ken::Property do
+  before :all do
+    Ken::Logger.new(STDOUT, :info)
+    # Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+    data = load_fixture('music_artist')
+    @type = Ken::Type.new(data)
+    @value_property = @type.properties[1]
+    @object_property = @type.properties[3]
+  end
+    
+  it 'should be a valid property instance' do
+    @value_property.should be_kind_of(Ken::Property)
+    @object_property.should be_kind_of(Ken::Property)
+  end
+  
+  it 'should have a type' do
+    @value_property.type.should be_kind_of(Ken::Type)
+    @object_property.type.should be_kind_of(Ken::Type)
+  end
+  
+  it '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
+

data/spec/unit/resource_spec.rb

@@ -0,0 +1,63 @@
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Ken::Resource do
+  
+  before :each do
+    Ken::Logger.new(STDOUT, :info)
+    # Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+    data = load_fixture('the_police')
+    @the_police = Ken::Resource.new(data)
+  end
+  
+  it 'should have types' do
+    @the_police.types.should have_at_least(1).items
+    @the_police.types.first.should be_kind_of(Ken::Type)
+  end
+  
+  it 'should have views' do
+    @the_police.views.should have(6).items
+    @the_police.views.first.should be_kind_of(Ken::View)
+    @the_police.views.first.type.should be_kind_of(Ken::Type)
+  end
+  
+  it 'should have an id and a name' do
+    @the_police.id.should be_kind_of(::String)
+    @the_police.name.should be_kind_of(::String)
+  end
+  
+  it 'should have attributes' do
+    @the_police.attributes.should_not be_nil
+  end
+  
+  it 'should deal with non-unique value type attributes' do
+    pending
+  end
+  
+  it 'should deal with unique object type attributes' do
+    pending
+  end
+  
+  it 'should deal with non-unique object type attributes' do
+    pending
+  end
+  
+  it 'should load attributes only on demand' do
+    @the_police.attributes_loaded?.should == false
+    @the_police.attributes
+    @the_police.attributes_loaded?.should == true
+  end
+  
+  it '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
+  
+  it '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

data/spec/{session_spec.rb → unit/session_spec.rb}

@@ -1,9 +1,7 @@
 require 'pathname'
-
-require Pathname(__FILE__).dirname.expand_path + 'spec_helper'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
 
 describe Ken::Session do
-
   before :all do
     Ken::Logger.new(STDOUT, :info)
     Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')

data/spec/unit/type_spec.rb

@@ -0,0 +1,21 @@
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Ken::Type do
+  before :all do
+    Ken::Logger.new(STDOUT, :info)
+    Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
+
+    # fetch a type
+    @type = Ken.get("/en/the_police").types.first
+  end
+    
+  it 'should have an id and a name' do
+    puts @type.id
+  end
+  
+  it 'should have properties' do
+    @type.properties.should have_at_least(1).items
+  end
+end

data/spec/unit/view_spec.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe Ken::View do
+  before :all do
+    Ken::Logger.new(STDOUT, :info)
+    data = load_fixture('the_police')
+    @the_police = Ken::Resource.new(data)
+    
+    @view = @the_police.views.first
+  end
+  
+  it "should have a type" do
+    @view.type.should_not be_nil
+  end
+  
+  it "should have properties" do
+    @view.properties.should_not be_nil
+  end
+  
+  it "should have attributes" do
+    @view.properties.should_not be_nil
+  end
+end
+

data/tasks/gemspec.rb

@@ -0,0 +1,23 @@
+desc "Generate gemspec"
+task :gemspec do |x|
+  # Clean up extraneous files before checking manifest
+  %x[rake clean]
+ 
+  # Check the manifest before generating the gemspec
+  manifest = %x[rake check_manifest]
+  manifest.gsub!("(in /usr/local/projects/dm/dm-core)\n", "")
+ 
+  unless manifest.empty?
+    print "\n", "#"*68, "\n"
+    print <<-EOS
+  Manifest.txt is not up-to-date. Please review the changes below.
+  If the changes are correct, run 'rake check_manifest | patch'
+  and then run this command again.
+EOS
+    print "#"*68, "\n\n"
+    puts manifest
+  else
+    %x[rake debug_gem > #{GEM_NAME}.gemspec]
+    puts "Successfully created gemspec for #{GEM_NAME}!"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: michael-ken
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Aufreiter
@@ -35,31 +35,40 @@ extra_rdoc_files:
 - TODO
 - History.txt
 files: 
-- .gitignore
 - History.txt
 - LICENSE
 - Manifest.txt
 - README.txt
+- README.textile
 - Rakefile
 - TODO
-- ken.gemspec
+- examples/artist.rb
 - lib/ken.rb
+- lib/ken/attribute.rb
 - lib/ken/collection.rb
 - lib/ken/logger.rb
 - lib/ken/property.rb
 - lib/ken/resource.rb
 - lib/ken/session.rb
 - lib/ken/type.rb
+- lib/ken/util.rb
 - lib/ken/version.rb
-- spec/mql_spec.rb
-- spec/property_spec.rb
-- spec/resource_spec.rb
-- spec/session_spec.rb
+- lib/ken/view.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
+- spec/integration/ken_spec.rb
+- spec/fixtures/music_artist.json
+- spec/fixtures/the_police.json
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/hoe.rb
 - tasks/install.rb
 - tasks/spec.rb
+- tasks/gemspec.rb
 has_rdoc: true
 homepage: http://github.com/michael/ken
 post_install_message: 

data/.gitignore

@@ -1,14 +0,0 @@
-*.log
-log/*
-pkg/*
-doc
-cov
-pkg
-.DS_Store
-coverage.html
-coverage/*
-*.db
-\#*
-_Yardoc
-.yardoc
-tmp/*

data/ken.gemspec

@@ -1,32 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{ken}
-  s.version = "0.0.1"
- 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Aufreiter"]
-  s.date = %q{2009-02-10}
-  s.description = %q{Ruby API for accessing Freebase}
-  s.email = ["ma [a] zive [d] at"]
-  s.extra_rdoc_files = ["README.txt", "LICENSE", "TODO", "History.txt"]
-  s.files = [".gitignore", "History.txt", "LICENSE", "Manifest.txt", "README.txt", "Rakefile", "TODO", "ken.gemspec", "lib/ken.rb", "lib/ken/collection.rb", "lib/ken/logger.rb", "lib/ken/property.rb", "lib/ken/resource.rb", "lib/ken/session.rb", "lib/ken/type.rb", "lib/ken/version.rb", "spec/mql_spec.rb", "spec/property_spec.rb", "spec/resource_spec.rb", "spec/session_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/hoe.rb", "tasks/install.rb", "tasks/spec.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://github.com/michael/ken}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{ken}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Ruby API for accessing Freebase}
- 
-  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_runtime_dependency(%q<extlib>, [">= 0"])
-    else
-      s.add_dependency(%q<extlib>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<extlib>, [">= 0"])
-  end
-end

data/spec/mql_spec.rb

@@ -1,16 +0,0 @@
-require 'pathname'
-
-require Pathname(__FILE__).dirname.expand_path + 'spec_helper'
-
-describe Ken do
-  before :all do
-    # Ken::Logger.new(STDOUT, :info)
-    Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
-  end
-  
-  it 'should return a Ken::Resource' do
-    the_police = Ken.get("/en/the_police")
-    the_police.should be_kind_of(Ken::Resource)
-  end
-  
-end

data/spec/resource_spec.rb

@@ -1,28 +0,0 @@
-require 'pathname'
-
-require Pathname(__FILE__).dirname.expand_path + 'spec_helper'
-
-describe Ken::Resource do
-  before :all do
-    Ken::Logger.new(STDOUT, :info)
-    Ken::Session.new('http://www.freebase.com', 'ma', 'xxxxx')
-
-    # fetch a resource
-    @the_police = Ken.get("/en/the_police")
-  end
-    
-  it 'should have types' do
-    @the_police.types.should have_at_least(1).items
-    @the_police.types.first.should be_kind_of(Ken::Type)
-  end
-  
-  it 'should have an id and a name' do
-    @the_police.id.should be_kind_of(::String)
-    @the_police.name.should be_kind_of(::String)
-  end
-  
-  it 'should get known attributes' do
-    # expected London
-    @the_police.read_attribute('origin').should == "London"
-  end
-end