sluggable-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 524d66a481f56da389dd239d9e1895c11e20740e
-  data.tar.gz: 5758997da24026a3fa780337259ea7b4315ba6bc
+SHA256:
+  metadata.gz: 17b9efd9689c4f2a8e4b7e43b9fc548bba77a991783df6ed0c33b17dc7098c0e
+  data.tar.gz: 9e94db4d0cb5ca8397cb60c23a92070757cd5439abb6e0b0b04ba4c14d685ec6
 SHA512:
-  metadata.gz: 66477a7d225c4d090f567069bd91974af60e4acc26bb424c16da812ee0bef86afaa54cd1f848408032b2344387108ef8b3e04b2a197b1b315f8eb24dbb670fa7
-  data.tar.gz: 48a5b48fb9b44e51df0753172db659dd6a215280e370368104d0a1f9ec424b608dd67786c9eae28254f6468c93a029f33fa736a53cc04993fe5ee4019ecc30e9
+  metadata.gz: 3dfa0e1a89c7ad121fd63aed9ff6dd2dfddcc5e24873a51d8d91e86b73dbf1e07672db0b13285e5c84ea6f4023769f68836a29d039594eb9033ab469c708689f
+  data.tar.gz: 0d32122dd202e54509ec30c199a51fa180c0d3fe732b32b8d3e032b7bbb093785d61da5fe54ed034af00e8148629da611548d3d9b4f34c929a211c81891dab6a

data/README.md

@@ -1,4 +1,7 @@
-# Sluggable Rails
+# Sluggable Rails 🏅
+[![Gem Version](https://badge.fury.io/rb/sluggable-rails.svg)](https://badge.fury.io/rb/sluggable-rails)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d260555b2cbb561875b4/maintainability)](https://codeclimate.com/github/juliendargelos/sluggable-rails/maintainability)
+
 Provide a unique slug to your records, generated from the attribute of your choice.
 
 ## Usage
@@ -16,24 +19,97 @@ Use the `has_slug` method:
 #  updated_at :datetime         not null
 #
 
-class Post < ActiveRecord::Base
+class Post < ApplicationRecord
+  #...
+
   has_slug by: :title
+
+  #...
 end
 ```
 
+```ruby
+post = Post.create title: 'My first slugified post!'
+post.slug # "my-first-slugified-post"
+
+another_post = Post.create title: 'My first slugified post!'
+another_post.slug # "my-first-slugified-post-1"
+```
+
 In this example, the slug will be generated from the post title. By default, it will be stored in the slug attribute.
 You can choose another attribute to store it:
 
 ```ruby
-has_slug :custom_attribute, by: :title
+class Post < ApplicationRecord
+  #...
+
+  has_slug :custom_attribute, by: :title
+
+  #...
+end
+```
+
+The slug is generated with the [`parameterize` method](http://api.rubyonrails.org/v5.1/classes/ActiveSupport/Inflector.html#method-i-parameterize), you can specify a separator as it expects (default: `'-'`):
+
+```ruby
+class Post < ApplicationRecord
+  #...
+
+  has_slug :custom_attribute, by: :title, separator: '_'
+
+  #...
+```
+
+Obviously, you have to add the corresponding column to your schema:
+
+```ruby
+class CreatePosts < ActiveRecord::Migration[5.1]
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.string :slug, null: false, index: true, unique: true # Or your custom attribute
+
+      t.timestamps
+    end
+  end
+end
 ```
 
-The slug is generated with the [`parameterize` method](http://api.rubyonrails.org/v5.1/classes/ActiveSupport/Inflector.html#method-i-parameterize), you can specify a separator as it excepts (default: `'-'`):
+The slug will be automatically generated in order to be unique. And a `presence` and `uniqueness` validations will also be added by the `has_slug` method.
+
+Moreover, you can define a scope for you slug so its uniqueness will depends on others attributes:
 
 ```ruby
-has_slug :custom_attribute, by: :title, separator: '_'
+class Post < ApplicationRecord
+  #...
+  
+  belongs_to :user
+  has_slug by: :title, scope: :user_id
+  # You can specify more than one attribute by giving an array of attributes to the scope option.
+
+  #...
+end
 ```
 
+In this example, each post will have a slug which is unique for the user it belongs to (but it could be any other attribute).
+
+The corresponding migration would be:
+
+```ruby
+class CreatePosts < ActiveRecord::Migration[5.1]
+  def change
+    create_table :posts do |t|
+      t.string :title
+      t.references :user, foreign_key: true
+      t.string :slug, null: false
+
+      t.timestamps
+    end
+  end
+
+  add_index :posts, [:user_id, :slug], unique: true
+end
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/sluggable/core_ext.rb

@@ -1,9 +1,9 @@
 ActiveRecord::Base.instance_eval do
   before_save :update_slugs
 
-  def has_slug attribute = :slug, by:, separator: '-'
-    slug_definitions.add attribute, origin: by, separator: separator
-    validates attribute, presence: true, uniqueness: true
+  def has_slug(attribute = :slug, by:, separator: '-', scope: nil)
+    slug_definitions.add attribute, origin: by, separator: separator, scope: scope
+    validates attribute, presence: true, uniqueness: scope.present? ? { scope: scope } : true
   end
 
   def slug_definitions

data/lib/sluggable/rails/definition.rb

@@ -1,10 +1,11 @@
 class Sluggable::Rails::Definition
-  attr_reader :attribute, :origin, :separator
+  attr_reader :attribute, :origin, :separator, :scope
 
-  def initialize(attribute = :slug, origin:, separator: '-')
+  def initialize(attribute = :slug, origin:, separator: '-', scope: nil)
     self.attribute = attribute
     self.origin = origin
     self.separator = separator
+    self.scope = scope
   end
 
   def attribute=(v)
@@ -18,4 +19,8 @@ class Sluggable::Rails::Definition
   def separator=(v)
     @separator = v.to_s
   end
+
+  def scope=(v)
+    @scope = [v].flatten.map{ |attribute| :"#{attribute}" }.compact.uniq
+  end
 end

data/lib/sluggable/rails/definitions.rb

@@ -7,11 +7,11 @@ class Sluggable::Rails::Definitions
     @definitions[attribute.to_s.to_sym]
   end
 
-  def add attribute = :slug, origin:, separator: '-'
+  def add(attribute = :slug, origin:, separator: '-')
     @definitions[attribute.to_s.to_sym] = Sluggable::Rails::Definition.new attribute, origin: origin, separator: separator
   end
 
-  def slugs from:
+  def slugs(from:)
     slugs = Sluggable::Rails::Slugs.new
     @definitions.each { |_, definition| slugs.add definition, from }
     slugs

data/lib/sluggable/rails/slug.rb

@@ -50,6 +50,10 @@ class Sluggable::Rails::Slug < String
     undefined? || changed?
   end
 
+  def scope
+    definition.scope.map{ |attribute| [atribute, record.send(attribute)] }.to_h
+  end
+
   protected
 
   def generate
@@ -64,7 +68,7 @@ class Sluggable::Rails::Slug < String
   end
 
   def unique?
-    found = record.class.find_by definition.attribute => self.to_s
+    found = record.class.find_by (definition.attribute => self.to_s).merge(scope)
     !found || found.id == record.id
   end
 end

data/lib/sluggable/rails/slugs.rb

@@ -3,7 +3,7 @@ class Sluggable::Rails::Slugs
     @slugs = []
   end
 
-  def add definition, record
+  def add(definition, record)
     @slugs << Sluggable::Rails::Slug.new(definition, record)
   end
 

data/lib/sluggable/rails/version.rb

@@ -1,5 +1,5 @@
 module Sluggable
   module Rails
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sluggable-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Julien Dargelos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-15 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Slugify your rails records.