rqrcode_core 0.1.0 → 1.1.0

checksums.yaml

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

data/.github/workflows/ruby.yml

@@ -0,0 +1,29 @@
+name: rqrcode_core
+
+on:
+  push:
+    branches:
+    - master
+    - release/*
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  Build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ruby/setup-ruby@v1
+      with:
+        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,39 @@
+# 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.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.1.0...HEAD
+[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.0)
+    rqrcode_core (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
-    rake (10.5.0)
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.0.5)
+      rubocop (= 1.12.1)
+      rubocop-performance (= 1.10.1)
+    standardrb (1.0.0)
+      standard
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
@@ -15,8 +43,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rqrcode_core!
+  standardrb (~> 1.0)
 
 BUNDLED WITH
-   2.0.1
+   2.2.15

data/README.md

@@ -1,4 +1,5 @@
-[![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)
+![](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
 
@@ -6,7 +7,7 @@
 
 Features:
 
-* `rqrcode_core` is a ruby only library. It requires no native libraries. Just Ruby!
+* `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.
@@ -18,7 +19,7 @@ Features:
 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
 ```
 
@@ -49,12 +50,12 @@ x xxx x  xxxxx x       xx x xxx x
 ## 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"
@@ -68,7 +69,7 @@ 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)
+size   - the size (integer) of the qrcode (defaults to smallest size needed to encode the string)
 
 level  - the error correction level, can be:
   * Level :l 7%  of code can be restored
@@ -85,13 +86,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.rb

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

data/lib/rqrcode_core/qrcode.rb

@@ -1,11 +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'
+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

@@ -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
-      (( (@buffer[buf_index]).rszf(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|
-        put_bit((((num).rszf(length - i - 1)) & 1) == 1)
+    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] |= ((0x80).rszf(@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