hydra-tutorial 0.0.1

data/or_templates/add_tests/records_controller_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "" do
+  it "should" do
+    true.should be_true
+  end
+end

data/or_templates/adding_our_models/basic_af_model.rb

@@ -0,0 +1,5 @@
+class Record < ActiveFedora::Base
+
+  has_metadata :name => "descMetadata", :type => ActiveFedora::NokogiriDatastream
+
+end

data/or_templates/adding_our_models/basic_mods_model.rb

@@ -0,0 +1,13 @@
+class Record < ActiveFedora::Base
+
+  has_metadata :name => "descMetadata", :type => ModsDescMetadata
+
+  delegate :title, :to=>'descMetadata', :at => [:mods, :titleInfo, :title], :unique=>true
+  delegate :abstract, :to => "descMetadata"
+  delegate :preferred_citation, :to => "descMetadata", :unique=>true
+  delegate :author, :to=>'descMetadata', :at => [:name, :namePart], :unique=>true
+  delegate :url, :to=>'descMetadata', :at => [:relatedItem, :location, :url], :unique=>true
+  delegate :description, :to=>'descMetadata', :at => [:abstract], :unique=>true
+
+end
+

data/or_templates/adding_our_models/basic_om_model.rb

@@ -0,0 +1,28 @@
+class Record < ActiveFedora::Base
+
+  class DatastreamMetadata < ActiveFedora::NokogiriDatastream
+
+    ##
+    # Here's the important part. We're mapping XML into Ruby.
+    set_terminology do |t|
+      t.root :path => 'root', :xmlns => nil
+      t.title
+      t.author
+      t.url
+      t.description
+    end
+
+    def self.xml_template
+      Nokogiri::XML::Builder.new do |xml|
+        xml.root do
+          xml.title
+          xml.author
+          xml.url
+          xml.description
+        end
+      end.doc
+    end
+  end
+
+  has_metadata :name => "descMetadata", :type => DatastreamMetadata
+end

data/or_templates/adding_our_models/mods_desc_metadata.rb

@@ -0,0 +1,135 @@
+class ModsDescMetadata < ActiveFedora::NokogiriDatastream
+  # MODS XML constants.
+
+  MODS_NS = 'http://www.loc.gov/mods/v3'
+  MODS_SCHEMA = 'http://www.loc.gov/standards/mods/v3/mods-3-3.xsd'
+  MODS_PARAMS = {
+    "version"            => "3.3",
+    "xmlns:xlink"        => "http://www.w3.org/1999/xlink",
+    "xmlns:xsi"          => "http://www.w3.org/2001/XMLSchema-instance",
+    "xmlns"              => MODS_NS,
+    "xsi:schemaLocation" => "#{MODS_NS} #{MODS_SCHEMA}",
+  }
+
+  # OM terminology.
+
+  set_terminology do |t|
+    t.root :path => 'mods', :xmlns => MODS_NS
+    t.originInfo  do
+      t.dateOther
+    end
+    t.abstract
+    t.titleInfo  do
+      t.title
+    end
+
+    t.title :ref => [:mods, :titleInfo, :title]
+    t.name  do
+      t.namePart
+      t.role  do
+        t.roleTerm
+      end
+    end
+
+    t.relatedItem  do
+      t.titleInfo  do
+        t.title
+      end
+      t.location  do
+        t.url
+      end
+    end
+
+    t.subject  do
+      t.topic
+    end
+
+    t.preferred_citation :path => 'note',  :attributes => { :type => "preferred citation" }
+    t.related_citation :path => 'note',  :attributes => { :type => "citation/reference" }
+
+  end
+
+  # Blocks to pass into Nokogiri::XML::Builder.new()
+
+  define_template :name do |xml|
+      xml.name {
+        xml.namePart
+        xml.role {
+          xml.roleTerm(:authority => "marcrelator", :type => "text")
+        }
+      }
+  end
+
+  define_template :relatedItem do |xml|
+      xml.relatedItem {
+        xml.titleInfo {
+          xml.title
+        }
+        xml.location {
+          xml.url
+        }
+      }
+  end
+
+  define_template :related_citation do |xml|
+    xml.note(:type => "citation/reference")
+  end
+
+  def self.xml_template
+    Nokogiri::XML::Builder.new do |xml|
+      xml.mods(MODS_PARAMS) {
+        xml.originInfo {
+          xml.dateOther
+        }
+        xml.abstract
+        xml.titleInfo {
+          xml.title
+        }
+        xml.name {
+          xml.namePart
+          xml.role {
+            xml.roleTerm
+          }
+        }
+        xml.relatedItem {
+          xml.titleInfo {
+            xml.title
+          }
+          xml.location {
+            xml.url
+          }
+        }
+        xml.subject {
+          xml.topic
+        }
+        xml.note(:type => "preferred citation")
+        xml.note(:type => "citation/reference")
+      }
+    end.doc
+  end
+
+  def insert_person
+    insert_new_node(:name)
+  end
+
+  def insert_related_item
+    insert_new_node(:relatedItem)
+  end
+
+  def insert_related_citation
+    insert_new_node(:related_citation)
+  end
+
+  def insert_new_node(term)
+    add_child_node(ng_xml.root, term)
+  end
+
+  def remove_node(term, index)
+    node = self.find_by_terms(term.to_sym => index.to_i).first
+    unless node.nil?
+      node.remove
+      self.dirty = true
+    end
+  end
+
+end

data/or_templates/building_a_basic_rails_app/fedora.yml

@@ -0,0 +1,14 @@
+development:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://127.0.0.1:8983/fedora
+test: &TEST  
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: <%= "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8983}/fedora-test" %>
+production:
+  user: fedoraAdmin
+  password: fedoraAdmin
+  url: http://your.production.server:8080/fedora
+cucumber:
+  <<: *TEST

data/or_templates/building_a_basic_rails_app/solr.yml

@@ -0,0 +1,10 @@
+# This is a sample config file that does not have multiple solr instances. You will also need to be sure to
+# edit the fedora.yml file to match the solr URL for active-fedora. 
+development:
+  url: http://localhost:8983/solr/development
+test: &TEST
+  url: <%= "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8983}/solr/test" %>
+cucumber:
+  <<: *TEST
+production:
+  url: http://your.production.server:8080/bl_solr/core0 

data/or_templates/records_controller.rb

@@ -0,0 +1,83 @@
+class RecordsController < ApplicationController
+  # GET /records
+  # GET /records.json
+  def index
+    @records = Record.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @records }
+    end
+  end
+
+  # GET /records/1
+  # GET /records/1.json
+  def show
+    @record = Record.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @record }
+    end
+  end
+
+  # GET /records/new
+  # GET /records/new.json
+  def new
+    @record = Record.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @record }
+    end
+  end
+
+  # GET /records/1/edit
+  def edit
+    @record = Record.find(params[:id])
+  end
+
+  # POST /records
+  # POST /records.json
+  def create
+    @record = Record.new(params[:record])
+
+    respond_to do |format|
+      if @record.save
+        format.html { redirect_to @record, notice: 'Record was successfully created.' }
+        format.json { render json: @record, status: :created, location: @record }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @record.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /records/1
+  # PUT /records/1.json
+  def update
+    @record = Record.find(params[:id])
+
+    respond_to do |format|
+      if @record.update_attributes(params[:record])
+        format.html { redirect_to @record, notice: 'Record was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @record.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /records/1
+  # DELETE /records/1.json
+  def destroy
+    @record = Record.find(params[:id])
+    @record.destroy
+
+    respond_to do |format|
+      format.html { redirect_to records_url }
+      format.json { head :no_content }
+    end
+  end
+end

data/or_templates/wiring_it_into_rails/_form.html.erb

@@ -0,0 +1,31 @@
+<%= form_for(@record) do |f| -%>
+  <h2>Title</h2>
+  <div class="row">
+      <%= f.label :title, "Title" %>
+      <%= f.text_area :title, :value=>@record.title, :required => true %>
+  </div>
+
+  <h2>Abstract and keywords</h2>
+
+  <div class="row">
+    <%= f.label :abstract %>
+    <%= f.text_area :abstract, :value=>@record.abstract.first, :required=>true %>
+  </div>
+
+  <div class="row">
+    <%= label_tag("hydrus_item_keywords", "Keywords") %>
+    <%= text_field_tag("hydrus_item_keywords", @record.descMetadata.subject.topic.join(", ")) -%>
+    <div class="help">separate keywords with commas</div>
+  </div>
+
+  <h2>Citations</h2>
+  <div class="row">
+    <%= f.label :preferred_citation, "Preferred citation for this object", :class => "hidden-tablet" %>
+    <%= f.text_area :preferred_citation, :value=>@record.preferred_citation %>
+  </div>
+
+  <input type="submit" class="btn btn-small save-edits" name="save" id="save" />
+
+<% end %>
+
+

data/or_templates/wiring_it_into_rails/show.html.erb

@@ -0,0 +1,7 @@
+<p id="notice"><%= notice %></p>
+
+<h1><%= @record.title %></h1>
+
+<%= link_to 'Edit', edit_record_path(@record) %> |
+<%= link_to 'Back', records_path %>
+

data/templates/application/dataset_hydra_mods_om.rb

@@ -0,0 +1,13 @@
+class Dataset < ActiveFedora::Base
+
+  include Hydra::ModelMixins::CommonMetadata
+  include Hydra::ModelMethods
+
+  has_metadata :name => "descMetadata", :type => ModsDescMetadata
+
+  delegate :title, :to=>'descMetadata', :at => [:mods, :titleInfo, :title], :unique=>true
+  delegate :author, :to=>'descMetadata', :at => [:name, :namePart], :unique=>true
+  delegate :url, :to=>'descMetadata', :at => [:relatedItem, :location, :url], :unique=>true
+  delegate :description, :to=>'descMetadata', :at => [:abstract], :unique=>true
+
+end

data/templates/application/dataset_hydra_om.rb

@@ -0,0 +1,37 @@
+class Dataset < ActiveFedora::Base
+
+  class DatastreamMetadata < ActiveFedora::NokogiriDatastream
+
+    ##
+    # Here's the important part. We're mapping XML into Ruby.
+    set_terminology do |t|
+      t.root :path => 'root', :xmlns => nil
+      t.title
+      t.author
+      t.url
+      t.description
+    end
+
+    def self.xml_template
+      Nokogiri::XML::Builder.new do |xml|
+        xml.root do
+          xml.title
+          xml.author
+          xml.url
+          xml.description
+        end
+      end.doc
+    end
+  end
+
+  include Hydra::ModelMixins::CommonMetadata
+  include Hydra::ModelMethods
+
+  has_metadata :name => "descMetadata", :type => DatastreamMetadata
+
+  delegate :title, :to=>'descMetadata', :unique=>true
+  delegate :author, :to=>'descMetadata', :unique=>true
+  delegate :url, :to=>'descMetadata', :unique=>true
+  delegate :description, :to=>'descMetadata', :unique=>true
+
+end

data/templates/application/datasets_controller.rb

@@ -0,0 +1,82 @@
+class DatasetsController < ApplicationController
+  # GET /datasets
+  # GET /datasets.json
+  def index
+    @datasets = Dataset.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render json: @datasets }
+    end
+  end
+
+  # GET /datasets/1
+  # GET /datasets/1.json
+  def show
+    @dataset = Dataset.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @dataset }
+    end
+  end
+
+  # GET /datasets/new
+  # GET /datasets/new.json
+  def new
+    @dataset = Dataset.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @dataset }
+    end
+  end
+
+  # GET /datasets/1/edit
+  def edit
+    @dataset = Dataset.find(params[:id])
+  end
+
+  # POST /datasets
+  # POST /datasets.json
+  def create
+    @dataset = Dataset.new(params[:dataset])
+    respond_to do |format|
+      if @dataset.save
+        format.html { redirect_to @dataset, notice: 'Dataset was successfully created.' }
+        format.json { render json: @dataset, status: :created, location: @dataset }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @dataset.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /datasets/1
+  # PUT /datasets/1.json
+  def update
+    @dataset = Dataset.find(params[:id])
+
+    respond_to do |format|
+      if @dataset.update_attributes(params[:dataset])
+        format.html { redirect_to @dataset, notice: 'Dataset was successfully updated.' }
+        format.json { head :no_content }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @dataset.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /datasets/1
+  # DELETE /datasets/1.json
+  def destroy
+    @dataset = Dataset.find(params[:id])
+    @dataset.destroy
+
+    respond_to do |format|
+      format.html { redirect_to datasets_url }
+      format.json { head :no_content }
+    end
+  end
+end