Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
storing seo frendly url in column
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
db
lib
spec
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
changelog.md
slugable.gemspec

README.md

Slugable

Installation

Add this line to your application's Gemfile:

gem 'slugable'

And then execute:

$ bundle

Or install it yourself as:

$ gem install slugable

Usage

in model use method has_slug

class Item < ActiveRecord::Base
  attr_accessor :name, :slug

  has_slug # default :from => :name, :to => :slug, :formatter => :parameterize, :cache_tree => true
end

# then in code
item = Item.create!(:name => "my name is")
item.slug # => "my-name-is"

item.to_slug # => "my-name-is"

item.slug = "new-slug

item.to_slug_was  # => "my-name-is"
item.to_slug_will # => "new-slug"
item.to_slug      # => "new-slug"

you can override defaults by passing hash

class Page < ActiveRecord::Base
  attr_accessor :title, :seo_url

  has_slug :from => :title, :to => :seo_url, :formatter => :my_style
end

class String
  def my_style
    self.parameterize
  end
end

# then in code
page = Page.create!(:title => "my name is", :seo_url => "my url")
page.seo_url # => "my-url"
page.to_seo_url # => "my-url"

if you have model with ancestry gem 'https://github.com/stefankroes/ancestry'

class Category < ActiveRecord::Base
  attr_accessor :name, :slug

  has_ancestry
  has_slug
end

# then in code
root = Category.create!(:name => "root", :slug => "root")
root.slug # => "root"
root.to_slug # => ["root"]

child = Category.new(:name => "child", :slug => "child")
child.parent = root
child.save!

child.slug # => "child"
child.to_slug # => ["root", "child"]

branch = Category.create!(:name => "branch", :slug => "branch")
child.parent = branch
child.slug = "renamed"

child.to_slug_was # => ["root", "child"]
child.to_slug_will # => ["branch", "renamed"]

child.to_slug # => ["root", "child"]
child.save!
child.to_slug # => ["branch", "renamed"]

configuration

By default all ancestry structure are cached to prevent useless calls to fetch same record from database just for slug values. You can pass :cache_tree option to disable it like this.

class Category < ActiveRecord::Base
  attr_accessor :name, :slug

  has_ancestry
  has_slug :cache_tree => false
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.