ortfodb 1.4.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c03de3d328180d569b9a5b199e51527d337e8c7da107d6f4615272190f9ffe
-  data.tar.gz: 58414173953c5c279e36c987983522c3b0e7c4b9b602836987b37cf6b62895c7
+  metadata.gz: dfdb5e23f5915036479e7ddb21929c3612369d72491679f435387dafe64e0332
+  data.tar.gz: 1bd20725c89cebcba8be97922d0ec994506efaa4d77dae3a11c1915b741ec903
 SHA512:
-  metadata.gz: 225c011268f5fc27be85a6fbafb4bf2fc4893f33944676ebaf4cead5fc344effac33cafe3ca220fa419e7093e5398ca90bc3c37b435878a1e7cdb01fcde3c4fb
-  data.tar.gz: 1ab876a11eb09f2d4e2f9fb6035febec9819ce69e451758d3dc1e5a8af4789c1d183017d559d2bda5b6d8e9c6a1bb688637eeed9f24f4c50ab7abcb87b67f65c
+  metadata.gz: 5cdc18ef72d256b60d0485c0688d8fc6536eaa7a4722e6f909cff82c6e13fa6dd872cf266ec5f7182324f4a2f824b269fdf68ebc6887b1780bd3a912c081ce19
+  data.tar.gz: 7932d8d198277da4cecd808053f7b6c3405681309472a3c49ca3f1bc2fa8ab8626c67ce26faa0c9936049b8e646ea11fd793d13a65f7cc6832d868d4d8eee716

data/lib/ortfodb/configuration.rb

@@ -4,7 +4,7 @@
 # To parse this JSON, add 'dry-struct' and 'dry-types' gems, then do:
 #
 #   configuration = Configuration.from_json! "{…}"
-#   puts configuration.technologies.repository
+#   puts configuration.technologies&.repository
 #
 # If from_json! succeeds, the value returned matches the schema.
 
@@ -22,7 +22,7 @@ module Ortfodb
     String  = Strict::String
   end
 
-  class ExtractColors < Dry::Struct
+  class ExtractColorsConfiguration < Dry::Struct
     attribute :default_files, Types.Array(Types::String)
     attribute :enabled,       Types::Bool
     attribute :extract,       Types.Array(Types::String)
@@ -53,7 +53,7 @@ module Ortfodb
     end
   end
 
-  class MakeGifs < Dry::Struct
+  class MakeGIFSConfiguration < Dry::Struct
     attribute :enabled,            Types::Bool
     attribute :file_name_template, Types::String
 
@@ -81,7 +81,7 @@ module Ortfodb
     end
   end
 
-  class MakeThumbnails < Dry::Struct
+  class MakeThumbnailsConfiguration < Dry::Struct
     attribute :enabled,            Types::Bool
     attribute :file_name_template, Types::String
     attribute :input_file,         Types::String
@@ -115,7 +115,9 @@ module Ortfodb
     end
   end
 
-  class Media < Dry::Struct
+  class MediaConfiguration < Dry::Struct
+
+    # Path to the media directory.
     attribute :at, Types::String
 
     def self.from_dynamic!(d)
@@ -140,7 +142,9 @@ module Ortfodb
     end
   end
 
-  class Tags < Dry::Struct
+  class TagsConfiguration < Dry::Struct
+
+    # Path to file describing all tags.
     attribute :repository, Types::String
 
     def self.from_dynamic!(d)
@@ -165,7 +169,9 @@ module Ortfodb
     end
   end
 
-  class Technologies < Dry::Struct
+  class TechnologiesConfiguration < Dry::Struct
+
+    # Path to file describing all technologies.
     attribute :repository, Types::String
 
     def self.from_dynamic!(d)
@@ -192,36 +198,34 @@ module Ortfodb
 
   # Configuration represents what the ortfodb.yaml configuration file describes.
   class Configuration < Dry::Struct
-    attribute :build_metadata_file, Types::String
 
     # Exporter-specific configuration. Maps exporter names to their configuration.
     attribute :exporters, Types::Hash.meta(of: Types::Hash.meta(of: Types::Any)).optional
 
-    attribute :extract_colors,  ExtractColors
-    attribute :make_gifs,       MakeGifs
-    attribute :make_thumbnails, MakeThumbnails
-    attribute :media,           Media
+    attribute :extract_colors,  ExtractColorsConfiguration.optional
+    attribute :make_gifs,       MakeGIFSConfiguration.optional
+    attribute :make_thumbnails, MakeThumbnailsConfiguration.optional
+    attribute :media,           MediaConfiguration.optional
 
     # Path to the directory containing all projects. Must be absolute.
     attribute :projects_at, Types::String
 
     attribute :scattered_mode_folder, Types::String
-    attribute :tags,                  Tags
-    attribute :technologies,          Technologies
+    attribute :tags,                  TagsConfiguration.optional
+    attribute :technologies,          TechnologiesConfiguration.optional
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        build_metadata_file:   d.fetch("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:        ExtractColors.from_dynamic!(d.fetch("extract colors")),
-        make_gifs:             MakeGifs.from_dynamic!(d.fetch("make gifs")),
-        make_thumbnails:       MakeThumbnails.from_dynamic!(d.fetch("make thumbnails")),
-        media:                 Media.from_dynamic!(d.fetch("media")),
+        extract_colors:        d["extract colors"] ? ExtractColorsConfiguration.from_dynamic!(d["extract colors"]) : nil,
+        make_gifs:             d["make gifs"] ? MakeGIFSConfiguration.from_dynamic!(d["make gifs"]) : nil,
+        make_thumbnails:       d["make thumbnails"] ? MakeThumbnailsConfiguration.from_dynamic!(d["make thumbnails"]) : nil,
+        media:                 d["media"] ? MediaConfiguration.from_dynamic!(d["media"]) : nil,
         projects_at:           d.fetch("projects at"),
         scattered_mode_folder: d.fetch("scattered mode folder"),
-        tags:                  Tags.from_dynamic!(d.fetch("tags")),
-        technologies:          Technologies.from_dynamic!(d.fetch("technologies")),
+        tags:                  d["tags"] ? TagsConfiguration.from_dynamic!(d["tags"]) : nil,
+        technologies:          d["technologies"] ? TechnologiesConfiguration.from_dynamic!(d["technologies"]) : nil,
       )
     end
 
@@ -231,16 +235,15 @@ 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,
-        "make thumbnails"       => make_thumbnails.to_dynamic,
-        "media"                 => media.to_dynamic,
+        "extract colors"        => extract_colors&.to_dynamic,
+        "make gifs"             => make_gifs&.to_dynamic,
+        "make thumbnails"       => make_thumbnails&.to_dynamic,
+        "media"                 => media&.to_dynamic,
         "projects at"           => projects_at,
         "scattered mode folder" => scattered_mode_folder,
-        "tags"                  => tags.to_dynamic,
-        "technologies"          => technologies.to_dynamic,
+        "tags"                  => tags&.to_dynamic,
+        "technologies"          => technologies&.to_dynamic,
       }
     end
 

data/lib/ortfodb/database.rb

@@ -24,7 +24,7 @@ module Ortfodb
   end
 
   # MediaAttributes stores which HTML attributes should be added to the media.
-  class Attributes < Dry::Struct
+  class MediaAttributes < Dry::Struct
 
     # Controlled with attribute character > (adds)
     attribute :autoplay, Types::Bool
@@ -33,7 +33,7 @@ module Ortfodb
     attribute :controls, Types::Bool
 
     # Controlled with attribute character ~ (adds)
-    attribute :attributes_loop, Types::Bool
+    attribute :media_attributes_loop, Types::Bool
 
     # Controlled with attribute character > (adds)
     attribute :muted, Types::Bool
@@ -44,11 +44,11 @@ module Ortfodb
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        autoplay:        d.fetch("autoplay"),
-        controls:        d.fetch("controls"),
-        attributes_loop: d.fetch("loop"),
-        muted:           d.fetch("muted"),
-        playsinline:     d.fetch("playsinline"),
+        autoplay:              d.fetch("autoplay"),
+        controls:              d.fetch("controls"),
+        media_attributes_loop: d.fetch("loop"),
+        muted:                 d.fetch("muted"),
+        playsinline:           d.fetch("playsinline"),
       )
     end
 
@@ -60,7 +60,7 @@ module Ortfodb
       {
         "autoplay"    => autoplay,
         "controls"    => controls,
-        "loop"        => attributes_loop,
+        "loop"        => media_attributes_loop,
         "muted"       => muted,
         "playsinline" => playsinline,
       }
@@ -72,7 +72,7 @@ module Ortfodb
   end
 
   # ColorPalette reprensents the object in a Work's metadata.colors.
-  class Colors < Dry::Struct
+  class ColorPalette < Dry::Struct
     attribute :primary,   Types::String
     attribute :secondary, Types::String
     attribute :tertiary,  Types::String
@@ -104,7 +104,7 @@ module Ortfodb
   end
 
   # ImageDimensions represents metadata about a media as it's extracted from its file.
-  class Dimensions < Dry::Struct
+  class ImageDimensions < Dry::Struct
 
     # width / height
     attribute :aspect_ratio, Types::Double
@@ -141,7 +141,7 @@ module Ortfodb
     end
   end
 
-  class Thumbnails < Dry::Struct
+  class ThumbnailsMap < Dry::Struct
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
@@ -163,27 +163,32 @@ module Ortfodb
     end
   end
 
-  class BlockElement < Dry::Struct
+  class ContentBlock < Dry::Struct
     attribute :alt, Types::String
 
     # whether the media has been analyzed
     attribute :analyzed, Types::Bool
 
     attribute :anchor,     Types::String
-    attribute :attributes, Attributes
+    attribute :attributes, MediaAttributes
     attribute :caption,    Types::String
-    attribute :colors,     Colors
+    attribute :colors,     ColorPalette
 
     # html
     attribute :content, Types::String
 
     attribute :content_type, Types::String
-    attribute :dimensions,   Dimensions
+    attribute :dimensions,   ImageDimensions
     attribute :dist_source,  Types::String
 
     # 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
@@ -193,39 +198,40 @@ module Ortfodb
     # in bytes
     attribute :size, Types::Integer
 
-    attribute :text,                 Types::String
-    attribute :thumbnails,           Thumbnails
-    attribute :thumbnails_built_at,  Types::String
-    attribute :title,                Types::String
-    attribute :database_schema_type, Types::String
-    attribute :url,                  Types::String
+    attribute :text,                Types::String
+    attribute :thumbnails,          ThumbnailsMap
+    attribute :thumbnails_built_at, Types::String
+    attribute :title,               Types::String
+    attribute :content_block_type,  Types::String
+    attribute :url,                 Types::String
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        alt:                  d.fetch("alt"),
-        analyzed:             d.fetch("analyzed"),
-        anchor:               d.fetch("anchor"),
-        attributes:           Attributes.from_dynamic!(d.fetch("attributes")),
-        caption:              d.fetch("caption"),
-        colors:               Colors.from_dynamic!(d.fetch("colors")),
-        content:              d.fetch("content"),
-        content_type:         d.fetch("contentType"),
-        dimensions:           Dimensions.from_dynamic!(d.fetch("dimensions")),
-        dist_source:          d.fetch("distSource"),
-        duration:             d.fetch("duration"),
-        has_sound:            d.fetch("hasSound"),
-        id:                   d.fetch("id"),
-        index:                d.fetch("index"),
-        online:               d.fetch("online"),
-        relative_source:      d.fetch("relativeSource"),
-        size:                 d.fetch("size"),
-        text:                 d.fetch("text"),
-        thumbnails:           Thumbnails.from_dynamic!(d.fetch("thumbnails")),
-        thumbnails_built_at:  d.fetch("thumbnailsBuiltAt"),
-        title:                d.fetch("title"),
-        database_schema_type: d.fetch("type"),
-        url:                  d.fetch("url"),
+        alt:                 d.fetch("alt"),
+        analyzed:            d.fetch("analyzed"),
+        anchor:              d.fetch("anchor"),
+        attributes:          MediaAttributes.from_dynamic!(d.fetch("attributes")),
+        caption:             d.fetch("caption"),
+        colors:              ColorPalette.from_dynamic!(d.fetch("colors")),
+        content:             d.fetch("content"),
+        content_type:        d.fetch("contentType"),
+        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"),
+        online:              d.fetch("online"),
+        relative_source:     d.fetch("relativeSource"),
+        size:                d.fetch("size"),
+        text:                d.fetch("text"),
+        thumbnails:          ThumbnailsMap.from_dynamic!(d.fetch("thumbnails")),
+        thumbnails_built_at: d.fetch("thumbnailsBuiltAt"),
+        title:               d.fetch("title"),
+        content_block_type:  d.fetch("type"),
+        url:                 d.fetch("url"),
       )
     end
 
@@ -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,
@@ -256,7 +263,7 @@ module Ortfodb
         "thumbnails"        => thumbnails.to_dynamic,
         "thumbnailsBuiltAt" => thumbnails_built_at,
         "title"             => title,
-        "type"              => database_schema_type,
+        "type"              => content_block_type,
         "url"               => url,
       }
     end
@@ -266,19 +273,21 @@ module Ortfodb
     end
   end
 
-  class ContentValue < Dry::Struct
-    attribute :blocks,    Types.Array(BlockElement)
-    attribute :footnotes, Types::Hash.meta(of: Types::String)
-    attribute :layout,    Types.Array(Types.Array(Types::String))
-    attribute :title,     Types::String
+  class LocalizedContent < Dry::Struct
+    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| BlockElement.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
 
@@ -300,7 +310,7 @@ module Ortfodb
     end
   end
 
-  class DatabaseMetadataClass < Dry::Struct
+  class DatabaseMeta < Dry::Struct
 
     # Partial is true if the database was not fully built.
     attribute :partial, Types::Bool
@@ -327,11 +337,11 @@ module Ortfodb
     end
   end
 
-  class Metadata < Dry::Struct
+  class WorkMetadata < Dry::Struct
     attribute :additional_metadata, Types::Hash.meta(of: Types::Any)
     attribute :aliases,             Types.Array(Types::String)
-    attribute :colors,              Colors
-    attribute :database_metadata,   DatabaseMetadataClass
+    attribute :colors,              ColorPalette
+    attribute :database_metadata,   DatabaseMeta
     attribute :finished,            Types::String
     attribute :made_with,           Types.Array(Types::String)
     attribute :page_background,     Types::String
@@ -347,8 +357,8 @@ module Ortfodb
       new(
         additional_metadata: Types::Hash[d.fetch("additionalMetadata")].map { |k, v| [k, Types::Any[v]] }.to_h,
         aliases:             d.fetch("aliases"),
-        colors:              Colors.from_dynamic!(d.fetch("colors")),
-        database_metadata:   DatabaseMetadataClass.from_dynamic!(d.fetch("databaseMetadata")),
+        colors:              ColorPalette.from_dynamic!(d.fetch("colors")),
+        database_metadata:   DatabaseMeta.from_dynamic!(d.fetch("databaseMetadata")),
         finished:            d.fetch("finished"),
         made_with:           d.fetch("madeWith"),
         page_background:     d.fetch("pageBackground"),
@@ -388,23 +398,23 @@ module Ortfodb
     end
   end
 
-  # AnalyzedWork represents a complete work, with analyzed mediae.
-  class DatabaseValue < 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: ContentValue)
+    attribute :content,          Types::Hash.meta(of: LocalizedContent)
     attribute :description_hash, Types::String
     attribute :id,               Types::String
-    attribute :metadata,         Metadata
+    attribute :metadata,         WorkMetadata
     attribute :partial,          Types::Bool
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
         built_at:         d.fetch("builtAt"),
-        content:          Types::Hash[d.fetch("content")].map { |k, v| [k, ContentValue.from_dynamic!(v)] }.to_h,
+        content:          Types::Hash[d.fetch("content")].map { |k, v| [k, LocalizedContent.from_dynamic!(v)] }.to_h,
         description_hash: d.fetch("descriptionHash"),
         id:               d.fetch("id"),
-        metadata:         Metadata.from_dynamic!(d.fetch("metadata")),
+        metadata:         WorkMetadata.from_dynamic!(d.fetch("metadata")),
         partial:          d.fetch("Partial"),
       )
     end
@@ -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, DatabaseValue.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/exporter.rb

@@ -21,7 +21,7 @@ module Ortfodb
     String = Strict::String
   end
 
-  class ExporterSchema < Dry::Struct
+  class ExporterCommand < Dry::Struct
 
     # Log a message. The first argument is the verb, the second is the color, the third is the
     # message.
@@ -58,10 +58,10 @@ module Ortfodb
 
     # Commands to run after the build finishes. Go text template that receives .Data and
     # .Database, the built database.
-    attribute :after, Types.Array(ExporterSchema).optional
+    attribute :after, Types.Array(ExporterCommand).optional
 
     # Commands to run before the build starts. Go text template that receives .Data
-    attribute :before, Types.Array(ExporterSchema).optional
+    attribute :before, Types.Array(ExporterCommand).optional
 
     # Initial data
     attribute :data, Types::Hash.meta(of: Types::Any).optional
@@ -80,19 +80,19 @@ module Ortfodb
 
     # Commands to run during the build, for each work. Go text template that receives .Data and
     # .Work, the current work.
-    attribute :work, Types.Array(ExporterSchema).optional
+    attribute :work, Types.Array(ExporterCommand).optional
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        after:         d["after"]&.map { |x| ExporterSchema.from_dynamic!(x) },
-        before:        d["before"]&.map { |x| ExporterSchema.from_dynamic!(x) },
+        after:         d["after"]&.map { |x| ExporterCommand.from_dynamic!(x) },
+        before:        d["before"]&.map { |x| ExporterCommand.from_dynamic!(x) },
         data:          Types::Hash.optional[d["data"]]&.map { |k, v| [k, Types::Any[v]] }&.to_h,
         description:   d.fetch("description"),
         exporter_name: d.fetch("name"),
         requires:      d["requires"],
         verbose:       d["verbose"],
-        work:          d["work"]&.map { |x| ExporterSchema.from_dynamic!(x) },
+        work:          d["work"]&.map { |x| ExporterCommand.from_dynamic!(x) },
       )
     end
 

data/lib/ortfodb/tags.rb

@@ -4,7 +4,7 @@
 # To parse this JSON, add 'dry-struct' and 'dry-types' gems, then do:
 #
 #   tags = Tags.from_json! "[…]"
-#   puts tags.first.detect.search.first
+#   puts tags.first.detect&.search&.first
 #
 # If from_json! succeeds, the value returned matches the schema.
 
@@ -20,17 +20,18 @@ module Ortfodb
     String = Strict::String
   end
 
+  # Various ways to automatically detect that a work is tagged with this tag.
   class Detect < Dry::Struct
-    attribute :files,     Types.Array(Types::String)
-    attribute :made_with, Types.Array(Types::String)
-    attribute :search,    Types.Array(Types::String)
+    attribute :files,     Types.Array(Types::String).optional
+    attribute :made_with, Types.Array(Types::String).optional
+    attribute :search,    Types.Array(Types::String).optional
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        files:     d.fetch("files"),
-        made_with: d.fetch("made with"),
-        search:    d.fetch("search"),
+        files:     d["files"],
+        made_with: d["made with"],
+        search:    d["search"],
       )
     end
 
@@ -51,21 +52,34 @@ module Ortfodb
     end
   end
 
+  # Tag represents a category that can be assigned to a work.
   class Tag < Dry::Struct
-    attribute :aliases,       Types.Array(Types::String)
-    attribute :description,   Types::String
-    attribute :detect,        Detect
-    attribute :learn_more_at, Types::String
-    attribute :plural,        Types::String
-    attribute :singular,      Types::String
+
+    # Other singular-form names of tags that refer to this tag. The names mentionned here
+    # should not be used to define other tags.
+    attribute :aliases, Types.Array(Types::String).optional
+
+    attribute :description, Types::String.optional
+
+    # Various ways to automatically detect that a work is tagged with this tag.
+    attribute :detect, Detect.optional
+
+    # URL to a website where more information can be found about this tag.
+    attribute :learn_more_at, Types::String.optional
+
+    # Plural-form name of the tag. For example, "Books".
+    attribute :plural, Types::String
+
+    # Singular-form name of the tag. For example, "Book".
+    attribute :singular, Types::String
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        aliases:       d.fetch("aliases"),
-        description:   d.fetch("description"),
-        detect:        Detect.from_dynamic!(d.fetch("detect")),
-        learn_more_at: d.fetch("learn more at"),
+        aliases:       d["aliases"],
+        description:   d["description"],
+        detect:        d["detect"] ? Detect.from_dynamic!(d["detect"]) : nil,
+        learn_more_at: d["learn more at"],
         plural:        d.fetch("plural"),
         singular:      d.fetch("singular"),
       )
@@ -79,7 +93,7 @@ module Ortfodb
       {
         "aliases"       => aliases,
         "description"   => description,
-        "detect"        => detect.to_dynamic,
+        "detect"        => detect&.to_dynamic,
         "learn more at" => learn_more_at,
         "plural"        => plural,
         "singular"      => singular,

data/lib/ortfodb/technologies.rb

@@ -4,7 +4,7 @@
 # To parse this JSON, add 'dry-struct' and 'dry-types' gems, then do:
 #
 #   technologies = Technologies.from_json! "[…]"
-#   puts technologies.first.files.first
+#   puts technologies.first.files&.first
 #
 # If from_json! succeeds, the value returned matches the schema.
 
@@ -20,34 +20,48 @@ module Ortfodb
     String = Strict::String
   end
 
+  # Technology represents a "technology" (in the very broad sense) that was used to create a
+  # work.
   class Technology < Dry::Struct
-    attribute :aliases, Types.Array(Types::String)
+
+    # Other technology slugs that refer to this technology. The slugs mentionned here should
+    # not be used in the definition of other technologies.
+    attribute :aliases, Types.Array(Types::String).optional
 
     # Autodetect contains an expression of the form 'CONTENT in PATH' where CONTENT is a
     # free-form unquoted string and PATH is a filepath relative to the work folder.
     # If CONTENT is found in PATH, we consider that technology to be used in the work.
-    attribute :autodetect, Types.Array(Types::String)
+    attribute :autodetect, Types.Array(Types::String).optional
+
+    # Name of the person or organization that created this technology.
+    attribute :by, Types::String.optional
 
-    attribute :by,          Types::String
-    attribute :description, Types::String
+    attribute :description, Types::String.optional
 
     # Files contains a list of gitignore-style patterns. If the work contains any of the
     # patterns specified, we consider that technology to be used in the work.
-    attribute :files, Types.Array(Types::String)
+    attribute :files, Types.Array(Types::String).optional
+
+    # URL to a website where more information can be found about this technology.
+    attribute :learn_more_at, Types::String.optional
 
-    attribute :learn_more_at,   Types::String
     attribute :technology_name, Types::String
-    attribute :slug,            Types::String
+
+    # The slug is a unique identifier for this technology, that's suitable for use in a
+    # website's URL.
+    # For example, the page that shows all works using a technology with slug "a" could be at
+    # https://example.org/technologies/a.
+    attribute :slug, Types::String
 
     def self.from_dynamic!(d)
       d = Types::Hash[d]
       new(
-        aliases:         d.fetch("aliases"),
-        autodetect:      d.fetch("autodetect"),
-        by:              d.fetch("by"),
-        description:     d.fetch("description"),
-        files:           d.fetch("files"),
-        learn_more_at:   d.fetch("learn more at"),
+        aliases:         d["aliases"],
+        autodetect:      d["autodetect"],
+        by:              d["by"],
+        description:     d["description"],
+        files:           d["files"],
+        learn_more_at:   d["learn more at"],
         technology_name: d.fetch("name"),
         slug:            d.fetch("slug"),
       )

data/lib/ortfodb/version.rb

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

metadata

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