wax_iiif 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31844c9c4c8aa58c1e5e940fd0bc447c073e0b4e1e5bf8f7dc77970eeaac95b5
-  data.tar.gz: d17b64b8d0f9a6c69340128571128c74bb44c26fb119911aff496dd71a4abc5f
+  metadata.gz: b8e8bfe689315b674d1af11bb292df7b42c6da7dcdaa4fe277b746ab2fcacc5c
+  data.tar.gz: 787041b5e001e26094254a123bf1d42327e1a2ec1d4c7af729f4b1aabb432318
 SHA512:
-  metadata.gz: b8b751aaa0cc21122743f4a2a6f7d166cac8cc7bb36942c631cae2343d382973fe2400282dc1c9e884dc4b9b4902ef8b42fa50a214c69b315a0168c29390b334
-  data.tar.gz: 7ee23f85b57d3ee86abe9002220b73a5138a950dc94406499d2fa59bd7824c56cab91682cd6dc94d8aa311a185e28e774ea2c09e139269c9866324eb5ae0cc15
+  metadata.gz: 3bed76dcd0835a29fcbf74eb01c38c4980d91af269eabde4d5f6535c058a2e81e4e7a2252a6b2d24c7c9029d142baf8600d6179ae3db2de95622682ea5a6acfe
+  data.tar.gz: 15683183c49c2968751abb425cc0d75a4b42d7d21ef7d11a0725b4cddc991079324bf3cf69d4ea9e330a81faf0b05303bd7c92ae827bd5a766eff7683b90d38d

data/.gitignore

@@ -20,6 +20,7 @@ tmp
 *.o
 *.a
 mkmf.log
+temp
 
 .env
 

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude: ['spec/**/*']
+Metrics/LineLength:
+  IgnoredPatterns: ['raise', 'puts', '#', '@', 'spec']
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/RedundantSelf:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Lint/UriEscapeUnescape:
+  Enabled: false

data/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
   - 2.4
+  - 2.5
 addons:
   apt:
     packages:
       - ghostscript
 script:
+  - bundle exec rubocop
   - bundle exec rspec

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in wax_iiif.gemspec
 gemspec
+
+gem 'rubocop', '0.59.0', require: false
+gem 'yard', require: false

data/README.md

@@ -1,8 +1,8 @@
 # wax_iiif
-[![Build Status](https://travis-ci.org/mnyrop/wax_iiif.svg?branch=master)](https://travis-ci.org/mnyrop/wax_iiif) [![Dependency Status](https://gemnasium.com/badges/github.com/mnyrop/wax_iiif.svg)](https://gemnasium.com/github.com/mnyrop/wax_iiif)  [![Maintainability](https://api.codeclimate.com/v1/badges/3eb2fcf5ae47e7b6d686/maintainability)](https://codeclimate.com/github/mnyrop/wax_iiif/maintainability)
+[![Gem Version](https://badge.fury.io/rb/wax_iiif.svg)](https://badge.fury.io/rb/wax_iiif) [![Build Status](https://travis-ci.org/mnyrop/wax_iiif.svg?branch=master)](https://travis-ci.org/mnyrop/wax_iiif) [![Maintainability](https://api.codeclimate.com/v1/badges/3eb2fcf5ae47e7b6d686/maintainability)](https://codeclimate.com/github/mnyrop/wax_iiif/maintainability)
 
-This fork is TRULY just a copy of the [iiif_s3 gem](https://github.com/cmoa/iiif_s3) with all the s3 dependencies and functionality removed!
+![License](https://img.shields.io/badge/license-MIT-green.svg) [![docs](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/minicomp/wax_iiif/)  
 
-It enables the static creation of IIIF derivatives (level 0) for static exhibtion sites with [wax](https://minicomp.github.io/wax/).
+This fork is *mostly* a copy of the [iiif_s3 gem](https://github.com/cmoa/iiif_s3) with all the s3 dependencies and functionality removed. It creates level 0 IIIF derivatives for static exhibition sites with [Minicomp/Wax](https://minicomp.github.io/wax/) via [Wax_Tasks](https://minicomp.github.io/wax_tasks/).
 
-For credit and documentation, head over to [iiif_s3](https://github.com/cmoa/iiif_s3).
+Documentation for using `wax_iiif` without `wax_tasks` is forthcoming. In the meantime, check out [rubydoc](https://www.rubydoc.info/gems/wax_iiif).

data/lib/wax_iiif.rb

@@ -1,83 +1,73 @@
 require 'csv'
 require 'json'
 
-require "iiif_s3/version"
-require "iiif_s3/errors"
-require "iiif_s3/base_properties"
-require "iiif_s3/image_record"
-require "iiif_s3/builder"
-require "iiif_s3/manifest"
-require "iiif_s3/config"
-require "iiif_s3/collection"
-require "iiif_s3/image_variant"
-require "iiif_s3/thumbnail"
-require "iiif_s3/image_tile"
-require "iiif_s3/full_image"
-require "iiif_s3/image_info"
-require "iiif_s3/utilities"
+require_relative 'wax_iiif/errors'
+require_relative 'wax_iiif/base_properties'
+require_relative 'wax_iiif/image_record'
+require_relative 'wax_iiif/builder'
+require_relative 'wax_iiif/manifest'
+require_relative 'wax_iiif/config'
+require_relative 'wax_iiif/collection'
+require_relative 'wax_iiif/image_variant'
+require_relative 'wax_iiif/thumbnail'
+require_relative 'wax_iiif/image_tile'
+require_relative 'wax_iiif/full_image'
+require_relative 'wax_iiif/image_info'
+require_relative 'wax_iiif/utilities'
 
-# Module IiifS3 is a tool for generating IIIF resources from a set of files.
+# Module WaxIiif is a tool for generating IIIF resources from a set of files.
 # It's designed to support the IIIF level 0 profile, and generates entirely static files.
 #
 # @author David Newbury <david.newbury@gmail.com>
 #
-module IiifS3
-
-
+module WaxIiif
   #--------------------------------------------------------------------------
   # CONSTANTS
   #--------------------------------------------------------------------------
 
-
   # @return [String] The URI of the presentation context for the IIIF V.2
-  PRESENTATION_CONTEXT  = "http://iiif.io/api/presentation/2/context.json"
+  PRESENTATION_CONTEXT  = 'http://iiif.io/api/presentation/2/context.json'.freeze
   # @return [String] The URI of the image context for the IIIF V.2
-  IMAGE_CONTEXT         = "http://iiif.io/api/image/2/context.json"
+  IMAGE_CONTEXT         = 'http://iiif.io/api/image/2/context.json'.freeze
   # @return [String] The URI of the image protocol for IIIF
-  IMAGE_PROTOCOL        = "http://iiif.io/api/image"
+  IMAGE_PROTOCOL        = 'http://iiif.io/api/image'.freeze
   # @return [String] The URI of the Level 0 profile for the IIIF V.2
-  LEVEL_0               = "http://iiif.io/api/image/2/level0.json"
+  LEVEL_0               = 'http://iiif.io/api/image/2/level0.json'.freeze
   # @return [String]  The IIIF default type for a sequence.
-  SEQUENCE_TYPE             = "sc:Sequence"
+  SEQUENCE_TYPE             = 'sc:Sequence'.freeze
   # @return [String]  The IIIF default type for a canvas
-  CANVAS_TYPE               = "sc:Canvas"
+  CANVAS_TYPE               = 'sc:Canvas'.freeze
   # @return [String]  The IIIF default type for a annotation.
-  ANNOTATION_TYPE           = "oa:Annotation"
+  ANNOTATION_TYPE           = 'oa:Annotation'.freeze
   # @return [String]  The IIIF default type for an image.
-  IMAGE_TYPE                = "dcterms:Image"
+  IMAGE_TYPE                = 'dcterms:Image'.freeze
   # @return [String] The default label for a canvas without a specified name.
-  MOTIVATION                = "sc:painting"
+  MOTIVATION                = 'sc:painting'.freeze
   # @return [String] The default label for a canvas without a specified name.
-  DEFAULT_CANVAS_LABEL      = "front"
+  DEFAULT_CANVAS_LABEL      = 'front'.freeze
   # @return [String] The default name for a sequence without a specified name.
-  DEFAULT_SEQUENCE_NAME     = "default"
+  DEFAULT_SEQUENCE_NAME     = 'default'.freeze
   # @return [String] The default reading direction for this manifest.
-  DEFAULT_VIEWING_DIRECTION = "left-to-right"
+  DEFAULT_VIEWING_DIRECTION = 'left-to-right'.freeze
   # @return [Number] The size in pixels below which the canvas will be doubled.
   MIN_CANVAS_SIZE           = 1200
 
-
-    #--------------------------------------------------------------------------
-    # HELPERS
-    #--------------------------------------------------------------------------
-
-
+  #--------------------------------------------------------------------------
+  # HELPERS
+  #--------------------------------------------------------------------------
 
   # Validates a viewing direction string against the IIIF V.2.0 spec.
   #
   # According to v2 of the IIIF standards, there are only four valid viewing directions:
-  # "left-to-right", "top-to-bottom”, "bottom-to-top" , and "right-to-left".  This
+  # 'left-to-right', 'top-to-bottom', 'bottom-to-top' , and 'right-to-left'.  This
   #  returns true if the provided direction is one of these, and falst for anything else.
   #
   # @param [String] direction A viewing direction string
   #
   # @return [boolean] Is the provided string a valid viewing direction?
   #
-  def self.is_valid_viewing_direction(direction)
-    direction == "left-to-right" ||
-    direction == "top-to-bottom" ||
-    direction == "bottom-to-top" ||
-    direction == "right-to-left"
+  def self.valid_viewing_direction?(direction)
+    valid = %w[left-to-right top-to-bottom bottom-to-top right-to-left]
+    valid.include? direction
   end
-
 end

data/lib/wax_iiif/base_properties.rb

@@ -0,0 +1,90 @@
+require_relative 'utilities'
+module WaxIiif
+  # Module BaseProperties provides the set of properties that are
+  # shared across all IIIF types.
+  #
+  # It is not a comprehensive list (yet), but it does handle
+  # most of the shared types.  It does not include any types
+  # that have class-based restrictions.
+  #
+  # It also performs some basic sanity checking on (some of) the
+  # fields, and provides utility classes that are applicable across
+  # the fields.
+  #
+  # @todo Add within, service, seeAlso, viewingHint fields
+  # @author David Newbury <david.newbury@gmail.com>
+  #
+  module BaseProperties
+    include Utilities::Helpers
+
+    # @!attribute [rw] label
+    # @return [String] The human-readable label for this record
+    attr_accessor :label
+    # @!attribute [r] id
+    # @return [String] The URI for this record
+    attr_reader :id
+    # @!attribute [rw] description
+    # @return [String] The long-form description of this record
+    attr_accessor :description
+    # @!attribute [rw] metadata
+    # @return [Hash] A set of key/value pairs describing additional metadata for the object.
+    attr_accessor :metadata
+    # @!attribute [rw] attribution
+    # @return [String] a human-readable label, typically used for attribution or credit.
+    attr_accessor :attribution
+    # @!attribute [rw] logo
+    # @return [String] The URI to an image for the logo of the institution associated with this record.
+    attr_accessor :logo
+    # @!attribute [rw] license
+    # @return [String] The URI to a resource that describes the license or rights statement associated.
+    attr_accessor :license
+    # @!attribute [rw] related
+    # @return [String, Array<String>] The URI to related resources.  Can be both a string or an array
+    attr_accessor :related
+
+    # The type of resource provided by this record.
+    #
+    # @return [String] The type of record
+    def type
+      self.class::TYPE
+    end
+
+    # Set the unique id for this record.
+    # This will automatically append the defined prefixes and suffixes.
+    #
+    # @param [String] _id The unique portion of this ID
+    # @return [string] The URI for this record
+    def id=(the_id)
+      @id = generate_id(the_id)
+    end
+
+    # Return the base data structure for this record as a Hash
+    # This will be in IIIF format, and should convert to JSON as JSON-LD nicely.
+    #
+    # @return [Hash] The base properties of this record
+    def base_properties
+      obj = {
+        '@context' => PRESENTATION_CONTEXT,
+        '@id' => self.id,
+        '@type' => self.type,
+        'label' => self.label
+      }
+      obj['attribution'] = self.attribution if self.attribution
+      obj['logo'] = self.logo if self.logo
+      obj['description'] = self.description if self.description
+      obj['attribution'] = self.attribution if self.attribution
+      obj['license'] = self.license if self.license
+      obj['related'] = self.related if self.related
+      obj['metadata'] = self.metadata if self.metadata
+
+      obj
+    end
+
+    # Save the JSON representation of this record to disk
+    #
+    # @return [Void]
+    def save
+      save_to_disk(JSON.parse(self.to_json))
+    end
+  end
+end

data/lib/wax_iiif/builder.rb

@@ -0,0 +1,252 @@
+require_relative 'utilities'
+require 'pathname'
+
+module WaxIiif
+  # Builder class
+  class Builder
+    include Utilities::Helpers
+
+    HEADER_VAL = 'filename'.freeze
+
+    #
+    # @!attribute [r] data
+    #   @return [Array<Hash>] The raw data computed for the given set of images
+    attr_reader :data
+
+    #
+    # @!attribute [r] manifests
+    #   @return [Array<Hash>] The manifest hashes for this configuration
+    attr_accessor :manifests
+
+    # @!attribute [r] config
+    #   @return [WaxIiif::Config] The configuration object
+    attr_reader :config
+
+    # Initialize the builder.
+    #
+    # @param [Hash] config an optional configuration object.
+    # @see WaxIiif::Config
+    # @return [Void]
+    #
+    def initialize(config = {})
+      @manifests = []
+      @config = WaxIiif::Config.new(config)
+    end
+
+    #
+    # Load data into the IIIF builder.
+    #
+    # This will load the data, perform some basic verifications on it, and sort
+    # it into proper order.
+    #
+    # @param [Array<ImageRecord>, ImageRecord] data
+    #   Either a single ImageRecord or an Array of ImageRecords.
+    # @raise [WaxIiif::Error::InvalidImageData] if any of the data does
+    #   not pass the validation checks
+    #
+    # @return [Void]
+    #
+    def load(data)
+      @data = [data].flatten # handle hashes and arrays of hashes
+      # validate
+      @data.each do |image_record|
+        raise WaxIiif::Error::InvalidImageData, "Image record #{image_record.inspect} is not an ImageRecord" unless image_record.is_a? ImageRecord
+        raise WaxIiif::Error::InvalidImageData, "Image record #{image_record.inspect} does not have an ID" if image_record.id.nil?
+      end
+    end
+
+    #
+    # Take the loaded data and generate all the files.
+    #
+    # @param [Boolean] force_image_generation Generate images even if they already exist
+    #
+    # @return [Void]
+    #
+    def process_data(force_image_generation = false)
+      return nil if @data.nil? # do nothing without data.
+
+      @manifests = []
+      @data.group_by(&:manifest_id).each do |key, value|
+        resources     = {}
+        manifest_id   = key
+        image_records = value
+
+        # genrate the images
+        image_records.each do |image_record|
+          # It attempts to load the info files and skip generation - not currently working.
+          info_file = image_info_file_name(image_record)
+          if File.exist?(info_file) && !force_image_generation
+            puts "skipping #{info_file}" if @config.verbose?
+            image_record.variants = load_variants(info_file)
+          else
+            image_record.variants = generate_variants(image_record, @config)
+            generate_tiles(image_record, @config)
+            generate_image_json(image_record, @config)
+          end
+          # Save the image info for the manifest
+          resources[image_record.id] ||= []
+          resources[image_record.id].push image_record
+        end
+
+        # Generate the manifest
+        if manifest_id.to_s.empty?
+          resources.each do |_key, val|
+            manifests.push generate_manifest(val, @config)
+          end
+        else
+          manifests.push generate_manifest(image_records, @config)
+        end
+      end
+
+      generate_collection
+    end
+
+    def generate_collection
+      collection = Collection.new(@config)
+      manifests.each { |m| collection.add_manifest(m) }
+      collection.save
+    end
+
+    # Creates the required directories for exporting to the file system.
+    #
+    # @return [Void]
+    def create_build_directories
+      root_dir = generate_build_location('')
+      Dir.mkdir root_dir unless Dir.exist?(root_dir)
+      img_dir = generate_image_location('').split('/')[0...-1].join('/')
+      Dir.mkdir img_dir unless Dir.exist?(img_dir)
+    end
+
+    # Load data into the IIIF server from a CSV
+    #
+    # @param [String] csv_path Path to the CSV file containing the image data
+    #
+    # @return [Void]
+    # @todo Fix this to use the correct data format!
+    #
+    def load_csv(csv_path)
+      raise Error::InvalidCSV unless File.exist? csv_path
+      begin
+        vals = CSV.read(csv_path)
+      rescue CSV::MalformedCSVError
+        raise Error::InvalidCSV
+      end
+
+      raise Error::BlankCSV if vals.length.zero?
+      raise Error::InvalidCSV if vals[0].length != 3
+
+      # remove optional header
+      vals.shift if vals[0][0] == HEADER_VAL
+
+      @data = vals.collect do |data|
+        {
+          'image_path'  => data[0],
+          'id'          => data[1],
+          'label'       => data[2]
+        }
+      end
+    end
+
+    protected
+
+    #----------------------------------------------------------------
+    def load_variants(path)
+      data  = JSON.parse escape_yaml(File.read(path))
+      id    = data['@id']
+      w     = data['width']
+      h     = data['height']
+
+      thumb_size = data['sizes'].find do |a|
+        same_width  = a['width']  == config.thumbnail_size
+        same_height = a['height'] == config.thumbnail_size
+        same_width || same_height
+      end
+
+      thumb_w   = thumb_size['width']
+      thumb_h   = thumb_size['height']
+      full_url  = "#{id}/full/full/0/default.jpg"
+      thumb_url = "#{id}/full/#{thumb_w},/0/default.jpg"
+      full      = FakeImageVariant.new(id,
+                                       w,
+                                       h,
+                                       full_url,
+                                       'image/jpeg')
+      thumbnail = FakeImageVariant.new(id,
+                                       thumb_w,
+                                       thumb_h,
+                                       thumb_url,
+                                       'image/jpeg')
+
+      { 'full' => full, 'thumbnail' => thumbnail }
+    end
+
+    def generate_tiles(data, config)
+      width = data.variants['full'].width
+      tile_width = config.tile_width
+      height = data.variants['full'].height
+      tiles = []
+      config.tile_scale_factors.each do |s|
+        (0..(height * 1.0 / (tile_width * s)).floor).each do |tile_y|
+          (0..(width * 1.0 / (tile_width * s)).floor).each do |tile_x|
+            tile = {
+              scale_factor: s,
+              xpos: tile_x,
+              ypos: tile_y,
+              x: tile_x * tile_width * s,
+              y: tile_y * tile_width * s,
+              width: tile_width * s,
+              height: tile_width * s,
+              xSize: tile_width,
+              ySize: tile_width
+            }
+            if tile[:x] + tile[:width] > width
+              tile[:width] = width - tile[:x]
+              tile[:xSize] = (tile[:width] / (s * 1.0)).ceil
+            end
+            if tile[:y] + tile[:height] > height
+              tile[:height] = height - tile[:y]
+              tile[:ySize]  = (tile[:height] / (s * 1.0)).ceil
+            end
+            tiles.push(tile)
+          end
+        end
+      end
+      tiles.each do |tile|
+        ImageTile.new(data, @config, tile)
+      end
+    end
+
+    def image_info_file_name(data)
+      "#{generate_image_location(data.id)}/info.json"
+    end
+
+    def generate_image_json(data, config)
+      filename = image_info_file_name(data)
+      info = ImageInfo.new(data.variants['full'].id,
+                           data.variants,
+                           config.tile_width,
+                           config.tile_scale_factors)
+      puts "writing #{filename}" if config.verbose?
+      Pathname.new(Pathname.new(filename).dirname).mkpath
+      File.open(filename, 'w') { |file| file.puts info.to_json }
+      info
+    end
+
+    def generate_manifest(data, config)
+      m = Manifest.new(data, config)
+      m.save_all_files_to_disk
+      m
+    end
+
+    def generate_variants(data, config)
+      obj = {
+        'full' => FullImage.new(data, config),
+        'thumbnail' => Thumbnail.new(data, config)
+      }
+      config.variants.each do |key, image_size|
+        obj[key] = ImageVariant.new(data, config, image_size)
+      end
+      obj
+    end
+  end
+end