visibilize 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84568a8140b7e27087461d5707673a258efad3d5dc8fdd5305eca9516398f8a3
-  data.tar.gz: 902201dd9774ab0f5e0b971f3125a4b9840193bff28cf0bacfa77fd618b7fa8d
+  metadata.gz: 80a09f94dca61143ddf4d2552946629a5d4af1dde248b5c98f8bdccb5f7657ff
+  data.tar.gz: c7be6a3803139cc8121528f4438c4e1135e63070c91549fd9a0fd2f808b4e11e
 SHA512:
-  metadata.gz: 4ddf68adcb0fa813ed29ed03553b8dd8cdb04cd369cc860d67ac33432c3003b236e0c24d89645a5b08599a613a533dfb773ba0240348118f38e1d9e0f57f1732
-  data.tar.gz: 1ca2048a188fa08798e2e637bb29b5a82d81be4f80fe50da3050e7284d3b76cf90cfd288aea4f898cfba5624513045a5174005cac0780fa20bc4d50aa7e964b0
+  metadata.gz: 19cf227b9d94edc6e5fef2a2d383a6c323703ecd530ef72727bb9841b26412da616b0b2d5d52c7b867ca27bbd6a99a09d92b3ba2782e32a27a9af80bf71f5bf7
+  data.tar.gz: 371a1d72ffb2ece0ed672c52798368685d223ce5e58ee05bde0befc2a5f314c5d2d8212661143f47db9ec18a0f213d0e1d4ebdc0c83ead93a96a3c187d04badb

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/Gemfile

@@ -1,4 +1,8 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in visibilize.gemspec
 gemspec
+
+group :development do
+  gem 'rubocop', '~> 1.65.1'
+end

data/Gemfile.lock

@@ -1,59 +1,97 @@
 PATH
   remote: .
   specs:
-    visibilize (0.1.1)
+    visibilize (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (7.1.4)
+      activesupport (= 7.1.4)
+    activerecord (7.1.4)
+      activemodel (= 7.1.4)
+      activesupport (= 7.1.4)
+      timeout (>= 0.4.0)
+    activesupport (7.1.4)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.3)
-    i18n (1.8.5)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    mysql2 (0.5.3)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
+    mutex_m (0.2.0)
+    parallel (1.26.3)
+    parser (3.3.4.2)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    regexp_parser (2.9.2)
+    rexml (3.3.6)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    yaml (0.1.0)
-    zeitwerk (2.4.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.1)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.7.3)
+      mini_portile2 (~> 2.8.0)
+    strscan (3.1.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 6.0)
+  activerecord (~> 7.0)
   bundler (~> 2.0)
-  mysql2 (~> 0.5.3)
   rake (~> 12.3.3)
   rspec (~> 3.0)
+  rubocop (~> 1.65.1)
+  sqlite3 (~> 1.4)
   visibilize!
-  yaml (~> 0.1.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -1,3 +1,4 @@
+# ⚠️ This is a very old and unmaintaned repository, refer to [friendly_id](https://github.com/norman/friendly_id) for a better solution.
 
 
 # Visibilize

data/lib/visibilize/generator.rb

@@ -1,72 +1,68 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
+# Handles value generation for Visibilize w.r.t. provided type argument
 module VisibilizeGenerator
+  # Raised when the generator is not found for the given type
+  class InvalidGeneratorError < StandardError
+    def initialize(type, klass, column)
+      super("Visibilize Error: No generator defined for type #{type}. (Asked for column #{column} of #{klass.name})")
+    end
+  end
+
+  # Raised when the maximum number of attempts to generate a unique value is exceeded
+  class AttemptsExceededError < StandardError
+    def initialize(attempts)
+      super("Visibilize Error: Failed to generate a unique value after #{attempts} attempts")
+    end
+  end
 
   class << self
+    # We're limiting the number of attempts to generate a unique value to 10
+    # This is to prevent infinite loops in case of collisions
+    MAX_UNIQUE_ATTEMPTS = 10
 
-    def get_value_for(type, klass, column, length, unique)
-      method="generate_#{type}"
-      
-      
-      if self.respond_to?(method) 
-        from=:generators
-      elsif SecureRandom.respond_to?(type)
-        from=:securerandom
-      else
-        raise "Visibilize Error: No generator defined for type #{type}. (Asked for column #{column} of #{klass.name})" 
+    def value(type, klass, column, length, unique)
+      return generate_value(type, klass, column, length) unless unique
+
+      MAX_UNIQUE_ATTEMPTS.times do
+        generated = generate_value(type, klass, column, length)
+        return generated unless klass.exists?(column => generated)
       end
+      raise AttemptsExceededError, MAX_UNIQUE_ATTEMPTS
+    end
 
-      loop do
-        if from==:generators
-          generated=public_send(method, length)
-        elsif from==:securerandom
-          generated=generate_from_securerandom(type, length)
-        end
+    def generate_value(type, klass, column, length)
+      case type
+      when :integer then generate_integer(length)
+      when :string then generate_string(length)
+      else
+        raise InvalidGeneratorError.new(type, klass, column) unless SecureRandom.respond_to?(type)
 
-        return generated if !unique || klass.where("#{column}='#{generated}'").empty?
+        generate_from_securerandom(type, length)
       end
-
     end
-    # end get_value_for
 
-    
-    #
-    # Generators
-    #
+    private
 
     def generate_integer(length)
-      return rand(1...10) if length==1
+      return rand(1...10) if length == 1
 
-      min=10**(length-1)  #1000
-      max=9*min + (min-1) #9999
-      rand(min...(max+1))
+      min = 10**(length - 1)
+      max = (10**length) - 1
+      rand(min..max)
     end
 
     def generate_string(length)
-      available_chars=("a".."z").to_a + ("A".."Z").to_a + (0..9).to_a
-      
-      str=""
-      length.times do
-        str+=available_chars[rand(available_chars.size)].to_s 
-      end
-
-      str
+      available_chars = [*'a'..'z', *'A'..'Z', *'0'..'9']
+      Array.new(length) { available_chars.sample }.join
     end
 
     def generate_from_securerandom(type, length)
-      if SecureRandom.respond_to?(type)  
-        begin
-          return SecureRandom.public_send(type, length)
-        rescue ArgumentError
-          return SecureRandom.public_send(type)
-        end
-      end
-      
-      return nil
+      SecureRandom.public_send(type, length)
+    rescue ArgumentError
+      SecureRandom.public_send(type)
     end
-
-
   end
-  # end static
-
-end
+end

data/lib/visibilize/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Visibilize
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/visibilize.rb

@@ -1,35 +1,44 @@
-require "visibilize/version"
-require "visibilize/generator"
+# frozen_string_literal: true
 
+require 'visibilize/version'
+require 'visibilize/generator'
 
+# Raised when the column is not found in the model
+class AttributeNotFoundError < StandardError
+  def initialize(column, klass)
+    super("Visibilize Error: Attribute #{column} not found in #{klass.name} instance.")
+  end
+end
 
-def visibilize(options={})
-
-  column    = options[:column]    || :visible_id
-  callback  = options[:callback]  || :before_create
-  type      = options[:type]      || :integer
-  unique    = options[:unique]    || true
-  length    = options[:length]    || 8
-  lamb      = options[:lambda]    || nil
-
-  # Define a method to fill the column with appropiate value
-  method_name="visibilize_#{column}"
-  define_method(method_name) do
+# Visibilize
+#
+# @param [Hash] options
+# @option options [Symbol] :column The column to be generated
+# @option options [Symbol] :callback The callback to be used (before_create, before_save, etc.)
+# @option options [Symbol] :type The type of value to be generated (integer, string, uuid, etc.)
+# @option options [Boolean] :unique Whether the value should be unique
+# @option options [Integer] :length The length of the value to be generated
+# @option options [Proc] :lambda A lambda to be used to generate the value
+def visibilize(options = {})
+  options.reverse_merge!(column: :visible_id, callback: :before_create, type: :integer, unique: true, length: 8)
+
+  # Define a method to fill the column with an appropiate value
+  define_visibilize_method(**options.slice(:column, :type, :unique, :length, :lambda))
 
-    raise "Visibilize Error: Attribute #{column} not found in #{self.class.name} instance." unless self.has_attribute?(column)
+  # Create a callback to execute method
+  callback_type, _, callback_timing = options[:callback].to_s.partition('_')
+  set_callback callback_timing.to_sym, callback_type.to_sym, method_name(options[:column])
+end
 
-    # Values are generated by VisibilizeGenerator class
-    value=lamb ? lamb.call : VisibilizeGenerator.get_value_for(type, self.class, column, length, unique)
+def define_visibilize_method(column: :visible_id, type: :integer, unique: true, length: 8, lambda: nil)
+  define_method(method_name(column)) do
+    raise AttributeNotFoundError.new(column, self.class) unless has_attribute?(column)
 
+    value = lambda&.call || VisibilizeGenerator.value(type, self.class, column, length, unique)
     write_attribute(column, value)
   end
-
-  # Create a callback to execute method
-  callback=callback.to_s.split('_')
-  set_callback callback[1].to_sym, callback[0].to_sym, method_name.to_sym
-
 end
-# end visibilize
-
-
 
+def method_name(column)
+  "visibilize_#{column}".to_sym
+end

data/visibilize.gemspec

@@ -1,6 +1,8 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "visibilize/version"
+require 'visibilize/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'visibilize'
@@ -8,26 +10,26 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Furkan Enes Apaydın']
   spec.email         = ['feapaydin@gmail.com']
 
-  spec.summary       = %q{Generate random friendly identifiers for ActiveRecord instances.}
-  spec.description   = %q{Visibilize generates random friendly identifiers (visible_id) that can be exposed to end users for ActiveRecord models. }
-  spec.homepage      = 'https://github.com/FEApaydin/visibilize'
+  spec.summary       = 'Generate random friendly identifiers for ActiveRecord instances.'
+  spec.description   = 'Visibilize generates random friendly identifiers that can be exposed to end users for ActiveRecord models.'
+  spec.homepage      = 'https://github.com/feapaydin/visibilize'
   spec.license       = 'MIT'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = 'https://github.com/FEApaydin/visibilize'
-  spec.metadata["changelog_uri"] = 'https://github.com/FEApaydin/visibilize'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/feapaydin/visibilize'
+  spec.metadata['changelog_uri'] = 'https://github.com/feapaydin/visibilize'
 
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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.required_ruby_version = '>= 3.0'
 
+  spec.add_development_dependency 'activerecord', '~> 7.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'activerecord', '~> 6.0'
-  spec.add_development_dependency 'mysql2', '~> 0.5.3'
-  spec.add_development_dependency 'yaml', '~> 0.1.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
 end

metadata

@@ -1,101 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: visibilize
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Furkan Enes Apaydın
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !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
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: yaml
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
-description: 'Visibilize generates random friendly identifiers (visible_id) that can
-  be exposed to end users for ActiveRecord models. '
+        version: '1.4'
+description: Visibilize generates random friendly identifiers that can be exposed
+  to end users for ActiveRecord models.
 email:
 - feapaydin@gmail.com
 executables: []
@@ -104,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -117,13 +104,13 @@ files:
 - lib/visibilize/generator.rb
 - lib/visibilize/version.rb
 - visibilize.gemspec
-homepage: https://github.com/FEApaydin/visibilize
+homepage: https://github.com/feapaydin/visibilize
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/FEApaydin/visibilize
-  source_code_uri: https://github.com/FEApaydin/visibilize
-  changelog_uri: https://github.com/FEApaydin/visibilize
+  homepage_uri: https://github.com/feapaydin/visibilize
+  source_code_uri: https://github.com/feapaydin/visibilize
+  changelog_uri: https://github.com/feapaydin/visibilize
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -132,14 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Generate random friendly identifiers for ActiveRecord instances.