rqrcode 1.1.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818b3dab2ed7719eb45d3c4b02704258e92f4de8ec0fe4f7e9cbb62765aad507
-  data.tar.gz: 50efa7d1fe21cce41ea38d44b4864290110281fcfc6c575267550440acb7f41a
+  metadata.gz: e194a5360a135a0ba06a0ea02e0ec9b6aa865e138e60a50176c45e148ed05178
+  data.tar.gz: bcc56e289e6f09f750409c5433d8edfb91808280c88880b99cee377743164f0b
 SHA512:
-  metadata.gz: fbda3d6822ef41ce25fed16754a921ea964c8a5fcfe629975146d1733de49f08dc337fc6b2f2213160289d623618961eb04a5531a22329ade90ac0ba777f57ed
-  data.tar.gz: 1834cab154c5819319ccd2cb22e7c8fddaa6dcd680648693e29e8ce98cb9f92a0d12c5f8072f9fa40ae09b0ffcecafa02ede7a7d26fef611397a3f693e4d9512
+  metadata.gz: 3b1ae5e3d66ab5de484c0f70dfd21efc683d5708128516c0da28a7aefdbe6be585a2a2c1939e49591fc9a3478f7ef9dfb96da8938871f83ce97bae5077aa0e41
+  data.tar.gz: d5df60860ebe56dae982aad6f01c11cd06fea0e324d543430d6694c663200e3aa48523082cd21af7d48cf229119bc117625cd714f6104975b4e9d8d4eeb7beef

data/.github/workflows/ruby.yml

@@ -4,28 +4,25 @@ on:
   push:
     branches:
     - master
-    - release/*
   pull_request:
     branches:
     - master
 
 jobs:
-  build:
-    name: Test Ruby ${{ matrix.ruby_version }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+  Build:
     strategy:
+      fail-fast: false
       matrix:
-        ruby_version: [2.5.x, 2.6.x]
-        os: [ubuntu-latest]
-
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v1
-    - name: Use Ruby ${{ matrix.ruby_version }}
-      uses: actions/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby_version }}
-    - name: Gem install and test
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake test
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run Tests for Ruby ${{ matrix.ruby }} on ${{ matrix.os }}
+      run: bundle exec rake spec
+    - name: StandardRB check for Ruby ${{ matrix.ruby }} on ${{ matrix.os }}
+      run: bundle exec standardrb --format progress

data/.gitignore

@@ -10,4 +10,4 @@
 .rvmrc
 *.sublime-project
 *.sublime-workspace
-Gemfile.lock
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [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 `.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
+
+- README updated
+- Rakefile cleaned up. You can now just run `rake` which will run specs and fix linting using `standardrb`
+- Small documentation clarification [@smnscp](https://github.com/smnscp)
+- Bump `rqrcode_core` to `~> 1.0`
+
+### Breaking Change
+
+- The dependency `rqrcode_core-1.0.0` has a tiny breaking change to the `to_s` public method. https://github.com/whomwah/rqrcode_core/blob/master/CHANGELOG.md#breaking-changes
+
+## [1.2.0] - 2020-12-26
+
+### Changed
+
+- README updated
+- bump dependencies
+- fix `required_ruby_version` for Ruby 3 support
+
+[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

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    rqrcode (2.1.0)
+      chunky_png (~> 1.0)
+      rqrcode_core (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    chunky_png (1.4.0)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rqrcode_core (1.2.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.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)
+      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 (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.0.5)
+      rubocop (= 1.12.1)
+      rubocop-performance (= 1.10.1)
+    standardrb (1.0.0)
+      standard
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rqrcode!
+  rspec (~> 3.5)
+  standardrb (~> 1.0)
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -1,20 +1,22 @@
 # RQRCode
 
-![](https://github.com/whomwah/rqrcode/workflows/rqrcode/badge.svg)
+![](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.
 
 * QR code is trademarked by Denso Wave inc
-* Minimum Ruby version is `~> 2.3`
-* For `rqrcode` releases `< 1.0.0` please use [this README](https://github.com/whomwah/rqrcode/blob/cd2732a68434e6197c219e6c8cbdadfce0c4c4f3/README.md)
+* Minimum Ruby version is `>= 2.3`
+* For `rqrcode` releases `< 2.0.0` please use [this README](https://github.com/whomwah/rqrcode/blob/v1.2.0/README.md)
+* For `rqrcode` releases `< 1.0.0` please use [this README](https://github.com/whomwah/rqrcode/blob/v0.9.0/README.md)
 
 ## Installing
 
 Add this line to your application's `Gemfile`:
 
 ```ruby
-gem 'rqrcode'
+gem "rqrcode", "~> 2.0"
 ```
 
 or install manually:
@@ -26,100 +28,165 @@ gem install rqrcode
 ## Basic usage example
 
 ```ruby
-require 'rqrcode'
+require "rqrcode"
 
-qr = RQRCode::QRCode.new('http://github.com')
-result = ''
+qr = RQRCode::QRCode.new("https://kyan.com")
 
-qr.qrcode.modules.each do |row|
-  row.each do |col|
-    result << (col ? 'X' : 'O')
-  end
-
-  result << "\n"
-end
-
-puts result
+puts qr.to_s
+# to_s( dark: "x", light: " " ) # defaults
+
+xxxxxxx xxxxxxx  xxx  xxxxxxx
+x     x  x  xxx   xx  x     x
+x xxx x xx x x     xx x xxx x
+x xxx x      xx xx xx x xxx x
+x xxx x x x       xxx x xxx x
+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 of the qrcode (default 4)
+  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
 
-You can output your QR code in various forms. These are detailed below:
+You probably want to output your QR code in a specific format. We make this easy by providing a bunch of formats to choose from below, each with their own set of options:
 
-### as SVG
+### `as_svg`
 
 The SVG renderer will produce a stand-alone SVG as a `String`
 
+```
+Options:
+
+offset          - Padding around the QR Code in pixels
+                  (default 0)
+fill            - Background color e.g "ffffff" or :white
+                  (default none)
+color           - Foreground color e.g "000" or :black
+                  (default "000")
+module_size     - The Pixel size of each module
+                  (defaults 11)
+shape_rendering - SVG Attribute: auto | optimizeSpeed | crispEdges | geometricPrecision
+                  (defaults crispEdges)
+standalone      - Whether to make this a full SVG file, or only an svg to embed in other svg
+                  (default true)
+use_path        - Use <path> to render SVG rather than <rect> to significantly reduce size
+                  and quality. This will become the default in future versions.
+                  (default false)
+viewbox         - Replace the `svg.width` and `svg.height` attribute with `svg.viewBox` to
+                  allow CSS scaling
+                  (default false)
+svg_attributes  - A optional hash of custom <svg> attributes. Existing attributes will remain.
+                  (default {})
+```
+Example
 ```ruby
-require 'rqrcode'
+require "rqrcode"
 
 qrcode = RQRCode::QRCode.new("http://github.com/")
 
 # NOTE: showing with default options specified explicitly
 svg = qrcode.as_svg(
-  offset: 0,
-  color: '000',
-  shape_rendering: 'crispEdges',
-  module_size: 6,
-  standalone: true
+  color: "000",
+  shape_rendering: "crispEdges",
+  module_size: 11,
+  standalone: true,
+  use_path: true
 )
 ```
 
 ![QR code with github url](./images/github-qrcode.svg)
 
-### as ANSI
+### `as_png`
 
-The ANSI renderer will produce as a string with ANSI color codes.
+The will produce a PNG using the [ChunkyPNG gem](https://github.com/wvanbergen/chunky_png). The result will be a `ChunkyPNG::Image` instance.
 
-```ruby
-require 'rqrcode'
+```
+Options:
 
-qrcode = RQRCode::QRCode.new("http://github.com/")
+fill  - Background ChunkyPNG::Color, defaults to 'white'
+color - Foreground ChunkyPNG::Color, defaults to 'black'
 
-# NOTE: showing with default options specified explicitly
-svg = qrcode.as_ansi(
-  light: "\033[47m", dark: "\033[40m",
-  fill_character: '  ',
-  quiet_zone_size: 4
-)
-```
+When option :file is supplied you can use the following ChunkyPNG constraints:
 
-![QR code with github url](./images/ansi-screen-shot.png)
+color_mode  - The color mode to use. Use one of the ChunkyPNG::COLOR_* constants.
+              (defaults to 'ChunkyPNG::COLOR_GRAYSCALE')
+bit_depth   - The bit depth to use. This option is only used for indexed images.
+              (defaults to 1 bit)
+interlace   - Whether to use interlacing (true or false).
+              (defaults to ChunkyPNG default)
+compression - The compression level for Zlib. This can be a value between 0 and 9, or a
+              Zlib constant like Zlib::BEST_COMPRESSION
+              (defaults to ChunkyPNG default)
+
+There are two sizing algorithms.
+
+* Original that can result in blurry and hard to scan images
+* Google's Chart API inspired sizing that resizes the module size to fit within the given image size.
 
-### as PNG
+The Google one will be used when no options are given or when the new size option is used.
 
-The library can produce a PNG. Result will be a `ChunkyPNG::Image` instance.
+*Google Sizing*
+
+size            - Total size of PNG in pixels. The module size is calculated so it fits.
+                  (defaults to 120)
+border_modules  - Width of white border around the modules.
+                  (defaults to 4).
+
+-- DONT USE border_modules OPTION UNLESS YOU KNOW ABOUT THE QUIET ZONE NEEDS OF QR CODES --
+
+*Original Sizing*
+
+module_px_size  - Image size, in pixels.
+border          - Border thickness, in pixels
+
+It first creates an image where 1px = 1 module, then resizes.
+Defaults to 120x120 pixels, customizable by option.
+```
+
+Example
 
 ```ruby
-require 'rqrcode'
+require "rqrcode"
 
 qrcode = RQRCode::QRCode.new("http://github.com/")
 
@@ -128,50 +195,97 @@ png = qrcode.as_png(
   bit_depth: 1,
   border_modules: 4,
   color_mode: ChunkyPNG::COLOR_GRAYSCALE,
-  color: 'black',
+  color: "black",
   file: nil,
-  fill: 'white',
+  fill: "white",
   module_px_size: 6,
   resize_exactly_to: false,
   resize_gte_to: false,
   size: 120
 )
 
-IO.write("/tmp/github-qrcode.png", png.to_s)
+IO.binwrite("/tmp/github-qrcode.png", png.to_s)
 ```
 
 ![QR code with github url](./images/github-qrcode.png)
 
-### On the console ( just because you can )
 
-```ruby
-require 'rqrcode'
+### `as_ansi`
 
-qr = RQRCode::QRCode.new('http://kyan.com', size: 4, level: :h)
+The ANSI renderer will produce as a string with ANSI color codes.
 
-puts qr.to_s
 ```
+Options:
+
+light           - Foreground ANSI code
+                  (default "\033[47m")
+dark            - Background ANSI code
+                  (default "\033[40m")
+fill_character  - The written character
+                  (default '  ')
+quiet_zone_size - Padding around the edge
+                  (default 4)
+```
+Example
+```ruby
+require "rqrcode"
 
-Output:
+qrcode = RQRCode::QRCode.new("http://github.com/")
 
-```
-xxxxxxx   x x  xxx    xxxxxxx
-x     x  xxxxx  x x   x     x
-x xxx x    x x     x  x xxx x
-x xxx x  xxx  x xxx   x xxx x
-x xxx x xxx  x  x  x  x xxx x
-... etc
+# NOTE: showing with default options specified explicitly
+svg = qrcode.as_ansi(
+  light: "\033[47m", dark: "\033[40m",
+  fill_character: "  ",
+  quiet_zone_size: 4
+)
 ```
 
+![QR code with github url](./images/ansi-screen-shot.png)
+
 ## API Documentation
 
 [http://www.rubydoc.info/gems/rqrcode](http://www.rubydoc.info/gems/rqrcode)
 
+## Tests
+
+You can run the test suite using:
+
+```
+$ ./bin/setup
+$ rake      # runs specs and standard:fix
+$ rake spec # just runs the specs
+```
+
+or try the lib from the console with:
+
+```
+$ ./bin/console
+```
+
+## Linting
+
+The project uses [standardrb](https://github.com/testdouble/standard) and can be used with:
+
+```
+$ ./bin/setup
+$ rake standard # checks
+$ rake standard:fix # fixes
+```
+
 ## Contributing
+
+I am not currently accepting any new renderers as the current `as_png`, `as_svg` and `as_ansi` work for most cases. If you need something different from what's available, the [`rqrcode_core`](https://github.com/whomwah/rqrcode_core) gem gives you access to all the QR Code information you will need so makes it simple to generate your own.
+
+The motivation for the above is because the rendering side of this gem takes up the most time. It seems that many people want a slightly different version of a QR Code so supporting all the variations would be hard. The easiest way is to empower people to create their own versions which they can manage and share. This is what `rqrcode_core` does.
+
+Any contribution PR's will be greatly accepted. It's important that they are well tested and backwards compatible.
+
 * Fork the project
 * Send a pull request
 * Don't touch the .gemspec, I'll do that when I release a new version
 
+Thanks D.
+
 ## Authors
 
 Original RQRCode author: Duncan Robertson

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+begin
+  require "standard/rake"
+  require "rspec/core/rake_task"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+  RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+  task default: [:spec, "standard:fix"]
+rescue LoadError
+  # no standard/rspec available
+end

data/lib/rqrcode/export/ansi.rb

@@ -9,15 +9,15 @@ module RQRCode
       #
       # Options:
       # light: Foreground ("\033[47m")
-      # dark: Background ANSI code. ("\033[47m")
+      # dark: Background ANSI code. ("\033[40m")
       # fill_character: The written character. ('  ')
       # quiet_zone_size: (4)
       #
-      def as_ansi(options={})
+      def as_ansi(options = {})
         options = {
           light: "\033[47m",
           dark: "\033[40m",
-          fill_character: '  ',
+          fill_character: "  ",
           quiet_zone_size: 4
         }.merge(options)
 
@@ -39,15 +39,13 @@ module RQRCode
                 row << dark
                 previous_dark = true
               end
-              row << fill_character
-            else
+            elsif previous_dark != false
               # light
-              if previous_dark != false
-                row << light
-                previous_dark = false
-              end
-              row << fill_character
+              row << light
+              previous_dark = false
             end
+
+            row << fill_character
           end
 
           # add quiet zone
@@ -68,7 +66,7 @@ module RQRCode
         quiet_row = light + fill_character * width + normal
         quiet_rows = quiet_row * quiet_zone_size
 
-        return quiet_rows + output.join + quiet_rows
+        quiet_rows + output.join + quiet_rows
       end
     end
   end

data/lib/rqrcode/export/html.rb

@@ -6,7 +6,7 @@ module RQRCode
       #
       # Use this module to HTML-ify the QR code if you just want the default HTML
       def as_html
-        ['<table>', rows.as_html, '</table>'].join
+        ["<table>", rows.as_html, "</table>"].join
       end
 
       private
@@ -27,7 +27,7 @@ module RQRCode
 
       class Row < Struct.new(:qr, :qr_module, :row_index)
         def as_html
-          ['<tr>', cells.map(&:as_html).join, '</tr>'].join
+          ["<tr>", cells.map(&:as_html).join, "</tr>"].join
         end
 
         def cells
@@ -41,7 +41,7 @@ module RQRCode
         end
 
         def html_class
-          qr.checked?(row_index, col_index) ? 'black' : 'white'
+          qr.checked?(row_index, col_index) ? "black" : "white"
         end
       end
     end

data/lib/rqrcode/export/png.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'chunky_png'
+
+require "chunky_png"
 
 # This class creates PNG files.
 # Code from: https://github.com/DCarper/rqrcode
@@ -8,54 +9,61 @@ module RQRCode
     module PNG
       # Render the PNG from the QR Code.
       #
-      # There are two sizing algoritams.
-      #
-      # - Original that can result in blurry and hard to scan images
-      # - Google's Chart API inspired sizing that resizes the module size to fit within the given image size.
-      #
-      # The Googleis one will be used when no options are given or when the new size option is used.
-      #
       # Options:
       # fill  - Background ChunkyPNG::Color, defaults to 'white'
       # color - Foreground ChunkyPNG::Color, defaults to 'black'
       #
       # When option :file is supplied you can use the following ChunkyPNG constraints
-      # color_mode  - The color mode to use. Use one of the ChunkyPNG::COLOR_* constants. defaults to 'ChunkyPNG::COLOR_GRAYSCALE'
-      # bit_depth   - The bit depth to use. This option is only used for indexed images. defaults to '1' bit
-      # interlace   - Whether to use interlacing (true or false). defaults to ChunkyPNG default
-      # compression - The compression level for Zlib. This can be a value between 0 and 9, or a Zlib constant like Zlib::BEST_COMPRESSION, defaults to ChunkyPNG defaults
+      # color_mode  - The color mode to use. Use one of the ChunkyPNG::COLOR_* constants.
+      #               (defaults to 'ChunkyPNG::COLOR_GRAYSCALE')
+      # bit_depth   - The bit depth to use. This option is only used for indexed images.
+      #               (defaults to 1 bit)
+      # interlace   - Whether to use interlacing (true or false).
+      #               (defaults to ChunkyPNG default)
+      # compression - The compression level for Zlib. This can be a value between 0 and 9, or a
+      #               Zlib constant like Zlib::BEST_COMPRESSION
+      #               (defaults to ChunkyPNG default)
+      #
+      # There are two sizing algorithms.
+      #
+      # - Original that can result in blurry and hard to scan images
+      # - Google's Chart API inspired sizing that resizes the module size to fit within the given image size.
+      #
+      # The Googleis one will be used when no options are given or when the new size option is used.
       #
-      # *Googleis*
-      # size            - Total size of PNG in pixels. The module size is calculated so it fits. (defaults to 90)
-      # border_modules  - Width of white border around in modules. (defaults to 4).
+      # *Google*
+      # size            - Total size of PNG in pixels. The module size is calculated so it fits.
+      #                   (defaults to 120)
+      # border_modules  - Width of white border around in modules.
+      #                   (defaults to 4).
       #
       #  -- DONT USE border_modules OPTION UNLESS YOU KNOW ABOUT THE QUIET ZONE NEEDS OF QR CODES --
       #
       # *Original*
       # module_px_size  - Image size, in pixels.
-      # border - Border thickness, in pixels
+      # border          - Border thickness, in pixels
       #
       # It first creates an image where 1px = 1 module, then resizes.
-      # Defaults to 90x90 pixels, customizable by option.
+      # Defaults to 120x120 pixels, customizable by option.
       #
       def as_png(options = {})
         default_img_options = {
           bit_depth: 1,
           border_modules: 4,
           color_mode: ChunkyPNG::COLOR_GRAYSCALE,
-          color: 'black',
+          color: "black",
           file: false,
-          fill: 'white',
+          fill: "white",
           module_px_size: 6,
           resize_exactly_to: false,
           resize_gte_to: false,
           size: 120
         }
 
-        googleis = options.length == 0 || (options[:size] != nil)
+        googleis = options.length == 0 || !options[:size].nil?
         options = default_img_options.merge(options) # reverse_merge
-        fill   = ChunkyPNG::Color(options[:fill])
-        color  = ChunkyPNG::Color(options[:color])
+        fill = ChunkyPNG::Color(options[:fill])
+        color = ChunkyPNG::Color(options[:color])
         output_file = options[:file]
         module_px_size = nil
         border_px = nil
@@ -81,7 +89,7 @@ module RQRCode
           else
             options[:module_px_size]
           end
-          border_px = border *  module_px_size
+          border_px = border * module_px_size
           total_border_px = border_px * 2
           resize_to = options[:resize_exactly_to]
 
@@ -96,7 +104,7 @@ module RQRCode
             if @qrcode.checked?(x, y)
               (0...module_px_size).each do |i|
                 (0...module_px_size).each do |j|
-                  png[(y * module_px_size) + border_px + j , (x * module_px_size) + border_px + i] = color
+                  png[(y * module_px_size) + border_px + j, (x * module_px_size) + border_px + i] = color
                 end
               end
             end
@@ -112,7 +120,7 @@ module RQRCode
             color_mode: options[:color_mode],
             bit_depth: options[:bit_depth]
           }
-          constraints[:interlace]   = options[:interlace]   if options.has_key?(:interlace)
+          constraints[:interlace] = options[:interlace] if options.has_key?(:interlace)
           constraints[:compression] = options[:compression] if options.has_key?(:compression)
           png.save(output_file, constraints)
         end

data/lib/rqrcode/export/svg.rb

@@ -1,59 +1,198 @@
 # frozen_string_literal: true
 
 # This class creates a SVG files.
-# Code from: https://github.com/samvincent/rqrcode-rails3
+# Initial code from: https://github.com/samvincent/rqrcode-rails3
 module RQRCode
   module Export
     module SVG
+      class BaseOutputSVG
+        attr_reader :result
+
+        def initialize(qrcode)
+          @qrcode = qrcode
+          @result = []
+        end
+      end
+
+      class Path < BaseOutputSVG
+        def build(module_size, offset, color)
+          modules_array = @qrcode.modules
+          matrix_width = matrix_height = modules_array.length + 1
+          empty_row = [Array.new(matrix_width - 1, false)]
+          edge_matrix = Array.new(matrix_height) { Array.new(matrix_width) }
+
+          (empty_row + modules_array + empty_row).each_cons(2).with_index do |row_pair, row_index|
+            first_row, second_row = row_pair
+
+            # horizontal edges
+            first_row.zip(second_row).each_with_index do |cell_pair, column_index|
+              edge = case cell_pair
+              when [true, false] then Edge.new column_index + 1, row_index, :left
+              when [false, true] then Edge.new column_index, row_index, :right
+              end
+
+              (edge_matrix[edge.start_y][edge.start_x] ||= []) << edge if edge
+            end
+
+            # vertical edges
+            ([false] + second_row + [false]).each_cons(2).each_with_index do |cell_pair, column_index|
+              edge = case cell_pair
+              when [true, false] then Edge.new column_index, row_index, :down
+              when [false, true] then Edge.new column_index, row_index + 1, :up
+              end
+
+              (edge_matrix[edge.start_y][edge.start_x] ||= []) << edge if edge
+            end
+          end
+
+          edge_count = edge_matrix.flatten.compact.count
+          path = []
+
+          while edge_count > 0
+            edge_loop = []
+            next_matrix_cell = edge_matrix.find(&:any?).find { |cell| cell&.any? }
+            edge = next_matrix_cell.first
+
+            while edge
+              edge_loop << edge
+              matrix_cell = edge_matrix[edge.start_y][edge.start_x]
+              matrix_cell.delete edge
+              edge_matrix[edge.start_y][edge.start_x] = nil if matrix_cell.empty?
+              edge_count -= 1
+
+              # try to find an edge continuing the current edge
+              edge = edge_matrix[edge.end_y][edge.end_x]&.first
+            end
+
+            first_edge = edge_loop.first
+            edge_loop_string = SVG_PATH_COMMANDS[:move]
+            edge_loop_string += "#{first_edge.start_x} #{first_edge.start_y}"
+
+            edge_loop.chunk(&:direction).to_a[0...-1].each do |direction, edges|
+              edge_loop_string << "#{SVG_PATH_COMMANDS[direction]}#{edges.length}"
+            end
+            edge_loop_string << SVG_PATH_COMMANDS[:close]
+
+            path << edge_loop_string
+          end
+
+          @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)
+          @qrcode.modules.each_index do |c|
+            tmp = []
+            @qrcode.modules.each_index do |r|
+              y = c * module_size + offset
+              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}"/>)
+            end
+
+            @result << tmp.join
+          end
+        end
+      end
+
+      class Edge < Struct.new(:start_x, :start_y, :direction)
+        def end_x
+          case direction
+          when :right then start_x + 1
+          when :left then start_x - 1
+          else start_x
+          end
+        end
+
+        def end_y
+          case direction
+          when :down then start_y + 1
+          when :up then start_y - 1
+          else start_y
+          end
+        end
+      end
+
+      DEFAULT_SVG_ATTRIBUTES = [
+        %(version="1.1"),
+        %(xmlns="http://www.w3.org/2000/svg"),
+        %(xmlns:xlink="http://www.w3.org/1999/xlink"),
+        %(xmlns:ev="http://www.w3.org/2001/xml-events")
+      ]
+
+      SVG_PATH_COMMANDS = {
+        move: "M",
+        up: "v-",
+        down: "v",
+        left: "h-",
+        right: "h",
+        close: "z"
+      }
+
       #
       # Render the SVG from the Qrcode.
       #
       # Options:
-      # offset - Padding around the QR Code (e.g. 10)
-      # fill - Background color (e.g "ffffff" or :white)
-      # color - Foreground color for the code (e.g. "000000" or :black)
-      # module_size - The Pixel size of each module (e.g. 11)
-      # shape_rendering - Defaults to crispEdges
-      # standalone - wether to make this a full SVG file, or only svg to embed
-      #              in other svg.
+      # offset          - Padding around the QR Code in pixels
+      #                   (default 0)
+      # fill            - Background color e.g "ffffff"
+      #                   (default none)
+      # color           - Foreground color e.g "000"
+      #                   (default "000")
+      # module_size     - The Pixel size of each module
+      #                   (defaults 11)
+      # shape_rendering - SVG Attribute: auto | optimizeSpeed | crispEdges | geometricPrecision
+      #                   (defaults crispEdges)
+      # standalone      - Whether to make this a full SVG file, or only an svg to embed in other svg
+      #                   (default true)
+      # use_path        - Use <path> to render SVG rather than <rect> to significantly reduce size
+      #                   and quality. This will become the default in future versions.
+      #                   (default false)
+      # viewbox         - replace `width` and `height` in <svg> with a viewBox, allows CSS scaling
+      #                   (default false)
+      # svg_attributes  - A optional hash of custom <svg> attributes. Existing attributes will remain.
+      #                   (default {})
       #
-      def as_svg(options={})
+      def as_svg(options = {})
+        fill = options[:fill]
+        use_path = options[:use_path]
         offset = options[:offset].to_i || 0
         color = options[:color] || "000"
         shape_rendering = options[:shape_rendering] || "crispEdges"
         module_size = options[:module_size] || 11
         standalone = options[:standalone].nil? ? true : options[:standalone]
+        viewbox = options[:viewbox].nil? ? false : options[:viewbox]
+        svg_attributes = options[:svg_attributes] || {}
 
         # height and width dependent on offset and QR complexity
-        dimension = (@qrcode.module_count*module_size) + (2*offset)
+        dimension = (@qrcode.module_count * module_size) + (2 * offset)
+        # use dimensions differently if we are using a viewBox
+        dimensions_attr = viewbox ? %(viewBox="0 0 #{dimension} #{dimension}") : %(width="#{dimension}" height="#{dimension}")
 
-        xml_tag = %{<?xml version="1.0" standalone="yes"?>}
-        open_tag = %{<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ev="http://www.w3.org/2001/xml-events" width="#{dimension}" height="#{dimension}" shape-rendering="#{shape_rendering}">}
-        close_tag = "</svg>"
+        svg_tag_attributes = (DEFAULT_SVG_ATTRIBUTES + [
+          dimensions_attr,
+          %(shape-rendering="#{shape_rendering}")
+        ] + svg_attributes.map { |k, v| %(#{k}="#{v}") }).join(" ")
 
-        result = []
-        @qrcode.modules.each_index do |c|
-          tmp = []
-          @qrcode.modules.each_index do |r|
-            y = c*module_size + offset
-            x = r*module_size + offset
+        xml_tag = %(<?xml version="1.0" standalone="yes"?>)
+        open_tag = %(<svg #{svg_tag_attributes}>)
+        close_tag = "</svg>"
 
-            next unless @qrcode.checked?(c, r)
-            tmp << %{<rect width="#{module_size}" height="#{module_size}" x="#{x}" y="#{y}" style="fill:##{color}"/>}
-          end
-          result << tmp.join
-        end
+        output_tag = (use_path ? Path : Rect).new(@qrcode)
+        output_tag.build(module_size, offset, color)
 
-        if options[:fill]
-          result.unshift %{<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:##{options[:fill]}"/>}
+        if fill
+          output_tag.result.unshift %(<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:##{fill}"/>)
         end
 
         if standalone
-          result.unshift(xml_tag, open_tag)
-          result << close_tag
+          output_tag.result.unshift(xml_tag, open_tag)
+          output_tag.result << close_tag
         end
 
-        result.join("\n")
+        output_tag.result.join
       end
     end
   end

data/lib/rqrcode/export.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rqrcode/export/ansi'
-require 'rqrcode/export/html'
-require 'rqrcode/export/png'
-require 'rqrcode/export/svg'
+require "rqrcode/export/ansi"
+require "rqrcode/export/html"
+require "rqrcode/export/png"
+require "rqrcode/export/svg"

data/lib/rqrcode/qrcode/qrcode.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module RQRCode #:nodoc:
   class QRCode

data/lib/rqrcode/qrcode.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'rqrcode/qrcode/qrcode'
+require "rqrcode/qrcode/qrcode"

data/lib/rqrcode/version.rb

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

data/lib/rqrcode.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module RQRCode
-  require 'rqrcode_core'
-  require 'rqrcode/qrcode'
-  require 'rqrcode/export'
-  require 'rqrcode/version'
+  require "rqrcode_core"
+  require "rqrcode/qrcode"
+  require "rqrcode/export"
+  require "rqrcode/version"
 end

data/rqrcode.gemspec

@@ -1,36 +1,39 @@
-# -*- encoding: utf-8 -*-
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "rqrcode/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "rqrcode"
-  spec.version       = RQRCode::VERSION
-  spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ["Duncan Robertson"]
-  spec.email         = ["duncan@whomwah.com"]
+  spec.name = "rqrcode"
+  spec.version = RQRCode::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Duncan Robertson"]
+  spec.email = ["duncan@whomwah.com"]
 
-  spec.summary       = %q{A library to encode QR Codes}
-  spec.description = <<EOF
-rqrcode is a library for encoding QR Codes. The simple
-interface allows you to create QR Code data structures
-and then render them in the way you choose.
-EOF
-  spec.homepage      = "https://github.com/whomwah/rqrcode"
-  spec.license       = "MIT"
+  spec.summary = "A library to encode QR Codes"
+  spec.description = <<~EOF
+    rqrcode is a library for encoding QR Codes. The simple
+    interface allows you to create QR Code data structures
+    and then render them in the way you choose.
+  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
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) 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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.3'
-  spec.add_dependency 'rqrcode_core', '~> 0.1.0'
-  spec.add_dependency 'chunky_png', '~> 1.0'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.required_ruby_version = ">= 2.3"
+  spec.add_dependency "rqrcode_core", "~> 1.0"
+  spec.add_dependency "chunky_png", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "standardrb", "~> 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Duncan Robertson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rqrcode_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |
   rqrcode is a library for encoding QR Codes. The simple
   interface allows you to create QR Code data structures
@@ -93,7 +107,9 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -116,14 +132,16 @@ 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:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -132,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A library to encode QR Codes