rqrcode 0.10.1 → 2.2.0

data/lib/rqrcode/export/ansi.rb

@@ -1,54 +1,51 @@
+# frozen_string_literal: true
+
 module RQRCode
   module Export
     module ANSI
-      ##
+      #
       # Returns a string of the QR code as
       # characters writen with ANSI background set.
-      # 
-      # Options: 
+      #
+      # 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)
 
-        normal = "\033[m"
+        normal = "\033[m\n"
         light = options.fetch(:light)
         dark = options.fetch(:dark)
         fill_character = options.fetch(:fill_character)
         quiet_zone_size = options.fetch(:quiet_zone_size)
+        output = []
 
-        output = ''
-
-        @modules.each_index do |c|
-
+        @qrcode.modules.each_index do |c|
           # start row with quiet zone
           row = light + fill_character * quiet_zone_size
           previous_dark = false
 
-          @modules.each_index do |r|
-            if is_dark(c, r)
-              # dark
+          @qrcode.modules.each_index do |r|
+            if @qrcode.checked?(c, r)
               if previous_dark != true
                 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
@@ -58,18 +55,18 @@ module RQRCode
           row << fill_character * quiet_zone_size
 
           # always end with reset and newline
-          row << normal + "\n"
+          row << normal
 
           output << row
         end
 
         # count the row width so we can add quiet zone rows
-        width = output.each_line.first.scan(fill_character).length
+        width = output.first.scan(fill_character).length
 
-        quiet_row = light + fill_character * width + normal + "\n"
+        quiet_row = light + fill_character * width + normal
         quiet_rows = quiet_row * quiet_zone_size
 
-        return quiet_rows + output + quiet_rows
+        quiet_rows + output.join + quiet_rows
       end
     end
   end

data/lib/rqrcode/export/html.rb

@@ -1,16 +1,18 @@
-# Use this module to HTML-ify the QR code if you just want the default HTML
+# frozen_string_literal: true
+
 module RQRCode
   module Export
     module HTML
-
+      #
+      # 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
 
       def rows
-        Rows.new(self)
+        Rows.new(@qrcode)
       end
 
       class Rows < Struct.new(:qr)
@@ -25,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
@@ -39,11 +41,7 @@ module RQRCode
         end
 
         def html_class
-          dark? ? 'black' : 'white'
-        end
-
-        def dark?
-          qr.dark?(row_index, col_index)
+          qr.checked?(row_index, col_index) ? "black" : "white"
         end
       end
     end

data/lib/rqrcode/export/png.rb

@@ -1,69 +1,80 @@
-require 'chunky_png'
+# frozen_string_literal: true
+
+require "chunky_png"
 
 # This class creates PNG files.
-# Code from: https://github.com/DCarper/rqrcode
 module RQRCode
   module Export
     module PNG
-
-      # Render the PNG from the Qrcode.
+      # Render the PNG from the QR Code.
+      #
+      # 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 default)
       #
-      # There are two sizing algoritams.
+      # 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.
       #
-      # Options: 
-      # fill  - Background ChunkyPNG::Color, defaults to 'white'
-      # color - Foreground ChunkyPNG::Color, defaults to 'black'
+      # 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 = {
-          :resize_gte_to => false,
-          :resize_exactly_to => false,
-          :fill => 'white',
-          :color => 'black',
-          :size => 120,
-          :border_modules => 4,
-          :file => false,
-          :module_px_size => 6
+          bit_depth: 1,
+          border_modules: 4,
+          color_mode: ChunkyPNG::COLOR_GRAYSCALE,
+          color: "black",
+          file: false,
+          fill: "white",
+          module_px_size: 6,
+          resize_exactly_to: false,
+          resize_gte_to: false,
+          size: 120
         }
-        
-        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])
+        googleis = options.length == 0 || !options[:size].nil?
+        options = default_img_options.merge(options) # reverse_merge
+        fill = ChunkyPNG::Color(*(options[:fill].is_a?(Array) ? options[:fill] : [options[:fill]]))
+        color = ChunkyPNG::Color(*(options[:color].is_a?(Array) ? options[:color] : [options[:color]]))
         output_file = options[:file]
-        
         module_px_size = nil
         border_px = nil
         png = nil
-        
+
         if googleis
           total_image_size = options[:size]
           border_modules = options[:border_modules]
 
-          module_px_size = (total_image_size.to_f / (self.module_count + 2 * border_modules).to_f).floor.to_i
+          module_px_size = (total_image_size.to_f / (@qrcode.module_count + 2 * border_modules).to_f).floor.to_i
 
-          img_size = module_px_size * self.module_count
+          img_size = module_px_size * @qrcode.module_count
 
           remaining = total_image_size - img_size
           border_px = (remaining / 2.0).floor.to_i
@@ -73,43 +84,48 @@ module RQRCode
           border = options[:border_modules]
           total_border = border * 2
           module_px_size = if options[:resize_gte_to]
-            (options[:resize_gte_to].to_f / (self.module_count + total_border).to_f).ceil.to_i
+            (options[:resize_gte_to].to_f / (@qrcode.module_count + total_border).to_f).ceil.to_i
           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]
 
-          img_size = module_px_size * self.module_count
+          img_size = module_px_size * @qrcode.module_count
           total_img_size = img_size + total_border_px
 
           png = ChunkyPNG::Image.new(total_img_size, total_img_size, fill)
         end
 
-        self.modules.each_index do |x|
-          self.modules.each_index do |y|
-            if self.dark?(x, y)
+        @qrcode.modules.each_index do |x|
+          @qrcode.modules.each_index do |y|
+            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
           end
         end
-        
+
         if !googleis && resize_to
-          png = png.resize(resize_to, resize_to)  
+          png = png.resize(resize_to, resize_to)
         end
 
-
         if output_file
-          png.save(output_file,{ :color_mode => ChunkyPNG::COLOR_GRAYSCALE, :bit_depth =>1})
+          constraints = {
+            color_mode: options[:color_mode],
+            bit_depth: options[:bit_depth]
+          }
+          constraints[:interlace] = options[:interlace] if options.has_key?(:interlace)
+          constraints[:compression] = options[:compression] if options.has_key?(:compression)
+          png.save(output_file, constraints)
         end
+
         png
       end
-
     end
   end
 end

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}" 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}" 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" 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.2.0"
 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.6"
+  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