hydramata-works 0.0.1.prerelease

data/app/presenters/hydramata/works/fieldset_presenter.rb

@@ -0,0 +1,54 @@
+require 'hydramata/works/base_presenter'
+
+module Hydramata
+  module Works
+    # Responsible for coordinating the rendering of an in-memory
+    # PropertySet-like object to an output buffer.
+    #
+    # @TODO - Rename fieldset in presentation to property_set
+    class FieldsetPresenter < BasePresenter
+      attr_reader :entity
+      def initialize(collaborators = {})
+        fieldset = collaborators.fetch(:fieldset)
+        @entity = collaborators.fetch(:entity)
+        super(fieldset, collaborators)
+      end
+
+      def work_type
+        __getobj__.work_type || entity.work_type
+      end
+
+      private
+
+      def default_dom_attributes
+        { class: [dom_class, presenter_dom_class] }
+      end
+
+      def default_presentation_context
+        entity.respond_to?(:presentation_context) ? entity.presentation_context : 'show'
+      end
+
+      def view_path_slug_for_object
+        'fieldsets'
+      end
+
+      def default_partial_prefixes
+        entity_prefix = TranslationKeyFragment(entity)
+        fieldset_prefix = TranslationKeyFragment(name)
+        [
+          [entity_prefix, fieldset_prefix],
+          [fieldset_prefix]
+        ]
+      end
+
+      def default_translation_scopes
+        entity_prefix = TranslationKeyFragment(entity)
+        fieldset_prefix = TranslationKeyFragment(name)
+        [
+          ['works', entity_prefix, view_path_slug_for_object, fieldset_prefix],
+          [view_path_slug_for_object, fieldset_prefix]
+        ]
+      end
+    end
+  end
+end

data/app/presenters/hydramata/works/property_presenter.rb

@@ -0,0 +1,51 @@
+require 'hydramata/works/base_presenter'
+module Hydramata
+  module Works
+    # Responsible for coordinating the rendering of an in-memory Property-like
+    # object to an output buffer.
+    class PropertyPresenter < BasePresenter
+      attr_reader :entity
+      def initialize(collaborators = {})
+        property = collaborators.fetch(:property)
+        @entity = collaborators.fetch(:entity)
+        super(property, collaborators)
+      end
+
+      def values
+        @values ||= __getobj__.values.collect {|value| ValuePresenter.new(value: value, predicate: self, entity: entity) }
+      end
+
+      private
+
+      def default_dom_attributes
+        { class: [dom_class, presenter_dom_class] }
+      end
+
+      def default_presentation_context
+        entity.respond_to?(:presentation_context) ? entity.presentation_context : 'show'
+      end
+
+      def view_path_slug_for_object
+        'properties'
+      end
+
+      def default_partial_prefixes
+        entity_prefix = TranslationKeyFragment(entity)
+        predicate_prefix = TranslationKeyFragment(predicate)
+        [
+          [entity_prefix, predicate_prefix],
+          [predicate_prefix]
+        ]
+      end
+
+      def default_translation_scopes
+        entity_prefix = TranslationKeyFragment(entity)
+        predicate_prefix = TranslationKeyFragment(predicate)
+        [
+          ['works', entity_prefix, view_path_slug_for_object, predicate_prefix],
+          [view_path_slug_for_object, predicate_prefix]
+        ]
+      end
+    end
+  end
+end

data/app/presenters/hydramata/works/value_presenter.rb

@@ -0,0 +1,60 @@
+require 'hydramata/works/base_presenter'
+module Hydramata
+  module Works
+    # Responsible for coordinating the rendering of an in-memory Value-like
+    # object to an output buffer.
+    class ValuePresenter < BasePresenter
+      attr_reader :entity, :predicate
+      def initialize(collaborators = {})
+        value = collaborators.fetch(:value)
+        @predicate = collaborators.fetch(:predicate)
+        @entity = collaborators.fetch(:entity)
+        super(value, collaborators)
+      end
+
+      def render(*args, &block)
+        begin
+          super(*args, &block)
+        rescue *template_missing_error
+          __getobj__.to_s
+        end
+      end
+
+      private
+
+      def name
+        "#{predicate.name}_value"
+      end
+
+      def default_dom_attributes
+        { class: [dom_class, presenter_dom_class] }
+      end
+
+      def default_presentation_context
+        entity.respond_to?(:presentation_context) ? entity.presentation_context : 'show'
+      end
+
+      def view_path_slug_for_object
+        'values'
+      end
+
+      def default_partial_prefixes
+        entity_prefix = TranslationKeyFragment(entity)
+        predicate_prefix = TranslationKeyFragment(predicate)
+        [
+          [entity_prefix, predicate_prefix],
+          [predicate_prefix]
+        ]
+      end
+
+      def default_translation_scopes
+        entity_prefix = TranslationKeyFragment(entity)
+        predicate_prefix = TranslationKeyFragment(predicate)
+        [
+          ['works', entity_prefix, view_path_slug_for_object, predicate_prefix],
+          [view_path_slug_for_object, predicate_prefix]
+        ]
+      end
+    end
+  end
+end

data/app/renderers/hydramata/works/entity_renderer.rb

@@ -0,0 +1,45 @@
+module Hydramata
+  module Works
+    # For some reason if you want to render the object outside of the context
+    # of a controller, this provides the wrapper.
+    class EntityRenderer
+      attr_reader :template, :format, :entity, :view_path
+      def initialize(options = {})
+        @entity = options.fetch(:entity)
+        @format = options.fetch(:format) { default_format }
+        @view_path = options.fetch(:view_path) { default_view_path }
+        @template = options.fetch(:template) { default_template }
+      end
+
+      def render
+        entity.render(template: template)
+      end
+
+      private
+
+      def default_format
+        :html
+      end
+
+      def default_template
+        view_container = ActionController::Base.new
+        # This appears to resolve the path relative to the Hydramata::Works
+        # Engine's paths['app/views']. I don't know if this will continue to
+        # work that way.
+        view_container.prepend_view_path(view_path) if view_path.present?
+        view = ActionView::Base.new(view_container.view_paths, {}, view_container, [format])
+
+        # Required if rendering a form. Defaults to false as this is a
+        # convenience object.
+        def view.protect_against_forgery?
+          false
+        end
+        view
+      end
+
+      def default_view_path
+        nil
+      end
+    end
+  end
+end

data/app/views/hydramata/works/fieldsets/_edit.html.erb

@@ -0,0 +1,4 @@
+<fieldset class="<%= edit.dom_class %> fieldset">
+  <caption><%= edit.t(:name) %></caption>
+  <% edit.properties.each do |property| %><%= property.render(template: self, locals: { form: form }) %><% end %>
+</fieldset>

data/app/views/hydramata/works/fieldsets/_show.html.erb

@@ -0,0 +1,8 @@
+<%= content_tag('section', show.container_content_tag_attributes) do %>
+  <hgroup>
+    <%= content_tag('h1', show.t(:name), class: 'heading') %>
+  </hgroup>
+  <dl class="metadata">
+    <% show.properties.each do |property| %><%= property.render(template: self) %><% end %>
+  </dl>
+<% end %>

data/app/views/hydramata/works/fieldsets/_show.json.jbuilder

@@ -0,0 +1,8 @@
+show.each do |property|
+  # Why the locals?
+  # Without the local json declared the jbuilder rendering engine
+  # will call :target! and dump the attributes to JSON form.
+  # This means nested calls will result in multiple dump commands on the
+  # rendered value.
+  property.render(template: self, locals: {json: json})
+end

data/app/views/hydramata/works/properties/_edit.html.erb

@@ -0,0 +1,12 @@
+<%# @TODO
+Tidy this up. Not yet certain how to do this.
+%>
+<div class="<%= edit.dom_class %>">
+  <%= label_tag("work_#{edit.predicate}", edit.t(:predicate)) %>
+  <div class="values">
+  <% edit.each_with_index do |value, index| %>
+    <%= text_field_tag("work_#{edit.predicate}_#{index+1}", value, name: "work[#{edit.predicate}][]") %>
+  <% end %>
+    <%= text_field_tag("work_#{edit.predicate}_0", nil, name: "work[#{edit.predicate}][]") %>
+  </div>
+</div>

data/app/views/hydramata/works/properties/_show.html.erb

@@ -0,0 +1,3 @@
+<%= content_tag('dt', show.t(:name), show.container_content_tag_attributes(class: 'label')) %>
+  <%- show.values.each_with_index do |value, index| -%><%= content_tag('dd', show.container_content_tag_attributes(class: 'value')) do %><%= value.render(template: self) %><%- end -%>
+<%- end -%>

data/app/views/hydramata/works/properties/_show.json.jbuilder

@@ -0,0 +1 @@
+json.set! show.name, show.values

data/app/views/hydramata/works/works/_edit.html.erb

@@ -0,0 +1,8 @@
+<%# @TODO
+Consider replacing form_for with form_tag. By using form_for, the given `edit`
+object must expose all of the property methods. This may work out as I steer
+towards a solution.
+%>
+<%= form_for edit, as: :work, url: '/', method: :patch, html: { class: [edit.dom_class(prefix: 'edit'), 'work'] } do |form| %>
+  <% edit.fieldsets.each do |fieldset| %><%= fieldset.render(template: self, locals: { form: form } ) %><% end %>
+<% end %>

data/app/views/hydramata/works/works/_new.html.erb

@@ -0,0 +1,8 @@
+<%# @TODO
+Consider replacing form_for with form_tag. By using form_for, the given `new`
+object must expose all of the property methods. This may work out as I steer
+towards a solution.
+%>
+<%= form_for new, as: :work, url: '/', method: :post, html: { class: [new.dom_class(prefix: 'new'), 'work'] } do |form| %>
+  <% new.fieldsets.each do |fieldset| %><%= fieldset.render(template: self, locals: { form: form } ) %><% end %>
+<% end %>

data/app/views/hydramata/works/works/_show.html.erb

@@ -0,0 +1,3 @@
+<%= content_tag('article', show.container_content_tag_attributes) do %>
+<% show.fieldsets.each do |fieldset| %><%= fieldset.render(template: self) %><% end %>
+<% end %>

data/app/views/hydramata/works/works/_show.json.jbuilder

@@ -0,0 +1,13 @@
+json.set! :work do
+  json.set! :work_type, show.work_type.to_s
+  json.properties do
+    show.fieldsets.each do |fieldset|
+      # Why the locals?
+      # Without the local json declared the jbuilder rendering engine
+      # will call :target! and dump the attributes to JSON form.
+      # This means nested calls will result in multiple dump commands on the
+      # rendered value.
+      fieldset.render(template: self, locals: {json: json})
+    end
+  end
+end

data/app/wranglers/hydramata/works/fedora_wrangler.rb

@@ -0,0 +1,66 @@
+module Hydramata
+  module Works
+    # Responsible for wrangling up data from Fedora and passing that data to
+    # visiting :entity.
+    class FedoraWrangler
+
+      attr_reader :repository_connection, :entity, :datastream_parser
+      def initialize(collaborators = {})
+        @repository_connection = collaborators.fetch(:repository_connection) { default_repository_connection }
+        @datastream_parser = collaborators.fetch(:datastream_parser) { default_datastream_parser }
+        @entity = collaborators.fetch(:entity)
+      end
+
+      private
+
+      def default_datastream_parser
+        require 'hydramata/works/datastream_parser'
+        DatastreamParser
+      end
+
+      def default_repository_connection
+        require 'rubydora'
+        # Please note: these parameters were used in building the VCR cassettes, so change at your own risk.
+        # TODO: This should be a configuration option analogous to ActiveFedora.
+        Rubydora.connect(url: 'http://127.0.0.1:8983/fedora', user: 'fedoraAdmin', password: 'fedoraAdmin')
+      end
+
+      public
+
+      def call(pid, options = {})
+        with_datastreams = options.fetch(:with_datastreams) { default_with_datastreams }
+        object = repository_connection.find(pid)
+        assign_work_type_from(object)
+        parse_datastreams(object) if with_datastreams
+      end
+
+      private
+
+      def default_with_datastreams
+        false
+      end
+
+      def assign_work_type_from(object)
+        object.models.each do |model|
+          if model =~ /\Ainfo:fedora\/afmodel\:(.*)\Z/
+            entity.work_type = Regexp.last_match[1]
+            break
+          end
+        end
+      end
+
+      def parse_datastreams(object)
+        object.datastreams.each do |_name, datastream|
+          parse_datastream_content(datastream)
+        end
+      end
+
+      def parse_datastream_content(datastream)
+        datastream_parser.call(datastream: datastream, entity: entity) do |property|
+          entity.properties << property
+        end
+      end
+
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/hydramata/works/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/db/migrate/20140606132349_create_hydramata_work_predicates.rb

@@ -0,0 +1,13 @@
+class CreateHydramataWorkPredicates < ActiveRecord::Migration
+  def change
+    create_table :hydramata_works_predicates do |t|
+      t.string :identity, index: { unique: true }, null: false
+      t.string :name_for_application_usage
+      t.string :datastream_name
+      t.string :value_coercer_name
+      t.string :value_parser_name
+      t.string :indexing_strategy
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140606132350_create_hydramata_work_types.rb

@@ -0,0 +1,9 @@
+class CreateHydramataWorkTypes < ActiveRecord::Migration
+  def change
+    create_table :hydramata_works_types do |t|
+      t.string :identity, index: { unique: true }, null: false
+      t.string :name_for_application_usage
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140606132351_create_hydramata_work_predicate_sets.rb

@@ -0,0 +1,13 @@
+class CreateHydramataWorkPredicateSets < ActiveRecord::Migration
+  def change
+    create_table :hydramata_works_predicate_sets do |t|
+      t.integer :work_type_id, index: true, null: false
+      t.string :identity, index: true, null: false
+      t.integer :presentation_sequence, index: true, null: false
+      t.string :name_for_application_usage
+      t.timestamps
+    end
+    add_index :hydramata_works_predicate_sets, [:work_type_id, :presentation_sequence], unique: true, name: :hydramata_works_predicate_set_sequence
+    add_index :hydramata_works_predicate_sets, [:work_type_id, :identity], unique: true, name: :hydramata_works_predicate_set_identity
+  end
+end

data/db/migrate/20140606132352_create_hydramata_work_predicate_presentation_sequences.rb

@@ -0,0 +1,12 @@
+class CreateHydramataWorkPredicatePresentationSequences < ActiveRecord::Migration
+  def change
+    create_table :hydramata_works_predicate_presentation_sequences do |t|
+      t.integer :predicate_set_id, index: true, null: false
+      t.integer :predicate_id, index: true, null: false
+      t.integer :presentation_sequence, index: true, null: false
+      t.timestamps
+    end
+    add_index :hydramata_works_predicate_presentation_sequences, [:predicate_set_id, :predicate_id], unique: true, name: :hydramata_works_predicate_presentation_sequences_identity
+    add_index :hydramata_works_predicate_presentation_sequences, [:predicate_set_id, :presentation_sequence], unique: true, name: :hydramata_works_predicate_presentation_sequences_presentation
+  end
+end

data/db/migrate/20140623200635_add_validations_to_predicates.rb

@@ -0,0 +1,5 @@
+class AddValidationsToPredicates < ActiveRecord::Migration
+  def change
+    add_column :hydramata_works_predicates, :validations, :text
+  end
+end

data/db/migrate/20140627134133_adding_item_type_schema_dot_org_to_work_type.rb

@@ -0,0 +1,5 @@
+class AddingItemTypeSchemaDotOrgToWorkType < ActiveRecord::Migration
+  def change
+    add_column :hydramata_works_types, :itemtype_schema_dot_org, :string
+  end
+end