active_fedora-datastreams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bd06d5a97b4fd602e01da55dabd0eb63223606b
+  data.tar.gz: 5e7b41bf053c7fdd2021af984ce0a31207bdb77c
+SHA512:
+  metadata.gz: 51cb0a96ba7c135ce6454cf0b8a65b91849e8ecf0b040613a40a69628ab6c44b0cd9f4d2b14229fcb71667b4fbcc363fc7e21177cd7449073175e1f3db971062
+  data.tar.gz: 98d586bf304ed09a8c546157a44cfffb1d2db256349a97fdcc042c477f8537b95d0c5f691c6f7588a22604e5c20fe24f1dfb4dcd421220d771d74cd46da45644

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,140 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'script/**/*'
+    - 'vendor/**/*'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/unit/**/*'
+    - 'spec/integration/**/*'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/active_fedora/datastreams/nokogiri_datastreams.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/active_fedora/datastreams/nokogiri_datastreams.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/active_fedora/rdf/rdf_datastream.rb'
+    - 'lib/active_fedora/qualified_dublin_core_datastream.rb'
+    - 'spec/samples/hydra-mods_article_datastream.rb'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/PredicateName:
+  Exclude:
+    - 'lib/active_fedora/om_datastream.rb'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockEndNewline:
+  Exclude:
+    - 'spec/**/*'
+
+Style/MultilineBlockLayout:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Semicolon:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Lambda:
+  Exclude:
+    - 'spec/**/*'
+    
+Style/FileName:
+  Exclude:
+    - 'spec/samples/hydra-mods_article_datastream.rb'
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleWording:
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+    NOT: does NOT
+  IgnoredWords:
+    - only
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/**/*'
+
+RSpec/NotToNot:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jcoyne@justincoyne.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_fedora-datastreams.gemspec
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+# ActiveFedora::Datastreams
+
+Datastreams support for ActiveFedora 11. This functionality previously was a part of ActiveFedora, but has been moved here as it is not required functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_fedora-datastreams'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_fedora-datastreams
+
+## Usage
+
+To create a XML datastream extend `ActiveFedora::OmDatastream`. To create an RDF::Datastream, extend `ActiveFedora::NtriplesRDFDatastream`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_fedora-datastreams. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require 'solr_wrapper'
+require 'fcrepo_wrapper'
+require 'active_fedora/rake_support'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:ci]
+
+desc "CI build"
+task :ci do
+  ENV['environment'] = "test"
+  Rake::Task['rubocop'].invoke unless ENV['NO_RUBOCOP']
+
+  with_test_server do
+    Rake::Task['spec'].invoke
+  end
+end
+
+require 'rubocop/rake_task'
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.requires << 'rubocop-rspec'
+  task.fail_on_error = true
+end

data/active_fedora-datastreams.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_fedora/datastreams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_fedora-datastreams"
+  spec.version       = ActiveFedora::Datastreams::VERSION
+  spec.authors       = ["Justin Coyne"]
+  spec.email         = ["jcoyne@justincoyne.com"]
+
+  spec.summary       = %q{Datastreams for ActiveFedora}
+  spec.description   = %q{XML and RDF datastreams for ActiveFedora}
+  spec.homepage      = "https://github.com/projecthydra-labs/active_fedora-datastreams"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "active-fedora", ">= 11.0.0.pre", "< 12"
+  spec.add_dependency "om", "~> 3.1"
+  spec.add_dependency "nom-xml", ">= 0.5.1"
+  spec.add_dependency "rdf-rdfxml", '~> 2.0'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "solr_wrapper", "~> 0.4"
+  spec.add_development_dependency 'fcrepo_wrapper', '~> 0.2'
+  spec.add_development_dependency "rubocop", '~> 0.42'
+  spec.add_development_dependency "rubocop-rspec", '~> 1.4'
+  spec.add_development_dependency "equivalent-xml"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_fedora/datastreams"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/fedora.yml

@@ -0,0 +1,14 @@
+development:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://127.0.0.1:<%= ENV['FCREPO_DEVELOPMENT_PORT'] || 8984 %>/rest
+  base_path: /dev
+test:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://localhost:<%= ENV['FCREPO_TEST_PORT'] || 8986 %>/rest
+  base_path: /test
+production:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://127.0.0.1:8983/fedora/rest

data/config/solr.yml

@@ -0,0 +1,15 @@
+development:
+  default:
+    url: http://127.0.0.1:<%= ENV['SOLR_TEST_PORT'] || 8983 %>/solr/hydra-development
+  full_text:
+    url: http://localhost:8983/solr/development
+test:
+  default:
+    url: http://localhost:<%= ENV['SOLR_TEST_PORT'] || 8985 %>/solr/hydra-test
+  full_text:
+    url: http://localhost:<%= ENV['SOLR_TEST_PORT'] || 8985 %>/solr/test
+production:
+  default:
+    url: http://localhost:8080/solr/production
+  full_text:
+    url: http://localhost:8080/solr/production

data/lib/active_fedora/datastreams.rb

@@ -0,0 +1,21 @@
+require "active_fedora/datastreams/version"
+require 'active_fedora'
+
+module ActiveFedora
+  autoload :NomDatastream, 'active_fedora/nom_datastream'
+  autoload :OmDatastream, 'active_fedora/om_datastream'
+  autoload :QualifiedDublinCoreDatastream, 'active_fedora/qualified_dublin_core_datastream'
+
+  module Datastreams
+    extend ActiveSupport::Autoload
+    autoload :NokogiriDatastreams, 'active_fedora/datastreams/nokogiri_datastreams'
+  end
+
+  module RDF
+    autoload :DatastreamIndexing, 'active_fedora/rdf/datastream_indexing'
+  end
+
+  autoload :NtriplesRDFDatastream, 'active_fedora/rdf/ntriples_rdf_datastream'
+  autoload :RDFDatastream, 'active_fedora/rdf/rdf_datastream'
+  autoload :RDFXMLDatastream, 'active_fedora/rdf/rdfxml_datastream'
+end

data/lib/active_fedora/datastreams/nokogiri_datastreams.rb

@@ -0,0 +1,119 @@
+module ActiveFedora
+  module Datastreams
+    module NokogiriDatastreams
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def xml_template
+          Nokogiri::XML::Document.parse("<xml/>")
+        end
+
+        def decorate_ng_xml(xml)
+          xml
+        end
+      end
+
+      def ng_xml
+        @ng_xml ||= begin
+          xml = if new_record?
+                  ## Load up the template
+                  self.class.xml_template
+                else
+                  Nokogiri::XML::Document.parse(remote_content)
+                end
+          self.class.decorate_ng_xml xml
+        end
+      end
+
+      def ng_xml=(new_xml)
+        # before we set ng_xml, we load the datastream so we know if the new value differs.
+        # TODO reinstate this
+        # local_or_remote_content(true)
+
+        case new_xml
+        when Nokogiri::XML::Document
+          self.content = new_xml.to_xml
+        when Nokogiri::XML::Node
+          ## Cast a fragment to a document
+          self.content = new_xml.to_s
+        when String
+          self.content = new_xml
+        else
+          raise TypeError, "You passed a #{new_xml.class} into the ng_xml of the #{dsid} datastream. OmDatastream.ng_xml= only accepts Nokogiri::XML::Document, Nokogiri::XML::Element, Nokogiri::XML::Node, or raw XML (String) as inputs."
+        end
+      end
+
+      def refresh_attributes
+        changed_attributes.clear
+        @ng_xml = nil
+      end
+
+      # don't want content eagerly loaded by proxy, so implementing methods that would be implemented by define_attribute_methods
+      def ng_xml_will_change!
+        changed_attributes['ng_xml'] = nil
+      end
+
+      def ng_xml_doesnt_change!
+        changed_attributes.delete('ng_xml')
+      end
+
+      # don't want content eagerly loaded by proxy, so implementing methods that would be implemented by define_attribute_methods
+      def ng_xml_changed?
+        changed_attributes.key? 'ng_xml'
+      end
+
+      def remote_content
+        @ds_content ||= Nokogiri::XML(super).to_xml(&:no_declaration).strip
+      end
+
+      def content=(new_content)
+        if remote_content != new_content.to_s
+          ng_xml_will_change!
+          @ng_xml = Nokogiri::XML::Document.parse(new_content)
+          super(@ng_xml.to_s.strip)
+        end
+        self.class.decorate_ng_xml @ng_xml
+      end
+
+      def content_changed?
+        return true if autocreate? && new_record?
+        return false unless xml_loaded
+        ng_xml_changed?
+      end
+
+      def to_xml(xml = nil)
+        xml = ng_xml if xml.nil?
+        ng_xml = self.ng_xml
+        if ng_xml.respond_to?(:root) && ng_xml.root.nil? && self.class.respond_to?(:root_property_ref) && !self.class.root_property_ref.nil?
+          ng_xml = self.class.generate(self.class.root_property_ref, "")
+          xml = ng_xml if xml.root.nil?
+        end
+
+        unless xml == ng_xml || ng_xml.root.nil?
+          if xml.is_a?(Nokogiri::XML::Document)
+            xml.root.add_child(ng_xml.root)
+          elsif xml.is_a?(Nokogiri::XML::Node)
+            xml.add_child(ng_xml.root)
+          else
+            raise "You can only pass instances of Nokogiri::XML::Node into this method.  You passed in #{xml}"
+          end
+        end
+
+        xml.to_xml.strip
+      end
+
+      def content
+        @content = to_xml if ng_xml_changed? || autocreate?
+        super
+      end
+
+      def autocreate?
+        changed_attributes.key? :profile
+      end
+
+      def xml_loaded
+        instance_variable_defined? :@ng_xml
+      end
+    end
+  end
+end