rails_sluggable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a3a7c668ab162a3dc8dce5271ec5d8b9cff0c2c27de73ad4d2cd06a553cf057
+  data.tar.gz: 972474ef9ee2f89d0f499663f4c178c90b0dd28d74a3832c531b74d340a9527e
+SHA512:
+  metadata.gz: 8522d4792d1d976ae9a3bdeb041cf72f72a1312ee9d534f773c2a090697e00fa6672305243132d88ed0a50ea034d19831e420569c566f913948b2abc19967203
+  data.tar.gz: 397d1fb2a0edff86b87eeccb250d8d9fa5dee992d19b499ac75fcda323fea5c1d037105501eed4d9979999c0d1186d53a0228fe00c88c0713010ecce2ec8fe6b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright aric.zheng
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# RailsSluggable
+> A Rails plugin for generating configurable model slugs.
+
+## Usage
+```rb
+# generate slug for `Posts`
+rails generate migration AddSlugToPosts slug:string:uniq
+
+class Post < ApplicationRecord
+  sluggable length: 12
+end
+
+class Article < ApplicationRecord
+  sluggable length: 8, separator: '-'
+end
+```
+
+## Example
+> Use slug for post model.
+```json
+{
+  "id": 1,
+  "content": "Ruby on Rails 是一个强大的 Web 开发框架...",
+  "created_at": "2025-11-07T06:48:29.259Z",
+  "slug": "077f802de102",
+  "title": "Rails 入门指南",
+  "updated_at": "2025-11-07T06:48:29.259Z"
+}
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_sluggable"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_sluggable
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/rails_sluggable/engine.rb

@@ -0,0 +1,9 @@
+module RailsSluggable
+  class Engine < ::Rails::Engine
+    initializer 'rails_sluggable' do
+      ActiveSupport.on_load :active_record do
+        include RailsSluggable
+      end
+    end
+  end
+end

data/lib/rails_sluggable/railtie.rb

@@ -0,0 +1,4 @@
+module RailsSluggable
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/rails_sluggable/version.rb

@@ -0,0 +1,3 @@
+module RailsSluggable
+  VERSION = "1.0.1"
+end

data/lib/rails_sluggable.rb

@@ -0,0 +1,38 @@
+require 'rails_sluggable/engine'
+require 'active_support/concern'
+
+module RailsSluggable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def sluggable(options = {})
+      include InstanceMethods
+      
+      # Store configuration per model
+      self.slug_options = options
+    end
+  end
+
+  module InstanceMethods
+    def generate_slug_if_blank
+      return if slug.present?
+
+      length = self.class.slug_options[:length] || 12
+      separator = self.class.slug_options[:separator] || ''
+      
+      # Generate UUID, remove separators, take specified length
+      uuid = SecureRandom.uuid.gsub('-', separator)
+      self.slug = separator.present? ? uuid.split(separator)[0..(length-1)].join(separator) : uuid[0, length]
+    end
+
+    def save_with_slug
+      generate_slug_if_blank
+      save
+    end
+  end
+
+  included do
+    before_save :generate_slug_if_blank
+    class_attribute :slug_options
+  end
+end

data/lib/tasks/rails_sluggable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_sluggable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rails_sluggable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- aric.zheng
+bindir: exe
+cert_chain: []
+date: 2025-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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
+description: A Rails plugin to generate configurable slugs for models, replacing ID-based
+  URLs with user-friendly identifiers.
+email:
+- 1290657123@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails_sluggable.rb
+- lib/rails_sluggable/engine.rb
+- lib/rails_sluggable/railtie.rb
+- lib/rails_sluggable/version.rb
+- lib/tasks/rails_sluggable_tasks.rake
+homepage: https://github.com/afeiship/rails_sluggable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/afeiship/rails_sluggable
+  source_code_uri: https://github.com/afeiship/rails_sluggable
+  changelog_uri: https://github.com/afeiship/rails_sluggable/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: A Rails plugin for generating configurable model slugs
+test_files: []