himg 0.0.6-aarch64-linux-musl

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 (38) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/.rubocop.yml +20 -0
  4. data/.ruby-version +1 -0
  5. data/Appraisals +40 -0
  6. data/CHANGELOG.md +50 -0
  7. data/LICENSE-APACHE.txt +203 -0
  8. data/LICENSE-MIT.txt +21 -0
  9. data/README.md +173 -0
  10. data/Rakefile +26 -0
  11. data/Steepfile +19 -0
  12. data/ext/himg/examples/assets/github_profile.html +119 -0
  13. data/ext/himg/examples/assets/github_profile_offline.html +86 -0
  14. data/ext/himg/output/.gitkeep +0 -0
  15. data/gemfiles/plain_ruby.gemfile +5 -0
  16. data/gemfiles/plain_ruby.gemfile.lock +181 -0
  17. data/gemfiles/rails_6.gemfile +11 -0
  18. data/gemfiles/rails_6.gemfile.lock +320 -0
  19. data/gemfiles/rails_7_0.gemfile +11 -0
  20. data/gemfiles/rails_7_0.gemfile.lock +318 -0
  21. data/gemfiles/rails_7_1.gemfile +8 -0
  22. data/gemfiles/rails_7_1.gemfile.lock +334 -0
  23. data/gemfiles/rails_7_2.gemfile +8 -0
  24. data/gemfiles/rails_7_2.gemfile.lock +329 -0
  25. data/gemfiles/rails_8.gemfile +8 -0
  26. data/gemfiles/rails_8.gemfile.lock +329 -0
  27. data/lib/himg/3.2/himg.so +0 -0
  28. data/lib/himg/3.4/himg.so +0 -0
  29. data/lib/himg/base_url.rb +21 -0
  30. data/lib/himg/cli.rb +64 -0
  31. data/lib/himg/railtie/controller_config.rb +31 -0
  32. data/lib/himg/railtie/template_handler.rb +32 -0
  33. data/lib/himg/railtie.rb +49 -0
  34. data/lib/himg/version.rb +5 -0
  35. data/lib/himg.rb +26 -0
  36. data/readme_hero.svg +54 -0
  37. data/sig/himg.rbs +16 -0
  38. metadata +211 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: ddebde923a0d36dadd4a06eed31f45a027f39c0204d441db59179c1ae41148cc
4
+ data.tar.gz: be914e5e73cbe0634b347050c7ed0bcfec247a4f4c2e755458e5d900be229254
5
+ SHA512:
6
+ metadata.gz: 92f8bb52a4c534e8cf1e634ff4dc636ee2781f0fa4e92b5dd3ac3eb54f655ccdcdb45316b0b677c38f806bf087b89daadef3c1dd350d3f319505f1b500b79fee
7
+ data.tar.gz: 315c44e0ea5a00d2da6094fbfc29f5b29e21229ad6b75ee64939a88e2f7ea8ec9b22b58ccf5a9b1701bd15d2be6fa5abdf384574e514937e625a6f49aabdf1dc
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,20 @@
1
+ AllCops:
2
+ TargetRubyVersion: 3.1
3
+
4
+ Style/StringLiterals:
5
+ EnforcedStyle: double_quotes
6
+
7
+ Style/StringLiteralsInInterpolation:
8
+ EnforcedStyle: double_quotes
9
+
10
+ Style/FrozenStringLiteralComment:
11
+ Enabled: false
12
+
13
+ Metrics/BlockLength:
14
+ Enabled: false
15
+
16
+ Bundler/OrderedGems:
17
+ Enabled: false
18
+
19
+ Layout/ExtraSpacing:
20
+ Enabled: false
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 3.4.3
data/Appraisals ADDED
@@ -0,0 +1,40 @@
1
+ appraise "plain-ruby" do
2
+ remove_gem "rails"
3
+ remove_gem "puma"
4
+ end
5
+
6
+ appraise "rails-6" do
7
+ remove_gem "puma"
8
+ gem "rails", "~> 6.0"
9
+ gem "rspec-rails", "~> 6.0"
10
+ gem "concurrent-ruby", "1.3.4" # Logger dependency fix, see: https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
11
+ gem "bigdecimal", "~> 1.4" # See: https://github.com/rails/rails/issues/34822
12
+ gem "drb"
13
+ end
14
+
15
+ appraise "rails-7-0" do
16
+ remove_gem "puma"
17
+ gem "rails", "~> 7.0.0"
18
+ gem "rspec-rails", "~> 7.0"
19
+ gem "concurrent-ruby", "1.3.4" # Logger dependency fix, see: https://stackoverflow.com/questions/79360526/uninitialized-constant-activesupportloggerthreadsafelevellogger-nameerror
20
+ gem "bigdecimal", "~> 1.4" # See: https://github.com/rails/rails/issues/34822
21
+ gem "drb"
22
+ end
23
+
24
+ appraise "rails-7-1" do
25
+ remove_gem "puma"
26
+ gem "rails", "~> 7.1.0"
27
+ gem "rspec-rails", "~> 7.0"
28
+ end
29
+
30
+ appraise "rails-7-2" do
31
+ remove_gem "puma"
32
+ gem "rails", "~> 7.2.0"
33
+ gem "rspec-rails", "~> 7.0"
34
+ end
35
+
36
+ appraise "rails-8" do
37
+ remove_gem "puma"
38
+ gem "rails", "~> 8.0"
39
+ gem "rspec-rails", "~> 7.0"
40
+ end
data/CHANGELOG.md ADDED
@@ -0,0 +1,50 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.0.6] - 2025-07-23
4
+
5
+ - Added bin/himg CLI screenshot tool
6
+ - Added `base_url` option for configuring relative paths
7
+ - Added `disable_fetch` option for security hardening
8
+ - Fixed race conditions when failing to fetch resources
9
+
10
+ ## [0.0.5] - 2025-04-22
11
+
12
+ - Can configure `render himg: ""` with options including `width:`, `height:`,
13
+ `truncate:` and `verbose:`.
14
+ - Can use `himg_config` helper methods at controller level and action level
15
+ to set `@_himg_config`, which can then be passed to the renderer with
16
+ `render himg: "<!DOCTYPE html>", config: himg_config` as an alternative to
17
+ specifying config options individually to `ActionController::Rendering#render`.
18
+ - `himg_config` helpers can also be used to control the configuration of
19
+ template based default render, when not calling render manually within the
20
+ controller. This works because the template handler can access `@_himg_config`.
21
+ - Can use string width / height with Himg.render
22
+ - Disable detailed log timings by default. Can re-enable with verbose: true.
23
+ There is still some logging from blitz-net#fetch for http requests and for
24
+ blitz-html::DocumentHtmlParser#finish on unexpected tokens.
25
+
26
+ ## [0.0.4] - 2025-04-22
27
+
28
+ - Allow `width`, `height` and `truncate` to be passed to the render function.
29
+
30
+ ## [0.0.3] - 2025-04-22
31
+
32
+ - Ensure that when render height is expanded to fit the content that we update
33
+ the height we try to write in the png metadata to match.
34
+ - Rust creates a ruby string with the binary png data so we don't need to convert with .pack("C*")
35
+ - Himg::Error wraps errors from a Rust Result<_,Err>
36
+ - Added OpenGraph metadata example
37
+ - Default dimensions of 720x405 to match the ideal 16:9 ratio and image size
38
+ for sharing og-image on messengers and social media.
39
+
40
+ ## [0.0.2] - 2025-04-21
41
+
42
+ - Adds Rails support via a ActionView template handler.
43
+ Takes views like `action.show.erb`, pre-processes them with Erb and renders
44
+ to a .png with 'image/png' set as the MIME type.
45
+ - Adds a `ActionController::Renderer` so `render himg: '<div>Some HTML</div>'`
46
+ can be used either directly or from a `format.png`/`format.himg` block.
47
+
48
+ ## [0.0.1] - 2025-04-19
49
+
50
+ - Initial alpha
data/LICENSE-APACHE.txt ADDED
@@ -0,0 +1,203 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
203
+
data/LICENSE-MIT.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2025 James Edwards-Jones
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,173 @@
1
+ # Himg: The Hyper Image Generator
2
+
3
+ You give it HTML and it gives back an image!
4
+
5
+ Parses a minimal subset of HTML/CSS, fetches nested resources, renders an image on the GPU. No browser, no fuss.
6
+
7
+ ![Mockup showing HTML being transformed into a WhatsApp preview](/readme_hero.svg)
8
+
9
+ ## Quickstart
10
+
11
+ ### Command Line
12
+
13
+ ```bash
14
+ bin/himg screenshot path/to/your.html screenshot.png
15
+ bin/himg screenshot https://github.com/Jamedjo/himg himg.png --width=1024 --verbose --no-truncate
16
+ ```
17
+
18
+ ### Ruby
19
+
20
+ ```ruby
21
+ png = Himg.render("<!DOCTYPE html><body style='background:blue;'></body>")
22
+ File.open("blue.png", "wb"){|f| f.write(png) }
23
+ ```
24
+
25
+ ```ruby
26
+ png = Himg.render("<!DOCTYPE html><h1>Snapshot</h1>", width: 89, height: 5, truncate: false)
27
+ File.open("dynamic_height.png", "wb"){|f| f.write(png) }
28
+ ```
29
+
30
+ ### Rails
31
+
32
+ Simply add a `show.himg.erb`!
33
+
34
+ ```erb
35
+ <div><%= @username %></div>
36
+ ```
37
+
38
+ ### OpenGraph Meta Tags
39
+
40
+ OpenGraph tags let messenger apps and social media sites know to use your generated image as a thumbnail card for your website.
41
+
42
+ ```html
43
+ <meta property="og:title" content="<%= @user.username %>" />
44
+ <meta property="og:description" content="<%= @user.tagline %>" />
45
+ <meta property="og:image" content="<%= user_url(@user.username, format: :png) %>" />
46
+ ```
47
+
48
+ # Usage
49
+
50
+ Install the gem and add to the application's Gemfile by executing:
51
+
52
+ ```bash
53
+ bundle add himg
54
+ ```
55
+
56
+ ## Configuration
57
+
58
+ |Option | Description | Type | Default |
59
+ |-|-|-|-|
60
+ |width | Sets the width of the rendered content. | integer | 720 |
61
+ |height | Sets the desired height of the rendered output. | integer | 405 |
62
+ |truncate | Keeps the image height fixed instead of expanding to include the full page | bool | true |
63
+ |verbose | Enables detailed logging for debugging and profiling. | bool | false |
64
+ |base_url | Where relative paths are relative to for linked resources (stylesheets, images, fonts, etc) | string | nil |
65
+ |disable_fetch | Disables fetching linked resources from disk and network| bool | false |
66
+
67
+
68
+ ### Passing options to a Rails view template
69
+
70
+ Options can be set at a controller level using the `himg_config` helper method:
71
+ ```ruby
72
+ class UsersController < ActionController::Base
73
+ himg_config(verbose: true)
74
+ end
75
+ ```
76
+
77
+ These can be overridden at a view level:
78
+ ```ruby
79
+ class UsersController < ActionController::Base
80
+ def show
81
+ himg_config(width: params[:w]) if params[:w]
82
+
83
+ @user = User.new
84
+ end
85
+ ```
86
+
87
+ ### Rails manual render
88
+
89
+ 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.
90
+
91
+ Options can then be passed directly to the manual render:
92
+ ```ruby
93
+ render himg: '<!DOCTYPE html>', truncate: false
94
+ ```
95
+
96
+ Alternatively you can pass in options which have been set with `himg_config`:
97
+ ```ruby
98
+ render himg: '<!DOCTYPE html>', config: himg_config
99
+ ```
100
+
101
+ ### Rails `respond_to`
102
+
103
+ To be explicit in the controller you can also use `respond_to` style:
104
+
105
+ ```ruby
106
+ respond_to do |format|
107
+ format.html
108
+ format.himg
109
+ end
110
+ ```
111
+
112
+ You can also use this combined with a manual render:
113
+ ```ruby
114
+ respond_to do |format|
115
+ format.html
116
+ format.himg { render himg: '<h1 style="text-align: center;">Recent Users</h1>' }
117
+ format.png { render himg: '<div>For .png URLs</div>' }
118
+ end
119
+ ```
120
+
121
+ # How it works
122
+
123
+ No browser, just basics!
124
+
125
+ Himg calls through to the amazing blitz library, which uses Stylo to parse the CSS, servo/html5ever to parse the HTML, fetches network resources, builds a scene graph and hands over to vello to render an image.
126
+
127
+ Interaction between Ruby & Rust is done with the help of `magnus`, `rb_sys` and lots of glue code from the `oxidize-rb` team.
128
+
129
+ To play nicely with Rails a template handler is registered, which Rails' `default_render` method automatically calls 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. Additionally a Renderer is available with `render himg: 'content'` in case a view template is not needed.
130
+
131
+ ## CAVEATS
132
+
133
+ 1. This is **pre-alpha** software, don't expect it to work yet.
134
+ 2. Performance needs tuning. Both in the underlying blitz library and how data is passed between Rust and Ruby
135
+ 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.
136
+ 4. file:// URLs are resolved: this could expose files on your computer. Use `disable_fetch` if you don't need to fetch any resources.
137
+ 5. Native extensions are not yet being published for different os/arch
138
+
139
+ # Development
140
+
141
+ 1. Run `bin/setup` to install dependencies.
142
+ 2. Run `rake spec` to run the tests with the default development setup
143
+ 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
144
+ 4. Run `bin/console` for an interactive prompt that will allow you to experiment.
145
+ 5. Run `RAILS_ENV=development bundle exec spec/dummy/dummy_rails server` to check the dummy app.
146
+ - http://localhost:3000/users/jamedjo.png will display an opengraph compatible png
147
+ - http://localhost:3000/users/jamedjo.himg will also render the same png
148
+ - http://localhost:3000/users/jamedjo will render an HTML page with opengraph meta tags
149
+ 6. To install this gem onto your local machine, run `bundle exec rake install`.
150
+
151
+ ### Run cargo example directly generate image in Rust
152
+
153
+ ```bash
154
+ bundle exec cargo run --example file
155
+ bundle exec cargo run --example file -- path/to/file.html
156
+ ```
157
+ ## Releases
158
+
159
+ To release a new version:
160
+ 1. Run `rake bump:patch` to update the version numbers in `version.rb` and `ext/himg/Cargo.toml`.
161
+ 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).
162
+
163
+ ## Contributing
164
+
165
+ Bug reports and pull requests are welcome on GitHub at https://github.com/jamedjo/himg.
166
+
167
+ ## License
168
+
169
+ Copyright (c) 2025 James Edwards-Jones
170
+
171
+ This project is dual licenced under both the MIT and Apache 2.0 terms.
172
+
173
+ See: [MIT License](https://opensource.org/licenses/MIT) and [APACHE 2.0 License](http://www.apache.org/licenses/LICENSE-2.0)
data/Rakefile ADDED
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ require "rb_sys/extensiontask"
13
+
14
+ task build: :compile
15
+
16
+ GEMSPEC = Gem::Specification.load("himg.gemspec")
17
+
18
+ RbSys::ExtensionTask.new("himg", GEMSPEC) do |ext|
19
+ ext.lib_dir = "lib/himg"
20
+ end
21
+
22
+ require "bump/tasks"
23
+ Bump.replace_in_default = %w[Cargo.lock ext/himg/Cargo.toml]
24
+ Bump.changelog = :editor
25
+
26
+ task default: %i[compile rubocop]
data/Steepfile ADDED
@@ -0,0 +1,19 @@
1
+ D = Steep::Diagnostic
2
+
3
+ target :lib do
4
+ signature "sig"
5
+ ignore_signature "sig/test"
6
+
7
+ check "lib" # Directory name
8
+
9
+ # library "pathname" # Standard libraries
10
+ # library "strong_json" # Gems
11
+
12
+ # configure_code_diagnostics(D::Ruby.default) # `default` diagnostics setting (applies by default)
13
+ # configure_code_diagnostics(D::Ruby.strict) # `strict` diagnostics setting
14
+ # configure_code_diagnostics(D::Ruby.lenient) # `lenient` diagnostics setting
15
+ # configure_code_diagnostics(D::Ruby.silent) # `silent` diagnostics setting
16
+ # configure_code_diagnostics do |hash| # You can setup everything yourself
17
+ # hash[D::Ruby::NoMethod] = :information
18
+ # end
19
+ end