rqrcode 0.10.1 → 2.1.1

data/lib/rqrcode/export/svg.rb

@@ -1,50 +1,206 @@
+# 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
+
+          # 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|
+              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
+      # 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 = (self.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}">}
+        svg_tag_attributes = (DEFAULT_SVG_ATTRIBUTES + [
+          dimensions_attr,
+          %(shape-rendering="#{shape_rendering}")
+        ] + svg_attributes.map { |k, v| %(#{k}="#{v}") }).join(" ")
+
+        xml_tag = %(<?xml version="1.0" standalone="yes"?>)
+        open_tag = %(<svg #{svg_tag_attributes}>)
         close_tag = "</svg>"
 
-        result = []
-        self.modules.each_index do |c|
-          tmp = []
-          self.modules.each_index do |r|
-            y = c*module_size + offset
-            x = r*module_size + offset
+        output_tag = (use_path ? Path : Rect).new(@qrcode)
+        output_tag.build(module_size, offset, color)
 
-            next unless self.is_dark(c, r)
-            tmp << %{<rect width="#{module_size}" height="#{module_size}" x="#{x}" y="#{y}" style="fill:##{color}"/>}
-          end
-          result << tmp.join
+        if 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 options[:fill]
-          result.unshift %{<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:##{options[:fill]}"/>}
+        if standalone
+          output_tag.result.unshift(xml_tag, open_tag)
+          output_tag.result << close_tag
         end
 
-        [xml_tag, open_tag, result, close_tag].flatten.join("\n")
+        output_tag.result.join
       end
     end
   end

data/lib/rqrcode/export.rb

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

data/lib/rqrcode/qrcode/qrcode.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module RQRCode # :nodoc:
+  class QRCode
+    extend Forwardable
+    def_delegators :@qrcode, :to_s
+    def_delegators :@qrcode, :modules # deprecated
+
+    attr_reader :qrcode
+
+    def initialize(string, *args)
+      @qrcode = RQRCodeCore::QRCode.new(string, *args)
+    end
+  end
+end

data/lib/rqrcode/qrcode.rb

@@ -1,4 +1,3 @@
-Dir[File.dirname(__FILE__) + "/qrcode/*.rb"].sort.each do |path|
-  filename = File.basename(path)
-  require "rqrcode/qrcode/#{filename}"
-end
+# frozen_string_literal: true
+
+require "rqrcode/qrcode/qrcode"

data/lib/rqrcode/version.rb

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

data/lib/rqrcode.rb

@@ -1,19 +1,8 @@
-#!/usr/bin/env ruby
-
-#--
-# Copyright 2008 by Duncan Robertson (duncan@whomwah.com).
-# All rights reserved.
-
-# Permission is granted for use, copying, modification, distribution,
-# and distribution of modified versions of this work as long as the
-# above copyright notice is included.
-#++
-
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require "rqrcode/core_ext"
-require "rqrcode/qrcode"
-require 'rqrcode/export/png'
-require 'rqrcode/export/svg'
-require 'rqrcode/export/html'
-require 'rqrcode/export/ansi'
+# frozen_string_literal: true
+
+module RQRCode
+  require "rqrcode_core"
+  require "rqrcode/qrcode"
+  require "rqrcode/export"
+  require "rqrcode/version"
+end

data/rqrcode.gemspec

@@ -0,0 +1,39 @@
+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.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
+    `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.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,126 +1,157 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 2.1.1
 platform: ruby
 authors:
-- Björn Blomqvist
 - Duncan Robertson
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 description: |
-  rQRCode is a library for encoding QR Codes. The simple
+  rqrcode is a library for encoding QR Codes. The simple
   interface allows you to create QR Code data structures
-  ready to be displayed in the way you choose.
+  and then render them in the way you choose.
 email:
-- darwin@bits2life.com
+- duncan@whomwah.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- CHANGELOG
-- LICENSE
+extra_rdoc_files: []
 files:
-- CHANGELOG
-- LICENSE
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- Rakefile
+- _config.yml
+- bin/console
+- bin/setup
+- images/ansi-screen-shot.png
+- images/github-qrcode.png
+- images/github-qrcode.svg
 - lib/rqrcode.rb
-- lib/rqrcode/core_ext.rb
-- lib/rqrcode/core_ext/array.rb
-- lib/rqrcode/core_ext/array/behavior.rb
-- lib/rqrcode/core_ext/integer.rb
-- lib/rqrcode/core_ext/integer/bitwise.rb
+- lib/rqrcode/export.rb
 - lib/rqrcode/export/ansi.rb
 - lib/rqrcode/export/html.rb
 - lib/rqrcode/export/png.rb
 - lib/rqrcode/export/svg.rb
 - lib/rqrcode/qrcode.rb
-- lib/rqrcode/qrcode/qr_8bit_byte.rb
-- lib/rqrcode/qrcode/qr_alphanumeric.rb
-- lib/rqrcode/qrcode/qr_bit_buffer.rb
-- lib/rqrcode/qrcode/qr_code.rb
-- lib/rqrcode/qrcode/qr_math.rb
-- lib/rqrcode/qrcode/qr_numeric.rb
-- lib/rqrcode/qrcode/qr_polynomial.rb
-- lib/rqrcode/qrcode/qr_rs_block.rb
-- lib/rqrcode/qrcode/qr_util.rb
+- lib/rqrcode/qrcode/qrcode.rb
 - lib/rqrcode/version.rb
-- test/data.rb
-- test/test_helper.rb
-- test/test_regresions.rb
-- test/test_rqrcode.rb
-- test/test_rqrcode_export.rb
+- rqrcode.gemspec
 homepage: https://github.com/whomwah/rqrcode
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+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: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A library to encode QR Codes
-test_files:
-- test/data.rb
-- test/test_helper.rb
-- test/test_regresions.rb
-- test/test_rqrcode.rb
-- test/test_rqrcode_export.rb
+test_files: []

data/CHANGELOG

@@ -1,97 +0,0 @@
-*0.10.1* (Feb 11, 2016)
-
-- Changed so that gem wont include images and tests.
-
-*0.10.0* (Feb 11, 2016)
-
-- Merged as_ansi by [Andy Brody](https://github.com/ab)
-
-*0.8.2* (Jan 3, 2016)
-
-- Fix source encoding problem introduced in 0.8.1
-
-*0.9.0* (Jan 3, 2016)
-
-- Added support for auto selecting qrcode size up to level 40. (only worked up to level 10 before)
-- Added numeric support during auto selection of qrcode mode.
-
-*0.8.1* (Jan 3, 2016)
-
-- Remove active support specific `present?`.
-- Fix so that all tests are run.
-
-*0.8.0* (Dec 18, 2015)
-
-- Added numeric QR code support
-- Dropped Ruby v1.8 support
-
-*0.7.0* (Aug 15, 2015)
-
-- Added shape_rendering option for as_svg
-
-*0.6.0* (Jun 2, 2015)
-
-- Improved png rendering. Previous png rendering could result in hard to scan qrcodes.
-  *Big thanks to Bart Jedrocha*
-
-*0.5.5* (Apr 25, 2015)
-
-- Fixed major bug. The rs block data was missing resulting in qr codes failing to be generated.
-  *Upgrade highly recomended!!*
-
-*0.5.4* (Nov 11th, 2013)
-  
-* Added as_html, Big thanks to Jon Evans!
-
-*0.4.2* (Sep 1st, 2011)
-
-* Proper namespace CoreExtensions and only extend when needed [https://github.com/metaskills]
-* fix for running tests on 1.9
-
-*0.4.1* (Aug 16th, 2011)
-
-* Compute common patterns only once (5% to 10% speedup) [https://github.com/gioele]
-
-*0.4.0* (Aug 13th, 2011)
-
-* Code optimization: 30% speedup [https://github.com/gioele]
-* refactor gem layout 
-
-*0.3.4* (May 23rd, 2011)
-
-* add the more Rubyish QRCode#dark? alias for #is_dark [https://github.com/dasch] 
-
-*0.3.3* (Feb 1st, 2011)
-
-* check to see if the level is valid
-* fix for 'rszf' bug by [Rob la Lau https://github.com/ohreally]
-
-*0.3.2* (Mar 15th, 2009)
-
-* Ruby 1.9 fixes by [Tore Darell http://tore.darell.no] [Chris Mowforth http://blog.99th.st]
-
-*0.3.1* (Nov 24th, 2008)
-
-* expanded RS block table to QRcode version 40  [Vladislav Gorodetskiy]
-
-*0.3.0* (Feb 28th, 2008)
-
-* added more documentation
-* changed to_console to to_s (what was I thinking)
-* add more tests
-
-*0.2.1* (Feb 24th, 2008)
-
-* small changes to rakefile and readme
-* small change to to_console method
-* make console_count method private (use modules.size instead)
-* slowy updating rdocs 
-
-*0.2.0* (Feb 23rd, 2008)
-
-* Split files up [DR]
-* added rdoc comment ... more to do there
-
-*0.1.0* (Feb 22rd, 2008)
-
-* Initial Release [DR]

data/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2008 Duncan Robertson 
-
-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 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.
-