base32-url 0.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2636154ecf4c12b4aebc6f7d902512a068caa8d119a66222e4c6bc5f986b550a
-  data.tar.gz: 1a6f5b368de218189acde3401611f116182e48318739c3b417cd3356cbc9ff09
+  metadata.gz: 6700c1c53464c4318f6361ebe22cf4276c925f24bf92cc6fc841e2075c502e6a
+  data.tar.gz: 5b58a804226b9714abde687042e207d8d00a10ed0859c716ccefa1c350a7fd69
 SHA512:
-  metadata.gz: 017d4b5c6246fbd756c03a39cc6746ccafe5fde79d2620f62321dd2ebc24c9ce4121ca1aecb1f03c26834c636806e0eeec7081f1a9260df8e9bae51d6b8cebac
-  data.tar.gz: fa73fb138288c1cec305373c74fa5e690129b52a066bf27e754f357912acf37b19767b588bac710dabfd151d6199d8869a2e8ffcf5d72da56c5a82e0c44bb032
+  metadata.gz: fa905b9b15aafdeb4ef156da982952e613d397b0f4dda8d5a1145eaeda61b461deeba2410f850564d20246ad5902c84d02d330602d1a30d7b9f9f0ede5b785c4
+  data.tar.gz: 1831d2538ff6892222341b9082db32ee93456e9385a0521db10a2549ef50eb7940e2cd57bcce3ae82c98518c010e6508c68994ce325699c6ab38293d45eb7780

data/.github/workflows/build.yml

@@ -0,0 +1,38 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby 3.1
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install
+          bundle exec rake test
+      - name: fix code coverage paths
+        working-directory: ./coverage
+        run: |
+          sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.json
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-report
+          path: coverage/coverage.json
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 doc
 pkg
+coverage

data/README.md

@@ -1,5 +1,7 @@
+[![Build](https://github.com/front-matter/base32-url/actions/workflows/build.yml/badge.svg)](https://github.com/front-matter/base32-url/actions/workflows/build.yml)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=front-matter_base32-url&metric=coverage)](https://sonarcloud.io/summary/new_code?id=front-matter_base32-url)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=front-matter_base32-url&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=front-matter_base32-url)
 [![Gem Version](https://badge.fury.io/rb/base32-url.svg)](https://badge.fury.io/rb/base32-url)
-[![Build Status](https://travis-ci.org/datacite/base32-url.svg?branch=master)](https://travis-ci.org/datacite/base32-url)
 
 An implementation of Douglas Crockfords Base32-Encoding in Ruby, with two modifications to make
 the resulting strings more URL friendly:
@@ -18,6 +20,7 @@ $ gem install base32-url
 ## Changes
 
 ```
+0.6.0 - support Ruby versions beyond 2.x
 0.5.0 - use mod 97-10 (ISO 7064) to calculate checksum
 0.3.0 - encode into lower case characters, use * ~ _ ^ u for checksum
 0.2.0 - added optional checksum

data/Rakefile

@@ -6,5 +6,4 @@ Bundler::GemHelper.install_tasks
 require 'rake/testtask'
 Rake::TestTask.new(:test)
 
-task :default => :test
-
+task default: :test

data/base32-url.gemspec

@@ -1,26 +1,29 @@
-require "date"
-require File.expand_path("../lib/base32/version", __FILE__)
+require 'date'
+require File.expand_path('lib/base32/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.authors       = "Martin Fenner"
-  s.email         = "mfenner@datacite.org"
-  s.name          = "base32-url"
-  s.homepage      = "https://github.com/datacite/base32-url"
-  s.summary       = "Ruby client library for conversion of DOI Metadata"
+  s.authors       = 'Martin Fenner'
+  s.email         = 'martin@front-matter.io'
+  s.name          = 'base32-url'
+  s.homepage      = 'https://github.com/front-matter/base32-url'
+  s.summary       = '32-symbol notation for expressing numbers in a form that can be conveniently and accurately transmitted between humans'
   s.date          = Date.today
-  s.description   = "32-symbol notation for expressing numbers in a form that can be conveniently and accurately transmitted between humans. URL-friendly version of the base32-crockford gem."
-  s.require_paths = ["lib"]
+  s.description   = '32-symbol notation for expressing numbers in a form that can be conveniently and accurately transmitted between humans. URL-friendly version of the base32-crockford gem.'
+  s.require_paths = ['lib']
   s.version       = Base32::Url::VERSION
-  s.extra_rdoc_files = ["README.md"]
-  s.license       = 'MIT'
-  s.required_ruby_version = '~> 2.2'
+  s.extra_rdoc_files = ['README.md']
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 2.6.0'
 
   # Declary dependencies here, rather than in the Gemfile
-  s.add_development_dependency 'bundler', '~> 1.0'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'test-unit', '~> 3.2.3'
+  s.add_development_dependency 'bundler', '>= 1.11', "< 3"
+  s.add_development_dependency 'rake', '>= 11.3', "< 14"
+  s.add_development_dependency 'rubocop', '~> 1.36'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'simplecov', '0.22.0'
+  s.add_development_dependency 'simplecov_json_formatter', '~> 0.1.4'
+  s.add_development_dependency 'test-unit', '~> 3.2', '>= 3.2.3'
 
-  s.require_paths = ["lib"]
-  s.files       = `git ls-files`.split($/)
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.files = `git ls-files`.split($/)
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 end

data/lib/base32/url.rb

@@ -1,11 +1,10 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 #
 # (c) 2008, Levin Alexander <http://levinalex.net>
 #
 # This file is released under the same license as ruby.
 
-require 'enumerator'
-
 module Base32
 end
 
@@ -38,12 +37,11 @@ end
 #
 class Base32::URL
   ENCODE_CHARS =
-    %w(0 1 2 3 4 5 6 7 8 9 a b c d e f g h j k m n p q r s t v w x y z ?)
+    %w[0 1 2 3 4 5 6 7 8 9 a b c d e f g h j k m n p q r s t v w x y z ?].freeze
 
-  DECODE_MAP = ENCODE_CHARS.to_enum(:each_with_index).reduce({}) do |hsh, (c,i)|
+  DECODE_MAP = ENCODE_CHARS.to_enum(:each_with_index).each_with_object({}) do |(c, i), hsh|
     hsh[c] = i
-    hsh
-  end.merge({'i' => 1, 'l' => 1, 'o' => 0})
+  end.merge({ 'i' => 1, 'l' => 1, 'o' => 0 })
 
   # encodes an integer into a string
   #
@@ -61,7 +59,7 @@ class Base32::URL
   #
   def self.encode(number, opts = {})
     # verify options
-    raise ArgumentError unless (opts.keys - [:length, :split, :checksum] == [])
+    raise ArgumentError unless opts.keys - %i[length split checksum] == []
 
     str = number.to_s(2).reverse.scan(/.{1,5}/).map do |bits|
       ENCODE_CHARS[bits.reverse.to_i(2)]
@@ -69,15 +67,15 @@ class Base32::URL
 
     if opts[:checksum]
       remainder = 98 - ((number * 100) % 97)
-      str += sprintf("%02d", remainder)
+      str += format('%02d', remainder)
     end
 
     str = str.rjust(opts[:length], '0') if opts[:length]
 
     if opts[:split]
       str = str.reverse
-      str = str.scan(/.{1,#{opts[:split]}}/).map { |x| x.reverse }
-      str = str.reverse.join("-")
+      str = str.scan(/.{1,#{opts[:split]}}/).map(&:reverse)
+      str = str.reverse.join('-')
     end
 
     str
@@ -99,11 +97,14 @@ class Base32::URL
   # decoded, or if checksum option is used and checksum is incorrect
 
   def self.decode(string, opts = {})
-    string, checksum = string[0..-3], string[-2..-1].to_i if opts[:checksum]
+    if opts[:checksum]
+      checksum = string[-2..].to_i
+      string = string[0..-3]
+    end
 
-    number = clean(string).split(//).map { |char|
+    number = clean(string).split(//).map do |char|
       DECODE_MAP[char] or return nil
-    }.inject(0) { |result,val| (result << 5) + val }
+    end.inject(0) { |result, val| (result << 5) + val }
 
     if opts[:checksum]
       remainder = 98 - ((number * 100) % 97)
@@ -114,7 +115,7 @@ class Base32::URL
   end
 
   # same as decode, but raises ArgumentError when the string can't be decoded
-  def self.decode!(string, opts = {})
+  def self.decode!(string, _opts = {})
     decode(string) or raise ArgumentError
   end
 
@@ -142,12 +143,12 @@ class Base32::URL
   # decoded
   #
   def self.valid?(string, opts = {})
-    !(normalize(string, opts) =~ /\?/)
+    (normalize(string, opts) !~ /\?/)
   end
 
   class << self
     def clean(string)
-      string.gsub(/-/,'').downcase
+      string.gsub(/-/, '').downcase
     end
     private :clean
   end

data/lib/base32/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Base32
   module Url
-    VERSION = "0.5"
+    VERSION = '0.6.0'
   end
 end

data/lib/base32-url.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'base32/url'

data/sonar-project.properties

@@ -0,0 +1,11 @@
+sonar.organization=front-matter
+sonar.projectKey=front-matter_base32-url
+
+# This is the name and version displayed in the SonarCloud UI.
+sonar.projectName=base32-url
+#sonar.projectVersion=1.0
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+sonar.sources=.
+
+sonar.ruby.coverage.reportPaths=coverage/coverage.json

data/test/test_base32_url.rb

@@ -1,13 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov_json_formatter'
+SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
+SimpleCov.start
 
 require 'test/unit'
 require 'base32/url'
 
 class TestBase32Url < Test::Unit::TestCase
-
   def test_encoding_and_decoding_single_chars
     from = (0..31).to_a
-    to = %w(0 1 2 3 4 5 6 7 8 9 a b c d e f g h j k m n p q r s t v w x y z)
+    to = %w[0 1 2 3 4 5 6 7 8 9 a b c d e f g h j k m n p q r s t v w x y z]
 
     from.zip(to) do |symbol_value, encode_symbol|
       assert_equal encode_symbol, Base32::URL.encode(symbol_value)
@@ -16,22 +20,22 @@ class TestBase32Url < Test::Unit::TestCase
   end
 
   def test_encoding_larger_numbers
-    assert_equal("10", Base32::URL.encode(32))
-    assert_equal("16j", Base32::URL.encode(1234))
+    assert_equal('10', Base32::URL.encode(32))
+    assert_equal('16j', Base32::URL.encode(1234))
   end
 
   def test_decoding_strings
-    assert_equal(1234, Base32::URL.decode("16j"))
+    assert_equal(1234, Base32::URL.decode('16j'))
   end
 
   def test_decoding_normalizes_symbols
     assert_equal Base32::URL.decode('11100110'),
-      Base32::URL.decode('IL1O0ilo')
+                 Base32::URL.decode('IL1O0ilo')
   end
 
   def test_decoding_lowercase
-    assert_equal Base32::URL.decode("abcdefghijklmnopqrstvwxyz"),
-      Base32::URL.decode("ABCDEFGHIJKLMNOPQRSTVWXYZ")
+    assert_equal Base32::URL.decode('abcdefghijklmnopqrstvwxyz'),
+                 Base32::URL.decode('ABCDEFGHIJKLMNOPQRSTVWXYZ')
   end
 
   def test_decoding_invalid_strings
@@ -40,58 +44,58 @@ class TestBase32Url < Test::Unit::TestCase
   end
 
   def test_decode_should_ignore_hyphens
-    assert_equal 1234, Base32::URL.decode("1-6-j")
+    assert_equal 1234, Base32::URL.decode('1-6-j')
   end
 
   def test_normalize
-    assert_equal "he110w0r1d", Base32::URL.normalize("hello-world")
-    assert_equal "he110w0r1d", Base32::URL.normalize("HELLO-WORLD")
-    assert_equal "b?123", Base32::URL.normalize("BU-123")
+    assert_equal 'he110w0r1d', Base32::URL.normalize('hello-world')
+    assert_equal 'he110w0r1d', Base32::URL.normalize('HELLO-WORLD')
+    assert_equal 'b?123', Base32::URL.normalize('BU-123')
   end
 
   def test_normalize_with_checksum
-    assert_equal "b?1223", Base32::URL.normalize("BU-123", :checksum => true)
-    assert_equal "b1223", Base32::URL.normalize("B123", :checksum => true)
+    assert_equal 'b?1223', Base32::URL.normalize('BU-123', checksum: true)
+    assert_equal 'b1223', Base32::URL.normalize('B123', checksum: true)
   end
 
   def test_valid
-    assert_equal true, Base32::URL.valid?("hello-world")
-    assert_equal false, Base32::URL.valid?("BU-123")
+    assert_equal true, Base32::URL.valid?('hello-world')
+    assert_equal false, Base32::URL.valid?('BU-123')
   end
 
   def test_valid_with_checksum
-    assert_equal true, Base32::URL.valid?("b123u", :checksum => true)
-    assert_equal false, Base32::URL.valid?("bu-123", :checksum => true)
+    assert_equal true, Base32::URL.valid?('b123u', checksum: true)
+    assert_equal false, Base32::URL.valid?('bu-123', checksum: true)
   end
 
   def test_length_and_hyphenization
-    assert_equal "0016j", Base32::URL.encode(1234, :length => 5)
-    assert_equal "0-01-6j",
-      Base32::URL.encode(1234, :length => 5, :split => 2)
-    assert_equal "00-010",
-      Base32::URL.encode(32, :length => 5, :split => 3)
+    assert_equal '0016j', Base32::URL.encode(1234, length: 5)
+    assert_equal '0-01-6j',
+                 Base32::URL.encode(1234, length: 5, split: 2)
+    assert_equal '00-010',
+                 Base32::URL.encode(32, length: 5, split: 3)
   end
 
   def test_encoding_checksum
-    assert_equal "16j82",
-      Base32::URL.encode(1234, :checksum => true)
-    assert_equal "016j82",
-      Base32::URL.encode(1234, :length => 6, :checksum => true)
-    assert_equal "01-6j-82",
-      Base32::URL.encode(1234, :length => 6, :split => 2, :checksum => true)
+    assert_equal '16j82',
+                 Base32::URL.encode(1234, checksum: true)
+    assert_equal '016j82',
+                 Base32::URL.encode(1234, length: 6, checksum: true)
+    assert_equal '01-6j-82',
+                 Base32::URL.encode(1234, length: 6, split: 2, checksum: true)
   end
 
   def test_decoding_checksum
     assert_equal 1234,
-      Base32::URL.decode("16j82", :checksum => true)
+                 Base32::URL.decode('16j82', checksum: true)
     assert_equal 1234,
-      Base32::URL.decode("016j82", :length => 6, :checksum => true)
+                 Base32::URL.decode('016j82', length: 6, checksum: true)
     assert_equal 1234,
-      Base32::URL.decode("01-6j-82", :length => 6, :split => 2, :checksum => true)
+                 Base32::URL.decode('01-6j-82', length: 6, split: 2, checksum: true)
   end
 
   def test_decoding_invalid_checksum
     assert_equal nil,
-      Base32::URL.decode("16j44", :checksum => true)
+                 Base32::URL.decode('16j44', checksum: true)
   end
 end

metadata

@@ -1,48 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: base32-url
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.6.0
 platform: ruby
 authors:
 - Martin Fenner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.3
   type: :development
@@ -50,17 +121,21 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.3
 description: 32-symbol notation for expressing numbers in a form that can be conveniently
   and accurately transmitted between humans. URL-friendly version of the base32-crockford
   gem.
-email: mfenner@datacite.org
+email: martin@front-matter.io
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -71,29 +146,31 @@ files:
 - lib/base32-url.rb
 - lib/base32/url.rb
 - lib/base32/version.rb
+- sonar-project.properties
 - test/test_base32_url.rb
-homepage: https://github.com/datacite/base32-url
+homepage: https://github.com/front-matter/base32-url
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.4.8
+signing_key:
 specification_version: 4
-summary: Ruby client library for conversion of DOI Metadata
-test_files: []
+summary: 32-symbol notation for expressing numbers in a form that can be conveniently
+  and accurately transmitted between humans
+test_files:
+- test/test_base32_url.rb