blacklight_folders 1.0.0

data/app/views/blacklight/folders/folders/_form.html.erb

@@ -0,0 +1,78 @@
+<%= form_for @folder, html: { role: 'form', class: 'form-horizontal folder-actions' } do |f| %>
+  <div class="row">
+    <div class="col-sm-6">
+      <% if @folder.errors.any? %>
+        <div id="error_explanation">
+          <h2><%= pluralize(@folder.errors.count, "error") %> prohibited this folder from being saved:</h2>
+
+          <ul>
+          <% @folder.errors.full_messages.each do |message| %>
+            <li><%= message %></li>
+          <% end %>
+          </ul>
+        </div>
+      <% end %>
+
+      <div class="form-group">
+        <%= f.label :name, class: 'col-sm-2 control-label' %>
+        <div class="col-sm-10">
+          <%= f.text_field :name, class: 'form-control' %>
+        </div>
+      </div>
+
+      <div class="form-group">
+        <%= label_tag nil, t("blacklight/folders/folder.visibility", scope: "helpers.label"), class: 'col-sm-2 control-label' %>
+        <div class="col-sm-10">
+
+          <label class="radio-inline">
+            <%= f.radio_button(:visibility, Blacklight::Folders::Folder::PUBLIC) %>
+            <%= human_friendly_visibility(Blacklight::Folders::Folder::PUBLIC) %>
+          </label>
+
+          <label class="radio-inline">
+            <%= f.radio_button(:visibility, Blacklight::Folders::Folder::PRIVATE) %>
+            <%= human_friendly_visibility(Blacklight::Folders::Folder::PRIVATE) %>
+          </label>
+        </div>
+      </div>
+    </div>
+    <div class="col-sm-6 pull-right">
+      <div><%= f.submit class: 'btn btn-primary' %></div>
+      <% if @folder.persisted? && can?(:destroy, @folder) %>
+        <%= link_to action_label(@folder, :delete), folder_path(@folder), method: :delete, class: 'btn btn-danger', data: { confirm: "Are you sure you want to delete this folder and all its contents?" } %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class="dd" data-folder_id="<%= f.object.id %>">
+    <ol id="documents" class="dd-list">
+      <%= f.fields_for :items do |i| %>
+
+        <li class="row dd-item" data-id="<%= i.object.id %>">
+
+        <div class="col-sm-2">
+          <span class="pull-left hidden dd-handle glyphicon glyphicon-resize-vertical"></span>
+          <%= i.text_field :position, class: 'form-control position-input' %>
+        </div>
+        <div class="col-sm-6 title">
+          <% document =  @folder.documents[i.options[:child_index]] %>
+          <%= link_to_document document, document_show_link_field(document) %>
+        </div>
+        <div class="col-sm-2 title">
+          <% options_for_select = options_for_folder_select(without: document) %>
+          <% unless options_for_select.empty? %>
+            <%= i.select :folder_id, options_for_select, { include_blank: "Move to..." }, class: "form-control"  %>
+          <% end %>
+        </div>
+        <div class="col-sm-2 checkbox">
+          <label>
+            <%= i.check_box :_destroy %>
+            Delete
+          </label>
+        </div>
+        </li>
+      <% end %>
+    </ol>
+  </div>
+
+<% end %>

data/app/views/blacklight/folders/folders/_index_header_default.html.erb

@@ -0,0 +1,20 @@
+
+      <% # header bar for doc items in index view -%>
+      <div class="documentHeader row">
+
+        <%# main title container for doc partial view 
+            How many bootstrap columns need to be reserved
+            for bookmarks control depends on size. 
+        -%>
+         <h5 class="index_title col-sm-9 col-lg-10">
+         <% counter = document_counter + 1 %>
+         <span class="document-counter">
+         <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+         </span>
+         <%= link_to presenter(document).render_document_index_label(document_show_link_field(document)), main_app.solr_document_path(document) %>
+        </h5>
+
+        <% # bookmark functions for items/docs -%>
+        <%= render_index_doc_actions document, :wrapping_class => "index-document-functions col-sm-3 col-lg-2" %>
+      </div>
+

data/app/views/blacklight/folders/folders/_marc_tools.html.erb

@@ -0,0 +1,10 @@
+  <% if @folder.documents.any? {|d| d.exports_as? :endnote } %>
+    <li class="endnote">
+    <%= link_to t('blacklight.tools.endnote'), { format: :endnote }, class: "btn btn-default", id: "endnoteLink" %>
+    </li>
+  <% end %>
+  <% if @folder.documents.any? {|d| d.exports_as? :refworks_marc_txt } %>
+    <li class="refworks">
+    <%= link_to t('blacklight.tools.refworks'), refworks_export_url(url: folder_export_url(@folder, :refworks_marc_txt)), class: "btn btn-default", id: "refworksLink" %>
+    </li>
+  <% end %>

data/app/views/blacklight/folders/folders/_tools.html.erb

@@ -0,0 +1,11 @@
+<ul class="bookmarkTools nav nav-pills">
+  <li class="cite">
+    <%= link_to t('blacklight.tools.cite'), main_app.citation_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @folder.documents.map {|doc| doc.id}), {:id => 'citeLink', :name => 'citation', :class => 'btn btn-default', :data => {:ajax_modal => "trigger"}} %>
+  </li>
+
+  <li class="email">
+    <%= link_to t('blacklight.tools.email'), main_app.email_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @folder.documents.map {|doc| doc.id}), :class=>"btn btn-default", :id => "emailLink", :data => {:ajax_modal => "trigger"} %>
+  </li>
+
+  <%= render_marc_tools %>
+</ul>

data/app/views/blacklight/folders/folders/edit.html.erb

@@ -0,0 +1,2 @@
+<h1><%= t(:'.header') %></h1>
+<%= render 'form' %>

data/app/views/blacklight/folders/folders/index.html.erb

@@ -0,0 +1,33 @@
+<div class="folder-index">
+  <div class="row">
+    <h1 class="col-lg-8">Folders <small>(<%= @folders.size %> total)</small></h1>
+
+    <%= form_tag blacklight_folders.folders_path, method: :get, class:"col-lg-4", id: "sort-tool" do %>
+      <%= select_tag 'order_by', options_for_select({ 'Name' => 'name', 'Size' => 'number_of_members', 'Created' => 'created_at', 'Updated' => 'updated_at' }, params[:order_by]), prompt: "Sort by..." %>
+    <% end %>
+  </div>
+  <table id="folders" class="table">
+    <thead>
+      <tr>
+        <th><%= t('.table.headers.name') %></th>
+        <th><%= t('.table.headers.size') %></th>
+        <th><%= t('.table.headers.visibility') %></th>
+        <th><%= t('.table.headers.created') %></th>
+        <th><%= t('.table.headers.updated') %></th>
+        <th><%= t('.table.headers.actions') %></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <%= render partial: 'folder', collection: @folders %>
+    </tbody>
+  </table>
+
+  <% if can? :create, Blacklight::Folders::Folder %>
+    <div class='actions'>
+      <div class='primary-actions'>
+        <%= link_to action_label(Blacklight::Folders::Folder.new), blacklight_folders.new_folder_path, class: 'btn btn-primary' %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/blacklight/folders/folders/new.html.erb

@@ -0,0 +1,2 @@
+<h1>Create a new folder</h1>
+<%= render 'form' %>

data/app/views/blacklight/folders/folders/show.endnote.erb

@@ -0,0 +1 @@
+<%= render_endnote_texts(@folder.documents) %>

data/app/views/blacklight/folders/folders/show.html.erb

@@ -0,0 +1,43 @@
+<div class="folder-view">
+  <p id="notice"><%= notice %></p>
+
+  <% if can? :edit, @folder %>
+    <div class="primary-actions">
+      <%= link_to edit_folder_path(@folder), class: 'btn btn-default' do %>
+        <span class="glyphicon glyphicon-pencil"></span> <%= action_label(@folder, :edit_long) %>
+      <% end %>
+     </div>
+  <% end %>
+  <h1><%= @folder.name %></h1>
+  <div>
+    <span class="owner-label"><%= t("blacklight/folders/folder.user", scope: "helpers.label") %>:</span> <span class="owner"><%= @folder.user.guest? ? 'Guest' : @folder.user %></span>
+  </div>
+
+  <div>
+    <span class="visibility-label"><%= t("blacklight/folders/folder.visibility", scope: "helpers.label") %>:</span> <span class="visibility"><%= human_friendly_visibility(@folder.visibility) %></span>
+  </div>
+
+  <div>
+    <span class="created-label">
+      <%= t("blacklight/folders/folder.created", scope: "helpers.label") %>:
+    </span>
+    <span class="created" title="<%= @folder.created_at %>">
+      <%= t('blacklight.folders.folders.folder.ago', time: time_ago_in_words(@folder.created_at)) %>
+    </span>
+  </div>
+
+  <div>
+    <span class="updated-label">
+      <%= t("blacklight/folders/folder.updated", scope: "helpers.label") %>:
+    </span>
+    <span class="updated" title="<%= @folder.updated_at %>">
+      <%= t('blacklight.folders.folders.folder.ago', time: time_ago_in_words(@folder.updated_at)) %>
+    </span>
+  </div>
+
+  <%= render 'tools' %>
+
+  <div id="documents">
+    <%= render partial: 'folder_item', collection: @folder.items, locals: { docs: @folder.documents } %>
+  </div>
+</div>

data/app/views/blacklight/folders/show/_add_to_folder.html.erb

@@ -0,0 +1,18 @@
+<% options_for_select = options_for_folder_select(without: @document) %>
+
+<% unless options_for_select.empty? %>
+  <div>
+    <%= form_for :folder, url: blacklight_folders.add_bookmarks_to_folder_path, method: :patch do |f| %>
+
+      <%= hidden_field_tag(:document_ids, @document.id) %>
+
+      <div class="field">
+        <%= f.select :id, options_for_select, prompt: t(:'.select.prompt') %>
+      </div>
+
+      <div class="actions">
+        <%= f.submit 'Add to Folder', class: 'btn btn-primary btn-sm' %>
+      </div>
+    <% end %>
+  </div>
+<% end %>

data/app/views/blacklight/folders/show/_folder_controls.html.erb

@@ -0,0 +1,15 @@
+<% in_folders = Blacklight::Folders::Folder.for_user(current_or_guest_user).with_document(@document) %>
+
+<% unless in_folders.empty? %>
+  <div class="panel panel-default folders">
+    <div class="panel-heading">Folders</div>
+    <div class="panel-body">
+      <%= t('.contained_in') %>
+      <ul>
+        <% in_folders.each do |folder| %>
+          <li> <%= link_to folder.name, blacklight_folders.folder_path(folder) %> </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+<% end %>

data/app/views/blacklight/nav/_folders.html.erb

@@ -0,0 +1,14 @@
+<%= link_to "#{t(:'blacklight_folders.main_navigation.folders')} (#{current_or_guest_user.folders.size})", blacklight_folders.folders_path, id: 'folders-nav-dropdown', class: "dropdown-toggle", data: { toggle: "dropdown"}, role: "button", 'aria-expanded' => "false" %>
+
+<ul class="dropdown-menu" role="menu" aria-labeledby="folders-nav-dropdown">
+  <% if can? :create, Blacklight::Folders::Folder %>
+    <li><%= link_to t(:'helpers.action.blacklight/folders/folder.create'), blacklight_folders.new_folder_path %></li>
+    <li role="presentation" class="divider"></li>
+  <% end %>
+
+  <% current_or_guest_user.folders.most_recent.limit(Blacklight::Folders::Folder::MENU_LIMIT).each do |folder| %>
+    <li><%= link_to truncate(folder.name, length: 20), blacklight_folders.folder_path(folder) %></li>
+  <% end %>
+  <li role="presentation" class="divider"></li>
+  <li><%= link_to t(:'blacklight_folders.main_navigation.all_folders'), blacklight_folders.folders_path %></li>
+</ul>

data/app/views/catalog/_show_sidebar.html.erb

@@ -0,0 +1,11 @@
+<%= render 'show_tools' %>
+<%= render 'blacklight/folders/show/folder_controls' %>
+
+<% unless @document.more_like_this.empty? %>
+  <div class="panel panel-default">
+    <div class="panel-heading">More Like This</div>
+    <div class="panel-body">
+      <%= render collection: @document.more_like_this, partial: 'show_more_like_this', as: :document %>
+    </div>
+  </div>
+<% end %>

data/config/jetty.yml

@@ -0,0 +1,6 @@
+default:
+  jetty_port: 8983
+  java_opts:
+    - "-XX:MaxPermSize=256m"
+    - "-Xmx256m"
+  startup_wait: 60

data/config/locales/blacklight_folders.en.yml

@@ -0,0 +1,73 @@
+en:
+  helpers:
+    action:
+      edit_long: "Edit %{model}"
+      blacklight/folders/folder:
+        delete:    "Delete Folder"
+        create:    "Create a New Folder"
+        edit_long: "Edit Folder"
+    submit:
+      blacklight_folders_default: &blacklight_folders_default
+        create: "Save"
+        submit: "Save changes"
+        update: "Save changes"
+        created: "The %{model} was created."
+        updated: "The %{model} was successfully updated."
+        destroyed: "The %{model} was deleted."
+      folder:
+        submit: "Create Folder"
+        update: "Update Folder"
+        created: "The folder was created."
+        updated: "The folder was successfully updated."
+        added_one: "Added document to %{folder_name}"
+        added_many: "Added documents to %{folder_name}"
+    label:
+      blacklight/folders/folder:
+        user: "Owner"
+        visibility: "Visibility"
+        created: "Created"
+        updated: "Updated"
+  activerecord:
+    models:
+      blacklight/folders/folder_item: Item
+      blacklight/folders/folder: Folder
+    attributes:
+      blacklight/folders/folder:
+        visibility:
+          public: "Anyone"
+          private: "Only me"
+  blacklight_folders:
+    main_navigation:
+      folders: "Folders"
+      all_folders: "Show All"
+  blacklight:
+    folders:
+      add_to_folder:
+        select:
+          prompt: "Add to folder"
+      show:
+        add_to_folder:
+          select:
+            prompt: "Select a Folder"
+        folder_controls:
+          contained_in: 'This item is contained in:'
+      folders:
+        edit:
+          header: "Manage Folder"
+        index:
+          table:
+            headers:
+              name:       "Name"
+              size:       "Size"
+              visibility: "Visibility"
+              created:    "Created"
+              updated:    "Updated"
+              actions:    "Actions"
+        folder:
+          ago: "%{time} ago"
+
+      default_folder_name: "Default folder"
+  catalog:
+    search:
+      folder:
+        label: "Move checked %{doctype} to %{model}"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Blacklight::Folders::Engine.routes.draw do
+  patch '/folders/add_bookmarks', to: 'folders#add_bookmarks', as: 'add_bookmarks_to_folder'
+  patch '/folders/remove_bookmarks', to: 'folders#remove_bookmarks', as: 'remove_bookmarks_from_folder'
+  resources :folders
+end

data/db/migrate/1416883534_create_blacklight_folders_folders.rb

@@ -0,0 +1,12 @@
+class CreateBlacklightFoldersFolders < ActiveRecord::Migration
+  def change
+    create_table :blacklight_folders_folders do |t|
+      t.string :name
+      t.references :user, null: false, polymorphic: true, index: true
+      t.string :visibility
+      t.integer :number_of_members, default: 0, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/1416883577_create_blacklight_folders_folder_items.rb

@@ -0,0 +1,13 @@
+class CreateBlacklightFoldersFolderItems < ActiveRecord::Migration
+
+  def change
+    create_table :blacklight_folders_folder_items do |t|
+      t.references :folder, null: false, index: true
+      t.references :bookmark, null: false, index: true
+      t.integer :position
+
+      t.timestamps
+    end
+  end
+
+end

data/lib/blacklight_folders/engine.rb

@@ -0,0 +1,11 @@
+# Load blacklight so that we can override blacklight views
+require 'blacklight'
+require 'acts_as_list'
+require 'cancan'
+require 'select2-rails'
+
+module Blacklight::Folders
+  class Engine < ::Rails::Engine
+    isolate_namespace Blacklight::Folders
+  end
+end

data/lib/blacklight_folders/version.rb

@@ -0,0 +1,5 @@
+module Blacklight
+  module Folders
+    VERSION = "1.0.0"
+  end
+end

data/lib/blacklight_folders.rb

@@ -0,0 +1,4 @@
+require "blacklight_folders/engine"
+
+module Blacklight::Folders
+end

data/lib/generators/blacklight_folders/install_generator.rb

@@ -0,0 +1,53 @@
+module BlacklightFolders
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "It will set up your rails app to use the blacklight_folders engine.\n\n"
+
+    def copy_initializer
+      template "blacklight_folders.rb", "config/initializers/blacklight_folders.rb"
+    end
+
+    def add_routes
+      route 'mount Blacklight::Folders::Engine, at: "blacklight"'
+    end
+
+    def run_migrations
+      rake "blacklight_folders:install:migrations"
+      rake "db:migrate"
+    end
+
+    def add_model_mixins
+      inject_into_class 'app/models/user.rb', User, '  include Blacklight::Folders::User'
+      inject_into_class 'app/models/solr_document.rb', SolrDocument, '  include Blacklight::Folders::SolrDocument'
+    end
+
+    def add_controller_mixins
+      inject_into_file 'app/controllers/application_controller.rb', :after => /Blacklight::Controller\s*\n/ do
+        "  include Blacklight::Folders::ApplicationControllerBehavior\n"
+      end
+    end
+
+    def add_helper
+      copy_file "blacklight_folders_helper.rb", "app/helpers/blacklight_folders_helper.rb"
+      inject_into_class 'app/helpers/application_helper.rb', ApplicationHelper, "  include BlacklightFoldersHelper"
+    end
+
+    def add_style
+      inject_into_file 'app/assets/stylesheets/blacklight.css.scss', "@import 'blacklight_folders/blacklight_folders';", after: /@import 'blacklight\/blacklight';\s*\n/
+    end
+
+    def add_javascript
+      unless IO.read("app/assets/javascripts/application.js").include?('blacklight_folders')
+        marker = IO.read("app/assets/javascripts/application.js").include?('blacklight/blacklight') ?
+          '//= require blacklight/blacklight' : "//= require jquery_ujs"
+        insert_into_file "app/assets/javascripts/application.js", after: marker do
+  %q{
+//
+//= require blacklight_folders}
+        end
+      end
+    end
+
+  end
+end

data/lib/generators/blacklight_folders/templates/blacklight_folders.rb

@@ -0,0 +1,12 @@
+# Remove bookmark from the navbar
+CatalogController.blacklight_config.navbar.partials.delete(:bookmark)
+# Remove bookmark from catalog#index
+CatalogController.blacklight_config.index.document_actions.delete(:bookmark)
+# Remove bookmark from catalog#show
+CatalogController.blacklight_config.show.document_actions.delete(:bookmark)
+
+
+CatalogController.add_results_document_tool(:folder, partial: 'blacklight/folders/folder_control')
+CatalogController.add_results_collection_tool(:folder, partial: 'blacklight/folders/add_to_folder')
+CatalogController.add_show_tools_partial(:folder, partial: 'blacklight/folders/show/add_to_folder')
+CatalogController.add_nav_action(:folder, partial: 'blacklight/nav/folders', if: Proc.new { |ctx| ctx.current_ability.can?(:index, Blacklight::Folders::Folder)  } )

data/lib/generators/blacklight_folders/templates/blacklight_folders_helper.rb

@@ -0,0 +1,3 @@
+module BlacklightFoldersHelper
+  include Blacklight::Folders::MainAppHelper
+end

data/lib/migration/bookmark_migrator.rb

@@ -0,0 +1,45 @@
+class BookmarkMigrator
+
+  attr_reader :errors
+
+  def initialize(options={})
+    @verbose = options[:verbose]
+    @logging = options[:logging]
+    @errors = []
+    @default_folder_name = I18n.translate(:'blacklight.folders.default_folder_name')
+  end
+
+  def migrate
+    raise 'Default folder name is not defined' if @default_folder_name.match(/translation missing/)
+    @errors = []
+    log_message 'Begin migration of existing bookmarks.'
+
+    User.where(guest: false).find_each do |user|
+      folder = default_folder(user)
+      bookmarks_to_add = user.bookmarks - folder.bookmarks
+      bookmarks_to_add.map do |b|
+        folder.items.build(bookmark: b)
+      end
+
+      unless folder.save
+        msg = "Unable to save bookmarks to folder: #{folder.id}"
+        log_message "ERROR: #{msg}"
+        @errors << msg
+      end
+    end
+
+    log_message "Migration complete with #{@errors.count} errors."
+    @errors.empty?
+  end
+
+  def default_folder(user)
+    folder = user.folders.where(name: @default_folder_name).first
+    folder ||= user.create_default_folder
+  end
+
+  def log_message(message)
+    puts message if @verbose
+    Rails.logger.info "#{self.class}: #{message}" if @logging
+  end
+
+end

data/lib/tasks/blacklight_folders_tasks.rake

@@ -0,0 +1,12 @@
+namespace :blacklight_folders do
+  namespace :db do
+
+    desc "Convert existing bookmarks to a folder with bookmarks"
+    task :migrate_data => :environment do
+      require 'migration/bookmark_migrator'
+      migrator = BookmarkMigrator.new(verbose: true, logging: true)
+      migrator.migrate
+    end
+
+  end
+end