hydra-collections 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f0a6d73f747ff5aaa1026b064e55730c1605f36
-  data.tar.gz: 8e5a8f2069f9fc74e661eb2389a4ea6e0b164421
+  metadata.gz: 33c94d0cf369a533ff8bb7d039edbafbacb9a163
+  data.tar.gz: c4f56e2253e1e648dd131d3cd334f37eeacac791
 SHA512:
-  metadata.gz: fd07c424bb502667e7cb2cb48aba65de9e14785df444d16a816a7d4169c81a886aa0aaff8e2fcc7ce754fbec0651e7fcf2de3b0e8ee03355d625c21b4db08a19
-  data.tar.gz: 045f31a8e3b174596bcc985be730f642dc3b7beea5b1fb134758fc67050ecde128b9158ffb5706c1f5a3dce138148600c963527bd496fbbe87daccd596929bf7
+  metadata.gz: e982f879d4dff4125fc229ede046443c167459e81185a8944701eb8cd5cfc80d44506b52ec6869c4dd24e1adf341096dc4056cb16d82ac6b460737192be65aa4
+  data.tar.gz: 280d86d67f35cd18f1a693f3799cf17864819d047275ae91bcded8c34aa1d45b688e716e9d22097971d59638f7fa89372b2870062fae88db607dced13365ff90

data/README.md

@@ -12,6 +12,9 @@ And then execute:
 
     $ bundle
 
+Finally run:
+    $ rails generate hydra:collections:install
+
 Or install it yourself as:
 
     $ gem install hydra-collections

data/app/helpers/collections_helper.rb

@@ -1,54 +1,4 @@
 # View Helpers for Hydra Collections functionality
 module CollectionsHelper
-  def has_collection_search_parameters?
-    !params[:cq].blank?
-  end
-
-  # Displays the Collections create collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
-  def button_for_create_collection(label = 'Create Collection')
-    render '/collections/button_create_collection', label: label
-  end
-
-  # Displays the Collections update collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
-  def button_for_update_collection(label = 'Update Collection', collection_id = 'collection_replace_id')
-    render '/collections/button_for_update_collection', label: label, collection_id: collection_id
-  end
-
-  # Displays the Collections delete collection button.  Put this in your search result page for each collection found.
-  def button_for_delete_collection(collection, label = 'Delete Collection', confirm = 'Are you sure?')
-    render '/collections/button_for_delete_collection', collection: collection, label: label, confirm: confirm
-  end
-
-  def button_for_remove_from_collection(collection, document, label = 'Remove From Collection')
-    render '/collections/button_remove_from_collection', collection: collection, label: label, document: document
-  end
-
-  def button_for_remove_selected_from_collection(collection, label = 'Remove From Collection')
-    render '/collections/button_for_remove_selected_from_collection', collection: collection, label: label
-  end
-
-  # add hidden fields to a form for removing a single document from a collection
-  def single_item_action_remove_form_fields(form, document)
-    single_item_action_form_fields(form, document, 'remove')
-  end
-
-  # add hidden fields to a form for adding a single document to a collection
-  def single_item_action_add_form_fields(form, document)
-    single_item_action_form_fields(form, document, 'add')
-  end
-
-  # add hidden fields to a form for performing an action on a single document on a collection
-  def single_item_action_form_fields(form, document, action)
-    render '/collections/single_item_action_fields', form: form, document: document, action: action
-  end
-
-  def hidden_collection_members
-    _erbout = ''
-    if params[:batch_document_ids].present?
-      params[:batch_document_ids].each do |batch_item|
-        _erbout.concat hidden_field_tag('batch_document_ids[]', batch_item)
-      end
-    end
-    _erbout.html_safe
-  end
+  include Hydra::Collections::CollectionsHelperBehavior
 end

data/app/helpers/hydra/collections/collections_helper_behavior.rb

@@ -0,0 +1,56 @@
+# View Helpers for Hydra Collections functionality
+module Hydra::Collections
+  module CollectionsHelperBehavior
+    def has_collection_search_parameters?
+      !params[:cq].blank?
+    end
+
+    # Displays the Collections create collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+    def button_for_create_collection(label = 'Create Collection')
+      render '/collections/button_create_collection', label: label
+    end
+
+    # Displays the Collections update collection button.  Put this in your search result page template.  We recommend putting it in catalog/_sort_and_per_page.html.erb
+    def button_for_update_collection(label = 'Update Collection', collection_id = 'collection_replace_id')
+      render '/collections/button_for_update_collection', label: label, collection_id: collection_id
+    end
+
+    # Displays the Collections delete collection button.  Put this in your search result page for each collection found.
+    def button_for_delete_collection(collection, label = 'Delete Collection', confirm = 'Are you sure?')
+      render '/collections/button_for_delete_collection', collection: collection, label: label, confirm: confirm
+    end
+
+    def button_for_remove_from_collection(collection, document, label = 'Remove From Collection')
+      render '/collections/button_remove_from_collection', collection: collection, label: label, document: document
+    end
+
+    def button_for_remove_selected_from_collection(collection, label = 'Remove From Collection')
+      render '/collections/button_for_remove_selected_from_collection', collection: collection, label: label
+    end
+
+    # add hidden fields to a form for removing a single document from a collection
+    def single_item_action_remove_form_fields(form, document)
+      single_item_action_form_fields(form, document, 'remove')
+    end
+
+    # add hidden fields to a form for adding a single document to a collection
+    def single_item_action_add_form_fields(form, document)
+      single_item_action_form_fields(form, document, 'add')
+    end
+
+    # add hidden fields to a form for performing an action on a single document on a collection
+    def single_item_action_form_fields(form, document, action)
+      render '/collections/single_item_action_fields', form: form, document: document, action: action
+    end
+
+    def hidden_collection_members
+      _erbout = ''
+      if params[:batch_document_ids].present?
+        params[:batch_document_ids].each do |batch_item|
+          _erbout.concat hidden_field_tag('batch_document_ids[]', batch_item)
+        end
+      end
+      _erbout.html_safe
+    end
+  end
+end

data/app/models/collection.rb

@@ -1,3 +1,4 @@
 class Collection < ActiveFedora::Base
   include Hydra::Collection
+  include Hydra::Collections::BasicMetadata
 end

data/app/models/concerns/hydra/collection.rb

@@ -5,7 +5,7 @@ module Hydra
     include Hydra::Works::CollectionBehavior
     include Hydra::WithDepositor # for access to apply_depositor_metadata
     include Hydra::AccessControls::Permissions
-    include Hydra::Collections::Metadata
+    include Hydra::Collections::RequiredMetadata
     include Hydra::Works::CollectionBehavior
 
 

data/app/models/concerns/hydra/collections/{metadata.rb → basic_metadata.rb}

@@ -1,11 +1,7 @@
 module Hydra::Collections
-  module Metadata
+  module BasicMetadata
     extend ActiveSupport::Concern
     included do
-      property :depositor, predicate: RDF::Vocab::MARCRelators.dpt, multiple: false do |index|
-        index.as :symbol, :stored_searchable
-      end
-
       property :part_of, predicate: RDF::Vocab::DC.isPartOf
 
       property :contributor, predicate: RDF::Vocab::DC.contributor do |index|

data/app/models/concerns/hydra/collections/required_metadata.rb

@@ -0,0 +1,10 @@
+module Hydra::Collections
+  module RequiredMetadata
+    extend ActiveSupport::Concern
+    included do
+      property :depositor, predicate: RDF::Vocab::MARCRelators.dpt, multiple: false do |index|
+        index.as :symbol, :stored_searchable
+      end
+    end
+  end
+end

data/lib/generators/hydra/collections/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Hydra::Collections
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'This generator makes the following changes to your application:
+   1. Creates a collection model.
+'
+
+    def collection
+      copy_file "collection.rb", "app/models/collection.rb"
+    end
+  end
+end

data/lib/generators/hydra/collections/templates/collection.rb

@@ -0,0 +1,7 @@
+class Collection < ActiveFedora::Base
+  include Hydra::Collection
+
+  # You can replace these metadata if they're not suitable
+  include Hydra::Collections::BasicMetadata
+end
+

data/lib/hydra/collections/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Collections
-    VERSION = "8.0.0"
+    VERSION = "8.1.0"
   end
 end

data/spec/controllers/other_collections_controller_spec.rb

@@ -5,6 +5,7 @@ describe OtherCollectionsController, :type => :controller do
   before(:all) do
     class OtherCollection < ActiveFedora::Base
       include Hydra::Collection
+      property :title, predicate: ::RDF::Vocab::DC.title
     end
 
     class Member < ActiveFedora::Base

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -21,6 +21,12 @@ class TestAppGenerator < Rails::Generators::Base
     generate 'hydra:head', '-f'
   end
 
+  def run_collections_generator
+    say_status("warning", "GENERATING Collection", :yellow)
+
+    generate 'hydra:collections:install'
+  end
+
   def run_migrations
     rake("db:migrate")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-collections
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Carolyn Cole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hydra-head
@@ -161,9 +161,11 @@ files:
 - app/controllers/concerns/hydra/collections_controller_behavior.rb
 - app/helpers/batch_select_helper.rb
 - app/helpers/collections_helper.rb
+- app/helpers/hydra/collections/collections_helper_behavior.rb
 - app/models/collection.rb
 - app/models/concerns/hydra/collection.rb
-- app/models/concerns/hydra/collections/metadata.rb
+- app/models/concerns/hydra/collections/basic_metadata.rb
+- app/models/concerns/hydra/collections/required_metadata.rb
 - app/models/concerns/hydra/collections/solr_document_behavior.rb
 - app/models/solr_document.rb
 - app/search_builders/hydra/collections/member_search_builder.rb
@@ -199,6 +201,8 @@ files:
 - gemfiles/rails3.gemfile
 - gemfiles/rails4.gemfile
 - hydra-collections.gemspec
+- lib/generators/hydra/collections/install_generator.rb
+- lib/generators/hydra/collections/templates/collection.rb
 - lib/hydra-collections.rb
 - lib/hydra/collections/accepts_batches.rb
 - lib/hydra/collections/search_service.rb