umlaut_journal_tocs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e60c1c166dfa1839819bbe4b9da4050c18fbd6d
+  data.tar.gz: e5928afdb0faed5785440e715bacc407ad37780b
+SHA512:
+  metadata.gz: 0eb7c9153fafeaea474a11966c533c7e5d9317a5e56ce47167db53caba84dff66b7c6285e748d771cbb536f447e22714103de2f0860e1728296e467658e038dd
+  data.tar.gz: 4a5301df4714bc73cb31692a6ac17580a7afeea05c5a1e76f8b8ad856b8c6498ca1f59aad709846088c5d37f247599fe39d0d47fa91d939bacf1ef2884a99b63

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Jonathan Rochkind
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UmlautJournalTocs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/item_decorators/umlaut_journal_tocs_decorator.rb

@@ -0,0 +1,50 @@
+# A bento_search item decorator customizing display for use in umlaut
+# recent articles. 
+
+class UmlautJournalTocsDecorator < BentoSearch::StandardDecorator
+
+    # Always full publication date
+    def display_date
+      if self.publication_date
+        I18n.localize(self.publication_date, :format => "%d %b %Y")
+      elsif self.year
+        self.year.to_s
+      else
+        nil
+      end
+    end
+
+    # Replace link with openurl pointing to ourselves with direct-to-fulltext,
+    # or else nothing. 
+    def link
+      if good_openurl?
+        self_openurl("umlaut.skip_resolve_menu_for_type" => "fulltext")
+      else
+        nil
+      end
+    end
+
+    #def other_links
+    #  links = []
+    #
+    #  if good_openurl?
+    #    links << BentoSearch::Link.new(:label => _h.umlaut_config.app_name, :url => self_openurl)
+    #  end
+    #end
+
+    # helper method for ourselves, do we have enough
+    # metadata for a good article openurl?
+    def good_openurl?
+      self.doi.present? || self.pmid.present? || 
+      (self.volume.present? && self.issue.present? && self.start_page.present?)
+    end
+
+    def self_openurl(extra_params = {})
+        _h.url_for_with_co(
+            { :controller => "/resolve", 
+              :action => :index
+            }.merge(extra_params),  
+            self.to_openurl)
+    end
+
+end

data/app/service_adaptors/journal_tocs_adapter.rb

@@ -0,0 +1,51 @@
+require 'bento_search'
+
+class JournalTocsAdapter < Service
+
+  def initialize(config)
+    @bento_search_engine = 'umlaut_journal_tocs'
+    @max_items = 40
+    super(config)
+  end
+
+
+  def service_types_generated
+    return [ServiceTypeValue[:journal_tocs_bento]]
+  end
+
+  def handle(request)
+    unless self.class.suitable_citation?(request)
+      return request.dispatched(self, true)
+    end
+
+    searcher = BentoSearch.get_engine(@bento_search_engine)
+
+    bento_results = searcher.fetch_by_issn(request.referent.issn)
+
+    bento_results.slice!(@max_items, bento_results.length)
+
+    # We store JSON serialization of results in the display_text field
+    # of a single ServiceResponse, hacky but okay. 
+    if bento_results.length > 0
+      request.add_service_response( 
+        :service=>self, 
+        :service_data => bento_results.dump_to_json,
+        :service_type_value => :journal_tocs_bento
+      )
+    end
+
+    return request.dispatched(self, true)
+  rescue BentoSearch::FetchError => e
+    Rails.logger.error("JournalTocsAdapter: Could not fetch results: #{e}")
+    return request.dispatched(self, false, e)
+  end
+
+  # A class-method because we use it standalone in our resolve
+  # section visbility logic. 
+  def self.suitable_citation?(request)
+    # We do nothing for article-level, only journal-level
+    # We can do nothing without ISSN. 
+    request.title_level_citation? && request.referent.issn.present?
+  end
+
+end

data/app/views/umlaut_journal_tocs/_bento_item.html.erb

@@ -0,0 +1,80 @@
+<%# 
+  # Custom template to display a BentoSearch::Result for the umlaut
+  # journal tocs recent article display. 
+  #
+  # Forked from bento_search/_std_item.html.erb, but with customizations
+  # for what we want to display, in what DOM structure. 
+  #
+  #  must pass in local:
+  #    * 'item' that's a BentoSearch::ResultItem
+%>
+
+
+
+<% bento_decorate(item) do |item| %>
+
+  <%# for debugging purposes, we'll include the vendor-specific unique_id, if we have
+      one, in a data-unique-id attribute. %>
+
+  <div class="bento_item" data-unique-id="<%= item.unique_id %>">
+    <b><%= link_to_unless(item.link.blank?, item.complete_title, item.link, :target => "_blank", :class => "response_link") %></b>
+
+
+    <div class="bento_item_body umlaut-content-indent">
+
+      <% if item.authors.present? %>
+        <p class="bento_item_row first_about">
+          <% if item.authors.present? %>
+            <span class="authors">
+              <%= item.render_authors_list %>
+            </span>
+          <% end %>
+        </p>
+      <% end %>
+
+      <% if item.abstract %>
+        <p class="bento_item_row abstract">
+          <%= item.render_summary  %>
+        </p>
+      <% end %>
+
+      <% if item.volume.present? || item.issue.present? || item.display_date.present? || item.doi.present? %>
+        <p class="bento_item_row second_about">
+
+          <% if item.display_date.present? %>
+            <span class="date">
+              <%= item.display_date %>
+            </span>
+          <% end %>
+
+          <% if item.display_date.present? && (item.volume.present? || item.issue.present? || item.start_page.present? || item.doi.present?) %>
+            <span class="separator">—</span>
+          <% end %>
+
+          <%= item.render_citation_details %>
+
+          <% if item.doi.present? && (item.volume.present? || item.issue.present? || item.start_page.present?) && item.display_date.present? %>
+            <span class="separator">—</span>
+          <% end %>
+
+
+          <% if item.doi.present? %>
+            <span class="doi">
+              doi:<%= item.doi %>
+            </p>
+          <% end %>
+
+
+        </p>
+      <% end %>
+
+      
+      <% if item.other_links.present? %>
+        <p class="bento_item_other_links">
+          <%= render :partial => "bento_search/link", :collection => item.other_links %>
+        </p>
+      <% end %>
+    </div>
+
+  </div>
+<% end %>

data/app/views/umlaut_journal_tocs/_resolve_section.html.erb

@@ -0,0 +1,10 @@
+<% responses.each do |response| 
+    results = BentoSearch::Results.load_json(response.service_data) %>
+
+    <%= list_with_limit("umlaut_journal_tocs_list", results, :limit => 6, :ul_class => "response_list") do |item| %>
+        <li class="response_item">
+            <%= render :partial => results.display_configuration.try(:item_partial) || "umlaut_journal_tocs/bento_item", :locals => {:item => item} %>
+        </li>
+    <% end %>
+
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  umlaut:
+    display_sections:
+      journal_tocs_bento:
+        title: Recent Articles

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/tasks/umlaut_journal_tocs_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :umlaut_journal_tocs do
+#   # Task goes here
+# end

data/lib/umlaut_journal_tocs.rb

@@ -0,0 +1,26 @@
+require "umlaut_journal_tocs/engine"
+
+module UmlautJournalTocs
+
+  # Custom visibility logic for our resolve section, 
+  # we don't want to show at all if it's not a suitable citation,
+  # otherwise :in_progress logic. 
+  SectionVisibilityLogic = lambda do |section_renderer|
+    return false unless JournalTocsAdapter.suitable_citation?(section_renderer.request)
+
+    # :in_progress logic
+    return (! section_renderer.responses_empty?) || section_renderer.services_in_progress?  
+  end
+
+
+  def self.resolve_section_definition
+    {
+      :div_id     => "journal_tocs_bento",
+      :html_area  => :main,
+      :partial    => "umlaut_journal_tocs/resolve_section",
+      :service_type_values => [:journal_tocs_bento],
+      :visibility => SectionVisibilityLogic
+    }
+  end
+
+end

data/lib/umlaut_journal_tocs/engine.rb

@@ -0,0 +1,18 @@
+require 'umlaut'
+require 'bento_search'
+
+module UmlautJournalTocs
+  class Engine < ::Rails::Engine
+    engine_name "umlaut_journal_tocs"
+
+    initializer "umlaut_journal_tocs.add_service_types" do |app|
+      require 'service_type_value'
+      ServiceTypeValue.merge_hash!( {"journal_tocs_bento" => {}} )
+    end
+
+    initializer "umlaut_journal_tocs.backtrace_cleaner", :before => "umlaut.backtrace_cleaner" do
+      Umlaut::Engine.config.whitelisted_backtrace[self.root] = self.engine_name
+    end
+
+  end
+end

data/lib/umlaut_journal_tocs/version.rb

@@ -0,0 +1,3 @@
+module UmlautJournalTocs
+  VERSION = "0.0.1"
+end

data/test/controller_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class ControllerTest < ActionController::TestCase
+  self.use_transactional_fixtures = false 
+  extend TestWithCassette
+
+  setup do
+    @controller = ResolveController.new
+  end
+
+  test_with_cassette("gets results") do
+    get :index, {"issn" => "17588936"}
+
+    assert_response :success
+
+    # Has at least one response item in the classes we expect
+    sample_item = assert_select(".umlaut-section.journal_tocs_bento .response_list .response_item .bento_item")
+
+    assert_select(sample_item, "a.response_link")
+    assert_select(sample_item, ".abstract")
+
+    # Has a list_with_limit 
+    assert_select(".journal_tocs_bento .collapsible")
+  end
+
+  test_with_cassette("not for article-level") do
+    get :index, { jtitle: 'JAMA', genre: 'article', issn: '1538-3598', volume: '1', issue: '1', spage:'1'}
+
+    # No response content
+    assert_select(".umlaut-section.journal_tocs_bento .response_list .response_item .bento_item", false)
+
+    # No section on page at all. 
+    assert_select(".umlaut-section.journal_tocs_bento", false)
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,17 @@
+
+ // Umlaut javascript required for proper functionality. The 'umlaut' file
+ // also forces require of jquery and jquery-ui, dependencies.
+ //= require 'umlaut'
+          // This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,19 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ *
+ * The base Umlaut styles:
+ *= require 'umlaut'
+ *
+ */