image_util 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31687d0660e040e340b6ed26f581f95de0746e33f992acf7dfcdb4fa4a88f4cd
-  data.tar.gz: 4fee3793295fb2207a54caa1ed430bdc43ddc8307f96ef597ba0ed777618b8e6
+  metadata.gz: 2665eb7733f8fa7dc6e091d09a8ddc3315d0461395fd15aa1eb2c12ca9de9df6
+  data.tar.gz: bc5ced5903fa35dfbe03a05ae6aff8e797ca3c5d39407881c288168f5cbe51d1
 SHA512:
-  metadata.gz: c02064cb968adae5e5d5b5328922e77fd542d6ca4322a9259d27b513339ff44ca71e272f8cf01055d864f3dbc3fef702d3187a745e98af09a95f2dc9907470c4
-  data.tar.gz: 97c9852b31aab0d2b71f19579968d856fd87eed7339c3b2ec9e6bd1dcee3b674862821f6d4a033148db8d45b0a8228d890670d43c2f0ba921dc98d7d5ed774de
+  metadata.gz: caf2f99b10ff415168c0ac9defc7966d5e374d007a5859eab7580ae0865f6a6bc5203d116e094ca77dbbc26fcc69faaead7869b092297bc4a42749ae2a2f95cd
+  data.tar.gz: 66823c89ef52e3bb5c0927529c4dc99877253047a7659450da0d2a7bd7790944f836656b10c07bbbcb2eae40cb95ad95c694f5d69c2338a526fae36bfddedf21

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.5.0] - 2025-10-05
+- Add `ImageUtil::Inspectable` interface for other gems to use
+
+## [0.4.0] - 2025-10-04
+- BREAKING: Float color components now share the 0..255 range with integers instead of being scaled from 0..1.
+- Add `define_mutable_version` helper to create bang versions from immutable methods
+- Add `background!` and `resize!` filters
+
 ## [0.3.0] - 2025-07-25
 - Rename `dither!` to `palette_reduce!`
 - Rename `#set_each_pixel_by_location` to `#set_each_pixel_by_location!` since it's mutable

data/README.md

@@ -96,13 +96,13 @@ the earlier system packages. Both Kitty and SIXEL outputs also accept one-dimens
 - Symbols or strings containing CSS color names (`:rebeccapurple`, 'papayawhip')
 - Hex strings like `'#abc'`, `'#aabbcc'` or `'#rrggbbaa'`
 
-When numeric components are given, integers are first clamped to the `0..255`
-range. Float values are treated as fractions of 255, so `0.5` becomes `127.5`
-and `1.0` becomes `255`. After scaling, values are again clamped to this range.
-If the alpha channel is omitted it defaults to `255`.
+When numeric components are given, values are clamped directly to the `0..255`
+range regardless of whether they are integers or floats. Floating point inputs
+are no longer scaled from `0..1`; instead they are treated in the same units as
+integers. If the alpha channel is omitted it defaults to `255`.
 
 ```ruby
-ImageUtil::Color[0.5] # => #808080
+ImageUtil::Color[128.5] # => #808080
 ImageUtil::Color[:red] # => #ff0000
 ImageUtil::Color["#fc0"] # => #ffcc00
 ```
@@ -177,7 +177,8 @@ Flatten an RGBA image on a solid color.
 img = ImageUtil::Image.new(128, 128) { |x, y| [255, 0, 0, x + y] }
 
 # put it on a blue background
-img.background([0, 0, 255])
+img.background!([0, 0, 255])
+# img.background([0, 0, 255]) # returns a new image
 ```
 
 ![Background example](docs/samples/background.png)
@@ -216,6 +217,7 @@ Scale an image to new dimensions.
 img = ImageUtil::Image.new(128, 128) { |x, y| [x, y, 30] }
 img[20, 20] = img.resize(64, 64)
 img
+# img.resize!(64, 64) # modifies in place
 ```
 
 ![Resize example](docs/samples/resize.png)

data/lib/image_util/codec/image_magick.rb

@@ -64,20 +64,15 @@ module ImageUtil
             img = img.redimension(img.width, img.height + pad) if pad > 0
           end
           pam = Codec::Pam.encode(:pam, img)
-
-          IO.popen(["magick", "pam:-", "#{fmt}:-"], "r+b") do |proc_io|
-            proc_io << pam
-            proc_io.close_write
-            proc_io.read
-          end
         else
           frames = image.buffer.last_dimension_split.map { |b| Image.from_buffer(b) }
-          stream = frames.map { |f| Codec::Pam.encode(:pam, f) }.join
-          IO.popen(["magick", "pam:-", "#{fmt}:-"], "r+b") do |proc_io|
-            proc_io << stream
-            proc_io.close_write
-            proc_io.read
-          end
+          pam = frames.map { |f| Codec::Pam.encode(:pam, f) }.join
+        end
+
+        IO.popen(["magick", "pam:-", "#{fmt}:-"], "r+b") do |proc_io|
+          proc_io << pam
+          proc_io.close_write
+          proc_io.read
         end
       end
 

data/lib/image_util/color.rb

@@ -24,7 +24,7 @@ module ImageUtil
       when Integer
         number.clamp(0, 255)
       when Float
-        (number * 255).clamp(0, 255)
+        number.clamp(0, 255)
       else
         raise ArgumentError, "wrong type passed as component (passed: #{number})"
       end

data/lib/image_util/filter/_mixin.rb

@@ -11,6 +11,15 @@ module ImageUtil
         end
       end
 
+      def define_mutable_version(*names)
+        names.each do |name|
+          define_method("#{name}!") do |*args, **kwargs, &block|
+            initialize_from_buffer(public_send(name, *args, **kwargs, &block).buffer)
+            self
+          end
+        end
+      end
+
       def axis_to_number(axis)
         axis = 0 if axis == :x
         axis = 1 if axis == :y

data/lib/image_util/filter/background.rb

@@ -3,6 +3,7 @@
 module ImageUtil
   module Filter
     module Background
+      extend ImageUtil::Filter::Mixin
       def background(bgcolor)
         return self if channels == 3
 
@@ -18,6 +19,8 @@ module ImageUtil
         end
         img
       end
+
+      define_mutable_version :background
     end
   end
 end

data/lib/image_util/filter/resize.rb

@@ -3,6 +3,7 @@
 module ImageUtil
   module Filter
     module Resize
+      extend ImageUtil::Filter::Mixin
       def resize(*new_dimensions, view: View::Interpolated)
         src = self.view(view)
 
@@ -15,6 +16,8 @@ module ImageUtil
           src[*src_loc]
         end
       end
+
+      define_mutable_version :resize
     end
   end
 end

data/lib/image_util/image.rb

@@ -4,6 +4,8 @@ module ImageUtil
   class Image
     autoload :Buffer, "image_util/image/buffer"
 
+    include ImageUtil::Inspectable
+
     Util.irb_fixup
 
     ALL = nil..nil
@@ -211,14 +213,8 @@ module ImageUtil
       Codec.encode(:sixel, self)
     end
 
-    def pretty_print(p)
-      if (image = Terminal.output_image($stdin, $stdout, self))
-        p.flush
-        p.output << image
-        p.text("", 0)
-      else
-        super
-      end
+    def inspect_image
+      self
     end
 
     def pixel_count(locations) = location_expand(locations).first.reduce(:*)

data/lib/image_util/inspectable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ImageUtil
+  module Inspectable
+    def pretty_print(pp)
+      image = inspect_image
+      return super unless image.is_a?(ImageUtil::Image)
+
+      rendered = ImageUtil::Terminal.output_image($stdin, $stdout, image)
+      if rendered
+        pp.flush
+        pp.output << rendered
+        pp.text("", 0)
+      else
+        super
+      end
+    rescue LoadError
+      super
+    end
+
+    def inspect_image
+      raise NotImplementedError, "including classes must implement #inspect_image"
+    end
+  end
+end

data/lib/image_util/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImageUtil
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/image_util.rb

@@ -11,6 +11,7 @@ module ImageUtil
   autoload :Image, "image_util/image"
   autoload :Util, "image_util/util"
   autoload :Codec, "image_util/codec"
+  autoload :Inspectable, "image_util/inspectable"
   autoload :Magic, "image_util/magic"
   autoload :Extension, "image_util/extension"
   autoload :Filter, "image_util/filter"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_util
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - hmdne
@@ -134,6 +134,7 @@ files:
 - lib/image_util/generator/example/rose.png
 - lib/image_util/image.rb
 - lib/image_util/image/buffer.rb
+- lib/image_util/inspectable.rb
 - lib/image_util/magic.rb
 - lib/image_util/statistic.rb
 - lib/image_util/statistic/colors.rb
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple pixel buffers with SIXEL and codec helpers
 test_files: []