rqrcode_core 0.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa65c1043ff732d79a7c945ebec22c3e58ec30824a10ea66ae2a83666cae0b54
-  data.tar.gz: cd413ba0b0c37980b57d017cc5910dde35cee7c09bf99d6d77ef5d4d74daf287
+  metadata.gz: ea3856aba6c1bc5602b3f7fa4126187fe26c47fdba56447b709871f96f432ff5
+  data.tar.gz: eab7166c0e00478bcdb12ab6a550a9a9b595401bf5f6c0271c6bac95b722564f
 SHA512:
-  metadata.gz: 1e74946cef2ab02b66431dd4e992198392166ae46e837194c2e7f361fcf6a25db37edfdc354ecbc531bbe58d713f6f3a61906c2a365a3b1df79dc03ffcd7296a
-  data.tar.gz: a87de6c5a59cd072c8ec9da9c655b63b519d435cb219ec54a533991eaeece40e4c3778df5f5a566e94f70e8831636454a40476b4e4670f79f3a782f1e3366490
+  metadata.gz: b9d1977c291eaed204644f09d3900b2ea18bde93e1c242628bdf1c4cd30573c046328e3cdbfe294c6ae27370f5963cdfa8454f1f2e6af7bf185e32cd0fefe592
+  data.tar.gz: 56d9c31b3c056a47ffccc2848f43e0e44d3b3a984f0ef4c332505fae31dadda0ca6adac5ad0566443dbf46a86a2b81b419806cf71a9da6880d51eacd583cbb34

data/.github/workflows/ruby.yml

@@ -10,22 +10,20 @@ on:
     - master
 
 jobs:
-  build:
-    name: Test Ruby ${{ matrix.ruby_version }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+  Build:
     strategy:
+      fail-fast: false
       matrix:
-        ruby_version: [2.5.x, 2.6.x]
-        os: [ubuntu-latest]
-
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v1
-    - name: Use Ruby ${{ matrix.ruby_version }}
-      uses: actions/setup-ruby@v1
+    - uses: ruby/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
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run Tests
+      run: bundle exec rake test
+    - name: StandardRB Check
+      run: bundle exec standardrb --format progress

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /.devcontainer/
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.2.0] - 2021-08-26
+
+- Added Multi Mode Support which allows for multi-segment encoding. Thanks to [@ssayer](https://github.com/ssayer)
+
+## [1.1.0] - 2021-07-01
+
+- Add a basic benchmark file
+- Add standardRB badge
+- Add `.freeze` on `CONST` lookup objects
+- Remove unused `@mode` instance variable
+- A batch of small refactors and optimizations
+
+## [1.0.0] - 2021-04-23
+
+### Changed
+
+- README updated
+- Small documentation clarification [@smnscp](https://github.com/smnscp).
+- Rakefile cleaned up. You can now just run `rake` which will run specs and fix linting using `standardrb`
+
+### Breaking Changes
+
+- Very niche but a breaking change never the less. The `to_s` method *no longer* accepts the `:true` and `:false` arguments, but prefers `:dark` and `:light`.
+
+## [0.2.0] - 2020-12-26
+
+### Changed
+
+- fix `required_ruby_version` for Ruby 3 support
+
+[unreleased]: https://github.com/whomwah/rqrcode_core/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/whomwah/rqrcode_core/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/whomwah/rqrcode_core/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/whomwah/rqrcode_core/compare/v0.2.0...v1.0.0
+[0.2.0]: https://github.com/whomwah/rqrcode_core/compare/v0.1.2...v0.2.0

data/Gemfile.lock

@@ -1,13 +1,41 @@
 PATH
   remote: .
   specs:
-    rqrcode_core (0.1.1)
+    rqrcode_core (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
-    rake (13.0.1)
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.1.7)
+      rubocop (= 1.18.4)
+      rubocop-performance (= 1.11.4)
+    standardrb (1.0.0)
+      standard
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -17,6 +45,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rqrcode_core!
+  standardrb (~> 1.0)
 
 BUNDLED WITH
-   2.0.2
+   2.2.22

data/README.md

@@ -1,24 +1,25 @@
-![](https://github.com/whomwah/rqrcode_core/workflows/rqrcode_core/badge.svg)
+![](https://github.com/whomwah/rqrcode_core/actions/workflows/ruby.yml/badge.svg)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 # 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).
+`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 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, but also allows for encoding multiple segments.
+* 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`.
+`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'
+gem "rqrcode_core"
 ```
 
 And then execute:
@@ -32,8 +33,8 @@ Or install it yourself as:
 ## Basic Usage
 
 ```ruby
-$ require 'rqrcode_core'
-$ qr = RQRCodeCore::QRCode.new('my string to generate', size: 4, level: :h)
+$ require "rqrcode_core"
+$ qr = RQRCodeCore::QRCode.new("https://kyan.com")
 $ puts qr.to_s
 ```
 
@@ -46,15 +47,24 @@ x xxx x  xxxxx x       xx x xxx x
 ... etc
 ```
 
+## Multiple Encoding Support
+
+```ruby
+$ require "rqrcode_core"
+$ qr = RQRCodeCore::QRCode.new([{data: "byteencoded", mode: :byte_8bit}, {data: "A1" * 100, mode: :alphanumeric}, {data: "1" * 500, mode: :number}])
+```
+
+This will create a QR Code with byte encoded, alphanumeric and number segments. Any combination of encodings/segments will work provided it fits within size limits.
+
 ## Doing your own rendering
 
 ```ruby
-require 'rqrcode_core'
+require "rqrcode_core"
 
-qr = RQRCodeCore::QRCode.new('my string to generate', size: 4, level: :h)
-qr.modules.each do |row|
+qr = RQRCodeCore::QRCode.new("https://kyan.com")
+qr.rows.each do |row|
   row.each do |col|
-    print col ? '#' : ' '
+    print col ? "#" : " "
   end
 
   print "\n"
@@ -63,12 +73,14 @@ end
 
 ### Options
 
-The library expects a string to be parsed in, other args are optional.
+The library expects a string or array (for multiple encodings) to be parsed in, other args are optional.
 
 ```
-string - the string you wish to encode
+data - the string or array you wish to encode
+
+size - the size (integer) of the QR Code (defaults to smallest size needed to encode the string)
 
-size   - the size of the qrcode (default 4)
+max_size - the max_size (Integer) of the QR Code (default RQRCodeCore::QRUtil.max_size)
 
 level  - the error correction level, can be:
   * Level :l 7%  of code can be restored
@@ -76,7 +88,7 @@ level  - the error correction level, can be:
   * 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):
+mode - the mode of the QR Code (defaults to alphanumeric or byte_8bit, depending on the input data, only used when data is a string):
   * :number
   * :alphanumeric
   * :byte_8bit
@@ -85,13 +97,36 @@ mode   - the mode of the qrcode (defaults to alphanumeric or byte_8bit, dependin
 
 #### Example
 
-```
-qr = RQRCodeCore::QRCode.new('hello world', size: 1, level: :m, mode: :alphanumeric)
+```ruby
+RQRCodeCore::QRCode.new("http://kyan.com", 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.
+### Tests
+
+You can run the test suite using:
+
+```
+$ ./bin/setup
+$ rake
+```
+
+or try the project from the console with:
+
+```
+$ ./bin/console
+```
+
+### Linting
+
+The project uses [standardrb](https://github.com/testdouble/standard) and can be run with:
+
+```
+$ ./bin/setup
+$ rake standard # check
+$ rake standard:fix # fix
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,19 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+begin
+  require "rake/testtask"
+  require "standard/rake"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+  Rake::TestTask.new(:test) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/**/*_test.rb"]
+  end
+
+  task default: [:test, "standard:fix"]
 
-task :default => :test
+  desc "Run a simple benchmark (x1000)"
+  task :benchmark do
+    ruby "test/benchmark.rb"
+  end
+rescue LoadError
+  # no standard/rspec available
+end

data/lib/rqrcode_core/qrcode/qr_8bit_byte.rb

@@ -2,21 +2,13 @@
 
 module RQRCodeCore
   class QR8bitByte
-    attr_reader :mode
-
-    def initialize( data )
-      @mode = QRMODE[:mode_8bit_byte]
-      @data = data;
-    end
-
-
-    def get_length
-      @data.bytesize
+    def initialize(data)
+      @data = data
     end
 
+    def write(buffer)
+      buffer.byte_encoding_start(@data.bytesize)
 
-    def write( buffer)
-      buffer.byte_encoding_start(get_length)
       @data.each_byte do |b|
         buffer.put(b, 8)
       end

data/lib/rqrcode_core/qrcode/qr_alphanumeric.rb

@@ -1,43 +1,36 @@
 # 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',' ','$','%','*','+','-','.','/',':']
+  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", " ", "$",
+    "%", "*", "+", "-", ".", "/", ":"
+  ].freeze
 
   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 initialize(data)
+      unless QRAlphanumeric.valid_data?(data)
+        raise QRCodeArgumentError, "Not a alpha numeric uppercase string `#{data}`"
+      end
 
-    def get_length
-      @data.size
+      @data = data
     end
 
-    def self.valid_data? data
-      data.each_char do |s|
-        return false if ALPHANUMERIC.index(s).nil?
-      end
-      true
+    def self.valid_data?(data)
+      (data.chars - ALPHANUMERIC).empty?
     end
 
+    def write(buffer)
+      buffer.alphanumeric_encoding_start(@data.size)
 
-    def write( buffer)
-      buffer.alphanumeric_encoding_start(get_length)
-
-      (@data.size).times do |i|
+      @data.size.times do |i|
         if i % 2 == 0
           if i == (@data.size - 1)
             value = ALPHANUMERIC.index(@data[i])
-            buffer.put( value, 6 )
+            buffer.put(value, 6)
           else
-            value = (ALPHANUMERIC.index(@data[i]) * 45) + ALPHANUMERIC.index(@data[i+1])
-            buffer.put( value, 11 )
+            value = (ALPHANUMERIC.index(@data[i]) * 45) + ALPHANUMERIC.index(@data[i + 1])
+            buffer.put(value, 11)
           end
         end
       end

data/lib/rqrcode_core/qrcode/qr_bit_buffer.rb

@@ -13,74 +13,64 @@ module RQRCodeCore
       @length = 0
     end
 
-
-    def get( index )
+    def get(index)
       buf_index = (index / 8).floor
-      (( QRUtil.rszf(@buffer[buf_index], 7 - index % 8)) & 1) == 1
+      ((QRUtil.rszf(@buffer[buf_index], 7 - index % 8)) & 1) == 1
     end
 
-
-    def put( num, length )
-      ( 0...length ).each do |i|
+    def put(num, length)
+      (0...length).each do |i|
         put_bit(((QRUtil.rszf(num, length - i - 1)) & 1) == 1)
       end
     end
 
-
     def get_length_in_bits
       @length
     end
 
-
-    def put_bit( bit )
-      buf_index = ( @length / 8 ).floor
+    def put_bit(bit)
+      buf_index = (@length / 8).floor
       if @buffer.size <= buf_index
         @buffer << 0
       end
 
       if bit
-        @buffer[buf_index] |= (QRUtil.rszf(0x80, @length % 8))
+        @buffer[buf_index] |= QRUtil.rszf(0x80, @length % 8)
       end
 
       @length += 1
     end
 
     def byte_encoding_start(length)
-
-      put( QRMODE[:mode_8bit_byte], 4 )
+      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(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(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 )
+        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
+        put(PAD0, 8)
+        put(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
+      put(0, 4) unless get_length_in_bits + 4 > max_data_bits
     end
   end
 end