worthwhile 0.0.1.alpha → 0.0.1

data/app/views/worthwhile/classify_concerns/new.html.erb

@@ -0,0 +1,27 @@
+<% content_for :page_header do %>
+
+<h2>What are you uploading?</h2>
+<p>Before we can begin we need to know a little about what you're uploading.</p>
+
+<% end %>
+
+
+<div class="row">
+  <ul class="classify-work">
+    <% classify_concern.all_curation_concern_classes.each do |klass| %>
+      <% if can? :create, klass %>
+        <li class="work-type">
+          <h3 class="title"><%= klass.human_readable_type %></h3>
+          <p class="short-description"><%= klass.human_readable_short_description %></p>
+          <%= link_to 'Add New',
+            main_app.new_polymorphic_path([:curation_concern, klass]),
+            class: "add-button btn btn-primary #{dom_class(klass, 'add_new')}"
+          %>
+        </li>
+      <% end %>
+    <% end %>
+    <li class="work-type placeholder" aria-hidden="true"></li>
+    <li class="work-type placeholder" aria-hidden="true"></li>
+    <li class="work-type placeholder" aria-hidden="true"></li>
+  </ul>
+</div>

data/app/workers/visibility_copy_worker.rb

@@ -0,0 +1,29 @@
+class VisibilityCopyWorker
+  def queue_name
+    :permissions
+  end
+
+  attr_accessor :pid
+
+  def initialize(pid)
+    self.pid = pid
+  end
+
+  def run
+    work = ActiveFedora::Base.find(pid)
+    work.generic_files.each do |file|
+      # visibility must come first, because it can clear an embargo/lease
+      file.visibility = work.visibility
+
+      file.embargo_release_date = work.embargo_release_date
+      file.visibility_during_embargo = work.visibility_during_embargo
+      file.visibility_after_embargo = work.visibility_after_embargo
+
+      file.lease_expiration_date = work.lease_expiration_date
+      file.visibility_during_lease = work.visibility_during_lease
+      file.visibility_after_lease = work.visibility_after_lease
+      file.save!
+    end
+  end
+end
+

data/config/initializers/simple_form.rb

@@ -0,0 +1,31 @@
+require 'simple_form'
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  config.wrappers :inline, tag: 'span', class: 'form-group inline', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label, class: 'control-label'
+    b.use :input, class: 'form-control'
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+  end
+
+  config.wrappers :vertical_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label, class: 'control-label'
+    b.wrapper tag: 'div' do |ba|
+      ba.use :input, class: 'form-control'
+      ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+
+  # Wrappers for forms and inputs using the Twitter Bootstrap toolkit.
+  # Check the Bootstrap docs (http://getbootstrap.com/css/)
+  # to learn about the different styles for forms and inputs,
+  # buttons and other elements.
+  config.default_wrapper = :vertical_form
+
+  config.error_notification_class = 'alert alert-danger'
+  config.button_class = 'btn btn-default'
+end

data/config/locales/sufia.en.yml

@@ -0,0 +1,26 @@
+en:
+  sufia:
+    product_name:       "Curate"
+    institution_name:   "Your Institution"
+    institution_homepage_url:   "#"
+    division_name:      "Your Division at Institution"
+    division_homepage_url:   "#"
+    search:
+      form:
+        q:
+          label:        "Search Curate"
+          placeholder:  "Type keywords in here"
+    search_facets:
+      label:            "View:"
+    profile:
+      default_title:    "Selected Works:"
+    work:
+      editor:
+        legend:         "Content Editors"
+        caption:        "Who should be able to make changes to this work?"
+        individual:
+          name:         "Individual"
+          help:         "At least one person should be able to edit this work"
+        group:
+          name:         "Group"
+          help:         "Add groups to allow others to collaboratively edit this work."

data/config/locales/worthwhile.en.yml

@@ -0,0 +1,68 @@
+en:
+  worthwhile:
+    catalog:
+      index:
+        type_tabs:
+          all: All
+  blacklight:
+    search:
+      fields:
+        facet:
+          human_readable_type_sim: Type of Work
+          desc_metadata__creator_sim: Creator
+          desc_metadata__tag_sim: Keyword
+          desc_metadata__subject_sim: Subject
+          desc_metadata__language_sim: Language
+          desc_metadata__based_near_sim: Location
+          desc_metadata__publisher_sim: Publisher
+          file_format_sim: Format 
+          generic_type_sim: Type
+        index:
+          desc_metadata__description_tesim: "Description"
+          desc_metadata__tag_tesim: "Keyword"
+          desc_metadata__subject_tesim: "Subject"
+          desc_metadata__creator_tesim: "Creator"
+          desc_metadata__contributor_tesim: "Contributor"
+          desc_metadata__publisher_tesim: "Publisher"
+          desc_metadata__based_near_tesim: "Location"
+          desc_metadata__language_tesim: "Language"
+          desc_metadata__date_uploaded_tesi: "Date Uploaded"
+          desc_metadata__date_modified_tesi: "Date Modified"
+          desc_metadata__date_created_tesim: "Date Created"
+          desc_metadata__rights_tesim: "Rights"
+          human_readable_type_tesim: "Resource Type"
+          desc_metadata__format_tesim: "File Format"
+          desc_metadata__identifier_tesim: "Identifier"
+        show:
+          desc_metadata__title_tesim: "Title"
+          desc_metadata__description_tesim: "Description"
+          desc_metadata__tag_tesim: "Keyword"
+          desc_metadata__subject_tesim: "Subject"
+          desc_metadata__creator_tesim: "Creator"
+          desc_metadata__contributor_tesim: "Contributor"
+          desc_metadata__publisher_tesim: "Publisher"
+          desc_metadata__based_near_tesim: "Location"
+          desc_metadata__language_tesim: "Language"
+          desc_metadata__date_uploaded_tesi: "Date Uploaded"
+          desc_metadata__date_modified_tesi: "Date Modified"
+          desc_metadata__date_created_tesim: "Date Created"
+          desc_metadata__rights_tesim: "Rights"
+          human_readable_type_tesim: "Resource Type"
+          desc_metadata__format_tesim: "File Format"
+          desc_metadata__identifier_tesim: "Identifier"
+  simple_form:
+    hints:
+      defaults:
+        description: 'Please keep your description to 300 words or fewer.'
+    labels:
+      defaults:
+        lease_expiration_date:     'until'
+        embargo_release_date:      'until'
+        visibility_during_embargo: 'Restricted to'
+        visibility_after_embargo:  'then open it up to'
+        visibility_during_lease:   'Is available for'
+        visibility_after_lease:    'then restrict it to'
+
+
+
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+Worthwhile::Engine.routes.draw do
+  # mount BrowseEverything::Engine => '/remote_files/browse'
+  resources :classify_concerns, only: [:new, :create]
+end

data/lib/generators/worthwhile/install_generator.rb

@@ -0,0 +1,74 @@
+require 'rails/generators'
+
+module Worthwhile
+  class Install < Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def run_blacklight_generator
+      say_status("warning", "GENERATING BL", :yellow)
+      generate 'blacklight:install', '--devise'
+
+      say_status("warning", "GENERATING HYDRA-HEAD", :yellow)
+      generate "hydra:head -f"
+
+      say_status("warning", "GENERATING SUFIA", :yellow)
+      generate "sufia:models:install#{options[:force] ? ' -f' : ''}"
+    end
+
+    def remove_catalog_controller
+      say_status("warning", "Removing Blacklight's generated CatalogController...", :yellow)
+      remove_file('app/controllers/catalog_controller.rb')
+    end
+    
+    def inject_application_controller_behavior
+      inject_into_file 'app/controllers/application_controller.rb', :after => /Blacklight::Controller\s*\n/ do
+        "  include Worthwhile::ApplicationControllerBehavior\n"
+      end
+    end
+
+    def inject_routes
+      inject_into_file 'config/routes.rb', :after => /devise_for :users\s*\n/ do
+        "  mount Hydra::Collections::Engine => '/'\n"\
+        "  mount Worthwhile::Engine, at: '/'\n"\
+        "  worthwhile_collections\n"\
+        "  worthwhile_curation_concerns\n"\
+        "  worthwhile_embargo_management\n"\
+      end
+    end
+
+    def inject_ability
+      inject_into_file 'app/models/ability.rb', :after => /Hydra::Ability\s*\n/ do
+        "  include Worthwhile::Ability\n"\
+        "  self.ability_logic += [:everyone_can_create_curation_concerns]\n\n"
+      end
+    end
+
+    # Add behaviors to the SolrDocument model
+    def inject_solr_document_behavior
+      file_path = "app/models/solr_document.rb"
+      if File.exists?(file_path)
+        inject_into_file file_path, after: /include Blacklight::Solr::Document.*$/ do
+          "\n  # Adds Worthwhile behaviors to the SolrDocument.\n" +
+            "  include Worthwhile::SolrDocumentBehavior\n"
+        end
+      else
+        puts "     \e[31mFailure\e[0m  Worthwhile requires a SolrDocument object. This generators assumes that the model is defined in the file #{file_path}, which does not exist."
+      end
+    end
+
+    def assets
+      copy_file "worthwhile.css.scss", "app/assets/stylesheets/worthwhile.css.scss"
+      copy_file "worthwhile.js", "app/assets/javascripts/worthwhile.js"
+    end
+
+    def add_helper
+      copy_file "worthwhile_helper.rb", "app/helpers/worthwhile_helper.rb"
+      #inject_into_class 'app/helpers/application_helper.rb', ApplicationHelper, "  include WorthwhileHelper"
+    end
+    
+    def add_config_file
+      copy_file "worthwhile_config.rb", "config/initializers/worthwhile_config.rb"
+    end
+  end
+end

data/lib/generators/worthwhile/templates/worthwhile.css.scss

@@ -0,0 +1,3 @@
+@import 'worthwhile/variables_bootstrap';
+@import 'bootstrap';
+@import 'worthwhile/worthwhile';

data/lib/generators/worthwhile/templates/worthwhile.js

@@ -0,0 +1 @@
+//= require worthwhile/application

data/lib/generators/worthwhile/templates/worthwhile_config.rb

@@ -0,0 +1,3 @@
+Worthwhile.configure do |config|
+  config.register_curation_concern 'GenericWork'
+end

data/lib/generators/worthwhile/templates/worthwhile_helper.rb

@@ -0,0 +1,4 @@
+module WorthwhileHelper
+  include ::BlacklightHelper
+  include Worthwhile::MainAppHelpers
+end

data/lib/worthwhile.rb

@@ -1,5 +1,7 @@
 require "worthwhile/version"
+require 'worthwhile/engine'
+require 'worthwhile/configuration'
 
 module Worthwhile
-  # Your code goes here...
+
 end

data/lib/worthwhile/configuration.rb

@@ -0,0 +1,74 @@
+module Worthwhile
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    # An anonymous function that receives a path to a file
+    # and returns AntiVirusScanner::NO_VIRUS_FOUND_RETURN_VALUE if no
+    # virus is found; Any other returned value means a virus was found
+    attr_writer :default_antivirus_instance
+    def default_antivirus_instance
+      @default_antivirus_instance ||= lambda {|file_path|
+        AntiVirusScanner::NO_VIRUS_FOUND_RETURN_VALUE
+      }
+    end
+
+    # Configure default search options from config/search_config.yml
+    attr_writer :search_config
+    def search_config
+      @search_config ||= "search_config not set"
+    end
+
+    # Configure the application root url.
+    attr_writer :application_root_url
+    def application_root_url
+      @application_root_url || (raise RuntimeError.new("Make sure to set your Worthwhile.configuration.application_root_url"))
+    end
+
+    # When was this last built/deployed
+    attr_writer :build_identifier
+    def build_identifier
+      # If you restart the server, this could be out of sync; A better
+      # implementation is to read something from the file system. However
+      # that detail is an exercise for the developer.
+      @build_identifier ||= Time.now.strftime("%Y-%m-%d %H:%M:%S")
+    end
+
+    # Override characterization runner
+    attr_accessor :characterization_runner
+
+    def register_curation_concern(*curation_concern_types)
+      Array(curation_concern_types).flatten.compact.each do |cc_type|
+        class_name = normalize_concern_name(cc_type)
+        if ! registered_curation_concern_types.include?(class_name)
+          self.registered_curation_concern_types << class_name
+        end
+      end
+    end
+
+    # Returns the class names (strings) of the registered curation concerns
+    def registered_curation_concern_types
+      @registered_curation_concern_types ||= []
+    end
+
+    # Returns the classes of the registered curation concerns
+    def curation_concerns
+      registered_curation_concern_types.map(&:constantize)
+    end
+
+    private
+
+    def normalize_concern_name(c)
+      c.to_s.camelize
+    end
+  end
+
+  configure {}
+end

data/lib/worthwhile/controller_resource.rb

@@ -0,0 +1,10 @@
+module Worthwhile
+  class ControllerResource < CanCan::ControllerResource
+    protected
+
+    # Override resource_params to make this a nop. Worthwhile uses actors to assign attributes
+    def resource_params
+      {}
+    end
+  end
+end

data/lib/worthwhile/engine.rb

@@ -0,0 +1,20 @@
+#Load blacklight which will give worthwhile views a higher preference than those in blacklight
+require 'blacklight'
+require 'sufia/models'  
+require 'hydra-collections'
+
+module Worthwhile
+  class Engine < ::Rails::Engine
+    isolate_namespace Worthwhile
+    require 'breadcrumbs_on_rails'
+
+    config.autoload_paths += %W(
+     #{config.root}/lib
+     #{config.root}/app/actors/concerns
+    )
+    
+    initializer 'worthwhile.initialize' do
+      require 'worthwhile/rails/routes' 
+    end
+  end
+end

data/lib/worthwhile/rails/routes.rb

@@ -0,0 +1,78 @@
+module ActionDispatch::Routing
+  class Mapper
+    
+    def worthwhile_curation_concerns 
+      resources :downloads, only: :show
+      namespace :curation_concern, path: :concern do
+        Worthwhile.configuration.registered_curation_concern_types.map(&:tableize).each do |curation_concern_name|
+          namespaced_resources curation_concern_name, except: [:index]
+        end
+        resources :permissions, only: [] do
+          member do
+            get :confirm
+            post :copy
+          end
+        end
+        resources :linked_resources, only: [:new, :create], path: 'container/:parent_id/linked_resources'
+        resources :linked_resources, only: [:show, :edit, :update, :destroy]
+        resources :generic_files, only: [:new, :create], path: 'container/:parent_id/generic_files'
+        resources :generic_files, only: [:show, :edit, :update, :destroy] do
+          member do
+            get :versions
+            put :rollback
+          end
+        end
+      end
+    end
+
+    # Used in conjunction with Hydra::Collections::Engine routes.
+    # Adds routes for doing paginated searches within a collection's contents
+    # @example in routes.rb:
+    #     mount Hydra::Collections::Engine => '/'
+    #     worthwhile_collections
+    def worthwhile_collections
+      resources :collections, only: :show do
+        member do
+          get 'page/:page', action: :index
+          get 'facet/:id', action: :facet, as: :dashboard_facet
+        end
+        collection do
+          get :add_member_form
+          put '', action: :update
+          put :remove_member
+        end
+      end
+    end
+
+    def worthwhile_embargo_management
+      resources :embargoes, only: [:index, :edit, :destroy] do
+        collection do
+          patch :update
+        end
+      end
+      resources :leases, only: [:index, :edit, :destroy] do
+        collection do
+          patch :update
+        end
+      end
+    end
+    
+    private
+    # Namespaces routes appropriately
+    # @example route_namespaced_target("worthwhile/generic_work") is equivalent to
+    #   namespace "worthwhile" do
+    #     resources "generic_work", except: [:index]
+    #   end
+    def namespaced_resources(target, opts={})
+      if target.include?("/")
+        the_namespace = target[0..target.index("/")-1]
+        new_target = target[target.index("/")+1..-1]
+        namespace the_namespace do 
+          namespaced_resources(new_target, opts)
+        end
+      else
+        resources target, opts
+      end
+    end
+  end
+end