rqrcode 1.0.0.pre → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a25f372a618c9ff9906fd306ab72592c31213be1aa71aa93cc1949a1ba8fc2d3
-  data.tar.gz: 2a140b6b425052375e5b0121f8910e1d16acc10f55c1e4d0cba047f1011e45d1
+  metadata.gz: 0d8b2f0f6e33a545c3f0e5414b53eb5cffdc99138238d06118fbfec70d968c2e
+  data.tar.gz: 05df172d996fde577a4ce32504f243cd7d8feb440d70167d633c03956fa8d6e6
 SHA512:
-  metadata.gz: 101c49983286d0f9f956eb4a47c4439dd3a48886c58fa1b25759085fdf529283abf19bc183c93655e0e41b1de14c6ee3f4ee7db998c7410d296fb859be5bb21c
-  data.tar.gz: 1321c977a150e091de1ef25260b35232f588d9045f6ac036e8378f11b62bbf5fd39b62c5fab4ba66a4984105b706e516cb7af0ead4b9baa764cc43d6a0746d99
+  metadata.gz: 73398ff5d4c89b362c850b6a293dace00e415738ec9944f4471d0d473dbbb7e0f8a9adec5026167a51535b619950487a556c126919045d1b289e949b82f2e171
+  data.tar.gz: 80c7718c260969fa52138620cd547d9c8564f9610dc951b1d06f4f4a2e20ac6979fca861b4ad6de22ef07e18daca15b86b187c5c963f47edeba24c99aa3fed5d

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: rqrcode
+
+on:
+  push:
+    branches:
+    - master
+    - release/*
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  build:
+    name: Test Ruby ${{ matrix.ruby_version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        ruby_version: [2.5.x, 2.6.x]
+        os: [ubuntu-latest]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Ruby ${{ matrix.ruby_version }}
+      uses: actions/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 rspec

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -1,13 +1,12 @@
-__UPDATE:__ A new pre-release has been made [v1.0.0.pre](https://github.com/whomwah/rqrcode/releases/tag/v1.0.0.pre). A fresh start after a _long_ pause. There is actually no new functionality in the release but there are some dependency changes. Minimum Ruby version is now `~> 2.3`. This release also cleans up the internals a bit. The core `QR Code` generation has been extracted into a new [rqrcode_core](https://github.com/whomwah/rqrcode_core) gem. This enables `qrqcode` to concentrate on rendering. Once `v1.0.0.pre` has had time for people to try I'll release `v1.0.0` of `rqrcode` and then concentrate on working through issues and PRs although I appreciate many of these may be old and out of date now! You can install this pre-release with `gem install rqrcode --pre` or `gem 'rqrcode', '>= 1.0.0.pre'` in your `Gemfile`.
-
-
 # RQRCode
 
-[![Codeship Status for whomwah/rqrcode](https://app.codeship.com/projects/66910bf0-809b-0137-b2d8-06fb89da20d2/status?branch=master)](https://app.codeship.com/projects/352496)
+![](https://github.com/whomwah/rqrcode/workflows/rqrcode/badge.svg)
+
 
 [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)
 
 ## Installing
@@ -89,7 +88,8 @@ svg = qrcode.as_svg(
   offset: 0,
   color: '000',
   shape_rendering: 'crispEdges',
-  module_size: 6
+  module_size: 6,
+  standalone: true
 )
 ```
 
@@ -125,17 +125,19 @@ qrcode = RQRCode::QRCode.new("http://github.com/")
 
 # NOTE: showing with default options specified explicitly
 png = qrcode.as_png(
-  resize_gte_to: false,
-  resize_exactly_to: false,
-  fill: 'white',
-  color: 'black',
-  size: 120,
+  bit_depth: 1,
   border_modules: 4,
+  color_mode: ChunkyPNG::COLOR_GRAYSCALE,
+  color: 'black',
+  file: nil,
+  fill: 'white',
   module_px_size: 6,
-  file: nil # path to write
+  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)
@@ -165,6 +167,21 @@ x xxx x xxx  x  x  x  x xxx x
 
 [http://www.rubydoc.info/gems/rqrcode](http://www.rubydoc.info/gems/rqrcode)
 
+## Tests
+
+You can run the test suite using:
+
+```
+$ ./bin/setup
+$ bundle exec rspec
+```
+
+or try the lib from the console with:
+
+```
+$ ./bin/console
+```
+
 ## Contributing
 * Fork the project
 * Send a pull request

data/lib/rqrcode/export/png.rb

@@ -6,8 +6,7 @@ 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.
       #
@@ -20,6 +19,12 @@ module RQRCode
       # 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
+      #
       # *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).
@@ -35,24 +40,23 @@ module RQRCode
       #
       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
@@ -103,10 +107,16 @@ module RQRCode
           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

data/lib/rqrcode/export/svg.rb

@@ -14,12 +14,15 @@ 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 = (@qrcode.module_count*module_size) + (2*offset)
@@ -45,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/qrcode/qrcode.rb

@@ -11,7 +11,7 @@ module RQRCode #:nodoc:
     attr_reader :qrcode
 
     def initialize(string, *args)
-      @qrcode = RQRCodeCore::QRCode.new(string, args)
+      @qrcode = RQRCodeCore::QRCode.new(string, *args)
     end
   end
 end

data/lib/rqrcode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RQRCode
-  VERSION = "1.0.0.pre"
+  VERSION = "1.2.0"
 end

data/rqrcode.gemspec

@@ -27,10 +27,10 @@ EOF
   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 "minitest", "~> 5.0"
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rqrcode
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.2.0
 platform: ruby
 authors:
 - Duncan Robertson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2020-12-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: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -42,14 +42,14 @@ dependencies:
   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
@@ -58,28 +58,28 @@ 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: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.5'
 description: |
   rqrcode is a library for encoding QR Codes. The simple
   interface allows you to create QR Code data structures
@@ -90,11 +90,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - _config.yml
 - bin/console
 - bin/setup
@@ -121,16 +122,16 @@ 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
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A library to encode QR Codes

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test