rqrcode 0.10.1 → 1.2.0

data/lib/rqrcode/export/ansi.rb

@@ -1,11 +1,13 @@
+# 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")
       # fill_character: The written character. ('  ')
@@ -19,23 +21,20 @@ module RQRCode
           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
@@ -58,18 +57,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
+        return quiet_rows + output.join + quiet_rows
       end
     end
   end

data/lib/rqrcode/export/html.rb

@@ -1,8 +1,10 @@
-# 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
       end
@@ -10,7 +12,7 @@ module RQRCode
       private
 
       def rows
-        Rows.new(self)
+        Rows.new(@qrcode)
       end
 
       class Rows < Struct.new(:qr)
@@ -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,3 +1,4 @@
+# frozen_string_literal: true
 require 'chunky_png'
 
 # This class creates PNG files.
@@ -5,21 +6,26 @@ require 'chunky_png'
 module RQRCode
   module Export
     module PNG
-
-      # Render the PNG from the Qrcode.
+      # 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: 
+      # Options:
       # fill  - Background ChunkyPNG::Color, defaults to 'white'
       # color - Foreground ChunkyPNG::Color, defaults to 'black'
       #
-      # *Googleis*    
+      # 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
+      #
+      # *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).
       #
@@ -33,37 +39,35 @@ module RQRCode
       # Defaults to 90x90 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])
         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,7 +77,7 @@ 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
@@ -81,15 +85,15 @@ module RQRCode
           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
@@ -98,18 +102,23 @@ module RQRCode
             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,10 +1,11 @@
+# frozen_string_literal: true
+
 # This class creates a SVG files.
 # Code from: https://github.com/samvincent/rqrcode-rails3
 module RQRCode
   module Export
-
     module SVG
-
+      #
       # Render the SVG from the Qrcode.
       #
       # Options:
@@ -13,28 +14,31 @@ module RQRCode
       # 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.
       #
       def as_svg(options={})
         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]
 
         # 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)
 
         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>"
 
         result = []
-        self.modules.each_index do |c|
+        @qrcode.modules.each_index do |c|
           tmp = []
-          self.modules.each_index do |r|
+          @qrcode.modules.each_index do |r|
             y = c*module_size + offset
             x = r*module_size + offset
 
-            next unless self.is_dark(c, r)
+            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
@@ -44,7 +48,12 @@ module RQRCode
           result.unshift %{<rect width="#{dimension}" height="#{dimension}" x="0" y="0" style="fill:##{options[:fill]}"/>}
         end
 
-        [xml_tag, open_tag, result, close_tag].flatten.join("\n")
+        if standalone
+          result.unshift(xml_tag, open_tag)
+          result << close_tag
+        end
+
+        result.join("\n")
       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 = "1.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,36 @@
+# -*- 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.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.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', '~> 0.2'
+  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'
+end

metadata

@@ -1,102 +1,120 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.2.0
 platform: ruby
 authors:
-- Björn Blomqvist
 - Duncan Robertson
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2020-12-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rqrcode_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !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: 1.0.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '3.5'
 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"
+- Gemfile
+- LICENSE.txt
 - README.md
+- _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: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -104,23 +122,17 @@ 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
+rubygems_version: 3.2.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: []