himg 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fc5224bd15d81a7d37a613be2ff4b648db40f6489898ef164c6144ae9e68e0f
-  data.tar.gz: 036c08c03d4cee6c08df32efeeddd2b334b43ba1e090a8f9e27196df4d401524
+  metadata.gz: 1e2af1a8848987b76777bf3aed2c0dfc3254e2486aab89e816e2751cb00ec10f
+  data.tar.gz: d4e71ff28a851c19ccc36403997cf2965e082f8267852f25a4efd704d4f96fa9
 SHA512:
-  metadata.gz: b0534b8ae5f8ba53db0173f71dc44742c3be7c4466dd5d76be6190ec7b7227a23c7e2135ea97d071de93667c339d2263e9adc43b7664db16803255e99a58b4bb
-  data.tar.gz: 2f72cfe20ac86a5243295073e6a152a76dcefb3192d860adb71510ed6fb59c841b58e1ed54ed7807979920dca0ae3cd8b7c478db214ff9b9df930f90531e070b
+  metadata.gz: 3706e38ff13df4d57636bbb10bd58994d666454b5b2fbcd9dfbbdd5fe31a78ab13e7c768f56b8d188b8752a648eca6653452c7044eda88c7927ad89be61489c9
+  data.tar.gz: 33c0de522e5ff80866457b88263540532a561ebc7fd0740649d08f3861370824456f7cc98f4d94b5e07ff28f02cc58706c716ed564f6bac0586676e6c4495d93

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  Enabled: false

data/Appraisals

@@ -1,7 +1,10 @@
 appraise "plain-ruby" do
+  remove_gem "rails"
+  remove_gem "puma"
 end
 
 appraise "rails-6" do
+  remove_gem "puma"
   gem "rails", "~> 6.0"
   gem "rspec-rails", "~> 6.0"
   gem "concurrent-ruby", "1.3.4" # Logger dependency fix, see: https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
@@ -10,6 +13,7 @@ appraise "rails-6" do
 end
 
 appraise "rails-7-0" do
+  remove_gem "puma"
   gem "rails", "~> 7.0.0"
   gem "rspec-rails", "~> 7.0"
   gem "concurrent-ruby", "1.3.4" # Logger dependency fix, see: https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
@@ -18,16 +22,19 @@ appraise "rails-7-0" do
 end
 
 appraise "rails-7-1" do
+  remove_gem "puma"
   gem "rails", "~> 7.1.0"
   gem "rspec-rails", "~> 7.0"
 end
 
 appraise "rails-7-2" do
+  remove_gem "puma"
   gem "rails", "~> 7.2.0"
   gem "rspec-rails", "~> 7.0"
 end
 
 appraise "rails-8" do
+  remove_gem "puma"
   gem "rails", "~> 8.0"
   gem "rspec-rails", "~> 7.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [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
+  the height we try to write in the png metadata to match.
+- Rust creates a ruby string with the binary png data so we don't need to convert with .pack("C*")
+- Himg::Error wraps errors from a Rust Result<_,Err>
+- Added OpenGraph metadata example
+- Default dimensions of 720x405 to match the ideal 16:9 ratio and image size
+  for sharing og-image on messengers and social media.
+
+## [0.0.2] - 2025-04-21
+
+- Adds Rails support via a ActionView template handler.
+  Takes views like `action.show.erb`, pre-processes them with Erb and renders
+  to a .png with 'image/png' set as the MIME type.
+- Adds a `ActionController::Renderer` so `render himg: '<div>Some HTML</div>'`
+  can be used either directly or from a `format.png`/`format.himg` block.
+
 ## [0.0.1] - 2025-04-19
 
 - Initial alpha

data/Cargo.lock

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

data/README.md

@@ -16,8 +16,7 @@ In Rails this will mean you can process user.himg.erb to display an image includ
 4. Network requests can be made: don't use this library with untrusted inputs.
 5. file:// URLs are resolved: this could expose files on your computer.
 6. Native extensions are not yet being published for different os/arch
-7. Error handling hasn't been added yet
-8. Verbose logging is hardcoded
+7. Verbose logging is hardcoded
 
 ## Installation
 
@@ -35,6 +34,16 @@ gem install himg
 
 ## Usage
 
+### Ruby
+
+```ruby
+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`!
@@ -43,6 +52,18 @@ Simply add a `show.himg.erb`!
 <div><%= @username %></div>
 ```
 
+### Adding OpenGraph Meta Tags
+
+Once you've added a view template for your resource, you can use it to generate image cards that will be shown when the page is shared on messenger apps or social media.
+
+```html
+<meta property="og:title" content="<%= @user.username %>" />
+<meta property="og:description" content="<%= @user.tagline %>" />
+<meta property="og:image" content="<%= user_url(@user.username, format: :png) %>" />
+```
+
+### Advanced Rails Usage
+
 A :himg template handler is registered and will be called by rails' `default_render` method automatically when the corresponding view is found. This can be `show.himg` for a static image, or `show.himg.erb` to use variables from the controller.
 
 If you prefer you could also use `render himg: "<div>My Data</div>"` instead, but should be careful with untrusted input if constructing HTML manually.
@@ -64,24 +85,31 @@ respond_to do |format|
 end
 ```
 
-### Run from Ruby
-
-```ruby
-png = Himg.render("<html bgcolor='blue'></html>") 
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ### Run directly from the command line to output an image
+
 ```bash
 bundle exec cargo run --example file
 bundle exec cargo run --example file -- path/to/file.html
 ```
 
+## Development
+
+1. Run `bin/setup` to install dependencies.
+2. Run `rake spec` to run the tests with the default development setup
+3. Run `appraisal rake spec` to run tests against different versions of rails and to confirm that the gem works in a plain ruby environment
+4. Run `bin/console` for an interactive prompt that will allow you to experiment.
+5. Run `RAILS_ENV=development bundle exec spec/dummy/dummy_rails server` to check the dummy app.
+  - http://localhost:3000/users/jamedjo.png will display an opengraph compatible png
+  - http://localhost:3000/users/jamedjo.himg will also render the same png
+  - http://localhost:3000/users/jamedjo will render an HTML page with opengraph meta tags
+6. To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releases
+
+To release a new version:
+1. Run `rake bump:patch` to update the version numbers in `version.rb` and `ext/himg/Cargo.toml`.
+3. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jamedjo/himg.

data/Rakefile

@@ -5,7 +5,9 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "standard/rake"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
 
 require "rb_sys/extensiontask"
 
@@ -17,4 +19,8 @@ RbSys::ExtensionTask.new("himg", GEMSPEC) do |ext|
   ext.lib_dir = "lib/himg"
 end
 
-task default: %i[compile standard]
+require "bump/tasks"
+Bump.replace_in_default = %w[Cargo.lock ext/himg/Cargo.toml]
+Bump.changelog = :editor
+
+task default: %i[compile rubocop]

data/Steepfile

@@ -17,13 +17,3 @@ target :lib do
   #   hash[D::Ruby::NoMethod] = :information
   # end
 end
-
-#target :test do
-#  unreferenced!                     # Skip type checking the `lib` code when types in `test` target is changed
-#  signature "sig/test"              # Put RBS files for tests under `sig/test`
-#  check "test"                      # Type check Ruby scripts under `test`
-
-#  configure_code_diagnostics(D::Ruby.lenient)      # Weak type checking for test code
-
-#  # library "pathname"              # Standard libraries
-#end

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.1"
+version = "0.0.4"
 edition = "2024"
 authors = ["James Edwards-Jones <git@jamedjo.co.uk>"]
 license = "MIT"

data/ext/himg/examples/file.rs

@@ -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
     };
@@ -43,7 +44,7 @@ async fn main() {
     let mut file = File::create(&out_path).unwrap();
 
     // Encode buffer as PNG and write it to a file
-    write_png(&mut file, &buffer, options.image_size.scaled_width(), options.image_size.scaled_height());
+    write_png(&mut file, &buffer, options.image_size.scaled_width(), options.image_size.scaled_height()).unwrap();
     logger.log("Wrote out png");
 
     logger.log_total_time("\nDone");

data/ext/himg/src/html_to_image.rs

@@ -11,12 +11,17 @@ use crate::image_size::ImageSize;
 use crate::logger::Logger;
 use crate::options::Options;
 
+pub struct RenderOutput {
+    pub buffer: Vec<u8>,
+    pub image_size: ImageSize,
+}
+
 pub async fn html_to_image(
     html: &str,
     base_url: Option<String>,
     options: Options,
     logger: &mut dyn Logger,
-) -> Vec<u8> {
+) -> RenderOutput {
     let (mut recv, callback) = MpscCallback::new();
     logger.log("Initial config");
 
@@ -59,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");
 
@@ -83,5 +92,8 @@ pub async fn html_to_image(
 
     logger.log("Rendered to buffer");
 
-    buffer
+    RenderOutput {
+        buffer: buffer,
+        image_size: render_size,
+    }
 }

data/ext/himg/src/lib.rs

@@ -1,50 +1,49 @@
-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::*, Error, Ruby};
-
-pub fn render_blocking(html: String) -> Vec<u8> {
-    tokio::runtime::Runtime::new()
-        .unwrap()
-        .block_on(render(html))
-}
+pub use renderer::render_blocking;
 
-pub async fn render(html: String) -> Vec<u8> {
-    let mut logger = TimedLogger::init();
+use crate::image_size::ImageSize;
+use crate::options::Options;
+use blitz_traits::ColorScheme;
+use magnus::{function, prelude::*, ExceptionClass, Error, Ruby, RString, RHash};
 
-    // Configure viewport dimensions
-    let options = Options {
-        image_size: ImageSize {
-            width: 1200, //TODO: pass this in
-            height: 800, //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
-    };
+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),
+        }
+    }
 
-    // Render to Image
-    //let base_url = format!("file://{}", path_string.clone());
-    let base_url = None;
-    let image_data = html_to_image(&html, base_url, options, &mut logger).await;
+    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
+        };
 
-    // Determine output path, and open a file at that path.
-    let mut output_buffer: Vec<u8> = Vec::new();
+        Ok(options)
+    }
+}
 
-    // Encode buffer as PNG and write it to a file
-    write_png(&mut output_buffer, &image_data, options.image_size.scaled_width(), options.image_size.scaled_height());
+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();
 
-    output_buffer
+    match render_blocking(html, options) {
+        Ok(data) => Ok(ruby.str_from_slice(&data)),
+        Err(e) => Err(Error::new(exception_class, format!("{}", e))),
+    }
 }
 
 #[magnus::init]
@@ -52,7 +51,8 @@ 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, 1))?;
+    module.define_singleton_method("render_to_string", function!(render_blocking_rb, 2))?;
+
     Ok(())
 }
 

data/ext/himg/src/options.rs

@@ -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

@@ -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/ext/himg/src/writer.rs

@@ -4,9 +4,9 @@ use png::{Encoder, ColorType, BitDepth, PixelDimensions, Unit};
 const INCHES_PER_METER: f64 = 39.3701;
 const DEFAULT_DPI: f64 = 144.0;
 
-pub fn write_png<W: Write>(writer: W, buffer: &[u8], width: u32, height: u32) {
+pub fn write_png<W: Write>(writer: W, buffer: &[u8], width: u32, height: u32) -> Result<(), std::io::Error> {
     let encoder = create_encoder(writer, width, height, DEFAULT_DPI);
-    write_data(encoder, buffer);
+    write_data(encoder, buffer)
 }
 
 fn create_encoder<'a, W: Write>(writer: W, width: u32, height: u32, dpi: f64) -> Encoder<'a, W> {
@@ -24,10 +24,11 @@ fn create_encoder<'a, W: Write>(writer: W, width: u32, height: u32, dpi: f64) ->
     encoder
 }
 
-fn write_data<W: Write>(encoder: Encoder<W>, buffer: &[u8]) {
-    //TODO: Better error handling instead of unwrap
-    let mut writer = encoder.write_header().unwrap();
+fn write_data<W: Write>(encoder: Encoder<W>, buffer: &[u8]) -> Result<(), std::io::Error> {
+    let mut writer = encoder.write_header()?;
 
-    writer.write_image_data(buffer).unwrap();
-    writer.finish().unwrap();
+    writer.write_image_data(buffer)?;
+    writer.finish()?;
+
+    Ok(())
 }

data/gemfiles/plain_ruby.gemfile

@@ -2,11 +2,4 @@
 
 source "https://rubygems.org"
 
-gem "irb"
-gem "rake", "~> 13.0"
-gem "rake-compiler"
-gem "rspec", "~> 3.0"
-gem "standard", "~> 1.3"
-gem "steep"
-
 gemspec path: "../"

data/gemfiles/plain_ruby.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.1)
+    himg (0.0.4)
       rb_sys (~> 0.9)
 
 GEM
@@ -28,10 +28,14 @@ GEM
     base64 (0.2.0)
     benchmark (0.4.0)
     bigdecimal (3.1.9)
+    bump (0.10.0)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.1)
     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)
     ffi (1.17.2)
@@ -118,24 +122,8 @@ GEM
     rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-performance (1.25.0)
-      lint_roller (~> 1.1)
-      rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    standard (1.49.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.75.2)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.8)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.8.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.25.0)
     steep (1.10.0)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.1.10)
@@ -171,7 +159,6 @@ PLATFORMS
   arm-linux-gnu
   arm-linux-musl
   arm64-darwin
-  ruby
   x86-linux-gnu
   x86-linux-musl
   x86_64-darwin
@@ -180,12 +167,14 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  bump
+  debug
   himg!
   irb
-  rake (~> 13.0)
+  rake
   rake-compiler
-  rspec (~> 3.0)
-  standard (~> 1.3)
+  rspec
+  rubocop
   steep
 
 BUNDLED WITH

data/gemfiles/rails_6.gemfile

@@ -2,12 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "irb"
-gem "rake", "~> 13.0"
-gem "rake-compiler"
-gem "rspec", "~> 3.0"
-gem "standard", "~> 1.3"
-gem "steep"
 gem "rails", "~> 6.0"
 gem "rspec-rails", "~> 6.0"
 gem "concurrent-ruby", "1.3.4"