active_triples-mongoid_strategy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22af17eaa429dc4f0ba5da01fbb6d3ad532c178b
+  data.tar.gz: f4970070d0d69869df6b540d330df6ef9e7d12ab
+SHA512:
+  metadata.gz: d7466df581b75490179329e68b88192846bb996745ef0a867259e36636ca512616d7a4168e641f930c38b13137541d7d63d8f80fd6f296d53f9715c5fdb7e04d
+  data.tar.gz: 41122d3427e8a5506d996d074925dd165c4a3801509e3872916c77fb0b091c15729618a47c6ac53badebb5c0da920c9f153728bd3b5e67ec04a29b7f884a12c6

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+Gemfile.lock
+tmp/*
+.sass-cache
+.idea
+coverage
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+bundler_args: --without debug
+script: "bundle exec rspec spec"
+sudo: false
+cache: bundler
+rvm:
+ - 2.0
+ - 2.1
+ - 2.2.4
+ - 2.3.0
+ - jruby-9.0.4.0
+ - rbx-2
+matrix:
+  allow_failures:
+      - rvm: jruby-9.0.4.0
+      - rvm: rbx-2

data/AUTHORS

@@ -0,0 +1 @@
+* MJ Suhonos (mj@suhonos.ca)

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

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,48 @@
+# ActiveTriples::MongoidStrategy
+
+[![Build Status](https://travis-ci.org/ActiveTriples/active_triples-mongoi.png?branch=master)](https://travis-ci.org/ActiveTriples/active_triples-mongoid_strategy)
+[![Coverage Status](https://coveralls.io/repos/ActiveTriples/active_triples-mongoid_strategy/badge.png?branch=master)](https://coveralls.io/r/ActiveTriples/active_triples-mongoid_strategy?branch=master)
+[![Gem Version](https://badge.fury.io/rb/active_triples-mongoid_strategy.svg)](http://badge.fury.io/rb/active_triples-mongoid_strategy)
+
+Provides a graph-based persistence strategy for the [ActiveTriples](https://github.com/ActiveTriples/ActiveTriples) framework.  `ActiveTriples::RDFSources` are persisted to MongoDB natively as Compacted [JSON-LD](http://json-ld.org) documents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_triples-mongoid_strategy'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_triples-mongoid_strategy
+
+## Usage
+
+Start by [configuring Mongoid](https://docs.mongodb.org/ecosystem/tutorial/mongoid-installation/#configuration) for your environment or application as per the documentation.
+
+Persistence strategies currently (as of [ActiveTriples 0.8.1](https://github.com/ActiveTriples/ActiveTriples/tree/v0.8.1)) use `RDF::Repository` as the default persistence strategy.  To override this, you have to inject `MongoidStrategy` into `RDFSource` instances at runtime:
+
+```ruby
+require 'active_triples/mongoid_strategy'
+
+source = ActiveTriples::Resource.new
+source.persistence_strategy # => #<ActiveTriples::RepositoryStrategy:...>
+
+source.set_persistence_strategy(ActiveTriples::MongoidStrategy)
+source.persistence_strategy # => #<ActiveTriples::MongoidStrategy:...>
+```
+
+## Contributing
+
+Please observe the following guidelines:
+
+ - Do your work in a feature branch based on ```master``` and rebase before submitting a pull request.
+ - Write tests for your contributions.
+ - Document every method you add using YARD annotations. (_Note: Annotations are sparse in the existing codebase, help us fix that!_)
+ - Organize your commits into logical units.
+ - Don't leave trailing whitespace (i.e. run ```git diff --check``` before committing).
+ - Use [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) commit messages.

data/active_triples-mongoid.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_triples/mongoid_strategy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active_triples-mongoid_strategy"
+  s.version     = ActiveTriples::MongoidStrategy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["MJ Suhonos"]
+  s.homepage    = 'https://github.com/ActiveTriples/active_triples-mongoid_strategy'
+  s.email       = 'mj@suhonos.ca'
+  s.summary     = %q{Mongoid persistence for ActiveTriples.}
+  s.description = %q{active_triples-mongoid provides a graph-based MongoDB persistence strategy for ActiveTriples.}
+  s.license     = "Apache-2.0"
+  s.required_ruby_version     = '>= 2.0.0'
+
+  s.add_dependency('active-triples', '~> 0.8')
+  s.add_dependency('mongoid', '~> 5.0')
+
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug')
+  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')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+end

data/lib/active_triples/mongoid_strategy.rb

@@ -0,0 +1,97 @@
+require 'active_triples/persistence_strategies/persistence_strategy'
+require 'active_triples/mongoid_strategy/version'
+require 'mongoid'
+require 'json/ld'
+
+module ActiveTriples
+  ##
+  # Persistence strategy for projecting `RDFSource` to `Mongoid::Documents`.
+  class MongoidStrategy
+    include PersistenceStrategy
+
+    # @!attribute [r] obj
+    #   the RDFSource to persist with this strategy
+    # @!attribute [r] collection
+    #   the Mongoid::Document class that the object
+    #   will project itself on when persisting
+    attr_reader :obj, :collection
+
+    ##
+    # @param obj [RDFSource] the `RDFSource` to persist with the strategy.
+    def initialize(obj)
+      @obj = obj
+      @collection = set_klass
+    end
+
+    ##
+    # Delete the Document from the collection
+    def erase_old_resource
+      persisted_document.destroy
+    end
+
+    ##
+    # Delete the Document from the collection
+    # and mark the Resource as destroyed
+    def destroy
+      super { erase_old_resource }
+    end
+
+    ##
+    # Persists the object to the repository
+    #
+    # @return [true] returns true if the save did not error
+    def persist!
+      # Persist ALL objects as a @graph
+      unless obj.empty?
+        doc = collection.find_or_initialize_by(id: obj.id)
+        doc.attributes = JSON.parse(obj.dump(:jsonld, standard_prefixes: true,
+                                                      useNativeTypes: true))
+        doc.save
+      end
+
+      @persisted = true
+    end
+
+    ##
+    # Repopulates the graph from the repository.
+    #
+    # @return [Boolean]
+    def reload
+      # Retrieve document from #collection if it exists
+      doc = persisted_document.first
+      obj << JSON::LD::API.toRDF(doc.as_document,
+                                 rename_bnodes: false) unless doc.nil?
+      @persisted = true
+    end
+
+    private
+
+    ##
+    # @return [Mongoid::Criteria] criteria matching the document
+    def persisted_document
+      collection.where(id: obj.id)
+    end
+
+    ##
+    # Return the delegated class for the object's model
+    def set_klass
+      klass_name = obj.model_name.name.demodulize.to_sym
+
+      if self.class.constants.include? klass_name
+        return self.class.const_get(klass_name)
+      else
+        return delegate_klass(klass_name)
+      end
+    end
+
+    ##
+    # Define a Mongoid::Document delegate class
+    def delegate_klass(klass_name)
+      klass = self.class.const_set(klass_name, Class.new)
+      klass.include Mongoid::Document
+      klass.include Mongoid::Attributes::Dynamic
+      klass.store_in collection: obj.model_name.plural
+      klass
+    end
+  end
+end

data/lib/active_triples/mongoid_strategy/version.rb

@@ -0,0 +1,5 @@
+module ActiveTriples
+  class MongoidStrategy
+    VERSION = "0.1.0"
+  end
+end

data/spec/active_triples/persistence_strategies/mongoid_strategy_spec.rb

@@ -0,0 +1,144 @@
+require 'active_triples/mongoid_strategy'
+require 'spec_helper'
+
+options = { clients: { default: { database: 'active_triples', hosts: ['localhost:27017'] } } }
+Mongoid.load_configuration(options)
+Mongo::Logger.logger.level = Logger::INFO
+
+describe ActiveTriples::MongoidStrategy do
+  let(:rdf_source) { ActiveTriples::Resource.new }
+  let(:subject) { described_class.new(rdf_source) }
+
+  before :each do
+    Mongoid.purge!
+  end
+
+  context 'with behaviour' do
+    it_behaves_like 'a persistence strategy'
+
+    describe '#persisted?' do
+      context 'before persist!' do
+        it 'returns false' do
+          expect(subject).not_to be_persisted
+        end
+      end
+
+      context 'after persist!' do
+        it 'returns true' do
+          subject.persist!
+          expect(subject).to be_persisted
+        end
+      end
+    end
+
+    describe '#destroy' do
+      shared_examples 'destroy resource' do
+        it 'removes the resource from the collection' do
+          subject.persist!
+          expect { subject.destroy }
+            .to change { subject.collection.count }.from(1).to(0)
+        end
+      end
+
+      it 'marks resource as destroyed' do
+        subject.destroy
+        expect(subject).to be_destroyed
+      end
+
+      it 'leaves other resources unchanged' do
+        # insert a new resource into the collection
+        other_resource = ActiveTriples::Resource.new
+        other_resource << RDF::Statement(other_resource.to_term, RDF::Vocab::DC.title, 'snorkmaiden')
+        described_class.new(other_resource).persist!
+
+        expect { subject.destroy }
+          .not_to change { subject.collection.count }
+      end
+
+      context 'with statements' do
+        before { rdf_source << RDF::Statement(rdf_source.to_term, RDF::Vocab::DC.title, 'moomin') }
+
+        include_examples 'destroy resource'
+
+        context 'with subjects' do
+          before do
+            subject.obj.set_subject! RDF::URI('http://example.org/moomin')
+          end
+
+          include_examples 'destroy resource'
+        end
+      end
+    end
+
+    describe '#destroyed?' do
+      it 'is false' do
+        expect(subject).not_to be_destroyed
+      end
+    end
+
+    describe '#reload' do
+      it 'returns true when both collection and object are empty' do
+        expect(subject.reload).to be true
+      end
+    end
+  end
+
+  context 'with literals' do
+    literals = [
+      # Non-localized String
+      'Comet in Moominland',
+      RDF::Literal('Mumintrollet pa kometjakt'),
+
+      # Localized string
+      RDF::Literal('Mumintrollet pa kometjakt', language: :sv),
+
+      # Boolean
+      true,
+      RDF::Literal("false", datatype: RDF::XSD.boolean),
+
+      # Integer
+      16_589_991,
+      RDF::Literal("31415927", datatype: RDF::XSD.integer),
+
+      # Float
+      12.345,
+      RDF::Literal("67.890", datatype: RDF::XSD.double),
+
+      # Symbol
+      :something,
+      RDF::Literal("else", datatype: RDF::XSD.token),
+
+      # Date
+      Date.new(1946),
+      RDF::Literal("1947-01-01", datatype: RDF::XSD.date),
+
+      # DateTime
+      DateTime.new(1951, 2, 3, 4, 5, 6),
+      RDF::Literal("1952-03-04T05:06:07Z", datatype: RDF::XSD.dateTime),
+
+      # Time
+      Time.now,
+      RDF::Literal(Time.now, datatype: RDF::XSD.time),
+
+      # URI
+      RDF::URI('http://foo.org'),
+    ]
+
+    it_behaves_like 'a mongoid strategy', literals
+
+    # Test persistence with various types of value
+    literals.each { |value| it_behaves_like 'a mongoid strategy', value }
+  end
+
+  context 'with objects' do
+    objects = [
+      ActiveTriples::Resource.new,
+      ActiveTriples::Resource.new('http://example.uri/'),
+    ]
+
+    it_behaves_like 'a mongoid strategy', objects
+
+    # Test persistence with various types of value
+    objects.each { |value| it_behaves_like 'a mongoid strategy', value }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'coveralls'
+Coveralls.wear!
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'rdf/spec'
+require 'rdf/vocab'
+require 'webmock/rspec'
+require 'active_triples'
+
+require 'pry' unless ENV["CI"]
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+
+  config.include(RDF::Spec::Matchers)
+
+  # Uncomment the following line to get errors and backtrace for deprecation warnings
+  # config.raise_errors_for_deprecations!
+
+  # Use the specified formatter
+  config.formatter = :documentation
+end

data/spec/support/shared_examples/mongoid_strategy.rb

@@ -0,0 +1,36 @@
+shared_examples 'a mongoid strategy' do |value|
+  before do
+    subject.obj[RDF::Vocab::DC.title] = value
+  end
+
+  describe '#persist!' do
+    it "writes graph with #{value.inspect} to #collection" do
+      subject.persist!
+      expect(subject.collection.all.map(&:id))
+          .to contain_exactly *rdf_source.id
+    end
+
+    it 'serializes as JSON-LD' do
+      subject.persist!
+
+      json_ld = JSON.parse(subject.obj.dump(:jsonld))
+      g = RDF::Graph.new << JSON::LD::API.toRdf(json_ld, rename_bnodes: false)
+
+      expect(subject.obj.statements)
+          .to contain_exactly *g.statements
+    end
+  end
+
+  describe '#reload' do
+    it 're-populates graph from a persisted document' do
+      g = RDF::Graph.new << subject.obj.statements
+
+      subject.persist!
+      subject.obj.clear
+      subject.reload
+
+      expect(subject.obj.statements)
+          .to contain_exactly *g.statements
+    end
+  end
+end

data/spec/support/shared_examples/persistence_strategy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+shared_examples 'a persistence strategy' do
+  shared_context 'with changes' do
+    before do
+      subject.obj << RDF::Statement.new(RDF::Node.new, RDF::Vocab::DC.title, 'moomin')
+    end
+  end
+
+  describe '#persist!' do
+    it 'evaluates true on success' do
+      expect(subject.persist!).to be_truthy
+    end
+
+    context 'with changes' do
+      include_context 'with changes'
+
+      it 'evaluates true on success' do
+        expect(subject.persist!).to be_truthy
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: active_triples-mongoid_strategy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MJ Suhonos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active-triples
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdf-spec
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: active_triples-mongoid provides a graph-based MongoDB persistence strategy
+  for ActiveTriples.
+email: mj@suhonos.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- AUTHORS
+- Gemfile
+- LICENSE
+- README.md
+- active_triples-mongoid.gemspec
+- lib/active_triples/mongoid_strategy.rb
+- lib/active_triples/mongoid_strategy/version.rb
+- spec/active_triples/persistence_strategies/mongoid_strategy_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/mongoid_strategy.rb
+- spec/support/shared_examples/persistence_strategy.rb
+homepage: https://github.com/ActiveTriples/active_triples-mongoid_strategy
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Mongoid persistence for ActiveTriples.
+test_files: []