wax_iiif 0.0.2 → 0.1.0

data/spec/wax_iiif/config_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+
+describe WaxIiif::Config do
+  context 'comparing' do
+    it 'shows equal things to be equal' do
+      expect(WaxIiif::Config.new).to eq(WaxIiif::Config.new)
+    end
+    it 'shows different things to be different' do
+      opts = {tile_width: 99, upload_to_s3: false}
+      opts2 = {tile_width: 100, upload_to_s3: false}
+      expect(WaxIiif::Config.new opts).not_to eq(WaxIiif::Config.new opts2)
+    end
+  end
+end

data/spec/wax_iiif/image_info_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'ostruct'
+
+include WaxIiif
+
+describe WaxIiif::ImageInfo do
+
+  let(:uri) {'http://www.example.com/test/1'}
+  include_context('fake variants')
+
+  context 'intialization' do
+
+
+    it 'initializes without errors' do
+      expect{ImageInfo.new(uri,@fake_variants)}.not_to raise_error
+    end
+    it "raises an error without a 'full' variant" do
+      @fake_variants.delete 'full'
+      expect{ImageInfo.new(uri,@fake_variants)}.to raise_error(Error::InvalidImageData)
+    end
+    it "raises an error without a 'thumbnail' variant" do
+      @fake_variants.delete 'thumbnail'
+      expect{ImageInfo.new(uri,@fake_variants)}.to raise_error(Error::InvalidImageData)
+    end
+  end
+
+
+  context 'valid data' do
+    before(:example) do
+      @info = ImageInfo.new(uri,@fake_variants)
+    end
+
+    it 'generates correct sizes' do
+      expect(@info.sizes).to eq([{'width' => 1000, 'height' => 1200},{'width' => 100, 'height' => 120}])
+    end
+
+    it 'generates nil when no tile data appears' do
+      expect(@info.tiles).to be_nil
+    end
+
+    it 'generates tile info when tile data appears' do
+      info = ImageInfo.new(uri,@fake_variants,500,[1,2,4])
+      expect(info.tiles).to eq([{'width' => 500, 'scaleFactors' => [1,2,4]}])
+    end
+
+    it 'has the correct other methods' do
+      expect(@info).to respond_to 'context'
+      expect(@info).to respond_to 'protocol'
+      expect(@info).to respond_to 'profile'
+      expect(@info).to respond_to 'service'
+    end
+
+    it 'generates correct JSON' do
+      expect(@info.to_json.delete(" \t\r\n")).to eq(@fake_image_info)
+    end
+  end
+end

data/spec/wax_iiif/image_record_spec.rb

@@ -0,0 +1,82 @@
+ require 'spec_helper'
+ require 'base_properties_spec'
+
+
+describe WaxIiif::ImageRecord do
+  let(:opts) {{
+      id: 1
+    }}
+    let(:image_record) {WaxIiif::ImageRecord.new(opts)}
+
+  it 'initializes without an error' do
+    expect{WaxIiif::ImageRecord.new}.not_to raise_error
+  end
+  it 'initializes without an error when provided a hash' do
+    opts = {id: 1}
+    expect{WaxIiif::ImageRecord.new(opts)}.not_to raise_error
+  end
+
+  context '#viewing_direction' do
+    it 'has a sensible default' do
+      expect(image_record.viewing_direction).to eq WaxIiif::DEFAULT_VIEWING_DIRECTION
+    end
+
+    it 'rejects invalid viewing directions on init' do
+      opts = {viewing_direction: 'wonky'}
+      expect{WaxIiif::ImageRecord.new(opts)}.to raise_error(WaxIiif::Error::InvalidViewingDirection)
+    end
+
+    it 'rejects setting invalid viewing directions' do
+      expect{image_record.viewing_direction = 'wonky'}.to raise_error(WaxIiif::Error::InvalidViewingDirection)
+    end
+  end
+
+  it 'initializes with provided hash values' do
+    expect(image_record.id).to eq opts[:id]
+  end
+  it 'ignores unknown data' do
+    opts['junk_data'] = 'bozo'
+    expect{WaxIiif::ImageRecord.new(opts)}.not_to raise_error
+  end
+  context '#is_primary' do
+    it 'defaults to false' do
+      expect(image_record.primary?).to equal(false)
+    end
+    it 'forces is_primary to boolean' do
+      image_record.is_primary = 'banana'
+      expect(image_record.primary?).to equal(true)
+    end
+    it 'allows page_number default to be overridded' do
+      image_record.is_primary = false
+      expect(image_record.primary?).to equal(false)
+    end
+  end
+  context '#image_path' do
+    it 'raises on a blan path' do
+      expect{image_record.path = nil}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+    it 'raises an error for a bad file name' do
+      expect{image_record.path = 'imaginary_file.jpg'}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+  end
+  context '#section' do
+    it 'uses the default for the name' do
+      expect(image_record.section).to eq WaxIiif::DEFAULT_CANVAS_LABEL
+    end
+    it 'uses the default for the label' do
+      expect(image_record.section_label).to eq WaxIiif::DEFAULT_CANVAS_LABEL
+    end
+  end
+  context '#is_document' do
+    it 'defaults to false' do
+      expect(image_record.document?).to equal(false)
+    end
+    it 'has_an_alias' do
+      expect(image_record.document?).to equal(false)
+    end
+    it 'forces is_document to boolean' do
+      image_record.is_document = 'banana'
+      expect(image_record.document?).to equal(true)
+    end
+  end
+end

data/spec/wax_iiif/image_variant_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe WaxIiif::ImageVariant do
+  let(:config) {WaxIiif::Config.new}
+  let(:data) { WaxIiif::ImageRecord.new({
+    'path' => './spec/data/test.jpg',
+    'id' => 1})
+  }
+
+  context 'initialization errors' do
+    it 'raises if the image does not have an ID' do
+      data.id =nil
+      expect{WaxIiif::ImageVariant.new(data, config)}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+    it 'raises if the image has a blank ID' do
+      data.id = ''
+      expect{WaxIiif::ImageVariant.new(data, config)}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+
+    it 'raises if the image is not a valid image file' do
+      data.path = './spec/data/test.csv'
+      expect{WaxIiif::ImageVariant.new(data, config)}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+
+  end
+
+  context 'basic data' do
+    before(:all) do
+      data = WaxIiif::ImageRecord.new({
+        'path' => './spec/data/test.jpg',
+        'id' => 1
+      })
+      config = WaxIiif::Config.new
+      @img = WaxIiif::ImageVariant.new(data, config, 100)
+    end
+
+    # it 'has a uri' do
+    #   expect(@img.uri).to eq("#{@img.generate_image_id(1)}/full/100,/0/default.jpg")
+    # end
+    # it 'has an id' do
+    #   expect(@img.id).to eq(@img.generate_image_id(1))
+    # end
+    # it 'has a width' do
+    #   expect(@img.width).to eq(100)
+    # end
+    # it 'has a mime type' do
+    #   expect(@img.mime_type).to eq('image/jpeg')
+    # end
+  end
+
+  context 'Full Image' do
+    before(:all) do
+      data = WaxIiif::ImageRecord.new({
+        'path' => './spec/data/test.jpg',
+        'id' => 1,
+        'page_number' => 1
+      })
+       config = WaxIiif::Config.new
+       @img = WaxIiif::FullImage.new(data, config)
+    end
+    # it 'has the default filestring' do
+    #   expect(@img.uri).to include 'full/full'
+    # end
+
+  end
+end

data/spec/wax_iiif/manifest_spec.rb

@@ -0,0 +1,97 @@
+ require 'spec_helper'
+ require 'base_properties_spec'
+
+
+describe WaxIiif::Manifest do
+  include_context('fake data')
+
+  context 'base' do
+      before(:each) do
+        @object = m
+      end
+      it_behaves_like 'base properties'
+  end
+
+  let (:config) {WaxIiif::Config.new()}
+  let (:m) {WaxIiif::Manifest.new(@fake_data[0,2], config)}
+  let (:output) {JSON.parse(m.to_json)}
+
+  it 'initializes without an error' do
+    expect(m).to be_a(WaxIiif::Manifest)
+  end
+
+
+  it 'exports JSON-LD as a valid JSON string' do
+    expect(m.to_json).to be_a(String)
+    expect{JSON.parse(m.to_json)}.not_to raise_error
+  end
+
+  it 'has a @context' do
+    expect(output['@context']).to eq(WaxIiif::PRESENTATION_CONTEXT)
+  end
+  it 'has a @type' do
+    expect(output['@type']).to eq(WaxIiif::Manifest::TYPE)
+  end
+  it 'has an @id' do
+    expect(output['@id']).to eq("#{WaxIiif::Config::DEFAULT_URL}/1/manifest.json")
+  end
+
+  context 'error checking' do
+    it 'throws an error if not provided ImageRecords' do
+      expect{WaxIiif::Manifest.new(['not an image record'],config)}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+    it "throws an error unless there's a primary image" do
+      data = @fake_data.clone
+      data.map { |d| d.is_primary = false }
+      expect{WaxIiif::Manifest.new(data, config)}.to raise_error(WaxIiif::Error::InvalidImageData)
+    end
+    it 'throws an error if there are two primary images' do
+      data1 = WaxIiif::ImageRecord.new({is_primary: true})
+      data2 = WaxIiif::ImageRecord.new({is_primary: true})
+
+      expect{WaxIiif::Manifest.new([data1, data2],config)}.to raise_error(WaxIiif::Error::MultiplePrimaryImages)
+    end
+  end
+
+  context 'config variables' do
+    let (:config) {WaxIiif::Config.new({:use_extensions => false})}
+    it 'the @id has an extension if configured thusly' do
+      expect(output['@id']).to eq("#{WaxIiif::Config::DEFAULT_URL}/1/manifest")
+    end
+  end
+
+  context 'base_url config variable' do
+    let (:config) {WaxIiif::Config.new({base_url: 'http://www.example.com'})}
+    it 'uses non-test uris' do
+      expect(output['@id']).to eq('http://www.example.com/1/manifest.json')
+    end
+  end
+
+  context 'spec requirements' do
+    it 'has a label' do
+      expect(output['label'].length).to be > 0
+    end
+    it 'does not have a format' do
+      expect(output['format']).to be_nil
+    end
+    it 'does not have a height' do
+      expect(output['height']).to be_nil
+    end
+    it 'does not have a width' do
+      expect(output['width']).to be_nil
+    end
+    it 'does not have a startCanvas' do
+      expect(output['startCanvas']).to be_nil
+    end
+    it 'accepts valid viewing directions' do
+      dir = 'right-to-left'
+      new_data = @fake_data.first
+      new_data.viewing_direction = dir
+      m = WaxIiif::Manifest.new([new_data],config)
+      o = JSON.parse(m.to_json)
+      expect(o['viewingDirection']).to eq(dir)
+
+    end
+  end
+
+end

data/spec/wax_iiif/utilities/pdf_splitter_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+
+describe WaxIiif::Utilities::PdfSplitter do
+  context 'comparing' do
+    it 'generates the proper number of files' do
+      skip('skipping expensive tests') if ENV['SKIP_EXPENSIVE_TESTS']
+      Dir.mktmpdir do |dir|
+        results = WaxIiif::Utilities::PdfSplitter.split('./spec/data/test.pdf', output_dir: dir)
+        expect(results.count).to eq(3)
+      end
+    end
+  end
+end

data/wax_iiif.gemspec

@@ -1,29 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "wax_iiif"
-  spec.version       = "0.0.2"
-  spec.authors       = ["Marii Nyrop", "David Newbury"]
-  spec.email         = ["m.nyrop@columbia.edu"]
-  spec.summary       = "Minimal iiif level 0 generator – i.e. David Newbury's iiif_s3 minus s3."
-  spec.description   = ""
-  spec.homepage      = "https://github.com/cmoa/iiif_s3"
-  spec.license       = "MIT"
+  spec.name          = 'wax_iiif'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Marii Nyrop', 'David Newbury']
+  spec.email         = ['m.nyrop@columbia.edu']
+  spec.summary       = 'Minimal IIIF level 0 generator'
+  spec.description   = 'Minimal IIIF level 0 generator for use with minicomp/wax'
+  spec.homepage      = 'https://github.com/minicomp/wax_iiif'
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 
-  spec.add_runtime_dependency "mini_magick", ">= 4.8"
+  spec.add_runtime_dependency 'mini_magick', '~> 4.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wax_iiif
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Marii Nyrop
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,113 +17,71 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: guard
-  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: guard-rspec
-  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: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
-description: ''
+description: Minimal IIIF level 0 generator for use with minicomp/wax
 email:
 - m.nyrop@columbia.edu
 executables: []
@@ -132,29 +90,27 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
-- Rakefile
-- lib/iiif_s3/base_properties.rb
-- lib/iiif_s3/builder.rb
-- lib/iiif_s3/collection.rb
-- lib/iiif_s3/config.rb
-- lib/iiif_s3/errors.rb
-- lib/iiif_s3/full_image.rb
-- lib/iiif_s3/image_info.rb
-- lib/iiif_s3/image_record.rb
-- lib/iiif_s3/image_tile.rb
-- lib/iiif_s3/image_variant.rb
-- lib/iiif_s3/manifest.rb
-- lib/iiif_s3/thumbnail.rb
-- lib/iiif_s3/utilities.rb
-- lib/iiif_s3/utilities/helpers.rb
-- lib/iiif_s3/utilities/pdf_splitter.rb
-- lib/iiif_s3/version.rb
 - lib/wax_iiif.rb
+- lib/wax_iiif/base_properties.rb
+- lib/wax_iiif/builder.rb
+- lib/wax_iiif/collection.rb
+- lib/wax_iiif/config.rb
+- lib/wax_iiif/errors.rb
+- lib/wax_iiif/full_image.rb
+- lib/wax_iiif/image_info.rb
+- lib/wax_iiif/image_record.rb
+- lib/wax_iiif/image_tile.rb
+- lib/wax_iiif/image_variant.rb
+- lib/wax_iiif/manifest.rb
+- lib/wax_iiif/thumbnail.rb
+- lib/wax_iiif/utilities.rb
+- lib/wax_iiif/utilities/helpers.rb
+- lib/wax_iiif/utilities/pdf_splitter.rb
 - spec/base_properties_spec.rb
 - spec/data/blank.csv
 - spec/data/invalid.csv
@@ -162,19 +118,18 @@ files:
 - spec/data/test.csv
 - spec/data/test.jpg
 - spec/data/test.pdf
-- spec/iiif_s3/builder_spec.rb
-- spec/iiif_s3/collection_spec.rb
-- spec/iiif_s3/config_spec.rb
-- spec/iiif_s3/image_info_spec.rb
-- spec/iiif_s3/image_record_spec.rb
-- spec/iiif_s3/image_variant_spec.rb
-- spec/iiif_s3/manifest_spec.rb
-- spec/iiif_s3/utilities/pdf_splitter_spec.rb
 - spec/shared_contexts.rb
 - spec/spec_helper.rb
-- test.rb
+- spec/wax_iiif/builder_spec.rb
+- spec/wax_iiif/collection_spec.rb
+- spec/wax_iiif/config_spec.rb
+- spec/wax_iiif/image_info_spec.rb
+- spec/wax_iiif/image_record_spec.rb
+- spec/wax_iiif/image_variant_spec.rb
+- spec/wax_iiif/manifest_spec.rb
+- spec/wax_iiif/utilities/pdf_splitter_spec.rb
 - wax_iiif.gemspec
-homepage: https://github.com/cmoa/iiif_s3
+homepage: https://github.com/minicomp/wax_iiif
 licenses:
 - MIT
 metadata: {}
@@ -197,7 +152,7 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Minimal iiif level 0 generator – i.e. David Newbury's iiif_s3 minus s3.
+summary: Minimal IIIF level 0 generator
 test_files:
 - spec/base_properties_spec.rb
 - spec/data/blank.csv
@@ -206,13 +161,13 @@ test_files:
 - spec/data/test.csv
 - spec/data/test.jpg
 - spec/data/test.pdf
-- spec/iiif_s3/builder_spec.rb
-- spec/iiif_s3/collection_spec.rb
-- spec/iiif_s3/config_spec.rb
-- spec/iiif_s3/image_info_spec.rb
-- spec/iiif_s3/image_record_spec.rb
-- spec/iiif_s3/image_variant_spec.rb
-- spec/iiif_s3/manifest_spec.rb
-- spec/iiif_s3/utilities/pdf_splitter_spec.rb
 - spec/shared_contexts.rb
 - spec/spec_helper.rb
+- spec/wax_iiif/builder_spec.rb
+- spec/wax_iiif/collection_spec.rb
+- spec/wax_iiif/config_spec.rb
+- spec/wax_iiif/image_info_spec.rb
+- spec/wax_iiif/image_record_spec.rb
+- spec/wax_iiif/image_variant_spec.rb
+- spec/wax_iiif/manifest_spec.rb
+- spec/wax_iiif/utilities/pdf_splitter_spec.rb