rublurhash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc2c304918cc0a2252977c6f8b37d0f1fae6bef56ad5fb593e280f10ea6456a6
+  data.tar.gz: 9856f1092248faafde566dab16d6f9323970eb3c2aca77bcb0dfc9bbc20ab947
+SHA512:
+  metadata.gz: 399abf185bb1341ec074800f0cbb0070db3a0a9806f95ec0dd1bab8c62fd82d564fda595b63b9cf23a574a0a4e7ee9f4f1b27614e5079f9cddc1f1ac54bb69f5
+  data.tar.gz: ca4b37959603dcf9f52ed8f2d72fa14b06b14a03854d86d7aab633c46320529d7fbab856d11043de8bfdec04a41ab58fa6683eefa3c7c33781adcf1c908d1db5

data/.document

@@ -0,0 +1,3 @@
+README.md
+LICENSE
+sig/*.rbs

data/.gitignore

@@ -0,0 +1,8 @@
+Gemfile.lock
+vendor/
+target/
+lib/rublurhash.bundle
+ext/.future-incompat-report.json
+ext/.rustc_info.json
+ext/release/
+.yardoc/

data/.gitlab-ci.yml

@@ -0,0 +1,30 @@
+default:
+  image: registry.gitlab.com/kitaitimakoto/ruby-rust:ruby-4.0
+  before_script:
+    - gem update --system
+    - bundle config set path vendor/bundle
+    - bundle install
+  cache:
+    key: ruby:4.0
+    paths:
+      - vendoe/bundle
+      - ext/target
+
+test:
+  variables:
+    RB_SYS_FORCE_INSTALL_RUST_TOOLCHAIN: 'true'
+  script:
+    - bundle exec rake
+
+create-pages:
+  stage: deploy
+  script:
+    - bundle exec rake yard
+    - mv doc public
+  pages: true 
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+  

data/.yardopts

@@ -0,0 +1,4 @@
+--title RuBlurHash
+--exclude sig/test/**/*
+-
+LICENSE

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kitaiti Makoto
+
+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,127 @@
+RuBlurHash
+==========
+
+A Ruby binding for [blurhash-core][], a fast Rust implementation of [BlurHash][].
+
+SYNOPSIS
+--------
+
+    require "rublurhash"
+    require "magro"
+    require "ndav/numo/narray"
+    
+    image = Magro::IO.imread("path/to/image") # => Numo::UInt8[height, width, channels]
+    encoded = RuBlurHash.encode(image, components_x: 4, components_y: 3)
+    puts encoded # => Base83-encoded String
+    
+    decoded = RuBlurHash.decode(encoded, width: 400, height: 320, punch: 1.0) # => RuBlurHash::ImageString
+    Magro::IO.imsave "path/to/output", NDAV::Converter::NumoNArray(decoded)
+
+INSTALLATION
+------------
+
+    % gem install rublurhash
+
+Or,
+
+    % bundle add rublurhash
+
+USAGE
+-----
+
+`RuBlurHash` provides two module functions: `encode` and `decode`.
+
+### Encoding ###
+
+`RuBlurHash.encode` and `RuBlurHash#encode` accept a MemoryView producer along with the component counts, `components_x` and `components_y`.
+
+The first argument must be contiguous image data, with the shape of `[height, width, channels]` and the number of channels must be `3` which means RGB color pixels, and the format of `"C"` (unsigned 8-bit integers) or `NULL`.
+
+For an explanation of the components, see [BlurHash's README][components].
+
+    require "rublurhash"
+    require "magro"
+    require "ndav/numo/narray"
+    
+    image = Magro::IO.imread("path/to/image") # => Numo::UInt8[height, width, channels]
+    # Loading "ndav/numo/narray" makes Numo::NArray a MemoryView producer
+    encoded = RuBlurHash.encode(image, components_x: 4, components_y: 3)
+    puts encoded # => Base83-encoded String
+
+They also accept a flat Ruby `Array` of RGB pixel values, with the image with width and height.
+
+The array must be flat, which means `[R, G, B, R, G, B, ...]`. Its length should be width * height * channels(3).
+
+    require "rublurhash"
+    require "rmagick"
+
+    images = Magick::Image.read("path/to/image")
+    image = images[0]
+    encoded = RuBlurHash.encode(image.export_pixels, width: image.columns, height: image.rows, components_x: 4, components_y: 3)
+    puts encoded # => Base83-encoded String
+
+They also accept a binary Ruby `String` equivalent to the `Array` explained above.
+
+    encoded = RuBlurHash.encode(image.export_pixels_to_str, width: image.columns, height: image.rows, components_x: 4, components_y: 3)
+
+### Decoding ###
+
+`RuBlurHash.decode` and `RuBlurHash#decode` accept a Base83-encoded BlurHash `String` with `width`, `height` and `punch`.
+
+For an explanation of the `punch`, see [BlurHash's README][punch].
+
+    require "rublurhash"
+
+    decoded = RuBlurHash.decode("...blurhashstring...", width: 32, height: 32, punch: 1.0)
+    p decoded # => RuBlurHash::ImageString
+
+They return a `RuBlurHash::ImageString` object, which is a subclass of `String` and can be used wherever a `String` is expected.
+
+    File.write "raw-image", decoded
+    pixels = decoded.unpack("C*") # => Array
+    p pixels # => [R, G, B, R, G, B, ...]
+    
+    image = Magick::Image.new(width, height)
+    image.import_pixels 0, 0, width, height, "RGB", decoded
+
+`RuBlurHash::ImageString` exports a MemoryView.
+
+    require "fiddle"
+
+    Fiddle::MemoryView.export decoded do |view|
+      view.shape # => [height, width, channels]
+      view.format # => "C"
+    end
+    
+    require "magro"
+    require "ndav/numo/narray"
+    
+    numo = NDAV::Converter::NumoNArray(decoded) # => Numo::UInt8
+    Magro::IO.imsave "path/to/image", numo
+
+It also has attributes `width` and `height`.
+
+    decoded.width # => Integer
+    decoded.height # => Integer
+
+LIMITATIONS
+-----------
+
+* The encoding algorithm is suitable for practical use but not identical to the reference BlurHash implementation.
+
+SEE ALSO
+--------
+
+* [BlurHash official site][BlurHash]
+* [blurhash-core documentation][]
+
+LICENSE
+-------
+
+MIT license. See {file:LICENSE} file.
+
+[BlurHash]: https://blurha.sh/
+[blurhash-core]: https://crates.io/crates/blurhash-core
+[blurhash-core documentation]: https://docs.rs/blurhash-core/0.1.0/blurhash_core/
+[components]: https://github.com/woltapp/blurhash#how-do-i-pick-the-number-of-x-and-y-components
+[punch]: https://github.com/woltapp/blurhash#what-is-the-punch-parameter-in-some-of-these-implementations

data/Rakefile

@@ -0,0 +1,19 @@
+require "rake/clean"
+require "rake/testtask"
+require "rubygems/tasks"
+require "kar/dsl"
+require "steep/rake_task"
+require "yard"
+require "rdoc/task"
+
+multitask default: [:test, :steep]
+
+cargo "rublurhash"
+
+Rake::TestTask.new test: :cargo
+Gem::Tasks.new
+Steep::RakeTask.new
+YARD::Rake::YardocTask.new
+RDoc::Task.new do |t|
+  t.main = "README.md"
+end

data/Steepfile

@@ -0,0 +1,34 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  ignore_signature "sig/test"
+
+  check "lib"                       # Directory name
+  # check "path/to/source.rb"         # File name
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+
+  # RBSs for the gems in Gemfile.lock are loaded via rbs collection automatically.
+  # Set it up with `rbs collection init` and `rbs collection install`.
+  # library "monitor"               # Load an RBS that rbs collection doesn't manage
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   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 "fileutils", "tmpdir"
+  # library "monitor"               # Load an RBS that rbs collection doesn't manage
+end