oa-graph 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ee82d3a04f3b61c10ce562151dcdb0e72c90547
+  data.tar.gz: 70110ef9417988e88c8f3c301731767e218e4ced
+SHA512:
+  metadata.gz: 7fb5b5f0cdab266514db38680df4016a46dcf9a35338f69a1db00a541ac2c43ad44106c33a6bd698076c68fc5e9baf5548170ea2ffe49b313e4ce2323db73965
+  data.tar.gz: 31470a60d945d2e04501d40b78c10163d6b0f615b0b70c8b202f72a7f25da533b57e1655c57bfbb32dcbac12114c9a2f7d5311b0ddc78a8c71f61f61c6a755d5

data/README.md

@@ -0,0 +1,31 @@
+# Oa::Graph
+
+A wrapper class for RDF::Graph that adds methods specific to OpenAnnotation graphs (See http://www.openannotation.org/spec/core/). Intended to be used for a single instance of an OpenAnnotation;  adds methods specific to OpenAnnotation RDF::Graph objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oa-graph'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install oa-graph
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/oa-graph/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,44 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec
+
+desc "Generate RDoc with YARD"
+task :doc => ['doc:generate']
+
+namespace :doc do
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+
+    YARD::Rake::YardocTask.new(:generate) do |yt|
+      yt.files   =  Dir.glob(File.join('lib', '*.rb')) +
+                    Dir.glob(File.join('lib', '**', '*.rb'))
+
+      yt.options = ['--output-dir', 'rdoc', '--readme', 'README.md',
+                    '--files', 'LICENSE', '--protected', '--private', '--title',
+                    'OA::Graph', '--exclude', 'version.rb']
+    end
+  rescue LoadError
+    desc "Generate RDoc with YARD"
+    task :generate do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r 'rdoc' if File.exists?('rdoc')
+  end
+end

data/lib/oa/graph.rb

@@ -0,0 +1,191 @@
+require 'oa/graph/version'
+require 'linkeddata'
+
+module OA
+  # a wrapper class for RDF::Graph that adds methods specific to OpenAnnotation
+  # (http://www.openannotation.org/spec/core/) Annotation objects. This is
+  # intended to be used for an RDF::Graph of a single annotation
+  class Graph
+
+    OA_CONTEXT_URL = 'http://www.w3.org/ns/oa.jsonld'
+    OA_DATED_CONTEXT_URL = 'http://www.w3.org/ns/oa-context-20130208.json'
+    IIIF_CONTEXT_URL = 'http://iiif.io/api/presentation/2/context.json'
+
+# Class Methods ----------------------------------------------------------------
+
+    # given an RDF::Resource (an RDF::Node or RDF::URI), look for all the
+    # statements with that object  as the subject, and recurse through the graph
+    # to find all descendant statements pertaining to the subject
+    # @param subject the RDF object to be used as the subject in the graph
+    #   query.  Should be an RDF::Node or RDF::URI
+    # @param [RDF::Graph] graph
+    # @return [Array[RDF::Statement]] all the triples with the given subject
+    def self.subject_statements(subject, graph)
+      result = []
+      graph.query([subject, nil, nil]).each { |stmt|
+        result << stmt
+        subject_statements(stmt.object, graph).each { |s| result << s }
+      }
+      result.uniq
+    end
+
+    # @return [RDF::Query] query for a subject :s with type of
+    #  RDF::Vocab::OA.Annotation
+    def self.anno_query
+      q = RDF::Query.new
+      q << [:s, RDF.type, RDF::Vocab::OA.Annotation]
+    end
+
+# Instance Methods -------------------------------------------------------------
+
+    # instantiate this class for an RDF::Graph of a single annotation
+    def initialize(rdf_graph)
+      @graph = rdf_graph
+    end
+
+    # @return json-ld representation of graph with OpenAnnotation context as a
+    #   url
+    def jsonld_oa
+      inline_context = @graph.dump(:jsonld, context: OA_DATED_CONTEXT_URL)
+      hash_from_json = JSON.parse(inline_context)
+      hash_from_json['@context'] = OA_DATED_CONTEXT_URL
+      hash_from_json.to_json
+    end
+
+    # @return json-ld representation of graph with IIIF context as a url
+    def jsonld_iiif
+      inline_context = @graph.dump(:jsonld, context: IIIF_CONTEXT_URL)
+      hash_from_json = JSON.parse(inline_context)
+      hash_from_json['@context'] = IIIF_CONTEXT_URL
+      hash_from_json.to_json
+    end
+
+    # Canned Query methods -----------------------------------------------------
+
+    # @return [String] the id of this annotation as a url string, or nil if it
+    #   is a Node
+    def id_as_url
+      solution = @graph.query self.class.anno_query
+      return if solution && solution.size == 1
+
+      rdf_resource = solution.first.s
+      rdf_resource.to_s if rdf_resource.is_a?(RDF::URI)
+      # TODO:  raise exception if not a URI?
+    end
+
+    # @return [Array<String>] Array of urls expressing the OA motivated_by
+    #   values
+    def motivated_by
+      motivations = []
+      q = self.class.anno_query.dup
+      q << [:s, RDF::Vocab::OA.motivatedBy, :motivated_by]
+      solution = @graph.query q
+      if solution && solution.size > 0
+        solution.each { |res|
+          motivations << res.motivated_by.to_s
+        }
+      end
+      # TODO:  raise exception if none? (validation)
+      motivations
+    end
+
+    # @param [RDF::URI] predicate either RDF::Vocab::OA.hasTarget or RDF::Vocab::OA.hasBody
+    # @return [Array<String>] urls for the predicate, as an Array of Strings
+    def predicate_urls(predicate)
+      urls = []
+      predicate_solns = @graph.query [nil, predicate, nil]
+      predicate_solns.each { |predicate_stmt|
+        predicate_obj = predicate_stmt.object
+        urls << predicate_obj.to_str.strip if predicate_obj.is_a?(RDF::URI)
+      }
+      urls
+    end
+
+    # For all bodies that are of type ContentAsText, get the characters as a
+    #   single String in the returned Array.
+    # @return [Array<String>] body chars as Strings, in an Array (one element
+    #   for each contentAsText body)
+    def body_chars
+      result = []
+      q = RDF::Query.new
+      q << [nil, RDF::Vocab::OA.hasBody, :body]
+      q << [:body, RDF.type, RDF::Vocab::CNT.ContentAsText]
+      q << [:body, RDF::Vocab::CNT.chars, :body_chars]
+      solns = @graph.query q
+      solns.each { |soln|
+        result << soln.body_chars.value
+      }
+      result
+    end
+
+    # @return [String] The datetime from the annotatedAt property, or nil
+    def annotated_at
+      solution = @graph.query [nil, RDF::Vocab::OA.annotatedAt, nil]
+      return if solution && solution.size == 1
+
+      solution.first.object.to_s
+    end
+
+
+    # Changing the Graph -------------------------------------------------------
+
+    # remove all RDF::Vocab::OA.hasBody and .hasTarget statements
+    #  and any other statements associated with body and target objects,
+    #  leaving all statements to be stored as part of base object in LDP store
+    def remove_non_base_statements
+      remove_has_target_statements
+      remove_has_body_statements
+    end
+
+    # remove all RDF::Vocab::OA.hasBody statements and any other statements associated
+    #   with body objects
+    def remove_has_body_statements
+      remove_predicate_and_its_object_statements RDF::Vocab::OA.hasBody
+    end
+
+    # remove all RDF::Vocab::OA.hasTarget statements and any other statements
+    #   associated with body objects
+    def remove_has_target_statements
+      remove_predicate_and_its_object_statements RDF::Vocab::OA.hasTarget
+    end
+
+    # remove all such predicate statements and any other statements associated
+    #   with predicates' objects
+    def remove_predicate_and_its_object_statements(predicate)
+      predicate_stmts = @graph.query([nil, predicate, nil])
+      predicate_stmts.each { |pstmt|
+        pred_obj = pstmt.object
+        OA::Graph.subject_statements(pred_obj, @graph).each { |s|
+          @graph.delete s
+        } unless !OA::Graph.subject_statements(pred_obj, @graph)
+        @graph.delete pstmt
+      }
+    end
+
+    # transform an outer blank node into a null relative URI
+    def make_null_relative_uri_out_of_blank_node
+      anno_stmts = @graph.query([nil, RDF.type, RDF::Vocab::OA.Annotation])
+      anno_rdf_obj = anno_stmts.first.subject
+      if anno_rdf_obj.is_a?(RDF::Node)
+        # use null relative URI representation of blank node
+        anno_subject = RDF::URI.new
+      else # it's already a URI
+        anno_subject = anno_rdf_obj
+      end
+      OA::Graph.subject_statements(anno_rdf_obj, @graph).each { |s|
+        if s.subject == anno_rdf_obj && anno_subject != anno_rdf_obj
+          @graph << RDF::Statement(subject: anno_subject,
+                                   predicate: s.predicate,
+                                   object: s.object)
+          @graph.delete s
+        end
+      }
+    end
+
+    # send unknown methods to RDF::Graph
+    def method_missing(sym, *args, &block)
+      @graph.send sym, *args, &block
+    end
+
+  end
+end

data/lib/oa/graph/version.rb

@@ -0,0 +1,5 @@
+module OA
+  class Graph
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: oa-graph
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naomi Dushay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: linkeddata
+  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: rake
+  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: 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: yard
+  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: rubocop
+  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: rubocop-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: 
+email:
+- ndushay@stanford.edu
+- darren.weber@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/oa/graph.rb
+- lib/oa/graph/version.rb
+homepage: https://github.com/sul-dlss/oa-graph
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Wrapper class for RDF::Graph that adds methods specific to OpenAnnotation
+  graphs. http://www.openannotation.org/spec/core/
+test_files: []
+has_rdoc: