himg 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fc5224bd15d81a7d37a613be2ff4b648db40f6489898ef164c6144ae9e68e0f
-  data.tar.gz: 036c08c03d4cee6c08df32efeeddd2b334b43ba1e090a8f9e27196df4d401524
+  metadata.gz: 286080c98560f491c524867c0986edd71e7e14bc912a50a2a72d627d4cb22e34
+  data.tar.gz: 435a08c13f0211d694ca477d4ce8a7afba24c686d088a7b7831c0397177d127c
 SHA512:
-  metadata.gz: b0534b8ae5f8ba53db0173f71dc44742c3be7c4466dd5d76be6190ec7b7227a23c7e2135ea97d071de93667c339d2263e9adc43b7664db16803255e99a58b4bb
-  data.tar.gz: 2f72cfe20ac86a5243295073e6a152a76dcefb3192d860adb71510ed6fb59c841b58e1ed54ed7807979920dca0ae3cd8b7c478db214ff9b9df930f90531e070b
+  metadata.gz: d5ca027f7d92741dc71b872a5308a05228c9e7c7743ebcfd976175f3c4a5a0482d3831e0d3f664aa1a7870353e8d2d482c1e545b0fa558d802ca3131282323bd
+  data.tar.gz: e4a9e936a5d96a1574c9af213912bed55de8e25af94775007397a70a7bdebc9f5b41519fc35668738c0929e9f50821b18f1c58d0897f84443334fcba15b4973c

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,23 @@
 ## [Unreleased]
 
+## [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.3"
 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,12 @@ gem install himg
 
 ## Usage
 
+### Ruby
+
+```ruby
+png = Himg.render("<html bgcolor='blue'></html>") 
+```
+
 ### Rails
 
 Simply add a `show.himg.erb`!
@@ -43,6 +48,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 +81,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[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.3"
 edition = "2024"
 authors = ["James Edwards-Jones <git@jamedjo.co.uk>"]
 license = "MIT"

data/ext/himg/examples/file.rs

@@ -43,7 +43,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");
 
@@ -83,5 +88,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

@@ -11,22 +11,23 @@ pub use writer::write_png;
 pub use logger::{Logger, TimedLogger};
 
 use blitz_traits::{ColorScheme};
-use magnus::{function, prelude::*, Error, Ruby};
+use magnus::{function, prelude::*, ExceptionClass, Error, Ruby};
 
-pub fn render_blocking(html: String) -> Vec<u8> {
-    tokio::runtime::Runtime::new()
-        .unwrap()
-        .block_on(render(html))
+pub fn render_blocking(html: String) -> Result<Vec<u8>, std::io::Error> {
+    let runtime = tokio::runtime::Runtime::new()?;
+
+    runtime.block_on(render(html))
 }
 
-pub async fn render(html: String) -> Vec<u8> {
+// 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: 1200, //TODO: pass this in
-            height: 800, //TODO: decide if this will be fixed or dynamic from the document
+            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,
@@ -36,15 +37,24 @@ pub async fn render(html: String) -> Vec<u8> {
     // 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;
+    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, &image_data, options.image_size.scaled_width(), options.image_size.scaled_height());
+    write_png(&mut output_buffer, &render_output.buffer, render_output.image_size.scaled_width(), render_output.image_size.scaled_height())?;
+
+    Ok(output_buffer)
+}
 
-    output_buffer
+pub fn render_blocking_rb(ruby: &Ruby, html: String) -> Result<magnus::RString, magnus::Error> {
+    let exception_class = ExceptionClass::from_value(magnus::eval("Himg::Error").unwrap()).unwrap();
+
+    match render_blocking(html) {
+        Ok(data) => Ok(ruby.str_from_slice(&data)),
+        Err(e) => Err(Error::new(exception_class, format!("{}", e))),
+    }
 }
 
 #[magnus::init]
@@ -52,7 +62,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", function!(render_blocking_rb, 1))?;
+
     Ok(())
 }
 

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.2)
       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"

data/gemfiles/rails_6.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.1)
+    himg (0.0.2)
       rb_sys (~> 0.9)
 
 GEM
@@ -74,10 +74,14 @@ GEM
     base64 (0.2.0)
     bigdecimal (1.4.4)
     builder (3.3.0)
+    bump (0.10.0)
     concurrent-ruby (1.3.4)
     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)
@@ -129,21 +133,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.7-aarch64-linux-gnu)
+    nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-aarch64-linux-musl)
+    nokogiri (1.18.8-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-gnu)
+    nokogiri (1.18.8-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-musl)
+    nokogiri (1.18.8-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-musl)
+    nokogiri (1.18.8-x86_64-linux-musl)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)
@@ -240,10 +244,6 @@ 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)
     sprockets (4.2.2)
@@ -254,18 +254,6 @@ GEM
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       sprockets (>= 3.0.0)
-    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)
@@ -314,16 +302,18 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bigdecimal (~> 1.4)
+  bump
   concurrent-ruby (= 1.3.4)
+  debug
   drb
   himg!
   irb
   rails (~> 6.0)
-  rake (~> 13.0)
+  rake
   rake-compiler
-  rspec (~> 3.0)
+  rspec
   rspec-rails (~> 6.0)
-  standard (~> 1.3)
+  rubocop
   steep
 
 BUNDLED WITH

data/gemfiles/rails_7_0.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", "~> 7.0.0"
 gem "rspec-rails", "~> 7.0"
 gem "concurrent-ruby", "1.3.4"

data/gemfiles/rails_7_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.1)
+    himg (0.0.2)
       rb_sys (~> 0.9)
 
 GEM
@@ -80,10 +80,14 @@ GEM
     base64 (0.2.0)
     bigdecimal (1.4.4)
     builder (3.3.0)
+    bump (0.10.0)
     concurrent-ruby (1.3.4)
     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)
@@ -135,21 +139,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.7-aarch64-linux-gnu)
+    nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-aarch64-linux-musl)
+    nokogiri (1.18.8-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-gnu)
+    nokogiri (1.18.8-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-musl)
+    nokogiri (1.18.8-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-musl)
+    nokogiri (1.18.8-x86_64-linux-musl)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)
@@ -246,24 +250,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)
@@ -312,16 +300,18 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bigdecimal (~> 1.4)
+  bump
   concurrent-ruby (= 1.3.4)
+  debug
   drb
   himg!
   irb
   rails (~> 7.0.0)
-  rake (~> 13.0)
+  rake
   rake-compiler
-  rspec (~> 3.0)
+  rspec
   rspec-rails (~> 7.0)
-  standard (~> 1.3)
+  rubocop
   steep
 
 BUNDLED WITH

data/gemfiles/rails_7_1.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", "~> 7.1.0"
 gem "rspec-rails", "~> 7.0"
 

data/gemfiles/rails_7_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.1)
+    himg (0.0.2)
       rb_sys (~> 0.9)
 
 GEM
@@ -93,11 +93,15 @@ GEM
     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)
@@ -148,21 +152,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.7-aarch64-linux-gnu)
+    nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-aarch64-linux-musl)
+    nokogiri (1.18.8-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-gnu)
+    nokogiri (1.18.8-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-musl)
+    nokogiri (1.18.8-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-musl)
+    nokogiri (1.18.8-x86_64-linux-musl)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)
@@ -265,24 +269,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)
@@ -330,14 +318,16 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  bump
+  debug
   himg!
   irb
   rails (~> 7.1.0)
-  rake (~> 13.0)
+  rake
   rake-compiler
-  rspec (~> 3.0)
+  rspec
   rspec-rails (~> 7.0)
-  standard (~> 1.3)
+  rubocop
   steep
 
 BUNDLED WITH

data/gemfiles/rails_7_2.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", "~> 7.2.0"
 gem "rspec-rails", "~> 7.0"
 

data/gemfiles/rails_7_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.1)
+    himg (0.0.2)
       rb_sys (~> 0.9)
 
 GEM
@@ -87,11 +87,15 @@ GEM
     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)
@@ -142,21 +146,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.7-aarch64-linux-gnu)
+    nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-aarch64-linux-musl)
+    nokogiri (1.18.8-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-gnu)
+    nokogiri (1.18.8-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-musl)
+    nokogiri (1.18.8-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-musl)
+    nokogiri (1.18.8-x86_64-linux-musl)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)
@@ -259,24 +263,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)
@@ -325,14 +313,16 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  bump
+  debug
   himg!
   irb
   rails (~> 7.2.0)
-  rake (~> 13.0)
+  rake
   rake-compiler
-  rspec (~> 3.0)
+  rspec
   rspec-rails (~> 7.0)
-  standard (~> 1.3)
+  rubocop
   steep
 
 BUNDLED WITH

data/gemfiles/rails_8.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", "~> 8.0"
 gem "rspec-rails", "~> 7.0"
 

data/gemfiles/rails_8.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    himg (0.0.1)
+    himg (0.0.2)
       rb_sys (~> 0.9)
 
 GEM
@@ -87,11 +87,15 @@ GEM
     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)
@@ -142,21 +146,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.7-aarch64-linux-gnu)
+    nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-aarch64-linux-musl)
+    nokogiri (1.18.8-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-gnu)
+    nokogiri (1.18.8-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm-linux-musl)
+    nokogiri (1.18.8-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-musl)
+    nokogiri (1.18.8-x86_64-linux-musl)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)
@@ -259,24 +263,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)
@@ -325,14 +313,16 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  bump
+  debug
   himg!
   irb
   rails (~> 8.0)
-  rake (~> 13.0)
+  rake
   rake-compiler
-  rspec (~> 3.0)
+  rspec
   rspec-rails (~> 7.0)
-  standard (~> 1.3)
+  rubocop
   steep
 
 BUNDLED WITH

data/lib/himg/railtie/template_handler.rb

@@ -1,13 +1,17 @@
 module Himg
   class Railtie
+    # Handles .himg templates by calling through to Himg.render
     class TemplateHandler
-      def self.call(template, source)
+      def self.call(_template, source)
         <<-CODE
-          Himg.render(#{source.inspect}).pack("C*")
+          Himg.render(#{source.inspect})
         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)
@@ -17,7 +21,7 @@ module Himg
           output = begin
             #{preprocessed_view_code}
           end
-          Himg.render(output).pack("C*")
+          Himg.render(output)
         CODE
       end
     end
@@ -25,4 +29,4 @@ module Himg
 end
 
 ActionView::Template.register_template_handler :himg, Himg::Railtie::TemplateHandler
-ActionView::Template.register_template_handler 'himg.erb', Himg::Railtie::ErbTemplateHandler
+ActionView::Template.register_template_handler "himg.erb", Himg::Railtie::ErbTemplateHandler

data/lib/himg/railtie.rb

@@ -1,8 +1,26 @@
 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'
+        require "himg/railtie/template_handler"
       end
     end
 
@@ -11,9 +29,9 @@ module Himg
     end
 
     initializer "himg.controller_renderer" do
-      ActionController::Renderers.add :himg do |obj, options|
+      ActionController::Renderers.add :himg do |obj, _options|
         png_data = Himg.render(obj)
-        send_data png_data.pack("C*"), type: "image/png", disposition: "inline"
+        send_data png_data, type: "image/png", disposition: "inline"
       end
     end
   end

data/lib/himg/version.rb

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

data/lib/himg.rb

@@ -16,5 +16,5 @@ end
 #
 # Converts HTML to an Image for a minimal subset of HTML and CSS
 module Himg
-  #class Error < StandardError; end
+  class Error < StandardError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: himg
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - James Edwards-Jones
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: irb
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,21 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: steep
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: steep
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -163,7 +149,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generates images from a minimal subset of HTML and CSS
+description: You give it HTML and it renders an Image!
 email:
 - git@jamedjo.co.uk
 executables: []
@@ -172,8 +158,8 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
-- ".standard.yml"
 - Appraisals
 - CHANGELOG.md
 - Cargo.lock
@@ -212,7 +198,6 @@ files:
 - lib/himg/railtie/template_handler.rb
 - lib/himg/version.rb
 - sig/himg.rbs
-- test.html.rbd
 homepage: https://github.com/Jamedjo/Himg
 licenses:
 - MIT

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/standardrb/standard
-ruby_version: 3.1

data/test.html.rbd

@@ -1,5 +0,0 @@
-<div style="background-color: red; width: '100%'; height: '100%'>
-
-<h1>Hello World</h1>
-__From_Rust_Ruby__
-</div>