tanshuku 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6aee43e7ffa3cbc23f12aa56267742a5efdae9b88eab48e4c8abce0e1ffac241
-  data.tar.gz: f4d85b7c7583b4415772c3a3208f6a2242fb49966f5acbc3bf0d864e647bbffb
+  metadata.gz: 5fd8f19194d9833955c4dddc0671365169b09764324daa7b4ddc44a878869f22
+  data.tar.gz: 5689b47d61bdffe1378872f4771b1518b88810b61aab8ee61770278e7c61e993
 SHA512:
-  metadata.gz: 83408c401bf65bf47ca10da7b27ea6e4f8c7b66f19657c8835780692ad30c1ffc398d01560395b04cfa4f4a077964a8d5f505feb5e852a77876e86c78b01a23c
-  data.tar.gz: e6c324b2d3d6e36dd6b7e15901f5102e720c08954b2d93ef0a31baecf55affe7ed46d0eb21b8fb6ea15d5a6de6c0b4a2ecd6aff3dd98de07894fcba7ffd7f8fd
+  metadata.gz: c14701fe4468278495a0499cc9362a6143c80ab73790407b499b2b6ee018aabe32b2b5eef43090620e725d8988c5ffa5a8fb7f5be3d640cef59bf4091d5d1ecd
+  data.tar.gz: 2aa7417b14b055c3e5677a27661e0757f62661a8130c5315b68ecb1b5c087a8e76371c7b61bfa7cec87915dff623c5fde9980959763aa42febbc445707d680d6

data/Steepfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+target :main do
+  check "app", "config", "db", "lib"
+  signature "sig"
+  collection_config "rbs_collection.yaml"
+end

data/app/models/tanshuku/url.rb

@@ -5,6 +5,8 @@ require "addressable"
 require "rack"
 
 module Tanshuku
+  # rubocop:disable Rails/ApplicationRecord
+  #
   # An +ActiveRecord::Base+ inherited class for a shortened URL. This class also have some logics for shortening URLs.
   class Url < ActiveRecord::Base
     # @!attribute [rw] url
@@ -174,4 +176,5 @@ module Tanshuku
       Tanshuku::Engine.routes.url_for(url_options)
     end
   end
+  # rubocop:enable Rails/ApplicationRecord
 end

data/lib/generators/tanshuku/install_generator.rb

@@ -20,8 +20,11 @@ module Tanshuku
     #
     # @return [void]
     def copy_migration_file
-      filename = "20230220123456_create_tanshuku_urls.rb"
-      copy_file "../../../db/migrate/#{filename}", "db/migrate/#{filename}"
+      # rubocop:disable Rails/TimeZone
+      old_filename = "20230220123456_create_tanshuku_urls.rb"
+      new_filename = old_filename.sub("20230220123456", Time.now.strftime("%Y%m%d%H%M%S"))
+      copy_file "../../../db/migrate/#{old_filename}", "db/migrate/#{new_filename}"
+      # rubocop:enable Rails/TimeZone
     end
   end
 end

data/lib/tanshuku/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tanshuku
-  VERSION = "0.0.16"
+  VERSION = "0.0.18"
 end

data/rbs_collection.lock.yaml

@@ -0,0 +1,194 @@
+---
+sources:
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gem_rbs_collection"
+gems:
+- name: actionmailer
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionpack
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionview
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activejob
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activemodel
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activestorage
+  version: '6.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: cgi
+  version: '0'
+  source:
+    type: stdlib
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: digest
+  version: '0'
+  source:
+    type: stdlib
+- name: globalid
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: mail
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rack
+  version: '2.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-dom-testing
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: railties
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 12631190e75c631eca0908ecc8c03bcfd78c0c99
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+path: .gem_rbs_collection
+
+gems:
+  - name: rbs
+    ignore: true
+  - name: steep
+    ignore: true
+  - name: tanshuku
+    ignore: true
+
+  - name: digest
+  - name: securerandom

data/sig/app/controllers/tanshuku/urls_controller.rbs

@@ -0,0 +1,5 @@
+module Tanshuku
+  class UrlsController < ActionController::API
+    def show: -> void
+  end
+end

data/sig/app/models/tanshuku/url.rbs

@@ -0,0 +1,114 @@
+# cf. https://github.com/pocke/rbs_rails
+module Tanshuku
+  class Url < ActiveRecord::Base
+    class ActiveRecord_Relation < ActiveRecord::Relation
+      include _ActiveRecord_Relation[Tanshuku::Url, Integer]
+      include Enumerable[Tanshuku::Url]
+    end
+
+    extend _ActiveRecord_Relation_ClassMethods[Tanshuku::Url, ActiveRecord_Relation, Integer]
+
+    DEFAULT_NAMESPACE: String
+
+    module GeneratedAttributeMethods
+      attr_accessor id (): Integer?
+      def id?: () -> bool
+      def id_changed?: () -> bool
+      def id_change: () -> [Integer?, Integer?]
+      def id_will_change!: () -> void
+      def id_was: () -> Integer?
+      def id_previously_changed?: () -> bool
+      def id_previous_change: () -> [Integer?, Integer?]?
+      def id_previously_was: () -> Integer?
+      def id_before_last_save: () -> Integer?
+      def id_change_to_be_saved: () -> [Integer?, Integer?]?
+      def id_in_database: () -> Integer?
+      def saved_change_to_id: () -> [Integer?, Integer?]?
+      def saved_change_to_id?: () -> bool
+      def will_save_change_to_id?: () -> bool
+      def restore_id!: () -> void
+      def clear_id_change: () -> void
+
+      attr_accessor url (): String?
+      def url?: () -> bool
+      def url_changed?: () -> bool
+      def url_change: () -> [String?, String?]
+      def url_will_change!: () -> void
+      def url_was: () -> String?
+      def url_previously_changed?: () -> bool
+      def url_previous_change: () -> [String?, String?]?
+      def url_previously_was: () -> String?
+      def url_before_last_save: () -> String?
+      def url_change_to_be_saved: () -> [String?, String?]?
+      def url_in_database: () -> String?
+      def saved_change_to_url: () -> [String?, String?]?
+      def saved_change_to_url?: () -> bool
+      def will_save_change_to_url?: () -> bool
+      def restore_url!: () -> void
+      def clear_url_change: () -> void
+
+      attr_accessor hashed_url (): String?
+      def hashed_url?: () -> bool
+      def hashed_url_changed?: () -> bool
+      def hashed_url_change: () -> [String?, String?]
+      def hashed_url_will_change!: () -> void
+      def hashed_url_was: () -> String?
+      def hashed_url_previously_changed?: () -> bool
+      def hashed_url_previous_change: () -> [String?, String?]?
+      def hashed_url_previously_was: () -> String?
+      def hashed_url_before_last_save: () -> String?
+      def hashed_url_change_to_be_saved: () -> [String?, String?]?
+      def hashed_url_in_database: () -> String?
+      def saved_change_to_hashed_url: () -> [String?, String?]?
+      def saved_change_to_hashed_url?: () -> bool
+      def will_save_change_to_hashed_url?: () -> bool
+      def restore_hashed_url!: () -> void
+      def clear_hashed_url_change: () -> void
+
+      attr_accessor key (): String?
+      def key?: () -> bool
+      def key_changed?: () -> bool
+      def key_change: () -> [String?, String?]
+      def key_will_change!: () -> void
+      def key_was: () -> String?
+      def key_previously_changed?: () -> bool
+      def key_previous_change: () -> [String?, String?]?
+      def key_previously_was: () -> String?
+      def key_before_last_save: () -> String?
+      def key_change_to_be_saved: () -> [String?, String?]?
+      def key_in_database: () -> String?
+      def saved_change_to_key: () -> [String?, String?]?
+      def saved_change_to_key?: () -> bool
+      def will_save_change_to_key?: () -> bool
+      def restore_key!: () -> void
+      def clear_key_change: () -> void
+
+      attr_accessor created_at (): ActiveSupport::TimeWithZone?
+      def created_at?: () -> bool
+      def created_at_changed?: () -> bool
+      def created_at_change: () -> [ActiveSupport::TimeWithZone?, ActiveSupport::TimeWithZone?]
+      def created_at_will_change!: () -> void
+      def created_at_was: () -> ActiveSupport::TimeWithZone?
+      def created_at_previously_changed?: () -> bool
+      def created_at_previous_change: () -> [ActiveSupport::TimeWithZone?, ActiveSupport::TimeWithZone?]?
+      def created_at_previously_was: () -> ActiveSupport::TimeWithZone?
+      def created_at_before_last_save: () -> ActiveSupport::TimeWithZone?
+      def created_at_change_to_be_saved: () -> [ActiveSupport::TimeWithZone?, ActiveSupport::TimeWithZone?]?
+      def created_at_in_database: () -> ActiveSupport::TimeWithZone?
+      def saved_change_to_created_at: () -> [ActiveSupport::TimeWithZone?, ActiveSupport::TimeWithZone?]?
+      def saved_change_to_created_at?: () -> bool
+      def will_save_change_to_created_at?: () -> bool
+      def restore_created_at!: () -> void
+      def clear_created_at_change: () -> void
+    end
+    include GeneratedAttributeMethods
+
+    def self.shorten: (String original_url, ?namespace: String, ?url_options: Hash[String | Symbol, untyped]) -> String
+    def self.find_by_url: (String url, ?namespace: String) -> ActiveRecord::Base?
+    def self.normalize_url: (String url) -> String
+    def self.hash_url: (String url, ?namespace: String) -> String
+    def self.generate_key: -> String
+    def self.report_exception: (exception: Exception, original_url: String) -> void
+    def shortened_url: (?Hash[String | Symbol, untyped] url_options) -> String
+  end
+end

data/sig/db/migrate/create_tanshuku_urls.rbs

@@ -0,0 +1,2 @@
+class CreateTanshukuUrls < ActiveRecord::Migration::Compatibility::V7_0
+end

data/sig/lib/generators/tanshuku/install_generator.rbs

@@ -0,0 +1,4 @@
+module Tanshuku
+  class InstallGenerator < Rails::Generators::Base
+  end
+end

data/sig/lib/tanshuku/configuration.rbs

@@ -0,0 +1,42 @@
+module Tanshuku
+  class Configuration
+    interface _UrlHasher
+      def call: (String url, namespace: String) -> String
+    end
+
+    interface _KeyGenerator
+      def call: -> String
+    end
+
+    interface _ExceptionReporter
+      def call: (exception: Exception, original_url: String) -> void
+    end
+
+    extend ActiveModel::Attributes::ClassMethods
+
+    @mutex: Thread::Mutex
+
+    attr_accessor default_url_options (): Hash[String | Symbol, untyped]
+    attr_accessor max_url_length (): Integer
+    attr_accessor url_pattern (): Regexp
+    attr_accessor key_length (): Integer
+    attr_accessor url_hasher (): _UrlHasher
+    attr_accessor key_generator (): _KeyGenerator
+    attr_accessor exception_reporter (): _ExceptionReporter
+
+    def initialize: (*bot noname) -> void
+    def configure: { (Configuration) -> void } -> void
+
+    module DefaultUrlHasher
+      extend _UrlHasher
+    end
+
+    module DefaultKeyGenerator
+      extend _KeyGenerator
+    end
+
+    module DefaultExceptionReporter
+      extend _ExceptionReporter
+    end
+  end
+end

data/sig/lib/tanshuku/engine.rbs

@@ -0,0 +1,4 @@
+module Tanshuku
+  class Engine < Rails::Engine
+  end
+end

data/sig/lib/tanshuku/version.rbs

@@ -0,0 +1,3 @@
+module Tanshuku
+  VERSION: String
+end

data/sig/lib/tanshuku.rbs

@@ -0,0 +1,6 @@
+module Tanshuku
+  self.@config: Configuration
+
+  def self.config: -> Configuration
+  def self.configure: { (Configuration config) -> void } -> void
+end

data/steep_expectations.yml

@@ -0,0 +1,19 @@
+---
+- file: lib/generators/tanshuku/install_generator.rb
+  diagnostics:
+  - range:
+      start:
+        line: 10
+        character: 49
+      end:
+        line: 10
+        character: 56
+    severity: ERROR
+    message: |-
+      Cannot pass a value of type `(::String | nil)` as an argument of type `(::string | ::_ToPath)`
+        (::String | nil) <: (::string | ::_ToPath)
+          nil <: (::string | ::_ToPath)
+            nil <: ::string
+              nil <: (::String | ::_ToStr)
+                nil <: ::String
+    code: Ruby::ArgumentTypeMismatch

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanshuku
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - kg8m
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,31 +16,31 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.0.0
 description: Tanshuku is a simple and performance aware Rails engine for shortening
-  URLs. Tanshuku generates a shortened URL per a normalized original URL.Tanshuku
-  redirects from a shortened URL to its correspond original URL.
+  URLs. Tanshuku generates a shortened URL per a normalized original URL. Tanshuku
+  redirects from a shortened URL to its corresponding original URL.
 email:
 - takumi.kagiyama@gmail.com
 executables: []
@@ -49,7 +49,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- Rakefile
+- Steepfile
 - app/controllers/tanshuku/urls_controller.rb
 - app/models/tanshuku/url.rb
 - config/locales/en.yml
@@ -62,7 +62,17 @@ files:
 - lib/tanshuku/configuration.rb
 - lib/tanshuku/engine.rb
 - lib/tanshuku/version.rb
-- tmp/.keep
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/app/controllers/tanshuku/urls_controller.rbs
+- sig/app/models/tanshuku/url.rbs
+- sig/db/migrate/create_tanshuku_urls.rbs
+- sig/lib/generators/tanshuku/install_generator.rbs
+- sig/lib/tanshuku.rbs
+- sig/lib/tanshuku/configuration.rbs
+- sig/lib/tanshuku/engine.rbs
+- sig/lib/tanshuku/version.rbs
+- steep_expectations.yml
 homepage: https://github.com/kg8m/tanshuku
 licenses:
 - MIT
@@ -80,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Tanshuku is a simple and performance aware Rails engine for shortening URLs.

data/Rakefile

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-
-APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
-
-load "rails/tasks/statistics.rake"
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
-
-namespace :yard do
-  desc "Start YARD server"
-  task :server do
-    puts "See http://localhost:8808/"
-    sh "yard server --reload"
-  end
-
-  desc "Check YARD docs"
-  task :check do
-    sh "yard --no-output --no-cache --fail-on-warning"
-  end
-end
-
-task default: %i[rubocop spec yard:check]