distorted 0.6.0 → 0.7.0

data/lib/distorted/modular_technology/vips_load.rb

@@ -1,77 +0,0 @@
-
-require 'set'
-
-require 'distorted/checking_you_out'
-require 'distorted/modular_technology/vips_save'
-
-
-module Cooltrainer; end
-module Cooltrainer::DistorteD; end
-module Cooltrainer::DistorteD::Technology; end
-module Cooltrainer::DistorteD::Technology::VipsLoad
-
-  # Returns a Set of MIME::Types based on libvips LipsForeignLoad capabilities.
-  # NOTE: libvips only declares support (via :get_suffixes) for the "saver" types,
-  #   but libvips can use additional external libraries for wider media-types support, e.g.:
-  #
-  # - SVG with librsvg2★ / libcairo. [*]
-  # - PDF with PDFium if available, otherwise with libpoppler-glib / libcairo.
-  # - OpenEXR/libIlmImf — ILM high dynamic range image format.
-  # - maybe more: https://github.com/libvips/libvips/blob/master/configure.ac
-  #
-  #   [FITS]: https://heasarc.gsfc.nasa.gov/docs/heasarc/fits.html
-  #
-  #   [RSVG2]: This is the normal SVG library for the GNOME/GLib world and is
-  #            probably fine for 95% of use-cases, but I'm pissed off at it because of:
-  #
-  #            - https://gitlab.gnome.org/GNOME/librsvg/-/issues/56
-  #            - https://gitlab.gnome.org/GNOME/librsvg/-/issues/100
-  #            - https://gitlab.gnome.org/GNOME/librsvg/-/issues/183
-  #            - https://gitlab.gnome.org/GNOME/librsvg/-/issues/494
-  #            - https://bugzilla.gnome.org/show_bug.cgi?id=666477
-  #            - https://phabricator.wikimedia.org/T35245
-  #
-  #            TLDR: SVG <tspan> elements' [:x, :y, :dy, :dx] attributes can be
-  #            a space-delimited list of position values for individual
-  #            characters in the <tspan>, but librsvg2 only supported reading
-  #            those attributes as a single one-shot numeric value.
-  #            Documents using this totally-common and totally-in-spec feature
-  #            rendered incorrectly with librsvg2. Effected <tspan> elements'
-  #            subsequent children would hug one edge of the rendered output.
-  #
-  #            And wouldn't you know it but the one (1) SVG on my website
-  #            at the time I built this feature (IIDX-Turntable-parts.svg) used
-  #            this feature for the double-digit parts diagram labels.
-  #            I ended up having to edit my input document to just squash the
-  #            offending <tspan>s down to a single child each.
-  #            I guess that's semantically more correct in my document since they are
-  #            numbers like Eleven and not two separate characters like '1 1'
-  #            but still ugh lol
-  #
-  #            This was finally fixed in 2019 as of librsvg2 version 2.45.91 :)
-  #            https://gitlab.gnome.org/GNOME/librsvg/-/issues/494#note_579774
-  #
-
-  # TODO: Figure out how to detect non-Magick non-Saver Loader support,
-  # by which I mean "everything not included in :get_suffixes".
-  # NOTE: The Magick-based '.bmp' loader is broken/missing in libvips <= 8.9.1:
-  # https://github.com/libvips/libvips/issues/1528
-  # irb> MIME::Types.type_for('.bmp')
-  # => [#<MIME::Type: image/bmp>, #<MIME::Type: image/x-bmp>, #<MIME::Type: image/x-ms-bmp>]
-  # irb> MIME::Types.type_for('.bmp').map(&:preferred_extension)
-  # => ["bmp", "bmp", "bmp"]
-  LOWER_WORLD = (VIPS_AVAILABLE_VER < TripleCounter.new(8, 9, 1)) ?
-    Cooltrainer::DistorteD::Technology::VipsSave::OUTER_LIMITS.keep_if { |t| t.preferred_extension != 'bmp'.freeze } :
-    Cooltrainer::DistorteD::Technology::VipsSave::OUTER_LIMITS
-
-  def to_vips_image
-    # TODO: Learn more about what VipsAccess means for our use case,
-    # if the default should be changed, and if it should be
-    # a user-controllable attr or not.
-    # https://libvips.github.io/libvips/API/current/VipsImage.html#VipsAccess
-    # https://libvips.github.io/libvips/API/current/How-it-opens-files.md.html
-    @vips_image ||= Vips::Image.new_from_file(path)
-  end
-
-
-end

data/lib/distorted/molecule/C18H27NO3.rb

@@ -1,10 +0,0 @@
-require 'distorted/injection_of_love'
-
-module Cooltrainer; end
-module Cooltrainer::DistorteD; end
-module Cooltrainer::DistorteD::Molecule; end
-module Cooltrainer::DistorteD::Molecule::C18H27NO3
-
-  BOOLEAN_ATTR_VALUES = Set[0, 1, false, true, '0'.freeze, '1'.freeze, 'false'.freeze, 'true'.freeze]
-
-end

data/lib/distorted/molecule/font.rb

@@ -1,198 +0,0 @@
-require 'set'
-
-# Font metadata extraction
-require 'ttfunk'
-
-require 'distorted/modular_technology/pango'
-require 'distorted/modular_technology/ttfunk'
-require 'distorted/modular_technology/vips_save'
-require 'distorted/checking_you_out'
-require 'distorted/injection_of_love'
-
-
-module Cooltrainer
-  module DistorteD
-    module Font
-
-
-      # TODO: Test OTF, OTB, and others.
-      # NOTE: Traditional bitmap fonts won't be supported due to Pango 1.44
-      # and later switching to Harfbuzz from Freetype:
-      # https://gitlab.gnome.org/GNOME/pango/-/issues/386
-      # https://blogs.gnome.org/mclasen/2019/05/25/pango-future-directions/
-      LOWER_WORLD = CHECKING::YOU::IN(/^font\/ttf/)
-      OUTER_LIMITS = CHECKING::YOU::IN(/^font\/ttf/)
-
-      ATTRIBUTES = Set[
-        :alt,
-      ]
-      ATTRIBUTES_VALUES = {
-      }
-      ATTRIBUTES_DEFAULT = {
-      }
-
-
-      # Maybe T0DO: Process output with TTFunk instead of only using it
-      # to generate images and metadata.
-      self::OUTER_LIMITS.each { |t|
-        define_method(t.distorted_method) { |*a, **k, &b|
-          copy_file(*a, **k, &b)
-        }
-      }
-
-      include Cooltrainer::DistorteD::Technology::TTFunk
-      include Cooltrainer::DistorteD::Technology::Pango
-      include Cooltrainer::DistorteD::Technology::VipsSave
-      include Cooltrainer::DistorteD::InjectionOfLove
-
-
-      # irb(main):089:0> chars.take(5)
-      # => [[1, 255], [2, 1], [3, 2], [4, 3], [5, 4]]
-      # irb(main):090:0> chars.values.take(5)
-      # => [255, 1, 2, 3, 4]
-      # irb(main):091:0> chars.values.map(&:chr).take(5)
-      # => ["\xFF", "\x01", "\x02", "\x03", "\x04"]
-      def to_pango
-        output = '' << cr << '<span>' << cr
-
-        output << "<span size='35387'> #{font_name}</span>" << cr << cr
-
-        output << "<span size='24576'> #{font_description}</span>" << cr
-        output << "<span size='24576'> #{font_copyright}</span>" << cr
-        output << "<span size='24576'> #{font_version}</span>" << cr << cr
-
-        # Print a preview String in using the loaded font. Or don't.
-        if abstract(:title)
-          output << cr << cr << "<span size='24576' foreground='grey'> #{g_markup_escape_text(abstract(:title))}</span>" << cr << cr << cr
-        end
-
-        #                        /!\ MANDATORY READING /!\
-        # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6cmap.html
-        #
-        # "The 'cmap' table maps character codes to glyph indices.
-        # The choice of encoding for a particular font is dependent upon the conventions
-        # used by the intended platform. A font intended to run on multiple platforms
-        # with different encoding conventions will require multiple encoding tables.
-        # As a result, the 'cmap' table may contain multiple subtables,
-        # one for each supported encoding scheme."
-        #
-        # Cmap#unicode is a convenient shortcut to sorting the subtables
-        # and removing any unusable ones:
-        # https://github.com/prawnpdf/ttfunk/blob/master/lib/ttfunk/table/cmap.rb
-        #
-        # irb(main):174:0> font_meta.cmap.tables.count
-        # => 3
-        # irb(main):175:0> font_meta.cmap.unicode.count
-        # => 2
-        to_ttfunk.cmap.tables.each do |table|
-          next if !table.unicode?
-          # Each subtable's `code_map` is a Hash map of character codes (the Hash keys)
-          # to the glyph IDs from the original font (the Hash's values).
-          #
-          # Subtable::encode takes:
-          #  - a Hash mapping character codes to original font glyph IDs.
-          #  - the desired output encoding — Set[:mac_roman, :unicode, :unicode_ucs4]
-          #    https://github.com/prawnpdf/ttfunk/blob/master/lib/ttfunk/table/cmap/subtable.rb
-          # …and returns a Hash with keys:
-          #  - :charmap  — Hash mapping the characters in the input charmap
-          #                to a another hash containing both the `:old`
-          #                and `:new` glyph ids for each character code.
-          #  - :subtable — String encoded subtable for the given encoding.
-          encoded = TTFunk::Table::Cmap::Subtable::encode(table&.code_map, :unicode).dig(:charmap)
-
-          output << "<span size='49152'>"
-
-          i = 0
-          encoded.each_pair { |c, (old, new)|
-
-            begin
-              if glyph = to_ttfunk.glyph_outlines.for(c)
-                # Add a space on either side of the character so they aren't
-                # all smooshed up against each other and unreadable.
-                output << ' ' << g_markup_escape_char(c) << ' '
-                if i >= 15
-                  output << cr
-                  i = 0
-                else
-                  i = i + 1
-                end
-              else
-              end
-            rescue NoMethodError => nme
-              # TTFunk's `glyph_outlines.for()` will raise this if we call it
-              # for a codepoint that does not exist in the font, which we will
-              # not do because we are enumerating the codepoints in the font,
-              # but we should still handle the possibility.
-              # irb(main):060:0> font.glyph_outlines.for(555555)
-              #
-              # Traceback (most recent call last):
-              #   6: from /usr/bin/irb:23:in `<main>'
-              #   5: from /usr/bin/irb:23:in `load'
-              #   4: from /home/okeeblow/.gems/gems/irb-1.2.4/exe/irb:11:in `<top (required)>'
-              #   3: from (irb):60
-              #   2: from /home/okeeblow/.gems/gems/ttfunk-1.6.2.1/lib/ttfunk/table/glyf.rb:35:in `for'
-              #   1: from /home/okeeblow/.gems/gems/ttfunk-1.6.2.1/lib/ttfunk/table/loca.rb:35:in `size_of'
-              # NoMethodError (undefined method `-' for nil:NilClass)
-            end
-          }
-
-          output << '</span>' << cr
-        end
-
-        output << '</span>'
-        output
-      end
-
-      # Return the `src` as the font_path since we aren't using
-      # any of the built-in fonts.
-      def font_path
-        path
-      end
-
-      def to_vips_image
-        # https://libvips.github.io/libvips/API/current/libvips-create.html#vips-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
-          # not implemented in Ruby GLib, so we have to do it ourselves.
-          to_pango,
-          **{
-            # String absolute path to TTF
-            :fontfile => font_path,
-            # It's not enough to just specify the TTF path;
-            # we must also specify a font family, subfamily, and size.
-            :font => "#{font_name}",
-            # Space between lines (in Points).
-            :spacing => to_ttfunk.line_gap,
-            # Requires libvips 8.8
-            :justify => false,
-            :dpi => 144,
-          },
-        )
-      end
-
-    end  # Font 
-  end  # DistorteD
-end  # Cooltrainer
-
-
-# Notes on file-format specifics and software-library-specifics
-#
-# # TTF (via TTFunk)
-# 
-# ## Cmap
-#
-# Each TTFunk::Table::Cmap::Format<whatever> class responds to `:supported?`
-# with its own internal boolean telling us if that Format is usable in TTFunk.
-# This has nothing to do with any font file itself, just the library code.
-# irb(main)> font.cmap.tables.map{|t| t.supported?}
-# => [true, true, true]
-#
-# Any subclass of TTFunk::Table::Cmap::Subtable responds to `:unicode?`
-# with a boolean calculated from the instance `@platform_id` and `@encoding_id`,
-# and those numeric IDs are assigned to the symbolic (e.g. `:macroman`) names in:
-# https://github.com/prawnpdf/ttfunk/blob/master/lib/ttfunk/table/cmap/subtable.rb
-# irb(main)> font.cmap.tables.map{|t| t.unicode?}
-# => [true, false, true]
-# 

data/lib/distorted/molecule/image.rb

@@ -1,36 +0,0 @@
-
-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/molecule/pdf.rb

@@ -1,119 +0,0 @@
-require 'set'
-
-require 'hexapdf'
-
-require 'distorted/checking_you_out'
-require 'distorted/injection_of_love'
-require 'distorted/molecule/C18H27NO3'
-
-
-module Cooltrainer
-  module DistorteD
-    module PDF
-
-
-      include Cooltrainer::DistorteD::Molecule::C18H27NO3
-
-      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
-      PDF_OPEN_PARAMS = Array[
-        # Keep the PDF Open Params in the order they are defined
-        # in the Adobe documentation, since it says they should
-        # be specified in the URL in that same order.
-        # Ruby's Set doesn't guarantee order, so use a plain Array here.
-        :nameddest,
-        :page,
-        :comment,
-        :collab,
-        :zoom,
-        :view,
-        :viewrect,
-        :pagemode,
-        :scrollbar,
-        :search,
-        :toolbar,
-        :statusbar,
-        :messages,
-        :navpanes,
-        :highlight,
-        :fdf,
-      ]
-      ATTRIBUTES = Set[
-        :alt,
-        :caption,
-        :height,  #<object> viewer container height.
-        :width,  # <object> viewer container width.
-      ].merge(PDF_OPEN_PARAMS)
-
-      # "You cannot use the reserved characters =, #, and &.
-      # There is no way to escape these special characters."
-      RESERVED_CHARACTERS_FRAGMENT = '[^=#&]+'.freeze
-
-      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})?)$/
-
-      ATTRIBUTES_DEFAULT = {
-        :height => '100%'.freeze,
-        :width => '100%'.freeze,
-        # BEGIN PDF Open Parameters
-        :page => 1,
-        :view => :Fit,
-        :pagemode => :none,
-        :scrollbar => 1,
-        :toolbar => 1,
-        :statusbar => 1,
-        :messages => 0,
-        :navpanes => 1,
-        # END PDF Open Parameters
-      }
-
-      # Adobe's PDF Open Parameters documentation sez:
-      # "Individual parameters, together with their values (separated by & or #),
-      # can be no greater then 32 characters in length."
-      # …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.
-      ATTRIBUTES_VALUES = {
-        :nameddest => /^#{RESERVED_CHARACTERS_FRAGMENT}$/,
-        :page => /\d/,
-        :comment => /^#{RESERVED_CHARACTERS_FRAGMENT}$/,
-        :collab => /^(DAVFDF|FSFDF|DB)@#{RESERVED_CHARACTERS_FRAGMENT}$/,
-        :zoom => /^#{FLOAT_INT_FRAGMENT}(,#{FLOAT_INT_FRAGMENT},#{FLOAT_INT_FRAGMENT})?$/,
-        :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_ATTR_VALUES,
-        :search => /^#{RESERVED_CHARACTERS_FRAGMENT}(,\s#{RESERVED_CHARACTERS_FRAGMENT})*$/,
-        :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|
-          doc.task(
-            :optimize,
-            compact: true,
-            object_streams: :generate,
-            xref_streams: :generate,
-            compress_pages: false,
-          )
-          doc.write(dest)
-        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

@@ -1,60 +0,0 @@
-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