rqrcode 0.9.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e8b487f591272b08e4fc7379f8ff16a7819459e
-  data.tar.gz: 5fc8e96a42d136b0cd76941d8a77316d207208e9
+SHA256:
+  metadata.gz: 818b3dab2ed7719eb45d3c4b02704258e92f4de8ec0fe4f7e9cbb62765aad507
+  data.tar.gz: 50efa7d1fe21cce41ea38d44b4864290110281fcfc6c575267550440acb7f41a
 SHA512:
-  metadata.gz: e2c4d056dc95bca8bb1a268567a0f19a3d48eaaa96d6888874ee4abde3d85db7d6ae3197e840e2085651fb0ebd8ded890421174816a75d12052a29b41bfb3895
-  data.tar.gz: b435943576d8a4c458e7392f0d7a69ed27a7ec3a05bc449523f2141b87e5f8c03e2fca35ce8ba64887787667d65c854655e2ec8449b1e2565daa40a1ad6f94a5
+  metadata.gz: fbda3d6822ef41ce25fed16754a921ea964c8a5fcfe629975146d1733de49f08dc337fc6b2f2213160289d623618961eb04a5531a22329ade90ac0ba777f57ed
+  data.tar.gz: 1834cab154c5819319ccd2cb22e7c8fddaa6dcd680648693e29e8ce98cb9f92a0d12c5f8072f9fa40ae09b0ffcecafa02ede7a7d26fef611397a3f693e4d9512

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 rake test

data/.gitignore

@@ -1,5 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
 /pkg/
+/spec/reports/
+/tmp/
+/.devcontainer/
 .rvmrc
-Gemfile.lock
 *.sublime-project
 *.sublime-workspace
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -1,9 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem "chunky_png", "~> 1.0"
-
-group :test, :development do
-  gem 'rake'
-  gem 'test-unit'
-  gem 'minitest'
-end
+# Specify your gem's dependencies in rqrcode-base.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -1,162 +1,184 @@
-# rQRCode, Encode QRCodes 
+# RQRCode
 
-[![Build Status](https://travis-ci.org/whomwah/rqrcode.svg?branch=master)](https://travis-ci.org/whomwah/rqrcode)
+![](https://github.com/whomwah/rqrcode/workflows/rqrcode/badge.svg)
 
-**All users of rqrcode are highly recomended to upgrade to version 0.5.5 ore later!**
 
-## Short changelog
+[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.
 
-*0.9.0* (Jan 3, 2016)
+* 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
 
-- 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.
+Add this line to your application's `Gemfile`:
 
-*0.8.1* (Jan 3, 2016)
+```ruby
+gem 'rqrcode'
+```
 
-- Remove active support specific `present?`.
-- Fix so that all tests are run.
+or install manually:
+
+```ruby
+gem install rqrcode
+```
 
-*0.8.0* (Dec 18, 2015)
+## Basic usage example
 
-- Added numeric QR code support
-- Dropped Ruby v1.8 support
+```ruby
+require 'rqrcode'
 
-## Overview
+qr = RQRCode::QRCode.new('http://github.com')
+result = ''
 
-rQRCode is a library for encoding QR Codes in Ruby. It has a simple interface with all the standard qrcode options. It was adapted from the Javascript library by Kazuhiko Arase.
+qr.qrcode.modules.each do |row|
+  row.each do |col|
+    result << (col ? 'X' : 'O')
+  end
 
-Let's clear up some rQRCode stuff.
+  result << "\n"
+end
 
-* rQRCode is a __ruby only library__ It requires no native libraries. Just Ruby!
-* It is an encoding library. You can't decode QR codes with it.
-* The interface is simple and assumes you just want to encode a string into a QR code
-* QR code is trademarked by Denso Wave inc
+puts result
+```
 
-## Installing
+### Advanced Options
 
-You may get the latest stable version from Rubygems.
+These are the various QR Code generation options provided by [rqrqcode_core](https://github.com/whomwah/rqrcode_core).
 
-```ruby
-gem install rqrcode
 ```
+string - the string you wish to encode
+
+size   - the size of the qrcode (default 4)
+
+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 qrcode (defaults to alphanumeric or byte_8bit, depending on the input data):
+  * :number
+  * :alphanumeric
+  * :byte_8bit
+  * :kanji
+```
+
+Example
+
+```
+qrcode = RQRCodeCore::QRCode.new('hello world', size: 1, level: :m, mode: :alphanumeric)
+```
+
+## Render types
+
+You can output your QR code in various forms. These are detailed below:
 
-## Using rQRCode
+### as SVG
+
+The SVG renderer will produce a stand-alone SVG as a `String`
 
 ```ruby
 require 'rqrcode'
 
 qrcode = RQRCode::QRCode.new("http://github.com/")
-image = qrcode.as_png
-svg = qrcode.as_svg
-html = qrcode.as_html
-string = qrcode.to_s
+
+# NOTE: showing with default options specified explicitly
+svg = qrcode.as_svg(
+  offset: 0,
+  color: '000',
+  shape_rendering: 'crispEdges',
+  module_size: 6,
+  standalone: true
+)
 ```
 
-## Image Rendering
-### SVG
+![QR code with github url](./images/github-qrcode.svg)
 
-The SVG renderer will produce a stand-alone SVG as a `String`
+### as ANSI
+
+The ANSI renderer will produce as a string with ANSI color codes.
 
 ```ruby
+require 'rqrcode'
+
 qrcode = RQRCode::QRCode.new("http://github.com/")
-# With default options specified explicitly
-svg = qrcode.as_svg(offset: 0, color: '000', 
-                    shape_rendering: 'crispEdges', 
-                    module_size: 11)
+
+# NOTE: showing with default options specified explicitly
+svg = qrcode.as_ansi(
+  light: "\033[47m", dark: "\033[40m",
+  fill_character: '  ',
+  quiet_zone_size: 4
+)
 ```
 
-### PNG
+![QR code with github url](./images/ansi-screen-shot.png)
+
+### as PNG
 
 The library can produce a PNG. Result will be a `ChunkyPNG::Image` instance.
 
 ```ruby
+require 'rqrcode'
+
 qrcode = RQRCode::QRCode.new("http://github.com/")
-# With default options specified explicitly
-png = qrcode.as_png(
-          resize_gte_to: false,
-          resize_exactly_to: false,
-          fill: 'white',
-          color: 'black',
-          size: 120,
-          border_modules: 4,
-          module_px_size: 6,
-          file: nil # path to write
-          )
-```
 
-## HTML Rendering
-### In your controller
-```ruby
-@qr = RQRCode::QRCode.new( 'https://github.com/whomwah/rqrcode', :size => 4, :level => :h )
+# NOTE: showing with default options specified explicitly
+png = qrcode.as_png(
+  bit_depth: 1,
+  border_modules: 4,
+  color_mode: ChunkyPNG::COLOR_GRAYSCALE,
+  color: 'black',
+  file: nil,
+  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)
 ```
 
-### In your view
-```html
-<%= raw @qr.as_html %>
-```
+![QR code with github url](./images/github-qrcode.png)
 
-### CSS
-```css
-table {
-  border-width: 0;
-  border-style: none;
-  border-color: #0000ff;
-  border-collapse: collapse;
-}
-
-td {
-  border-left: solid 10px #000;
-  padding: 0; 
-  margin: 0; 
-  width: 0px; 
-  height: 10px; 
-}
-
-td.black { border-color: #000; }
-td.white { border-color: #fff; }
-```
-    
-## On the console
+### On the console ( just because you can )
 
 ```ruby
-qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
+require 'rqrcode'
+
+qr = RQRCode::QRCode.new('http://kyan.com', size: 4, level: :h)
+
 puts qr.to_s
 ```
 
 Output:
 
 ```
-xxxxxxx x  x x   x x  xx  xxxxxxx
-x     x  xxx  xxxxxx xxx  x     x
-x xxx x  xxxxx x       xx x xxx x
-... etc 
+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
 ```
 
-## Doing your own rendering
-```ruby
-qr = RQRCode::QRCode.new( 'my string to generate', :size => 4, :level => :h )
-qr.modules.each do |row|
-    row.each do |col| 
-        print col ? "X" : " "
-    end
-    print "\n"
-end
-```
-
-## Specifying QR code mode
+## API Documentation
 
-Sometimes you may want to specify the QR code mode explicitly. 
+[http://www.rubydoc.info/gems/rqrcode](http://www.rubydoc.info/gems/rqrcode)
 
-It is done via the `mode` option. Allowed values are: `number`, `alphanumeric` and `byte_8bit`.
+## Contributing
+* Fork the project
+* Send a pull request
+* Don't touch the .gemspec, I'll do that when I release a new version
 
-```ruby
-qr = RQRCode::QRCode.new( '1234567890', :size => 2, :level => :m, :mode => :number )
-```
+## Authors
 
+Original RQRCode author: Duncan Robertson
 
-## API Documentation
+A massive thanks to [all the contributors of the library over the years](https://github.com/whomwah/rqrcode/graphs/contributors). It wouldn't exist if it wasn't for you all.
 
-[http://www.rubydoc.info/gems/rqrcode](http://www.rubydoc.info/gems/rqrcode)
+Oh, and thanks to my bosses at https://kyan.com for giving me time to maintain this project.
 
 ## Resources
 
@@ -164,25 +186,6 @@ qr = RQRCode::QRCode.new( '1234567890', :size => 2, :level => :m, :mode => :numb
 * Denso-Wave website:: http://www.denso-wave.com/qrcode/index-e.html
 * kaywa:: http://qrcode.kaywa.com
 
-## Authors
-
-Original author: Duncan Robertson
-
-Special thanks to the following people for submitting patches:
-
-* [Chris Mowforth](http://blog.99th.st)
-* [Daniel Schierbeck](https://github.com/dasch)
-* [Gioele Barabucci](https://github.com/gioele)
-* [Ken Collins](https://github.com/metaskills)
-* [Rob la Lau](https://github.com/ohreally)
-* [Tore Darell](http://tore.darell.no)
-* Vladislav Gorodetskiy
-
-## Contributing
-* Fork the project
-* Send a pull request
-* Don't touch the .gemspec, I'll do that when I release a new version
-
 ## Copyright
 
 MIT License (http://www.opensource.org/licenses/mit-license.html)

data/Rakefile

@@ -1,14 +1,10 @@
-require 'rake/testtask'
-require 'bundler'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-Bundler::GemHelper.install_tasks
-
-desc 'Run tests'
-Rake::TestTask.new do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/test_*.rb'
-  t.verbose = true
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => [:test]
+task :default => :test

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rqrcode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)