distorted 0.5.7 → 0.6.0

data/lib/distorted/molecule/image.rb

@@ -0,0 +1,36 @@
+
+require 'set'
+
+require 'distorted/checking_you_out'
+require 'distorted/modular_technology/vips'
+require 'distorted/injection_of_love'
+
+
+module Cooltrainer
+  module DistorteD
+    module Image
+
+
+      # Attributes for our <picture>/<img>.
+      # Automatically enabled as attrs for DD Liquid Tag.
+      # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture#Attributes
+      # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#Attributes
+      # https://developer.mozilla.org/en-US/docs/Web/Performance/Lazy_loading
+      ATTRIBUTES = Set[:alt, :caption, :href, :loading]
+
+      # Defaults for HTML Element attributes.
+      # Not every attr has to be listed here.
+      # Many need no default and just won't render.
+      ATTRIBUTES_DEFAULT = {
+        :loading => :eager,
+      }
+      ATTRIBUTES_VALUES = {
+        :loading => Set[:eager, :lazy],
+      }
+
+      include Cooltrainer::DistorteD::Technology::Vips
+      include Cooltrainer::DistorteD::InjectionOfLove
+
+    end  # Image
+  end  # DistorteD
+end  # Cooltrainer

data/lib/distorted/{pdf.rb → molecule/pdf.rb}

@@ -1,17 +1,20 @@
 require 'set'
 
 require 'hexapdf'
-require 'mime/types'
+
+require 'distorted/checking_you_out'
+require 'distorted/injection_of_love'
+require 'distorted/molecule/C18H27NO3'
 
 
 module Cooltrainer
   module DistorteD
-    class PDF
+    module PDF
+
 
-      MEDIA_TYPE = 'application'.freeze
-      SUB_TYPE = 'pdf'.freeze
+      include Cooltrainer::DistorteD::Molecule::C18H27NO3
 
-      MIME_TYPES = MIME::Types["#{MEDIA_TYPE}/#{SUB_TYPE}"].to_set
+      LOWER_WORLD = CHECKING::YOU::IN("application/pdf")
 
       # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/object#Attributes
       # https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/pdf_open_parameters.pdf
@@ -37,7 +40,7 @@ module Cooltrainer
         :highlight,
         :fdf,
       ]
-      ATTRS = Set[
+      ATTRIBUTES = Set[
         :alt,
         :caption,
         :height,  #<object> viewer container height.
@@ -50,9 +53,8 @@ module Cooltrainer
 
       FLOAT_INT_FRAGMENT = '[+-]?([0-9]+([.][0-9]*)?|[.][0-9]+)'.freeze
       ZERO_TO_ONE_HUNDRED = /^(([1-9]\d?|1\d{1})([.,]\d{0,1})?|100([.,]0{1})?)$/
-      BOOLEAN_SET = Set[0, 1, false, true, '0'.freeze, '1'.freeze, 'false'.freeze, 'true'.freeze]
 
-      ATTRS_DEFAULT = {
+      ATTRIBUTES_DEFAULT = {
         :height => '100%'.freeze,
         :width => '100%'.freeze,
         # BEGIN PDF Open Parameters
@@ -73,7 +75,7 @@ module Cooltrainer
       # …but then goes on to show some examples (like `comment`)
       # that are clearly longer than 32 characters.
       # Dunno. I'll err on the side of giving you a footgun.
-      ATTRS_VALUES = {
+      ATTRIBUTES_VALUES = {
         :nameddest => /^#{RESERVED_CHARACTERS_FRAGMENT}$/,
         :page => /\d/,
         :comment => /^#{RESERVED_CHARACTERS_FRAGMENT}$/,
@@ -82,15 +84,18 @@ module Cooltrainer
         :view => /^Fit(H|V|B|BH|BV(,#{FLOAT_INT_FRAGMENT})?)?$/,
         :viewrect => /^#{FLOAT_INT_FRAGMENT},#{FLOAT_INT_FRAGMENT},#{FLOAT_INT_FRAGMENT},#{FLOAT_INT_FRAGMENT}$/,
         :pagemode => Set[:none, :thumbs, :bookmarks],
-        :scrollbar => BOOLEAN_SET,
+        :scrollbar => BOOLEAN_ATTR_VALUES,
         :search => /^#{RESERVED_CHARACTERS_FRAGMENT}(,\s#{RESERVED_CHARACTERS_FRAGMENT})*$/,
-        :toolbar => BOOLEAN_SET,
-        :statusbar => BOOLEAN_SET,
-        :messages => BOOLEAN_SET,
-        :navpanes => BOOLEAN_SET,
+        :toolbar => BOOLEAN_ATTR_VALUES,
+        :statusbar => BOOLEAN_ATTR_VALUES,
+        :messages => BOOLEAN_ATTR_VALUES,
+        :navpanes => BOOLEAN_ATTR_VALUES,
         :fdf => /^#{RESERVED_CHARACTERS_FRAGMENT}$/,
       }
 
+      include Cooltrainer::DistorteD::InjectionOfLove
+
+      # TODO: Use MuPDF instead of libvips magick-based PDF loader.
 
       def self.optimize(src, dest)
         HexaPDF::Document.open(src) do |doc|
@@ -105,6 +110,10 @@ module Cooltrainer
         end
       end
 
+      def to_application_pdf(*a, **k, &b)
+        copy_file(*a, **k, &b)
+      end
+
     end  # PDF
   end  # DistorteD
 end  # Cooltrainer

data/lib/distorted/molecule/svg.rb

@@ -0,0 +1,60 @@
+require 'set'
+
+require 'svg_optimizer'
+
+require 'distorted/checking_you_out'
+require 'distorted/injection_of_love'
+require 'distorted/molecule/C18H27NO3'
+
+
+module Cooltrainer
+  module DistorteD
+    module SVG
+
+      SUB_TYPE = 'svg'.freeze
+      include Cooltrainer::DistorteD::Molecule::C18H27NO3
+
+      #WISHLIST: Support VML for old IE compatibility.
+      #  Example: RaphaëlJS — https://en.wikipedia.org/wiki/Rapha%C3%ABl_(JavaScript_library)
+      LOWER_WORLD = CHECKING::YOU::IN(/^image\/svg/)
+
+      ATTRIBUTES = Set[
+        :alt,
+        :caption,
+        :href,
+        :loading,
+        :optimize,
+      ]
+      ATTRIBUTES_VALUES = {
+        :optimize => BOOLEAN_ATTR_VALUES,
+      }
+      ATTRIBUTES_DEFAULT = {
+        :optimize => false,
+      }
+
+      include Cooltrainer::DistorteD::Technology::VipsSave
+      include Cooltrainer::DistorteD::InjectionOfLove
+
+      def to_vips_image
+        # TODO: Load-time options for various formats, like SVG's `unlimited`:
+        # "SVGs larger than 10MB are normally blocked for security. Set unlimited to allow SVGs of any size."
+        # https://libvips.github.io/libvips/API/current/VipsForeignSave.html#vips-svgload
+        @vips_image ||= Vips::Image.new_from_file(path)
+      end
+
+      def to_image_svg_xml(dest, *a, **k, &b)
+        if abstract(:optimize)
+          SvgOptimizer.optimize_file(path, dest, SvgOptimizer::DEFAULT_PLUGINS)
+        else
+          copy_file(dest, *a, **k, &b)
+        end
+      end
+
+      def self.optimize(src, dest)
+        # TODO: Make optimizations/plugins configurable
+        SvgOptimizer.optimize_file(src, dest, SvgOptimizer::DEFAULT_PLUGINS)
+      end
+
+    end
+  end
+end

data/lib/distorted/{text.rb → molecule/text.rb}

@@ -1,45 +1,24 @@
 require 'set'
 
-require 'ttfunk'  # Font metadata extraction
 require 'charlock_holmes'  # Text file charset detection
 
 require 'distorted/monkey_business/string'  # String#map
 require 'distorted/modular_technology/pango'
+require 'distorted/modular_technology/ttfunk'
+require 'distorted/modular_technology/vips_save'
 
-require 'distorted/image'
-
-require 'mime/types'
-
-# No need to do all the fancy library versioning in a subclass.
-require 'vips'
+require 'distorted/checking_you_out'
+require 'distorted/injection_of_love'
+require 'distorted/molecule/image'
 
 
 module Cooltrainer
   module DistorteD
-    class Text < Image
-
-      include Cooltrainer::DistorteD::Tech::Pango;
-
+    module Text
 
-      MEDIA_TYPE = 'text'.freeze
 
-      MIME_TYPES = MIME::Types[/^#{self::MEDIA_TYPE}\/(plain|x-nfo)/, :complete => true].to_set
-
-      ATTRS = Set[
-        :alt,
-        :crop,
-        :font,
-        :encoding,
-        :spacing,
-        :dpi,
-      ]
-      ATTRS_VALUES = {
-        :spacing => Set[:monospace, :proportional],
-      }
-      ATTRS_DEFAULT = {
-        :crop => :none,
-        :dpi => 144,
-      }
+      LOWER_WORLD = CHECKING::YOU::IN(/^text\/(plain|x-nfo)/)
+      OUTER_LIMITS = CHECKING::YOU::IN(/^text\/(plain|x-nfo)/)
 
       # Track supported fonts by codepage.
       # Avoid renaming these from the original archives / websites.
@@ -91,17 +70,45 @@ module Cooltrainer
         ],
       }
       # …as well as the inverse, the numeric codepage for each font:
-      FONT_CODEPAGE = CODEPAGE_FONT.reduce(Hash.new([])) { |memo, (key, values)|
+      FONT_CODEPAGE = self::CODEPAGE_FONT.reduce(Hash.new([])) { |memo, (key, values)|
         values.each { |value| memo[value] = key }
         memo
       }
 
+      self::OUTER_LIMITS.each { |t|
+        define_method(t.distorted_method) { |*a, **k, &b|
+          copy_file(*a, **k, &b)
+        }
+      }
+
+      ATTRIBUTES = Set[
+        :alt,
+        :crop,
+        :font,
+        :encoding,
+        :spacing,
+        :dpi,
+      ]
+      ATTRIBUTES_VALUES = {
+        :spacing => Set[:monospace, :proportional],
+        :font => self::FONT_FILENAME.keys.to_set,
+      }
+      ATTRIBUTES_DEFAULT = {
+        :crop => :none,
+        :dpi => 144,
+        :encoding => 'UTF-8'.freeze
+      }
+
+      include Cooltrainer::DistorteD::Technology::TTFunk
+      include Cooltrainer::DistorteD::Technology::Pango
+      include Cooltrainer::DistorteD::Technology::VipsSave
+      include Cooltrainer::DistorteD::InjectionOfLove
 
       # Using a numeric key for things for simplicity.
       # TODO: Replace this with Ruby's built-in Encoding class after I have
       # a better idea what I want to do.
       def codepage
-        case @encoding
+        case text_file_encoding
           when 'UTF-8'.freeze then 65001
           when 'Shift_JIS'.freeze then 932
           when 'IBM437'.freeze then 437
@@ -112,35 +119,48 @@ module Cooltrainer
       # Return a Pango Markup escaped version of the document.
       def to_pango
         # https://developer.gnome.org/glib/stable/glib-Simple-XML-Subset-Parser.html#g-markup-escape-text
-        escaped = @contents.map{ |c|
+        escaped = text_file_utf8_content.map{ |c|
           g_markup_escape_char(c)
         }
-        if spacing == :monospace
+        if font_spacing == :monospace
           "<tt>" << escaped << "</tt>"
         else
           escaped
         end
       end
 
-      def initialize(src, encoding: nil, font: nil, spacing: nil, dpi: ATTRS_DEFAULT[:dpi])
-        @src = src
-        @liquid_spacing = spacing
+      protected
 
+      def text_file_content
         # VIPS makes us provide the text content as a single variable,
         # so we may as well just one-shot File.read() it into memory.
         # https://kunststube.net/encoding/
-        contents = File.read(@src)
+        @text_file_content ||= File.read(path)
+      end
+
+      def text_file_utf8_content
+        CharlockHolmes::Converter.convert(text_file_content, text_file_encoding, 'UTF-8'.freeze)
+      end
 
+      def text_file_encoding
         # It's not easy or even possible in some cases to tell the "true" codepage
         # we should use for any given text document, but using character detection
         # is worth a shot if the user gave us nothing.
-        detected = CharlockHolmes::EncodingDetector.detect(contents)
-        @encoding = (encoding || detected[:encoding] || 'UTF-8'.freeze).to_s
-        @contents = CharlockHolmes::Converter.convert(contents, @encoding, 'UTF-8'.freeze)
+        #
+        # TODO: Figure out if/how we can get IBM437 files to not be detected as ISO-8859-1
+        @text_file_encoding ||= (
+          abstract(:encoding).to_s ||
+          CharlockHolmes::EncodingDetector.detect(text_file_content)[:encoding] ||
+          'UTF-8'.freeze
+        ).to_s
+      end
 
-        # Set the shorthand symbol key for our chosen font.
-        @font = font&.to_sym || self.singleton_class.const_get(:CODEPAGE_FONT)[codepage].first
+      def vips_font
+        # Set the shorthand Symbol key for our chosen font.
+        return abstract(:font)&.to_sym || CODEPAGE_FONT[codepage].first
+      end
 
+      def to_vips_image
         # Load font metadata directly from the file so we don't have to
         # duplicate it here to feed to Vips/Pango.
         #
@@ -154,10 +174,9 @@ module Cooltrainer
         # => "PerfectDOSVGA437"
         # irb(main)> font_meta.line_gap
         # => 0
-        @font_meta = TTFunk::File.open(font_path)
 
         # https://libvips.github.io/libvips/API/current/libvips-create.html#vips-text
-        @image = Vips::Image.text(
+        Vips::Image.text(
           # This string must be well-escaped Pango Markup:
           # https://developer.gnome.org/pango/stable/pango-Markup.html
           # However the official function for escaping text is
@@ -170,23 +189,22 @@ module Cooltrainer
             # we must also specify a font family, subfamily, and size.
             :font => "#{font_name} 16",
             # Space between lines (in Points).
-            :spacing => @font_meta.line_gap,
+            :spacing => to_ttfunk.line_gap,
             :justify => true,  # Requires libvips 8.8
-            :dpi => dpi.to_i,
+            :dpi => abstract(:dpi)&.to_i,
           },
         )
       end
 
-      protected
-
       # Return the String absolute path to the TTF file
       def font_path
         File.join(
-          File.dirname(__FILE__),  # distorted
+          File.dirname(__FILE__),  # molecule
+          '..'.freeze,  # distorted
           '..'.freeze,  # lib
           '..'.freeze,  # DistorteD-Ruby
           'font'.freeze,
-          font_codepage,
+          font_codepage.to_s,
           font_filename,
         )
       end
@@ -194,46 +212,12 @@ module Cooltrainer
       # Returns the numeric representation of the codepage
       # covered by our font.
       def font_codepage
-        self.singleton_class.const_get(:FONT_CODEPAGE)&.dig(@font).to_s
+        FONT_CODEPAGE.dig(vips_font).to_s
       end
 
       # Returns the basename (with file extension) of our font.
       def font_filename
-        self.singleton_class.const_get(:FONT_FILENAME)&.dig(@font)
-      end
-
-      # Returns a boolean for whether or not this font is monospaced.
-      # true == monospace
-      # false == proportional
-      def spacing
-        # Monospace fonts will (read: should) have the same width
-        # for every glyph, so we can tell a monospace font by
-        # checking if a deduplicated widths table has size == 1:
-        # irb(main)> font.horizontal_metrics.widths.count
-        # => 256
-        # irb(main)> font.horizontal_metrics.widths.uniq.compact.length
-        # => 1
-        @font_meta.horizontal_metrics.widths.uniq.compact.length == 1 ? :monospace : :proportional
-      end
-
-      # Returns the Family and Subfamily as one string suitable for libvips
-      def font_name
-        "#{@font_meta.name.font_family.first.encode('UTF-8')} #{@font_meta.name.font_subfamily.first.encode('UTF-8')}"
-      end
-
-      # Returns the Pango-Markup-encoded UTF-8 String version + revision of the font
-      def font_version
-        g_markup_escape_text(@font_meta.name&.version&.first&.encode('UTF-8').to_s)
-      end
-
-      # Returns the Pango-Markup-encoded UTF-8 String font file description
-      def font_description
-        g_markup_escape_text(@font_meta.name&.description&.first&.encode('UTF-8').to_s)
-      end
-
-      # Returns the Pango-Markup-encoded UTF-8 String copyright information of the font
-      def font_copyright
-        g_markup_escape_text(@font_meta.name&.copyright&.first&.encode('UTF-8').to_s)
+        FONT_FILENAME.dig(vips_font)
       end
 
     end  # Text

data/lib/distorted/{video.rb → molecule/video.rb}

@@ -17,25 +17,27 @@ end
 
 require 'set'
 
-require 'mime/types'
+require 'distorted/checking_you_out'
+require 'distorted/injection_of_love'
+
 
 module Cooltrainer
   module DistorteD
-    class Video
+    module Video
 
-      MEDIA_TYPE = 'video'.freeze
-      MIME_TYPES = MIME::Types[/^#{MEDIA_TYPE}/, :complete => true].to_set
+      LOWER_WORLD = CHECKING::YOU::IN(/^video\/mp4/)
 
       # Attributes for our <video>.
       # Automatically enabled as attrs for DD Liquid Tag.
       # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#Attributes
-      ATTRS = Set[:caption]
+      ATTRIBUTES = Set[:caption]
 
       # Defaults for HTML Element attributes.
       # Not every attr has to be listed here.
       # Many need no default and just won't render.
-      ATTRS_DEFAULT = {}
-      ATTRS_VALUES = {}
+      ATTRIBUTES_DEFAULT = {}
+      ATTRIBUTES_VALUES = {}
+      include Cooltrainer::DistorteD::InjectionOfLove
 
       attr_accessor :dest