slothful-code-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8dbd14d94387b3989432616c6fac8ad9d6dbd95b51bc665db1bf612672376ed
+  data.tar.gz: c0eb253a2e8d63f85e844d7df91b6593b1048c9024e8564a9e824f7e44af4788
+SHA512:
+  metadata.gz: 695fa543111485dd49ea0daf207c39bde52f1f387f67a77beaabce4d5935f21719efd4d6f7aa8f967b1ff97e18e12b070abea05caffa5f3f51b93cc3b3fb2939
+  data.tar.gz: 0b67467a85a6729a261bbd76e4d94f6eb563e10bea0f374a1e9b23c2c938e64bd62d2dfff56e063873f6c0d3a1b321438a1f1d3fd2953a02a251639cc380a8e3

data/.editorconfig

@@ -0,0 +1,3 @@
+[*]
+indent_size = 2
+indent_style = space

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slothful-code-generator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2021, Colorful Company,Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,46 @@
+# SlothfulCode
+
+ある程度人間にとって扱いやすい長さ、複雑さで、類推しにくく、重複しないコードを生成、検証する
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slothful-code-generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slothful-code-generator
+
+## Usage
+
+```ruby
+require 'slothful_code'
+```
+
+### ganerate
+
+```ruby
+sc = SlothfulCode.new(<salt>)
+sc.generate(type_id: '1') # => '989JV7WDCN6Q-1'
+```
+
+### decode
+
+```ruby
+sc = SlothfulCode.new(<salt>)
+sc.decode(<code>) # => {:type_id=>'1', :time=>[1612769809, 113]}
+```
+
+### valid?
+
+```ruby
+sc = SlothfulCode.new(<salt>)
+sc.valid?(<code>) # => true / false
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/Steepfile

@@ -0,0 +1,7 @@
+# -*- mode: ruby -*-
+
+target :lib do
+  signature "sig"
+
+  check "lib"                       # Directory name
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slothful_code"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slothful-code-generator.rb

@@ -0,0 +1 @@
+require_relative './slothful_code'

data/lib/slothful_code.rb

@@ -0,0 +1,134 @@
+require "hashids"
+require "slothful_code/version"
+
+#
+# 識別コードを生成、検証する
+#
+# hashids を利用して長過ぎず短過ぎない、人間に読み書きしやすくユニー
+# クな文字列を生成し、またその文字列が適切にこのシステムが生成したも
+# のかどうかを検証できる仕組み
+#
+# 数字と英大文字のうち数字と紛らわしくない文字を利用して11, 12桁程度に
+# 収まるだろう文字列を生成する
+#
+# sc = SlothfulCode.new
+# sc.generate(type_id: '1') # => 'R6B7ZRDT6EY-1'
+#
+# see https://hashids.org/
+# 
+class SlothfulCode
+  class Error < StandardError; end
+  class WrongTypeId < Error; end
+  
+  HASHIDS_INCLUDE_CHARS = '1234567890ABCDEFGHJKLMNPQRSTUVWXYZ'.freeze
+  TYPE_CHARS = /\A[0-9A-Z]+\z/
+  
+  #
+  # [param] String salt
+  #
+  def initialize(salt = '')
+    @id_processor = Hashids.new(salt, 6, HASHIDS_INCLUDE_CHARS)
+  end
+  attr_reader :resources
+
+  #
+  # コードを生成する
+  #
+  # [param] String type_id
+  # [return] String
+  #
+  def generate(type_id:)
+    t = time_array
+
+    if type_id.to_s =~ TYPE_CHARS
+      hash = [
+        @id_processor.encode(t),
+        type_id.to_s
+      ].join('-')
+
+      @resources = { type_id: type_id.to_s, time: t }
+      hash
+    else
+      raise WrongTypeId
+    end
+  end
+
+  #
+  # 与えられたコードが hashids で decode できるかどうか
+  #
+  # [param] String code
+  # [return] Boolean
+  #
+  def valid?(code)
+    decode(code).size > 0
+  end
+
+  #
+  # [param] String code
+  # [return] Hash
+  #
+  # :reek:TooManyStatement
+  def decode(code)
+    begin
+      id_str, type_id = code.split('-')
+      id = @id_processor.decode(id_str)
+
+      if id && type_id
+        @resources = { type_id: type_id, time: id }
+      else
+        {}
+      end
+    rescue Hashids::InputError => e
+      if e.message == 'unable to unhash'
+        {}
+      else
+        raise
+      end
+    end
+  end
+
+  #
+  # [return] Time
+  #
+  def now
+    Time.now
+  end
+  
+  #
+  # 現在時刻を2つの整数の配列にして返す
+  #
+  # 少数部を 1 msec にまで丸めて2つの整数の配列にして返している。この
+  # 部分は完全に hashids での利用のために特化している。この際、0.1 と
+  # 0.001 が同じ整数 1 にならないように 0 を埋めている。
+  #
+  # ex)
+  # [12345, 123] = time_array
+  #
+  # [return] Array
+  #
+  # :reek:UncommunicativeVariableName
+  def time_array
+    t = now.to_f.round(3)
+    sleep 0.001
+
+    ht, lt = t.to_s.split('.')
+    [ht.to_i, (lt.to_s + '00')[0, 3].to_i]
+  end
+
+  #
+  # decode 済みのコードについて確認用の日付を取得する
+  #
+  # [return] String
+  #
+  # :reek:UncommunicativeVariableName, :reek:FeatureEnvy
+  def date
+    time = resources[:time]
+    
+    if time
+      t = Time.at(time.first)
+      { month: t.month, mon: t.mon, day: t.day }
+    else
+      nil
+    end
+  end
+end

data/lib/slothful_code/version.rb

@@ -0,0 +1,3 @@
+class SlothfulCode
+  VERSION = "0.1.0"
+end

data/sig/slothful_code.rbs

@@ -0,0 +1,27 @@
+# -*- mode: ruby -*-
+
+type time_array = [Integer, Integer]
+type resource_record = { type_id: String?, time: time_array? }
+type date_record = { month: Integer, mon: Integer, day: Integer }
+
+class SlothfulCode
+  VERSION: String
+  HASHIDS_INCLUDE_CHARS: String
+  TYPE_CHARS: untyped
+
+  attr_reader resources: resource_record
+
+  def initialize: (?String) -> untyped
+
+  def generate: (type_id: String) -> String
+
+  def valid?: (String) -> bool
+
+  def decode: (String) -> resource_record
+
+  def now: () -> Time
+
+  def time_array: () -> time_array
+
+  def date: () -> (date_record | nil)
+end

data/slothful-code-generator.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slothful_code/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slothful-code-generator"
+  spec.version       = SlothfulCode::VERSION
+  spec.authors       = [""]
+  spec.email         = [""]
+
+  spec.summary       = %q{generate time-based unique id with loose precision}
+  spec.description   = # %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/colorfulcompany/slothful-code-generator"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+#  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "hashids", "~> 1"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-skip"
+  spec.add_development_dependency "minitest-power_assert", "~> 0.3"
+  spec.add_development_dependency "power_assert", "~> 2.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1"
+  spec.add_development_dependency "steep"
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: slothful-code-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-skip
+  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-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: steep
+  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'
+description: https://github.com/colorfulcompany/slothful-code-generator
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Steepfile
+- bin/console
+- bin/setup
+- lib/slothful-code-generator.rb
+- lib/slothful_code.rb
+- lib/slothful_code/version.rb
+- sig/slothful_code.rbs
+- slothful-code-generator.gemspec
+homepage: https://github.com/colorfulcompany/slothful-code-generator
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/colorfulcompany/slothful-code-generator
+  source_code_uri: https://github.com/colorfulcompany/slothful-code-generator
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: generate time-based unique id with loose precision
+test_files: []