redlander 0.5.2 → 0.5.3

data/.gitignore

@@ -18,3 +18,4 @@ tmp/
 .bundle
 .yardoc/
 doc/
+bin/

data/ChangeLog

@@ -1,3 +1,8 @@
+redlander (0.5.3)
+
+  * using crossplatform-compatible FFI (makes MacOSX happy)
+  * transaction block returns the result of block evaluation
+
 redlander (0.5.2)
 
   * UTF-8 output for Node#value

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    redlander (0.5.2)
-      ffi (~> 1.1)
+    redlander (0.5.3)
+      ffi (~> 1.3)
       xml_schema (~> 0.1.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.3)
-    ffi (1.1.2)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
+    ffi (1.3.1)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
+    rspec-mocks (2.12.1)
     xml_schema (0.1.3)
 
 PLATFORMS

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Slava Kravchenko
+Copyright (c) 2012,2013 Slava Kravchenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -0,0 +1,183 @@
+# Redlander
+
+Redlander is Ruby bindings to [Redland](http://librdf.org) library written in C,
+which is used to manipulate RDF graphs. This is an alternative implementation
+of Ruby bindings (as opposed to the official bindings), aiming to be more
+intuitive, lightweight, high-performing and as bug-free as possible.
+
+# Installing
+
+Installing Redlander is simple:
+
+    $ gem install redlander
+
+Note, that you will have to install Redland runtime library (librdf) for Redlander to work.
+
+# Usage
+
+This README outlines most obvious use cases.
+For more details please refer to YARD documentation of Redlander.
+
+To start doing anything useful with Redlander, you need to initialize a model first:
+
+    $ m = Redlander::Model.new
+
+This creates a model where all RDF statements are stored in the memory.
+Depending on the selected storage you may need to supply extra parameters
+like `:user` or `:password`. Look-up the options for `Model.initialize`
+for the list of available options.
+Naturally, you don't need to create a model if you just want to play around
+with independent statements, nodes and the like.
+
+## RDF Statements
+
+Now that you have created a model, you can access its RDF statements:
+
+    $ m.statements
+
+Most of Redlander functionality is accessable via these statements.
+The API is almost identical to [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord):
+
+    $ s = URI.parse('http://example.com/concepts#subject')
+    $ p = URI.parse('http://example.com/concepts#label')
+    $ o = "subject!"
+    $ m.statements.create(:subject => s, :predicate => p, :object => o)
+
+    $ m.statements.empty?  # => false
+
+    $ st = Redlander::Statement.new(:subject => s, :predicate => p, :object => "another label")
+    $ m.statements.add(st)
+
+    $ m.statements.size    # => 2
+
+    $ m.statements.each { |st| puts st }
+
+Finding statements:
+
+    $ m.statements.find(:first, :object => "subject!")
+    $ m.statements.all(:object => "another label")
+    $ m.statements.each(:object => "subject!") { |statement|
+        puts statement.subject
+      }
+
+Note that `m.statements.each` is "lazy", while `m.statements.all` (and other finders) is not.
+
+You can access the subject, predicate or object of a statement:
+
+    $ m.statements.first.subject  # => (Redlander::Node)
+
+Please refer to `Redlander::Node` API doc for details.
+
+You can also use different query languages supported by [librdf](http://librdf.org/)
+("SPARQL 1.0" being a default):
+
+    $ m.query("SELECT ?s ?p ?o WHERE {}")  # => [{"s" => ..., "p" => ..., "o" => ...}, ...]
+
+*ASK* queries return true/false, *SELECT* queries return arrays of binding hashes,
+*CONSTRUCT* queries return an instance of a new memory-based model comprised from
+the statements constructed by the query.
+You can also supply a block to `Model#query`, which is ignored by *ASK* queries, but
+yields the statements constructed by *CONSTRUCT* queries and yields the binding
+hash for *SELECT* queries. Binding hash values are instances of `Redlander::Node`.
+
+For query options and available query languages refer to `Model#query` documentation.
+
+
+## Parsing Input
+
+You can fill your model with statements by parsing some external sources like plain or streamed data.
+
+    $ data = File.read("data.xml")
+    $ m.from(data, :format => "rdfxml")
+
+If the input is too large, you may prefer streaming it:
+
+    $ source = URI("http://example.com/data.nt")
+    $ m.from(source, :format => "ntriples")
+
+If you want to get the data from a local file, you can use "file://" schema for your URI
+or use `from_file` method with a local file name (without schema):
+
+    $ m.from_file("../data.ttl", :format => "turtle")
+
+Most frequently used parsing methods are aliased to save you some typing:
+`from_rdfxml`, `from_ntriples`, `from_turtle`, `from_uri/from_file`.
+
+Finally, you can filter the parsed input to prevent certain statements from getting into your model:
+
+    $ m.from_turtle(data) do |statement|
+        statement.object.value == "good"
+      end
+
+If the block returns `false`, the statement will not be added to the model.
+The above example will add only statements having "literal" objects with a value of "good".
+
+
+## Serializing Model
+
+Naturally, you can convert your model into a portable syntax:
+
+    $ m.to(:format => "rdfxml") # => RDF/XML output
+
+There are aliases as well: `to_rdfxml`, `to_dot`, etc.
+
+You can also dump the output directly into a local file:
+
+    $ m.to_file("data.nt", :format => "ntriples")
+
+
+## Transactions
+
+It is possible to wrap all changes you perform on a model in a transaction,
+if transactions are supported by the backend storage. If they are not supported,
+all changes will be instantaneous.
+
+    $ m.transaction { m.statements.delete_all }
+
+There are also dedicated methods to start, commit and rollback a transaction,
+should you not be able to explicitly wrap your changes in a block:
+
+    $ m.transaction_start
+    $ m.delete_all
+    $ if lucky?
+        m.transaction_commit
+      else
+        m.transaction_rollback
+      end
+
+All the above methods have their "banged" counterparts (`transaction_start!`,
+`transaction_commit!` and `transaction_rollback!`) that would raise `RedlandError`
+in case of an error.
+
+
+# Exceptions
+
+If anything unexpected happens, Redlander raises `RedlandError`.
+
+
+# Known Issues
+
+> Fixed in `redland-1.0.15`: [0000478](http://bugs.librdf.org/mantis/view.php?id=478)
+
+All Enumerator-based aggregation methods of `Redlander::ModelProxy`
+return invalid results - they are all copies of the last found statement.
+For example,
+
+    $ model.statements.to_a
+
+returns statement copies, while
+
+    $ model.statements.each { ... }
+
+yields proper results in the block.
+Update your `redland` library to 1.0.15 or newer to fix this.
+
+
+# Authors and Contributors
+
+[Slava Kravchenko](https://github.com/cordawyn)
+
+
+# Thanks
+
+Thanks goes to Dave Beckett, the creator of Redland!

data/lib/redland.rb

@@ -5,8 +5,9 @@ module Redland
   if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby'
     require 'ffi'
     extend FFI::Library
-    ffi_lib "rdf.so.0"
+    ffi_lib "rdf"
   else
+    # TODO: This might be outdated already, check with Rubinius
     extend FFI::Library
     ffi_lib "librdf.so.0"
   end

data/lib/redlander/model.rb

@@ -131,8 +131,9 @@ module Redlander
     def transaction
       if block_given?
         transaction_start
-        yield
+        result = yield
         transaction_commit
+        result
       end
     rescue
       transaction_rollback

data/lib/redlander/version.rb

@@ -1,4 +1,4 @@
 module Redlander
   # Redlander version number
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/redlander.gemspec

@@ -17,12 +17,12 @@ HERE
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  # gem.add_dependency("librdf0", "~> 1.0.14")
+  # gem.add_dependency("librdf0", "~> 1.0.15")
   gem.add_dependency("xml_schema", "~> 0.1.3")
-  gem.add_dependency("ffi", "~> 1.1")
+  gem.add_dependency("ffi", "~> 1.3")
   gem.add_development_dependency("rspec", "~> 2")
 
   gem.license = "The MIT License (MIT)"
-  gem.extra_rdoc_files = ['README.rdoc', 'ChangeLog']
+  gem.extra_rdoc_files = ['README.md', 'ChangeLog']
   gem.has_rdoc = false
 end

data/spec/lib/redlander/model_spec.rb

@@ -171,6 +171,39 @@ describe Model do
 
         it { should be_nil }
       end
+
+      context "for all matching statements" do
+        subject { model.statements.find(:all, @conditions) }
+
+        before do
+          @another_statement =
+            model.statements.create(statement_attributes.merge(:subject => URI.parse('http://example.com/concepts#another_subject')))
+        end
+
+        context "with empty conditions" do
+          before { @conditions = {} }
+
+          it { should eql [@statement, @another_statement] }
+        end
+
+        context "with one matching statement" do
+          before { @conditions = {:subject => @statement.subject} }
+
+          it { should eql [@statement] }
+        end
+
+        context "with all matching statements" do
+          before { @conditions = {:object => @statement.object} }
+
+          it { should eql [@statement, @another_statement] }
+        end
+
+        context "with no matching statements" do
+          before { @conditions = {:object => "no match"} }
+
+          it { should be_empty }
+        end
+      end
     end
 
     context "when checked for existance" do
@@ -373,6 +406,10 @@ describe Model do
                    :librdf_model_transaction_rollback => 0)
     end
 
+    it "should return the output of the block evaluation" do
+      subject.transaction { 3+7 }.should eql(10)
+    end
+
     context "when start fails" do
       before { Redland.stub(:librdf_model_transaction_start => -1) }
 

metadata

@@ -1,49 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: redlander
 version: !ruby/object:Gem::Version
-  version: 0.5.2
   prerelease: 
+  version: 0.5.3
 platform: ruby
 authors:
 - Slava Kravchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: xml_schema
-  requirement: &20744320 !ruby/object:Gem::Requirement
-    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.3
-  type: :runtime
-  prerelease: false
-  version_requirements: *20744320
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: &21431040 !ruby/object:Gem::Requirement
     none: false
+  name: xml_schema
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.1.3
+    none: false
+- !ruby/object:Gem::Dependency
   type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  name: ffi
   prerelease: false
-  version_requirements: *21431040
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &21430560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
     none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
-  type: :development
+    none: false
+  name: rspec
   prerelease: false
-  version_requirements: *21430560
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+    none: false
 description: ! 'Redlander is Ruby bindings to Redland library (see http://librdf.org)
   written in C, which is used to manipulate RDF graphs. This is an alternative implementation
   of Ruby bindings (as opposed to the official bindings), aiming to be more intuitive,
@@ -55,7 +70,7 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - ChangeLog
 files:
 - .gitignore
@@ -63,7 +78,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/redland.rb
 - lib/redlander.rb
@@ -95,20 +110,26 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 202030683622946567
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 202030683622946567
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Advanced Ruby bindings for Redland runtime library (librdf).

data/README.rdoc

@@ -1,151 +0,0 @@
-= Redlander
-
-Redlander is Ruby bindings to Redland library (see http://librdf.org) written in C, which is used to manipulate RDF graphs. This is an alternative implementation of Ruby bindings (as opposed to the official bindings), aiming to be more intuitive, lightweight, high-performing and as bug-free as possible.
-
-= Installing
-
-Installing Redlander is simple:
-
-  $ gem install redlander
-
-Note, that you will have to install Redland runtime library (librdf) for Redlander to work.
-
-= Usage
-
-This README outlines most obvious use cases. For more details please refer to YARD documentation of Redlander.
-
-To start doing anything useful with Redlander, you need to initialize a model first:
-
-  $ m = Redlander::Model.new
-
-This creates a model where all RDF statements are stored in the memory. Depending on the selected storage you may need to supply extra parameters like :user or :password. Look-up the options for Model.initialize for the list of available options.
-Naturally, you don't need to create a model if you just want to play around with independent statements, nodes and the like.
-
-== RDF Statements
-
-Now that you have created a model, you can access its RDF statements:
-
-  $ m.statements
-
-Most of Redlander functionality is accessable via these statements. The API is almost identical to ActiveRecord:
-
-  $ s = URI.parse('http://example.com/concepts#subject')
-  $ p = URI.parse('http://example.com/concepts#label')
-  $ o = "subject!"
-  $ m.statements.create(:subject => s, :predicate => p, :object => o)
-
-  $ m.statements.empty?  # => false
-
-  $ st = Redlander::Statement.new(:subject => s, :predicate => p, :object => "another label")
-  $ m.statements.add(st)
-
-  $ m.statements.size    # => 2
-
-  $ m.statements.each { |st| puts st }
-
-Finding statements:
-
-  $ m.statements.find(:first, :object => "subject!")
-  $ m.statements.all(:object => "another label")
-  $ m.statements.each(:object => "subject!") { |statement|
-      puts statement.subject
-    }
-
-Note that "m.statements.each" is "lazy", while "m.statements.all" (and other finders) is not.
-
-You can access the subject, predicate or object of a statement:
-
-  $ m.statements.first.subject  # => (Redlander::Node)
-
-Please refer to Redlander::Node API doc for details.
-
-You can also use different query languages supported by librdf ("SPARQL 1.0" being a default):
-
-  $ m.query("SELECT ?s ?p ?o WHERE {}")  # => [{"s" => ..., "p" => ..., "o" => ...}, ...]
-
-"ASK" queries return true/false, "SELECT" queries return arrays of binding hashes,
-"CONSTRUCT" queries return an instance of a new memory-based model comprised from
-the statements constructed by the query.
-You can also supply a block to Model#query, which is ignored by ASK queries, but
-yields the statements constructed by CONSTRUCT queries and yields the binding
-hash for SELECT queries. Binding hash values are instances of Redlander::Node.
-
-For query options and available query languages refer to Model#query documentation.
-
-
-== Parsing Input
-
-You can fill your model with statements by parsing some external sources like plain or streamed data.
-
-  $ data = File.read("data.xml")
-  $ m.from(data, :format => "rdfxml")
-
-If the input is too large, you may prefer streaming it:
-
-  $ source = URI("http://example.com/data.nt")
-  $ m.from(source, :format => "ntriples")
-
-If you want to get the data from a local file, you can use "file://" schema for your URI
-or use "from_file" method with a local file name (without schema):
-
-  $ m.from_file("../data.ttl", :format => "turtle")
-
-Most frequently used parsing methods are aliased to save you some typing:
-"from_rdfxml", "from_ntriples", "from_turtle", "from_uri/from_file".
-
-Finally, you can filter the parsed input to prevent certain statements from getting into your model:
-
-  $ m.from_turtle(data) do |statement|
-      statement.object.value == "good"
-    end
-
-If the block returns "false", the statement will not be added to the model.
-The above example will add only statements having "literal" objects with a value of "good".
-
-== Serializing Model
-
-Naturally, you can convert your model into a portable syntax:
-
-  $ m.to(:format => "rdfxml") # => RDF/XML output
-
-There are aliases as well: "to_rdfxml", "to_dot", etc.
-
-You can also dump the output directly into a local file:
-
-  $ m.to_file("data.nt", :format => "ntriples")
-
-== Transactions
-
-It is possible to wrap all changes you perform on a model in a transaction,
-if transactions are supported by the backend storage. If they are not supported,
-all changes will be instantaneous.
-
-  $ m.transaction { m.statements.delete_all }
-
-There are also dedicated methods to start, commit and rollback a transaction,
-should you not be able to explicitly wrap your changes in a block:
-
-  $ m.transaction_start
-  $ m.delete_all
-  $ if lucky?
-      m.transaction_commit
-    else
-      m.transaction_rollback
-    end
-
-All the above methods have their "banged" counterparts ("transaction_start!",
-"transaction_commit!" and "transaction_rollback!") that would raise RedlandError
-in case of an error.
-
-
-= Exceptions
-
-If anything unexpected happens, Redlander raises RedlandError.
-
-= Authors and Contributors
-
-Slava Kravchenko <https://github.com/cordawyn>
-
-= Thanks
-
-Thanks goes to Dave Beckett, the creator of Redland!