rqrcode 0.8.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 537c13caf3f8d2e6896f4c4ca2e8f49aefd5a873
-  data.tar.gz: a9ec155978d80c75928cc8a952b010f8682ad2dc
+SHA256:
+  metadata.gz: 0db16b2bfb687e737b0059398da5727e95ded9567b62027639069c5b52b1924a
+  data.tar.gz: 29b82466d2dd00f773968b6d9219643e3801dadfae0dea062eb7c1a5de3c6295
 SHA512:
-  metadata.gz: c9e472adeef166c9030acc1d3b12b3cff3578ac6283551c60822bf02178b2ab74ab82fb60178ac94b1260d73d14f8f3dbe9c540d9244d2c07a55094d216a5f24
-  data.tar.gz: 7ea7baac645ccb7cff2dc714ff3127a9d7bdbd19e347f889efba97a04a8489ff39c0a8038e174bfe29b5ff07794c2b75cdb7d581ecb017df6d867bcca4b9b9b8
+  metadata.gz: 90c75c5fc56d6d64be3b4896e40227a25394d7206c3afe3fe6940b7d91a2ecf1b7a158b9f096a0a7ab1e3d36ef6c65cd92fc9e77642e550dc53bc90c3452e711
+  data.tar.gz: 04f456be8601ea85f3fe79a4fb4f97a04dc23d93437719e5fceb24e4ba386572b33c87820c8a1f9102d6ad4f7c69cde25f9396da6e278bf50c629ad6f4eaa111

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: rqrcode
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      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/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,165 +1,182 @@
-# 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.8.2* (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)
 
-- Fix source encoding problem introduced in 0.8.1
+## Installing
 
-*0.8.1* (Jan 3, 2016)
+Add this line to your application's `Gemfile`:
 
-- Remove active support specific `present?`.
-- Fix so that all tests are run.
+```ruby
+gem 'rqrcode'
+```
 
-*0.8.0* (Dec 18, 2015)
+or install manually:
 
-- Added numeric QR code support
-- Dropped Ruby v1.8 support
+```ruby
+gem install rqrcode
+```
 
-*0.7.0* (Aug 15, 2015)
+## Basic usage example
 
-- Added shape_rendering option for as_svg
+```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 __standalone library__ It requires no other 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)
 
-## Using rQRCode
+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:
+
+### 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
+
+# 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,
-          border_modules: 4,
-          module_px_size: 6,
-          file: nil # path to write
-          )
+  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
+)
+
+IO.write("/tmp/github-qrcode.png", png.to_s)
 ```
 
-## HTML Rendering
-### In your controller
-```ruby
-@qr = RQRCode::QRCode.new( 'https://github.com/whomwah/rqrcode', :size => 4, :level => :h )
-```
+![QR code with github url](./images/github-qrcode.png)
 
-### In your view
-```html
-<%= raw @qr.as_html %>
-```
-
-### 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 
-```
-
-## 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
+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
 ```
 
-## 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
 
@@ -167,25 +184,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"
+Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.pattern = "test/**/test_*.rb"
-  t.verbose = true
+  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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here