quirc 0.0.1

data/ext/quirc/extconf.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+ROOT = File.expand_path(File.join(__dir__, "..", ".."))
+SRC_DIR = File.join(__dir__, "embed")
+TMP_DIR = File.join(ROOT, "tmp", RUBY_PLATFORM)
+BUILD_DIR = File.join(TMP_DIR, "quirc-1.0")
+LIB_FILE = File.join(BUILD_DIR, "libquirc.a")
+
+def build_library
+  Dir.mkdir(BUILD_DIR) unless File.exist?(BUILD_DIR)
+  system({ "BUILD_DIR" => BUILD_DIR }, "make", "-C", SRC_DIR) or raise "Error building quirc"
+end
+
+find_header("quirc.h", "#{SRC_DIR}/lib") or missing("quirc.h")
+build_library
+$LOCAL_LIBS << LIB_FILE
+
+create_makefile("quirc/quirc")

data/ext/quirc/quirc.c

@@ -0,0 +1,92 @@
+#include <ruby.h>
+#include <quirc.h>
+
+static VALUE mQuirc, cDecoder, cResult;
+
+static void decoder_free(struct quirc *qr) {
+    quirc_destroy(qr);
+}
+
+static VALUE decoder_alloc(VALUE self) {
+    struct quirc *qr = quirc_new();
+    if (qr == NULL) {
+        rb_raise(rb_const_get(rb_cObject, rb_intern("NoMemoryError")), "Could not allocate memory");
+    }
+    return Data_Wrap_Struct(self, NULL, decoder_free, qr);
+}
+
+static VALUE decoder_m_initialize(VALUE self, VALUE width, VALUE height) {
+    struct quirc *qr;
+
+    Data_Get_Struct(self, struct quirc, qr);
+    if (quirc_resize(qr, NUM2INT(width), NUM2INT(height)) < 0) {
+        rb_raise(rb_const_get(rb_cObject, rb_intern("NoMemoryError")), "Could not allocate memory");
+    }
+    rb_iv_set(self, "@width", width);
+    rb_iv_set(self, "@height", height);
+
+    return Qnil;
+}
+
+static VALUE decoder_m_decode(VALUE self, VALUE image) {
+    struct quirc *qr;
+    int width, height, size;
+    uint8_t *buffer;
+    int num_codes;
+    VALUE results;
+
+    Check_Type(image, T_STRING);
+    Data_Get_Struct(self, struct quirc, qr);
+
+    buffer = quirc_begin(qr, &width, &height);
+    size = width * height;
+    if (RSTRING_LEN(image) != size) {
+        rb_raise(rb_const_get(rb_cObject, rb_intern("ArgumentError")), "Decoder is allocated for %dx%d images", width, height);
+    }
+    memcpy(buffer, StringValuePtr(image), size);
+    quirc_end(qr);
+
+    num_codes = quirc_count(qr);
+    results = rb_ary_new2(num_codes);
+    for (int i = 0; i < num_codes; i++) {
+        struct quirc_code code;
+        struct quirc_data data;
+        quirc_decode_error_t err;
+        VALUE item;
+
+        quirc_extract(qr, i, &code);
+        err = quirc_decode(&code, &data);
+        if (err) continue;
+
+        item = rb_class_new_instance(0, NULL, cResult);
+        rb_iv_set(item, "@version", INT2FIX(data.version));
+        rb_iv_set(item, "@ecc_level", INT2FIX(data.ecc_level));
+        rb_iv_set(item, "@mask", INT2FIX(data.mask));
+        rb_iv_set(item, "@data_type", INT2FIX(data.data_type));
+        rb_iv_set(item, "@payload", rb_str_freeze(rb_str_new((const char *) data.payload, data.payload_len)));
+        rb_iv_set(item, "@eci", INT2NUM(data.eci));
+        rb_ary_push(results, item);
+    }
+
+    return results;
+}
+
+void Init_quirc(void) {
+    mQuirc = rb_const_get(rb_cObject, rb_intern("Quirc"));
+    rb_define_const(mQuirc, "LIB_VERSION", rb_str_freeze(rb_str_new_cstr(quirc_version())));
+
+    cDecoder = rb_define_class_under(mQuirc, "Decoder", rb_cObject);
+    rb_define_alloc_func(cDecoder, decoder_alloc);
+    rb_define_method(cDecoder, "initialize", decoder_m_initialize, 2);
+    rb_define_method(cDecoder, "decode", decoder_m_decode, 1);
+    rb_define_attr(cDecoder, "width", 1, 0);
+    rb_define_attr(cDecoder, "height", 1, 0);
+
+    cResult = rb_define_class_under(mQuirc, "Result", rb_cObject);
+    rb_define_attr(cResult, "version", 1, 0);
+    rb_define_attr(cResult, "ecc_level", 1, 0);
+    rb_define_attr(cResult, "mask", 1, 0);
+    rb_define_attr(cResult, "data_type", 1, 0);
+    rb_define_attr(cResult, "payload", 1, 0);
+    rb_define_attr(cResult, "eci", 1, 0);
+}

data/lib/quirc.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Quirc
+  def self.decode(image, width=nil, height=nil)
+    width ||= image.public_send(:width)
+    height ||= image.public_send(:height)
+    if image.respond_to?(:to_grayscale_stream)
+      Decoder.new(width, height).decode(image.to_grayscale_stream)
+    else
+      Decoder.new(width, height).decode(image)
+    end
+  end
+end
+
+require "quirc/version"
+require "quirc/quirc"

data/lib/quirc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Quirc
+  VERSION = "0.0.1".freeze
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "oily_png"
+require "quirc"
+
+module TestHelpers
+  def image_fixture(*path)
+    ChunkyPNG::Image.from_file(File.join(__dir__, "fixtures", *path))
+  end
+end
+
+class Minitest::Spec
+  include TestHelpers
+end

data/test/test_decode.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "helper.rb"
+
+describe Quirc do
+  describe "error levels" do
+    it "should decode all error levels" do
+      %i[m l h q].each_with_index do |level, no|
+        image = image_fixture("hello-120-utf8-#{level}.png")
+        result = Quirc.decode(image).first
+        assert_equal no, result.ecc_level
+        assert_equal "Hello World!", result.payload
+      end
+    end
+  end
+
+  describe "errors" do
+    it "should throw error if image size is not equal to buffer" do
+      assert_raises ArgumentError, "Decoder is allocated for 1x2 images" do
+        Quirc::Decoder.new(1, 2).decode("abc")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: quirc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jacob Middag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby bindings for C library quirc that extracts and decode QR images
+email: jacob@gaddim.nl
+executables: []
+extensions:
+- ext/quirc/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- ext/quirc/embed/LICENSE
+- ext/quirc/embed/Makefile
+- ext/quirc/embed/lib/decode.c
+- ext/quirc/embed/lib/identify.c
+- ext/quirc/embed/lib/quirc.c
+- ext/quirc/embed/lib/quirc.h
+- ext/quirc/embed/lib/quirc_internal.h
+- ext/quirc/embed/lib/version_db.c
+- ext/quirc/extconf.rb
+- ext/quirc/quirc.c
+- lib/quirc.rb
+- lib/quirc/version.rb
+- test/fixtures/hello-120-utf8-h.png
+- test/fixtures/hello-120-utf8-l.png
+- test/fixtures/hello-120-utf8-m.png
+- test/fixtures/hello-120-utf8-q.png
+- test/helper.rb
+- test/test_decode.rb
+homepage: https://github.com/middagj/quirc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: QR decoder based on quirc
+test_files:
+- test/fixtures/hello-120-utf8-h.png
+- test/fixtures/hello-120-utf8-l.png
+- test/fixtures/hello-120-utf8-m.png
+- test/fixtures/hello-120-utf8-q.png
+- test/helper.rb
+- test/test_decode.rb