active_record_pretty_key 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa0c741c251d8d3acde833ff8620ffbea369f74544d1feda3507684596d327de
+  data.tar.gz: 9be0117695b9d2268c7ba3e930a28983ea50fb19326ce5aabfc6e914bda3c8c5
+SHA512:
+  metadata.gz: 4bd0c1ac8f56f770bd90e010467f3aae5e345f316554d657ef7086b7ff288825a5b9a2545c261c495bede196445b54f0566b5d8dd8d8e53ba17926f3bce167aa
+  data.tar.gz: 6c3e23c905e21f50d625dd22b84d26232f99222d473d79afc4f89e05db2ccc2f4830ccc8a6f1910fe4b5da5e00da733fc98c66664ce741c5a65341a2b38fa2b0

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/active_record_pretty_key/concern.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveRecordPrettyKey
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :generate_pretty_key
+    end
+
+    private
+
+    def generate_pretty_key
+      pk_attribute = self.class.primary_key
+      return if pk_attribute.nil? || self.class.attribute_types[pk_attribute].nil? || self.class.attribute_types[pk_attribute].type != :string
+
+      # Ensure PrettyKeyTicket is available
+      return unless defined?(ActiveRecordPrettyKey::PrettyKeyTicket)
+
+      self.assign_attributes(pk_attribute => ActiveRecordPrettyKey::PrettyKeyTicket.next_sqid) unless self.attributes[pk_attribute].present?
+    end
+  end
+end

data/lib/active_record_pretty_key/pretty_key_ticket.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ActiveRecordPrettyKey
+  class PrettyKeyTicket < ActiveRecord::Base
+    self.table_name = "pretty_key_tickets"
+    @sqids = Sqids.new(
+      min_length: 4,
+      alphabet: defined?(Rails) && Rails.application.respond_to?(:credentials) ?
+                (Rails.application.credentials.dig(:sqids, :alphabet) || Sqids::DEFAULT_ALPHABET) :
+                Sqids::DEFAULT_ALPHABET,
+    )
+
+    # Generate a new unique ID that works with PostgreSQL, MySQL, and SQLite
+    def self.next_id
+      transaction do
+        # Detect database type
+        adapter = connection.adapter_name.downcase
+
+        if [ "postgresql", "postgis" ].include?(adapter)
+          # PostgreSQL approach
+          result = connection.execute(
+            "INSERT INTO pretty_key_tickets (stub) VALUES ('a')
+             ON CONFLICT (stub) DO UPDATE SET id = currval('pretty_key_tickets_id_seq')
+             RETURNING id"
+          )
+          result[0]["id"]
+        elsif [ "mysql", "mysql2" ].include?(adapter)
+          # MySQL approach
+          connection.execute("REPLACE INTO pretty_key_tickets (stub) VALUES ('a');")
+          connection.execute("SELECT LAST_INSERT_ID()").first[0]
+        else
+          # SQLite approach (and fallback for others)
+          connection.execute("REPLACE INTO pretty_key_tickets (stub) VALUES ('a');")
+          last.id
+        end
+      end
+    end
+
+    def self.next_sqid
+      @sqids.encode([ self.next_id ])
+    end
+  end
+end

data/lib/active_record_pretty_key/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecordPrettyKey
+  VERSION = File.read(
+    File.expand_path('../../VERSION', __dir__)
+  ).strip.freeze
+end

data/lib/active_record_pretty_key.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support/concern"
+require "sqids"
+require_relative "active_record_pretty_key/pretty_key_ticket"
+require_relative "active_record_pretty_key/concern"
+# require_relative "active_record_pretty_key/version"
+
+
+module ActiveRecordPrettyKey
+  class Error < StandardError; end
+end

data/lib/generators/active_record_pretty_key/install/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module ActiveRecordPrettyKey
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates the tickets table migration for active_record_pretty_key"
+
+      def create_migration
+        template "create_tickets.erb", "db/migrate/#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_create_pretty_key_tickets.rb"
+      end
+
+      private
+
+      def migration_version
+        if ActiveRecord::VERSION::MAJOR >= 5
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_record_pretty_key/install/templates/create_tickets.erb

@@ -0,0 +1,11 @@
+class CreatePrettyKeyTickets < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :pretty_key_tickets, id: :bigint do |t|
+      t.string :stub, limit: 1, null: false
+    end
+    add_index :pretty_key_tickets, :stub, unique: true
+
+    # Seed initial value
+    execute "INSERT INTO pretty_key_tickets (stub) VALUES ('a')"
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: active_record_pretty_key
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stuart Yamartino
+- John Nagro
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sqids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: ActiveRecordPrettyKey provides functionality to generate and manage pretty,
+  human-readable keys for ActiveRecord models.
+email:
+- stu@stuyam.com
+- john.nagro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/active_record_pretty_key.rb
+- lib/active_record_pretty_key/concern.rb
+- lib/active_record_pretty_key/pretty_key_ticket.rb
+- lib/active_record_pretty_key/version.rb
+- lib/generators/active_record_pretty_key/install/install_generator.rb
+- lib/generators/active_record_pretty_key/install/templates/create_tickets.erb
+homepage: https://github.com/noreastergroup/active_record_pretty_key
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/noreastergroup/active_record_pretty_key
+  source_code_uri: https://github.com/noreastergroup/active_record_pretty_key
+  changelog_uri: https://github.com/noreastergroup/active_record_pretty_key/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A gem for generating pretty keys in ActiveRecord models
+test_files: []