ruby_rqrr 0.9.0.1

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["./ext/ruby_rqrr"]
+resolver = "2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Shawn Jordan
+
+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,50 @@
+# RubyRqrr
+
+RubyRqrr (Ruby RQ'er) is a Ruby gem that provides a simple interface to scan images for QR codes. It uses the [Rust crate RQrr](https://docs.rs/crate/rqrr/latest) under the hood to decode QR codes. This gem is a simple wrapper around the Rust crate to provide a Ruby interface.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ruby_rqrr
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ruby_rqrr
+```
+
+## Usage
+
+The gem provides a module `RubyRqrr` with a single method `detect_qrs_in_image` that takes an image file path as an argument and returns an array of QR codes found in the image.
+
+```ruby
+require 'ruby_rqrr'
+
+RubyRqrr.detect_qrs_in_image('path/to/image.png')
+["https://github.com/phchun/ruby_rqrr"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Versioning
+
+We will follow the RQrr versioning for the first three digits. The fourth digit will be used for RubyRqrr specific changes within that version of RQrr.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/phchun/ruby_rqrr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/phchun/ruby_rqrr/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubyRqrr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/phchun/ruby_rqrr/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("ruby_rqrr.gemspec")
+
+RbSys::ExtensionTask.new("ruby_rqrr", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/ruby_rqrr"
+end
+
+task default: %i[compile test standard]

data/ext/ruby_rqrr/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "ruby_rqrr"
+version = "0.9.0-1"
+edition = "2021"
+authors = ["Shawn Jordan <shawn.jordan@me.com>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+image = { version ="0.25.5" }
+magnus = { version = "0.6.2" }
+rqrr = { version = "0.9.0"}
+url = { version = "2.5.4" }

data/ext/ruby_rqrr/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("ruby_rqrr/ruby_rqrr")

data/ext/ruby_rqrr/src/lib.rs

@@ -0,0 +1,47 @@
+use image;
+use magnus::{
+    exception, exception::ExceptionClass, function, prelude::*, value::Lazy, Error, RArray,
+    RModule, Ruby,
+};
+use rqrr;
+use std::path::Path;
+
+static RUBY_RQRR: Lazy<RModule> = Lazy::new(|ruby| ruby.define_module("RubyRqrr").unwrap());
+
+static ERROR: Lazy<ExceptionClass> = Lazy::new(|ruby| {
+    ruby.get_inner(&RUBY_RQRR)
+        .define_error("Error", ruby.exception_standard_error())
+        .unwrap()
+});
+
+static QR_PARSE_ERROR: Lazy<ExceptionClass> = Lazy::new(|ruby| {
+    ruby.get_inner(&RUBY_RQRR)
+        .define_error("QrParseError", ruby.get_inner(&ERROR))
+        .unwrap()
+});
+
+fn detect_qrs_in_image(ruby: &Ruby, file_path: String) -> Result<RArray, Error> {
+    // Load the image
+    let img_file = image::open(Path::new(&file_path))
+        .map_err(|e| Error::new(exception::io_error(), e.to_string()))?
+        .to_luma8();
+    let mut img = rqrr::PreparedImage::prepare(img_file);
+    let grids = img.detect_grids();
+    let urls = RArray::new();
+
+    for grid in grids {
+        let (_, content) = grid
+            .decode()
+            .map_err(|e| Error::new(ruby.get_inner(&QR_PARSE_ERROR), e.to_string()))?;
+        urls.push(content)?;
+    }
+    Ok(urls)
+}
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    Lazy::force(&QR_PARSE_ERROR, ruby);
+    ruby.get_inner(&RUBY_RQRR)
+        .define_singleton_method("detect_qrs_in_image", function!(detect_qrs_in_image, 1))?;
+    Ok(())
+}

data/lib/ruby_rqrr/version.rb

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

data/lib/ruby_rqrr.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "ruby_rqrr/version"
+require_relative "ruby_rqrr/ruby_rqrr"
+
+module RubyRqrr
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/mise.toml

@@ -0,0 +1,3 @@
+[tools]
+ruby = "3.4.1"
+rust = "1.85.1"

data/sig/ruby_rqrr.rbs

@@ -0,0 +1,4 @@
+module RubyRqrr
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: ruby_rqrr
+version: !ruby/object:Gem::Version
+  version: 0.9.0.1
+platform: ruby
+authors:
+- Shawn Jordan
+bindir: exe
+cert_chain: []
+date: 2025-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.91
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.91
+description: This gem brings in a rust library (RQRR) to detect QR codes in images.
+email:
+- shawn.jordan@me.com
+executables: []
+extensions:
+- ext/ruby_rqrr/extconf.rb
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Cargo.lock
+- Cargo.toml
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/ruby_rqrr/Cargo.toml
+- ext/ruby_rqrr/extconf.rb
+- ext/ruby_rqrr/src/lib.rs
+- lib/ruby_rqrr.rb
+- lib/ruby_rqrr/version.rb
+- mise.toml
+- sig/ruby_rqrr.rbs
+homepage: https://gitlab.com/phchun/ruby_rqrr
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/phchun/ruby_rqrr
+  source_code_uri: https://gitlab.com/phchun/ruby_rqrr
+  changelog_uri: https://gitlab.com/phchun/ruby_rqrr/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Ruby Binding for Rust's RQRR'.
+test_files: []