activefedora-aggregation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74fb6af1b85424431bb3effb4dfa78d4db3d7760
-  data.tar.gz: f7c34ca334ebae873b5ba1167ec1d209db901be8
+  metadata.gz: 7a55076e62ea008d34356dd58d2a502eb71114ab
+  data.tar.gz: 6b17d9e6891e6a8c280c7cc1edba9ab2408b8687
 SHA512:
-  metadata.gz: f85e2ecc89fad1ffc071017203b0b935086cbc08675259a8785eeee2cb9e6d1b8e86106de3aed64835b71b899057570bdaa448b2c585e02d62bce785fa0daa0f
-  data.tar.gz: 9beabc6d5def85ce0961339fdd8d51bb159989395f6f01d5758793b3a453ad266f9d9c02477cb193ad8ec948f7253ce1ac7cfeb1056d8c388ddb95594354919e
+  metadata.gz: 79a25936d708e62ee1747ee4ab26bf58b24716eab159f209a8eb5cc58231f7f96a86cdfb2e64cc55bdaf51dba9af6107e524bd4c6627f4de155ac11201688d08
+  data.tar.gz: c0f461eacfbe9437bc3950c9c0f560eea944974dc4d5bf116e3d23a4ed7e19c97d920b7df36ddff5def8ca84b47c7ba35a5ed299301c10a5831b68f65b5c6e5f

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/activefedora-aggregation.svg)](http://badge.fury.io/rb/activefedora-aggregation) [![Build Status](https://travis-ci.org/curationexperts/activefedora-aggregation.svg?branch=v0.1.0)](https://travis-ci.org/curationexperts/activefedora-aggregation)
 # ActiveFedora::Aggregation
 
 Aggregations for ActiveFedora.
@@ -7,17 +8,48 @@ Aggregations for ActiveFedora.
 class GenericFile < ActiveFedora::Base
 end
 
-generic_file1 = GenericFile.create
-generic_file2 = GenericFile.create
+generic_file1 = GenericFile.create(id: 'file1')
+generic_file2 = GenericFile.create(id: 'file2')
 
 class Image < ActiveFedora::Base
   aggregates :generic_files
 end
 
-image = Image.create
+image = Image.create(id: 'my_image')
 image.generic_files = [generic_file2, generic_file1]
 image.save
 
 ```
 
 Now the "generic\_files" method returns an ordered list of GenericFile objects.
+
+Here's what the graph looks like:
+
+```ttl
+<http://127.0.0.1:8983/fedora/rest/dev/my_image> a <http://www.w3.org/ns/ldp#RDFSource>,
+     <http://www.w3.org/ns/ldp#Container>;
+   <http://www.w3.org/ns/ldp#contains> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files>;
+   <info:fedora/fedora-system:def/model#hasModel> "Image" .
+
+<http://127.0.0.1:8983/fedora/rest/dev/my_image/files> a <http://www.w3.org/ns/ldp#RDFSource>,
+     <http://www.w3.org/ns/ldp#Container>;
+   <http://www.iana.org/assignments/relation/first> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files/5a5af870-594b-4966-93f6-0348402583f0>;
+   <http://www.iana.org/assignments/relation/last> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files/9cc70b3d-c9d7-4cfc-b504-adbcb0bdfb3d>;
+   <http://www.w3.org/ns/ldp#contains> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files/5a5af870-594b-4966-93f6-0348402583f0>,
+     <http://127.0.0.1:8983/fedora/rest/dev/my_image/files/9cc70b3d-c9d7-4cfc-b504-adbcb0bdfb3d>;
+   <info:fedora/fedora-system:def/model#hasModel> "ActiveFedora::Aggregation::ProxyContainer" .
+
+<http://127.0.0.1:8983/fedora/rest/dev/my_image/files/5a5af870-594b-4966-93f6-0348402583f0> a <http://www.w3.org/ns/ldp#RDFSource>,
+     <http://www.w3.org/ns/ldp#Container>;
+   <http://www.iana.org/assignments/relation/next> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files/9cc70b3d-c9d7-4cfc-b504-adbcb0bdfb3d>;
+   <http://www.openarchives.org/ore/terms/proxyFor> <http://127.0.0.1:8983/fedora/rest/dev/file2>;
+   <http://www.openarchives.org/ore/terms/proxyIn> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files>;
+   <info:fedora/fedora-system:def/model#hasModel> "ActiveFedora::Aggregation::Proxy" .
+
+<http://127.0.0.1:8983/fedora/rest/dev/my_image/files/9cc70b3d-c9d7-4cfc-b504-adbcb0bdfb3d> a <http://www.w3.org/ns/ldp#RDFSource>,
+     <http://www.w3.org/ns/ldp#Container>;
+   <http://www.iana.org/assignments/relation/prev> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files/5a5af870-594b-4966-93f6-0348402583f0>;
+   <http://www.openarchives.org/ore/terms/proxyFor> <http://127.0.0.1:8983/fedora/rest/dev/file1>;
+   <http://www.openarchives.org/ore/terms/proxyIn> <http://127.0.0.1:8983/fedora/rest/dev/my_image/files>;
+   <info:fedora/fedora-system:def/model#hasModel> "ActiveFedora::Aggregation::Proxy" .
+```

data/lib/active_fedora/aggregation/association.rb

@@ -14,38 +14,42 @@ module ActiveFedora::Aggregation
     end
 
     def == other
-      aggregation.to_a == other
+      container.to_a == other
     end
 
     def create(&block)
       klass.create(&block).tap do |created|
-        aggregation << created
+        container << created
       end
       save #causes the (head/tail) pointers on the aggregation to be persisted
     end
 
     def save
-      aggregation.save
+      container.save
     end
 
     def target=(vals)
-      aggregation.target=(vals)
+      container.target=(vals)
     end
 
     def target_ids=(vals)
-      aggregation.target_ids=(vals)
+      container.target_ids=(vals)
     end
 
     def target_ids
-      aggregation.target_ids
+      container.target_ids
     end
 
-    def aggregation
-      @aggregation ||= Aggregator.find_or_initialize(klass.uri_to_id(uri))
+    def container
+      @container ||= begin
+         ProxyContainer.find_or_initialize(klass.uri_to_id(uri)).tap do |container|
+           container.parent = @parent
+         end
+      end
     end
 
     def first
-      aggregation.first
+      container.first
     end
 
     def uri

data/lib/active_fedora/aggregation/builder.rb

@@ -5,6 +5,10 @@ module ActiveFedora::Aggregation
     def build
       reflection = super
       configure_dependency
+      model.has_and_belongs_to_many :proxies, predicate: ::RDF::Vocab::ORE.aggregates, class_name: 'ActiveFedora::Aggregation::Proxy', inverse_of: :containers
+      model.belongs_to :head, predicate: ::RDF::Vocab::IANA['first'], class_name: 'ActiveFedora::Aggregation::Proxy'
+      model.belongs_to :tail, predicate: ::RDF::Vocab::IANA.last, class_name: 'ActiveFedora::Aggregation::Proxy'
+
       reflection
     end
 

data/lib/active_fedora/aggregation/proxy.rb

@@ -1,10 +1,13 @@
 module ActiveFedora::Aggregation
   class Proxy < ActiveFedora::Base
-    belongs_to :aggregator, predicate: ::RDF::Vocab::ORE.proxyIn, class_name: 'ActiveFedora::Aggregation::Proxy'
+    # HABTM is actually only belongs to one
+    has_and_belongs_to_many :containers, predicate: ::RDF::Vocab::ORE.proxyIn, class_name: 'ActiveFedora::Base'
     belongs_to :target, predicate: ::RDF::Vocab::ORE.proxyFor, class_name: 'ActiveFedora::Base'
     belongs_to :next, predicate: ::RDF::Vocab::IANA.next, class_name: 'ActiveFedora::Aggregation::Proxy'
     belongs_to :prev, predicate: ::RDF::Vocab::IANA.prev, class_name: 'ActiveFedora::Aggregation::Proxy'
 
+    type ::RDF::Vocab::ORE.Proxy
+
     def as_list
       if self.next
         [self] + self.next.as_list

data/lib/active_fedora/aggregation/{aggregator.rb → proxy_container.rb}

@@ -1,11 +1,26 @@
 module ActiveFedora::Aggregation
-  class Aggregator < ActiveFedora::Base
-    has_many :proxies, predicate: ::RDF::Vocab::ORE.proxyIn, class_name: 'ActiveFedora::Aggregation::Proxy'
-    belongs_to :head, predicate: ::RDF::Vocab::IANA['first'], class_name: 'ActiveFedora::Aggregation::Proxy'
-    belongs_to :tail, predicate: ::RDF::Vocab::IANA.last, class_name: 'ActiveFedora::Aggregation::Proxy'
+  class ProxyContainer < ActiveFedora::Base
+    type ::RDF::Vocab::LDP.IndirectContainer
+
+    attr_writer :parent
+
+    property :membership_resource, predicate: ::RDF::Vocab::LDP.membershipResource
+    property :member_relation, predicate: ::RDF::Vocab::LDP.hasMemberRelation
+    property :inserted_content_relation, predicate: ::RDF::Vocab::LDP.insertedContentRelation
+
+    after_initialize :default_relations
+
+    def parent
+      @parent || raise("Parent hasn't been set on #{self.class}")
+    end
+
+    def default_relations
+      self.member_relation = [::RDF::URI.new("http://pcdm.org/hasMember")] # TODO wrong predicate!
+      self.inserted_content_relation = [::RDF::Vocab::ORE.proxyFor]
+    end
 
     def first
-      head.target
+      parent.head.target
     end
 
     # This can be a very expensive operation. avoid if possible
@@ -28,9 +43,9 @@ module ActiveFedora::Aggregation
         proxy.prev_id = new_proxies[idx-1].id unless idx == 0
       end
 
-      self.head = new_proxies.first
-      self.tail = new_proxies.last
-      self.proxies = new_proxies
+      parent.head = new_proxies.first
+      parent.tail = new_proxies.last
+      parent.proxies = new_proxies
     end
 
     # TODO clear out the old proxies (or reuse them)
@@ -56,16 +71,16 @@ module ActiveFedora::Aggregation
     # @param obj [ActiveFedora::Base]
     def << (obj)
       node = if persisted?
-               proxies.create(id: mint_proxy_id, target: obj, prev: tail)
+               parent.proxies.create(id: mint_proxy_id, target: obj, prev: parent.tail)
              else
-               proxies.build(id: mint_proxy_id, target: obj, prev: tail)
+               parent.proxies.build(id: mint_proxy_id, target: obj, prev: parent.tail)
              end
       # set the old tail, if present, to have this new proxy as its next
-      self.tail.update(next: node) if tail
+      parent.tail.update(next: node) if parent.tail
       # update the tail to point at the new node
-      self.tail = node
+      parent.tail = node
       # if this is the first node, set it to be the head
-      self.head = node unless head
+      parent.head = node unless parent.head
       reset_target!
     end
 
@@ -86,8 +101,8 @@ module ActiveFedora::Aggregation
 
     # return the proxies in order
     def list_of_proxies
-      @proxy_list ||= if head
-        head.as_list
+      @proxy_list ||= if parent.head
+        parent.head.as_list
       else
         []
       end

data/lib/active_fedora/aggregation/version.rb

@@ -1,5 +1,5 @@
 module ActiveFedora
   module Aggregation
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/active_fedora/aggregation.rb

@@ -7,7 +7,7 @@ module ActiveFedora
   module Aggregation
     extend ActiveSupport::Autoload
     eager_autoload do
-      autoload :Aggregator
+      autoload :ProxyContainer
       autoload :Association
       autoload :Proxy
       autoload :Builder

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activefedora-aggregation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -127,11 +127,11 @@ files:
 - bin/console
 - bin/setup
 - lib/active_fedora/aggregation.rb
-- lib/active_fedora/aggregation/aggregator.rb
 - lib/active_fedora/aggregation/association.rb
 - lib/active_fedora/aggregation/base_extension.rb
 - lib/active_fedora/aggregation/builder.rb
 - lib/active_fedora/aggregation/proxy.rb
+- lib/active_fedora/aggregation/proxy_container.rb
 - lib/active_fedora/aggregation/reflection.rb
 - lib/active_fedora/aggregation/through_association.rb
 - lib/active_fedora/aggregation/version.rb