tanshuku 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa7ab0b4cb36fafbd7747af1bff6592c5b775b9602bc664d84dbc195daa0ed3b
-  data.tar.gz: 1826f56d1be47b0925d2b5d05c5992f8218f499e02f6c049612e44f09e9a577b
+  metadata.gz: 58228d834716ae9f1a9415212f4976816aeaf61bd6ff2a1e92672a62bd202a93
+  data.tar.gz: e8ecd16d19d73cdff428f08cd5a3b801e59934fa86d69fa1b182e0da40da1feb
 SHA512:
-  metadata.gz: 208cd3049977df30d0bd0757f5575414da55464b343f77f31e1d3195f8fd4377718b3d3c3067e0df6ff43fa198ef2c37666ffe9201e8242af465c90fc1108ead
-  data.tar.gz: 65d877e047853c97baef247b3508fe5a181d9ecf8d0696be491d6caf389bc9252ba155b6b465abe843c184e28300bca36c4b4a22695dfd5a04bc31b6a3b80bcf
+  metadata.gz: f786879cc78304a288487079e4b2e218be8df2d7c6df4edc8f629ca672369fa583998e2b44bc4d62876b1f242dd24ae0f67201a1a85f391d20fb26dd07d80ca1
+  data.tar.gz: 2b7af5d5181be59774b1d6ae13e12df32347c862cec776139a4ba31da153a38fb63959380e8bebcc931fa707b658799b33eb5a248a7bf765ba77dc9de3397bf9

data/Rakefile

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require "bundler/setup"
 
-require "rubocop/rake_task"
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-RuboCop::RakeTask.new
+load "rails/tasks/statistics.rake"
 
-task default: :rubocop
+require "bundler/gem_tasks"

data/app/models/tanshuku/url.rb

@@ -8,46 +8,53 @@ require "securerandom"
 
 module Tanshuku
   class Url < ActiveRecord::Base
+    DEFAULT_NAMESPACE = ""
+
     MAX_URL_LENGTH = 10_000
     URL_PATTERN = %r{\A(?:https?://\w+|/)}
     KEY_LENGTH = 20
 
     validates :url, :hashed_url, :key, presence: true
     validates :url, length: { maximum: MAX_URL_LENGTH }
-    validates :url, format: { with: URL_PATTERN }
+    validates :url, format: { with: URL_PATTERN }, allow_blank: true
 
     # Don't validate uniqueness of unique attributes. Raise ActiveRecord::RecordNotUnique instead if the attributes get
     # duplicated. Then rescue the exception and try to retry.
     # validates :url, :hashed_url, :key, uniqueness: true
 
-    def self.shorten(original_url, retries: 0)
+    def self.shorten(original_url, namespace: DEFAULT_NAMESPACE)
       raise ArgumentError, "original_url should be present" unless original_url
 
       url = normalize_url(original_url)
+      retries = 0
 
-      transaction do
-        record =
-          create_or_find_by!(hashed_url: hash_url(url)) do |r|
-            r.attributes = { url:, key: generate_key }
-          end
+      begin
+        transaction do
+          record =
+            create_or_find_by!(hashed_url: hash_url(url, namespace:)) do |r|
+              r.attributes = { url:, key: generate_key }
+            end
 
-        record.shortened_url
-      end
-    rescue ActiveRecord::RecordNotUnique => e
-      if retries < 10
-        shorten(url, retries: retries + 1)
-      else
-        report_exception(exception: e, original_url:)
-        original_url
+          record.shortened_url
+        end
+      # ActiveRecord::RecordNotFound is raised when the key is duplicated.
+      rescue ActiveRecord::RecordNotFound => e
+        if retries < 10
+          retries += 1
+          retry
+        else
+          report_exception(exception: e, original_url:)
+          original_url
+        end
       end
     rescue StandardError => e
       report_exception(exception: e, original_url:)
       original_url
     end
 
-    def self.find_by_url(url)
+    def self.find_by_url(url, namespace: DEFAULT_NAMESPACE)
       normalized_url = normalize_url(url)
-      hashed_url = hash_url(normalized_url)
+      hashed_url = hash_url(normalized_url, namespace:)
 
       find_by(hashed_url:)
     end
@@ -59,8 +66,8 @@ module Tanshuku
       parsed_url.normalize.to_s
     end
 
-    def self.hash_url(url)
-      Digest::SHA512.hexdigest(url)
+    def self.hash_url(url, namespace: DEFAULT_NAMESPACE)
+      Digest::SHA512.hexdigest(namespace.to_s + url)
     end
 
     def self.generate_key
@@ -68,7 +75,7 @@ module Tanshuku
     end
 
     def self.report_exception(exception:, original_url:)
-      logger.warn("Tanshuku - Failed to shorten a URL: #{exception.inspect} for #{original_url.inspect}")
+      Tanshuku.config.exception_reporter.call(exception:, original_url:)
     end
 
     def shortened_url

data/config/routes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Tanshuku::Engine.routes.draw do
-  default_url_options Tanshuku.default_url_options
+  default_url_options Tanshuku.config.default_url_options
 
   get "/:key", to: "urls#show"
 end

data/lib/tanshuku/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Tanshuku
+  class Configuration
+    module DefaultExceptionReporter
+      def self.call(exception:, original_url:)
+        Rails.logger.warn("Tanshuku - Failed to shorten a URL: #{exception.inspect} for #{original_url.inspect}")
+      end
+    end
+
+    include ActiveModel::Attributes
+
+    attribute :default_url_options, default: {}
+    attribute :exception_reporter, default: DefaultExceptionReporter
+  end
+end

data/lib/tanshuku/engine.rb

@@ -3,5 +3,9 @@
 module Tanshuku
   class Engine < ::Rails::Engine
     isolate_namespace Tanshuku
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/lib/tanshuku/version.rb

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

data/lib/tanshuku.rb

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
+require_relative "tanshuku/configuration"
 require_relative "tanshuku/engine"
 require_relative "tanshuku/version"
 
 module Tanshuku
-  mattr_accessor :default_url_options, default: {}
+  def self.config
+    Mutex.new.synchronize do
+      @config ||= Configuration.new
+    end
+  end
+
+  def self.configure
+    yield config
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanshuku
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - kg8m
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-02-24 00:00:00.000000000 Z
+date: 2023-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,92 +38,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
-- !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: rspec
-  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: rubocop
-  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: rubocop-performance
-  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: rubocop-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: rubocop-rspec
-  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: Tanshuku is a Rails engine for shortening URLs. Tanshuku generates a
-  shortened URL per a normalized original URL.
+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.
 email:
 - takumi.kagiyama@gmail.com
 executables: []
@@ -139,6 +56,7 @@ files:
 - config/routes.rb
 - db/migrate/20230220123456_create_tanshuku_urls.rb
 - lib/tanshuku.rb
+- lib/tanshuku/configuration.rb
 - lib/tanshuku/engine.rb
 - lib/tanshuku/version.rb
 homepage: https://github.com/kg8m/tanshuku
@@ -164,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
-summary: Tanshuku is a Rails engine for shortening URLs.
+summary: Tanshuku is a simple and performance aware Rails engine for shortening URLs.
 test_files: []