slugable 0.0.4 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b0a37a9a60ba3abef0792c337b76720cefc99ef
+  data.tar.gz: 8c892a3ce4d03dd42cf890d9c122a791e937d690
+SHA512:
+  metadata.gz: 52a1957403eebed9c904e51d9b36b93ed7d5e7e49f0a1b4537ebcb3cf1ee6de480557f57a0f7d6cd3f7c2986c0d86cd4b1a714bfc04a6e67c81aeb6293c818ab
+  data.tar.gz: c4b5b0fe345489617eb9160867122e288b467a707e2b7d2adaf4dcb6b4cd6935f7e9ffd88120ef145b7dae7b1b4433cfd81f6b3a83906937ad63fe1bc0c55454

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -16,3 +15,5 @@ test/tmp
 test/version_tmp
 tmp
 .idea/
+Gemfile.lock
+gemfiles/*.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-2.2.2@slugable --create

data/.travis.yml

@@ -0,0 +1,26 @@
+cache: bundler
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.2
+before_install:
+  - rm .rvmrc
+script:
+  - "bundle exec rspec spec/"
+sudo: false
+gemfile:
+  - gemfiles/activerecord_3.2.gemfile
+  - gemfiles/activerecord_4.0.gemfile
+  - gemfiles/activerecord_4.1.gemfile
+  - gemfiles/activerecord_4.2.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/activerecord_4.0.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/activerecord_4.1.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/activerecord_4.2.gemfile
+addons:
+  code_climate:
+    repo_token: 3e779acb537014cbfd1a7c48c7a509d3197afe962cd1738e832a46b439919e24

data/Appraisals

@@ -0,0 +1,24 @@
+# Appraisals
+appraise "activerecord-3.2" do
+  gem "activerecord", "~> 3.2.1"
+  gem "ancestry", "~> 1.3.0"
+
+  gem "test-unit", "~> 3.0"
+end
+
+if RUBY_VERSION > "1.9.3"
+  appraise "activerecord-4.0" do
+    gem "activerecord", "~> 4.0.1"
+    gem "ancestry", "~> 2.1.0"
+  end
+
+  appraise "activerecord-4.1" do
+    gem "activerecord", "~> 4.1.1"
+    gem "ancestry", "~> 2.1.0"
+  end
+
+  appraise "activerecord-4.2" do
+    gem "activerecord", "~> 4.2.1"
+    gem "ancestry", "~> 2.1.0"
+  end
+end

data/README.md

@@ -1,15 +1,39 @@
 # Slugable
 
-* adds support for seo friendly url
-* one helper method has_slug
-* support for ancestry models 'https://github.com/stefankroes/ancestry'
-* be default cache ancestry models url, can be changed
+[![Build Status](https://travis-ci.org/mirrec/slugable.svg?branch=master)](https://travis-ci.org/mirrec/slugable)
+[![Gem Version](https://badge.fury.io/rb/slugable.svg)](https://badge.fury.io/rb/slugable)
+[![Code Climate](https://codeclimate.com/github/mirrec/slugable/badges/gpa.svg)](https://codeclimate.com/github/mirrec/slugable)
+[![Test Coverage](https://codeclimate.com/github/mirrec/slugable/badges/coverage.svg)](https://codeclimate.com/github/mirrec/slugable/coverage)
+
+* adds support for creating seo friendly url to your active record models and simplifies generating url
+* gem is tests against rails 3.2, 4.0, 4.1, 4.2 and ruby 1.9.3. and 2.2.2
+
+```ruby
+# model
+class Article < ActiveRecord::Base
+  # has columns: id, name, slug
+  has_slug
+end
+
+# creating new
+item = Article.create!(name: 'First article')
+item.slug # => 'first-article'
+item.to_slug # => 'first-article'
+
+# routes to the article
+get "articles/:slug" => "articles#show", as: :article
+
+# view
+link_to 'My first article', article_path(item.to_slug) # => '/articles/first-article'
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'slugable'
+```ruby
+gem 'slugable'
+```
 
 And then execute:
 
@@ -21,91 +45,139 @@ Or install it yourself as:
 
 ## Usage
 
-in model use method has_slug
+* default configuration converts name column to slug column and formatted by parameterize method from active support
+* it internally use callbacks to do the job
+* it also adds several convenient methods for generating url parts `to_slug`, `to_slug_was`, `to_slug_will`
 
-    class Item < ActiveRecord::Base
-      attr_accessor :name, :slug
+```ruby
+class Item < ActiveRecord::Base
+  # columns :name, :slug
 
-      has_slug # default :from => :name, :to => :slug, :formatter => :parameterize, :cache_tree => true
-    end
+  has_slug # default from: :name, to: :slug
+end
 
-    # then in code
-    item = Item.create!(:name => "my name is")
-    item.slug # => "my-name-is"
+# then in code
+item = Item.create!(name: "my name is")
+item.slug # => "my-name-is"
 
-    item.to_slug # => "my-name-is"
+item.to_slug # => "my-name-is"
 
-    item.slug = "new-slug
+item.slug = "new-slug"
 
-    item.to_slug_was  # => "my-name-is"
-    item.to_slug_will # => "new-slug"
-    item.to_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
 
+```ruby
+class Page < ActiveRecord::Base
+  # has columns: :id, :title, :seo_url
 
-    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
+  has_slug from: :title, to: :seo_url, formatter: lambda { |string| string.downcase }
+end
+
+# then in code
+page = Page.create!(title: "NAME")
+page.seo_url # => "name"
+page.to_seo_url # => "name"
+```
+
+if model is a tree structure and you use [ancestry gem](https://github.com/stefankroes/ancestry),
+tree like structure will be generated
+
+```ruby
+class Category < ActiveRecord::Base
+  # has columns: :id, :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"]
+```
+
+* You can cache slug for tree structure if you want to optimize performance, all you need is to pass cache storage object
+
+```ruby
+class Category < ActiveRecord::Base
+  # has columns: :id, :name, :slug
+
+  has_ancestry
+  has_slug tree_cache_storage: Rails.cache
+end
+```
+
+## Configuration
+
+You can set up default formatter and default tree_cache_storage in you initializer.
+
+```ruby
+class MyFormatter
+  def self.call(string)
+    string.my_own_parameterize
+  end
+end
+
+Slugable.configure do |config|
+  config.formatter          = MyFormatter
+  config.tree_cache_storage = Rails.cache
+end
+```
+
+`to_slug`, `to_slug_was` and `to_slug_will` methods are implemented by to_slug_builder. You can implement you own one and pass as configuration
+
+```ruby
+# you own to slug builder
+class StupidToSlug
+  def to_slug(record)
+    "to_slug_#{record.id}"
+  end
+
+  def to_slug_was(record)
+    "to_slug_was_#{record.id}"
+  end
+
+  def to_slug_will(record)
+    "to_slug_will_#{record.id}"
+  end
+end
+
+# model
+class News < ActiveRecord::Base
+  # columns: :id, :name, :slug
+
+  has_slug to_slug_builder: StupidToSlug.new
+end
+
+# code
+news = News.create!(name: 'whatever')
+news.to_slug      # => "to_slug_#{news.id}"
+news.to_slug_was  # => "to_slug_was_#{news.id}"
+news.to_slug_will # => "to_slug_will_#{news.id}"
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,14 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+end

data/changelog.md

@@ -1,3 +1,53 @@
+# 1.0.0 (November 22, 2015)
+## added
+* add ability to pass cache storage to tree structure `tree_cache_storage`
+* add ability to set default `formatter` and `tree_cache_storage` in config
+```ruby
+Slugable.configure do |config|
+  config.formatter          = MyFormatter
+  config.tree_cache_storage = Rails.cache
+end
+```
+* introduce slug builder
+* add ability to pass own slug builder
+```ruby
+# you own to slug builder
+class StupidToSlug
+  def to_slug(record)
+    "to_slug_#{record.id}"
+  end
+
+  def to_slug_was(record)
+    "to_slug_was_#{record.id}"
+  end
+
+  def to_slug_will(record)
+    "to_slug_will_#{record.id}"
+  end
+end
+
+# model
+class News < ActiveRecord::Base
+  # columns: :id, :name, :slug
+
+  has_slug to_slug_builder: StupidToSlug.new
+end
+```
+* travis ci for running tests
+  * tests run against ruby `1.9.3`, `2.2.2` and `activerecord` from >= `3.2` <= `4.2`
+* test coverage
+* code climate
+## changed
+* big internal refactoring
+* `formatter` param now expect callable object
+* `cache_tree` option has been change to `tree_cache_storage` and expect object that can store cache (e.g. Rails.cache), it is `nil` by default
+* ruby version to `2.2.2`
+* hash to new syntax
+* all spec uses expect syntax
+* `to_slug` method for tree structure now returns array all the time
+## fixed
+* several bugs with caching
+
 # 0.0.4 (May 30, 2013)
 ## fixed
 * `to_slug` method not skip nil in path

data/db/schema.rb

@@ -1,40 +1,47 @@
 ActiveRecord::Schema.define do
-  create_table "items", :force => true do |t|
+  create_table "flat_items", force: true do |t|
     t.string "name"
     t.string "title"
     t.string "slug"
     t.string "seo_url"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  create_table "pages", :force => true do |t|
+  create_table "flat_pages", force: true do |t|
     t.string "title"
     t.string "seo_url"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  create_table "categories", :force => true do |t|
+  create_table "tree_categories", force: true do |t|
     t.string "name"
     t.string "ancestry"
     t.string "slug"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  create_table "products", :force => true do |t|
+  create_table "flat_products", force: true do |t|
     t.string "name"
     t.string "slug"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  create_table "tree_items", :force => true do |t|
+  create_table "tree_items", force: true do |t|
     t.string "name"
     t.string "ancestry"
     t.string "slug"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "flat_news", force: true do |t|
+    t.string "name"
+    t.string "slug"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 end