pretty_slugs 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pretty_slugs.gemspec
+gemspec
+gem 'activerecord', ">= 3.0.0", "~> 3.2"
+gem 'activesupport', ">= 3.0.0", "~> 3.2"
+gem 'railties', ">= 3.0.0", "~> 3.2"
+gem 'rake'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kevin Hopkins
+
+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,47 @@
+# PrettySlugs
+
+[Slug Monster](http://www.horrordvds.com/reviews/n-z/slugs/slugs_shot3l.jpg)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pretty_slugs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_slugs
+
+## Usage
+
+to add the migration(s) to your app, run
+
+    $ rails g pretty_slugs
+
+then run
+
+    $ rake db:migrate
+
+To your models that need to implement pretty slugs, add this line:
+
+    include PrettySlugs
+
+And that is all you need if your model has a :name column, 
+if you want to override the slug via a form field, then
+you can create a field named :slug in the model's form
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+Bunder::GemHeper.install_tasks

data/lib/generators/pretty_slugs_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class PrettySlugsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  extend ActiveRecord::Generators::Migration
+  
+  source_root File.expand_path("../../pretty_slugs", __FILE__)
+  
+  def copy_files(*args)
+    migration_template "migration.rb", "db/migrate/create_pretty_slugs.rb"
+  end
+end

data/lib/pretty_slugs/migration.rb

@@ -0,0 +1,18 @@
+class CreatePrettySlugs < ActiveRecord::Migration
+  def self.up
+    create_table :pretty_slugs do |t|
+      t.string :slug, null: false
+      t.integer :sluggable_id, null: false
+      t.string :sluggable_class, null: false
+      t.timestamps
+    end
+    
+    add_index :pretty_slugs, :sluggable_id
+    add_index :pretty_slugs, [:slug, :sluggable_class]
+    add_index :pretty_slugs, :sluggable_class
+  end
+  
+  def self.down
+    drop_table :pretty_slugs
+  end
+end

data/lib/pretty_slugs/version.rb

@@ -0,0 +1,3 @@
+module PrettySlugs
+  VERSION = "0.0.2"
+end

data/lib/pretty_slugs.rb

@@ -0,0 +1,119 @@
+require "pretty_slugs/version"
+
+module PrettySlugs
+  extend ActiveSupport::Concern
+  included do
+    attr_accessor :slug
+    
+    after_commit lambda {
+      action = transaction_include_action?(:create) ? "create" : transaction_include_action?(:destroy) ? "destroy" : "save"
+      case action
+      when "destroy"
+        remove_slug
+      end
+    }
+    
+    # Class method overload for ActiveRecord's find.  Covers id's passed in as string or number, and slugs passed.
+    # This is wrapped in an eval block because of Ruby 1.9.2 and issues with super in a singleton included by multiple classes. 
+    # This is the error otherwise:
+    # super from singleton method that is defined to multiple classes is not supported; this will be fixed in 1.9.3 or later
+    # http://stackoverflow.com/questions/4261615/workaround-for-ruby-1-9-2-super-from-singleton-method-that-is-defined-to-multip
+    # error occurs when same lexical method (which calls super) is defined on the singleton class of two or more objects of different classes, and then that method is called on any of the objects other than the last one the method was defined on...
+    eval %(
+      def self.find(input, *args)
+        if input.is_a?(Integer) || input.is_a?(Fixnum)
+          super
+        elsif input.is_a?(Symbol)
+          super
+        elsif input.is_a?(String) && input.to_i.to_s == input
+          super
+        else
+          obj = Slug.find_by_slug(input)
+          return obj.sluggable_class.constantize.find(obj.sluggable_id, args) rescue nil
+        end
+      end
+    )
+    class Slug < ActiveRecord::Base
+      self.table_name = 'pretty_slugs'
+      attr_accessible :slug, :sluggable_id, :sluggable_class
+    end
+    
+    def slug
+      slug = Slug.find_by_sluggable_id_and_sluggable_class(self.id, self.class.to_s).slug rescue nil
+      return slug if slug
+      generate_slug
+    end
+    
+    def slug=(val)
+      check_slug_existence
+      if val != nil && val != ""
+        slug = val
+        Slug.find_by_sluggable_id_and_sluggable_class(self.id, self.class.to_s).update_attribute(:slug, val)
+        update_menu_elements(val)
+      else
+        # do nothing
+      end
+    end
+    
+    def check_slug_existence
+      if self.slug.nil?
+        generate_slug
+      end
+    end
+    
+    def generate_slug
+      inc = 1
+      slug = self.to_slug
+      while !Slug.find_by_sluggable_id_and_sluggable_class(self.id, self.class.to_s).nil?
+        slug += "-#{inc}"
+        inc += 1
+      end
+
+      obj = Slug.create({
+        slug: slug,
+        sluggable_id: self.id,
+        sluggable_class: self.class.to_s
+      })
+      
+      update_menu_elements(slug)
+      slug
+    end
+    
+    def remove_slug
+      Slug.find_by_sluggable_id_and_sluggable_class(self.id, self.class.to_s).destroy rescue true
+    end
+    
+    def update_slug
+      Slug.find_by_sluggable_id_and_sluggable_class(self.id, self.class.to_s).update_attribute(slug: self.slug)
+    end
+    
+    def update_menu_elements(url=nil)
+      if self.respond_to?("menu_elements") && self.class.to_s == "Page"
+        self.menu_elements.each{|me| me.update_attribute(:url, ("/pages/" + (url.nil? || url.empty? ? self.slug : url)))}
+      end
+    end
+    
+    def to_slug(val=nil)
+      #strip the string
+      ret = val.nil? ? self[self.respond_to?("name") ? "name" : "title"].strip : val
+      ret = ret.downcase
+      #blow away apostrophes
+      ret.gsub! /['`]/,""
+
+      # @ --> at, and & --> and
+      ret.gsub! /\s*@\s*/, " at "
+      ret.gsub! /\s*&\s*/, " and "
+
+      #replace all non alphanumeric, underscore or periods with underscore
+      ret.gsub! /\s*[^A-Za-z0-9\.\-]\s*/, '_'  
+
+      #convert double underscores to single
+      ret.gsub! /_+/,"_"
+
+      #strip off leading/trailing underscore
+      ret.gsub! /\A[_\.]+|[_\.]+\z/,""
+
+      ret
+    end
+  end
+end

data/pretty_slugs.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pretty_slugs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kevin Hopkins", "Timothy Johnson"]
+  gem.email         = ["kevin@h-pk-ns.com", "timothy@wearefound.com"]
+  gem.description   = %q{Pretty Slugs for Rails models}
+  gem.summary       = %q{Pretty Slugs stores sluggified strings for rails models in an extensible way}
+  gem.homepage      = ""
+
+  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.name          = "pretty_slugs"
+  gem.require_paths = ["lib"]
+  gem.version       = PrettySlugs::VERSION
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pretty_slugs
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Kevin Hopkins
+- Timothy Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-28 00:00:00 Z
+dependencies: []
+
+description: Pretty Slugs for Rails models
+email: 
+- kevin@h-pk-ns.com
+- timothy@wearefound.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/pretty_slugs_generator.rb
+- lib/pretty_slugs.rb
+- lib/pretty_slugs/migration.rb
+- lib/pretty_slugs/version.rb
+- pretty_slugs.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Pretty Slugs stores sluggified strings for rails models in an extensible way
+test_files: []
+