slugable 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slugable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Miroslav Hettes
+
+MIT License
+
+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,80 @@
+# Slugable
+
+* adds support for seo friendly url
+* one helper method has_slug
+* support for ancestry models 'https://github.com/stefankroes/ancestry'
+
+## 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
+    end
+
+    # then in code
+    item = Item.create!(:name => "my name is")
+    item.slug # => "my-name-is"
+
+    item.to_slug # => "my-name-is"
+
+you can override defaults by passing hash
+
+
+    class Page < ActiveRecord::Base
+      attr_accessor :title, :seo_url
+
+      has_slug :from => :title, :to => :seo_url
+    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"]
+
+## 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

data/Rakefile

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

data/changelog.md

@@ -0,0 +1,6 @@
+# 0.0.1
+## added
+* init version from real project
+* support for storing seo friendly url
+* caching slug for ancestry models
+* all covered with tests

data/db/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define do
+  create_table "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
+  end
+
+  create_table "pages", :force => true do |t|
+    t.string "title"
+    t.string "seo_path"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "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
+  end
+end

data/lib/slugable/has_slug.rb

@@ -0,0 +1,129 @@
+module Slugable
+  module HasSlug
+    #
+    # USAGE
+    # generate before save filter for filling slug from name attribute, and parameterize slug attribute
+    # you can change default columns by passing :from and :to attributes
+    #
+    # it also generate method to_slug (depanding od :to param), which generate slug url for link_path
+    #
+    # has_slug                                # generate to_slug
+    # has_slug :from => :title                # generate to_slug
+    # has_slug :to => :seo_url                # generate to_url
+    # has_slug :from => :name, :to => :slug   # generate to_slug
+    #
+    def has_slug(options={})
+      defaults = {:from => :name, :to => :slug}
+      options.reverse_merge!(defaults)
+      from = options.delete(:from)
+      to = options.delete(:to)
+      before_save :"fill_slug_from_#{from}_to_#{to}", :"format_slug_from_#{from}_to_#{to}"
+      after_save :"update_my_#{to}_cache"
+
+      # generate this
+      #
+      # def fill_slug
+      #   self.slug = name unless slug.present?
+      # end
+      code =<<-method
+        def fill_slug_from_#{from}_to_#{to}
+          self.#{to} = #{from} unless #{to}.present?
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      #
+      # def format_slug
+      #   self.slug = slug.parameterize
+      # end
+      code =<<-method
+        def format_slug_from_#{from}_to_#{to}
+          self.#{to} = #{to}.parameterize
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      # def update_my_slug_cache
+      #  @@all ||= {}
+      #  @@all[id] = send(:slug)
+      # end
+      code =<<-method
+        def update_my_#{to}_cache
+          @@all ||= {}
+          @@all[id] = send(:#{to})
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      #
+      # def self.all_slugs
+      #  slug_column = :slug
+      #  @@all ||= self.all.map_to_hash{|slug_element| {slug_element.id => slug_element.send(slug_column)}}
+      # end
+      code =<<-method
+        def self.all_#{to}s
+          @@all ||= self.all.map_to_hash{|slug_element| {slug_element.id => slug_element.send(:#{to})}}
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      #
+      # def self.clear_cached_slugs
+      #  @@all = nil
+      # end
+      code =<<-method
+        def self.clear_cached_#{to}s
+          @@all = nil
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      #
+      # def self.cached_slug(id)
+      #  all_slugs[id]
+      # end
+      code =<<-method
+        def self.cached_#{to}(id)
+          all_#{to}s[id].to_s
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      #
+      # def to_slug
+      #  if respond_to?(:path_ids)
+      #    slugs = path_ids.map{|id| self.class.cached_slug(id)}.select{|i| i.size > 0 }
+      #    if slugs.empty?
+      #      ""
+      #    else
+      #      slug
+      #    end
+      #  else
+      #    send(:slug)
+      #  end
+      # end
+      code =<<-method
+        def to_#{to}
+          if respond_to?(:path_ids)
+            slugs = path_ids.map{|id| self.class.cached_#{to}(id)}.select{|i| i.size > 0 }
+            if slugs.empty?
+              ""
+            else
+              slugs
+            end
+          else
+            send(:#{to})
+          end
+        end
+      method
+      class_eval(code)
+    end
+
+  end
+end

data/lib/slugable/railtie.rb

@@ -0,0 +1,9 @@
+module Slugable
+  class Railtie < Rails::Railtie
+    initializer "slugable.active_record_ext" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :extend, Slugable::HasSlug
+      end
+    end
+  end
+end

data/lib/slugable/version.rb

@@ -0,0 +1,3 @@
+module Slugable
+  VERSION = "0.0.1"
+end

data/lib/slugable.rb

@@ -0,0 +1,6 @@
+require "active_record"
+require "active_support"
+require "wnm_support"
+require "slugable/version"
+require "slugable/has_slug"
+require "slugable/railtie" if defined?(Rails)

data/slugable.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slugable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "slugable"
+  gem.version       = Slugable::VERSION
+  gem.authors       = ["Miroslav Hettes"]
+  gem.email         = ["hettes@webynamieru.sk"]
+  gem.description   = %q{Add dsl method for automatic storing seo friendly url in database column}
+  gem.summary       = %q{Storing seo friendly url in column}
+  gem.homepage      = "https://github.com/mirrec/slugable"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "activerecord", ">= 3.0"
+  gem.add_runtime_dependency "activesupport", ">= 3.0"
+  gem.add_runtime_dependency "wnm_support", "~> 0.0.4"
+
+  gem.add_development_dependency "rspec", "~> 2.11.0"
+  gem.add_development_dependency "rake", "~> 0.9.2.2"
+  gem.add_development_dependency "sqlite3", "~> 1.3.6"
+  gem.add_development_dependency "ancestry", "~> 1.3.0"
+end

data/spec/slugable/has_slug_spec.rb

@@ -0,0 +1,147 @@
+require "spec_helper"
+
+ActiveRecord::Base.send :extend, Slugable::HasSlug
+
+class Item < ActiveRecord::Base
+  attr_accessor :name, :slug
+
+  has_slug
+end
+
+class Page < ActiveRecord::Base
+  attr_accessor :title, :seo_url
+
+  has_slug :from => :title, :to => :seo_url
+end
+
+class Category < ActiveRecord::Base
+  attr_accessor :name, :slug
+
+  has_ancestry
+  has_slug
+end
+
+
+describe Slugable::HasSlug do
+  before(:each) do
+    Category.clear_cached_slugs
+  end
+
+  context "default options" do
+    it "should create fill_slug_from_name_to_slug" do
+      Item.new.should respond_to :fill_slug_from_name_to_slug
+    end
+
+    it "should create format_slug_from_name_to_slug" do
+      Item.new.should respond_to :format_slug_from_name_to_slug
+    end
+
+    it "should fill in slug parameter from attribute name and parametrize it" do
+      item = Item.create!(:name => "my name is")
+      item.slug.should eq "my-name-is"
+    end
+
+    it "should only parametrize slug attribute if slug is present" do
+      item = Item.create!(:name => "my name is", :slug => "my url")
+      item.slug.should eq "my-url"
+    end
+  end
+
+  context "given options" do
+    it "should create fill_slug_from_title_to_seo_url" do
+      Page.new.should respond_to :fill_slug_from_title_to_seo_url
+    end
+
+    it "should create format_slug_from_title_to_seo_url" do
+      Page.new.should respond_to :format_slug_from_title_to_seo_url
+    end
+
+    it "should fill in slug parameter from attribute name and parametrize it" do
+      page = Page.create!(:title => "my name is")
+      page.seo_url.should eq "my-name-is"
+    end
+
+    it "should only parametrize slug attribute if slug is present" do
+      page = Page.create!(:title => "my name is", :seo_url => "my url")
+      page.seo_url.should eq "my-url"
+    end
+  end
+
+  describe "to_slug" do
+    context "default options" do
+      it "should define mehtod to_seo_url" do
+        Item.new.should respond_to :to_slug
+      end
+
+      it "should return slug in string" do
+        item = Item.create!(:name => "my name is", :slug => "my-url")
+        item.to_slug.should eq "my-url"
+      end
+    end
+
+    context "given options" do
+      it "should define mehtod to_seo_url" do
+        Page.new.should respond_to :to_seo_url
+      end
+
+      it "should return slug in string" do
+        page = Page.create!(:title => "my name is", :seo_url => "my-url")
+        page.to_seo_url.should eq "my-url"
+      end
+    end
+
+    context "ancestry model" do
+      it "should return array of slugs" do
+        root = Category.create!(:name => "root", :slug => "root")
+        child = Category.new(:name => "child", :slug => "child")
+        child.parent = root
+        child.save!
+
+        child.to_slug.should eq ["root", "child"]
+      end
+    end
+  end
+
+  describe "ancestry methods" do
+    describe "all_slugs" do
+      it "ancestry model class should respond to all_slugs" do
+        Category.should respond_to :all_slugs
+      end
+
+      it "should return all slugs in hash where key is id and value is slug by itself" do
+        root = Category.create!(:name => "root", :slug => "root")
+        child = Category.new(:name => "child", :slug => "child")
+        child.parent = root
+        child.save!
+
+        Category.all_slugs.should eq({root.id => "root", child.id => "child"})
+      end
+
+      it "should update slug cache after save" do
+        root = Category.create!(:name => "root", :slug => "root")
+        Category.all_slugs.should eq({root.id => "root"})
+
+        child = Category.new(:name => "child", :slug => "child")
+        child.save! # force save
+        Category.all_slugs.should eq({root.id => "root", child.id => "child"})
+
+        child.slug = "updated-child"
+        child.save # standard save
+        Category.all_slugs.should eq({root.id => "root", child.id => "updated-child"})
+      end
+    end
+
+    describe "clear_cached_slugs" do
+      it "should clear cache for slug" do
+        root = Category.create!(:name => "root", :slug => "root")
+        Category.all_slugs.should eq({root.id => "root"})
+
+        root.destroy
+        Category.all_slugs.should eq({root.id => "root"})
+
+        Category.clear_cached_slugs
+        Category.all_slugs.should eq({})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "slugable"
+require "sqlite3"
+require "ancestry"
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+load "db/schema.rb"
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end
+

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: slugable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Miroslav Hettes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: wnm_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Add dsl method for automatic storing seo friendly url in database column
+email:
+- hettes@webynamieru.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- changelog.md
+- db/schema.rb
+- lib/slugable.rb
+- lib/slugable/has_slug.rb
+- lib/slugable/railtie.rb
+- lib/slugable/version.rb
+- slugable.gemspec
+- spec/slugable/has_slug_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mirrec/slugable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Storing seo friendly url in column
+test_files:
+- spec/slugable/has_slug_spec.rb
+- spec/spec_helper.rb