active_annotations 0.1.0

data/lib/active_annotations/rdf_annotation.rb

@@ -0,0 +1,224 @@
+require 'open-uri'
+require 'securerandom'
+require 'yaml'
+require 'json/ld'
+require 'rdf/vocab/dc'
+require 'rdf/vocab/oa'
+require 'rdf/vocab/cnt'
+require 'rdf/vocab/dcmitype'
+require 'rdf/vocab/foaf'
+
+module ActiveAnnotations  
+  class RDFAnnotation
+    RDF::Vocab::DC = RDF::DC unless defined?(RDF::Vocab::DC)
+    RDF::Vocab::FOAF = RDF::FOAF unless defined?(RDF::Vocab::FOAF)
+    
+    attr_reader :graph
+    CONTEXT_URI = 'http://www.w3.org/ns/oa.jsonld'
+    
+    def self.from_jsonld(json)
+      content = JSON.parse(json)
+      self.new(JSON::LD::API.toRDF(content, documentLoader: DocumentLoader.document_loader))
+    end
+    
+    def to_jsonld(opts={})
+      input = JSON.parse(graph.dump :jsonld, standard_prefixes: true, prefixes: { oa: RDF::Vocab::OA.to_iri.value })
+      frame = YAML.load(File.read(File.expand_path('../frame.yml',__FILE__)))
+      output = JSON::LD::API.frame(input, frame, omitDefault: true, documentLoader: DocumentLoader.document_loader)
+      output.merge!(output.delete('@graph')[0])
+      if opts[:pretty_json]
+        JSON.pretty_generate output
+      else
+        output.to_json
+      end
+    end
+
+    def initialize(content=nil)
+      @graph = RDF::Graph.new
+      if content.nil?
+        self.add_default_content!
+      else
+        @graph << content
+      end
+    end
+    
+    def get_value(s, p)
+      return nil if s.nil?
+      statement = graph.first(subject: s, predicate: p)
+      if statement.nil?
+        return nil
+      elsif statement.object.is_a?(RDF::Literal)
+        statement.object.object
+      else
+        statement.object.value
+      end
+    end
+    
+    def set_value(s, p, value)
+      return nil if s.nil?
+      @graph.delete({ subject: s, predicate: p })
+      @graph << RDF::Statement.new(s, p, value) unless value.nil?
+    end
+    
+    def add_statements(*statements)
+      statements.each { |statement| @graph << statement }
+    end
+    
+    def add_default_content!
+      aid = new_id
+      add_statements(
+        RDF::Statement.new(aid, RDF.type, RDF::Vocab::OA.Annotation),
+        RDF::Statement.new(aid, RDF::Vocab::OA.annotatedAt, DateTime.now)
+      )
+    end
+
+    def ensure_body!
+      if body_id.nil?
+        bid = new_id
+        add_statements(
+          RDF::Statement.new(annotation_id, RDF::Vocab::OA.hasBody, bid),
+          RDF::Statement.new(bid, RDF.type, RDF::Vocab::DCMIType.Text),
+          RDF::Statement.new(bid, RDF.type, RDF::Vocab::CNT.ContentAsText)
+        )
+      end
+    end
+    
+    def ensure_target!
+      if target_id.nil?
+        tid = new_id
+        add_statements(
+          RDF::Statement.new(annotation_id, RDF::Vocab::OA.hasTarget, tid),
+          RDF::Statement.new(tid, RDF.type, RDF::Vocab::OA.SpecificResource)
+        )
+      end
+    end
+
+    def ensure_selector!
+      if selector_id.nil?
+        ensure_target!
+        sid = new_id
+        add_statements(
+          RDF::Statement.new(target_id, RDF::Vocab::OA.hasSelector, sid),
+          RDF::Statement.new(sid, RDF.type, RDF::Vocab::OA.FragmentSelector),
+          RDF::Statement.new(sid, RDF::Vocab::DC.conformsTo, RDF::URI('http://www.w3.org/TR/media-frags/'))
+        )
+      end
+    end
+    
+    def new_id
+      RDF::URI.new("urn:uuid:#{SecureRandom.uuid}")
+    end
+
+    def find_id(type)
+      statement = @graph.first(predicate: RDF.type, object: type)
+      statement.nil? ? nil : statement.subject
+    end
+    
+    def annotation_id
+      find_id(RDF::Vocab::OA.Annotation)
+    end
+    
+    def body_id
+      statement = @graph.first(subject: annotation_id, predicate: RDF::Vocab::OA.hasBody)
+      statement.nil? ? nil : statement.object
+    end
+    
+    def target_id
+      find_id(RDF::Vocab::OA.SpecificResource)
+    end
+    
+    def selector_id
+      find_id(RDF::Vocab::OA.FragmentSelector)
+    end
+    
+    def fragment_value
+      graph.first(subject: selector_id, predicate: RDF.value)
+    end
+    
+    def fragment_value=(value)
+      ensure_selector!
+      set_value(selector_id, RDF.value, value)
+    end
+    
+    def start_time
+      value = fragment_value.nil? ? nil : fragment_value.object.value.scan(/^t=(.*)$/).flatten.first.split(/,/)[0]
+      Float(value)
+    rescue
+       value
+    end
+    
+    def start_time=(value)
+      self.fragment_value = "t=#{[value, end_time].join(',')}"
+    end
+    
+    def end_time
+      value = fragment_value.nil? ? nil : fragment_value.object.value.scan(/^t=(.*)$/).flatten.first.split(/,/)[1]
+      Float(value)
+    rescue
+      value
+    end
+    
+    def end_time=(value)
+      self.fragment_value = "t=#{[start_time, value].join(',')}"
+    end
+    
+    def content
+      get_value(body_id, RDF::Vocab::CNT.chars)
+    end
+    
+    def content=(value)
+      ensure_body!
+      set_value(body_id, RDF::Vocab::CNT.chars, value)
+    end
+    
+    def annotated_by
+      get_value(annotation_id, RDF::Vocab::OA.annotatedBy)
+    end
+    
+    def annotated_by=(value)
+      unless annotated_by.nil?
+        @graph.delete({ subject: RDF::URI(annotated_by) })
+      end
+
+      value = value.nil? ? nil : RDF::URI(value)
+      set_value(annotation_id, RDF::Vocab::OA.annotatedBy, value)
+      set_value(value, RDF.type, RDF::Vocab::FOAF.Person)
+    end
+    
+    def annotated_at
+      get_value(annotation_id, RDF::Vocab::OA.annotatedAt)
+    end
+    
+    def annotated_at=(value)
+      set_value(annotation_id, RDF::Vocab::OA.annotatedAt, value)
+    end
+    
+    def source
+      # TODO: Replace this with some way of retrieving the actual source
+      get_value(target_id, RDF::Vocab::OA.hasSource)
+    end
+    
+    def source=(value)
+      unless target_id.nil?
+        statement = @graph.first(subject: target_id, predicate: RDF::Vocab::OA.hasSource)
+        @graph.delete({ subject: statement.object, predicate: RDF.type }) unless statement.nil?
+        @graph.delete({ subject: target_id, predicate: RDF::Vocab::OA.hasSource })
+      end
+      unless value.nil?
+        ensure_target!
+        add_statements(
+          RDF::Statement.new(target_id, RDF::Vocab::OA.hasSource, RDF::URI(value.rdf_uri)),
+          RDF::Statement.new(RDF::URI(value.rdf_uri), RDF.type, value.rdf_type)
+        )
+      end
+    end
+    
+    def label
+      get_value(annotation_id, RDF::RDFS.label)
+    end
+    
+    def label=(value)
+      set_value(annotation_id, RDF::RDFS.label, value)
+    end
+  end
+end

data/lib/active_annotations/version.rb

@@ -0,0 +1,3 @@
+module ActiveAnnotations
+  VERSION = "0.1.0"
+end

data/lib/active_annotations.rb

@@ -0,0 +1,7 @@
+require "active_annotations/version"
+require "active_annotations/rdf_annotation"
+require "active_annotations/document_loader"
+require "active_annotations/engine"
+
+module ActiveAnnotations
+end

data/lib/generators/active_annotations/install_generator.rb

@@ -0,0 +1,10 @@
+module ActiveAnnotations
+  class InstallGenerator < Rails::Generators::Base
+     desc "This generator copies the ActiveAnnotations database migrations to /db/migrate"
+     
+     def copy_migrations
+       rake "active_annotations:install:migrations"
+       rake "db:migrate"
+     end
+  end
+end

data/tasks/active_annotations.rake

@@ -0,0 +1,13 @@
+require 'engine_cart/rake_task'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern =  'spec/**/*_spec.rb'
+end
+
+EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
+
+desc "Run test suite"
+task :ci => ['engine_cart:generate'] do
+  Rake::Task['spec'].invoke
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: active_annotations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael B. Klein
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-ld
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  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: faker
+  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: simplecov
+  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: See http://www.openannotation.org/spec/core/
+email:
+- mbklein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_annotations.gemspec
+- app/models/active_annotations/annotation.rb
+- db/migrate/20160422052041_create_annotations.rb
+- lib/active_annotations.rb
+- lib/active_annotations/document_loader.rb
+- lib/active_annotations/engine.rb
+- lib/active_annotations/frame.yml
+- lib/active_annotations/oa.jsonld
+- lib/active_annotations/rdf_annotation.rb
+- lib/active_annotations/version.rb
+- lib/generators/active_annotations/install_generator.rb
+- tasks/active_annotations.rake
+homepage: http://github.com/avalonmediasystem/active_annotations
+licenses:
+- Apache
+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.5.1
+signing_key: 
+specification_version: 4
+summary: OpenAnnontations + JSON-LD + ActiveRecord
+test_files: []