rqrcode 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dad1e83dc97d564e2ec828cb8ba389c222fa4ae7662d6feaaed36fbfea194ba
-  data.tar.gz: e3d901e23ba8dfb7cc6b300ae47bc11dcbc6913d2fce1a66824bffa670ca5cf5
+  metadata.gz: e194a5360a135a0ba06a0ea02e0ec9b6aa865e138e60a50176c45e148ed05178
+  data.tar.gz: bcc56e289e6f09f750409c5433d8edfb91808280c88880b99cee377743164f0b
 SHA512:
-  metadata.gz: 317ff35bc49042e5a7a0d9390c82051b9552bd5d2a4c7a56e99e2ea75e7d2d4cf9071516f1fb800e5fd1af3c964976c6354db675c33928a0fee99f54cf588a7c
-  data.tar.gz: 167fc518c536b3bf32699dc09952fc5068db81d44040b0b768a4a220186438076992a8a3deb5eb85537c651d1d47ddabe7d4b2a29fbc490027a157b8265e3f77
+  metadata.gz: 3b1ae5e3d66ab5de484c0f70dfd21efc683d5708128516c0da28a7aefdbe6be585a2a2c1939e49591fc9a3478f7ef9dfb96da8938871f83ce97bae5077aa0e41
+  data.tar.gz: d5df60860ebe56dae982aad6f01c11cd06fea0e324d543430d6694c663200e3aa48523082cd21af7d48cf229119bc117625cd714f6104975b4e9d8d4eeb7beef

data/CHANGELOG.md

@@ -7,13 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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 +43,7 @@ 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.0...HEAD
+[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.0)
       chunky_png (~> 1.0)
       rqrcode_core (~> 1.0)
 
@@ -18,7 +18,7 @@ GEM
     rake (13.0.3)
     regexp_parser (2.1.1)
     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)
@@ -65,4 +65,4 @@ DEPENDENCIES
   standardrb (~> 1.0)
 
 BUNDLED WITH
-   2.2.15
+   2.2.22

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
@@ -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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RQRCode
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 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.0
 platform: ruby
 authors:
 - Duncan Robertson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode_core
@@ -132,7 +132,9 @@ files:
 homepage: https://github.com/whomwah/rqrcode
 licenses:
 - MIT
-metadata: {}
+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:
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A library to encode QR Codes