active-triples 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90cd49de8c91815ff02733feaf843e01618037c8
-  data.tar.gz: c6b95f28bc6b814a6464adefc46858bba2709f71
+  metadata.gz: 134e560560581d9eb910f02fb4acfe1796a49e8c
+  data.tar.gz: 06111e25af63727d289515c461f5d648bdfbf9ff
 SHA512:
-  metadata.gz: 69f978b7d1aa618f3942acf21c99ca4c5b211d0d573a260bfe7487a3e3fa92509eb459bfaa2e915195b3249af7f0e75a5c0d571cf0b9b18f9d76ba640fcd9072
-  data.tar.gz: b13615881670aed59931f21f6d7f1b043e23dee5ee0230131b0758d1d179c7c508c4cbde35980a771bf8f989112c62091ee38ec21f57f96063ea35e51e4eeeeb
+  metadata.gz: 12bcd4d12842619f883cc042052f53e1a89bca2b6bf78f926318ebe7a6072ee3d9116ebfc56c52deceb7401694a2d3fdaaadbea7753f5348aa5e5c44e8e469c5
+  data.tar.gz: 61a6ee297b43bd909bf89f5a91ea815fdcef3dced6a8863a4f2af7b7f989ad77bc187e5140a4ea6001876d943ea8a011a126febdfa1ae97fe499746ba94c2fc1

data/.travis.yml

@@ -4,12 +4,14 @@ script: "bundle exec rspec spec"
 sudo: false
 cache: bundler
 rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.2.1
   - ruby-head
   - jruby
   - rbx-2
 matrix:
   allow_failures:
       - rvm: jruby
+      - rvm: ruby-head

data/AUTHORS

@@ -1,2 +1,2 @@
-* Tom Johnson (thomas.johnson@oregonstate.edu)
+* Tom Johnson (tom@dp.la)
 * Trey Terrell

data/CHANGES.md

@@ -1,21 +1,16 @@
-0.7.3
-----
-
-  - Optimize querying by using Graph#query instead of Queryable#query
-  - Improved error handling
-
-0.7.2
-----
-
-  - Allows interoperability between `ActiveModel::Validations` and
-    `RDF::Graph#valid?`. This fixes a bug with validation callbacks. See:
-    [#167](https://github.com/ActiveTriples/ActiveTriples/pull/167).
-
-0.7.1
-----
+0.8.0
+-----
+  - Adds RDF.rb interfaces to `RDFSource`, improving interoperability 
+  with other `ruby-rdf` packages.
+  - Introduces a defined `Persistable` interface and 
+  `PersistenceStrategies`.
+  - Changes `Relation`'s delete methods to remove all values, instead of
+  trying to maintain a predicate -> class pair on the property 
+  definitions in some cases. The previous functionality was unclear and
+  unreliable.
+  - Adds a `Schema` concept, for defining property definitions that are
+   portable across `RDFSource` types.
 
-  - Adds a Schema concept, for defining property definitions that are portable
-    across RDFSource types.
 
 0.7.0
 -----

data/Gemfile

@@ -3,3 +3,5 @@ source "https://rubygems.org"
 gemspec
 
 gem 'pry-byebug' unless ENV["CI"]
+
+gem 'rdf-spec', :github => 'ruby-rdf/rdf-spec', :branch => 'develop'

data/README.md

@@ -1,8 +1,8 @@
 Description
 -----------
 
-[![Build Status](https://travis-ci.org/ActiveTriples/ActiveTriples.png?branch=master)](https://travis-ci.org/ActiveTriples/ActiveTriples)
-[![Coverage Status](https://coveralls.io/repos/ActiveTriples/ActiveTriples/badge.png?branch=master)](https://coveralls.io/r/ActiveTriples/ActiveTriples?branch=master)
+[![Build Status](https://travis-ci.org/ActiveTriples/ActiveTriples.png?branch=develop)](https://travis-ci.org/ActiveTriples/ActiveTriples)
+[![Coverage Status](https://coveralls.io/repos/ActiveTriples/ActiveTriples/badge.svg?branch=develop)](https://coveralls.io/r/ActiveTriples/ActiveTriples?branch=develop)
 [![Gem Version](https://badge.fury.io/rb/active-triples.svg)](http://badge.fury.io/rb/active-triples)
 
 An ActiveModel-like interface for RDF data. Models graphs as RDFSources with property/attribute configuration, accessors, and other methods to support Linked Data in a Ruby/Rails enviornment. See [RDF Concepts and Abstract Syntax](http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#change-over-time) for an informal definition of an RDF Source.

data/active-triples.gemspec

@@ -8,22 +8,23 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Tom Johnson", "Trey Terrell"]
   s.homepage    = 'https://github.com/no-reply/ActiveTriples'
-  s.email       = 'thomas.johnson@oregonstate.edu'  
+  s.email       = 'tom@dp.la'
   s.summary     = %q{RDF graphs in ActiveModel wrappers.}
   s.description = %q{ActiveTriples provides tools for modeling RDF as discrete resources.}
   s.license     = "APACHE2"
   s.required_ruby_version     = '>= 1.9.3'
-  
-  s.add_dependency('rdf', '~> 1.1')
+
+  s.add_dependency('rdf', '~> 1.1.13')
   s.add_dependency('linkeddata', '~> 1.1')
   s.add_dependency('activemodel', '>= 3.0.0')
-  s.add_dependency('deprecation', '~> 1.0')
+  s.add_dependency('deprecation', '~> 0.1')
   s.add_dependency('activesupport', '>= 3.0.0')
 
   s.add_development_dependency('rdoc')
   s.add_development_dependency('rspec')
+  s.add_development_dependency('rdf-spec')
   s.add_development_dependency('coveralls')
-  s.add_development_dependency('guard-rspec') unless ENV['CI']
+  s.add_development_dependency('guard-rspec')
   s.add_development_dependency('webmock')
   s.add_development_dependency('nokogiri')
   s.add_development_dependency('pragmatic_context', '~> 0.1.2')

data/lib/active_triples.rb

@@ -2,6 +2,29 @@ require 'rdf'
 require 'active_triples/version'
 require 'active_support'
 
+##
+# An ActiveModel compliant ObjectGraphMapper for RDF data. 
+# 
+# Models graphs as `RDFSources` with property/attribute configuration, 
+# accessors, and other methods to support Linked Data in a Ruby enviornment. 
+#
+# @example modeling a simple resource
+#   class Thing
+#     include  ActiveTriples::RDFSource
+#     configure :type => RDF::OWL.Thing, :base_uri => 'http://example.org/things#'
+#     property :title, :predicate => RDF::DC.title
+#     property :description, :predicate => RDF::DC.description
+#   end
+#
+#   obj = Thing.new('123')
+#   obj.title = 'Resource'
+#   obj.description = 'A resource.'
+#   obj.dump :ntriples 
+#    # => "<http://example.org/things#123> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/2002/07/owl#Thing> .\n<http://example.org/things#123> <http://purl.org/dc/terms/title> \"Resource\" .\n<http://example.org/things#123> <http://purl.org/dc/terms/description> \"A resource.\" .\n"
+#
+# @see http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#change-over-time 
+#   RDF Concepts and Abstract Syntax for an informal definition of an RDF 
+#   Source.
 module ActiveTriples
   extend ActiveSupport::Autoload
   eager_autoload do
@@ -10,6 +33,7 @@ module ActiveTriples
     autoload :List
     autoload :Relation
     autoload :Configurable
+    autoload :Persistable
     autoload :Properties
     autoload :PropertyBuilder
     autoload :Reflection
@@ -22,18 +46,44 @@ module ActiveTriples
     autoload :Property
     autoload :ExtensionStrategy
 
-    # deprecated class
-    autoload :Term, 'active_triples/relation'
+    # persistence strategies
+    autoload :PersistenceStrategy,
+             'active_triples/persistence_strategies/persistence_strategy'
+    autoload :ParentStrategy,
+             'active_triples/persistence_strategies/parent_strategy'
+    autoload :RepositoryStrategy,
+             'active_triples/persistence_strategies/repository_strategy'
   end
-
+  
+  ##
   # Raised when a declared repository doesn't have a definition
   class RepositoryNotFoundError < StandardError
   end
 
+  ##
+  # Converts a string for a class or module into a a constant. This will find
+  # classes in or above a given container class.
+  #
+  # @example finding a class in Kernal
+  #    ActiveTriples.class_from_string('MyClass') # => MyClass
+  #
+  # @example finding a class in a module
+  #    ActiveTriples.class_from_string('MyClass', MyModule) 
+  #    # => MyModule::MyClass
+  #
+  # @example when a class exists above the module, but not in it
+  #    ActiveTriples.class_from_string('Object', MyModule) 
+  #    # => Object
+  #
+  # @param class_name [String]
+  # @param container_class
+  #
+  # @return [Class]
   def self.class_from_string(class_name, container_class=Kernel)
     container_class = container_class.name if container_class.is_a? Module
     container_parts = container_class.split('::')
-    (container_parts + class_name.split('::')).flatten.inject(Kernel) do |mod, class_name|
+    (container_parts + class_name.split('::'))
+      .flatten.inject(Kernel) do |mod, class_name|
       if mod == Kernel
         Object.const_get(class_name)
       elsif mod.const_defined? class_name.to_sym
@@ -45,6 +95,8 @@ module ActiveTriples
     end
   end
 
+  ##
+  # A simplified, Belgian version of this software
   def self.ActiveTripels
     puts <<-eos
 
@@ -61,5 +113,4 @@ module ActiveTriples
 eos
 "Yum"
   end
-
 end

data/lib/active_triples/configurable.rb

@@ -3,12 +3,14 @@ require 'deprecation'
 module ActiveTriples
   ##
   # Module to include configurable class-wide properties common to
-  # Resource and RDFDatastream. It does its work at the class level,
-  # and is meant to be extended.
+  # RDFSources.
   #
   # Define properties at the class level with:
   #
-  #    configure base_uri: "http://oregondigital.org/resource/", repository: :default
+  # @example
+  #   configure base_uri: "http://oregondigital.org/resource/",
+  #     repository: :default
+  #
   # Available properties are base_uri, rdf_label, type, and repository
   module Configurable
     extend Deprecation
@@ -28,29 +30,23 @@ module ActiveTriples
       @configuration ||= Configuration.new
     end
 
-    ##
-    # @deprecated use `configure type:` instead.
-    def rdf_type(value)
-      Deprecation.warn Configurable, "rdf_type is deprecated and will be removed in active-fedora 8.0.0. Use configure type: instead.", caller
-      configure type: value
-    end
-
     def repository
-      configuration[:repository] || :parent
+      configuration[:repository]
     end
 
     ##
-    # API for configuring class properties on a Resource. This is an 
+    # API for configuring class properties on a RDFSource. This is an
     # alternative to overriding the methods in this module.
     #
     # Can configure the following values:
-    #  - base_uri (allows passing slugs to the Resource initializer 
+    #  - base_uri (allows passing slugs to the RDFSource initializer
     #    in place of fully qualified URIs)
     #  - rdf_label (overrides default label predicates)
     #  - type (a default rdf:type to include when initializing a
-    #    new Resource)
-    #  - repository (the target persist location to for the Resource)
-    # 
+    #    new RDFSource)
+    #  - repository (the target persist location to for the RDFSource)
+    #
+    # @example
     #   configure base_uri: "http://oregondigital.org/resource/", repository: :default
     #
     # @param options [Hash]
@@ -67,7 +63,7 @@ module ActiveTriples
     def transform_type(values)
       Array(values).map do |value|
         RDF::URI.new(value).tap do |uri|
-          Resource.type_registry[uri] = self
+          RDFSource.type_registry[uri] = self
         end
       end
     end

data/lib/active_triples/list.rb

@@ -11,7 +11,7 @@ module ActiveTriples
     include Properties
     include Reflection
 
-    delegate :rdf_subject, :mark_for_destruction, :marked_for_destruction?, :set_value, :get_values, :parent, :type, :dump, :attributes=, to: :resource
+    delegate :rdf_subject, :mark_for_destruction, :marked_for_destruction?, :set_value, :get_values, :parent, :persist, :persist!, :type, :dump, :attributes=, to: :resource
     alias_method :to_ary, :to_a
 
     class << self
@@ -27,8 +27,8 @@ module ActiveTriples
 
     def initialize(*args)
       super
-      parent = graph.parent if graph.respond_to? :parent
-      @graph = ListResource.new(subject) << graph unless graph.kind_of? RDFSource
+      @graph = ListResource.new(subject) unless
+        graph.kind_of? RDFSource
       graph << parent if parent
       graph.list = self
       graph.reload
@@ -36,13 +36,10 @@ module ActiveTriples
 
     def clear
       graph.send :erase_old_resource
-      parent = graph.parent
       old_subject = subject
       super
       @subject = old_subject
       @graph = ListResource.new(subject)
-      graph << parent if parent
-      graph.parent = parent
       graph.list = self
     end
 
@@ -78,20 +75,17 @@ module ActiveTriples
       node_from_value(super)
     end
 
-    def shift
-      node_from_value(super)
-    end
-
     ##
-    # Find an AF::Rdf::Resource from the value returned by RDF::List
+    # find an AF::Rdf::Resource from the value returned by RDF::List
     def node_from_value(value)
-      if value.kind_of? RDF::Resource
-        type_uri = resource.query([value, RDF.type, nil]).to_a.first.try(:object)
-        klass = ActiveTriples::Resource.type_registry[type_uri]
-        klass ||= Resource
-        return klass.from_uri(value,resource)
-      end
-      value
+      return value unless value.is_a? RDF::Resource
+      return value if value.is_a? RDFSource
+
+      type_uri = resource.query([value, RDF.type, nil]).to_a.first.try(:object)
+      klass = RDFSource.type_registry[type_uri]
+      klass ||= Resource
+
+      klass.from_uri(value, resource)
     end
 
     ##
@@ -125,13 +119,15 @@ module ActiveTriples
       end
 
       protected
+
       # Clear out any old assertions in the repository about this node or statement
       # thus preparing to receive the updated assertions.
       def erase_old_resource
-        RDF::List.new(rdf_subject, repository).clear
+        RDF::List.new(rdf_subject, self).clear
       end
 
       private
+
         def attributes_to_list(value, klass)
           value.each do |entry|
             item = klass.new()
@@ -172,12 +168,17 @@ module ActiveTriples
       if empty?
         @graph.type = RDF.List
         resource.set_value(RDF.first, value)
-        resource.insert([subject, RDF.rest, RDF.nil])
+        resource.insert([subject.to_term, RDF.rest, RDF.nil])
         resource << value if value.kind_of? RDFSource
         return self
       end
       super
-      resource << value if value.kind_of? RDFSource
+      if value.kind_of? RDFSource
+        resource << value
+        value.set_persistence_strategy(ParentStrategy)
+        value.persistence_strategy.parent = resource
+        value.persist!
+      end
     end
   end
 end

data/lib/active_triples/persistable.rb

@@ -0,0 +1,100 @@
+module ActiveTriples
+  ##
+  # Bundles the core interfaces used by ActiveTriples persistence strategies
+  # to treat a graph as persistable. Specificially:
+  #
+  #   - RDF::Enumerable
+  #   - RDF::Mutable
+  #
+  # @abstract implement {#graph} as a reference to an `RDF::Graph` or similar.
+  module Persistable
+    extend ActiveSupport::Concern
+
+    include RDF::Enumerable
+    include RDF::Mutable
+
+    ##
+    # @see RDF::Enumerable.each
+    def each(*args)
+      graph.each(*args)
+    end
+
+    ##
+    # @see RDF::Writable.insert_statement
+    def insert_statement(*args)
+      graph.send(:insert_statement, *args)
+    end
+
+    ##
+    # @see RDF::Writable.delete_statement
+    def delete_statement(*args)
+      graph.send(:delete_statement, *args)
+    end
+
+    ##
+    # Returns the persistence strategy object that handles this object's
+    # persistence
+    def persistence_strategy
+      @persistence_strategy || set_persistence_strategy(RepositoryStrategy)
+    end
+
+    ##
+    # Sets a persistence strategy
+    #
+    # @param klass [Class] A class implementing the persistence strategy
+    #   interface
+    def set_persistence_strategy(klass)
+      @persistence_strategy = klass.new(self)
+    end
+
+    ##
+    # Removes the statements in this RDFSource's graph from the persisted graph
+    #
+    # @return [Boolean]
+    def destroy
+      persistence_strategy.destroy
+    end
+    alias_method :destroy!, :destroy
+
+    ##
+    # @return [Boolean] true if this item is destroyed
+    def destroyed?
+      persistence_strategy.destroyed?
+    end
+
+    ##
+    # Sends a persistence message to the persistence_startegy, saving the
+    # RDFSource.
+    #
+    # @return [Boolean]
+    def persist!(opts={})
+      return if @persisting
+      result = false
+      return result if opts[:validate] && !valid?
+      @persisting = true
+      run_callbacks :persist do
+        result = persistence_strategy.persist!
+      end
+      @persisting = false
+      result
+    end
+
+    ##
+    # Indicates if the resource is persisted.
+    #
+    # @see #persist
+    # @return [Boolean]
+    def persisted?
+      persistence_strategy.persisted?
+    end
+
+    ##
+    # Repopulates the graph according to the persistence strategy
+    #
+    # @return [Boolean]
+    def reload
+      @term_cache ||= {}
+      persistence_strategy.reload
+    end
+  end
+end