blacklight-gallery 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7265445f18630a2d43755bd9322140a4e3c4f07
-  data.tar.gz: 71a212fcdfa7d93dbde1205b02fa907ccb7fbd0d
+  metadata.gz: 98c59e605154729f071d84f594e00cf1cb1acef5
+  data.tar.gz: b0b8c6e17a2342e72007b72d83016e07a0384248
 SHA512:
-  metadata.gz: d43e289a9d072fb79144907c9eded29e54c57e70c5a3ba6b81815a5c431051eeb2f52beb1e29aede06c0eb775e9d9b656b72acfd55b136d84cb448b4acdbcf24
-  data.tar.gz: c015833a99afbeb4456f9c9224c0e8a1f860f140c0577f53bfb1461d5ecf2577441adb2484c86aa0a36907055a33faca1f15e308de7d4c35ec7453a13ba0ebc4
+  metadata.gz: 8b2b543edc5f4ec04347b7a25d43898ac1cc16bea5f17b1f6e4af53d05b5a63c8b08264d5b91d59eea183204d439e330383f33a7f8cc58761f8e632ce3dca9bf
+  data.tar.gz: a3d6e3e316f6d156d0cbe3a7210b3023d7691638e67ef5823746e86ad30bb88879a5709a8f0e6b5e492ae09c397c3258ca0bda75e744c6711d30e8fdf70e1700

data/Gemfile

@@ -3,24 +3,21 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in blacklight-gallery.gemspec
 gemspec
 
-# If we don't specify 2.11.0 we'll end up with sprockets 2.12.0 in the main 
-# Gemfile.lock but since sass-rails gets generated (rails new) into the test app
-# it'll want sprockets 2.11.0 and we'll have a conflict
-gem 'sprockets', '2.11.0'
-
-# If we don't specify 3.2.15 we'll end up with sass 3.3.2 in the main 
-# Gemfile.lock but since sass-rails gets generated (rails new) into the test app
-# it'll want sass 3.2.0 and we'll have a conflict
-gem 'sass', '~> 3.2.0'
-
-group :test do
-  gem "bootstrap-sass"
-  gem 'turbolinks'
-  gem 'sass-rails'
-end
-
 gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
-if File.exists?('spec/test_app_templates/Gemfile.extra')
-  eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
-end
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+else
+  gem 'rails', ENV['RAILS_VERSION']
+
+  # explicitly include sass-rails to get compatible sprocket dependencies
+  if ENV['RAILS_VERSION'] and ENV['RAILS_VERSION'] =~ /^4.2/
+    gem 'sass-rails', ">= 5.0.0.beta1"
+    gem 'responders', "~> 2.0"
+  else
+    gem 'sass-rails'
+    gem 'coffee-rails', "~> 4.0.0"
+  end
+end

data/app/assets/javascripts/blacklight_gallery/default.js

@@ -0,0 +1,2 @@
+//= require blacklight_gallery/slideshow
+//= require blacklight_gallery/osd_viewer

data/app/assets/javascripts/blacklight_gallery/osd_viewer.js

@@ -0,0 +1 @@
+//= require openseadragon/rails

data/app/assets/stylesheets/blacklight_gallery/_gallery.css.scss

@@ -0,0 +1,51 @@
+.view-icon-gallery {
+  &:before { content: "\e011"; } 
+}
+
+#documents.gallery {
+
+  display: -webkit-box;
+  display: -moz-box;
+  display: -ms-flexbox;
+  display: -webkit-flex;
+  display: flex;
+  flex-flow: row wrap;
+
+
+  .document {
+    border-bottom: none;
+
+    -webkit-box-flex: 1;
+    -moz-box-flex: 1;
+    -webkit-flex: 1;
+    -ms-flex: 1;
+    flex: 1;
+
+    min-width: 250px;
+    min-height: 250px;
+  }
+
+  .index_title {
+    width: 100%;
+  }
+
+  .document-counter {
+    display: none;
+  }
+
+  .index-document-functions {
+    clear: left;
+  }
+
+  .document-metadata { 
+    dt, dd {
+      float: none;
+      width: auto;
+      clear: none;
+      text-align: left;
+      margin: 0;
+      padding: 0;
+    }
+
+  }
+}

data/app/assets/stylesheets/blacklight_gallery/_osd_viewer.css.scss

@@ -0,0 +1,29 @@
+#document {
+
+  .osd-toolbar {
+    padding: 5px 0;
+
+    a {
+      cursor: pointer;
+      margin: 0 5px;
+    }
+
+    .pagination {
+      margin: 0;
+      padding: 0;
+      text-align: left;
+    }
+
+    .controls {
+      float: right;
+      padding: 0;
+      text-align: right;
+    }
+  }
+
+  .osd-image {
+    border: 1px solid #ccc;
+    height: 400px;
+
+  }
+}

data/app/assets/stylesheets/blacklight_gallery/_slideshow.css.scss

@@ -1,3 +1,7 @@
+.view-icon-slideshow {
+  &:before { content: "\e158"; } 
+}
+
 $gray-light: lightgray !default;
 $gray-dark: darkgray !default;
 

data/app/assets/stylesheets/blacklight_gallery/default.css.scss

@@ -1,56 +1,3 @@
+@import "gallery";
 @import "slideshow";
-
-#documents.gallery {
-
-  display: -webkit-box;
-  display: -moz-box;
-  display: -ms-flexbox;
-  display: -webkit-flex;
-  display: flex;
-  flex-flow: row wrap;
-
-
-  .document {
-    border-bottom: none;
-
-    -webkit-box-flex: 1;
-    -moz-box-flex: 1;
-    -webkit-flex: 1;
-    -ms-flex: 1;
-    flex: 1;
-
-    min-width: 250px;
-    min-height: 250px;
-  }
-
-  .index_title {
-    width: 100%;
-  }
-
-  .document-counter {
-    display: none;
-  }
-
-  .index-document-functions {
-    clear: left;
-  }
-
-  .document-metadata { 
-    dt, dd {
-      float: none;
-      width: auto;
-      clear: none;
-      text-align: left;
-      margin: 0;
-      padding: 0;
-    }
-
-  }
-}
-
-.view-icon-gallery {
-  &:before { content: "\e011"; } 
-}
-.view-icon-slideshow {
-  &:before { content: "\e158"; } 
-}
+@import "osd_viewer";

data/app/models/concerns/blacklight/gallery/openseadragon_solr_document.rb

@@ -0,0 +1,7 @@
+module Blacklight::Gallery::OpenseadragonSolrDocument
+  def to_openseadragon view_config = nil
+    if view_config and view_config.tile_source_field
+      Array(get(view_config.tile_source_field, sep: nil))
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+<% image = document.to_openseadragon(blacklight_config.view_config(:show)) %>
+<%
+  osd_config = {
+    crossOriginPolicy: false,
+    zoomInButton:     "osd-zoom-in",
+    zoomOutButton:    "osd-zoom-out",
+    homeButton:       "osd-home",
+    fullPageButton:   "osd-full-page",
+    nextButton:       "osd-next",
+    previousButton:   "osd-previous"
+  }
+
+  osd_config_referencestrip = {
+    showReferenceStrip:             true,
+    referenceStripPosition:         'OUTSIDE',
+    referenceStripScroll:           'vertical',
+    referenceStripWidth:            100,
+    referenceStripBackgroundColor:  'transparent'
+  }
+%>
+
+<% unless image.nil? %>
+  <% count = Array(image).length %>
+
+  <div class="col-md-6">
+    <div class="osd-toolbar row">
+      <% if count > 1 %>
+        <% osd_config = osd_config_referencestrip.merge(osd_config) %>
+
+        <div class="col-md-6 pagination">
+          <a id="osd-previous"><span class="glyphicon glyphicon-chevron-left"></span></a>
+          <span id="osd-page">1</span>  of <%= count %>
+          <a id="osd-next"><span class="glyphicon glyphicon-chevron-right"></span></a>
+        </div>
+      <% end %>
+        <div class="col-md-6 controls">
+          <a id="osd-zoom-in"><span class="glyphicon glyphicon-plus-sign"></span></a>
+          <a id="osd-zoom-out"><span class="glyphicon glyphicon-minus-sign"></span></a>
+          <a id="osd-home"><span class="glyphicon glyphicon-resize-small"></span></a>
+          <a id="osd-full-page"><span class="glyphicon glyphicon-fullscreen"></span></a>
+        </div>
+    </div>
+    <%= openseadragon_picture_tag image, class: 'osd-image row', data: { openseadragon: osd_config } %>
+  </div>
+
+<% end %>
+

data/blacklight-gallery.gemspec

@@ -20,11 +20,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails"
   spec.add_dependency "blacklight", "~> 5.0"
   spec.add_dependency "bootstrap-sass", "~> 3.0"
+  spec.add_dependency "openseadragon", ">= 0.0.9"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-rails", "~> 3.1"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-activemodel-mocks"
+  spec.add_development_dependency "rspec-collection_matchers"
   spec.add_development_dependency "jettywrapper"
   spec.add_development_dependency "engine_cart"
   spec.add_development_dependency "capybara"
+  spec.add_development_dependency "poltergeist", ">= 1.5.0"
 end

data/lib/blacklight/gallery/engine.rb

@@ -3,8 +3,8 @@ require 'blacklight'
 module Blacklight
   module Gallery
     class Engine < Rails::Engine
-      Blacklight::Configuration.default_values[:view].gallery.partials = [:index_header, :index]
-      Blacklight::Configuration.default_values[:view].slideshow.partials = [:index]
+      require 'openseadragon'
+    
     end
   end
 end

data/lib/blacklight/gallery/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Gallery
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/generators/blacklight_gallery/install_generator.rb

@@ -9,5 +9,29 @@ module BlacklightGallery
       copy_file "blacklight_gallery.css.scss", "app/assets/stylesheets/blacklight_gallery.css.scss"
       copy_file "blacklight_gallery.js", "app/assets/javascripts/blacklight_gallery.js"
     end
+
+    def configuration
+      inject_into_file 'app/controllers/catalog_controller.rb', after: "configure_blacklight do |config|" do
+        <<-EOF
+          config.view.gallery.partials = [:index_header, :index]
+          config.view.slideshow.partials = [:index]
+
+          config.show.tile_source_field = :content_metadata_image_iiif_info_ssm
+          config.show.partials.insert(1, :openseadragon)
+        EOF
+      end
+    end
+
+    def add_model_mixin
+      inject_into_file 'app/models/solr_document.rb', after: "include Blacklight::Solr::Document" do
+       "\n  include Blacklight::Gallery::OpenseadragonSolrDocument\n"
+      end
+    end
+
+    def add_controller_helpers
+      inject_into_class 'app/controllers/catalog_controller.rb', CatalogController do
+        "\n  helper Openseadragon::OpenseadragonHelper\n"
+      end
+    end
   end
 end

data/lib/generators/blacklight_gallery/templates/blacklight_gallery.js

@@ -1 +1 @@
-//= require blacklight_gallery/slideshow
+//= require blacklight_gallery/default

data/spec/features/gallery_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "Gallery view" do
+describe "Gallery view", :type => :feature do
   before { visit catalog_index_path :q => 'medicine', :view => 'gallery' }
 
   it "should display results in a galley view" do

data/spec/features/slideshow_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "Slideshow", :js do
+describe "Slideshow", :js, :type => :feature do
 
   it "should open when one of the grid panes are clicked" do
     visit catalog_index_path( :q => 'medicine', :view => 'slideshow' )

data/spec/helpers/blacklight/gallery_helper_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Blacklight::GalleryHelper do
+describe Blacklight::GalleryHelper, :type => :helper do
   describe "#render_gallery_collection" do
     let(:template) { double }
     before do
@@ -10,12 +10,12 @@ describe Blacklight::GalleryHelper do
     let(:documents) { [ double, double] }
     subject { helper.render_gallery_collection documents}
 
-    it { should eq 'hello hello ' }
+    it { is_expected.to eq 'hello hello ' }
   end
 
   describe "#gallery_wrapper_template" do
     before do
-      helper.stub(:blacklight_config).and_return(CatalogController.blacklight_config)
+      allow(helper).to receive(:blacklight_config).and_return(CatalogController.blacklight_config)
       helper.lookup_context.prefixes << "catalog"
     end
     

data/spec/spec_helper.rb

@@ -1,18 +1,20 @@
 ENV["RAILS_ENV"] ||= 'test'
 
-require 'blacklight'
-require 'blacklight/gallery'
-
 require 'engine_cart'
 EngineCart.load_application!
 
+require 'rspec/collection_matchers'
+require 'rspec/its'
 require 'rspec/rails'
+require 'rspec/active_model/mocks'
+
 require 'capybara/poltergeist'
 Capybara.javascript_driver = :poltergeist
 
+require 'blacklight'
+require 'blacklight/gallery'
+
 RSpec.configure do |c|
-  c.treat_symbols_as_metadata_keys_with_true_values = true
   c.infer_spec_type_from_file_location!
-  
 end
 

data/spec/views/catalog/_document_slideshow.html.erb_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-describe "catalog/_document_slideshow.html.erb" do
+describe "catalog/_document_slideshow.html.erb", :type => :view do
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   let(:document) { stub_model(::SolrDocument) }
 
   before do
-    view.stub(blacklight_config: blacklight_config)
-    view.stub(documents: [document])
+    allow(view).to receive_messages(blacklight_config: blacklight_config)
+    allow(view).to receive_messages(documents: [document])
   end
 
   it "should have a edit tag form" do

data/spec/views/catalog/_index_gallery.html.erb_spec.rb

@@ -1,20 +1,20 @@
 require 'spec_helper'
 
-describe "catalog/_index_gallery.html.erb" do
+describe "catalog/_index_gallery.html.erb", :type => :view do
   let(:blacklight_config) { Blacklight::Configuration.new }
 
   let(:document) { stub_model(::SolrDocument) }
 
   before do
     blacklight_config.view.gallery.partials = ['a', 'b']
-    view.stub(blacklight_config: blacklight_config)
-    view.stub(document: document)
-    view.stub(document_counter: 3, document_counter_with_offset: 3)
+    allow(view).to receive_messages(blacklight_config: blacklight_config)
+    allow(view).to receive_messages(document: document)
+    allow(view).to receive_messages(document_counter: 3, document_counter_with_offset: 3)
   end
 
   it "should have thumbnail and caption" do
-    view.should_receive(:render_thumbnail_tag).with(document, {}, hash_including(:counter)).and_return('Thumbnail')
-    view.should_receive(:render_document_partials).with(document, ['a', 'b'], document_counter: 3).and_return('Z')
+    expect(view).to receive(:render_thumbnail_tag).with(document, {}, hash_including(:counter)).and_return('Thumbnail')
+    expect(view).to receive(:render_document_partials).with(document, ['a', 'b'], document_counter: 3).and_return('Z')
     render
     expect(rendered).to have_selector '.thumbnail', text: 'Thumbnail'
     expect(rendered).to have_selector '.caption', text: 'Z'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-gallery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: openseadragon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +96,48 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-activemodel-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: 
 email:
 - cabeer@stanford.edu
@@ -149,15 +219,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/javascripts/blacklight_gallery/default.js
+- app/assets/javascripts/blacklight_gallery/osd_viewer.js
 - app/assets/javascripts/blacklight_gallery/slideshow.js
+- app/assets/stylesheets/blacklight_gallery/_gallery.css.scss
+- app/assets/stylesheets/blacklight_gallery/_osd_viewer.css.scss
 - app/assets/stylesheets/blacklight_gallery/_slideshow.css.scss
 - app/assets/stylesheets/blacklight_gallery/default.css.scss
 - app/helpers/blacklight/gallery_helper.rb
+- app/models/concerns/blacklight/gallery/openseadragon_solr_document.rb
 - app/views/catalog/_document_gallery.html.erb
 - app/views/catalog/_document_slideshow.html.erb
 - app/views/catalog/_grid_slideshow.html.erb
 - app/views/catalog/_index_gallery.html.erb
 - app/views/catalog/_index_slideshow.html.erb
+- app/views/catalog/_openseadragon_default.html.erb
 - app/views/catalog/_slideshow.html.erb
 - app/views/catalog/_slideshow_modal.html.erb
 - blacklight-gallery.gemspec
@@ -211,4 +287,3 @@ test_files:
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_document_slideshow.html.erb_spec.rb
 - spec/views/catalog/_index_gallery.html.erb_spec.rb
-has_rdoc: