wax_iiif 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13d4ff2abd3af952990aacf338ff5d9842fa9947699e5fc1844bbc09e43f625
-  data.tar.gz: 531615c4d2380c96916370b798cf22ed945ea53e79906bc6f757da3c6101ce64
+  metadata.gz: 9c8960705254abe3b74d5e75c7972d07f4152f840c2de845f6555905bc1abb42
+  data.tar.gz: ae4d3e69e8b3ebccedc19d09005209e8b97232adcce67c1a9a78a9fbc05d80dc
 SHA512:
-  metadata.gz: 9b1f984f67dae9f129339d2b62f9fd7dbe7382e2be43b8111e3733ac286bd6d063239bb75b59b0bb5484ea88f43c5baa3429eafc78390a593f0f3668ff913d35
-  data.tar.gz: 3b2350315e8945edf5bc2ae9102d806c2df2de9a60f130b818bd937a67e3aa818e325a29bea8df00bfed11289e7a68959917ce0d9c4d391be263c1dabc189d20
+  metadata.gz: 0d7161eccce1b681d6bdb543ac5dcbdf1bd3506a51e755a16a39a4c2091e8d3e874c9e6122004cb799ff2eab1fac95d8224572870771a0696c7904d90a040be3
+  data.tar.gz: 15f1b8cbd87bfeadbea25e781f4ecd8d5301a1ed036fce8a94bada86bb4dac0b376b655b18c77f00eaeec1c47499f05d7726e0a1caff0002135aca100e16e43b

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+Welcome to the Changelog! Below is the first attempt at a log for this project.  
+
+
+## v0.2.0
+#### Date: 09/10/2019
+
+#### Breaking Changes:
+- N/A
+
+#### Non-breaking Changes:
+- :white_check_mark: `wax_iiif` can now run its `build` process in parallel. (Credit: [@KitaitiMakoto](https://github.com/KitaitiMakoto))
+- :white_check_mark: `progress_bar` on `builder.process_data` shows up faster.
+
+#### Dependency Changes:
+- \+ `gem 'parallel'`

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rubocop', '0.59.0', require: false
+gem 'rubocop', require: false
 gem 'yard', require: false

data/README.md

@@ -1,8 +1,52 @@
 # wax_iiif
-[![Gem Version](https://badge.fury.io/rb/wax_iiif.svg)](https://badge.fury.io/rb/wax_iiif) [![Build Status](https://travis-ci.org/minicomp/wax_iiif.svg?branch=master)](https://travis-ci.org/minicomp/wax_iiif) [![Maintainability](https://api.codeclimate.com/v1/badges/a7d79a1b819cef81eb11/maintainability)](https://codeclimate.com/github/minicomp/wax_iiif/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a7d79a1b819cef81eb11/test_coverage)](https://codeclimate.com/github/minicomp/wax_iiif/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/wax_iiif.svg)](https://badge.fury.io/rb/wax_iiif) [![Build Status](https://travis-ci.org/minicomp/wax_iiif.svg?branch=master)](https://travis-ci.org/minicomp/wax_iiif) [![Maintainability](https://api.codeclimate.com/v1/badges/a7d79a1b819cef81eb11/maintainability)](https://codeclimate.com/github/minicomp/wax_iiif/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/a7d79a1b819cef81eb11/test_coverage)](https://codeclimate.com/github/minicomp/wax_iiif/test_coverage) [![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/minicomp/wax_iiif)](https://libraries.io/github/minicomp/wax_iiif)
 
 ![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/)  
 
 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://github.com/minicomp/wax/) via [Wax_Tasks](https://github.com/minicomp/wax_tasks/).
 
+## Installation
+
+This library assumes that you have ImageMagick installed. If you need to install it, follow the instructions:
+
+on OSX, `brew install imagemagick ` should be sufficient.
+
+If you have issues with TIFF files, try
+
+```shell
+
+brew update
+brew reinstall --with-libtiff --ignore-dependencies imagemagick
+
+```
+
+If you plan to work with PDFs, you should also have a copy of GhostScript installed.
+
+on OSX, `brew install gs`
+
+
+
+Add this line to your application's Gemfile:
+
+    gem 'wax_iiif'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wax_iiif
+
+## Usage
+
 Documentation for using `wax_iiif` without `wax_tasks` is forthcoming. In the meantime, check out [rubydoc](https://www.rubydoc.info/gems/wax_iiif).
+
+
+## Contributing
+
+1. Fork it ( https://github.com/minicomp/wax_iiif/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/wax_iiif.rb

@@ -1,5 +1,6 @@
 require 'csv'
 require 'json'
+require 'rainbow'
 
 require_relative 'wax_iiif/errors'
 require_relative 'wax_iiif/base_properties'

data/lib/wax_iiif/builder.rb

@@ -2,6 +2,7 @@ require_relative 'utilities'
 
 require 'pathname'
 require 'progress_bar'
+require 'parallel'
 
 module WaxIiif
   # Builder class
@@ -60,20 +61,26 @@ module WaxIiif
     #
     # Take the loaded data and generate all the files.
     #
+    # @param [Integer] thread_count Thread count to use for processing images concurrently. Defaults to number of processors.
+    #
     # @return [Void]
     #
-    def process_data
+    def process_data(thread_count: Parallel.processor_count)
+      puts Rainbow("Running on #{thread_count} threads.").blue
+
       return nil if @data.nil? # do nothing without data.
 
       @manifests = []
 
       data = @data.group_by(&:manifest_id)
       bar = ProgressBar.new(data.length)
+      bar.write
 
       data.each do |key, value|
         manifest_id   = key
         image_records = value
-        resources     = process_image_records(image_records)
+        resources     = process_image_records(image_records,
+                                              thread_count: thread_count)
 
         # Generate the manifest
         if manifest_id.to_s.empty?
@@ -128,13 +135,7 @@ module WaxIiif
       # 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
+      @data = vals.collect { |d| { 'image_path' => d[0], 'id' => d[1], 'label' => d[2] } }
     end
 
     protected
@@ -239,11 +240,12 @@ module WaxIiif
       obj
     end
 
-    def process_image_records(image_records)
+    def process_image_records(image_records,
+                              thread_count: Parallel.processor_count)
       resources = {}
 
       # genrate the images
-      image_records.each do |image_record|
+      Parallel.each(image_records, in_threads: thread_count) 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)

data/lib/wax_iiif/collection.rb

@@ -36,7 +36,7 @@ module WaxIiif
     #
     # @return [String] The JSON representation as a string
     #
-    def to_json
+    def to_json(*_args)
       obj = base_properties
       obj['collections'] = collect_object(collections) unless collections.empty?
       obj['manifests'] = collect_object(manifests) unless manifests.empty?

data/lib/wax_iiif/image_info.rb

@@ -48,7 +48,7 @@ module WaxIiif
     #
     # @return [String] the JSON representation of this image
     #
-    def to_json
+    def to_json(*_args)
       obj = {
         '@context' => context,
         '@id' => id,

data/lib/wax_iiif/manifest.rb

@@ -48,7 +48,7 @@ module WaxIiif
     #
     # @return [String]  the JSON-LD representation of the manifest as a string.
     #
-    def to_json
+    def to_json(*_args)
       obj = base_properties
 
       obj['thumbnail']        = @primary.variants['thumbnail'].uri
@@ -106,10 +106,9 @@ module WaxIiif
     #--------------------------------------------------------------------------
     def build_canvas(data)
       canvas_id = generate_id "canvas/#{data.id}"
-
       obj = {
         '@type' => CANVAS_TYPE,
-        '@id'   => canvas_id,
+        '@id' => canvas_id,
         'label' => data.section_label,
         'width' => data.variants['full'].width.floor,
         'height' => data.variants['full'].height.floor,
@@ -130,7 +129,7 @@ module WaxIiif
       annotation_id = generate_id "annotation/#{data.id}"
       {
         '@type' => ANNOTATION_TYPE,
-        '@id'   => annotation_id,
+        '@id' => annotation_id,
         'motivation' => MOTIVATION,
         'resource' => {
           '@id' => data.variants['full'].uri,

data/spec/wax_iiif/builder_spec.rb

@@ -45,7 +45,7 @@ describe WaxIiif::Builder do
     include_context('fake data')
 
     before(:example) do
-      @iiif = WaxIiif::Builder.new({base_url: 'http://0.0.0.0', verbose: true, thumbnail_size: 120})
+      @iiif = WaxIiif::Builder.new({base_url: 'http://0.0.0.0', verbose: false, thumbnail_size: 120})
       @iiif.load(@fake_data)
       allow(@iiif).to receive(:generate_tiles) {nil}
       allow(@iiif).to receive(:generate_variants) {@fake_variants}
@@ -73,7 +73,7 @@ describe WaxIiif::Builder do
 
     before(:example) do
       @dir = Dir.mktmpdir
-      @iiif = WaxIiif::Builder.new({output_dir: @dir, base_url: 'http://0.0.0.0', verbose: true, thumbnail_size: 120})
+      @iiif = WaxIiif::Builder.new({output_dir: @dir, base_url: 'http://0.0.0.0', verbose: false, thumbnail_size: 120})
       @iiif.load(@fake_data)
       @info_json = "#{@dir}/images/1/info.json"
       allow(@iiif).to receive(:generate_tiles) {nil}

data/spec/wax_iiif/image_variant_spec.rb

@@ -34,18 +34,18 @@ describe WaxIiif::ImageVariant do
       @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
+    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
@@ -58,9 +58,9 @@ describe WaxIiif::ImageVariant do
        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
+    it 'has the default filestring' do
+      expect(@img.uri).to include 'full/full'
+    end
 
   end
 end

data/wax_iiif.gemspec

@@ -3,25 +3,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'wax_iiif'
-  spec.version       = '0.1.2'
+  spec.version       = '0.2.0'
   spec.authors       = ['Marii Nyrop', 'David Newbury']
-  spec.email         = ['m.nyrop@columbia.edu']
+  spec.email         = ['marii@nyu.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.required_ruby_version  = '>= 2.4'
+  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.metadata['yard.run'] = 'yri'
-
-  spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'dotenv', '~> 2.7'
   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.9'
+  spec.add_runtime_dependency 'parallel', '~> 1.17'
   spec.add_runtime_dependency 'progress_bar', '~> 1.3'
+  spec.add_runtime_dependency 'rainbow', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wax_iiif
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Marii Nyrop
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +59,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '4.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '4.9'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: progress_bar
   requirement: !ruby/object:Gem::Requirement
@@ -81,9 +95,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Minimal IIIF level 0 generator for use with minicomp/wax
 email:
-- m.nyrop@columbia.edu
+- marii@nyu.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -92,6 +120,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -132,8 +161,7 @@ files:
 homepage: https://github.com/minicomp/wax_iiif
 licenses:
 - MIT
-metadata:
-  yard.run: yri
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -142,15 +170,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Minimal IIIF level 0 generator