stackview_acorn_tester 2.0.0

data/app/assets/stylesheets/rails_stackview/_plain.scss

@@ -0,0 +1,119 @@
+
+.stack-plain {
+  box-sizing: content-box;
+  position: relative;  
+
+  > a {
+    box-sizing: content-box;
+
+    min-height: 40px;
+
+    position:relative;
+    width: 100%;
+
+    border-radius: 3px 0 0 3px;
+    border-width:1px;
+    border-style:solid;
+    text-shadow:none;
+    font-size:11px;
+    padding:0 10px 0 0;
+
+    // disable background image inherited
+    &, &:hover, &:active, &:focus {
+      background-image: none;
+    }
+
+    font-family: monospace;
+  }
+
+  .spine-year {
+    @include rotate(-90deg);
+  }
+
+  .label-container {
+    //Makes it easier to keep the spine-text away from the date label
+    //with another container, sorry. 
+    display: block;
+    margin: 0;
+    padding: 3px 28px 4px 4px;
+    max-width: 100%;
+  }
+
+  .spine-text {
+    position: static;
+    
+    // Make it look kind of like a printed label
+    background-color: #f9fceb;
+    color: rgb(34, 34, 34);
+    border-color: rgb(34, 34, 34);
+    border-radius: 4px;
+    padding: 4px 0 2px 4px;
+
+    display: inline-block;
+    max-width: 100%;
+  }
+
+
+
+  .plain-title, .plain-format, .plain-author {
+    box-sizing: border-box !important;
+    max-width: 100%;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    white-space:nowrap;
+    padding-right: 7px;
+    line-height: 16px;
+  }
+
+  .plain-title {
+    font-size: 13px;
+    float: left;
+  }
+  .plain-format {
+    float: left;
+    clear: left;
+    &:empty {
+      clear: none;
+    }
+    padding-right: 30px;
+  }
+  .plain-author {
+    float: right;
+  }
+
+  .plain-top {
+    content:'';
+    display:block;
+    position:absolute;
+    top:-5px;
+    left:4px;
+    right:-5px;
+    height:3px;
+    border-width:1px;
+    border-style:solid;
+    @include skew(-70deg, 0);
+    border-radius:0 5px 0 5px;
+    z-index:2;
+  }
+
+  .plain-edge {
+    content:'';
+    display:block;
+    position:absolute;
+    top:-3px;
+    bottom:1px;
+    right:-8px;
+    width:6px;
+    @include skew(0, -20deg);
+    border-width:0 1px 1px 0;
+    border-style:solid;
+  }
+
+}
+
+
+
+
+
+
+

data/app/assets/stylesheets/rails_stackview/browser.scss

@@ -0,0 +1,116 @@
+$rails-shelfbrowse-hide-browse-breakpoint: 565px !default;
+
+.shelfbrowser {
+  display: block;
+  width: 100%;
+  max-width: 1340px;
+  overflow: hidden;
+  margin-right: auto;
+  margin-left: auto;
+
+  position: relative;
+  box-sizing: border-box;
+
+
+
+  // we prefer no ribbon
+  .stackview .ribbon {
+    display: none;
+  }
+
+  .stackview .stack-navigation {
+    top: 55px; // not sure why it ended up 5px by default. 
+  }
+
+  .shelfbrowser-browse-column, .shelfbrowser-info-column {
+    display: block;
+  }
+
+  .shelfbrowser-browse-column {
+    width: 55%;
+    @media screen and (min-width: 925px) { 
+      width: 60%;
+    }
+    // on Very small screens, this column is it. 
+    @media screen and (max-width: $rails-shelfbrowse-hide-browse-breakpoint) {
+      width: 100%;
+    }
+
+    float: left;
+
+    // Does weird with our columns, but we're leaving in for now
+    padding-left: 8px;
+
+    .stackview {
+      overflow-y: hidden;
+
+
+      // Trying to do this made IE unhappy. 
+      //position: absolute;
+      //height: 100%;
+      //width: 100%;
+
+      // Stackview does not like box-styling: border-box.
+      // Bootstrap applies it to everything, we apply it to
+      // some things above here on purpose, as it makes things better. 
+      // But we need to return actual contents of the .stackview to
+      // content-box. 
+      box-sizing: content-box;
+      * {
+        box-sizing: inherit;
+      }
+    }
+
+  }
+
+  .shelfbrowser-info-column {    
+    box-sizing: border-box;
+    width: 45%;
+    @media screen and (min-width: 925px) { 
+      padding-right: 48px;
+      width: 40%;
+    }
+    // Hide entirely on very small sizes
+    @media screen and (max-width: $rails-shelfbrowse-hide-browse-breakpoint) {
+      display: none;
+    }
+
+    float: left;
+    overflow-y: auto;
+
+    padding: 0 16px 16px 16px;
+
+    .shelfbrowse-header {
+      border-bottom: 1px solid #eeeeee;
+      margin-bottom: 16px;
+    }
+
+    .stack-item-panel {
+      overflow-x: hidden;
+    }
+
+    .shelfbrowser-back-btn a {
+      display: block;
+      text-align: right;
+    }
+
+  }
+
+  .active-item {
+    margin-left: 10px;
+    // Make the old item nudge in just a bit before
+    // new item nudges out. 
+    transition-delay: 40ms;
+  }
+
+  li.stack-item {
+    // For browsers that support CSS transitions, make
+    // pull out of active item awesome. 
+    transition-property: margin-left;
+    transition-duration: 120ms;
+    transition-timing-function: ease-in;
+
+  }
+
+}
+

data/app/assets/stylesheets/rails_stackview.scss

@@ -0,0 +1,10 @@
+/*
+ * CSS manifest file for rails_stackview, we make an scss file using
+ * imports, so our custom rails_stackview CSS, like the plain type
+ * definition, can use mixins defined in jquery.stackview
+ *
+ * Includes vendored stackview CSS and any of our own custom CSS
+ */
+ @import 'stackview/jquery.stackview';
+ @import 'rails_stackview/browser';
+ @import 'rails_stackview/plain';

data/app/controllers/stackview_data_controller.rb

@@ -0,0 +1,91 @@
+class StackviewDataController < ApplicationController
+
+  ApplicationController::ActionController::Parameters.permit_all_parameters = true
+  ApplicationController::ActionController::Parameters.action_on_unpermitted_parameters = :raise
+
+  # stackview doesn't like it if certain things are blank
+  DefaultStackviewDocAttributes = {
+    "measurement_height_numeric" => 23,
+    "shelfrank" => 1,
+    "measurement_page_numeric" => 100
+  }
+ß
+  # config for different call number types; we don't
+  # fully support call number types yet, but are building for it. 
+  # with the exception of the 'test' type
+  class_attribute :_config_for_types
+  self._config_for_types = {
+    'default' => {
+      :fetch_adapter => lambda { RailsStackview::DbWindowFetcher.new },
+      # By default, automatic link to Blacklight catalog_path if present
+      :link => lambda do |hash|
+        if self.respond_to?(:catalog_path)
+          catalog_path(hash["system_id"])
+        else
+          hash["link"]
+        end
+      end
+    },
+    'test' => {
+      :fetch_adapter => lambda { RailsStackview::MockFetcher.new }
+    },
+    'lc' => {
+      # defaults are good. 
+    }
+  }
+  def self.set_config_for_type(type, attributes)
+    type = type.to_s
+    config = (self._config_for_types[type] ||= {})
+    config.merge! attributes
+
+    return config
+  end
+  def self.config_for_type(type)
+    type = type.to_s
+
+    config  = self._config_for_types[type]
+    unless config
+      raise ArgumentError, "No config found for #{type}"
+    end
+    default = _config_for_types['default']
+
+    return config.reverse_merge(default)
+  end
+  def config_for_type(type)
+    self.class.config_for_type(type)
+  end
+  # mostly for testing
+  def self.remove_config_for_type(type)
+    type = type.to_s
+    _config_for_types.delete(type)
+  end
+
+
+
+  def fetch
+    config = config_for_type( params[:call_number_type] )
+
+    fetch_adapter = config[:fetch_adapter].call    
+
+    # Make sure defaults are covered
+    docs = fetch_adapter.fetch(params).collect do |d|      
+      d = d.reverse_merge DefaultStackviewDocAttributes
+      # stackview doens't like shelfrank's over 100
+      d["shelfrank"] = [d["shelfrank"], 100].min
+
+      d
+    end
+
+    # add in URLs
+    url_proc = config[:link] || (lambda {|doc| doc["link"]})
+    docs.each do |doc|
+      doc["link"] = self.instance_exec(doc, &url_proc)
+    end
+
+    result = {'docs' => docs}
+    result['start'] = "-1" if docs.empty?
+
+    render :json => result
+  end
+
+end

data/app/fetch_adapters/rails_stackview/db_window_fetcher.rb

@@ -0,0 +1,88 @@
+module RailsStackview
+
+  # Fetches from the stackview_call_numbers table with ActiveRecord
+  #
+  # * Assumes a windowing `search_type:loc_sort_order` in stackview, which
+  #   sends query=[X TO Y] in params. 
+  #
+  # * Additionally assumes we get an `origin_sort_key` in params,
+  #   which will used as the "zero point" for stackview's query ranges. 
+  #   It must be an actual normalized sort_key -- if it does not exist in the DB,
+  #   we'll just browse from that point in sort order though. 
+  #
+  #   We use this origin_sortkey to try and avoid very deep offsets in our
+  #   SQL, which get expensive, although if the user pages a LOT they can
+  #   still get there. If this is not good enough, we'll have to contribute
+  #   features to stackview to provide alternate windowing based on sortkeys
+  #   alone. 
+  #
+  #  Create a path to the StackviewDataController using 'lc' call_number_type,
+  #  which uses this fetcher, specifying the origin_sort_key as a query param:
+  #
+  #     stackview_data_path("lc", :origin_sort_key => some_sort_key)
+  class DbWindowFetcher
+
+    def fetch(params)
+      @origin_sort_key = params["origin_sort_key"]
+      @sort_key_type   = params["sort_key_type"] || "lc"
+
+      unless @origin_sort_key.present?
+        raise ArgumentError, "`origin_sort_key` param required, specifying where to start the browse"
+      end
+
+      (first, last)  = RailsStackview.parse_query_range(params["query"])
+      unless first < last
+        raise ArgumentError, "beginning of range must be less than end: #{params["query"]}"
+      end
+
+
+      # Fetch the AR models, then turn em into hashes, which include all
+      # columns in the db, excluding some we don't want. 
+      #
+      # Plus we need to turn our single creator into an array, cause
+      # that's what stackview wants.
+      results = fetch_records(first, last).collect do |record|
+        record.attributes.except('id').reject {|k, v| v.blank? }.
+          merge("creator" => (record["creator"].present? ? [record['creator']] : record['creator']))
+      end
+
+      # Mark the thing at 0 index as origin:true, so it can be auto-selected
+      # by browser. 
+      if (first..last).cover?(0)
+        origin_index = [first.abs, results.length - 1].min
+        results[origin_index]["is_origin_item"] = true
+      end
+
+      return results
+    end
+
+
+    # Returns ActiveRecord StackviewCallNumber objects. 
+    def fetch_records(first, last)
+      if first >= 0 && last >= 0 # all positive
+        positive_fetch(first, last)
+      elsif first < 0 && last >= 0# cross zero-boundary
+        # have to do half first and half last
+        negative_fetch(first, -1) + positive_fetch(0, last)
+      else # all negative
+        negative_fetch(first, last)
+      end
+    end
+
+    def positive_fetch(first, last)
+      StackviewCallNumber.where("sort_key >= ?", @origin_sort_key).
+        where(:sort_key_type => @sort_key_type).
+        order("sort_key ASC").
+        offset(first).limit(last - first + 1)
+    end
+
+    def negative_fetch(first, last)
+      StackviewCallNumber.where("sort_key < ?", @origin_sort_key).
+        where(:sort_key_type => @sort_key_type).
+        order("sort_key DESC").
+        offset(last.abs - 1).limit(last - first + 1).
+        reverse
+    end
+
+  end
+end

data/app/fetch_adapters/rails_stackview/mock_fetcher.rb

@@ -0,0 +1,27 @@
+module RailsStackview
+  # A mock fetcher that just returns fake data, useful for testing, both manual and
+  # automated testing. 
+  #
+  # Assumes 'loc_sort_order' style fetching, with query=[X TO Y] in params. 
+  # 
+  # Returns the designated number of records, with titles and other attributes
+  # including the 'i' index
+  class MockFetcher
+    def fetch(params)
+      first, last = RailsStackview.parse_query_range(params["query"])
+
+      return first.upto(last).collect do |i|
+        {
+          'title' => "item #{i}",
+          'system_id' => "doc_#{i}",
+          'creator' => ["author #{i}"],
+          'pub_date' => "2000",
+          'measurement_page_numeric' => rand(1..500),
+          'measurement_height_numeric' => ((25 + i*2) % 50),
+          'shelfrank' => ((i*10) % 100),
+          'link' => "http://example.org"
+        }
+      end
+    end
+  end
+end

data/app/models/stackview_call_number.rb

@@ -0,0 +1,2 @@
+class StackviewCallNumber < ActiveRecord::Base
+end

data/app/views/rails_stackview/browser.html.erb

@@ -0,0 +1,42 @@
+<div class="shelfbrowser">
+  <%= content_tag "div",
+        {
+            :class => "shelfbrowser-browse-column",
+            :data => {
+                :stackview_browser_item_path => (respond_to?(:stackview_browser_item_path) ?
+                    stackview_browser_item_path :
+                    "")
+            }
+        } do %>
+        <%= content_tag "div", "",
+                :class => "shelfbrowser-stackview",
+                :data => {
+                    :stackview_init => {
+                        :id => 0,
+                        :url => stackview_data_path(
+                            local_assigns[:call_number_type] || "lc",
+                            :origin_sort_key => "local_assigns[:origin_sort_key]"
+                        ),
+                        :search_type => "loc_sort_order"
+                    }
+                }
+        %>
+    <% end %>
+
+    <div class="shelfbrowser-info-column">
+        <div class="shelfbrowse-header">
+            <%# cheesy way to provide a 'back' button, our users requested it %>
+            <% if request.referer %>
+                <p class="shelfbrowser-back-btn">
+                    <%= link_to "« Back to Catalog", request.referer %>
+                </p>
+            <% end %>
+
+            <h2>Virtual Shelf Browse!!!!!!!</h2>
+        </div>
+
+        <div class="stack-item-panel"></div>        
+    </div>
+
+</div>
+

data/config/routes.rb

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

data/db/migrate/20150602210254_create_stackview_call_numbers.rb

@@ -0,0 +1,34 @@
+class CreateStackviewCallNumbers < ActiveRecord::Migration
+  def change
+    create_table :stackview_call_numbers do |t|
+      # these are what we want to assemble items in a sequence,
+      t.string :sort_key, :null => false, :length => 100
+      t.string :sort_key_display
+      t.string :sort_key_type, :null => false, :length => 100
+
+      # and be able to link back to external systems
+      t.string :system_id, :null => false, :length => 100
+
+ 
+      # These are what stackview wants or can use
+
+      t.string :title, :null => false
+      t.string :creator
+      t.string :format
+
+      t.integer    :measurement_page_numeric
+      t.integer    :measurement_height_numeric
+      t.integer    :shelfrank
+
+      t.string :pub_date
+
+      # record created_at for bookkeeping
+
+      t.column :created_at, :datetime
+
+      # indexes
+      t.index :system_id
+      t.index :sort_key
+    end
+  end
+end

data/lib/rails_stackview/engine.rb

@@ -0,0 +1,7 @@
+module RailsStackview
+  class Engine < ::Rails::Engine
+    # We need to precompile our stackview pngs, not sure what Rails
+    # is up to. 
+    config.assets.precompile += %w[stackview/*.png stackview/*.gif stackview/*.jpg] 
+  end
+end

data/lib/rails_stackview/version.rb

@@ -0,0 +1,3 @@
+module RailsStackview
+  VERSION = "2.0.0"
+end

data/lib/rails_stackview.rb

@@ -0,0 +1,20 @@
+require "rails_stackview/engine"
+
+module RailsStackview
+
+
+  # Utility methods
+
+  # Parses [XX TO YY] to ints. 
+  #
+  #     first, last = RailsStackview.parse_query_range("[-10 TO 50]")
+  #     # first == -10 ; last == 50
+  #
+  # Raises an ArgumentError if input string isn't in expected format. 
+  def self.parse_query_range(str)
+    unless str =~ /\[(\-?\d+) TO (\-?\d+)\]/
+      raise ArgumentError, "expect a query in the form `[\d+ TO \d+]`"
+    end
+    return [$1.to_i, $2.to_i]
+  end
+end

data/lib/tasks/rails_stackview_tasks.rake

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

data/test/controllers/stackview_data_controller_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+require 'json'
+
+class StackviewDataControllerTest < ActionController::TestCase
+  test "fetch with test adapter" do
+    get :fetch, :call_number_type => "test", :query => "[-5 TO 5]"
+
+    assert_response :success
+    assert_equal "application/json", response.content_type
+    
+    parsed_response = JSON.parse( response.body )
+
+    assert_kind_of Array, (docs = parsed_response["docs"])
+
+    assert_equal 11, docs.length
+  end
+
+  test "configured :link filter" do
+    StackviewDataController.set_config_for_type("test", 
+      :link => lambda do |hash|
+        "http://example.org/to_doc/#{hash['system_id']}"
+      end
+    )
+
+    get :fetch, :call_number_type => "test", :query => "[1 TO 10]"
+    
+    docs = JSON.parse( response.body )["docs"]
+
+    docs.each do |doc|
+      assert_equal "http://example.org/to_doc/#{doc['system_id']}", doc['link']
+    end
+  end
+
+  class StackviewDataControllerConfigTest < ActionController::TestCase
+
+    test "has and can look up config for `lc`" do
+      config = StackviewDataController.config_for_type('lc')
+      assert_present config
+
+      assert_present config[:fetch_adapter]
+    end
+
+    test "can set config" do
+      StackviewDataController.set_config_for_type("just_testing", :foo => :bar)
+
+      config = StackviewDataController.config_for_type('just_testing')
+      assert_present config
+
+      assert_equal :bar, config[:foo]
+
+      StackviewDataController.remove_config_for_type("just_testing")
+    end
+  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 @@
+// 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_self
+//
+//= require jquery
+//
+//= require rails_stackview