Add documentation around ActiveFedora classes

samvera · Jul 14, 2017 · ee5e64c · ee5e64c
1 parent 887357d
commit ee5e64c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/lib/valkyrie/persistence/active_fedora/dynamic_klass.rb b/lib/valkyrie/persistence/active_fedora/dynamic_klass.rb
@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::ActiveFedora
+  # A factory for Valkrie::Models given data from an ActiveFedora::Base
+  # Because we override `new`, no instances of DynamicKlass are actually created.
   class DynamicKlass
+    # Instantiate the appropriate subclass of Valkrie::Model given the data from
+    # the `internal_model` field on the Valkyrie::Persistence::ActiveFedora::ORM::Resource class
+    # @param [Valkyrie::Persistence::ActiveFedora::ORM::Resource]
+    # @return [Valkrie::Model]
     def self.new(orm_object)
       orm_object.internal_model.constantize.new(cast_attributes(orm_object).merge(member_ids: orm_object.ordered_member_ids.map { |x| Valkyrie::ID.new(x) }))
     end

diff --git a/lib/valkyrie/persistence/active_fedora/orm/resource.rb b/lib/valkyrie/persistence/active_fedora/orm/resource.rb
@@ -10,6 +10,8 @@ class Schema < ActiveTriples::Schema
     property :thumbnail_id, predicate: ::RDF::URI("http://example.com/thumbnail_id")
     property :representative_id, predicate: ::RDF::URI("http://example.com/representative_id")
     property :start_canvas, predicate: ::RDF::URI("http://example.com/start_canvas")
+
+    # The type of the valkyrie model this resource represents
     property :internal_model, predicate: ::RDF::URI("http://example.com/internal_model"), multiple: false
     property :file_identifiers, predicate: ::RDF::URI("http://example.com/file_identifiers")
     property :label, predicate: ::RDF::URI("http://example.com/label")

diff --git a/lib/valkyrie/persistence/active_fedora/resource_factory.rb b/lib/valkyrie/persistence/active_fedora/resource_factory.rb
@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 module Valkyrie::Persistence::ActiveFedora
+  # Convert Valkrie::Model to an ActiveFedora::Base and vice versa
   class ResourceFactory
     class << self
+      # Convert an ActiveFedora::Base or ActiveFedora::SolrHit to Valkrie::Model
+      # @param orm_object [Valkyrie::Persistence::ActiveFedora::ORM::Resource, ActiveFedora::SolrHit]
+      # @return [Valkrie::Model]
       def to_model(orm_obj)
         return solr_to_model(orm_obj) if orm_obj.is_a?(ActiveFedora::SolrHit)
         ::Valkyrie::Persistence::ActiveFedora::DynamicKlass.new(orm_obj)
       end
 
+      # Find or create an ActiveFedora::Base that corresponds to the identifier
+      # of the Valkyrie model and encode the type of the Valkyrie model on it.
+      # @param [Valkrie::Model]
+      # @return [Valkyrie::Persistence::ActiveFedora::ORM::Resource]
       def from_model(model)
         resource =
           begin