slugs 2.0.1 → 4.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21b9bbbfe8b2a44f63ffb7edf8eaa22fe97cf6ce
-  data.tar.gz: 41e5ec36704f1c403c4cb62030cdbc83dc4e8fb9
+  metadata.gz: 40739528bced84f0f44d1d2b4b703195e5200fad
+  data.tar.gz: 61ae632c29f54550bed3fc4ecd6e2919fa56d4fe
 SHA512:
-  metadata.gz: 1096e6bdcdb42b39622b0a8175c9c2fe7928b1d29e09fd2c4eedf5d1b59745dc871d653f4279cf7277a935632e935ee13dabd573c684034ea4bb6839fd465bc1
-  data.tar.gz: 072aa30a88b10abad83b03a6b45fb65fc383af4d1c3a9e7495822d7d8778fe13e3f8d727b73a020d439f5347d203a19c4fe24536373ec800f5d4006a0185ac81
+  metadata.gz: 454843d24608dad78b5c634201499918bd99d7c1cc59b46d8af85a2197c1be055be353f25ae9449846682a86174e06c1222aa9cf2a1ca41c675c8043ae95bc00
+  data.tar.gz: 81f1c28b5d1b2bdc1a482ce3fd5e2775bf63ec85d0f2946ee100d000976aa776880a8c3e5669608eeede8dbcb7ab23e7e26a35f9a2929fb93a75484b3f107e2b

data/README.md

@@ -1,12 +1,20 @@
 [![Gem Version](https://badge.fury.io/rb/slugs.svg)](http://badge.fury.io/rb/slugs)
 [![Code Climate](https://codeclimate.com/github/mmontossi/slugs/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/slugs)
-[![Build Status](https://travis-ci.org/mmontossi/slugs.svg)](https://travis-ci.org/mmontossis/slugs)
+[![Build Status](https://travis-ci.org/mmontossi/slugs.svg)](https://travis-ci.org/mmontossi/slugs)
 [![Dependency Status](https://gemnasium.com/mmontossi/slugs.svg)](https://gemnasium.com/mmontossi/slugs)
 
 # Slugs
 
 Manages slugs for records with minimal efford in rails.
 
+## Why
+
+I did this gem to:
+
+- Generalize how to control when routes will use the slug param.
+- Keep old slugs active until the record is destroyed.
+- Ensure unique slugs by appending an index automatically on duplicates.
+
 ## Install
 
 Put this line in your Gemfile:
@@ -21,47 +29,79 @@ $ bundle
 
 ## Configuration
 
-Generate the slugs configuration file:
+Run the install generator:
 ```
-bundle exec rails g slugs:install
+$ bundle exec rails g slugs:install
 ```
 
-Add the slug column to the tables of the models you want to have slugs:
+Set the global settings:
+```ruby
+Slugs.configure do |config|
+  config.use_slug? do |record, params|
+    params[:controller] != 'admin'
+  end
+end
+```
+
+## Usage
+
+### Definitions
+
+Add the column to your tables:
 ```ruby
-t.string :slug
+class AddSlug < ActiveRecord::Migration
+  def change
+    add_column :products, :slug, :string
+  end
+end
 ```
 
 Update your db:
 ```
-bundle exec rake db:migrate
+$ bundle exec rake db:migrate
 ```
 
-Configure the proc to decide which records will be slugged:
+Define slugs in your models:
 ```ruby
-Slugs.configure do |config|
-  config.use_slug_proc = Proc.new do |record, params|
-    params[:controller] != 'admin'
-  end
+class Product < ActiveRecord::Base
+  has_slug :model, :name, scope: :shop_id
 end
 ```
 
-## Usage
+### Generation
 
-Use has_slug in your models to define what the slug will be:
+A slug will be generated every time you create/update a record:
+```ruby
+product = Product.create(name: 'Stratocaster', model: 'American Standar', ...)
+product.slug # => 'american-standard-stratocaster'
+```
+
+An index will be appended if another record with the same slug is created:
+```ruby
+product = Product.create(name: 'Stratocaster', model: 'American Standard', ...)
+product.slug # => 'american-standard-stratocaster-1'
+```
 
-If you want to use the value of one field:
+Every time you change a record, the slug will be updated:
 ```ruby
-has_slug :prop
+product.update name: 'Strat'
+product.slug # => 'american-standard-strat'
 ```
 
-To concatenate the value of multiple fields:
+### Finders
+
+The find method of models will start accepting slugs and remember old ones:
 ```ruby
-has_slug :prop1, :prop2, :prop3
+Product.find 'american-standard-stratocaster' # => product
+Product.find 'american-standard-strat' # => product
 ```
 
-To find a record by slug:
+### Routes
+
+The logic of the use_slug? block is used to determine when to sluggize:
 ```ruby
-Model.find_by slug: 'slug'
+admin_product_path product # => 'admin/products/34443'
+product_path product # => 'products/american-standard-strat'
 ```
 
 ## Credits

data/Rakefile

@@ -4,26 +4,8 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Slugs'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-
-
 Bundler::GemHelper.install_tasks
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
-
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
@@ -31,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

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

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module Slugs
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_initializer_file
+        copy_file 'initializer.rb', 'config/initializers/slugs.rb'
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_slugs.rb'
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime '%Y%m%d%H%M%S'
+      end
+
+    end
+  end
+end

data/lib/generators/slugs/{templates/configuration.rb → install/templates/initializer.rb}

@@ -1,6 +1,6 @@
 Slugs.configure do |config|
 
-  config.use_slug_proc = Proc.new do |record, params|
+  config.use_slug? do |record, params|
     # Add your code here
   end
 

data/lib/generators/slugs/install/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateSlugs < ActiveRecord::Migration
+  def change
+    create_table :slugs do |t|
+      t.integer :sluggable_id
+      t.string :sluggable_type
+      t.string :value
+
+      t.timestamps null: false
+    end
+
+    add_index :slugs, :sluggable_id
+    add_index :slugs, :sluggable_type
+    add_index :slugs, :value
+  end
+end

data/lib/slugs.rb

@@ -1,9 +1,12 @@
 require 'slugs/extensions/action_dispatch/generator'
 require 'slugs/extensions/action_dispatch/optimized_url_helper'
 require 'slugs/extensions/active_record/base'
+require 'slugs/extensions/active_record/finders'
+require 'slugs/slug'
 require 'slugs/concern'
 require 'slugs/configuration'
 require 'slugs/railtie'
+require 'slugs/version'
 
 module Slugs
   class << self
@@ -17,7 +20,7 @@ module Slugs
     end
 
     def parameterize(record, params)
-      if use_slug_for?(record, params)
+      if use_slug?(record, params)
         if record.slug_changed?
           record.slug_was
         else
@@ -28,9 +31,9 @@ module Slugs
       end
     end
 
-    def use_slug_for?(record, params)
-      if record.try(:sluggable?) && configuration.use_slug_proc
-        configuration.use_slug_proc.call record, params
+    def use_slug?(record, params)
+      if record.try(:sluggable?)
+        configuration.use_slug? record, params
       else
         false
       end

data/lib/slugs/concern.rb

@@ -3,10 +3,9 @@ module Slugs
     extend ActiveSupport::Concern
 
     included do
-      before_create :set_slug
-      after_save :ensure_slug_uniqueness
+      has_many :slugs, as: :sluggable, class_name: 'Slugs::Slug'
+      before_save :set_slug
       validates_format_of :slug, with: /\A[a-z0-9\-]+\z/, allow_blank: true
-      validates_length_of :slug, maximum: 255, allow_blank: true
     end
 
     def sluggable?
@@ -18,10 +17,6 @@ module Slugs
     def set_slug
       options = self.class.slug
       self.slug = slice(*options[:attributes]).values.join(' ').parameterize
-    end
-
-    def ensure_slug_uniqueness
-      options = self.class.slug
       case options[:scope]
       when Symbol
         attribute = options[:scope]
@@ -30,8 +25,20 @@ module Slugs
         attributes = options[:scope]
         scope = attributes.map{ |a| [a, send(a)] }.to_h
       end
-      if self.class.where(scope).where(slug: slug).where.not(id: id).any?
-        update_column :slug, "#{slug}-#{id}"
+      relation = self.class.where(scope).where('slug ~ ?', "^#{slug}(-[0-9]+)?$")
+      if persisted?
+        relation = relation.where.not(id: id)
+      end
+      previous_slug = relation.order(slug: :desc).limit(1).pluck(:slug).first
+      if previous_slug.present?
+        if result = previous_slug.match(/^#{slug}-(\d+)$/)
+          self.slug += "-#{result[1].to_i + 1}"
+        else
+          self.slug += '-1'
+        end
+      end
+      if slug_changed?
+        slugs.build value: slug
       end
     end
 

data/lib/slugs/configuration.rb

@@ -1,7 +1,17 @@
 module Slugs
   class Configuration
 
-    attr_accessor :use_slug_proc
+    def use_slug?(*args, &block)
+      if block_given?
+        @use_slug = block
+      else
+        if @use_slug
+          @use_slug.call *args
+        else
+          false
+        end
+      end
+    end
 
   end
 end

data/lib/slugs/extensions/action_dispatch/generator.rb

@@ -2,6 +2,7 @@ module Slugs
   module Extensions
     module ActionDispatch
       module Generator
+        extend ActiveSupport::Concern
 
         def generate
           @set.formatter.generate(

data/lib/slugs/extensions/action_dispatch/optimized_url_helper.rb

@@ -2,6 +2,7 @@ module Slugs
   module Extensions
     module ActionDispatch
       module OptimizedUrlHelper
+        extend ActiveSupport::Concern
 
         private
 

data/lib/slugs/extensions/active_record/finders.rb

@@ -0,0 +1,27 @@
+module Slugs
+  module Extensions
+    module ActiveRecord
+      module Finders
+        extend ActiveSupport::Concern
+
+        def find(id)
+          if sluggable? && id.is_a?(String) && id !~ /\A\d+\z/
+            order = Slugs::Slug.order(id: :desc)
+            joins(:slugs).merge(order).find_by! slugs: { value: id }
+          else
+            super
+          end
+        end
+
+        def exists?(value=:none)
+          if sluggable? && value.is_a?(String) && value !~ /\A\d+\z/
+            joins(:slugs).exists? slugs: { value: value }
+          else
+            super
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/slugs/railtie.rb

@@ -1,16 +1,22 @@
 module Slugs
   class Railtie < Rails::Railtie
 
-    initializer 'slugs' do
-      ::ActionDispatch::Routing::RouteSet::NamedRouteCollection::UrlHelper::OptimizedUrlHelper.prepend(
-        Slugs::Extensions::ActionDispatch::OptimizedUrlHelper
-      )
+    initializer 'slugs.extensions' do
       ::ActionDispatch::Routing::RouteSet::Generator.prepend(
         Slugs::Extensions::ActionDispatch::Generator
       )
+      ::ActionDispatch::Routing::RouteSet::NamedRouteCollection::UrlHelper::OptimizedUrlHelper.prepend(
+        Slugs::Extensions::ActionDispatch::OptimizedUrlHelper
+      )
       ::ActiveRecord::Base.include(
         Slugs::Extensions::ActiveRecord::Base
       )
+      ::ActiveRecord::Base.extend(
+        Slugs::Extensions::ActiveRecord::Finders
+      )
+      ::ActiveRecord::Relation.include(
+        Slugs::Extensions::ActiveRecord::Finders
+      )
     end
 
   end

data/lib/slugs/slug.rb

@@ -0,0 +1,9 @@
+module Slugs
+  class Slug < ActiveRecord::Base
+
+    belongs_to :sluggable, polymorphic: true
+
+    validates_presence_of :sluggable, :value
+
+  end
+end

data/lib/slugs/version.rb

@@ -1,5 +1,5 @@
 module Slugs
 
-  VERSION = '2.0.1'
+  VERSION = '4.0.0.0'
 
 end

data/test/dummy/bin/bundle

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/test/dummy/bin/setup

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require 'pathname'
 
 # path to your application root.

data/test/dummy/config/database.yml.travis

@@ -1,12 +1,3 @@
-mysql: &mysql
-  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>mysql<%= '2' if RUBY_ENGINE != 'jruby' %>
-
-postgres: &postgres
-  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>postgresql
-
-sqlite: &sqlite
-  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>sqlite3
-
 test:
-  <<: *<%= ENV['DB'] %>
-  database: <%= ENV['DB'] == 'sqlite' ? 'db/travis.sqlite3' : 'travis' %>
+  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>postgresql
+  database: travis