test_hyrax 0.0.1.alpha

data/app/helpers/hyrax/citations_behaviors/formatters/chicago_formatter.rb

@@ -0,0 +1,58 @@
+module Hyrax
+  module CitationsBehaviors
+    module Formatters
+      class ChicagoFormatter < BaseFormatter
+        include Hyrax::CitationsBehaviors::PublicationBehavior
+        include Hyrax::CitationsBehaviors::TitleBehavior
+
+        def format(work)
+          text = ""
+
+          # setup formatted author list
+          authors_list = all_authors(work)
+          text << format_authors(authors_list)
+          unless text.blank?
+            text = "<span class=\"citation-author\">#{text}</span>"
+          end
+          # Get Pub Date
+          pub_date = setup_pub_date(work)
+          text << " #{pub_date}." unless pub_date.nil?
+          text << "." unless text.blank? || text =~ /\.$/
+
+          text << format_title(work.to_s)
+          pub_info = setup_pub_info(work, false)
+          text << " #{pub_info}." unless pub_info.blank?
+          text.html_safe
+        end
+
+        def format_authors(authors_list = [])
+          unless authors_list.blank?
+            text = ''
+            text << surname_first(authors_list.first) if authors_list.first
+            authors_list[1..6].each_with_index do |author, index|
+              text << if index + 2 == authors_list.length # we've skipped the first author
+                        ", and #{given_name_first(author)}."
+                      else
+                        ", #{given_name_first(author)}"
+                      end
+            end
+            text << " et al." if authors_list.length > 7
+          end
+          # if for some reason the first author ended with a comma
+          text.gsub!(',,', ',')
+          text << "." unless text =~ /\.$/
+          text
+        end
+
+        def format_date(pub_date); end
+
+        def format_title(title_info)
+          return "" if title_info.blank?
+          title_text = chicago_citation_title(title_info)
+          title_text << '.' unless title_text =~ /\.$/
+          " <i class=\"citation-title\">#{title_text}</i>"
+        end
+      end
+    end
+  end
+end

data/app/helpers/hyrax/citations_behaviors/formatters/mla_formatter.rb

@@ -0,0 +1,64 @@
+module Hyrax
+  module CitationsBehaviors
+    module Formatters
+      class MlaFormatter < BaseFormatter
+        include Hyrax::CitationsBehaviors::PublicationBehavior
+        include Hyrax::CitationsBehaviors::TitleBehavior
+
+        def format(work)
+          text = ''
+
+          # setup formatted author list
+          authors = author_list(work).select { |author| !author.blank? }
+          text << "<span class=\"citation-author\">#{format_authors(authors)}</span>"
+          # setup title
+          title_info = setup_title_info(work)
+          text << format_title(title_info)
+
+          # Publication
+          pub_info = clean_end_punctuation(setup_pub_info(work, true))
+
+          text << pub_info unless pub_info.blank?
+          text << "." unless text.blank? || text =~ /\.$/
+          text.html_safe
+        end
+
+        def format_authors(authors_list = [])
+          return "" if authors_list.blank?
+          authors_list = Array.wrap(authors_list)
+          text = concatenate_authors_from(authors_list)
+          unless text.blank?
+            text << "." unless text =~ /\.$/
+            text << " "
+          end
+          text
+        end
+
+        def concatenate_authors_from(authors_list)
+          text = ''
+          text << surname_first(authors_list.first)
+          if authors_list.length > 1
+            if authors_list.length < 4
+              authors_list[1...-1].each do |author|
+                text << ", " << given_name_first(author)
+              end
+              text << ", and #{given_name_first(authors_list.last)}"
+            else
+              text << ", et al"
+            end
+          end
+          text
+        end
+        private :concatenate_authors_from
+
+        def format_date(pub_date)
+          pub_date
+        end
+
+        def format_title(title_info)
+          title_info.blank? ? "" : "<i class=\"citation-title\">#{mla_citation_title(title_info)}</i> "
+        end
+      end
+    end
+  end
+end

data/app/helpers/hyrax/citations_behaviors/formatters/open_url_formatter.rb

@@ -0,0 +1,41 @@
+module Hyrax
+  module CitationsBehaviors
+    module Formatters
+      class OpenUrlFormatter < BaseFormatter
+        def format(work)
+          export_text = []
+          export_text << "url_ver=Z39.88-2004&ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&rfr_id=info%3Asid%2Fblacklight.rubyforge.org%3Agenerator"
+          field_map.each do |element, kev|
+            next unless work.respond_to?(element)
+            values = work.send(element)
+            Array.wrap(values).each do |value|
+              next if value.blank?
+              export_text << "rft.#{kev}=#{CGI.escape(value.to_s)}"
+            end
+          end
+          export_text.join('&') unless export_text.blank?
+        end
+
+        private
+
+          def field_map
+            {
+              title: 'title',
+              creator: 'creator',
+              subject: 'subject',
+              description: 'description',
+              publisher: 'publisher',
+              contributor: 'contributor',
+              date_created: 'date',
+              resource_type: 'format',
+              identifier: 'identifier',
+              language: 'language',
+              keyword: 'relation',
+              based_near: 'coverage',
+              rights: 'rights'
+            }
+          end
+      end
+    end
+  end
+end

data/app/helpers/hyrax/citations_behaviors/name_behavior.rb

@@ -0,0 +1,51 @@
+module Hyrax
+  module CitationsBehaviors
+    module NameBehavior
+      include Hyrax::CitationsBehaviors::CommonBehavior
+      # return all unique authors with end punctuation removed
+      def author_list(work)
+        all_authors(work) { |author| clean_end_punctuation(CGI.escapeHTML(author)) }
+      end
+
+      # return all unique authors of a work or nil if none
+      def all_authors(work, &block)
+        authors = work.creator.uniq.compact
+        block_given? ? authors.map(&block) : authors
+      end
+
+      def given_name_first(name)
+        name = clean_end_punctuation(name)
+        return name unless name =~ /,/
+        temp_name = name.split(/,\s*/)
+        temp_name.last + " " + temp_name.first
+      end
+
+      def surname_first(name)
+        name = name.join('') if name.is_a? Array
+        # make sure we handle "Cher" correctly
+        return name if name.include?(',')
+        name_segments = name.split(' ')
+        given_name = name_segments.first
+        surnames = name_segments[1..-1]
+        if surnames
+          "#{surnames.join(' ')}, #{given_name}"
+        else
+          given_name
+        end
+      end
+
+      def abbreviate_name(name)
+        abbreviated_name = ''
+        name = name.join('') if name.is_a? Array
+
+        # make sure we handle "Cher" correctly
+        return name unless name.include?(' ') || name.include?(',')
+        name = surname_first(name)
+        name_segments = name.split(/,\s*/)
+        abbreviated_name << name_segments.first
+        abbreviated_name << ", #{name_segments.last.first}" if name_segments[1]
+        abbreviated_name << "."
+      end
+    end
+  end
+end

data/app/helpers/hyrax/citations_behaviors/publication_behavior.rb

@@ -0,0 +1,40 @@
+module Hyrax
+  module CitationsBehaviors
+    module PublicationBehavior
+      include Hyrax::CitationsBehaviors::CommonBehavior
+      def setup_pub_date(work)
+        first_date = work.date_created.first if work.date_created
+        unless first_date.blank?
+          first_date = CGI.escapeHTML(first_date)
+          date_value = first_date.gsub(/[^0-9|n\.d\.]/, "")[0, 4]
+          return nil if date_value.nil?
+        end
+        clean_end_punctuation(date_value) if date_value
+      end
+
+      def setup_pub_place(work)
+        work.based_near.first if work.based_near
+      end
+
+      def setup_pub_publisher(work)
+        work.publisher.first if work.publisher
+      end
+
+      def setup_pub_info(work, include_date = false)
+        pub_info = ""
+        if (place = setup_pub_place(work))
+          pub_info << CGI.escapeHTML(place)
+        end
+        if (publisher = setup_pub_publisher(work))
+          pub_info << ": " << CGI.escapeHTML(publisher)
+        end
+
+        pub_date = include_date ? setup_pub_date(work) : nil
+        pub_info << ", " << pub_date unless pub_date.nil?
+
+        pub_info.strip!
+        pub_info.blank? ? nil : pub_info
+      end
+    end
+  end
+end

data/app/helpers/hyrax/citations_behaviors/title_behavior.rb

@@ -0,0 +1,52 @@
+module Hyrax
+  module CitationsBehaviors
+    module TitleBehavior
+      include Hyrax::CitationsBehaviors::CommonBehavior
+
+      TITLE_NOCAPS = ["a", "an", "and", "but", "by", "for", "it", "of", "the", "to", "with"].freeze
+      EXPANDED_NOCAPS = TITLE_NOCAPS + ["about", "across", "before", "without"]
+
+      def chicago_citation_title(title_text)
+        process_title_parts(title_text) do |w, index|
+          if (index.zero? && w.casecmp(w).zero?) || (w.length > 1 && w.casecmp(w).zero? && !EXPANDED_NOCAPS.include?(w))
+            # the split("-") will handle the capitalization of hyphenated words
+            w.split("-").map!(&:capitalize).join("-")
+          else
+            w
+          end
+        end
+      end
+
+      def mla_citation_title(title_text)
+        process_title_parts(title_text) do |w|
+          if TITLE_NOCAPS.include? w
+            w
+          else
+            w.capitalize
+          end
+        end
+      end
+
+      def process_title_parts(title_text, &block)
+        if block_given?
+          title_text.split(" ").collect.with_index(&block).join(" ")
+        else
+          title_text
+        end
+      end
+
+      def setup_title_info(work)
+        text = ''
+        title = work.to_s
+        unless title.blank?
+          title = CGI.escapeHTML(title)
+          title_info = clean_end_punctuation(title.strip)
+          text << title_info
+        end
+
+        return nil if text.strip.blank?
+        clean_end_punctuation(text.strip) + "."
+      end
+    end
+  end
+end

data/app/helpers/hyrax/collections_helper.rb

@@ -0,0 +1,37 @@
+module Hyrax
+  module CollectionsHelper
+    def render_collection_links(solr_doc)
+      collection_list = Hyrax::CollectionMemberService.run(solr_doc)
+      return if collection_list.empty?
+      links = collection_list.map do |collection|
+        link_to collection.title_or_label, collection_path(collection.id)
+      end
+      content_tag :span, safe_join([t('hyrax.collection.is_part_of'), ': '] + links)
+    end
+
+    # @return [Boolean]
+    def has_collection_search_parameters?
+      !params[:cq].blank?
+    end
+
+    def button_for_remove_from_collection(collection, document, label = 'Remove From Collection')
+      render 'hyrax/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 'hyrax/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
+
+    private
+
+      # 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 'hyrax/collections/single_item_action_fields', form: form, document: document, action: action
+      end
+  end
+end

data/app/helpers/hyrax/content_block_helper.rb

@@ -0,0 +1,5 @@
+module Hyrax
+  module ContentBlockHelper
+    include ContentBlockHelperBehavior
+  end
+end

data/app/helpers/hyrax/content_block_helper_behavior.rb

@@ -0,0 +1,55 @@
+module Hyrax
+  module ContentBlockHelperBehavior
+    def editable_content_block(content_block, show_new = false)
+      return raw(content_block.value) unless can? :update, content_block
+      capture do
+        concat content_tag(:div, id: dom_id(content_block, 'preview'), class: 'content_block_preview') {
+          concat raw(content_block.value)
+          concat edit_button(content_block)
+          concat new_button(content_block) if show_new
+        }
+        concat edit_form(content_block)
+        concat new_form(content_block.name) if show_new
+      end
+    end
+
+    def display_editable_content_block?(content_block)
+      content_block.value.present? || can?(:update, content_block)
+    end
+
+    def edit_button(content_block)
+      button_tag "Edit", class: 'btn btn-primary', data: { behavior: 'reveal-editor', target: '#' + dom_id(content_block, 'edit') }
+    end
+
+    def new_button(_content_block)
+      button_tag "New", class: 'btn btn-primary', data: { behavior: 'reveal-editor', target: '#' + 'new_content_block' }
+    end
+
+    def edit_form(content_block, editing_field_id = nil)
+      editing_field_id ||= "text_area_#{content_block.name}"
+      form_for([hyrax, content_block], html: { class: 'tinymce-form' }) do |f|
+        concat hidden_field_tag 'content_block[name]', content_block.name
+        concat f.text_area :value, id: editing_field_id, class: "tinymce", rows: 20, cols: 120
+        concat f.label :external_key, content_block.external_key_name
+        concat f.text_field :external_key, class: key_field_class(content_block.name)
+        concat content_tag(:div) { f.submit 'Save', class: "btn btn-primary" }
+      end
+    end
+
+    def key_field_class(content_block_type)
+      content_block_type == ContentBlock::RESEARCHER ? 'select2-user' : ''
+    end
+
+    def new_form(name)
+      content_block = ContentBlock.new(name: name)
+      edit_form(content_block, "new_#{name}_text_area")
+    end
+
+    def tiny_mce_stuff
+      capture do
+        concat tinymce_assets
+        concat tinymce
+      end
+    end
+  end
+end

data/app/helpers/hyrax/dashboard_helper_behavior.rb

@@ -0,0 +1,70 @@
+module Hyrax
+  module DashboardHelperBehavior
+    def render_sent_transfers
+      if @outgoing.present?
+        render 'hyrax/transfers/sent'
+      else
+        t('hyrax.dashboard.no_transfers')
+      end
+    end
+
+    def render_received_transfers
+      if @incoming.present?
+        render 'hyrax/transfers/received'
+      else
+        t('hyrax.dashboard.no_transfer_requests')
+      end
+    end
+
+    def render_recent_activity
+      if @activity.empty?
+        t('hyrax.dashboard.no_activity')
+      else
+        render 'hyrax/users/activity_log', events: @activity
+      end
+    end
+
+    def render_recent_notifications
+      if @notifications.empty?
+        t('hyrax.dashboard.no_notifications')
+      else
+        render "hyrax/mailbox/notifications", messages: notifications_for_dashboard
+      end
+    end
+
+    def on_the_dashboard?
+      params[:controller].match(%r{^hyrax/dashboard|hyrax/my})
+    end
+
+    def on_my_works?
+      params[:controller].match(%r{^hyrax/my/works})
+    end
+
+    def number_of_works(user = current_user)
+      Hyrax::WorkRelation.new.where(DepositSearchBuilder.depositor_field => user.user_key).count
+    rescue RSolr::Error::ConnectionRefused
+      'n/a'
+    end
+
+    def number_of_files(user = current_user)
+      ::FileSet.where(DepositSearchBuilder.depositor_field => user.user_key).count
+    rescue RSolr::Error::ConnectionRefused
+      'n/a'
+    end
+
+    def number_of_collections(user = current_user)
+      ::Collection.where(DepositSearchBuilder.depositor_field => user.user_key).count
+    rescue RSolr::Error::ConnectionRefused
+      'n/a'
+    end
+
+    def notifications_for_dashboard
+      @notifications.limit(Hyrax.config.max_notifications_for_dashboard)
+    end
+
+    def link_to_additional_notifications
+      return unless @notifications.count > Hyrax.config.max_notifications_for_dashboard
+      link_to t('hyrax.dashboard.additional_notifications'), hyrax.notifications_path
+    end
+  end
+end