rqrcode_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86bf286f36fb7acec89e8a8ac63c9b3db53924419765d73299af06b2d5af6e6b
+  data.tar.gz: 63f29d43c5442598324647c876f7d93e60a1039812396aa2697e8066b06f1621
+SHA512:
+  metadata.gz: 0f529986cdb960c2f01446b2b25ef89225399bc5005bb91294112d9a361ceed33a1d72d3a5f5f6acb15ea9334286dfb91ae9349cc56d2aad66b055745d91c56c
+  data.tar.gz: 150efe0ebfaffcdd317983bbcef042653c96421c2b42f78b919f2fd87b361ffd6b256660e95b76afbb096c63ca5985726688c07648ad26efc28ffedd487af851

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.devcontainer/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rqrcode-base.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    rqrcode_core (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rqrcode_core!
+
+BUNDLED WITH
+   2.0.1

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

@@ -0,0 +1,102 @@
+[![Codeship Status for whomwah/rqrcode_core](https://app.codeship.com/projects/d2dc8c80-6e88-0137-bf46-6a53d28fd6d4/status?branch=master)](https://app.codeship.com/projects/347347)
+
+# RQRCodeCore
+
+`rqrcode_core` is a library for encoding QR codes in pure Ruby. It has a simple interface with all the standard qrcode options. It was originally adapted in 2008 from a Javascript library by [Kazuhiko Arase](https://github.com/kazuhikoarase).
+
+Features:
+
+* `rqrcode_core` 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.
+
+`rqrcode_core` is the basis of the popular `rqrcode` gem [https://github.com/whomwah/rqrcode]. This gem allows you to generate different renderings of your QR code, including `png`, `svg` and `ansi`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rqrcode_core'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rqrcode_core
+
+## Basic Usage
+
+```ruby
+$ require 'rqrcode_core'
+$ qr = RQRCodeCore::QRCode.new('my string to generate', 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
+require 'rqrcode_core'
+
+qr = RQRCodeCore::QRCode.new('my string to generate', size: 4, level: :h)
+qr.modules.each do |row|
+  row.each do |col|
+    print col ? '#' : ' '
+  end
+
+  print "\n"
+end
+```
+
+### Options
+
+The library expects a string to be parsed in, other args are optional.
+
+```
+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
+
+```
+qr = RQRCodeCore::QRCode.new('hello world', size: 1, level: :m, mode: :alphanumeric)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/whomwah/rqrcode_core.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rqrcode_core"
+
+# 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

data/lib/rqrcode_core.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  require "rqrcode_core/core_ext"
+  require "rqrcode_core/qrcode"
+  require "rqrcode_core/version"
+end

data/lib/rqrcode_core/core_ext.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rqrcode_core/core_ext/array'
+require 'rqrcode_core/core_ext/integer'

data/lib/rqrcode_core/core_ext/array.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rqrcode_core/core_ext/array/behavior'
+
+class Array #:nodoc: all
+  include RQRCodeCore::CoreExtensions::Array::Behavior
+end

data/lib/rqrcode_core/core_ext/array/behavior.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  module CoreExtensions #:nodoc: all
+    module Array
+      module Behavior
+        def extract_options!
+          last.is_a?(::Hash) ? pop : {}
+        end unless [].respond_to?(:extract_options!)
+      end
+    end
+  end
+end
+

data/lib/rqrcode_core/core_ext/integer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rqrcode_core/core_ext/integer/bitwise'
+
+class Integer #:nodoc: all
+  include RQRCodeCore::CoreExtensions::Integer::Bitwise
+end

data/lib/rqrcode_core/core_ext/integer/bitwise.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  module CoreExtensions #:nodoc: all
+    module Integer
+      module Bitwise
+        def rszf(count)
+          # zero fill right shift
+          (self >> count) & ((2 ** ((self.size * 8) - count))-1)
+        end
+      end
+    end
+  end
+end
+

data/lib/rqrcode_core/qrcode.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rqrcode_core/qrcode/qr_8bit_byte'
+require 'rqrcode_core/qrcode/qr_alphanumeric'
+require 'rqrcode_core/qrcode/qr_bit_buffer'
+require 'rqrcode_core/qrcode/qr_code'
+require 'rqrcode_core/qrcode/qr_math'
+require 'rqrcode_core/qrcode/qr_numeric'
+require 'rqrcode_core/qrcode/qr_polynomial'
+require 'rqrcode_core/qrcode/qr_rs_block'
+require 'rqrcode_core/qrcode/qr_util'

data/lib/rqrcode_core/qrcode/qr_8bit_byte.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  class QR8bitByte
+    attr_reader :mode
+
+    def initialize( data )
+      @mode = QRMODE[:mode_8bit_byte]
+      @data = data;
+    end
+
+
+    def get_length
+      @data.bytesize
+    end
+
+
+    def write( buffer)
+      buffer.byte_encoding_start(get_length)
+      @data.each_byte do |b|
+        buffer.put(b, 8)
+      end
+    end
+  end
+end

data/lib/rqrcode_core/qrcode/qr_alphanumeric.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  ALPHANUMERIC = ['0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F','G','H','I','J','K','L','M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z',' ','$','%','*','+','-','.','/',':']
+
+  class QRAlphanumeric
+    attr_reader :mode
+
+    def initialize( data )
+      @mode = QRMODE[:mode_alpha_numk]
+
+      raise QRCodeArgumentError, "Not a alpha numeric uppercase string `#{data}`" unless QRAlphanumeric.valid_data?(data)
+
+      @data = data;
+    end
+
+
+    def get_length
+      @data.size
+    end
+
+    def self.valid_data? data
+      data.each_char do |s|
+        return false if ALPHANUMERIC.index(s).nil?
+      end
+      true
+    end
+
+
+    def write( buffer)
+      buffer.alphanumeric_encoding_start(get_length)
+
+      (@data.size).times do |i|
+        if i % 2 == 0
+          if i == (@data.size - 1)
+            value = ALPHANUMERIC.index(@data[i])
+            buffer.put( value, 6 )
+          else
+            value = (ALPHANUMERIC.index(@data[i]) * 45) + ALPHANUMERIC.index(@data[i+1])
+            buffer.put( value, 11 )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rqrcode_core/qrcode/qr_bit_buffer.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module RQRCodeCore
+  class QRBitBuffer
+    attr_reader :buffer
+
+    PAD0 = 0xEC
+    PAD1 = 0x11
+
+    def initialize(version)
+      @version = version
+      @buffer = []
+      @length = 0
+    end
+
+
+    def get( index )
+      buf_index = (index / 8).floor
+      (( (@buffer[buf_index]).rszf(7 - index % 8)) & 1) == 1
+    end
+
+
+    def put( num, length )
+      ( 0...length ).each do |i|
+        put_bit((((num).rszf(length - i - 1)) & 1) == 1)
+      end
+    end
+
+
+    def get_length_in_bits
+      @length
+    end
+
+
+    def put_bit( bit )
+      buf_index = ( @length / 8 ).floor
+      if @buffer.size <= buf_index
+        @buffer << 0
+      end
+
+      if bit
+        @buffer[buf_index] |= ((0x80).rszf(@length % 8))
+      end
+
+      @length += 1
+    end
+
+    def byte_encoding_start(length)
+
+      put( QRMODE[:mode_8bit_byte], 4 )
+      put(length, QRUtil.get_length_in_bits(QRMODE[:mode_8bit_byte], @version))
+
+    end
+
+    def alphanumeric_encoding_start(length)
+
+      put( QRMODE[:mode_alpha_numk], 4 )
+      put(length, QRUtil.get_length_in_bits(QRMODE[:mode_alpha_numk], @version))
+
+    end
+
+    def numeric_encoding_start(length)
+
+      put( QRMODE[:mode_number], 4 )
+      put(length, QRUtil.get_length_in_bits(QRMODE[:mode_number], @version))
+
+    end
+
+    def pad_until(prefered_size)
+      # Align on byte
+      while get_length_in_bits % 8 != 0
+        put_bit( false )
+      end
+
+      # Pad with padding code words
+      while get_length_in_bits < prefered_size
+        put( QRBitBuffer::PAD0, 8 )
+        put( QRBitBuffer::PAD1, 8 ) if get_length_in_bits < prefered_size
+      end
+    end
+
+    def end_of_message(max_data_bits)
+      put( 0, 4 ) unless get_length_in_bits+4 > max_data_bits
+    end
+  end
+end