activefedora-aggregation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74fb6af1b85424431bb3effb4dfa78d4db3d7760
+  data.tar.gz: f7c34ca334ebae873b5ba1167ec1d209db901be8
+SHA512:
+  metadata.gz: f85e2ecc89fad1ffc071017203b0b935086cbc08675259a8785eeee2cb9e6d1b8e86106de3aed64835b71b899057570bdaa448b2c585e02d62bce785fa0daa0f
+  data.tar.gz: 9beabc6d5def85ce0961339fdd8d51bb159989395f6f01d5758793b3a453ad266f9d9c02477cb193ad8ec948f7253ce1ac7cfeb1056d8c388ddb95594354919e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/jetty

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activefedora-aggregation.gemspec
+gemspec
+gem 'rdf-vocab', github: 'projecthydra-labs/rdf-vocab'
+gem 'byebug' unless ENV['CI']
+

data/LICENSE

@@ -0,0 +1,12 @@
+##########################################################################
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,23 @@
+# ActiveFedora::Aggregation
+
+Aggregations for ActiveFedora.
+
+### Example
+```ruby
+class GenericFile < ActiveFedora::Base
+end
+
+generic_file1 = GenericFile.create
+generic_file2 = GenericFile.create
+
+class Image < ActiveFedora::Base
+  aggregates :generic_files
+end
+
+image = Image.create
+image.generic_files = [generic_file2, generic_file1]
+image.save
+
+```
+
+Now the "generic\_files" method returns an ordered list of GenericFile objects.

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'jettywrapper'
+Jettywrapper.hydra_jetty_version = "v8.3.0"
+
+desc 'Spin up hydra-jetty and run specs'
+task ci: ['jetty:clean'] do
+  puts 'running continuous integration'
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait]= 90
+  error = Jettywrapper.wrap(jetty_params) do
+    Rake::Task['spec'].invoke
+  end
+  raise "test failures: #{error}" if error
+end
+
+
+task default: :ci

data/activefedora-aggregation.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_fedora/aggregation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activefedora-aggregation"
+  spec.version       = ActiveFedora::Aggregation::VERSION
+  spec.authors       = ["Justin Coyne"]
+  spec.email         = ["justin@curationexperts.com"]
+
+  spec.summary       = %q{Aggregations for active-fedora}
+  spec.homepage      = "http://github.org/curationexperts/activefedora-aggregation"
+  spec.license       = "APACHE2"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'active-fedora'
+  spec.add_dependency 'rdf-vocab'
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "jettywrapper"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activefedora/aggregation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_fedora/aggregation.rb

@@ -0,0 +1,21 @@
+require 'active_fedora/aggregation/version'
+require 'active_support'
+require 'active-fedora'
+require 'rdf-vocab'
+
+module ActiveFedora
+  module Aggregation
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Aggregator
+      autoload :Association
+      autoload :Proxy
+      autoload :Builder
+      autoload :ThroughAssociation
+      autoload :Reflection
+      autoload :BaseExtension
+    end
+
+    ActiveFedora::Base.extend BaseExtension
+  end
+end

data/lib/active_fedora/aggregation/aggregator.rb

@@ -0,0 +1,96 @@
+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'
+
+    def first
+      head.target
+    end
+
+    # This can be a very expensive operation. avoid if possible
+    def to_a
+      @target ||= list_of_proxies.map(&:target)
+    end
+
+    def target= (collection)
+      link_target(build_proxies(collection))
+    end
+
+    def target_ids=(object_ids)
+      link_target(build_proxies_with_ids(object_ids))
+    end
+
+    # Set the links on the nodes in the list
+    def link_target(new_proxies)
+      new_proxies.each_with_index do |proxy, idx|
+        proxy.next_id = new_proxies[idx+1].id unless new_proxies.length - 1 <= idx
+        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
+    end
+
+    # TODO clear out the old proxies (or reuse them)
+    def build_proxies(objects)
+      # need to create the proxies before we can add the links otherwise the linked to resource won't exist
+      objects.map do |object|
+        Proxy.create(id: mint_proxy_id, target: object)
+      end
+    end
+
+    # TODO clear out the old proxies (or reuse them)
+    def build_proxies_with_ids(object_ids)
+      # need to create the proxies before we can add the links otherwise the linked to resource won't exist
+      object_ids.map do |file_id|
+        Proxy.create(id: mint_proxy_id, target_id: file_id)
+      end
+    end
+
+    def target_ids
+      list_of_proxies.map(&:target_id)
+    end
+
+    # @param obj [ActiveFedora::Base]
+    def << (obj)
+      node = if persisted?
+               proxies.create(id: mint_proxy_id, target: obj, prev: tail)
+             else
+               proxies.build(id: mint_proxy_id, target: obj, prev: tail)
+             end
+      # set the old tail, if present, to have this new proxy as its next
+      self.tail.update(next: node) if tail
+      # update the tail to point at the new node
+      self.tail = node
+      # if this is the first node, set it to be the head
+      self.head = node unless head
+      reset_target!
+    end
+
+    def mint_proxy_id
+      "#{id}/#{SecureRandom.uuid}"
+    end
+
+    def self.find_or_initialize(id)
+      find(id)
+    rescue ActiveFedora::ObjectNotFoundError
+      new(id)
+    end
+
+    def reset_target!
+      @proxy_list = nil
+      @target = nil
+    end
+
+    # return the proxies in order
+    def list_of_proxies
+      @proxy_list ||= if head
+        head.as_list
+      else
+        []
+      end
+    end
+  end
+end

data/lib/active_fedora/aggregation/association.rb

@@ -0,0 +1,55 @@
+module ActiveFedora::Aggregation
+  class Association
+
+    # @param [ActiveFedora::Base] parent
+    # @param [Reflection] reflection
+    # @opts options [String] class_name name of the class in the association
+    def initialize(parent, reflection)
+      @parent = parent
+      @reflection = reflection
+    end
+
+    def klass
+      @reflection.klass
+    end
+
+    def == other
+      aggregation.to_a == other
+    end
+
+    def create(&block)
+      klass.create(&block).tap do |created|
+        aggregation << created
+      end
+      save #causes the (head/tail) pointers on the aggregation to be persisted
+    end
+
+    def save
+      aggregation.save
+    end
+
+    def target=(vals)
+      aggregation.target=(vals)
+    end
+
+    def target_ids=(vals)
+      aggregation.target_ids=(vals)
+    end
+
+    def target_ids
+      aggregation.target_ids
+    end
+
+    def aggregation
+      @aggregation ||= Aggregator.find_or_initialize(klass.uri_to_id(uri))
+    end
+
+    def first
+      aggregation.first
+    end
+
+    def uri
+      @parent.uri + '/files'
+    end
+  end
+end

data/lib/active_fedora/aggregation/base_extension.rb

@@ -0,0 +1,24 @@
+module ActiveFedora::Aggregation
+  module BaseExtension
+
+    ##
+    # Create an aggregation association on the class
+    # @example
+    #   class Image < ActiveFedora::Base
+    #     aggregates :generic_files
+    #   end
+    def aggregates(name, options={})
+      Builder.build(self, name, options)
+    end
+
+    def create_reflection(macro, name, options, active_fedora)
+      if macro == :aggregation
+        Reflection.new(macro, name, options, active_fedora).tap do |reflection|
+          add_reflection name, reflection
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/active_fedora/aggregation/builder.rb

@@ -0,0 +1,44 @@
+module ActiveFedora::Aggregation
+  class Builder < ActiveFedora::Associations::Builder::CollectionAssociation
+    self.macro = :aggregation
+
+    def build
+      reflection = super
+      configure_dependency
+      reflection
+    end
+
+    def self.define_readers(mixin, name)
+      super
+      mixin.redefine_method("#{name.to_s.singularize}_ids") do
+        association(name).ids_reader
+      end
+    end
+
+    def self.define_writers(mixin, name)
+      super
+      mixin.redefine_method("#{name.to_s.singularize}_ids=") do |ids|
+        association(name).ids_writer(ids)
+      end
+    end
+
+    private
+
+      def configure_dependency
+        define_save_dependency_method
+        model.after_save dependency_method_name
+      end
+
+      def define_save_dependency_method
+        name = self.name
+        model.send(:define_method, dependency_method_name) do
+          send(name).save
+        end
+      end
+
+      def dependency_method_name
+        "aggregator_dependent_for_#{name}"
+      end
+
+  end
+end

data/lib/active_fedora/aggregation/proxy.rb

@@ -0,0 +1,16 @@
+module ActiveFedora::Aggregation
+  class Proxy < ActiveFedora::Base
+    belongs_to :aggregator, predicate: ::RDF::Vocab::ORE.proxyIn, class_name: 'ActiveFedora::Aggregation::Proxy'
+    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'
+
+    def as_list
+      if self.next
+        [self] + self.next.as_list
+      else
+        [self]
+      end
+    end
+  end
+end

data/lib/active_fedora/aggregation/reflection.rb

@@ -0,0 +1,11 @@
+module ActiveFedora::Aggregation
+  class Reflection < ActiveFedora::Reflection::AssociationReflection
+    def association_class
+      ThroughAssociation
+    end
+
+    def collection?
+      true
+    end
+  end
+end

data/lib/active_fedora/aggregation/through_association.rb

@@ -0,0 +1,25 @@
+module ActiveFedora::Aggregation
+  class ThroughAssociation
+    def initialize(owner, reflection)
+      @owner, @reflection = owner, reflection
+    end
+
+    # has_one :aggregation
+    # has_many :generic_files, through: :aggregation
+    def reader
+      @file_association ||= Association.new(@owner, @reflection)
+    end
+
+    def writer(vals)
+      reader.target = vals
+    end
+
+    def ids_writer(vals)
+      reader.target_ids = vals
+    end
+
+    def ids_reader
+      reader.target_ids
+    end
+  end
+end

data/lib/active_fedora/aggregation/version.rb

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

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: activefedora-aggregation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Coyne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active-fedora
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdf-vocab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: jettywrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- justin@curationexperts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activefedora-aggregation.gemspec
+- 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/reflection.rb
+- lib/active_fedora/aggregation/through_association.rb
+- lib/active_fedora/aggregation/version.rb
+homepage: http://github.org/curationexperts/activefedora-aggregation
+licenses:
+- APACHE2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Aggregations for active-fedora
+test_files: []
+has_rdoc: