aperitiiif 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02f6e4b4232068a021694eadacda55cde5757f54811d297bf0e73982bb50d0c1
+  data.tar.gz: ec553c98daa97c74fd8a3a315a8ec68e316ed3d5450b6a83d00c8bd5d38c97c5
+SHA512:
+  metadata.gz: 5628ed423c165523a95ea40ca4a6a43b67ce791142f45c927b6858b1ae0bf7cb64ef33906589a07cae08d6f1e512cde751f940ec05db2316a2df2ad232634aad
+  data.tar.gz: 24b053c916baa29fde6dda1ca17b2d5a49356157217de7fe60271aad477b10792b65e12519a44ea5efb62ec84d8e9c9663bc8204d706e68d36db232c252ebc2a

data/.reek.yml

@@ -0,0 +1,10 @@
+---
+detectors:
+  TooManyStatements:
+    max_statements: 6
+  DuplicateMethodCall:
+    allow_calls:
+      - options
+      - match
+  UtilityFunction:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+  NewCops: disable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+  AllowedPatterns:
+    - 'raise'
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false # conflicts with reek expectations
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+
+group :test do
+  gem 'reek'
+  gem 'rspec'
+  gem 'rubocop', '~> 1.21'
+  gem 'simplecov', require: false
+end

data/README.md

@@ -0,0 +1,81 @@
+# aperitiiif-cli
+
+gem-packaged commands for processing aperitiiif batches 🥂
+
+[![rspec](https://github.com/nyu-dss/aperitiiif-cli/actions/workflows/rspec.yml/badge.svg)](https://github.com/nyu-dss/aperitiiif/actions/workflows/rspec.yml) [![reek](https://github.com/nyu-dss/aperitiiif-cli/actions/workflows/reek.yml/badge.svg)](https://github.com/nyu-dss/aperitiiif/actions/workflows/reek.yml) [![rubocop](https://github.com/nyu-dss/aperitiiif-cli/actions/workflows/rubocop.yml/badge.svg)](https://github.com/nyu-dss/aperitiiif/actions/workflows/rubocop.yml)  
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/c25005f1fd12e7a86122/maintainability)](https://codeclimate.com/github/nyu-dss/aperitiiif/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c25005f1fd12e7a86122/test_coverage)](https://codeclimate.com/github/nyu-dss/aperitiiif/test_coverage)
+
+## Overview
+
+<img alt="aperitiiif service diagram" src="https://nyu-dss.github.io/aperitiiif/media/aperitiiif.jpg" style="max-height:300px;width:auto" />
+
+> View as [PDF](https://nyu-dss.github.io/aperitiiif/media/aperitiiif.pdf).
+
+
+## Prerequisites
+- [Ruby Version Manager](https://rvm.io/rvm/install)
+- [Git](https://git-scm.com/downloads)
+- [Vips](https://www.libvips.org/install.html)
+
+## Installation
+
+### Recommended
+
+It is highly recommended that you use the [aperitiiif-batch-template](https://github.com/nyu-dss/aperitiiif-batch-template) repo to create your new batch project. This method will include all the necessary Ruby dependencies and project structure.
+
+### Manual
+
+Alternatively, you can add the gem to your project's Gemfile:
+
+``` ruby
+gem 'aperitiiif', github: 'nyu-dss/aperitiiif-cli'
+```
+
+Then install by running the command:
+
+``` sh
+bundle install
+```
+
+## Usage
+
+After your batch project is set up and you have installed the dependencies using Bundler, you will have access to the `aperitiiif` commands.
+
+1. Check available commands
+  ```sh
+  bundle exec aperitiiif --help
+  ```
+2. Check available batch commands
+  ```sh
+  bundle exec aperitiiif batch --help
+  ```
+  You will see something like:
+  ```sh
+  ➜ bundle exec aperitiiif batch --help
+    Commands:
+    aperitiiif batch build           # build batch resources
+    aperitiiif batch help [COMMAND]  # Describe subcommands or one specific subc...
+    aperitiiif batch lint            # lint the batch
+    aperitiiif batch reset           # reset the batch
+  ```
+
+## Development
+
+Contributions should:
+- Avoid code smells
+- Follow style guide
+- Update tests as needed
+- Update documentation as needed
+
+To ensure the above, this repo includes configuration for [reek](https://github.com/troessner/reek) and [rubocop](https://github.com/rubocop/rubocop) as well as [rspec](https://rspec.info/) tests. You can run them respectively with the following commands:
+
+```sh
+bundle exec reek
+```
+```sh
+bundle exec rubocop -A
+```
+```sh
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'reek/rake/task'
+require 'rspec/core/rake_task'
+
+begin
+  RSpec::Core::RakeTask.new :spec do |t|
+    t.fail_on_error = false
+  end
+
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+  end
+
+  task default: :spec
+end

data/bin/aperitiiif

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV['VIPS_WARNING'] = '1'
+
+require 'aperitiiif'
+
+Aperitiiif::CLI::Main.start

data/lib/aperitiiif/asset.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'iiif/presentation'
+require 'mimemagic'
+require 'vips'
+
+# to do
+module Aperitiiif
+  # to do
+  # has smell :reek:TooManyMethods
+  class Asset
+    attr_reader :parent_id
+
+    TARGET_EXT = '.jpg'
+
+    def initialize(parent_id, source, config)
+      @parent_id  = parent_id
+      @source     = source
+      @config     = config
+
+      validate_source
+      validate_config
+    end
+
+    def validate_source
+      raise Aperitiiif::Error, "Asset source #{@source} does not exist" unless File.file? @source
+      raise Aperitiiif::Error, "Asset source #{@source} is not a valid format" unless Utils.valid_source? @source
+    end
+
+    def validate_config
+      raise Aperitiiif::Error, "No value found for 'namespace'. Check your config?" if @config.namespace.empty?
+      raise Aperitiiif::Error, "No value found for 'image_build_dir'. Check your config?" if @config.image_build_dir.empty?
+      raise Aperitiiif::Error, "No value found for 'presentation_api_url'. Check your config?" if @config.presentation_api_url.empty?
+      raise Aperitiiif::Error, "No value found for 'image_api_url'. Check your config?" if @config.image_api_url.empty?
+    end
+
+    def id
+      @id ||= build_id
+    end
+
+    def target
+      @target ||= build_target
+    end
+
+    def width
+      @width ||= Vips::Image.new_from_file(@source).width
+    end
+
+    def height
+      @height ||= Vips::Image.new_from_file(@source).height
+    end
+
+    def target_mime
+      write_to_target
+      @target_mime ||= Utils.mime target
+    end
+
+    def source_mime
+      @source_mime ||= Utils.mime @source
+    end
+
+    def canvas_url
+      @canvas_url ||= "#{@config.presentation_api_url}/canvas/#{id}.json"
+    end
+
+    def thumbnail_url
+      @thumbnail_url ||= "#{@config.image_api_url}/#{id}/full/250,/0/default.jpg"
+    end
+
+    def annotation_url
+      @annotation_url ||= "#{@config.presentation_api_url}/annotation/#{id}.json"
+    end
+
+    def full_resource_url
+      @full_resource_url ||= "#{@config.image_api_url}/#{id}/full/full/0/default.jpg"
+    end
+
+    def service_url
+      @service_url ||= "#{@config.image_api_url}/#{id}"
+    end
+
+    def build_id
+      id = Utils.basename_no_ext @source
+      id.prepend "#{@parent_id}_" unless id == @parent_id
+      id.prepend "#{@config.namespace}_"
+    end
+
+    def target_written? = File.file? target
+
+    def build_target = "#{@config.image_build_dir}/#{id}#{TARGET_EXT}"
+
+    def write_to_target
+      return false if target_written?
+
+      FileUtils.mkdir_p @config.image_build_dir
+      Vips::Image.new_from_file(@source).write_to_file target
+    end
+
+    def service
+      {
+        '@context' => 'http://iiif.io/api/image/2/context.json',
+        '@id' => service_url
+      }
+    end
+
+    def annotation
+      opts = {
+        '@id' => annotation_url,
+        'on' => canvas_url,
+        'resource' => resource
+      }
+      IIIF::Presentation::Annotation.new opts
+    end
+
+    def resource
+      opts = {
+        '@id' => full_resource_url,
+        '@type' => 'dcterms:Image',
+        'service' => service,
+        'format' => target_mime
+      }
+      IIIF::Presentation::Resource.new opts
+    end
+
+    def canvas
+      opts = {
+        '@id' => canvas_url,
+        'label' => id,
+        'width' => width,
+        'height' => height,
+        'thumbnail' => thumbnail_url,
+        'images' => [annotation]
+      }
+      IIIF::Presentation::Canvas.new opts
+    end
+  end
+end

data/lib/aperitiiif/batch/assets.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  module Assets
+    def assets
+      @assets ||= map_to_assets
+    end
+
+    def child_assets(path)
+      return [path] if Utils.valid_source?(path)
+      return [] unless File.directory? path
+
+      Dir.glob("#{path}/*").select { |sub| Utils.valid_source? sub }
+    end
+
+    # has smell :reek:NestedIterators
+    def map_to_assets(mymap = asset_map)
+      mymap.flat_map { |id, vals| vals.map { |val| Asset.new id, val, config } }
+    end
+
+    def asset_map(dir = config.source_dir)
+      map = {}
+      Dir["#{dir}/*"].each do |path|
+        parent_id       = Utils.parent_id(path, dir)
+        children        = child_assets path
+        map[parent_id]  = children unless children.empty?
+      end
+      map
+    end
+  end
+end

data/lib/aperitiiif/batch/items.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'aperitiiif/item'
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  module Items
+    def items
+      @items ||= items_from_assets
+    end
+
+    def items=(items)
+      @items = items
+    end
+
+    def items_from_assets(assets = self.assets)
+      grouped = assets.group_by(&:parent_id)
+      grouped.flat_map do |id, grouped_assets|
+        Item.new id, grouped_assets, config
+      end
+    end
+  end
+end

data/lib/aperitiiif/batch/linters.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  module Linters
+    def linters
+      @linters ||= [
+        method(:warn_nil_record_items),
+        method(:warn_duplicate_record_ids),
+        method(:warn_duplicate_image_names),
+        method(:warn_missing_labels),
+        method(:warn_stray_files)
+      ]
+    end
+
+    def lint
+      puts 'Linting...'.colorize(:cyan)
+      puts 'Passed ✓'.colorize(:green) unless report_failures.any?
+    end
+
+    def report_failures
+      linters.map(&:call)
+    end
+
+    # has smell :reek:TooManyStatements
+    def warn_nil_record_items
+      nil_record_items = items.select { |item| item.record.blank? }
+      return false if nil_record_items.empty?
+
+      warn "Could not find record(s) for #{nil_record_items.length} items:".colorze(:orange)
+      nil_record_items.each { |item| puts Utils.rm_batch_namespace(item.id).colorize(:yellow) }
+      true
+    end
+
+    # has smell :reek:TooManyStatements
+    def warn_duplicate_record_ids
+      ids     = records.map(&:id)
+      dup_ids = ids.select { |id| ids.count(id) > 1 }.uniq
+      return false if dup_ids.empty?
+
+      warn "Found #{dup_ids.length} non-unique record id value(s):".colorze(:orange)
+      dup_ids.each { |id| puts id.colorize(:yellow) }
+      true
+    end
+
+    # has smell :reek:DuplicateMethodCall
+    # has smell :reek:TooManyStatements
+    # rubocop: disable Metrics/AbcSize
+    def warn_duplicate_image_names
+      files = Dir.glob("#{config.source_dir}/**/*").select { |file| File.file? file }
+      files.map! { |file| Utils.rm_ext file.sub(config.source_dir, '') }
+      duplicate_names = files.select { |file| files.count(file) > 1 }.uniq
+      return false if duplicate_names.empty?
+
+      warn "Found #{duplicate_names.length} duplicate image name(s):".colorze(:orange)
+      duplicate_names.each { |name| puts Utils.prune_prefix_junk(name).colorize(:yellow) }
+      true
+    end
+    # rubocop: enable Metrics/AbcSize
+
+    # has smell :reek:TooManyStatements
+    def warn_missing_labels
+      no_label_records = records.select { |record| record.label.to_s.empty? }
+      return false if no_label_records.empty?
+
+      warn "Found #{no_label_records.length} record(s) missing labels (strongly encouraged):".colorze(:orange)
+      no_label_records.each { |record| puts record.id.colorize(:yellow) }
+      true
+    end
+
+    # has smell :reek:TooManyStatements
+    # rubocop:disable Metrics/AbcSize
+    def warn_stray_files
+      stray_files = Dir.glob("#{config.source_dir}/**/*")
+      stray_files.select! { |file| File.file?(file) && !file.end_with?(*ALLOWED_SRC_FORMATS) }
+      return false if stray_files.empty?
+
+      warn "Found #{stray_files.length} stray file(s) with unaccepted file types:".colorze(:orange)
+      stray_files.each { |file| puts file.colorize(:yellow) }
+      puts "(Accepted file extensions: #{ALLOWED_SRC_FORMATS.join(', ')})".colorize(:pink)
+      true
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end

data/lib/aperitiiif/batch/records.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  module Records
+    def records
+      @records ||= records_from_file
+    end
+
+    def find_record(item_id, records = self.records)
+      records.find { |record| record.id == item_id }
+    end
+
+    # has smell :reek:DuplicateMethodCall
+    def records_from_file(file = config.records_file, defaults = config.records_defaults)
+      return [] unless records_file_configured? file
+      return [] unless records_file_exists? file
+
+      Utils.csv_records file, defaults
+    end
+
+    def records_file_configured?(file = config.records_file)
+      return true if file.present?
+
+      warn 'WARNING:: No records file configured'.colorize(:yellow)
+      false
+    end
+
+    def records_file_exists?(file = config.records_file)
+      return true if File.file?(file)
+
+      warn "WARNING:: Couldn't find records file #{file}".colorize(:yellow)
+      false
+    end
+
+    def load_records!
+      self.items = items.map do |item|
+        record = find_record(item.id, records)
+        item.record = record if record.present?
+        item
+      end
+    end
+  end
+end

data/lib/aperitiiif/batch.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'parallel'
+require 'ruby-progressbar'
+require 'safe_yaml'
+
+require 'aperitiiif/batch/assets'
+require 'aperitiiif/batch/items'
+require 'aperitiiif/batch/records'
+require 'aperitiiif/batch/linters'
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  class Batch
+    include Assets
+    include Items
+    include Linters
+    include Records
+
+    def initialize; end
+
+    DEFAULT_CONFIG_FILE = './config.yml'
+
+    def config
+      @config ||= load_config_file
+    end
+
+    def load_config_file(file = DEFAULT_CONFIG_FILE)
+      @config = Config.new SafeYAML.load_file file
+    rescue StandardError
+      raise Aperitiiif::Error, "Cannot find file #{file}" unless File.file?(file)
+
+      raise Aperitiiif::Error, "Cannot read file #{file}. Is it valid yaml?"
+    end
+
+    def load_config_hash(hash)
+      @config = Config.new hash
+    end
+
+    def reset(dir = config.build_dir)
+      puts 'Resetting build...'.colorize(:cyan)
+      FileUtils.rm_rf dir
+      puts 'Done ✓'.colorize(:green)
+    end
+
+    def write_target_assets(assets = self.assets)
+      msg = 'Writing target image TIFs'.colorize(:cyan)
+      Parallel.map(assets, in_threads: 4, progress: { format: "#{msg}: %c/%u | %P%" }, &:write_to_target)
+    end
+
+    # has smell :reek:TooManyStatements
+    def write_presentation_json(items = self.items)
+      msg = 'Writing IIIF Presentation JSON'.colorize(:cyan)
+      load_records!
+      Parallel.map(items, in_threads: 4, progress: { format: "#{msg}: %c/%u | %P%" }, &:write_presentation_json)
+      write_iiif_collection_json
+    end
+
+    def seed
+      {
+        '@id' => iiif_collection_url,
+        'label' => config.label,
+        'description' => config.batch_description,
+        'attribution' => config.batch_attribution
+      }.delete_if { |_key, val| val.blank? }
+    end
+
+    def iiif_collection
+      collection = IIIF::Presentation::Collection.new seed
+      collection.manifests = items.map(&:manifest)
+      collection
+    end
+
+    def iiif_collection_file      = "#{config.presentation_build_dir}/#{config.namespace}/collection.json"
+    def iiif_collection_url       = "#{config.presentation_api_url}/#{config.namespace}/collection.json"
+    def iiif_collection_written?  = File.file? iiif_collection_file
+
+    def write_iiif_collection_json
+      Aperitiiif::Utils.mkfile_p iiif_collection_file, iiif_collection.to_json(pretty: true)
+    end
+  end
+end

data/lib/aperitiiif/cli.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  module CLI
+    # TO DO COMMENT
+    class SubCommandBase < Thor
+      def self.banner(command, _namespace, _subcommand)
+        "#{basename} #{subcommand_prefix} #{command.usage}"
+      end
+
+      def self.subcommand_prefix
+        str = name.gsub(/.*::/, '')
+        str.gsub!(/^[A-Z]/) { |match| match[0].downcase }
+        str.gsub!(/[A-Z]/) { |match| "-#{match[0].downcase}" }
+        str
+      end
+    end
+
+    # TO DO COMMENT
+    class Batch < SubCommandBase
+      desc 'build', 'build batch resources'
+
+      option :config, type: :string, default: ''
+      option :lint,   type: :boolean
+      option :reset,  type: :boolean
+
+      # has smells :reek:FeatureEnvy, :reek:TooManyStatements
+      # rubocop:disable Metrics/AbcSize
+      def build
+        batch = Aperitiiif::Batch.new
+        batch.load_config_file(options[:config]) if options[:config].present?
+        batch.reset if options[:reset]
+        batch.lint  if options[:lint]
+
+        batch.write_target_assets
+        batch.write_presentation_json
+        index = Aperitiiif::Index.new batch
+        index.write type: :html
+        index.write type: :json
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      desc 'reset', 'reset the batch'
+      def reset
+        batch = Aperitiiif::Batch.new
+        batch.reset
+      end
+
+      desc 'lint', 'lint the batch'
+      def lint
+        batch = Aperitiiif::Batch.new
+        batch.lint
+      end
+    end
+
+    # TO DO COMMENT
+    class Main < Thor
+      map %w[--version -v] => :__print_version
+      desc '--version, -v', 'print the version'
+      def __print_version
+        puts Aperitiiif::VERSION
+      end
+
+      desc 'batch SUBCOMMANDS', 'batch subcommands'
+      subcommand 'batch', Batch
+    end
+  end
+end

data/lib/aperitiiif/config.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# TO DO COMMENT
+module Aperitiiif
+  # has smell :reek:Attribute
+  # TO DO COMMENT
+  class Config
+    attr_reader :namespace, :hash
+
+    DELEGATE       = %i[puts p].freeze
+    DEFAULT_VALUES = {
+      'build_dir' => './build',
+      'source_dir' => './src/data',
+      'service_namespace' => 'aperitiiif-batch'
+    }.freeze
+
+    def initialize(seed = {})
+      @hash       = DEFAULT_VALUES.merge(seed)
+      @namespace  = batch_namespace
+
+      validate
+    end
+
+    def method_missing(method, *args, &block)
+      return super if DELEGATE.include? method
+
+      @hash.fetch method.to_s, ''
+    end
+
+    def respond_to_missing?(method, _args)
+      DELEGATE.include?(method) or super
+    end
+
+    # should check for more reqs
+    def validate
+      raise Aperitiiif::Error, "Config is missing a valid 'namespace' for the batch." if namespace.empty?
+      raise Aperitiiif::Error, "Config is missing 'label' for the batch." if label.empty?
+    end
+
+    def batch_namespace(dir = nil)
+      dir ||= FileUtils.pwd
+      name = dir.split(service_namespace).last
+      Utils.slugify name
+    end
+
+    def presentation_build_dir  = "#{build_dir}/presentation"
+    def image_build_dir         = "#{build_dir}/image"
+    def html_build_dir          = "#{build_dir}/html"
+    def records_file            = @hash.dig('records', 'file') || ''
+    def records_defaults        = @hash.dig('records', 'defaults') || {}
+  end
+end

data/lib/aperitiiif/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  class Error < RuntimeError
+    def initialize(msg = '')
+      puts msg.colorize(:magenta) and super('')
+    end
+  end
+end

data/lib/aperitiiif/index.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'liquid'
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  class Index
+    VALID_TYPES      = %i[json html].freeze
+    TEMPLATE_FILE    = "#{__dir__}/template/index.html".freeze
+
+    attr_reader :config, :items
+
+    def initialize(batch)
+      @batch  = batch
+      @config = batch.config
+      @items  = batch.items
+    end
+
+    def path(type)
+      "#{@config.html_build_dir}/index.#{type}"
+    end
+
+    # rubocop: disable Metrics/AbcSize
+    # has smell :reek:TooManyStatements
+    def write(**options)
+      raise Aperitiiif::Error, "Index#write is missing required 'type:' option" unless options.key? :type
+      raise Aperitiiif::Error, "Index#write 'type: #{options[:type]}' does not match available types #{VALID_TYPES}" unless VALID_TYPES.include? options[:type]
+
+      print "Writing #{options[:type]} index...".colorize(:cyan)
+
+      index = options[:type] == :html ? to_html : to_json
+      path  = options&.[](:path) || path(options[:type])
+
+      Aperitiiif::Utils.mkfile_p path, index
+
+      puts "\r#{"Writing #{options[:type]} index:".colorize(:cyan)} #{'Done ✓'.colorize(:green)}    "
+    end
+    # rubocop: enable Metrics/AbcSize
+
+    def to_json(items = self.items)
+      JSON.pretty_generate items.map(&:to_hash)
+    end
+
+    # has smell :reek:DuplicateMethodCall
+    def to_html(items = self.items, config = self.config)
+      vars = {
+        'items' => items.map(&:to_hash),
+        'config' => config.hash,
+        'iiif_collection_url' => @batch.iiif_collection_url,
+        'formatted_date' => Aperitiiif::Utils.formatted_datetime
+      }
+      template = Liquid::Template.parse File.open(TEMPLATE_FILE).read
+      template.render vars
+    end
+  end
+end

data/lib/aperitiiif/item.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'iiif/presentation'
+require 'ostruct'
+
+# to do
+module Aperitiiif
+  # to do
+  # has smell :reek:InstanceVariableAssumption
+  # has smell :reek:TooManyInstanceVariables
+  # has smell :reek:TooManyMethods
+  class Item
+    # has smell  :reek:Attribute
+    attr_writer :record
+    attr_reader :id, :assets
+
+    def initialize(id, assets, config)
+      @id       = id
+      @config   = config
+      @assets   = assets
+
+      validate_config
+    end
+
+    def validate_config
+      raise Aperitiiif::Error, "No value found for 'namespace'. Check your config?" if @config.namespace.empty?
+      raise Aperitiiif::Error, "No value found for 'presentation_api_url'. Check your config?" if @config.presentation_api_url.empty?
+      raise Aperitiiif::Error, "No value found for 'presentation_build_dir'. Check your config?" if @config.presentation_build_dir.empty?
+    end
+
+    def record
+      @record || default_record
+    end
+
+    def default_record
+      Record.new({ 'id' => id }, @config.records_defaults)
+    end
+
+    def manifest
+      @manifest ||= build_manifest
+    end
+
+    def label
+      record.label
+    end
+
+    def manifest_url
+      "#{@config.presentation_api_url}/#{@config.namespace}/#{@id}/manifest.json"
+    end
+
+    def thumbnail_url
+      return '' if assets.empty?
+
+      assets.first.thumbnail_url
+    end
+
+    def viewpoint_url
+      "https://dss.hosting.nyu.edu/viewpoint/mirador/#manifests[]=#{CGI.escape manifest_url}&theme=dark"
+    end
+
+    # has smell :reek: TooManyStatements
+    def seed
+      {
+        '@id' => manifest_url,
+        'label' => label,
+        'logo' => record.logo,
+        'description' => record.description,
+        'source' => record.source,
+        'metadata' => record.custom_metadata
+      }.delete_if { |_key, val| val.blank? }
+    end
+
+    def build_manifest
+      manifest = IIIF::Presentation::Manifest.new seed
+      sequence = IIIF::Presentation::Sequence.new
+      sequence.canvases = assets.map(&:canvas)
+      manifest.sequences << sequence
+      manifest
+    end
+
+    def manifest_file
+      "#{@config.presentation_build_dir}/#{@config.namespace}/#{id}/manifest.json"
+    end
+
+    def manifest_written?
+      File.file? manifest_file
+    end
+
+    def write_presentation_json
+      Aperitiiif::Utils.mkfile_p manifest_file, manifest.to_json(pretty: true)
+    end
+
+    def to_hash
+      {
+        'id' => id,
+        'label' => label,
+        'manifest_url' => manifest_url,
+        'thumbnail_url' => thumbnail_url,
+        'viewpoint_url' => viewpoint_url
+      }
+    end
+  end
+end

data/lib/aperitiiif/record.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+# to do
+module Aperitiiif
+  # to do
+  class Record
+    DELEGATE                = %i[puts p].freeze
+    CUSTOM_METADATA_PREFIX  = 'meta.'
+
+    def initialize(hash, defaults = {})
+      @hash = defaults.merge(hash)
+      @id   = id
+    end
+
+    def method_missing(method, *args, &block)
+      return super if DELEGATE.include? method
+
+      @hash.fetch method.to_s
+    end
+
+    def respond_to_missing?(method, _args)
+      DELEGATE.include?(method) or super
+    end
+
+    def id
+      @hash.fetch 'id'
+    rescue KeyError
+      raise Aperitiiif::Error, "Record has no 'id'\n#{@hash.inspect}"
+    end
+
+    def label       = @hash.fetch 'label', id
+    def logo        = @hash.fetch 'logo', ''
+    def description = @hash.fetch 'description', ''
+    def source      = @hash.fetch 'source', ''
+
+    def custom_metadata_keys
+      @hash.to_h.keys.select { |key| key.to_s.start_with?(CUSTOM_METADATA_PREFIX) } || []
+    end
+
+    def custom_metadata
+      custom_metadata_keys.map do |key|
+        {
+          'label' => key.to_s.delete_prefix(CUSTOM_METADATA_PREFIX),
+          'value' => @hash[key]
+        }
+      end
+    end
+  end
+end

data/lib/aperitiiif/template/index.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html lang='en'>
+  <head>
+    <meta charset='UTF-8'>
+    <meta http-equiv='X-UA-Compatible' content='ie=edge'>
+    <meta name='viewport' content='width=device-width, initial-scale=1.0'>
+    <title>{{ config.label }} | aperitiiif batch listing</title>
+    <link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css'>
+    <link rel='stylesheet' href='https://cdn.datatables.net/1.12.1/css/jquery.dataTables.min.css'>
+  </head>
+  <body>
+    <section class='hero is-info'>
+      <div class='hero-body'>
+        <div class='container'>
+          <h1 class='title'>{{ config.label }}</h1>
+          <p class='subtitle'>Aperitiiif Batch Index</p>
+          <p class='is-5 is-grey'>Last updated {{ formatted_date }}</p>
+          <p class='tags mt-5'>
+            <a target='_blank' class='tag is-danger is-light' href='{{ iiif_collection_url }}'>iiif collection</a>
+            <a target='_blank' class='tag is-link is-light' href='index.json'>index.json</a>
+          </p>
+        </div>
+      </div>
+    </section>
+    <section class='section'>
+      <div class='container'>
+        <h2 class='is-size-4 mb-3'>Items ({{ items.size }})</h2>
+        <div class='table-container'>
+          <table id='table' class='table display is-hoverable is-striped is-bordered'>
+            <thead>
+              <tr>
+                <td>item id</td>
+                <td>label</td>
+                <td>thumbnnail</td>
+                <td>iiif manifest</td>
+                <td>view in viewpoint</td>
+              </tr>
+            </thead>
+            <tbody>
+              {% for item in items %}
+              <tr>
+                <td><b>{{ item.id }}</b></td>
+                <td>{{ item.label }}</td>
+                <td><a target='_blank' href='{{ item.thumbnail_url }}'><img style="height:100px;width:auto" class='lazy' data-original="{{ item.thumbnail_url }}"/></a></td>
+                <td><a target='_blank' href='{{ item.manifest_url }}'><img alt='Thumbnail {{ item.label }}' src='https://upload.wikimedia.org/wikipedia/commons/e/e8/International_Image_Interoperability_Framework_logo.png' style="width:25px"/></a></td>
+                <td><a target='_blank' class='is-size-7' href='{{ item.viewpoint_url }}'>{{ item.viewpoint_url }}</a></td>
+              </tr>
+              {% endfor %}
+            </tbody>
+          </table>
+        </table>
+      </div>
+    </section>
+    <script src='https://code.jquery.com/jquery-3.5.1.js'></script>
+    <script src='https://cdnjs.cloudflare.com/ajax/libs/jquery.lazyload/1.9.1/jquery.lazyload.min.js'></script>
+    <script src='https://cdn.datatables.net/1.12.1/js/jquery.dataTables.min.js'></script>
+    <script>
+      $(document).ready(function () {
+        $('#table').DataTable( {
+          drawCallback: function(){
+            $('img.lazy').lazyload();
+          }
+        });
+      });
+    </script>
+  </body>
+</html>

data/lib/aperitiiif/utils.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+# TO DO COMMENT
+module Aperitiiif
+  # TO DO COMMENT
+  module Utils
+    def self.basename_no_ext(str)   = rm_ext File.basename(str)
+    def self.rm_ext(str)            = str.sub File.extname(str), ''
+    def self.parent_id(str, dir)    = prune_prefix_junk(rm_ext(str.sub(dir, '')))
+    def self.parent_dir(str)        = File.dirname(str).split('/').last
+    def self.prune_prefix_junk(str) = str.sub(/^(_|\W+)/, '')
+    def self.mime(path) = MimeMagic.by_magic(File.open(path)).to_s
+    def self.valid_source?(path) = File.file?(path) && path.end_with?(*ALLOWED_SRC_FORMATS)
+
+    def self.slugify(str)
+      str.downcase!
+      str.strip!
+      str.gsub! ' ', '-'
+      str.gsub!(/[^\w-]/, '')
+      prune_prefix_junk str
+    end
+
+    def self.formatted_datetime(time = Time.now)
+      fmt_date  = "#{time.month}/#{time.day}/#{time.year}"
+      fmt_time  = "#{time.hour}:#{time.min.to_s.rjust(2, '0')}#{time.zone}"
+      "#{fmt_date} at #{fmt_time}"
+    end
+
+    def self.item_assets_from_path(path)
+      return [path] if Utils.valid_source?(path)
+      return [] unless File.directory? path
+
+      Dir.glob("#{path}/*").select { |sub| Utils.valid_source? sub }
+    end
+
+    def self.csv_records(file, defaults = {})
+      hashes = CSV.read(file, headers: true).map(&:to_hash)
+      hashes.map { |hash| Record.new hash.compact, defaults }
+    end
+
+    def self.mkfile_p(path, contents)
+      FileUtils.mkdir_p File.dirname(path)
+      File.open(path, 'w') { |file| file.write contents }
+    end
+  end
+end

data/lib/aperitiiif/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Aperitiiif
+  VERSION = '0.1.0'
+end

data/lib/aperitiiif.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'colorize'
+require 'thor'
+
+require 'aperitiiif/asset'
+require 'aperitiiif/batch'
+require 'aperitiiif/cli'
+require 'aperitiiif/config'
+require 'aperitiiif/error'
+require 'aperitiiif/index'
+require 'aperitiiif/item'
+require 'aperitiiif/record'
+require 'aperitiiif/version'
+require 'aperitiiif/utils'
+
+# TO DO COMMENT
+module Aperitiiif
+  ALLOWED_SRC_FORMATS = %w[jpg jpeg png tif tiff].freeze
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: aperitiiif
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mnyrop
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: iiif-presentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- marii@nyu.edu
+executables:
+- aperitiiif
+extensions: []
+extra_rdoc_files: []
+files:
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/aperitiiif
+- lib/aperitiiif.rb
+- lib/aperitiiif/asset.rb
+- lib/aperitiiif/batch.rb
+- lib/aperitiiif/batch/assets.rb
+- lib/aperitiiif/batch/items.rb
+- lib/aperitiiif/batch/linters.rb
+- lib/aperitiiif/batch/records.rb
+- lib/aperitiiif/cli.rb
+- lib/aperitiiif/config.rb
+- lib/aperitiiif/error.rb
+- lib/aperitiiif/index.rb
+- lib/aperitiiif/item.rb
+- lib/aperitiiif/record.rb
+- lib/aperitiiif/template/index.html
+- lib/aperitiiif/utils.rb
+- lib/aperitiiif/version.rb
+homepage: https://github.com/nyu-dss/aperitiiif-cli
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nyu-dss/aperitiiif-cli
+  source_code_uri: https://github.com/nyu-dss/aperitiiif-cli
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []