himg 0.0.6-x86_64-linux-musl

data/gemfiles/rails_8.gemfile.lock

@@ -0,0 +1,329 @@
+PATH
+  remote: ..
+  specs:
+    himg (0.0.5)
+      rb_sys (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    bump (0.10.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.1)
+    crass (1.0.6)
+    csv (3.3.4)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.1)
+    drb (2.2.1)
+    erubi (1.13.1)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    fileutils (1.7.3)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
+    minitest (5.25.5)
+    mutex_m (0.3.0)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.8-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-musl)
+      racc (~> 1.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.4.0)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.13)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rake-compiler (1.3.0)
+      rake
+    rake-compiler-dock (1.9.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rb_sys (0.9.111)
+      rake-compiler-dock (= 1.9.1)
+    rbs (3.9.2)
+      logger
+    rdoc (6.13.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (7.1.1)
+      actionpack (>= 7.0)
+      activesupport (>= 7.0)
+      railties (>= 7.0)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.2)
+    rubocop (1.75.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    steep (1.10.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.17.0.4, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      mutex_m (>= 0.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 3.9)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 5)
+      uri (>= 0.12.0)
+    stringio (3.1.7)
+    strscan (3.1.3)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  appraisal
+  bump
+  debug
+  himg!
+  irb
+  rails (~> 8.0)
+  rake
+  rake-compiler
+  rspec
+  rspec-rails (~> 7.0)
+  rubocop
+  steep
+
+BUNDLED WITH
+   2.6.7

data/lib/himg/base_url.rb

@@ -0,0 +1,21 @@
+require "uri"
+
+module Himg
+  class BaseUrl
+    def initialize(path_or_url)
+      path_or_url = path_or_url.to_s.strip
+      return if path_or_url&.empty?
+
+      @url = URI.parse(path_or_url)
+      @url.scheme = "file" unless @url.scheme
+
+      raise Himg::Error, "Invalid base_url #{path_or_url}" if @url.path.empty?
+
+      @url.path += "/" unless @url.path.end_with?("/")
+    end
+
+    def to_s
+      @url&.to_s
+    end
+  end
+end

data/lib/himg/cli.rb

@@ -0,0 +1,64 @@
+require "thor"
+require "himg"
+require "open-uri"
+
+module Himg
+  class CLI < Thor
+    desc "screenshot SOURCE_HTML DESTINATION_PNG [OPTIONS]", "Render HTML to a png screenshot"
+
+    option :width, type: :numeric, desc: "Sets the width of the rendered content.", default: 720
+    option :height, type: :numeric, desc: "Sets the desired height of the rendered output.", default: 405
+    option :truncate, type: :boolean, desc: "Keeps the image height fixed instead of expanding to include the full page.", default: true
+    option :verbose, type: :boolean, desc: "Enables detailed logging for debugging and profiling.", default: false
+    option :disable_fetch, type: :boolean, desc: "Skip fetching file/http resources (stylesheets, images, fonts, etc)", default: false
+    option :http_headers, desc: "HTTP Headers to use when fetching remote resource"
+    option :base_url, desc: "Base URL used to resolve relative URLs"
+
+    long_desc <<-LONGDESC
+      `himg screenshot` takes a path to an HTML file and will render a png image with the output.
+
+      It takes a SOURCE, which can be a file path or a URL to fetch.
+
+      The DESTINATION_PNG must be a local file path.
+
+      CAVEATS: This uses a lightweight HTML parser instead of a full browser, so does not support all features.
+      Additionally it does not use a JavaScript engine, so will screenshot the page as-is and would not work for all webpages.
+    LONGDESC
+    def screenshot(url, destination)
+      Document.new(url, options).load do |content|
+        png = Himg.render(content, **options.transform_keys(&:to_sym))
+
+        File.open(destination, "wb") { |f| f.write(png) }
+      end
+    end
+
+    private
+
+    def self.exit_on_failure?
+      true
+    end
+
+    class Document
+      def initialize(source, options)
+        @source = source
+        @options = options
+      end
+
+      def http_url?
+        @source =~ %r{\Ahttps?\://}
+      end
+
+      def load(&block)
+        if http_url?
+          URI.send(:open, @source) do |input|
+            yield(input.binmode.read)
+          end
+        else
+          File.open(@source) do |f|
+            yield(f.read)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/himg/railtie/controller_config.rb

@@ -0,0 +1,31 @@
+module Himg
+  class Railtie
+    module ControllerConfig
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :_apply_himg_config
+      end
+
+      class_methods do
+        def himg_config(options = {})
+          @_himg_global_config ||= {}
+          @_himg_global_config.merge!(options)
+        end
+
+        def _himg_global_config
+          @_himg_global_config&.dup || {}
+        end
+      end
+
+      def himg_config(options = {})
+        @_himg_config.merge!(options)
+        @_himg_config
+      end
+
+      def _apply_himg_config
+        @_himg_config = self.class._himg_global_config
+      end
+    end
+  end
+end

data/lib/himg/railtie/template_handler.rb

@@ -0,0 +1,32 @@
+module Himg
+  class Railtie
+    # Handles .himg templates by calling through to Himg.render
+    class TemplateHandler
+      def self.call(_template, source)
+        <<-CODE
+          Himg.render(#{source.inspect}, **@_himg_config)
+        CODE
+      end
+    end
+
+    # Handles .himg.erb templates by pre-processing with Erb, possibly appending
+    # to @output_buffer or calling .safe_append, and then passing the result to
+    # Himg.render
+    class ErbTemplateHandler
+      def self.call(template, source)
+        erb_handler = ActionView::Template.registered_template_handler(:erb)
+        preprocessed_view_code = erb_handler.call(template, source)
+
+        <<-CODE
+          output = begin
+            #{preprocessed_view_code}
+          end
+          Himg.render(output, **@_himg_config)
+        CODE
+      end
+    end
+  end
+end
+
+ActionView::Template.register_template_handler :himg, Himg::Railtie::TemplateHandler
+ActionView::Template.register_template_handler "himg.erb", Himg::Railtie::ErbTemplateHandler

data/lib/himg/railtie.rb

@@ -0,0 +1,49 @@
+module Himg
+  # Himg::Railtie
+  #
+  # Allows you to render Png images directly from rails using HTML based templates.
+  #
+  # View templates can be registered with `.himg` and will be converted from
+  # HTML to an image, or with `.himg.erb` to insert dynamic content. A renderer
+  # also allows direct rendering of HTML without going through a template.
+  #
+  # Example usage:
+  # - `show.himg.erb` renders an image based on controller data.
+  # - `render himg: '<div>My Data</div>'` generates an image from HTML.
+  #
+  # This works by registering a template handler, which will be called by Rails'
+  # default_render method when a view template exists matching the current action
+  # in a request where the format extension is .himg or a png is requested.
+  #
+  # The direct render works similarly, but instead of checking the request format
+  # it looks for the :himg key passed into a Rails render function.
+  class Railtie < Rails::Railtie
+    initializer "himg.configure_rails_initialization" do
+      ActiveSupport.on_load(:action_view) do
+        require "himg/railtie/template_handler"
+      end
+    end
+
+    initializer "himg.mime_types" do
+      Mime::Type.register "image/png", :himg
+    end
+
+    initializer "himg.controller_renderer" do
+      ActionController::Renderers.add :himg do |obj, options = {}|
+        configured_options = options[:config] || {}
+        direct_options = options.symbolize_keys.slice(*Himg::RENDER_OPTIONS)
+        merged_options = configured_options.merge(direct_options)
+
+        png_data = Himg.render(obj, **merged_options)
+        send_data png_data, type: "image/png", disposition: "inline"
+      end
+    end
+
+    initializer 'himg.controller_config' do
+      require "himg/railtie/controller_config"
+      ActiveSupport.on_load(:action_controller) do
+        include Himg::Railtie::ControllerConfig
+      end
+    end
+  end
+end

data/lib/himg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Himg
+  VERSION = "0.0.6"
+end

data/lib/himg.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "himg/version"
+require_relative "himg/base_url"
+require "himg/railtie" if defined?(Rails::Railtie)
+
+# Attempt to load a versioned extension based on the Ruby version.
+# Fall back to loading the non-versioned extension if version-specific loading fails.
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "#{Regexp.last_match(1)}/himg/himg"
+rescue LoadError
+  require "himg/himg"
+end
+
+# The Hyper Image Generator
+#
+# Converts HTML to an Image for a minimal subset of HTML and CSS
+module Himg
+  RENDER_OPTIONS = %i[width height truncate verbose].freeze
+  class Error < StandardError; end
+
+  def self.render(html, width: 720, height: 405, truncate: true, verbose: false, base_url: nil, disable_fetch: false)
+    render_to_string(html, "width" => width.to_i, "height" => height.to_i, "truncate" => truncate, "verbose" => verbose, "base_url" => BaseUrl.new(base_url).to_s, "disable_fetch" => disable_fetch)
+  end
+end