rqrcode_renderer 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a8be9d21f1aa3e90d969e929398b03f9c77ca0fb178f75038e9a74ec9173b8d2
4
+ data.tar.gz: 37b2edaa458da95fe9bbc76d27e5d4926b66e8781d41387795a0e23193cfb18e
5
+ SHA512:
6
+ metadata.gz: a9ba848e9854eab65591606411bd095caf45c9b5619fdae80fd335a752a2d15d08dd542fd05de96a64d762396ef93dfb2caa39b67be22d871febabfc4c94c0dc
7
+ data.tar.gz: 86c442f15eb4f8a8186293e63b59c22ff2856d4e0fa60ecf75ff2a836aea74b26e46410e6af3dd0b42db3ec7ffa71cc8dc441a8e5ae3db1decfcf4d86daa70ba
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ .rspec
11
+ .rspec_status
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at yaboo.ja@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ # Specify your gem's dependencies in rqrcode_renderer.gemspec
6
+ gemspec
7
+
8
+ gem 'rake', '~> 12.0'
9
+ gem 'rspec', '~> 3.0'
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 yaboojp
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # Render QR codes easily from your Rails application
2
+
3
+ This gem supports rendering either SVG or PNG, JPEG, and GIF formats.
4
+
5
+
6
+ ## Installation
7
+
8
+ Add the following to your `Gemfile`.
9
+
10
+ ```ruby
11
+ gem 'rqrcode_renderer'
12
+ ```
13
+
14
+ If you want to use the PNG, JPEG or GIF format, you will have to have **ImageMagick** installed on your system.
15
+ You will also want to add the **mini_magick** gem to your application's `Gemfile`.
16
+
17
+ ```ruby
18
+ gem 'mini_magick'
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ In your controller actions, you could return a QR code that links to the current page like this:
24
+
25
+ ```ruby
26
+ respond_to do |format|
27
+ format.svg { render qrcode: 'http://example.com/', offset: 10, color: 'FF0000' }
28
+ format.png { render qrcode: 'http://example.com/' }
29
+ format.gif { render qrcode: 'http://example.com/' }
30
+ format.jpeg { render qrcode: 'http://example.com/' }
31
+ end
32
+ ```
33
+
34
+ #### Options:
35
+
36
+ * `size` – This controls how big the QR Code will be. Smallest size will be chosen by default. Set to maintain consistent size.
37
+ * `level` – The error correction level, can be:
38
+ * Level `l` 7% of code can be restored
39
+ * Level `m` 15% of code can be restored
40
+ * Level `q` 25% of code can be restored
41
+ * Level `h` 30% of code can be restored (default :h)
42
+ * `offset` – Padding around the QR Code (e.g. 10)
43
+ * `color` – Foreground color for the code (e.g. "000000" or :black)
44
+
45
+ ## About
46
+
47
+ This project was inspired by [rqrcode-rails3](https://github.com/samvincent/rqrcode-rails3) that is no longer maintained.
48
+
49
+
50
+ QR codes are encoded by [rqrcode](https://github.com/whomwah/rqrcode)
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'bundler/gem_tasks'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'rqrcode_renderer'
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require 'irb'
15
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rqrcode_renderer/version'
4
+ require 'rqrcode_renderer/data'
5
+ require 'action_controller'
6
+
7
+ module RqrcodeRenderer
8
+ Mime::Type.register 'image/svg+xml', :svg unless Mime::Type.lookup_by_extension(:svg)
9
+ Mime::Type.register 'image/png', :png unless Mime::Type.lookup_by_extension(:png)
10
+ Mime::Type.register 'image/jpeg', :jpeg unless Mime::Type.lookup_by_extension(:jpeg)
11
+ Mime::Type.register 'image/gif', :gif unless Mime::Type.lookup_by_extension(:gif)
12
+
13
+ ActionController::Renderers.add :qrcode do |string, options|
14
+ data = RqrcodeRenderer::Data.build(string, request.format.symbol, options)
15
+ self.response_body = render_to_string(plain: data, template: nil)
16
+ end
17
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rqrcode_renderer/size_calculator'
4
+ require 'rqrcode'
5
+
6
+ module RqrcodeRenderer
7
+ class Data
8
+ class << self
9
+ def build(string, format, options)
10
+ size = options[:size] || RqrcodeRenderer::SizeCalculator.minimum_qr_size_from_string(string)
11
+ level = options[:level] || :h
12
+ color = options[:color] || '000000'
13
+ offset = options[:offset] || 0
14
+
15
+ qrcode = RQRCode::QRCode.new(string, size: size, level: level)
16
+
17
+ svg = qrcode.as_svg(color: color, offset: offset)
18
+
19
+ if format.to_s == 'svg'
20
+ svg
21
+ else
22
+ image = MiniMagick::Image.read(svg) { |i| i.format 'svg' }
23
+ image.format format
24
+ image.to_blob
25
+ end
26
+ end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RqrcodeRenderer
4
+ class SizeCalculator
5
+ # size - seems to follow this logic
6
+ # # | input | modules
7
+ # | size | created
8
+ #-------|-------|--------
9
+ # 1 | 7 | 21
10
+ # 2 | 14 | 25 (+4)
11
+ # 3 | 24 | 29 -
12
+ # 4 | 34 | 33 -
13
+ # 5 | 44 | 37 -
14
+ # 6 | 58 | 41 -
15
+ # 7 | 64 | 45 -
16
+ # 8 | 84 | 49 -
17
+ # 9 | 98 | 53 -
18
+ # 10 | 119 | 57 -
19
+ # 11 | 137 | 61 -
20
+ # 12 | 155 | 65 -
21
+ # 13 | 177 | 69 -
22
+ # 14 | 194 | 73 -
23
+
24
+ QR_CHAR_SIZE_VS_SIZE = [7, 14, 24, 34, 44, 58, 64, 84, 98, 119, 137, 155, 177, 194].freeze
25
+
26
+ class << self
27
+ def minimum_qr_size_from_string(string)
28
+ QR_CHAR_SIZE_VS_SIZE.each_with_index do |size, index|
29
+ return (index + 1) if string.size < size
30
+ end
31
+
32
+ # If it's particularly big, we'll try and create codes until it accepts
33
+ i = QR_CHAR_SIZE_VS_SIZE.size
34
+ begin
35
+ i += 1
36
+ RQRCode::QRCode.new(string, size: i)
37
+ i
38
+ rescue RQRCode::QRCodeRunTimeError
39
+ retry
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module RqrcodeRenderer
4
+ VERSION = '0.1.1'
5
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'lib/rqrcode_renderer/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'rqrcode_renderer'
7
+ spec.version = RqrcodeRenderer::VERSION
8
+ spec.authors = ['yaboojp']
9
+ spec.email = ['yaboo.ja@gmail.com']
10
+
11
+ spec.summary = 'Render QR codes with Rails.'
12
+ spec.description = 'Render QR codes with Rails.'
13
+ spec.homepage = 'https://github.com/yaboojp/rqrcode_renderer'
14
+ spec.license = 'MIT'
15
+ spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
16
+
17
+ # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
18
+
19
+ spec.metadata['homepage_uri'] = spec.homepage
20
+ spec.metadata['source_code_uri'] = 'https://github.com/yaboojp/rqrcode_renderer'
21
+ # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
22
+
23
+ # Specify which files should be added to the gem when it is released.
24
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
25
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
26
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
27
+ end
28
+ spec.bindir = 'exe'
29
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
30
+ spec.require_paths = ['lib']
31
+
32
+ spec.add_dependency 'rails', '>= 6.0'
33
+ spec.add_dependency 'rqrcode', '>= 1.2.0'
34
+ end
metadata ADDED
@@ -0,0 +1,86 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rqrcode_renderer
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - yaboojp
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-03-14 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '6.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '6.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rqrcode
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 1.2.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 1.2.0
41
+ description: Render QR codes with Rails.
42
+ email:
43
+ - yaboo.ja@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - CODE_OF_CONDUCT.md
50
+ - Gemfile
51
+ - LICENSE.txt
52
+ - README.md
53
+ - Rakefile
54
+ - bin/console
55
+ - bin/setup
56
+ - lib/rqrcode_renderer.rb
57
+ - lib/rqrcode_renderer/data.rb
58
+ - lib/rqrcode_renderer/size_calculator.rb
59
+ - lib/rqrcode_renderer/version.rb
60
+ - rqrcode_renderer.gemspec
61
+ homepage: https://github.com/yaboojp/rqrcode_renderer
62
+ licenses:
63
+ - MIT
64
+ metadata:
65
+ homepage_uri: https://github.com/yaboojp/rqrcode_renderer
66
+ source_code_uri: https://github.com/yaboojp/rqrcode_renderer
67
+ post_install_message:
68
+ rdoc_options: []
69
+ require_paths:
70
+ - lib
71
+ required_ruby_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: 2.6.0
76
+ required_rubygems_version: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - ">="
79
+ - !ruby/object:Gem::Version
80
+ version: '0'
81
+ requirements: []
82
+ rubygems_version: 3.1.4
83
+ signing_key:
84
+ specification_version: 4
85
+ summary: Render QR codes with Rails.
86
+ test_files: []