ruby-short_url 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d1ec6226599a832509efde0026d2e617ac9e8b624afdf4659e9b6b5e22c695d
-  data.tar.gz: 1ebc6a2ab572cd422f7cd72ec401cedb3355d6bbc79dd5432337b742758ac18e
+  metadata.gz: 969037b93fe75fa29b45de3cc6e931886b16a9d9485530f59efb0f64eb80c578
+  data.tar.gz: dd827e2a29013e165c08e9c1f010452f9e0b054abd208a2fde16cc7c5e0c4193
 SHA512:
-  metadata.gz: d95b0b18faaa8dd3b01e59d4aa26efab02195c75c049298eb253a8f569ca10939a12789e6c84584d8e461d7c06efac6b87c6802cdc56dc9ce7d0ac6a0922171e
-  data.tar.gz: 345d2afce842c154cee3847b08aa62a0a86775537c494f7078f478b2105cde2b93641c8072bb51110e6d7a1d4fc75ee1f0bd02fa23409e2d81bde33e01dc775f
+  metadata.gz: 123a3efa9602bb2478dcca44eb96a8a1b3d82f90ffea47013e37a43b03e8d68df65cf37673134c40331d1a46b7729cee7e7b3e85c3bea204daa78b24abb31c46
+  data.tar.gz: 948c137acda8b9865289c633f935e3a59e05b587771cd1fe78d0e1f096208f3e2951a93cb4ee09fd34ed05cbb24f2ae3a87c8e1b15089e695cae847f81214e41

data/.github/workflows/coverage.yml

@@ -0,0 +1,18 @@
+name: Coverage
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: codeclimate report
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - run: bundle install
+    - uses: paambaati/codeclimate-action@v2.5.4
+      env:
+        CC_TEST_REPORTER_ID: 357da37cbdcc472b4b33ba5f6e8a6fcc14ebcb41bb951b5133c547818ad6fbb3
+      with:
+        coverageCommand: bundle exec rake

data/.github/workflows/rubocop.yml

@@ -11,10 +11,4 @@ jobs:
       with:
         ruby-version: 2.6
     - run: bundle install
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-gems-
     - run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test
+on: [pull_request]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+    runs-on: ubuntu-latest
+    name: Test
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle install
+    - run: bundle exec rake

data/.rubocop.yml

@@ -1,7 +1,7 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
+Style/HashEachMethods:
+  Enabled: false
 Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:

data/README.md

@@ -1,8 +1,8 @@
 # Ruby::ShortUrl
 
-[![Build Status](https://travis-ci.org/toshimaru/ruby-short_url.svg?branch=master)](https://travis-ci.org/toshimaru/ruby-short_url)
-![RuboCop](https://github.com/toshimaru/ruby-short_url/workflows/RuboCop/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/ruby-short_url.svg)](http://badge.fury.io/rb/ruby-short_url)
+![Test](https://github.com/toshimaru/ruby-short_url/workflows/Test/badge.svg)
+![RuboCop](https://github.com/toshimaru/ruby-short_url/workflows/RuboCop/badge.svg)
 [![Test Coverage](https://codeclimate.com/github/toshimaru/ruby-short_url/badges/coverage.svg)](https://codeclimate.com/github/toshimaru/ruby-short_url/coverage)
 [![Code Climate](https://codeclimate.com/github/toshimaru/ruby-short_url/badges/gpa.svg)](https://codeclimate.com/github/toshimaru/ruby-short_url)
 
@@ -11,6 +11,10 @@
 Ruby implementation for generating Tiny URL. The implementation is based on [python-short_url](https://github.com/Alir3z4/python-short_url).
 
 > A bit-shuffling approach is used to avoid generating consecutive, predictable URLs. However, the algorithm is deterministic and will guarantee that no collisions will occur.
+>
+> The URL alphabet is fully customizable and may contain any number of characters.
+
+> The intended use is that incrementing, consecutive integers will be used as keys to generate the short URLs. For example, when creating a new URL, the unique integer ID assigned by a database could be used to generate the URL by using this module. Or a simple counter may be used. As long as the same integer is not used twice, the same short URL will not be generated twice.
 
 More detail is [here](https://github.com/Alir3z4/python-short_url#short-url-generator).
 
@@ -40,7 +44,7 @@ Ruby::ShortUrl::Encoder.new.encode_url(123456) # => "00crI"
 Ruby::ShortUrl::Encoder.new.decode_url("00crI") # => 123456
 ```
 
-### Create your own short URL
+### Create your own URL Shortner
 
 ```rb
 class CustomEncoder < Ruby::ShortUrl::Encoder
@@ -61,6 +65,8 @@ end
 # => "00011"
 # > custom_encoder.encode_url(3)
 # => "00033"
+# > custom_encoder.encode_url(4)
+# => "0000a"
 #
 # > custom_encoder.decode_url("00022")
 # => 1
@@ -68,6 +74,8 @@ end
 # => 2
 # > custom_encoder.decode_url("00033")
 # => 3
+# > custom_encoder.decode_url("0000a")
+# => 4
 ```
 
 ## Development

data/lib/ruby/short_url/encoder.rb

@@ -13,67 +13,66 @@ module Ruby
         raise ArgumentError, 'block_size must be greater than 0.' unless block_size > 0
 
         @alphabet = alphabet
-        @block_size = block_size
         @mask = (1 << block_size) - 1
-        @mapping = (0..block_size - 1).to_a
+        @mapping = (0...block_size).to_a.reverse!
       end
 
-      def encode_url(n, min_length: MIN_LENGTH)
-        enbase(encode(n), min_length)
+      def encode_url(int, min_length: MIN_LENGTH)
+        enbase(encode(int), min_length)
       end
 
-      def decode_url(n)
-        decode(debase(n))
+      def decode_url(str)
+        decode(debase(str))
       end
 
       private
 
-      def encode(n)
-        (n & ~@mask) | _encode(n & @mask)
+      def encode(int)
+        (int & ~@mask) | _encode(int & @mask)
       end
 
-      def decode(n)
-        (n & ~@mask) | _decode(n & @mask)
+      def decode(int)
+        (int & ~@mask) | _decode(int & @mask)
       end
 
-      def enbase(x, min_length)
-        result = _enbase(x)
+      def enbase(int, min_length)
+        result = _enbase(int)
         padding_length = min_length - result.length
         padding_length = 0 if padding_length < 0
         padding = @alphabet[0] * padding_length
         padding.to_s + result.to_s
       end
 
-      def debase(x)
-        n = @alphabet.length
-        x.split('').reverse.each_with_index.inject(0) do |result, (c, i)|
-          result + @alphabet.index(c) * (n**i)
+      def debase(str)
+        len = @alphabet.length
+        str.split('').reverse.each_with_index.sum do |char, idx|
+          @alphabet.index(char) * (len**idx)
         end
       end
 
-      def _encode(n)
-        @mapping.reverse.each_with_index.inject(0) do |result, (b, i)|
-          _calc_result(result, n, b, i)
+      def _encode(int)
+        @mapping.each_with_index.inject(0) do |result, (val, idx)|
+          _calc_result(result, int, val, idx)
         end
       end
 
-      def _decode(n)
-        @mapping.reverse.each_with_index.inject(0) do |result, (b, i)|
-          _calc_result(result, n, i, b)
+      def _decode(int)
+        @mapping.each_with_index.inject(0) do |result, (val, idx)|
+          _calc_result(result, int, idx, val)
         end
       end
 
-      def _calc_result(result, n, x, y)
-        return result |= (1 << x) if n & (1 << y) != 0
+      def _calc_result(result, int, int1, int2)
+        return result |= (1 << int1) if int & (1 << int2) != 0
 
         result
       end
 
-      def _enbase(x)
-        n = @alphabet.length
-        return @alphabet[x] if x < n
+      def _enbase(int)
+        len = @alphabet.length
+        return @alphabet[int] if int < len
 
-        _enbase(x / n) + @alphabet[x % n]
+        _enbase(int / len) + @alphabet[int % len]
       end
     end
   end

data/lib/ruby/short_url/version.rb

@@ -2,6 +2,6 @@
 
 module Ruby
   module ShortUrl
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/ruby-short_url.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-short_url
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - toshimaru
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-03-11 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -17,11 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/coverage.yml"
 - ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -43,7 +43,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rubocop_todo.yml

@@ -1,14 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2020-03-09 23:12:09 +0900 using RuboCop version 0.80.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 12
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/ruby/short_url/encoder.rb'

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.8
-  - 2.4.8
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-after_success:
-  - bundle exec codeclimate-test-reporter
-addons:
-  code_climate:
-    repo_token: 357da37cbdcc472b4b33ba5f6e8a6fcc14ebcb41bb951b5133c547818ad6fbb3