himg 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b2129ecb9c51fef4cb5937b84cb79ffb17880b514f787870272e152f27c75f3
-  data.tar.gz: 72f3bf4d34326c362093a94ef77dbb460ef766930465cf04c7db6a3cff1a5dd4
+  metadata.gz: 7884a5777dcf5c83efbabe6e832f6276fc83450d6807199f51a73567e1f40123
+  data.tar.gz: 850e6467c3b7e76ae460fe4078bf3a5acd3cd3e0b0eb1bec898150671be9e7d1
 SHA512:
-  metadata.gz: 1d37eedb7061da5062c3115256f53d9011ba7498b45ca4c2d83e61838c81f87261561c7e3b8bdfc7eac0c8241a66d1b5c8413fc36fe0cda67bbc639ae254a366
-  data.tar.gz: 539f6f154e7414412e4c5b86505bededd930398a9f909d489787b395493a774bc1786011a1056689b75f61c38a4aa24de3b0e727cf88e66a8f85c9a16d55f55d
+  metadata.gz: b0befe957c4dda3e6b5c9d0a7aff0c112564cdb080bb040562c06f80ecd37e0f5340b96e8c30fda8d8a90ddeccc53381c4d740533c6a0848fb62b2a644cc2de3
+  data.tar.gz: 20574d4a615bed23e48027e23b79f77d5ffeef9f4e1ec75f294f38a370af772020fbacb1d4c90579b93f48f4293282d65466efe318b5fbee80bb8079630a10c5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.0.7] - 2025-07-29
+
+- Added `fetch_timeout` option to control restrict how long can be spent fetching resources.
+- Move bin/himg to exe/himg so bundler can install it in on the users PATH.
+
 ## [0.0.6] - 2025-07-23
 
 - Added bin/himg CLI screenshot tool

data/Cargo.lock

@@ -857,7 +857,7 @@ checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c"
 
 [[package]]
 name = "himg"
-version = "0.0.6"
+version = "0.0.7"
 dependencies = [
  "anyrender",
  "anyrender_vello_cpu",

data/README.md

@@ -2,7 +2,9 @@
 
 You give it HTML and it gives back an image!
 
-Parses a minimal subset of HTML/CSS, fetches nested resources, renders an image on the GPU. No browser, no fuss.
+Parses a minimal subset of HTML/CSS, fetches nested resources, renders an image. No browser, no fuss.
+
+Perfect for OpenGraph images - stop losing clicks to boring links by adding a rich image preview that showcases your content.
 
 ![Mockup showing HTML being transformed into a WhatsApp preview](/readme_hero.svg)
 
@@ -11,8 +13,8 @@ Parses a minimal subset of HTML/CSS, fetches nested resources, renders an image
 ### Command Line
 
 ```bash
-bin/himg screenshot path/to/your.html screenshot.png
-bin/himg screenshot https://github.com/Jamedjo/himg himg.png --width=1024 --verbose --no-truncate
+himg screenshot path/to/your.html screenshot.png
+himg screenshot https://github.com/Jamedjo/himg himg.png --width=1024 --verbose --no-truncate
 ```
 
 ### Ruby
@@ -63,6 +65,7 @@ bundle add himg
 |verbose | Enables detailed logging for debugging and profiling. | bool | false |
 |base_url | Where relative paths are relative to for linked resources (stylesheets, images, fonts, etc) | string | nil |
 |disable_fetch | Disables fetching linked resources from disk and network| bool | false |
+|fetch_timeout | Timeout in seconds for fetching resources | float | 10.0 |
 
 
 ### Passing options to a Rails view template
@@ -130,7 +133,7 @@ To play nicely with Rails a template handler is registered, which Rails' `defaul
 
 ## CAVEATS
 
-1. This is **pre-alpha** software, don't expect it to work yet.
+1. This is **pre-alpha** software, don't expect it to work perfectly yet.
 2. Performance needs tuning. Both in the underlying blitz library and how data is passed between Rust and Ruby
 3. Network requests can be made: don't use this library with untrusted inputs. Use `disable_fetch` if you don't need to fetch any resources.
 4. file:// URLs are resolved: this could expose files on your computer. Use `disable_fetch` if you don't need to fetch any resources.

data/exe/himg

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require "himg"
+require "himg/cli"
+Himg::CLI.start(ARGV)

data/ext/himg/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "himg"
 description = "ruby bindings to expose a blitz html->png pipeline"
-version = "0.0.6"
+version = "0.0.7"
 edition = "2024"
 authors = ["James Edwards-Jones <git@jamedjo.co.uk>"]
 license = "MIT"

data/ext/himg/examples/file.rs

@@ -34,6 +34,7 @@ async fn main() {
         verbose: true,
         color_scheme: ColorScheme::Light,
         disable_fetch: false,
+        fetch_timeout: 10.0,
         base_url: Some(base_url),
     };
 

data/ext/himg/src/html_to_image.rs

@@ -4,6 +4,7 @@ use anyrender_vello_cpu::VelloCpuImageRenderer;
 use anyrender::render_to_buffer;
 use blitz_paint::paint_scene;
 use blitz_traits::shell::{Viewport};
+use tokio::time::{timeout, Duration};
 
 use crate::image_size::ImageSize;
 use crate::logger::Logger;
@@ -50,8 +51,10 @@ pub async fn html_to_image(
     ));
 
     if let Some(ref mut net_fetcher) = net_fetcher {
-        net_fetcher.fetch_resources(&mut document).await;
-        logger.log("Fetched assets");
+        match timeout(Duration::from_millis((options.fetch_timeout * 1000.0) as u64), net_fetcher.fetch_resources(&mut document)).await {
+            Ok(_) => logger.log("Fetched assets"),
+            Err(_) => logger.log("Timeout fetching assets"),
+        }
     }
 
     // Compute style, layout, etc for HtmlDocument

data/ext/himg/src/lib.rs

@@ -12,7 +12,6 @@ pub use options::Options;
 pub use html_to_image::html_to_image;
 pub use writer::write_png;
 
-use blitz_traits::shell::ColorScheme;
 use magnus::{function, prelude::*, ExceptionClass, Error, Ruby, RString, RHash};
 
 impl Options {
@@ -26,15 +25,16 @@ impl Options {
 
         let options = Options {
             image_size: ImageSize {
-                width: hash.lookup2("width", 720)?,
-                height: hash.lookup2("height", 405)?,
-                hidpi_scale: 1.0,
+                width: hash.lookup2("width", defaults.image_size.width)?,
+                height: hash.lookup2("height", defaults.image_size.height)?,
+                hidpi_scale: defaults.image_size.hidpi_scale,
             },
-            truncate: hash.lookup2("truncate", true)?,
-            verbose: hash.lookup2("verbose", false)?,
+            truncate: hash.lookup2("truncate", defaults.truncate)?,
+            verbose: hash.lookup2("verbose", defaults.verbose)?,
             base_url: hash.lookup("base_url")?,
-            disable_fetch: hash.lookup2("disable_fetch", false)?,
-            color_scheme: ColorScheme::Light,
+            disable_fetch: hash.lookup2("disable_fetch", defaults.disable_fetch)?,
+            fetch_timeout: hash.lookup2("fetch_timeout", defaults.fetch_timeout)?,
+            color_scheme: defaults.color_scheme,
         };
 
         Ok(options)

data/ext/himg/src/options.rs

@@ -7,6 +7,7 @@ pub struct Options {
     pub image_size: ImageSize,
     pub color_scheme: ColorScheme,
     pub disable_fetch: bool,
+    pub fetch_timeout: f64,
     pub base_url: Option<String>,
     pub truncate: bool,
     pub verbose: bool,
@@ -24,6 +25,7 @@ impl Options {
             verbose:  false,
             base_url: None,
             disable_fetch:  false,
+            fetch_timeout: 10.0,
             color_scheme: ColorScheme::Light,
         }
     }

data/gemfiles/plain_ruby.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.5)
+    himg (0.0.6)
       rb_sys (~> 0.9)
 
 GEM

data/gemfiles/rails_6.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.5)
+    himg (0.0.6)
       rb_sys (~> 0.9)
 
 GEM

data/gemfiles/rails_7_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.5)
+    himg (0.0.6)
       rb_sys (~> 0.9)
 
 GEM

data/gemfiles/rails_7_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.5)
+    himg (0.0.6)
       rb_sys (~> 0.9)
 
 GEM

data/gemfiles/rails_7_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.5)
+    himg (0.0.6)
       rb_sys (~> 0.9)
 
 GEM

data/gemfiles/rails_8.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.5)
+    himg (0.0.6)
       rb_sys (~> 0.9)
 
 GEM

data/lib/himg/cli.rb

@@ -11,6 +11,7 @@ module Himg
     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 :fetch_timeout, type: :numeric, desc: "Timeout in seconds for fetching resources", default: 10
     option :http_headers, desc: "HTTP Headers to use when fetching remote resource"
     option :base_url, desc: "Base URL used to resolve relative URLs"
 

data/lib/himg/version.rb

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

data/lib/himg.rb

@@ -20,7 +20,7 @@ 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)
+  def self.render(html, width: 720, height: 405, truncate: true, verbose: false, base_url: nil, disable_fetch: false, fetch_timeout: 10)
+    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, "fetch_timeout" => fetch_timeout.to_f)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: himg
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - James Edwards-Jones
@@ -149,10 +149,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: You give it HTML and it renders an Image!
+description: You give it HTML and it renders an Image! No browser required. Perfect
+  for OpenGraph social cards so your links don't look boring when shared.
 email:
 - git@jamedjo.co.uk
-executables: []
+executables:
+- himg
 extensions:
 - ext/himg/extconf.rb
 extra_rdoc_files: []
@@ -169,6 +171,7 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- exe/himg
 - ext/himg/Cargo.lock
 - ext/himg/Cargo.toml
 - ext/himg/build.rs
@@ -229,5 +232,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: The Hyper Image Generator
+summary: Renders HTML to an Image, perfect for OpenGraph social cards
 test_files: []