hydramata-works 0.0.1.prerelease

data/db/migrate/20140627140840_adding_item_prop_schema_dot_org_to_predicate.rb

@@ -0,0 +1,5 @@
+class AddingItemPropSchemaDotOrgToPredicate < ActiveRecord::Migration
+  def change
+    add_column :hydramata_works_predicates, :itemprop_schema_dot_org, :string
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,36 @@
+article = Hydramata::Works::WorkTypes::Storage.create!(identity: 'article', name_for_application_usage: 'article')
+predicate_set = Hydramata::Works::PredicateSets::Storage.create!(identity: 'required', work_type: article, presentation_sequence: 1, name_for_application_usage: 'required')
+
+def within_predicate_set_create_predicate_by_term(predicate_set, term)
+  name = "dc_#{term.gsub('#', '_')}"
+  predicate = Hydramata::Works::Predicates::Storage.new(identity: "http://purl.org/dc/terms/#{term}", name_for_application_usage: name)
+  predicate.save!
+  counter = predicate_set.predicate_presentation_sequences.count + 1
+  predicate_set.predicate_presentation_sequences.create!(presentation_sequence: counter, predicate: predicate)
+end
+
+[
+  'title',
+  'alternative',
+  'creator#author',
+  'contributor#author',
+  'identifier#issn',
+  'identifier#doi',
+  'abstract',
+  'subject',
+  'source',
+  'publisher',
+  'created',
+  'format#mimeType',
+  'bibliographicCitation',
+  'contributor#repository',
+  'relation#ispartof',
+  'temporal',
+  'spatial',
+  'language',
+  'format#extent',
+  'contributor#institution',
+  'rights#permissions',
+].each do |term|
+  within_predicate_set_create_predicate_by_term(predicate_set, term)
+end

data/documents/administrative-set-strawperson.md

@@ -0,0 +1,45 @@
+# Hydramata::AdministrativeSet Strawperson
+
+An Administrative Set is concerned with:
+
+* Somewhat concerned about presentation (i.e. where is this found)
+* Default values for ingest
+* Might enable bulk editing
+* What happens when something is deposited/ingested
+
+* Enable some student to deposit into a specific collection
+* Deposit requires review
+
+* What can be added to the set
+* Who can add to the set
+* Who can modify objects in the set
+* What happens when an object that is part of the set changes
+* What happens when an object is created in the set
+
+```gherkin
+Background:
+  Given a User with groups:
+    | group                    |
+    | Professor of Mathematics |
+    | Faculty                  |
+  And the following GroupRoles:
+    | group                    | role                     |
+    | Professor of Mathematics | Math Holdings Manager    |
+    | Faculty                  | Faculty Holdings Manager |
+    | Students                 | Self Deposit Submitter   |
+  And the following AdministrativeSets:
+    | set                   |
+    | General Holdings      |
+    | Self Deposit Holdings |
+    | Math Holdings         |
+  And the following Permissions:
+    | role                     | permissions                                           |
+    | General Holdings Manager | can :manage, "General Holdings item of type Article"  |
+    | General Holdings Manager | can :manage, "General Holdings item of type Document" |
+    | Math Holdings Manager    | can :manage, "General Holdings item of type Article"  |
+    | Math Holdings Manager    | can :manage, "General Holdings item of type Dataset"  |
+    | Self Deposit Submitter   | can :create, "Self Deposits item of type Document"    |
+
+Scenario:
+  Then they 
+```

data/documents/diagrams/hydramata-refactor-tasks.dot

@@ -0,0 +1,88 @@
+digraph "G" {
+    label="Hydramata Refactor"
+    compound=true;
+    node[color="grey15" fillcolor=white style=filled shape=record penwidth=2 margin="0.15, 0.125"];
+
+    subgraph cluster_1 {
+      label="Hydramata Base Definitions"
+      fillcolor=olivedrab3
+      style=filled
+      define_works_public_interface[label="{ Work's Public Interface | 1 week }"]
+      define_plugin_architecture_spec[label="{ Plugin Architecture Spec | 1 week }"]
+    }
+
+    subgraph cluster_2 {
+      label="Hydramata::Works"
+      fillcolor=orange
+      style=filled
+      articulate_work_responsibility[label="{Articulate Work Responsibility | 1 week }"]
+      define_presentation_structure[label="{ Define Presentation Structure | 1 week }"]
+      splice_presentation_structure[label="{ Splice in Presentation Structure | 3 weeks | SWARM! }"]
+      define_predicate_interfaces[label="{ Define Predicates Interfaces | 3 weeks }"]
+      define_existing_predicates[label="{ Define Existing Predicates | 3 weeks | SWARM! }"]
+      splice_work_wrangler[label="{ Splice Work Wrangler for Fedora | 3 weeks }"]
+      splice_actor_shim[label="{ Splice Actor Shim for Hydramata::Works | 2 weeks | SWARM? }"]
+    }
+
+    subgraph cluster_3 {
+      label="Hydramata::Worksflow"
+      fillcolor=lightblue
+      style=filled
+      articulate_workflow_responsibility[label="{Articulate WorkFlow Responsibility | 1 week }"]
+      define_workflow_interface[label="{Define Workflow Interface | 2 week }"]
+      create_asynchronous_workflow[label="{ Create Asynchronous Workflow System | 6 weeks }"]
+      create_exsting_tasks[label="{ Create Single Focus Tasks | 3 weeks | SWARM! }"]
+      stand_up_workflow_app[label="{ Stand-up Workflow App | 1 week }"]
+      replace_existing_actors[label="{ Replace Actors with Workflow | 2 week }"]
+    }
+
+    subgraph cluster_4 {
+      label="Hydramata::Permissions"
+      fillcolor=firebrick2
+      style=filled
+      articulate_permission_responsibility[label="{ Articulate Permission Responsibility | 1 week }"]
+      define_permission_interface[label="{ Define Permission Interface | 2 weeks }"]
+      define_permission_management_system[label="{ Create Permission Management System | 8 weeks }"]
+      splice_in_hacl[label="{ Splice in Permission for Hydra::AccessControls | 3 weeks }"]
+      replace_repository_admin[label="{ Replace Repository Admin | 1 week }"]
+      replace_application_manager[label="{ Replace Application Manager | 1 week }"]
+    }
+
+    subgraph cluster_5 {
+      label="Hydramata::AdministrativeContext"
+      fillcolor=orchid3
+      style=filled
+      articulate_administrative_context_responsibility[label="{ Articulate AdministrativeContext Responsibility | 3 weeks }"]
+      define_impact_on_work[label="{ Define Impact on Work Datastructure | 1 weeks }"]
+      define_impact_on_permissions[label="{ Define Impact on Permissions | 1 weeks }"]
+      define_impact_on_workflow[label="{ Define Impact on Workflow | 1 weeks }"]
+      make_it_so[label="{ Make it So | ??? weeks }"]
+    }
+
+    define_works_public_interface -> define_plugin_architecture_spec
+    define_plugin_architecture_spec -> articulate_work_responsibility -> define_presentation_structure
+    define_plugin_architecture_spec -> articulate_permission_responsibility -> define_permission_interface
+    define_plugin_architecture_spec -> articulate_workflow_responsibility -> define_workflow_interface -> create_asynchronous_workflow
+
+    define_presentation_structure -> articulate_administrative_context_responsibility
+    define_permission_interface -> articulate_administrative_context_responsibility
+    define_workflow_interface -> articulate_administrative_context_responsibility
+    articulate_administrative_context_responsibility -> define_impact_on_work -> make_it_so
+    articulate_administrative_context_responsibility -> define_impact_on_workflow -> make_it_so
+    articulate_administrative_context_responsibility -> define_impact_on_permissions -> make_it_so
+
+    define_permission_interface -> define_permission_management_system
+    define_permission_management_system -> replace_repository_admin
+    replace_repository_admin -> replace_application_manager
+    define_permission_management_system -> splice_in_hacl
+    define_presentation_structure -> splice_presentation_structure
+    define_presentation_structure -> define_predicate_interfaces
+    define_predicate_interfaces -> define_existing_predicates
+    splice_presentation_structure -> splice_work_wrangler
+    define_existing_predicates -> splice_work_wrangler
+    splice_work_wrangler -> splice_actor_shim
+    create_asynchronous_workflow -> create_exsting_tasks
+    create_asynchronous_workflow -> stand_up_workflow_app
+    stand_up_workflow_app -> replace_existing_actors
+    create_exsting_tasks -> replace_existing_actors
+}

data/documents/diagrams/hydramata-sip-dip-aip.dot

@@ -0,0 +1,88 @@
+digraph "G" {
+    label="Hydramata SIP / DIP / AIP"
+    compound=true;
+    node[color="grey15" shape=record penwidth=2 margin="0.15, 0.125"];
+
+    subgraph cluster_0 {
+        label="Operations via Interface";
+        color="olivedrab3";
+        node[color="grey" style=filled fillcolor=olivedrab3];
+
+        user_submission [label="{User Submission Interface | rendered HTML form }"];
+        batch_submission [label="{Batch Submission Interface | machine readable file }"];
+        sip_request [label="{GET SIP by PID}"]
+        aip_request [label="{GET AIP by PID}"]
+        dip_request [label="{GET DIP by PID}"]
+        search_interface [label="{GET SEARCH}"]
+        work_viewer [label="{Representation of Work | by content type (i.e. HTML, JSON)}"]
+        search_response [label="{Representation of Search | by content type (i.e. HTML, JSON)}"]
+    }
+
+    subgraph 1 {
+        label="Data Negotiation"
+        color="lightskyblue3";
+        node[color="grey" style=filled fillcolor=lightskyblue3]
+
+        submission_handler [label="{Submission Input Handler | validate input | mint PID | persist input | enqueue submission}"];
+        work_wrangler [label="{Work Wrangler | retrieve data from persistence | retrieval sequence (for :edit, :show, etc.)}"]
+
+        blacklight [label="{Blacklight}"]
+        work_wrangler_aip [label="{ActiveFedora}"]
+        work_wrangler_sip [label="{ActiveRecord}"]
+        rubydora [label="{Rubydora}"]
+        solrizer [label="{Solrizer}"]
+        work_renderer [label="{Work Renderer}"]
+    }
+
+    subgraph cluster_2 {
+        label="Queing System"
+        color="pink"
+        style="filled"
+        hydramata_queue_handler [fillcolor=pink label="{Hydramata Workflow}"]
+        hydramata_queue_handler ->
+        send_user_notifications ->
+        run_anti_virus ->
+        characterize_files ->
+        generate_derivatives ->
+        apply_rights_metadata ->
+        etc ->
+        ingest_sip
+        send_user_notifications
+    }
+
+    subgraph 3 {
+        label="Data Storage and Persistence"
+        node[color="grey"style=filled fillcolor=grey];
+        sip_data_storage [label="{ Database }"];
+        sip_file_storage [label="{ File System Workspace }"];
+        aip_data_storage [label="{ Fedora }"];
+        index_data_storage [label="{ SOLR }"];
+    }
+
+    submission_handler -> sip_data_storage [label="Persist SIP"]
+    sip_request -> work_wrangler
+    dip_request -> work_wrangler
+    aip_request -> work_wrangler
+
+    work_wrangler -> work_wrangler_sip [arrowhead="none" label="Exists in Database?"]
+    work_wrangler_sip -> sip_data_storage [arrowhead="both"]
+    work_wrangler -> work_wrangler_aip [arrowhead="none" label="Exists in Fedora or SOLR?"]
+    work_wrangler -> work_renderer [label="Well-formed Work object"]
+    work_renderer -> work_viewer [label="Negotiated content type (i.e. JSON, HTML, XML)"]
+
+    work_wrangler_aip -> rubydora [arrowhead="both"]
+    work_wrangler_aip -> solrizer [arrowhead="both"]
+    search_interface -> blacklight
+    blacklight -> index_data_storage
+    blacklight -> search_response
+    user_submission -> submission_handler [label="User submits a form"];
+    batch_submission -> submission_handler [label="Batch file ready to process"];
+    submission_handler -> sip_request [label="Response from Submission Input Handler"];
+    submission_handler -> hydramata_queue_handler [label="Enqueue PID and workflow ID"];
+    hydramata_queue_handler -> sip_data_storage [label="Update SIP data"]
+    sip_data_storage -> hydramata_queue_handler [label="Load SIP data"]
+    hydramata_queue_handler -> rubydora [label="Ingest (SIP -> AIP)"]
+    hydramata_queue_handler -> solrizer [label="Index (SIP -> AIP)"]
+    rubydora -> aip_data_storage
+    solrizer -> index_data_storage
+}

data/documents/diagrams/hydramata-work-architecture.dot

@@ -0,0 +1,129 @@
+digraph "G" {
+    label="Hydramata::Works Architecture"
+    compound=true;
+    node[color="grey15" style=filled fillcolor=white shape=oval penwidth=2 margin="0.15, 0.15"];
+
+    subgraph cluster_0 {
+        label="Datastores"
+        color="olivedrab3"
+        style="filled"
+        node[shape=record]
+        fedora3[fillcolor=orchid4]
+        database
+        fedora4[fillcolor=orchid2]
+        solr
+    }
+
+    subgraph cluster_1 {
+        label="Wranglers"
+        color="orange"
+        style="filled"
+        work_resolver
+        fedora3_wrangler[fillcolor=orchid4]
+        fedora4_wrangler[fillcolor=orchid2]
+        database_wrangler[label="database_wrangler*"]
+        solr_wrangler
+        fedora_work_type_finder
+        fedora_work_type_finder
+        solr_work_type_finder
+        database_work_type_finder
+    }
+
+    subgraph cluster_8 {
+        label="Parsers"
+        color="orange"
+        style="filled"
+
+        datastream_parsers
+        database_serialization_parsers[label="database_serialization_parsers*"]
+        solr_document_parsers
+        predicate_parsers
+        value_parsers
+        presentation_structure_builder
+    }
+
+    subgraph cluster_2 {
+        label="Data Structure Definition"
+        color="olivedrab3"
+        style="filled"
+        node[shape=record]
+
+        work_type -> predicate_set -> predicate
+    }
+
+
+    subgraph cluster_3 {
+        label="Datastore Persister"
+        color="orange"
+        style="filled"
+        fedora3_persister
+        fedora4_persister[fillcolor=orchid2]
+        database_persister[label="database_persister*"]
+        solr_persister
+        work_persister
+    }
+
+    subgraph cluster_4 {
+        label="In Memory"
+        color="lightblue"
+        style="filled"
+        node[shape=record]
+        work
+        property_set
+        property
+        value
+    }
+
+    subgraph cluster_5 {
+        label="Buffer Map"
+        color="orange"
+        style="filled"
+    }
+
+    subgraph cluster_6 {
+        label="Output Buffer"
+        color="firebrick2"
+        style="filled"
+    }
+
+    presentation_structure_builder -> property_set
+    database -> database_wrangler
+    database_persister -> database
+    database_serialization_parsers -> predicate_parsers
+    database_wrangler -> database_serialization_parsers
+    database_wrangler -> database_work_type_finder
+    datastream_parsers -> predicate_parsers
+    fedora3 -> fedora3_wrangler
+    fedora3_persister -> fedora3
+    fedora3_wrangler -> datastream_parsers
+    fedora3_wrangler -> fedora_work_type_finder
+    fedora_work_type_finder
+    fedora4 -> fedora4_wrangler
+    fedora4_persister -> fedora4
+    fedora4_wrangler -> datastream_parsers
+    fedora4_wrangler -> fedora_work_type_finder
+    predicate -> presentation_structure_builder
+    predicate_parsers -> property
+    predicate_parsers -> value_parsers
+    predicate_set -> presentation_structure_builder
+    property -> value
+    property_set -> property
+    solr -> solr_wrangler
+    solr_document_parsers -> predicate_parsers
+    solr_persister -> solr
+    solr_wrangler -> solr_document_parsers
+    solr_wrangler -> solr_work_type_finder
+    value_parsers -> value
+    work -> property_set
+    work -> work_persister
+    work_persister -> database_persister
+    work_persister -> fedora3_persister
+    work_persister -> fedora4_persister
+    work_persister -> solr_persister
+    work_resolver -> presentation_structure_builder
+    work_resolver -> database_wrangler
+    work_resolver -> fedora3_wrangler
+    work_resolver -> fedora4_wrangler
+    work_resolver -> solr_wrangler
+    work_resolver -> work
+}

data/documents/diagrams/hydramata-work-subcomponents.dot

@@ -0,0 +1,36 @@
+digraph "G" {
+    label="Hydramata Refactor"
+    compound=true;
+    node[color="grey15" fillcolor=white style=filled shape=record penwidth=2 margin="0.15, 0.125"];
+
+    subgraph cluster_1 {
+      label="Hydramata Base Definitions"
+      fillcolor=olivedrab3
+      style=filled
+    }
+
+    subgraph cluster_2 {
+      label="Hydramata::Works"
+      fillcolor=orange
+      style=filled
+    }
+
+    subgraph cluster_3 {
+      label="Hydramata::Worksflow"
+      fillcolor=lightblue
+      style=filled
+    }
+
+    subgraph cluster_4 {
+      label="Hydramata::Permissions"
+      fillcolor=firebrick2
+      style=filled
+    }
+
+    subgraph cluster_5 {
+      label="Hydramata::AdministrativeContext"
+      fillcolor=orchid3
+      style=filled
+    }
+
+}

data/documents/diagrams/map-from-database-to-work-object.dot

@@ -0,0 +1,44 @@
+digraph "G" {
+    label="Map from Database to Work Object"
+    compound=true;
+    node[color="grey15" shape=record penwidth=2 margin="0.15, 0.125"];
+
+    subgraph 1 {
+        label="Records"
+        node[color="grey" style=filled fillcolor=olivedrab3];
+        database[label="Database"]
+        work[label="{ <f0> Work (in memory) | <f1> #pid | <f2> #work_type | <f3> #property_set }"]
+    }
+
+    subgraph cluster_0 {
+        label="Sequence for Transforming\nDatabase object to a Work"
+        color="orange"
+        style="filled"
+        node[style=filled fillcolor=white]
+        database_request_pid[label="Request PID"]
+        database_retrieve_object[label="Retrieve Object"]
+        database_instantiate_work[label="Instantiate Work"]
+        database_assign_work_type[label="Assign Work Type"]
+        database_parse_datastream[label="Parse Serialized data"]
+        database_for_each_property[label="For each Property"]
+        database_loop_for_each_property[label="More Properties" shape="diamond"]
+        database_push_property_to_work_property_set[label="Push Property to Work Property Set"]
+        return_work[label="Return Work object"]
+
+        database_request_pid -> database_retrieve_object
+        database_retrieve_object -> database_instantiate_work ->
+        database_instantiate_work -> database_assign_work_type
+        database_assign_work_type -> database_parse_datastream
+        database_parse_datastream -> database_for_each_property
+        database_for_each_property -> database_push_property_to_work_property_set
+        database_push_property_to_work_property_set -> database_loop_for_each_property
+        database_loop_for_each_property -> database_for_each_property [label="NEXT"]
+        database_loop_for_each_property -> return_work [label="NO"]
+    }
+
+    database_instantiate_work -> work[dir=both]
+    database_assign_work_type -> work:f2
+    database_retrieve_object -> database[dir=both]
+    database_push_property_to_work_property_set -> work:f3
+    work -> return_work
+}