openseadragon 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in openseadragon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,24 @@
+# OpenSeadragon
+
+OpenSeadragon is a javascript library for displaying tiling images. This gem packages those assets and some Rails helpers for using them.
+
+http://openseadragon.github.io/
+
+# Setup
+
+In order to display a file, OpenSeadragon needs to know the full dimension of the image.  In order to do this we need to inject an image resolver. Here's an example.
+
+```ruby
+    module ImageResolver
+      def self.find(id)
+        # Custom code here to find the height & width
+        Openseadragon::Image.new(id: id, height: 4000, width: 8000)
+      end
+    end
+
+    # register the resolver
+    Openseadragon::Image.file_resolver = ImageResolver
+```
+
+The image resolver only needs to implement the `find` method. It takes an id as a parameter and returns a new instance of `Openseadragon::Image`
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task ci: ['engine_cart:generate', :spec]
+task default: :ci

data/app/helpers/openseadragon/openseadragon_helper.rb

@@ -0,0 +1,114 @@
+module Openseadragon
+  module OpenseadragonHelper
+
+    # @param id [String] the image identifier
+    # @param options [Hash] 
+    # @option options [String] :id ('openseadragon1') HTML id
+    # @option options [Hash] :html HTML attributes
+    # @option options [String] :prefixUrl
+    # @option options [Array] :tileSources ([])
+    # @option options [Hash] :options_with_raw_js
+    def openseadragon_collection_viewer(ids_or_images, options={})
+      html_options = (options[:html] or {})
+      html_options[:id] = (options[:id] or 'openseadragon1')
+
+      tile_sources = ids_or_images.zip((options[:tileSources] or [])).map do |id_or_image, opts|
+        image_options(id_or_image, opts)
+      end
+
+      collection_options = {
+        id: html_options[:id],
+        prefixUrl: '/assets/openseadragon/',
+        tileSources: tile_sources,
+      }.deep_merge(options.except(:html, :tileSources))
+
+      js_options = options_to_js(collection_options.except(:options_with_raw_js),
+                                 collection_options[:options_with_raw_js])
+
+      js =<<-EOF
+        function initOpenSeadragon() {
+          OpenSeadragon(#{js_options});
+        }
+        window.onload = initOpenSeadragon;
+        document.addEventListener("page:load", initOpenSeadragon); // Initialize when using turbolinks
+      EOF
+      tag(:div, html_options) + javascript_tag(js) 
+    end
+
+    # converts a ruby hash to a javascript object without stringifying the raw_js_keys
+    # so you can put js variables in there
+    def options_to_js(options, raw_js_keys=[])
+      normal = options.except(*raw_js_keys).stringify_keys.map do |k, v|
+        val = if v.is_a?(Hash) or v.is_a?(Array)
+                JSON.pretty_generate(v)
+              else
+                json_dump(v)
+              end
+        k.to_s.inspect + ": " + val
+      end
+      raw_js = options.slice(*raw_js_keys).map{|k, v| k.to_s + ": " + v.to_s}
+      "{\n" + (normal + raw_js).join(",\n") + "}"
+    end
+
+
+    # This hack is necessary for ruby 1.9.3. Just use JSON.dump(val) if Ruby >= 2.0
+    if RUBY_VERSION < "2.0.0"
+      def json_dump(val)
+        case val
+        when String
+          val.inspect
+        when Symbol
+          val.to_s.inspect
+        else
+          raise ArgumentError, "Unexpected value #{val.inspect}"
+        end
+      end
+    else
+      def json_dump(val)
+        JSON.dump(val)
+      end
+    end
+
+    # @param id_or_image [String,Image] the image identifier or an image object
+    # @param options [Hash] 
+    # @option options [String] :html_id HTML id
+    # @option options [String] :prefix_url
+    # @option options [String] :image_host
+    # @option options [String] :tile_width
+    # @option options [String] :tile_height
+    def openseadragon_viewer(id_or_image, options={})
+      opts = {}
+      opts[:id] = options[:html_id] if options[:html_id]
+      opts[:prefixUrl] = options[:prefix_url] if options[:prefix_url]
+      opts[:tileSources] = [options.slice(:image_host, :tile_width, :tile_height)]
+      opts.deep_merge!(options.except(:html_id, :prefix_url, :image_host, :tile_width, :tile_height))
+      openseadragon_collection_viewer([id_or_image], opts)
+    end
+
+    private
+
+    # @param id_or_image [String,Image] the image identifier or an image object
+    # @param options [Hash] 
+    def image_options(id_or_image, options)
+      options ||= {}
+      image = case id_or_image
+        when String
+          Image.find(id_or_image)
+        when Image
+          id_or_image
+        end
+      {
+        identifier: image.id,
+        width: image.width,
+        height: image.height,
+        scale_factors: [1, 2, 3, 4, 5],
+        formats: [:jpg, :png],
+        qualities: [:native, :bitonal, :grey, :color],
+        profile: "http://library.stanford.edu/iiif/image-api/compliance.html#level3",
+        tile_width: 1024,
+        tile_height: 1024,
+        image_host: '/image-service',
+      }.merge(options)
+    end
+  end
+end

data/app/models/openseadragon/image.rb

@@ -0,0 +1,23 @@
+module Openseadragon
+  class Image
+    attr_accessor :id, :width, :height
+
+    class_attribute :file_resolver
+   
+    class << self
+      def find(id)
+        file_resolver.find(id)
+      end
+    end
+
+    def initialize(attributes = {})
+      self.id = attributes[:id]
+      self.width = attributes[:width]
+      self.height = attributes[:height]
+    end
+
+    def as_json
+      { id: id}
+    end
+  end
+end

data/lib/openseadragon.rb

@@ -0,0 +1,5 @@
+require "openseadragon/version"
+require "openseadragon/engine"
+
+module Openseadragon
+end

data/lib/openseadragon/engine.rb

@@ -0,0 +1,6 @@
+module Openseadragon 
+  class Engine < ::Rails::Engine
+    isolate_namespace Openseadragon
+  end
+end
+

data/lib/openseadragon/version.rb

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

data/openseadragon.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency 'rails', '> 3.2.0'
+  
+
+end

data/spec/helpers/openseadragon_helper_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+
+describe Openseadragon::OpenseadragonHelper do
+  before do
+    module SpecResolver
+      def self.find(id)
+        Openseadragon::Image.new({ id: id }.merge(data(id)))
+      end
+
+      def self.data(id)
+        { 'world' =>  {height: 400, width: 800},
+          'irises' => {height: 3282, width: 4264}}[id]
+      end
+    end
+    Openseadragon::Image.file_resolver = SpecResolver
+  end
+
+  it "should draw the single item viewer" do
+    out = openseadragon_viewer('world', image_host: '/foo', html: {class: 'stuff'})
+    out.should == '<div class="stuff" id="openseadragon1" /><script>
+//<![CDATA[
+        function initOpenSeadragon() {
+          OpenSeadragon({
+"id": "openseadragon1",
+"prefixUrl": "/assets/openseadragon/",
+"tileSources": [
+  {
+    "identifier": "world",
+    "width": 800,
+    "height": 400,
+    "scale_factors": [
+      1,
+      2,
+      3,
+      4,
+      5
+    ],
+    "formats": [
+      "jpg",
+      "png"
+    ],
+    "qualities": [
+      "native",
+      "bitonal",
+      "grey",
+      "color"
+    ],
+    "profile": "http://library.stanford.edu/iiif/image-api/compliance.html#level3",
+    "tile_width": 1024,
+    "tile_height": 1024,
+    "image_host": "/foo"
+  }
+]});
+        }
+        window.onload = initOpenSeadragon;
+        document.addEventListener("page:load", initOpenSeadragon); // Initialize when using turbolinks
+
+//]]>
+</script>'
+  end
+
+  it "should not crash when there's no tileSources" do
+    openseadragon_collection_viewer(['world', 'irises'], {extraOption: :some_stuff})
+    openseadragon_collection_viewer(['world', 'irises'],
+                                    {extraOption: :some_stuff,
+                                     rawOption: "(1 + 1)",
+                                     options_with_raw_js: [:rawOption]})
+  end
+
+  it "should draw the collection viewer" do
+    out = openseadragon_collection_viewer(['world', 'irises'],
+                                          {tileSources: [{profile: :foo}, {profile: :bar}],
+                                           extraOption: :some_stuff,
+                                           rawOption: "(1 + 1)",
+                                           options_with_raw_js: [:rawOption]})
+    out.should == '<div id="openseadragon1" /><script>
+//<![CDATA[
+        function initOpenSeadragon() {
+          OpenSeadragon({
+"id": "openseadragon1",
+"prefixUrl": "/assets/openseadragon/",
+"tileSources": [
+  {
+    "identifier": "world",
+    "width": 800,
+    "height": 400,
+    "scale_factors": [
+      1,
+      2,
+      3,
+      4,
+      5
+    ],
+    "formats": [
+      "jpg",
+      "png"
+    ],
+    "qualities": [
+      "native",
+      "bitonal",
+      "grey",
+      "color"
+    ],
+    "profile": "foo",
+    "tile_width": 1024,
+    "tile_height": 1024,
+    "image_host": "/image-service"
+  },
+  {
+    "identifier": "irises",
+    "width": 4264,
+    "height": 3282,
+    "scale_factors": [
+      1,
+      2,
+      3,
+      4,
+      5
+    ],
+    "formats": [
+      "jpg",
+      "png"
+    ],
+    "qualities": [
+      "native",
+      "bitonal",
+      "grey",
+      "color"
+    ],
+    "profile": "bar",
+    "tile_width": 1024,
+    "tile_height": 1024,
+    "image_host": "/image-service"
+  }
+],
+"extraOption": "some_stuff",
+rawOption: (1 + 1)});
+        }
+        window.onload = initOpenSeadragon;
+        document.addEventListener("page:load", initOpenSeadragon); // Initialize when using turbolinks
+
+//]]>
+</script>'
+  end
+end

data/spec/internal/.generated_engine_cart

@@ -0,0 +1 @@
+true

data/spec/internal/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp