sequel-generate-slug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 901bfe33eea0397cdd68a73aa321a1bb69376989124bf0c66c58d305b241fa02
+  data.tar.gz: dd0a5c584970f8482dde914357dedef59b11b971457391f7cbeba2b21f40a809
+SHA512:
+  metadata.gz: 559e13aa146f388868f9fffb19e660bb561e70b0b199a4535c8ce2be24b7100e0f7d448f2b0f1589eedecaebbc73362c409f0efa7e3d2008ff648932943a3f0e
+  data.tar.gz: eac8f1102296fe5bf5085a3d3e61bc0e4956d8618a939648d185014dce31a73734c717f21370ce2999d7363786f9a4a7fb7e7854484f59570ac2dc85f5b7bce0

data/lib/sequel/plugins/generate_slug.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'stringex'
+
+module Sequel
+  module Plugins
+    # GenerateSlug plugin generates a unique slug based on the specified source
+    # and additional columns. The plugin is designed to work with the Sequel
+    # ORM.
+    #
+    # @example
+    #   class Post < Sequel::Model
+    #     plugin :generate_slug, column: 'slug', source: 'title', additional: 'identifier'
+    #   end
+    #
+    #   post = Post.create(title: 'Hello World', identifier: 'abcdef')
+    #   post.slug # => 'hello-world'
+    #
+    #   post = Post.create(title: 'Hello World', identifier: 'abcdef')
+    #   post.slug # => 'hello-world-abcdef'
+    #
+    #   post = Post.create(title: 'Hello World', identifier: 'abcdef')
+    #   post.slug # => 'hello-world-abcdef-1'
+    module GenerateSlug
+      # Configure the plugin with the given options.
+      #
+      # @param model [Sequel::Model] the model to configure the plugin for
+      # @param opts [Hash] the options to configure the plugin with
+      # @option opts [Symbol] :column (:slug) the column to store the generated slug
+      # @option opts [Symbol] :source (:title) the source column to generate the slug from
+      # @option opts [Symbol] :additional (:identifier) the additional column to use in slug generation if necessary
+      def self.configure(model, opts = {})
+        model.instance_exec do
+          @slug_column = opts[:column] || :slug
+          @source_column = opts[:source] || :title
+          @additional_column = opts[:additional] || :identifier
+        end
+      end
+
+      module ClassMethods
+        # @!attribute [r] slug_column
+        # @return [Symbol] the column to store the generated slug
+        attr_reader :slug_column
+
+        # @!attribute [r] source_column
+        # @return [Symbol] the source column to generate the slug from
+        attr_reader :source_column
+
+        # @!attribute [r] additional_column
+        # @return [Symbol] the additional column to use in slug generation if necessary
+        attr_reader :additional_column
+
+        Plugins.inherited_instance_variables(self, :@slug_column => nil, :@source_column => nil, :@additional_column => nil)
+      end
+
+      module InstanceMethods
+        # Set the slug before validation if the record is new or the slug needs updating.
+        def before_validation
+          set_slug if new? || slug_needs_update?
+          super
+        end
+
+        private
+
+        # Generate a unique slug based on the source and additional columns.
+        #
+        # @return [String] the generated slug
+        def generate_slug
+          base_slug = get_column_value(model.source_column).to_url
+          additional_column = get_column_value(model.additional_column)
+
+          slug = find_unique_slug(base_slug, additional_column)
+          slug ||= generate_slug_with_random_number(base_slug)
+
+          slug
+        end
+
+        # Find a unique slug based on the given base_slug and additional_column.
+        #
+        # @param base_slug [String] the base slug to start with
+        # @param additional_column [String, nil] the additional column value to use in slug generation if necessary
+        # @return [String, nil] the unique slug or nil if not found
+        def find_unique_slug(base_slug, additional_column)
+          variations = [base_slug]
+          variations << "#{base_slug}-#{additional_column}" unless additional_column.nil? || additional_column.empty?
+
+          variations.each do |variation|
+            return variation if self.class.where(model.slug_column.to_sym => variation).none?
+          end
+
+          nil
+        end
+
+        # Generate a unique slug with a random number appended to the base_slug.
+        #
+        # @param base_slug [String] the base slug to start with
+        # @return [String] the generated slug with a random number appended
+        def generate_slug_with_random_number(base_slug)
+          loop do
+            new_slug = "#{base_slug}-#{rand(1000)}"
+            break new_slug if self.class.where(model.slug_column.to_sym => new_slug).none?
+          end
+        end
+
+        # Check if the slug needs to be updated based on the modified columns.
+        #
+        # @return [Boolean] true if the slug needs to be updated, false otherwise
+        def slug_needs_update?
+          modified?(model.source_column.to_sym) || modified?(model.additional_column.to_sym)
+        end
+
+        # Set the slug for the model instance.
+        #
+        # @param slug [String] the slug to set
+        # @return [void]
+        def set_slug(slug = generate_slug)
+          slug_column = model.slug_column
+          method_name = :"#{slug_column}="
+
+          set_column_value(method_name, slug) if respond_to?(slug_column) && respond_to?(method_name) && !modified?(slug_column)
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module SequelGenerateSlug
+  VERSION = '0.1.0'.freeze
+end

data/spec/plugins/generate_slug_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Sequel::Plugins::GenerateSlug do
+  before do
+    DB.create_table :assets do
+      primary_key :id
+      String :name
+      String :identifier
+      String :slug
+    end
+
+    class Asset < Sequel::Model(:assets)
+      plugin :generate_slug, source: :name, additional: :identifier
+    end
+  end
+
+  after do
+    DB.drop_table :assets
+  end
+
+  describe 'before_create' do
+    context 'when slug is not provided' do
+      it 'generates unique slug' do
+        asset = Asset.create(name: 'Test Asset', identifier: '123')
+        expect(asset.slug).not_to be_empty
+      end
+    end
+
+    context 'when slug is provided' do
+      it 'does not override provided slug' do
+        asset = Asset.create(name: 'Test Asset', identifier: '123', slug: 'test-asset')
+        expect(asset.slug).to eq('test-asset')
+      end
+    end
+  end
+
+  describe 'before_update' do
+    context 'when source or additional columns are modified' do
+      it 'updates slug' do
+        asset = Asset.create(name: 'Test Asset', identifier: '123')
+        asset.update(name: 'New Name')
+        expect(asset.slug).to eq('new-name')
+      end
+    end
+
+    context 'when slug column is modified' do
+      it 'does not update slug' do
+        asset = Asset.create(name: 'Test Asset', identifier: '123')
+        asset.update(slug: 'updated-asset')
+        expect(asset.slug).to eq('updated-asset')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'sequel'
+
+require './lib/sequel/plugins/generate_slug'
+
+DB = Sequel.connect('sqlite:/')
+
+RSpec.configure do |config|
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.pattern = 'spec/**/*_spec.rb'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sequel-generate-slug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Zhuk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Sequel plugin for generating and maintaining slugs in a database using
+  the base name and an optional additional column.
+email:
+- zhuk_andriy@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sequel/plugins/generate_slug.rb
+- lib/version.rb
+- spec/plugins/generate_slug_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/andrewzhuk/sequel-generate-slug
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/andrewzhuk/sequel-generate-slug
+  bug_tracker_uri: https://github.com/andrewzhuk/sequel-generate-slug/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Sequel plugin for generating and maintaining slugs.
+test_files: []