ortfodb 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f25b4793b5193e4ad8009bd31b30932bd64e3495b0e04a81f85ef4c164e27e3
-  data.tar.gz: 4d91389ec40ec4840f93c4ffbf45475bad4ea3fd29660f788312bc42154b3821
+  metadata.gz: dfdb5e23f5915036479e7ddb21929c3612369d72491679f435387dafe64e0332
+  data.tar.gz: 1bd20725c89cebcba8be97922d0ec994506efaa4d77dae3a11c1915b741ec903
 SHA512:
-  metadata.gz: 8d9025810554c0cbd45ada3bd97ed5559631fda3d19b0ca81efc4992e4f9006c3293362a6bb82c4c999baeb051238713c66041c77539babbc36c15bb86015a80
-  data.tar.gz: ea901b1e430836c366997b2729f003a3d463cae5535b671bdeab0b056a61e8bff8a8342c905b8aecdaafac515c63836da693f7be107326e2f15063287fb7bab3
+  metadata.gz: 5cdc18ef72d256b60d0485c0688d8fc6536eaa7a4722e6f909cff82c6e13fa6dd872cf266ec5f7182324f4a2f824b269fdf68ebc6887b1780bd3a912c081ce19
+  data.tar.gz: 7932d8d198277da4cecd808053f7b6c3405681309472a3c49ca3f1bc2fa8ab8626c67ce26faa0c9936049b8e646ea11fd793d13a65f7cc6832d868d4d8eee716

data/lib/ortfodb/configuration.rb

@@ -198,7 +198,6 @@ module Ortfodb
 
   # Configuration represents what the ortfodb.yaml configuration file describes.
   class Configuration < Dry::Struct
-    attribute :build_metadata_file, Types::String.optional
 
     # Exporter-specific configuration. Maps exporter names to their configuration.
     attribute :exporters, Types::Hash.meta(of: Types::Hash.meta(of: Types::Any)).optional
@@ -218,7 +217,6 @@ module Ortfodb
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        build_metadata_file:   d["build metadata file"],
         exporters:             Types::Hash.optional[d["exporters"]]&.map { |k, v| [k, Types::Hash[v].map { |k, v| [k, Types::Any[v]] }.to_h] }&.to_h,
         extract_colors:        d["extract colors"] ? ExtractColorsConfiguration.from_dynamic!(d["extract colors"]) : nil,
         make_gifs:             d["make gifs"] ? MakeGIFSConfiguration.from_dynamic!(d["make gifs"]) : nil,
@@ -237,7 +235,6 @@ module Ortfodb
 
     def to_dynamic
       {
-        "build metadata file"   => build_metadata_file,
         "exporters"             => exporters,
         "extract colors"        => extract_colors&.to_dynamic,
         "make gifs"             => make_gifs&.to_dynamic,

data/lib/ortfodb/database.rb

@@ -184,6 +184,11 @@ module Ortfodb
     # in seconds
     attribute :duration, Types::Double
 
+    # Hash of the media file, used for caching purposes. Could also serve as an integrity
+    # check.
+    # The value is the MD5 hash, base64-encoded.
+    attribute :content_block_hash, Types::String
+
     attribute :has_sound,       Types::Bool
     attribute :id,              Types::String
     attribute :index,           Types::Integer
@@ -214,6 +219,7 @@ module Ortfodb
         dimensions:          ImageDimensions.from_dynamic!(d.fetch("dimensions")),
         dist_source:         d.fetch("distSource"),
         duration:            d.fetch("duration"),
+        content_block_hash:  d.fetch("hash"),
         has_sound:           d.fetch("hasSound"),
         id:                  d.fetch("id"),
         index:               d.fetch("index"),
@@ -246,6 +252,7 @@ module Ortfodb
         "dimensions"        => dimensions.to_dynamic,
         "distSource"        => dist_source,
         "duration"          => duration,
+        "hash"              => content_block_hash,
         "hasSound"          => has_sound,
         "id"                => id,
         "index"             => index,
@@ -267,18 +274,20 @@ module Ortfodb
   end
 
   class LocalizedContent < Dry::Struct
-    attribute :blocks,    Types.Array(ContentBlock)
-    attribute :footnotes, Types::Hash.meta(of: Types::String)
-    attribute :layout,    Types.Array(Types.Array(Types::String))
-    attribute :title,     Types::String
+    attribute :abbreviations, Types::Hash.meta(of: Types::String)
+    attribute :blocks,        Types.Array(ContentBlock)
+    attribute :footnotes,     Types::Hash.meta(of: Types::String)
+    attribute :layout,        Types.Array(Types.Array(Types::String))
+    attribute :title,         Types::String
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        blocks:    d.fetch("blocks").map { |x| ContentBlock.from_dynamic!(x) },
-        footnotes: Types::Hash[d.fetch("footnotes")].map { |k, v| [k, Types::String[v]] }.to_h,
-        layout:    d.fetch("layout"),
-        title:     d.fetch("title"),
+        abbreviations: Types::Hash[d.fetch("abbreviations")].map { |k, v| [k, Types::String[v]] }.to_h,
+        blocks:        d.fetch("blocks").map { |x| ContentBlock.from_dynamic!(x) },
+        footnotes:     Types::Hash[d.fetch("footnotes")].map { |k, v| [k, Types::String[v]] }.to_h,
+        layout:        d.fetch("layout"),
+        title:         d.fetch("title"),
       )
     end
 
@@ -288,10 +297,11 @@ module Ortfodb
 
     def to_dynamic
       {
-        "blocks"    => blocks.map { |x| x.to_dynamic },
-        "footnotes" => footnotes,
-        "layout"    => layout,
-        "title"     => title,
+        "abbreviations" => abbreviations,
+        "blocks"        => blocks.map { |x| x.to_dynamic },
+        "footnotes"     => footnotes,
+        "layout"        => layout,
+        "title"         => title,
       }
     end
 
@@ -388,8 +398,8 @@ module Ortfodb
     end
   end
 
-  # AnalyzedWork represents a complete work, with analyzed mediae.
-  class AnalyzedWork < Dry::Struct
+  # Work represents a given work in the database.
+  class Work < Dry::Struct
     attribute :built_at,         Types::String
     attribute :content,          Types::Hash.meta(of: LocalizedContent)
     attribute :description_hash, Types::String
@@ -432,7 +442,7 @@ module Ortfodb
   module Ortfodb
     class Database
       def self.from_json!(json)
-        Types::Hash[JSON.parse(json, quirks_mode: true)].map { |k, v| [k, AnalyzedWork.from_dynamic!(v)] }.to_h
+        Types::Hash[JSON.parse(json, quirks_mode: true)].map { |k, v| [k, Work.from_dynamic!(v)] }.to_h
       end
     end
   end

data/lib/ortfodb/version.rb

@@ -1,3 +1,3 @@
 module Ortfodb
-	VERSION = "1.5.0"
+	VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ortfodb
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ewen Le Bihan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-20 00:00:00.000000000 Z
+date: 2024-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct