rqrcode_renderer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8be9d21f1aa3e90d969e929398b03f9c77ca0fb178f75038e9a74ec9173b8d2
+  data.tar.gz: 37b2edaa458da95fe9bbc76d27e5d4926b66e8781d41387795a0e23193cfb18e
+SHA512:
+  metadata.gz: a9ba848e9854eab65591606411bd095caf45c9b5619fdae80fd335a752a2d15d08dd542fd05de96a64d762396ef93dfb2caa39b67be22d871febabfc4c94c0dc
+  data.tar.gz: 86c442f15eb4f8a8186293e63b59c22ff2856d4e0fa60ecf75ff2a836aea74b26e46410e6af3dd0b42db3ec7ffa71cc8dc441a8e5ae3db1decfcf4d86daa70ba

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.rspec
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yaboo.ja@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rqrcode_renderer.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 yaboojp
+
+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 @@
+# Render QR codes easily from your Rails application
+
+This gem supports rendering either SVG or PNG, JPEG, and GIF formats.
+
+
+## Installation
+
+Add the following to your `Gemfile`.
+
+```ruby
+gem 'rqrcode_renderer'
+```
+
+If you want to use the PNG, JPEG or GIF format, you will have to have **ImageMagick** installed on your system.
+You will also want to add the **mini_magick** gem to your application's `Gemfile`.
+
+```ruby
+gem 'mini_magick'
+```
+
+## Usage
+
+In your controller actions, you could return a QR code that links to the current page like this:
+
+```ruby
+respond_to do |format|
+  format.svg  { render qrcode: 'http://example.com/', offset: 10, color: 'FF0000' }
+  format.png  { render qrcode: 'http://example.com/' }
+  format.gif  { render qrcode: 'http://example.com/' }
+  format.jpeg { render qrcode: 'http://example.com/' }
+end
+```
+
+#### Options:
+
+* `size`   – This controls how big the QR Code will be. Smallest size will be chosen by default. Set to maintain consistent size.
+* `level`  – The error correction level, can be:
+  * Level `l` 7%  of code can be restored
+  * Level `m` 15% of code can be restored
+  * Level `q` 25% of code can be restored
+  * Level `h` 30% of code can be restored (default :h)
+* `offset` – Padding around the QR Code (e.g. 10)
+* `color`  – Foreground color for the code (e.g. "000000" or :black)
+
+## About
+
+This project was inspired by [rqrcode-rails3](https://github.com/samvincent/rqrcode-rails3) that is no longer maintained.
+
+
+QR codes are encoded by [rqrcode](https://github.com/whomwah/rqrcode)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rqrcode_renderer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rqrcode_renderer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rqrcode_renderer/version'
+require 'rqrcode_renderer/data'
+require 'action_controller'
+
+module RqrcodeRenderer
+  Mime::Type.register 'image/svg+xml', :svg  unless Mime::Type.lookup_by_extension(:svg)
+  Mime::Type.register 'image/png',     :png  unless Mime::Type.lookup_by_extension(:png)
+  Mime::Type.register 'image/jpeg', :jpeg unless Mime::Type.lookup_by_extension(:jpeg)
+  Mime::Type.register 'image/gif', :gif unless Mime::Type.lookup_by_extension(:gif)
+
+  ActionController::Renderers.add :qrcode do |string, options|
+    data = RqrcodeRenderer::Data.build(string, request.format.symbol, options)
+    self.response_body = render_to_string(plain: data, template: nil)
+  end
+end

data/lib/rqrcode_renderer/data.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rqrcode_renderer/size_calculator'
+require 'rqrcode'
+
+module RqrcodeRenderer
+  class Data
+    class << self
+      def build(string, format, options)
+        size   = options[:size]  || RqrcodeRenderer::SizeCalculator.minimum_qr_size_from_string(string)
+        level  = options[:level] || :h
+        color  = options[:color] || '000000'
+        offset = options[:offset] || 0
+
+        qrcode = RQRCode::QRCode.new(string, size: size, level: level)
+
+        svg = qrcode.as_svg(color: color, offset: offset)
+
+        if format.to_s == 'svg'
+          svg
+        else
+          image = MiniMagick::Image.read(svg) { |i| i.format 'svg' }
+          image.format format
+          image.to_blob
+        end
+      end
+    end
+  end
+end

data/lib/rqrcode_renderer/size_calculator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RqrcodeRenderer
+  class SizeCalculator
+    # size - seems to follow this logic
+    #     # | input | modules
+    #       | size  | created
+    #-------|-------|--------
+    #     1 |     7 |      21
+    #     2 |    14 |      25 (+4)
+    #     3 |    24 |      29   -
+    #     4 |    34 |      33   -
+    #     5 |    44 |      37   -
+    #     6 |    58 |      41   -
+    #     7 |    64 |      45   -
+    #     8 |    84 |      49   -
+    #     9 |    98 |      53   -
+    #    10 |   119 |      57   -
+    #    11 |   137 |      61   -
+    #    12 |   155 |      65   -
+    #    13 |   177 |      69   -
+    #    14 |   194 |      73   -
+
+    QR_CHAR_SIZE_VS_SIZE = [7, 14, 24, 34, 44, 58, 64, 84, 98, 119, 137, 155, 177, 194].freeze
+
+    class << self
+      def minimum_qr_size_from_string(string)
+        QR_CHAR_SIZE_VS_SIZE.each_with_index do |size, index|
+          return (index + 1) if string.size < size
+        end
+
+        # If it's particularly big, we'll try and create codes until it accepts
+        i = QR_CHAR_SIZE_VS_SIZE.size
+        begin
+          i += 1
+          RQRCode::QRCode.new(string, size: i)
+          i
+        rescue RQRCode::QRCodeRunTimeError
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/rqrcode_renderer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RqrcodeRenderer
+  VERSION = '0.1.1'
+end

data/rqrcode_renderer.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rqrcode_renderer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rqrcode_renderer'
+  spec.version       = RqrcodeRenderer::VERSION
+  spec.authors       = ['yaboojp']
+  spec.email         = ['yaboo.ja@gmail.com']
+
+  spec.summary       = 'Render QR codes with Rails.'
+  spec.description   = 'Render QR codes with Rails.'
+  spec.homepage      = 'https://github.com/yaboojp/rqrcode_renderer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/yaboojp/rqrcode_renderer'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 6.0'
+  spec.add_dependency 'rqrcode', '>= 1.2.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rqrcode_renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- yaboojp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Render QR codes with Rails.
+email:
+- yaboo.ja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rqrcode_renderer.rb
+- lib/rqrcode_renderer/data.rb
+- lib/rqrcode_renderer/size_calculator.rb
+- lib/rqrcode_renderer/version.rb
+- rqrcode_renderer.gemspec
+homepage: https://github.com/yaboojp/rqrcode_renderer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yaboojp/rqrcode_renderer
+  source_code_uri: https://github.com/yaboojp/rqrcode_renderer
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Render QR codes with Rails.
+test_files: []