mini_vips 0.1.0-x86_64-linux-gnu

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4fa87f586b96d668f60325b73c6afe1a144f2144e5d08527406bd8967cfe9f4
+  data.tar.gz: f5a7137830fdbe15bd3615ac9cb73e2f13ec91b9992b08967a0ee9d6b7b55c39
+SHA512:
+  metadata.gz: e5082db7b6ebe0268643af75a60a4bafe254a6c4ec19edf6b691ae8a06e25871b5151b49503060a7e1b125004e1c84bf9c91a58d8209e30a37d12b2934b8df87
+  data.tar.gz: cbdcdf8c8f70b38655b04e952093791652c6a4fbb6c3f5564d2ad17fd9d55cdbae6169242f485c3ecb1ee7ab086663adf26b7f00a537d5a5362eb2e3ffa306d6

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-08-24
+
+### Added
+
+- `version` reports the linked libvips version.
+- `letter-avatar` creates a letter avatar with configurable dimensions and background color.
+- `dominant-color` reports a representative RGB color for an image.
+- `resize` supports cover and contain resizing, proportional scaling, maximum pixel limits, output quality, palette limits, and metadata removal.
+- `convert` converts SVG images to PNG within a caller-supplied pixel limit.
+- A bundled Noto Sans font for consistent letter-avatar rendering.
+- Precompiled glibc Linux and macOS gems for x86-64 and ARM64.
+
+[Unreleased]: https://github.com/discourse/mini_vips/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/discourse/mini_vips/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Discourse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,176 @@
+# mini_vips
+
+mini_vips packages the native libvips image operations used by [discourse/discourse](https://github.com/discourse/discourse).
+
+mini_vips requires libvips 8.13 or newer to be installed. Follow the [libvips building and installation instructions](https://github.com/libvips/libvips/wiki#building-and-installing) before using it. Precompiled versions of mini_vips are available for glibc Linux and macOS on x86-64 and ARM64.
+
+## Usage
+
+Add mini_vips to the application's `Gemfile`, then run `bundle install`:
+
+```ruby
+gem "mini_vips"
+```
+
+Use `MiniVips.executable` to access the CLI executable:
+
+```ruby
+require "mini_vips"
+
+MiniVips.executable
+```
+
+## CLI
+
+### `version`
+
+Print the linked libvips version.
+
+```text
+$ mini_vips version
+8.17.2
+```
+
+### `letter-avatar`
+
+Generate a square letter-avatar PNG, 360 by 360 pixels by default.
+
+```text
+$ mini_vips letter-avatar A avatar.png --background-color C67D28
+```
+
+```text
+usage:
+   letter-avatar letter out [--size pixels] [--letter-size pixels] [--background-color color]
+
+where:
+   letter             - Text displayed in the avatar
+   out                - Output PNG path
+
+options:
+   background-color   - Six-character RGB background color
+                        optional, default: 000000
+   size               - Output width and height in pixels
+                        optional, default: 360
+                        min: 1, max: 4096
+   letter-size        - Letter size in pixels
+                        optional, default: 7/9 of size
+                        min: 1, max: 4096
+```
+
+Letter avatars use the bundled Noto Sans font.
+
+### `resize`
+
+Resize a supported image and select the output format from the output filename.
+
+```text
+$ mini_vips resize avatar.png avatar-90.png --width 90 --height 90 --fit cover
+```
+
+```text
+usage:
+   resize in out (--width pixels --height pixels | --scale ratio | --max-pixels pixels)
+                 [--fit contain|cover] [--position center|top]
+                 [--without-enlargement] [--quality 1..100]
+                 [--colors count] [--strip-metadata]
+
+where:
+   in                    - Input image path
+   out                   - Output image path
+
+options:
+   width                 - Bounding-box or cover width in pixels
+   height                - Bounding-box or cover height in pixels
+                          use together, min: 1, max: 65535
+   scale                 - Proportional scale ratio
+                          min: greater than 0, max: 100
+   max-pixels            - Maximum output pixel area
+                          min: 1; never enlarges the image
+   fit                   - Fit within the dimensions or cover them exactly
+                          optional, default: contain
+   position              - Crop from the center or top when fit is cover
+                          optional, default: center
+   without-enlargement   - Keep an image within the requested dimensions at
+                          its original size when it is already smaller
+   quality               - Output encoder quality
+                          optional, min: 1, max: 100; unavailable for GIF
+   colors                - Maximum palette size for PNG or GIF output
+                          optional, min: 2, max: 256; rounded down to the
+                          nearest palette bit depth supported by the format
+   strip-metadata        - Remove image metadata from the output
+```
+
+Supported inputs are JPEG, PNG, GIF, WebP, HEIF, JPEG XL, and SVG. Supported outputs are JPEG, PNG, GIF, WebP, HEIF/AVIF, and JPEG XL. Resize uses the first frame of animated inputs, applies image orientation, preserves transparency when the output format supports it, and sharpens only images produced with `--fit cover`.
+
+### `dominant-color`
+
+Print a representative color as an uppercase six-character RGB value.
+
+```text
+$ mini_vips dominant-color image.png
+3A3730
+```
+
+```text
+usage:
+   dominant-color in
+
+where:
+   in                 - Input image path
+```
+
+Supported inputs are JPEG, PNG, GIF, WebP, HEIF, and JPEG XL. Transparent pixels contribute black when calculating the color.
+
+### `convert`
+
+Convert an SVG into an opaque PNG.
+
+```text
+$ mini_vips convert image.svg image.png --max-pixels 40000000
+```
+
+```text
+usage:
+   convert in out --max-pixels pixels
+
+where:
+   in                 - Input SVG path
+   out                - Output PNG path
+
+options:
+   max-pixels         - Maximum output pixel area
+                        required, min: 1
+```
+
+Currently, `convert` only supports SVG input and PNG output.
+
+### Exit status
+
+The executable returns:
+
+- `0` when the operation succeeds.
+- `1` when image processing fails.
+- `2` when the command or its arguments are invalid.
+
+Errors are written to standard error.
+
+## Development
+
+Install [libvips](https://github.com/libvips/libvips/wiki#building-and-installing) and pkg-config first. Then set up the repository once by installing its Ruby development dependencies:
+
+```sh
+bundle install
+```
+
+Use the default task during development. It compiles the native helper, runs the tests, and checks Ruby formatting and style:
+
+```sh
+bundle exec rake
+```
+
+Build, install, and test the platform gem with:
+
+```sh
+bundle exec rake test:installed
+```

data/lib/mini_vips/fonts/NotoSans-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2018 The Noto Project Authors (github.com/googlei18n/noto-fonts)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/lib/mini_vips/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MiniVips
+  VERSION = "0.1.0"
+end

data/lib/mini_vips.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "mini_vips/version"
+
+module MiniVips
+  EXECUTABLE_PATH = File.expand_path("../libexec/mini_vips", __dir__)
+  private_constant :EXECUTABLE_PATH
+
+  def self.executable
+    return EXECUTABLE_PATH if File.file?(EXECUTABLE_PATH) && File.executable?(EXECUTABLE_PATH)
+
+    raise "mini_vips executable is unavailable at #{EXECUTABLE_PATH}"
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: mini_vips
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: x86_64-linux-gnu
+authors:
+- Discourse
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- team@discourse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/mini_vips.rb
+- lib/mini_vips/fonts/NotoSans-OFL.txt
+- lib/mini_vips/fonts/NotoSans-Regular.ttf
+- lib/mini_vips/version.rb
+- libexec/mini_vips
+homepage: https://github.com/discourse/mini_vips
+licenses:
+- MIT
+- OFL-1.1
+metadata:
+  bug_tracker_uri: https://github.com/discourse/mini_vips/issues
+  changelog_uri: https://github.com/discourse/mini_vips/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/discourse/mini_vips
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Fixed-purpose libvips image operations for Discourse
+test_files: []