RubyGems - himg - Versions diffs - 0.0.3 → 0.0.4 - Mend

himg 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +4 -0
data/Cargo.lock +1 -1
data/README.md +4 -0
data/Rakefile +1 -1
data/ext/himg/Cargo.toml +1 -1
data/ext/himg/examples/file.rs +1 -0
data/ext/himg/src/html_to_image.rs +9 -5
data/ext/himg/src/lib.rs +34 -45
data/ext/himg/src/options.rs +1 -0
data/ext/himg/src/renderer.rs +28 -0
data/gemfiles/plain_ruby.gemfile.lock +1 -1
data/gemfiles/rails_6.gemfile.lock +1 -1
data/gemfiles/rails_7_0.gemfile.lock +1 -1
data/gemfiles/rails_7_1.gemfile.lock +1 -1
data/gemfiles/rails_7_2.gemfile.lock +1 -1
data/gemfiles/rails_8.gemfile.lock +1 -1
data/lib/himg/version.rb +1 -1
data/lib/himg.rb +4 -0
metadata +2 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286080c98560f491c524867c0986edd71e7e14bc912a50a2a72d627d4cb22e34
-  data.tar.gz: 435a08c13f0211d694ca477d4ce8a7afba24c686d088a7b7831c0397177d127c
+  metadata.gz: 1e2af1a8848987b76777bf3aed2c0dfc3254e2486aab89e816e2751cb00ec10f
+  data.tar.gz: d4e71ff28a851c19ccc36403997cf2965e082f8267852f25a4efd704d4f96fa9
 SHA512:
-  metadata.gz: d5ca027f7d92741dc71b872a5308a05228c9e7c7743ebcfd976175f3c4a5a0482d3831e0d3f664aa1a7870353e8d2d482c1e545b0fa558d802ca3131282323bd
-  data.tar.gz: e4a9e936a5d96a1574c9af213912bed55de8e25af94775007397a70a7bdebc9f5b41519fc35668738c0929e9f50821b18f1c58d0897f84443334fcba15b4973c
+  metadata.gz: 3706e38ff13df4d57636bbb10bd58994d666454b5b2fbcd9dfbbdd5fe31a78ab13e7c768f56b8d188b8752a648eca6653452c7044eda88c7927ad89be61489c9
+  data.tar.gz: 33c0de522e5ff80866457b88263540532a561ebc7fd0740649d08f3861370824456f7cc98f4d94b5e07ff28f02cc58706c716ed564f6bac0586676e6c4495d93

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,9 @@
 ## [Unreleased]
+## [0.0.4] - 2025-04-22
+- Allow `width`, `height` and `truncate` to be passed to the render function.
 ## [0.0.3] - 2025-04-22
 - Ensure that when render height is expanded to fit the content that we update

data/Cargo.lock CHANGED Viewed

@@ -1065,7 +1065,7 @@ checksum = "dfa686283ad6dd069f105e5ab091b04c62850d3e4cf5d67debad1933f55023df"
 [[package]]
 name = "himg"
-version = "0.0.3"
+version = "0.0.4"
 dependencies = [
  "blitz-dom",
  "blitz-html",

data/README.md CHANGED Viewed

@@ -40,6 +40,10 @@ gem install himg
 png = Himg.render("<html bgcolor='blue'></html>")
 ```
+```ruby
+png = Himg.render("<h1>Hi</h1>", width: 24, height: 24, truncate: false)
+```
 ### Rails
 Simply add a `show.himg.erb`!

data/Rakefile CHANGED Viewed

@@ -20,7 +20,7 @@ RbSys::ExtensionTask.new("himg", GEMSPEC) do |ext|
 end
 require "bump/tasks"
-Bump.replace_in_default = %w[ext/himg/Cargo.toml]
+Bump.replace_in_default = %w[Cargo.lock ext/himg/Cargo.toml]
 Bump.changelog = :editor
 task default: %i[compile rubocop]

data/ext/himg/Cargo.toml CHANGED Viewed

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

data/ext/himg/examples/file.rs CHANGED Viewed

@@ -30,6 +30,7 @@ async fn main() {
             height: 800,
             hidpi_scale: 1.0,
         },
+        truncate: false,
         color_scheme: ColorScheme::Light,
         allow_net_requests: true, //TODO: Implement using this
     };

data/ext/himg/src/html_to_image.rs CHANGED Viewed

@@ -64,11 +64,15 @@ pub async fn html_to_image(
     logger.log("Resolved styles and layout");
     // Determine height to render
-    let computed_height = document.as_ref().root_element().final_layout.size.height;
-    let render_height = (computed_height as u32).max(options.image_size.height).min(4000);
-    let render_size = ImageSize {
-        height: render_height,
-        ..options.image_size
+    let render_size = if options.truncate {
+        options.image_size
+    } else {
+        let computed_height = document.as_ref().root_element().final_layout.size.height;
+        let render_height = (computed_height as u32).max(options.image_size.height).min(10_000);
+        ImageSize {
+            height: render_height,
+            ..options.image_size
+        }
     };
     logger.log("Calculated render dimensions from document");

data/ext/himg/src/lib.rs CHANGED Viewed

@@ -1,57 +1,46 @@
-pub mod writer;
-pub mod image_size;
+pub mod renderer;
 pub mod html_to_image;
-pub mod logger;
+pub mod image_size;
 pub mod options;
+pub mod writer;
+pub mod logger;
-pub use html_to_image::html_to_image;
-pub use image_size::ImageSize;
-pub use options::Options;
-pub use writer::write_png;
-pub use logger::{Logger, TimedLogger};
-use blitz_traits::{ColorScheme};
-use magnus::{function, prelude::*, ExceptionClass, Error, Ruby};
-pub fn render_blocking(html: String) -> Result<Vec<u8>, std::io::Error> {
-    let runtime = tokio::runtime::Runtime::new()?;
-    runtime.block_on(render(html))
-}
-// render_to_bytes, render_to_string, render_to_file, render_to_io
-pub async fn render(html: String) -> Result<Vec<u8>, std::io::Error> {
-    let mut logger = TimedLogger::init();
-    // Configure viewport dimensions
-    let options = Options {
-        image_size: ImageSize {
-            width: 720, //TODO: pass this in
-            height: 405, //TODO: decide if this will be fixed or dynamic from the document
-            hidpi_scale: 1.0,
-        },
-        color_scheme: ColorScheme::Light,
-        allow_net_requests: true, //TODO: Implement using this
-    };
-    // Render to Image
-    //let base_url = format!("file://{}", path_string.clone());
-    let base_url = None;
-    let render_output = html_to_image(&html, base_url, options, &mut logger).await;
+pub use renderer::render_blocking;
-    // Determine output path, and open a file at that path.
-    let mut output_buffer: Vec<u8> = Vec::new();
+use crate::image_size::ImageSize;
+use crate::options::Options;
+use blitz_traits::ColorScheme;
+use magnus::{function, prelude::*, ExceptionClass, Error, Ruby, RString, RHash};
-    // Encode buffer as PNG and write it to a file
-    write_png(&mut output_buffer, &render_output.buffer, render_output.image_size.scaled_width(), render_output.image_size.scaled_height())?;
+impl Options {
+    fn get_option<V: magnus::TryConvert + magnus::IntoValue>(optional_hash: Option<RHash>, key: &str, default: V) -> Result<V, Error> {
+        match optional_hash {
+            Some(hash) => hash.lookup2::<&str, V, V>(key, default),
+            None => Ok(default),
+        }
+    }
-    Ok(output_buffer)
+    pub fn from_ruby(hash: Option<RHash>) -> Result<Self, Error> {
+        let options = Options {
+            image_size: ImageSize {
+                width: Self::get_option(hash, "width", 720)?,
+                height: Self::get_option(hash, "height", 405)?,
+                hidpi_scale: 1.0,
+            },
+            truncate: Self::get_option(hash, "truncate", true)?,
+            color_scheme: ColorScheme::Light,
+            allow_net_requests: true, //TODO: Implement using this
+        };
+        Ok(options)
+    }
 }
-pub fn render_blocking_rb(ruby: &Ruby, html: String) -> Result<magnus::RString, magnus::Error> {
+pub fn render_blocking_rb(ruby: &Ruby, html: String, options: Option<RHash>) -> Result<RString, Error> {
+    let options = Options::from_ruby(options)?;
     let exception_class = ExceptionClass::from_value(magnus::eval("Himg::Error").unwrap()).unwrap();
-    match render_blocking(html) {
+    match render_blocking(html, options) {
         Ok(data) => Ok(ruby.str_from_slice(&data)),
         Err(e) => Err(Error::new(exception_class, format!("{}", e))),
     }
@@ -62,7 +51,7 @@ fn init(ruby: &Ruby) -> Result<(), Error> {
     let module = ruby.define_module("Himg")?;
     //TODO: Allow optional base_url for resolving linked resources (stylesheets, images, fonts, etc)
-    module.define_singleton_method("render", function!(render_blocking_rb, 1))?;
+    module.define_singleton_method("render_to_string", function!(render_blocking_rb, 2))?;
     Ok(())
 }

data/ext/himg/src/options.rs CHANGED Viewed

@@ -7,4 +7,5 @@ pub struct Options {
     pub image_size: ImageSize,
     pub color_scheme: ColorScheme,
     pub allow_net_requests: bool,
+    pub truncate: bool,
 }

data/ext/himg/src/renderer.rs ADDED Viewed

@@ -0,0 +1,28 @@
+use crate::html_to_image::html_to_image;
+use crate::options::Options;
+use crate::writer::write_png;
+use crate::logger::{TimedLogger};
+pub fn render_blocking(html: String, options: Options) -> Result<Vec<u8>, std::io::Error> {
+    let runtime = tokio::runtime::Runtime::new()?;
+    runtime.block_on(render(html, options))
+}
+// render_to_bytes, render_to_string, render_to_file, render_to_io
+pub async fn render(html: String, options: Options) -> Result<Vec<u8>, std::io::Error> {
+    let mut logger = TimedLogger::init();
+    // Render to Image
+    //let base_url = format!("file://{}", path_string.clone());
+    let base_url = None;
+    let render_output = html_to_image(&html, base_url, options, &mut logger).await;
+    // Determine output path, and open a file at that path.
+    let mut output_buffer: Vec<u8> = Vec::new();
+    // Encode buffer as PNG and write it to a file
+    write_png(&mut output_buffer, &render_output.buffer, render_output.image_size.scaled_width(), render_output.image_size.scaled_height())?;
+    Ok(output_buffer)
+}

data/gemfiles/plain_ruby.gemfile.lock CHANGED Viewed

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

data/gemfiles/rails_6.gemfile.lock CHANGED Viewed

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

data/gemfiles/rails_7_0.gemfile.lock CHANGED Viewed

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

data/gemfiles/rails_7_1.gemfile.lock CHANGED Viewed

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

data/gemfiles/rails_7_2.gemfile.lock CHANGED Viewed

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

data/gemfiles/rails_8.gemfile.lock CHANGED Viewed

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

data/lib/himg/version.rb CHANGED Viewed

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

data/lib/himg.rb CHANGED Viewed

@@ -17,4 +17,8 @@ end
 # Converts HTML to an Image for a minimal subset of HTML and CSS
 module Himg
   class Error < StandardError; end
+  def self.render(html, width: 720, height: 405, truncate: true)
+    render_to_string(html, "width" => width, "height" => height, "truncate" => truncate)
+  end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: himg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - James Edwards-Jones
@@ -180,6 +180,7 @@ files:
 - ext/himg/src/lib.rs
 - ext/himg/src/logger.rs
 - ext/himg/src/options.rs
+- ext/himg/src/renderer.rs
 - ext/himg/src/writer.rs
 - gemfiles/plain_ruby.gemfile
 - gemfiles/plain_ruby.gemfile.lock