rqrcode 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dad1e83dc97d564e2ec828cb8ba389c222fa4ae7662d6feaaed36fbfea194ba
-  data.tar.gz: e3d901e23ba8dfb7cc6b300ae47bc11dcbc6913d2fce1a66824bffa670ca5cf5
+  metadata.gz: 6d9f9771040408819ab4ae97bc5b0de8814863e5b9dba0402268799eb03350d9
+  data.tar.gz: 2f811a4fed92cfa3bed1fdbe8609c57910c76184c97eafb00985422d83c02385
 SHA512:
-  metadata.gz: 317ff35bc49042e5a7a0d9390c82051b9552bd5d2a4c7a56e99e2ea75e7d2d4cf9071516f1fb800e5fd1af3c964976c6354db675c33928a0fee99f54cf588a7c
-  data.tar.gz: 167fc518c536b3bf32699dc09952fc5068db81d44040b0b768a4a220186438076992a8a3deb5eb85537c651d1d47ddabe7d4b2a29fbc490027a157b8265e3f77
+  metadata.gz: 6ece7165b08b181bd62a10069d5b60a849e0887c1c775b625cf691d3f7a439f0a5701d3fa362fb1263d7aae425e9a8a18c706ac621efb7f8f97955f5e7e11dbc
+  data.tar.gz: '0479794cb35208cffebf7355cbb3517b394f14b8af04eeebbcf51b2afdafd35f088fe2f9a60daf55752594578231411468f6eef090bd20b4e0c4864ea1cb00e4'

data/.github/workflows/ruby.yml

@@ -14,10 +14,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}

data/CHANGELOG.md

@@ -7,13 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.1] - 2022-02-11
+
+- Added in a handler for when color arguments are passed in as symbols e.g `color: :yellow`. This also allows for the use of the `:currentColor` keyword. [#122]
+
+## [2.1.0] - 2021-08-26
+
+- Sync Gemfile.lock with `rqrcode_core.1.2.0` [Adds Multimode Support](https://github.com/whomwah/rqrcode_core#multiple-encoding-support)
+- Add badge for Standard linting
+
+### Changed
+
+- Corrected method name referred to in CHANGELOG.
+
 ## [2.0.0] - 2021-05-06
 
 ### Added
 
-- A new `use_path:` option on `.to_svg`. This uses a `<path>` node to greatly reduce the final SVG size. [#108]
-- A new `viewbox:` option on `.to_svg`. Replaces the `svg.width` and `svg.height` attribute with `svg.viewBox` to allow CSS scaling. [#112]
-- A new `svg_attributes:` option on `.to_svg`. Allows you to pass in custom SVG attributes to be used in the `<svg>` tag. [#113]
+- A new `use_path:` option on `.as_svg`. This uses a `<path>` node to greatly reduce the final SVG size. [#108]
+- A new `viewbox:` option on `.as_svg`. Replaces the `svg.width` and `svg.height` attribute with `svg.viewBox` to allow CSS scaling. [#112]
+- A new `svg_attributes:` option on `.as_svg`. Allows you to pass in custom SVG attributes to be used in the `<svg>` tag. [#113]
 
 ### Changed
 
@@ -34,6 +47,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - bump dependencies
 - fix `required_ruby_version` for Ruby 3 support
 
-[unreleased]: https://github.com/whomwah/rqrcode/compare/v2.0.0...HEAD
+[unreleased]: https://github.com/whomwah/rqrcode/compare/v2.1.1...HEAD
+[2.1.1]: https://github.com/whomwah/rqrcode/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/whomwah/rqrcode/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/whomwah/rqrcode/compare/v1.2.0...v2.0.0
 [1.2.0]: https://github.com/whomwah/rqrcode/compare/v1.1.1...v1.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rqrcode (2.0.0)
+    rqrcode (2.1.1)
       chunky_png (~> 1.0)
       rqrcode_core (~> 1.0)
 
@@ -11,14 +11,14 @@ GEM
     ast (2.4.2)
     chunky_png (1.4.0)
     diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (3.0.1.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
-    rqrcode_core (1.0.0)
+    rqrcode_core (1.2.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -32,27 +32,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.12.1)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.13.1)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    standard (1.0.5)
-      rubocop (= 1.12.1)
-      rubocop-performance (= 1.10.1)
+    standard (1.6.0)
+      rubocop (= 1.24.1)
+      rubocop-performance (= 1.13.1)
     standardrb (1.0.0)
       standard
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -65,4 +65,4 @@ DEPENDENCIES
   standardrb (~> 1.0)
 
 BUNDLED WITH
-   2.2.15
+   2.2.32

data/README.md

@@ -1,6 +1,7 @@
 # RQRCode
 
 ![](https://github.com/whomwah/rqrcode/actions/workflows/ruby.yml/badge.svg)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 
 [RQRCode](https://github.com/whomwah/rqrcode) is a library for creating and rendering QR codes into various formats. It has a simple interface with all the standard QR code options. It was adapted from the Javascript library by Kazuhiko Arase.
@@ -32,6 +33,7 @@ require "rqrcode"
 qr = RQRCode::QRCode.new("https://kyan.com")
 
 puts qr.to_s
+# to_s( dark: "x", light: " " ) # defaults
 
 xxxxxxx xxxxxxx  xxx  xxxxxxx
 x     x  x  xxx   xx  x     x
@@ -42,32 +44,46 @@ x     x  xxx x xx x x x     x
 ...
 ```
 
+Easy, but unlikely to be readable. For this you will need to use one of the many [rendering options](#render-types) below.
+
 ### Advanced Options
 
-These are the various QR Code generation options provided by [rqrqcode_core](https://github.com/whomwah/rqrcode_core).
+These are the various QR code generation options provided by the underlying [rqrcode_core](https://github.com/whomwah/rqrcode_core). You may actually only need this library if you don't need the various rendering options `rqrcode` provides, but just need the data structure.
 
 ```
-string - the string you wish to encode
+Expects a string or array (for multi-segment encoding) to be parsed in, other args are optional
+
+  data - the string, QRSegment or array of Hashes (with data:, mode: keys) you wish to encode
 
-size   - the size (Integer) of the qrcode (defaults to smallest size needed to encode the string)
+  size - the size (Integer) of the QR Code (defaults to smallest size needed to encode the data)
 
-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)
+  max_size - the max_size (Integer) of the QR Code (default RQRCodeCore::QRUtil.max_size)
 
-mode   - the mode of the qrcode (defaults to alphanumeric or byte_8bit, depending on the input data):
-  * :number
-  * :alphanumeric
-  * :byte_8bit
-  * :kanji
+  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)
+
+  mode - the mode of the QR Code (defaults to :alphanumeric or :byte_8bit, depending on the input data,
+         only used when data is a string):
+    * :number
+    * :alphanumeric
+    * :byte_8bit
+    * :kanji
 ```
 
 Example
 
-```
-qrcode = RQRCodeCore::QRCode.new('hello world', size: 1, level: :m, mode: :alphanumeric)
+```ruby
+simple_qrcode = RQRCodeCore::QRCode.new("https://kyan.com", size: 1, level: :m, mode: :alphanumeric)
+
+segment_qrcode = QRCodeCore::QRCode.new({ data: "foo", mode: :byte_8bit })
+
+multi_qrcode = RQRCodeCore::QRCode.new([
+  { data: 'foo', mode: :byte_8bit },
+  { data: 'bar1', mode: :alphanumeric }
+])
 ```
 
 ## Render types
@@ -83,9 +99,9 @@ Options:
 
 offset          - Padding around the QR Code in pixels
                   (default 0)
-fill            - Background color e.g "ffffff" or :white
+fill            - Background color e.g "ffffff" or :white or :currentColor
                   (default none)
-color           - Foreground color e.g "000" or :black
+color           - Foreground color e.g "000" or :black or :currentColor
                   (default "000")
 module_size     - The Pixel size of each module
                   (defaults 11)
@@ -114,10 +130,7 @@ svg = qrcode.as_svg(
   shape_rendering: "crispEdges",
   module_size: 11,
   standalone: true,
-  use_path: true,
-  svg_attributes: {
-    id: "myUniqueId"
-  }
+  use_path: true
 )
 ```
 

data/lib/rqrcode/export/svg.rb

@@ -76,12 +76,18 @@ module RQRCode
             path << edge_loop_string
           end
 
-          @result << %{<path d="#{path.join}" style="fill:##{color}" transform="translate(#{offset},#{offset}) scale(#{module_size})"/>}
+          # Prefix hexadecimal colors unless using a named color (symbol)
+          color = "##{color}" unless color.is_a?(Symbol)
+
+          @result << %{<path d="#{path.join}" style="fill:#{color}" transform="translate(#{offset},#{offset}) scale(#{module_size})"/>}
         end
       end
 
       class Rect < BaseOutputSVG
         def build(module_size, offset, color)
+          # Prefix hexadecimal colors unless using a named color (symbol)
+          color = "##{color}" unless color.is_a?(Symbol)
+
           @qrcode.modules.each_index do |c|
             tmp = []
             @qrcode.modules.each_index do |r|
@@ -89,7 +95,7 @@ module RQRCode
               x = r * module_size + offset
 
               next unless @qrcode.checked?(c, r)
-              tmp << %(<rect width="#{module_size}" height="#{module_size}" x="#{x}" y="#{y}" style="fill:##{color}"/>)
+              tmp << %(<rect width="#{module_size}" height="#{module_size}" x="#{x}" y="#{y}" style="fill:#{color}"/>)
             end
 
             @result << tmp.join
@@ -184,7 +190,9 @@ module RQRCode
         output_tag.build(module_size, offset, color)
 
         if fill
-          output_tag.result.unshift %(<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:##{fill}"/>)
+          # Prefix hexadecimal colors unless using a named color (symbol)
+          fill = "##{fill}" unless fill.is_a?(Symbol)
+          output_tag.result.unshift %(<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:#{fill}"/>)
         end
 
         if standalone

data/lib/rqrcode/qrcode/qrcode.rb

@@ -2,7 +2,7 @@
 
 require "forwardable"
 
-module RQRCode #:nodoc:
+module RQRCode # :nodoc:
   class QRCode
     extend Forwardable
     def_delegators :@qrcode, :to_s

data/lib/rqrcode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RQRCode
-  VERSION = "2.0.0"
+  VERSION = "2.1.1"
 end

data/rqrcode.gemspec

@@ -17,6 +17,10 @@ Gem::Specification.new do |spec|
   EOF
   spec.homepage = "https://github.com/whomwah/rqrcode"
   spec.license = "MIT"
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/whomwah/rqrcode/issues",
+    "changelog_uri" => "https://github.com/whomwah/rqrcode/blob/master/CHANGELOG.md"
+  }
 
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Duncan Robertson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode_core
@@ -132,8 +132,10 @@ files:
 homepage: https://github.com/whomwah/rqrcode
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/whomwah/rqrcode/issues
+  changelog_uri: https://github.com/whomwah/rqrcode/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A library to encode QR Codes
 test_files: []