blurhash_ruby 0.0.14 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef513fb805c4bdc62e5236843403bb3af8cb06c034c48ac2abc1a9d94a6863e8
-  data.tar.gz: 037752a9951af438c498f2caf27ab31f3717023124fa3c7e4300761cbb7f8c12
+  metadata.gz: 315b833a934d58fd6e79ed73d3437b696d34f0627ecbab6d2daf1ca955b55b9b
+  data.tar.gz: d7edf9e3acea388dc8205644dbbcbe52e3f7ccd864f459b28dd9382706330e27
 SHA512:
-  metadata.gz: 751b20bc24a4a36e0f97121e1faabef567afdf04e3c9e69763b121a6c7c5c4e9746eeba1b38ef266467109985752868c9b9b26ec5930e2f0afff4f43a9a97e93
-  data.tar.gz: 4b69c4baef24c4e7d696a818b92a6d04d685a01c1c6f8865a84ce31d6102ab2709113ea72070220a87be349c832cc9c2ee49efef8a4e6fd3d82b6380b66eb217
+  metadata.gz: 5178d705ee916a4a8e1fc5904265dcd2b41ba8e9a35cbfd6033644dd5891a5f7d2f27c2fb48cbca2fb64468b2ee8c0e48332a0b9eaa4363b239e847a2b2ab96b
+  data.tar.gz: e74a6c098687d9b2e530a10698cf3303ef7f687a9b1b6bc37b1f8ab078d8fa5b1005f53d26acd3927ce3e791e60b4914efc8b3012b700f127e4a39a62fb54a9c

data/.gitignore

@@ -1,4 +1,5 @@
 tmp
-lib/blurhash_decoder/binary/*.bundle
-lib/blurhash_encoder/binary/*.bundle
-*.gem
+lib/blurhash_ruby/*.bundle
+lib/blurhash_encoder/*.bundle
+*.gem
+.DS_Store

data/README.md

@@ -1 +1,43 @@
 ## Blurhash Ruby
+Generate a compact representation of a placeholder for an image in Ruby that can be saved in database, returned as API response and can be displayed as a blurred preview before the real image loads. This gem provides different options depending on the use case, either you want to store blurhash representation of the image(about 20-30 characters) and decode on the fly or you want to directly store the more longer(about 150 characters) base64 representation to skip decoding step, choice is yours!!
+If you want to learn how blurhash works plese refer to the [original repository](https://github.com/woltapp/blurhash).
+
+### Why this gem?
+✅ No external dependencies \
+✅ Contains both encoder and decoder \
+✅ Faster than other ruby implementations 
+
+### Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'blurhash_ruby'
+```
+
+And then execute:
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+```ruby
+$ gem install blurhash_ruby
+```
+
+### Usage
+```ruby
+require 'blurhash_ruby'
+
+BlurhashRuby.encode_image('https://cdn.pixabay.com/photo/2018/01/14/23/12/nature-3082832_
+_480.jpg')
+# => "LMCFqys-0gIp-os,NHNI={s,R+I;"
+
+BlurhashRuby.decode_blurhash('LHB3~nxvjYax0Mo#o#t7-cayWBWE')
+# => "iVBORw0KGgoAAAANSUhEUgAAAAQAAAACCAYAAAB/qH1jAAAALElEQVR4XmMMSUj///3bB4YfX18xfP/xkYGFjdmQ4S8bA8Pv/z8ZOFl/MgAANdoP6+z0zPQAAAAASUVORK5CYII="
+```
+
+### Contributing
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request

data/Rakefile

@@ -1,9 +1,9 @@
 require "rake/extensiontask"
 
 Rake::ExtensionTask.new "blurhash_decoder" do |ext|
-  ext.lib_dir = 'lib/blurhash_decoder/binary'
+  ext.lib_dir = 'lib/blurhash_ruby'
 end
 
 Rake::ExtensionTask.new "blurhash_encoder" do |ext|
-  ext.lib_dir = 'lib/blurhash_encoder/binary'
+  ext.lib_dir = 'lib/blurhash_ruby'
 end

data/benchmark.rb

@@ -0,0 +1,21 @@
+require 'benchmark'
+require 'blurhash_ruby'
+require 'blurhash'
+require 'rmagick'
+
+Benchmark.bm do |x|
+    x.report { 
+        BlurhashRuby.encode_image('https://twilio-cms-prod.s3.amazonaws.com/images/MSjyG8qNtcrbONBpWKztYRJqSpr4R2M6K83KXW4dj05n5.width-1616.png')
+     }
+end 
+
+Benchmark.bm do |x|
+    x.report { 
+        image_url = 'https://twilio-cms-prod.s3.amazonaws.com/images/MSjyG8qNtcrbONBpWKztYRJqSpr4R2M6K83KXW4dj05n5.width-1616.png'
+        filename = 'in.png'
+        File.write filename, URI.open(image_url).read
+        file_path = Dir.pwd + "/#{filename}"
+        image = Magick::ImageList.new(file_path)
+        Blurhash.encode(image.columns, image.rows, image.export_pixels)
+     }
+end 

data/blurhash_ruby.gemspec

@@ -1,9 +1,6 @@
-# lib = File.expand_path('../lib/', __FILE__)
-# $:.unshift lib unless $:.include?(lib)
-
 Gem::Specification.new do |s|
     s.name        = 'blurhash_ruby'
-    s.version     = '0.0.14'
+    s.version     = '0.0.16'
     s.summary     = "A fast blurhash encoder/decoder gem!"
     s.description = "A fast blurhash encoder/decoder gem."
     s.authors     = ["Rabin Poudyal"]

data/ext/blurhash_decoder/blurhash_decoder.c

@@ -6,13 +6,13 @@
 
 VALUE DECODER = Qnil;  /* Ruby Module */
 
-VALUE method_decode(VALUE self, VALUE blurhash, VALUE heigh, VALUE widt, VALUE punc) {
+VALUE method_decode(VALUE self, VALUE path, VALUE blurhash, VALUE heigh, VALUE widt, VALUE punc) {
     const char * hash = StringValuePtr(blurhash);
     int height = NUM2INT(heigh);
     int width = NUM2INT(widt);
     int punch = NUM2INT(punc);
 
-    const char * output_file = "tmp/out.png";
+    const char * output_file = StringValuePtr(path);
 
     const int nChannels = 4;
 
@@ -34,6 +34,6 @@ VALUE method_decode(VALUE self, VALUE blurhash, VALUE heigh, VALUE widt, VALUE p
 void
 Init_blurhash_decoder(void) {
     DECODER = rb_define_module("DECODER");
-    rb_define_method(DECODER, "decode", method_decode, 4);
+    rb_define_method(DECODER, "decode", method_decode, 5);
 }
 

data/ext/blurhash_decoder/decode.h

@@ -1,6 +1,6 @@
 #ifndef __BLURHASH_DECODE_H__
 
-#define __BLURHASH_DECODE_H
+#define __BLURHASH_DECODE_H__
 
 #include <math.h>
 #include <stdbool.h>

data/ext/blurhash_decoder/extconf.rb

@@ -3,4 +3,4 @@ require "mkmf"
 abort "missing malloc()" unless have_func "malloc"
 abort "missing free()"   unless have_func "free"
 
-create_makefile("blurhash_decoder/blurhash_decoder")
+create_makefile("blurhash_ruby/blurhash_decoder")

data/ext/blurhash_encoder/blurhash_encoder.c

@@ -12,11 +12,11 @@ VALUE ENCODER = Qnil;  /* Ruby Module */
 
 const char *blurHashForFile(int xComponents, int yComponents,const char *filename);
 
-VALUE method_encode(VALUE self, VALUE x, VALUE y) {
+VALUE method_encode(VALUE self, VALUE path ,VALUE x, VALUE y) {
     int xComponents = NUM2INT(x);
     int yComponents = NUM2INT(y);
 
-    const char * input_file = "tmp/in.png";
+    const char * input_file = StringValuePtr(path);
 
     if(xComponents < 1 || xComponents > 8 || yComponents < 1 || yComponents > 8) {
 		fprintf(stderr, "Component counts must be between 1 and 8.\n");
@@ -47,6 +47,6 @@ const char *blurHashForFile(int xComponents, int yComponents,const char *filenam
 void
 Init_blurhash_encoder(void) {
     ENCODER = rb_define_module("ENCODER");
-    rb_define_method(ENCODER, "encode", method_encode, 2);
+    rb_define_method(ENCODER, "encode", method_encode, 3);
 }
 

data/ext/blurhash_encoder/extconf.rb

@@ -3,4 +3,4 @@ require "mkmf"
 abort "missing malloc()" unless have_func "malloc"
 abort "missing free()"   unless have_func "free"
 
-create_makefile("blurhash_encoder/blurhash_encoder")
+create_makefile("blurhash_ruby/blurhash_encoder")

data/lib/blurhash_ruby.rb

@@ -1,15 +1,31 @@
-require File.expand_path('../blurhash_encoder/blurhash_encoder', __FILE__)
-require File.expand_path('../blurhash_decoder/blurhash_decoder', __FILE__)
+require 'blurhash_ruby/blurhash_encoder'
+require 'blurhash_ruby/blurhash_decoder'
 
-class Blurhash 
-  def self.encode(image_url, x_comp = 4, y_comp = 3)
-    # Usage: Blurhash.encode('https://cdn.pixabay.com/photo/2018/01/14/23/12/nature-3082832__480.jpg')
-    BlurhashEncoder.new.blurhash(image_url, x_comp, y_comp)
+require 'open-uri'
+require 'base64'
+
+
+class BlurhashRuby
+  extend DECODER
+  extend ENCODER
+  
+  def self.encode_image(image_url, x_comp = 4, y_comp = 3)
+    # Usage: BlurhashRuby.encode_image('https://cdn.pixabay.com/photo/2018/01/14/23/12/nature-3082832__480.jpg')
+    filename = 'in.png'
+    File.write filename, URI.open(image_url).read
+    file_path = Dir.pwd + "/#{filename}"
+    encode(file_path, x_comp, y_comp)
   end
 
-  def self.decode(blurhash, height = 2, width = 4, punch = 1, as_img = false)
-    # Usage: Blurhash.decode('LHB3~nxvjYax0Mo#o#t7-cayWBWE')
-    hash = BlurhashDecoder.new.decode_blurhash(blurhash, height, width, punch)
-    as_img ? 'data:image/png;base64,' + hash : hash
+  def self.decode_blurhash(blurhash, height = 2, width = 4, punch = 1, as_img = false)
+    # Usage: BlurhashRuby.decode_blurhash('LHB3~nxvjYax0Mo#o#t7-cayWBWE')
+    filename = 'out.png'
+    file_path = Dir.pwd + "/#{filename}"
+
+    decode(file_path, blurhash, height, width, punch)
+    base64_image = File.open(file_path, "rb") do |file|
+      Base64.strict_encode64(file.read)
+    end
+    as_img ? 'data:image/png;base64,' + base64_image : base64_image
   end
-end
+end

data/run.sh

@@ -0,0 +1,6 @@
+gem uninstall blurhash_ruby
+rm -rf tmp/
+gem build blurhash_ruby.gemspec
+gem install blurhash_ruby-0.0.15.gem
+cd ..
+irb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blurhash_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.16
 platform: ruby
 authors:
 - Rabin Poudyal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies: []
 description: A fast blurhash encoder/decoder gem.
 email: rabin@trip101.com
@@ -23,6 +23,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- benchmark.rb
 - blurhash_ruby.gemspec
 - ext/blurhash_decoder/blurhash_decoder.c
 - ext/blurhash_decoder/decode.c
@@ -35,9 +36,8 @@ files:
 - ext/blurhash_encoder/extconf.rb
 - ext/blurhash_encoder/stb_image.h
 - ext/common.h
-- lib/blurhash_decoder/blurhash_decoder.rb
-- lib/blurhash_encoder/blurhash_encoder.rb
 - lib/blurhash_ruby.rb
+- run.sh
 homepage: https://rubygems.org/gems/blurhash_ruby
 licenses:
 - MIT

data/lib/blurhash_decoder/blurhash_decoder.rb

@@ -1,15 +0,0 @@
-require File.expand_path('lib/blurhash_decoder/binary/blurhash_decoder')
-require 'base64'
-
-class BlurhashDecoder
-  include DECODER
-
-  def decode_blurhash(blurhash, height, width, punch)
-    decode(blurhash, height, width, punch)
-    base64_image = File.open("tmp/out.png", "rb") do |file|
-      Base64.strict_encode64(file.read)
-    end
-    base64_image
-  end
-
-end

data/lib/blurhash_encoder/blurhash_encoder.rb

@@ -1,12 +0,0 @@
-require 'open-uri'
-require File.expand_path('lib/blurhash_encoder/binary/blurhash_encoder')
-
-class BlurhashEncoder
-  include ENCODER
-  
-  def blurhash(image_url, x, y)
-    File.write 'tmp/in.png', URI.open(image_url).read
-    encode(x,y)
-  end
-
-end