ruby-short_url 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 192c6995b9316fbaca400d15b827721689404d83
-  data.tar.gz: 78041a4f6e844b9de877be4b180f8a7ee2075f07
+SHA256:
+  metadata.gz: 0d1ec6226599a832509efde0026d2e617ac9e8b624afdf4659e9b6b5e22c695d
+  data.tar.gz: 1ebc6a2ab572cd422f7cd72ec401cedb3355d6bbc79dd5432337b742758ac18e
 SHA512:
-  metadata.gz: 463ac634e1cb35ce867323720933b810690d87c9719423cd76c50bfd6cd9d9448cacf5e098e63ac26d622aa8403576ba436064f06b8ace3c06728db23b881899
-  data.tar.gz: f98d70f0346e34dfce2d1348dec11783194711807a10928a29fd7899b198d4fdb5144a73ebe87d36e6e387401745e61283c18658cbf698d19d55e62588d5540f
+  metadata.gz: d95b0b18faaa8dd3b01e59d4aa26efab02195c75c049298eb253a8f569ca10939a12789e6c84584d8e461d7c06efac6b87c6802cdc56dc9ce7d0ac6a0922171e
+  data.tar.gz: 345d2afce842c154cee3847b08aa62a0a86775537c494f7078f478b2105cde2b93641c8072bb51110e6d7a1d4fc75ee1f0bd02fa23409e2d81bde33e01dc775f

data/.github/workflows/rubocop.yml

@@ -0,0 +1,20 @@
+name: RuboCop
+on: [pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: rubocop
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      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/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Layout/LineLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Style/NumericPredicate:
+  EnforcedStyle: comparison

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# 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,11 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.4
-  - 2.4.1
+  - 2.3.8
+  - 2.4.8
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 after_success:
   - bundle exec codeclimate-test-reporter
 addons:

data/Gemfile

@@ -1,4 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ruby-short_url.gemspec
 gemspec
+
+gem 'bundler'
+gem 'codeclimate-test-reporter', '~> 1.0'
+gem 'minitest'
+gem 'minitest-reporters'
+gem 'rake'
+gem 'rubocop'
+gem 'simplecov'

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 toshi
+Copyright (c) 2020 toshimaru
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,12 +1,14 @@
 # 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 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)
-[![Dependency Status](https://gemnasium.com/toshimaru/ruby-short_url.svg)](https://gemnasium.com/toshimaru/ruby-short_url)
 
-Ruby implementation for generating Tiny URL. Ruby implementation of [python-short_url](https://github.com/Alir3z4/python-short_url)
+## Description
+
+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.
 
@@ -47,7 +49,9 @@ class CustomEncoder < Ruby::ShortUrl::Encoder
     super(alphabet: "0123abc", block_size: 5)
   end
 end
+```
 
+```rb
 # > custom_encoder = CustomEncoder.new
 # => #<CustomEncoder:0x007faf3babc830 @alphabet="0123abc", @block_size=5, @mask=31, @mapping=[0, 1, 2, 3, 4]>
 #
@@ -68,14 +72,14 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/ruby-short_url/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/toshimaru/ruby-short_url. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,9 +1,11 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-task :default => :test
+task default: :test
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "ruby-short_url"
+require 'bundler/setup'
+require 'ruby-short_url'
 
 # 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.
@@ -10,5 +11,5 @@ require "ruby-short_url"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/ruby/short_url/encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ruby
   module ShortUrl
     # Original imprementation is here: https://github.com/Alir3z4/python-short_url
@@ -7,8 +9,8 @@ module Ruby
       MIN_LENGTH = 5
 
       def initialize(alphabet: DEFAULT_ALPHABET, block_size: DEFAULT_BLOCK_SIZE)
-        raise ArgumentError.new('alphabet must contain at least 2 characters.') if alphabet.length < 2
-        raise ArgumentError.new('block_size must be greater than 0.') unless block_size > 0
+        raise ArgumentError, 'alphabet must contain at least 2 characters.' if alphabet.length < 2
+        raise ArgumentError, 'block_size must be greater than 0.' unless block_size > 0
 
         @alphabet = alphabet
         @block_size = block_size
@@ -63,12 +65,14 @@ module Ruby
 
       def _calc_result(result, n, x, y)
         return result |= (1 << x) if n & (1 << y) != 0
+
         result
       end
 
       def _enbase(x)
         n = @alphabet.length
         return @alphabet[x] if x < n
+
         _enbase(x / n) + @alphabet[x % n]
       end
     end

data/lib/ruby/short_url/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Ruby
   module ShortUrl
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.1.0'
   end
 end

data/lib/ruby-short_url.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'ruby/short_url/version'
 require 'ruby/short_url/encoder'

data/ruby-short_url.gemspec

@@ -1,27 +1,22 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby/short_url/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ruby-short_url"
+  spec.name          = 'ruby-short_url'
   spec.version       = Ruby::ShortUrl::VERSION
-  spec.authors       = ["toshimaru"]
-  spec.email         = ["me@toshimaru.net"]
+  spec.authors       = ['toshimaru']
+  spec.email         = ['me@toshimaru.net']
 
-  spec.summary       = %q{Small library for generating tiny URL. Ruby port of python-short_url.}
-  spec.homepage      = "https://github.com/toshimaru/ruby-short_url"
+  spec.summary       = 'Small library for generating tiny URL. Ruby port of python-short_url.'
+  spec.homepage      = 'https://github.com/toshimaru/ruby-short_url'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-reporters"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "simplecov"
+  spec.required_ruby_version = '>= 2.3.0'
 end

metadata

@@ -1,99 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby-short_url
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - toshimaru
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2020-03-09 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - me@toshimaru.net
@@ -101,7 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -124,15 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Small library for generating tiny URL. Ruby port of python-short_url.