openseadragon 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18d43d32894da3240f3369a3b12c81e229a61466
-  data.tar.gz: d58c49ef95383a9bb8feea8f3e239daa6451a7b4
+  metadata.gz: 14efe47c95e1ac88bc454c7ad91100b92b1835d5
+  data.tar.gz: 5ea80765a25fde178aeb7a88746a1de7b9dd1793
 SHA512:
-  metadata.gz: f70211dcbe9ee4f97e2fdcc5ea204fe13a1d16a91e0c891c61e7523874c132c489b4ffe675c83009f8e4ec26203e6199472867b844455808f8e81e3a256e92f6
-  data.tar.gz: 8336ab2fa8befbcc031f993d62768b1b33e32b54a441bb13c0da321adc2fb36b26ba2c2fb5e937fc2217a13edeeaa2e2587d54a63347610beffcc2c4125a6723
+  metadata.gz: 8f9866c71944872ea106c1c1505a1ef5939b0e023c061dacd58588fecffd8973b9c01c72c0f77c38ded543305449f8a490cf2685a6cc5885f5063a1152a4af3c
+  data.tar.gz: 91b744c99940886dba57481b7e454c9588bc7b561610cc896b3c8153124685d735eaadd82158e9b5cbedc58503bfec645cae4c79e4b61ba2924879699187c63e

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2015 The Board of Trustees of the Leland Stanford Junior University and Data Curation Experts
+Additional copyright may be held by others, as reflected in the commit log
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -4,16 +4,34 @@ OpenSeadragon is a javascript library for displaying tiling images. This gem pac
 
 http://openseadragon.github.io/
 
-# Usage
+## Installation
 
-This gem provides two helpers, `#picture_tag` and `#openseadragon_picture_tag`.
+Add the gem to your Gemfile:
 
-In your controller add this line:
 ```ruby
-  helper Openseadragon::OpenseadragonHelper
+gem 'openseadragon-rails'
+```
+
+Run bundle install: 
+
+```
+$ bundle install
+```
+
+And run the openseadragon-rails install generator:
+
+```
+$ bundle exec rails g openseadragon:install
 ```
 
-## picture_tag
+The generator will install the Rails helpers and openseadragon assets.
+
+## Usage
+
+This gem provides two helpers, `#picture_tag` and `#openseadragon_picture_tag`.
+
+
+### picture_tag
 
 The `#picture_tag` helper creates [HTML5 <picture> tags](http://www.w3.org/TR/html-picture-element/).
 
@@ -47,7 +65,7 @@ picture_tag ['page1.jpg' => { id: 'first-picture'}], 'page2.jpg', 'page3.jpg', {
 </picture>
 ```
 
-## openseadragon_picture_tag
+### openseadragon_picture_tag
 
 If you have an OpenSeaDragon tilesource, you can use this helper to construct a HTML5 `<picture>` that will render as an OpenSeaDragon tile viewer.
 

data/Rakefile

@@ -7,3 +7,10 @@ RSpec::Core::RakeTask.new(:spec)
 
 task ci: ['engine_cart:generate', :spec]
 task default: :ci
+
+
+task server: ['engine_cart:generate'] do
+  within_test_app do
+    system "bundle exec rails s"
+  end
+end

data/app/assets/javascripts/openseadragon.js

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

data/app/assets/javascripts/openseadragon/jquery.js

@@ -0,0 +1,39 @@
+(function($) {
+  $.fn.openseadragon = function() {
+    var __osd_counter = 0;
+    function generateOsdId() {
+      __osd_counter++;
+      
+      return "Openseadragon" + __osd_counter;
+    }
+
+    $(this).each(function() {
+      var $picture = $(this);
+      $picture.addClass('openseadragon-viewer');
+      
+      if (typeof $picture.attr('id') === "undefined") {
+        $picture.attr('id', generateOsdId());
+      }
+
+      var collectionOptions = $picture.data('openseadragon');
+      
+      var sources = $picture.find('source[media="openseadragon"]');
+
+      var tilesources = $.map(sources, function(e) {
+        if ($(e).data('openseadragon')) {
+          return $(e).data('openseadragon');
+        } else {
+          return $(e).attr('src');
+        }
+      });
+
+      $picture.css('height', $picture.css('height'));
+
+      $picture.data('osdViewer', OpenSeadragon(
+        $.extend({ id: $picture.attr('id') }, collectionOptions, { tileSources: tilesources })
+      ));
+    });
+
+    return this;
+  };
+})(jQuery);

data/app/assets/javascripts/openseadragon/rails.js

@@ -1,42 +1,10 @@
-//= require openseadragon
+//= require openseadragon/jquery
 
 (function($) {
-  var __osd_counter = 0;
-  function generateOsdId() {
-    __osd_counter++;
-    
-    return "Openseadragon" + __osd_counter;
-  }
-
   function initOpenSeadragon() {
-    $('picture[data-openseadragon]').each(function() {
-      var $picture = $(this);
-      
-      if (typeof $picture.attr('id') === "undefined") {
-        $picture.attr('id', generateOsdId());
-      }
-
-      var collectionOptions = $picture.data('openseadragon');
-      
-      var sources = $picture.find('source[media="openseadragon"]');
-
-      var tilesources = $.map(sources, function(e) {
-        if ($(e).data('openseadragon')) {
-          return $(e).data('openseadragon');
-        } else {
-          return $(e).attr('src');
-        }
-      });
-      
-      $picture.css("display", "block");
-      $picture.css("height", "500px");
-
-      $picture.data('osdViewer', OpenSeadragon(
-        $.extend({ id: $picture.attr('id') }, collectionOptions, { tileSources: tilesources })
-      ));
-    });
-  };
+    $('picture[data-openseadragon]').openseadragon();
+  }
 
-  window.onload = initOpenSeadragon;
-  document.addEventListener("page:load", initOpenSeadragon, false);
+  $(document).on('page:load', initOpenSeadragon);
+  $(document).ready(initOpenSeadragon);
 })(jQuery);

data/app/assets/stylesheets/openseadragon/openseadragon.css

@@ -0,0 +1,4 @@
+.openseadragon-viewer {
+  display: block;
+  min-height: 500px;
+}

data/lib/generators/openseadragon/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Openseadragon
+  class Install < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    def assets
+      copy_file "openseadragon.css", "app/assets/stylesheets/openseadragon.css"
+      copy_file "openseadragon.js", "app/assets/javascripts/openseadragon.js"
+    end
+
+    def inject_helper
+      inject_into_class 'app/controllers/application_controller.rb', ApplicationController do
+        "  helper Openseadragon::OpenseadragonHelper\n"
+      end
+    end
+  end
+end

data/lib/generators/openseadragon/templates/openseadragon.css

@@ -0,0 +1,3 @@
+/*
+ *= require openseadragon/openseadragon
+ */

data/lib/generators/openseadragon/templates/openseadragon.js

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

data/lib/openseadragon/version.rb

@@ -1,3 +1,3 @@
 module Openseadragon
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/openseadragon.gemspec

@@ -6,12 +6,12 @@ require 'openseadragon/version'
 Gem::Specification.new do |spec|
   spec.name          = "openseadragon"
   spec.version       = Openseadragon::VERSION
-  spec.authors       = ["Justin Coyne", "Brian Maddy"]
-  spec.email         = ["justin@curationexperts.com"]
+  spec.authors       = ["Justin Coyne", "Chris Beer", "Christopher Jesudurai"]
+  spec.email         = ["justin@curationexperts.com", "cabeer@stanford.edu", "jchris@stanford.edu"],
   spec.summary       = %q{OpenSeadragon assets and helpers for Rails. http://openseadragon.github.io/}
   spec.description   = %q{OpenSeadragon is a javascript library for displaying tiling images. This gem packages those assets and some Rails helpers for using them}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/iiif/openseadragon-rails"
+  spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root "../../spec/test_app_templates"
+
+  def run_generator
+    generate 'openseadragon:install'
+  end
+
+  def generate_controller
+    generate 'controller test show'
+    route "root to: 'test#show'"
+  end
+
+  def add_osd_to_view
+    copy_file "show.html.erb", 'app/views/test/show.html.erb', force: true
+  end
+end

data/spec/test_app_templates/show.html.erb

@@ -0,0 +1 @@
+<%= openseadragon_picture_tag 'https://stacks.stanford.edu/image/iiif/xf680rd3068%2Fxf680rd3068_00_0001/info.json' %>

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: openseadragon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Coyne
-- Brian Maddy
+- Chris Beer
+- Christopher Jesudurai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,7 +113,10 @@ dependencies:
 description: OpenSeadragon is a javascript library for displaying tiling images. This
   gem packages those assets and some Rails helpers for using them
 email:
-- justin@curationexperts.com
+- - justin@curationexperts.com
+  - cabeer@stanford.edu
+  - jchris@stanford.edu
+- OpenSeadragon assets and helpers for Rails. http://openseadragon.github.io/
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -120,13 +124,19 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/openseadragon.js
+- app/assets/javascripts/openseadragon/jquery.js
 - app/assets/javascripts/openseadragon/rails.js
+- app/assets/stylesheets/openseadragon/openseadragon.css
 - app/helpers/openseadragon/openseadragon_helper.rb
 - app/models/openseadragon/image.rb
 - app/models/openseadragon/open_street_map.rb
+- lib/generators/openseadragon/install_generator.rb
+- lib/generators/openseadragon/templates/openseadragon.css
+- lib/generators/openseadragon/templates/openseadragon.js
 - lib/openseadragon.rb
 - lib/openseadragon/engine.rb
 - lib/openseadragon/version.rb
@@ -135,6 +145,8 @@ files:
 - spec/models/openseadragon/image_spec.rb
 - spec/models/openseadragon/open_street_map.rb
 - spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/test_app_templates/show.html.erb
 - vendor/assets/images/openseadragon/fullpage_grouphover.png
 - vendor/assets/images/openseadragon/fullpage_hover.png
 - vendor/assets/images/openseadragon/fullpage_pressed.png
@@ -167,10 +179,10 @@ files:
 - vendor/assets/images/openseadragon/zoomout_hover.png
 - vendor/assets/images/openseadragon/zoomout_pressed.png
 - vendor/assets/images/openseadragon/zoomout_rest.png
-- vendor/assets/javascripts/openseadragon.js
-homepage: ''
+- vendor/assets/javascripts/openseadragon/openseadragon.js
+homepage: https://github.com/iiif/openseadragon-rails
 licenses:
-- MIT
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -197,3 +209,5 @@ test_files:
 - spec/models/openseadragon/image_spec.rb
 - spec/models/openseadragon/open_street_map.rb
 - spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/test_app_templates/show.html.erb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 TODO: Write your name
-
-MIT License
-
-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.