active-fedora 1.0.5 → 1.1.0

data/spec/integration/semantic_node_spec.rb

@@ -0,0 +1,95 @@
+require File.join( File.dirname(__FILE__), "../spec_helper" )
+
+require 'active_fedora'
+
+describe ActiveFedora::SemanticNode do
+  
+  before(:all) do 
+    class SpecNode 
+      include ActiveFedora::SemanticNode
+      has_relationship "collection_members", :has_collection_member
+    end
+    @node = SpecNode.new
+    class SpecModel < ActiveFedora::Base
+      has_relationship("parts", :is_part_of, :inbound => true)
+      has_relationship("containers", :is_member_of)
+    end
+    
+    @test_object = SpecModel.new
+    @test_object.save
+    
+    @part1 = ActiveFedora::Base.new()
+    @part1.add_relationship(:is_part_of, @test_object)
+    @part1.save
+    @part2 = ActiveFedora::Base.new()
+    @part2.add_relationship(:is_part_of, @test_object)
+    @part2.save
+    
+    
+    @container1 = ActiveFedora::Base.new()
+    @container1.save
+    @container2 = ActiveFedora::Base.new()    
+    @container2.save
+    
+    @test_object.add_relationship(:is_member_of, @container1)
+    @test_object.add_relationship(:is_member_of, @container2)
+    @test_object.save
+  end
+  
+  after(:all) do
+    @part1.delete 
+    @part2.delete
+    @container1.delete
+    @container2.delete
+    @test_object.delete
+    
+    Object.send(:remove_const, :SpecModel)
+
+  end
+  
+  describe '#has_relationship' do
+    it "should create useable finders" do
+      spec_node = SpecNode.new
+      spec_node.collection_members.should == []
+      rel = ActiveFedora::Relationship.new(:subject => :self, :predicate => :has_collection_member, :object => @test_object.pid)  
+      spec_node.add_relationship(rel)
+      collection_members = spec_node.collection_members
+      collection_members.length.should == 1
+      collection_members.first.pid.should == @test_object.pid
+      collection_members.first.class.should == @test_object.class
+    end
+    it "should create useable inbound finders if :inbound is set to true"
+  end
+  
+  describe "inbound relationship finders" do
+    it "should return an array of Base objects" do
+      parts = @test_object.parts
+      parts.each do |part|
+        part.should be_kind_of(ActiveFedora::Base)
+      end  
+    end
+    it "_ids should return an array of pids" do
+      ids = @test_object.parts_ids
+      ids.each do |id|
+        id.should satisfy {|id| id == @part1.pid || @part2.pid}
+      end  
+    end
+  end
+  
+  describe "outbound relationship finders" do
+    it "should return an array of Base objects" do
+      containers = @test_object.containers
+      containers.length.should > 0
+      containers.each do |container|
+        container.should be_kind_of(ActiveFedora::Base)
+      end  
+    end
+    it "_ids should return an array of pids" do
+      ids = @test_object.containers_ids
+      ids.each do |id|
+        id.should satisfy {|id| id == @container1.pid || @container2.pid}
+      end  
+    end
+  end
+  
+end

data/spec/integration/solr_service_spec.rb

@@ -0,0 +1,33 @@
+require File.join( File.dirname(__FILE__), "../spec_helper" )
+
+require 'active_fedora'
+
+include ActiveFedora
+
+
+describe ActiveFedora::SolrService do
+  describe "#reify_solr_results" do
+    before(:all) do
+      class FooObject < ActiveFedora::Base
+      end
+      @test_object = ActiveFedora::Base.new
+      @foo_object = FooObject.new
+      @test_object.save
+      @foo_object.save
+    end
+    after(:all) do
+      @test_object.delete
+      @foo_object.delete
+    end
+    it "should return an array of objects that are of the class stored in active_fedora_model_s" do
+      query = "id\:#{SolrService.escape_uri_for_query(@test_object.pid)} OR id\:#{SolrService.escape_uri_for_query(@foo_object.pid)}"
+      solr_result = SolrService.instance.conn.query(query)
+      result = ActiveFedora::SolrService.reify_solr_results(solr_result)
+      result.length.should == 2
+      result.each do |r|
+        (r.class == ActiveFedora::Base || r.class == FooObject).should be_true
+      end
+    end
+    
+  end
+end

data/spec/samples/models/audio_record.rb

@@ -0,0 +1,29 @@
+require 'active-fedora'
+
+class AudioRecord
+  
+    include ActiveFedora::Model
+      
+    # This seems a bit strange, since this Class might be used outside of Oral Histories.  
+    # From this perspective, it makes more sense to put triples on the containing object, not on the children...
+    
+    relationship "parents", :is_part_of, [nil, :oral_history]
+    #has n, :parents, {:predicate => :is_part_of, :likely_types => [nil, :oral_history]}
+    # OR
+    # is_part_of [:oral_history]
+    
+    property "date_recorded",   :date
+    property "file_name", :string
+    property "duration",  :string
+    property "notes", :text
+
+    # This doesn't make sense when you have both compressed and uncompressed in the same object!
+    # Probably better to rely on the file size in datastreamVersion "SIZE" attribute from Fedora anyway    
+    #property "file_size", :integer
+
+    #property "restriction", :text
+    
+    datastream "compressed", ["audio/mpeg"], :multiple => true
+    datastream "uncompressed", ["audio/wav", "audio/aiff"], :multiple => true
+      
+end

data/spec/samples/models/image.rb

@@ -0,0 +1,5 @@
+require 'active-fedora'
+
+class Image 
+  include ActiveFedora::Model
+end

data/spec/samples/models/oral_history.rb

@@ -0,0 +1,50 @@
+require 'active-fedora'
+
+include ActiveFedora
+include SemanticNode
+
+class OralHistory < ActiveFedora::Base
+    include Model
+
+  
+    # Imitating DataMapper ...
+    
+    has_relationship "parts", :is_part_of, :inbound => true
+    
+    # These are all the properties that don't quite fit into Qualified DC
+    # Put them on the object itself (in the properties datastream) for now.
+    has_metadata :name => "properties", :type => MetadataDatastream do |m|
+      field "alt_title", :string
+      field "narrator",  :string
+      field "interviewer", :integer
+      field "transcript_editor", :text
+      field "bio", :string
+      field "notes", :text
+      field "hard_copy_availability", :text
+      field "hard_copy_location", :text
+      field "other_contributors", :string
+      field "restrictions", :text
+    end
+        
+    has_metadata :name => "dublin_core", :type => QualifiedDublinCoreDatastream do |m|
+      # Default :multiple => true
+      #
+      # on retrieval, these will be pluralized and returned as arrays
+      # ie. subject_entries = my_oral_history.dublin_core.subjects
+      #
+      # aimint to use method-missing to support calling methods like
+      # my_oral_history.subjects  OR   my_oral_history.titles  OR EVEN my_oral_history.title whenever possible
+      
+      #field :name => "subject_heading", :string, {:xml_node => "subject", :encoding => "LCSH"}
+    end
+    
+    has_metadata :name => "significant_passages" do |m|
+      field "significant_passage", :text
+    end
+    
+    has_metadata :name => "sensitive_passages" do |m|
+      field "sensitive_passage", :text
+    end
+
+  
+end

data/spec/samples/models/seminar.rb

@@ -0,0 +1,29 @@
+require 'active-fedora'
+
+class Seminar 
+  
+    include ActiveFedora::Model
+    
+    # Imitating DataMapper ...
+    
+    relationship "parts", :is_part_of, [:seminar_audio_file], :inbound => true 
+    #has n, :parts, {:predicate => :is_part_of, :likely_types => [:seminar_audio_file], :inbound => true}  
+    # OR
+    # has_parts [:seminar_audio_file] 
+    
+    property "title_wylie",          :text  # Note: reserving title_tibetan for actual UTF-8 tibetan text
+    property "title_english",         :text
+    property "original_media_format",      :text
+    property "original_media_number_of_units",      :integer
+    property "author_name_wylie",  :text
+    property "author_name_english",     :text
+    property "location",    :string
+    property "date_recorded",   :date
+    property "file_name", :string
+    property "duration",      :string
+    property "file_size",    :integer
+    property "restriction",   :text
+    property "uri",   :string
+    property "notes", :text
+  
+end

data/spec/samples/models/seminar_audio_file.rb

@@ -0,0 +1,34 @@
+require 'active-fedora'
+
+class SeminarAudioFile
+  
+    include ActiveFedora::Model
+  
+    # Imitating DataMapper ...
+    
+    relationship "parent", :is_part_of, :seminar
+    #has n, :parents, {:predicate => :is_part_of, :likely_types => [:seminar]}
+    # OR
+    # is_part_of :seminar
+    
+    property "date_recorded",   :date
+    property "file_name", :string
+    property "duration",  :string
+    property "uri", :string
+    property "notes", :text
+
+    # TODO: Figure out how to declare access restrictions
+    #property "restriction", :text
+    set_restrictions ["public", "private"]
+        
+    # A file_size property doesn't make sense when you have both compressed and uncompressed in the same object!
+    # Probably better to rely on the file size in datastreamVersion "SIZE" attribute from Fedora anyway    
+    #property "file_size", :integer
+
+    datastream "compressed", ["audio/mpeg"], :multiple => true
+    datastream "uncompressed", ["audio/wav", "audio/aiff"], :multiple => true
+    
+    #has_metadata "dublin_core", :type => ActiveFedora::MetadataDatastream::QualifiedDublinCore
+
+  
+end

data/spec/samples/oh_qdc.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<wrapper xmlns:foxml="info:fedora/fedora-system:def/foxml#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="info:fedora/fedora-system:def/foxml# http://www.fedora.info/definitions/1/0/foxml1-1.xsd">
+
+  <foxml:datastream ID='dublin_core' STATE='A' CONTROL_GROUP='X' VERSIONABLE='true'>
+    <foxml:datastreamVersion SIZE='1726' ID='dublin_core.0' MIMETYPE='text/xml' LABEL='' CREATED='2009-01-15T17:55:49.277Z'>
+      <foxml:xmlContent>
+        <dc xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:dcterms='http://purl.org/dc/terms/'>
+          <dcterms:type xsi:type='DCMITYPE'>sound</dcterms:type>
+          <dcterms:medium>medium</dcterms:medium>
+          <dcterms:rights>rights</dcterms:rights>
+          <dcterms:language>English</dcterms:language>
+          <dcterms:temporal>tmp</dcterms:temporal>
+          <dcterms:subject>kw1</dcterms:subject>
+          <dcterms:subject>kw2</dcterms:subject>
+          <dcterms:creator>creator</dcterms:creator>
+          <dcterms:title>title</dcterms:title>
+          <dcterms:extent>extent</dcterms:extent>
+          <dcterms:format>audio/x-wav</dcterms:format>
+          <dcterms:subject xsi:type='LCSH'>sh1</dcterms:subject>
+          <dcterms:subject xsi:type='LCSH'>sh2</dcterms:subject>
+          <dcterms:spatial>sp1</dcterms:spatial>
+          <dcterms:spatial>sp2</dcterms:spatial>
+          <dcterms:publisher>jwa</dcterms:publisher>
+          <dcterms:alternative>alt</dcterms:alternative>
+          <dcterms:description>desc</dcterms:description>
+          <dcterms:date>datestr</dcterms:date>
+        </dc>
+      </foxml:xmlContent>
+    </foxml:datastreamVersion>
+  </foxml:datastream>
+</wrapper>

data/spec/samples/oral_history_sample.xml

@@ -0,0 +1,38 @@
+<xml>
+	<fields>
+		<system_create_date>2008-07-02T05:09:42.015Z</system_create_date>
+		<system_modified_date>2008-09-29T21:21:52.892Z</system_modified_date>
+		<active_fedora_model_field>OralHistory</active_fedora_model_field>
+		<id>changeme:14527</id>
+		<subject_heading>subject heading</subject_heading>
+		<type>type</type>
+		<rights>rights</rights>
+		<publisher>publisher</publisher>
+		<creation_date>creation date</creation_date>
+		<identifier>jwa:sample_pid</identifier>
+		<format>format</format>
+		<extent>extent</extent>
+		<language>language</language>
+		<description>description</description>
+		<title>title</title>
+		<medium>medium</medium>
+		<spatial_coverage>spatial coverage</spatial_coverage>
+		<alt_title>alt_title</alt_title>
+		<temporal_coverage>temporal coverage</temporal_coverage>
+		<subject>subject</subject>
+		<creator>creator</creator>
+		<abstract>abstract</abstract>
+		<other_contributors>Sally Ride</other_contributors>
+		<transcript_editor>Transcript Editor</transcript_editor>
+		<restrictions>None</restrictions>
+		<bio>Biographic info</bio>
+		<series>My Series</series>
+		<notes>My Note</notes>
+		<location>location</location>
+		<hard_copy_availability>Yes</hard_copy_availability>
+		<narrator>Narrator</narrator>
+		<hard_copy_location>Archives</hard_copy_location>
+		<interviewer>Interviewer</interviewer>
+	</fields>
+	<content/>
+</xml>

data/spec/samples/oral_history_sample_model.rb

@@ -0,0 +1,39 @@
+require "active_fedora"
+class OralHistorySampleModel < ActiveFedora::Base
+
+    has_relationship "parts", :is_part_of, :inbound => true
+    
+    has_metadata :name => "properties", :type => ActiveFedora::MetadataDatastream do |m|
+      m.field "narrator",  :string
+      m.field "interviewer", :string
+      m.field "transcript_editor", :text
+      m.field "bio", :string
+      m.field "notes", :text
+      m.field "hard_copy_availability", :text
+      m.field "hard_copy_location", :text
+      m.field "other_contributor", :string
+      m.field "restrictions", :text
+      m.field "series", :string
+      m.field "location", :string
+    end
+    
+    has_metadata :name => "dublin_core", :type => ActiveFedora::QualifiedDublinCoreDatastream do |m|
+      m.field "creation_date", :date, :xml_node => "date"
+      m.field "abstract", :text, :xml_node => "abstract"
+      m.field "rights", :text, :xml_node => "rights"
+      m.field "subject_heading", :string, :xml_node => "subject", :encoding => "LCSH" 
+      m.field "spatial_coverage", :string, :xml_node => "spatial", :encoding => "TGN"
+      m.field "temporal_coverage", :string, :xml_node => "temporal", :encoding => "Period"
+      m.field "type", :string, :xml_node => "type", :encoding => "DCMITYPE"
+      m.field "alt_title", :string, :xml_node => "alternative"
+    end
+    
+    has_metadata :name => "significant_passages", :type => ActiveFedora::MetadataDatastream do |m|
+      m.field "significant_passage", :text
+    end
+    
+    has_metadata :name => "sensitive_passages", :type => ActiveFedora::MetadataDatastream do |m|
+      m.field "sensitive_passage", :text
+    end
+
+end

data/spec/samples/oral_history_xml.xml

@@ -0,0 +1,35 @@
+<doc>
+  <field name="system_create_date">2008-07-02T05:09:42.015Z</field>
+  <field name="system_modified_date">2008-09-29T21:21:52.892Z</field>
+  <field name="active_fedora_model_field">OralHistory</field>
+  <field name="id">changeme:13919</field>
+  <field name="subject_heading_field">subject heading</field>
+  <field name="type_field">type</field>
+  <field name="rights_text">rights</field>
+  <field name="publisher_field">publisher</field>
+  <field name="creation_date">creation date</field>
+  <field name="identifier_field">jwa:sample_pid</field>
+  <field name="format_field">format</field>
+  <field name="extent_field">extent</field>
+  <field name="language_field">language</field>
+  <field name="description_field">description</field>
+  <field name="title_field">title</field>
+  <field name="medium_field">medium</field>
+  <field name="spatial_coverage_field">spatial coverage</field>
+  <field name="alt_title_field">alt_title</field>
+  <field name="temporal_coverage_field">temporal coverage</field>
+  <field name="subject_field">subject</field>
+  <field name="creator_field">creator</field>
+  <field name="abstract_text">abstract</field>
+  <field name="other_contributors_field">Sally Ride</field>
+  <field name="transcript_editor_text">Transcript Editor</field>
+  <field name="restrictions_text">None</field>
+  <field name="bio_field">Biographic info</field>
+  <field name="series_field">My Series</field>
+  <field name="notes_text">My Note</field>
+  <field name="location_field">location</field>
+  <field name="hard_copy_availability_text">Yes</field>
+  <field name="narrator_field">Narrator</field>
+  <field name="hard_copy_location_text">Archives</field>
+  <field name="interviewer_integer">Interviewer</field>
+</doc>

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format progress
+--loadby mtime
+--reverse
+

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+gem 'mocha'
+require 'ruby-debug'
+require 'mocha'
+require 'ruby-fedora'
+begin
+  require 'spec'
+rescue LoadError
+  gem 'rspec'
+  require 'spec'
+end
+
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+Dir[File.join(File.dirname(__FILE__)+'/../lib/')+'**/*.rb'].each{|x| require x}
+$VERBOSE=nil
+
+# This loads the Fedora and Solr config info from /config/fedora.yml
+# You can load it from a different location by passing a file path as an argument.
+ActiveFedora.init(File.join(File.dirname(__FILE__), "..", "config", "fedora.yml"))
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+#TEST_FEDORA_URL = 'http://fedoraAdmin:fedoraAdmin@127.0.0.1:8080/fedora' 
+#TEST_SOLR_URL = 'http://127.0.0.1:8080/solr' 
+#Fedora::Repository.register(TEST_FEDORA_URL)
+#ActiveFedora::SolrService.register(TEST_SOLR_URL)
+
+
+
+def fixture(file)
+  File.new(File.join(File.dirname(__FILE__), 'fixtures', file))
+end
+
+def validate_xml(xml, expected_root)
+  root = REXML::Document.new(xml).root
+  root.should_not be_nil
+  root.name.should == expected_root
+end