galetahub-salty_slugs 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.markdown

@@ -0,0 +1,72 @@
+## SaltySlugs
+
+ Abstraction of word-based slugs for URLs, w/ or w/o leading numeric IDs.
+ 
+## Installation
+
+* Using Rails 3
+
+<pre>
+rails plugin install git://github.com/norbauer/salty_slugs.git
+</pre>
+
+
+* Using Rails 2.1+
+
+<pre>
+./script/plugin install git://github.com/norbauer/salty_slugs.git
+</pre>
+
+## Instructions
+
+* SaltySlugs defaults to `title` as the `source_column`, `slug` as the `slug_column`, and prepends the model ID. Upon creating/updating a record, the plugin will sluggify the `source_column` when the `slug_column` is empty, otherwise it will sluggify the `slug_column` _unless_ the `slug_sync` option is set to true (defaults to false).
+
+<pre> 
+class Post < ActiveRecord::Base
+   has_slug
+end
+ 
+post = Post.create(:title => "Do Not Mix Slugs and Salt!")
+@post.to_param
+=> '23-do-not-mix-slugs-and-salt'
+</pre>
+
+* You can also overwrite the defaults
+
+<pre>
+class Product < ActiveRecord::Base
+   has_slug :source_column => :name, :slug_column => :permalink, :prepend_id => false
+end
+ 
+@product = Product.create(:name => "Salt and Pepper Shaker")
+@product.to_param
+=> 'salt-and-pepper-shaker'
+</pre>
+ 
+* Use the `slugged_find` class method in your controllers, smart enough to modify the search conditions if prepending ID is found or not. `slugged_find` is capable of accepting standard `ActiveRecord::Base#find` options as a second parameter. If no records are found, `ActiveRecord::RecordNotFound` is raised to match behavior of `ActiveRecord::Base#find`.
+
+<pre>
+class PostsController < ApplicationController
+
+   def show
+     @post = Post.slugged_find(params[:id])
+     # or optionally with an eager-load
+     @post_with_author = Post.slugged_find(params[:id], :include => :author)
+   # catch exceptions if post is not found
+   rescue ActiveRecord::RecordNotFound
+     flash[:error] = "Post not found"
+     redirect_to :action => :index
+   end
+   
+end
+</pre>
+
+* If the `sync_slug` option is set to true, the `source_column` will _always_ be sluggified upon updating the record.  This means that the slug will not be able to be manually edited, but will always be synchronized to the `source_column`.
+
+## TODO
+
+* Add a word/regexp blacklist, so that they are sliced out of a string when sluggified (for example to remove .com, .net, etc)
+
+---
+Copyright (c) 2008 Norbauer Inc, released under the MIT license
+<br/>Written by Jonathan Dance and Jose Fernandez

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'salty_slugs', 'version')
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the slug plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the slug plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Slug'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "galetahub-salty_slugs"
+    s.version = SaltySlugs::VERSION
+    s.summary = "Generated slugs"
+    s.description = "Abstraction of word-based slugs for URLs, w/ or w/o leading numeric IDs."
+    s.email = "galeta.igor@gmail.com"
+    s.homepage = "https://github.com/galetahub/salty_slugs"
+    s.authors = ["Igor Galeta", "Pavlo Galeta"]
+    s.files =  FileList["[A-Z]*", "lib/**/*"]
+    s.extra_rdoc_files = FileList["[A-Z]*"] - %w(Rakefile)
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/lib/salty_slugs.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module SaltySlugs
+  autoload :Transliteration, 'salty_slugs/transliteration'
+  autoload :Utils,           'salty_slugs/utils'
+  autoload :ActiveRecord,    'salty_slugs/active_record'
+end
+
+require 'salty_slugs/railtie'

data/lib/salty_slugs/active_record.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+module SaltySlugs
+  module ActiveRecord
+    def self.included(base)
+      base.extend SlugMethods
+    end
+
+    module SlugMethods
+      # Configuration options are:
+      #   :slug_column - column for save slug
+      #   :source_column - source column for generate slug
+      #   :prepend_id - method to_param return ':id-:slug' or ':slug'
+      #   :sync_slug - regenerate slug on record update
+      #   :scope - for validation
+      #
+      # Usage:
+      # class Post < ActiveRecord::Base
+      #   has_slug :slug_column => 'permalink', :source_column => 'name'
+      # end
+      # 
+      def has_slug(options = {})
+        unless included_modules.include? InstanceMethods
+          extend ClassMethods
+          extend Columns
+          include InstanceMethods
+          include Columns
+        end
+
+        options = {
+            :slug_column => 'slug',
+            :source_column => 'title',
+            :prepend_id => true,
+            :sync_slug => false,
+            :scope => nil
+          }.merge(options)
+        
+        if options[:scope].is_a?(Symbol) && options[:scope].to_s !~ /_id$/
+          options[:scope] = "#{options[:scope]}_id".intern
+        end
+        
+        write_inheritable_attribute :salty_slugs_options, options
+        class_inheritable_reader :salty_slugs_options
+
+        unless slug_prepend_id
+          slug_scope_fields ? (validates_uniqueness_of slug_column, :scope => slug_scope_fields) : (validates_uniqueness_of slug_column)
+        end
+
+        before_validation { |record| record[slug_column] = (sync_slug || record[slug_column].blank?) ? SaltySlugs::Utils.sluggify(record.send(slug_source_column)) : SaltySlugs::Utils.sluggify(record[slug_column]) }
+      end
+
+      module ClassMethods
+        def slugged_find(value, options = {})
+          if slug_prepend_id && value.to_i != 0
+            find(value.to_i, options)
+          else
+            with_scope(:find => { :conditions => { slug_column => value } }) do
+              find(:first, options)
+            end or raise ::ActiveRecord::RecordNotFound
+          end
+        end
+      end
+
+      module Columns
+        def slug_column
+          salty_slugs_options[:slug_column]
+        end
+        
+        def slug_source_column
+          salty_slugs_options[:source_column]
+        end
+        
+        def slug_prepend_id
+          salty_slugs_options[:prepend_id]
+        end
+        
+        def sync_slug
+          salty_slugs_options[:sync_slug]
+        end
+        
+        def slug_scope_fields
+          salty_slugs_options[:scope]
+        end
+      end
+      
+      module InstanceMethods
+        def to_param
+          return self.id.to_s if self[slug_column].blank?
+          slug_prepend_id ? "#{self.id}-#{self[slug_column]}" : self[slug_column]
+        end
+      end
+    end
+  end
+end

data/lib/salty_slugs/railtie.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'rails'
+require 'salty_slugs'
+
+module SaltySlugs
+  class Railtie < Rails::Railtie
+    config.before_initialize do
+      ActiveSupport.on_load :active_record do
+        ::ActiveRecord::Base.send(:include, SaltySlugs::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/salty_slugs/transliteration.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+module SaltySlugs
+  # Russian transliteration 
+  #
+  # Транслитерация для букв русского алфавита
+  module Transliteration
+    extend self
+  
+    # Transliteration heavily based on rutils gem by Julian "julik" Tarkhanov and Co.
+    # <http://rutils.rubyforge.org/>
+    # Cleaned up and optimized.
+  
+    LOWER = {
+       "і"=>"i","ґ"=>"g","ё"=>"yo","№"=>"#","є"=>"e",
+       "ї"=>"yi","а"=>"a","б"=>"b",
+       "в"=>"v","г"=>"g","д"=>"d","е"=>"e","ж"=>"zh",
+       "з"=>"z","и"=>"i","й"=>"y","к"=>"k","л"=>"l",
+       "м"=>"m","н"=>"n","о"=>"o","п"=>"p","р"=>"r",
+       "с"=>"s","т"=>"t","у"=>"u","ф"=>"f","х"=>"h",
+       "ц"=>"ts","ч"=>"ch","ш"=>"sh","щ"=>"sch","ъ"=>"'",
+       "ы"=>"y","ь"=>"","э"=>"e","ю"=>"yu","я"=>"ya"
+    }.freeze
+  
+    UPPER = {
+      "Ґ"=>"G","Ё"=>"YO","Є"=>"E","Ї"=>"YI","І"=>"I",
+      "А"=>"A","Б"=>"B","В"=>"V","Г"=>"G",
+       "Д"=>"D","Е"=>"E","Ж"=>"ZH","З"=>"Z","И"=>"I",
+       "Й"=>"Y","К"=>"K","Л"=>"L","М"=>"M","Н"=>"N",
+       "О"=>"O","П"=>"P","Р"=>"R","С"=>"S","Т"=>"T",
+       "У"=>"U","Ф"=>"F","Х"=>"H","Ц"=>"TS","Ч"=>"CH",
+       "Ш"=>"SH","Щ"=>"SCH","Ъ"=>"'","Ы"=>"Y","Ь"=>"",
+       "Э"=>"E","Ю"=>"YU","Я"=>"YA",
+    }.freeze
+
+    # Transliterate a string with russian characters
+    #
+    # Возвращает строку, в которой все буквы русского алфавита заменены на похожую по звучанию латиницу
+    def transliterate(str)
+      chars = str.split(//)    
+    
+      result = ""
+
+      chars.each_with_index do |char, index|
+        if UPPER.has_key?(char) && LOWER.has_key?(chars[index+1])
+          # combined case
+          result << UPPER[char].downcase.capitalize
+        elsif UPPER.has_key?(char)
+          result << UPPER[char]
+        elsif LOWER.has_key?(char)
+          result << LOWER[char]
+        else
+          result << char
+        end
+      end
+
+      return result
+    end
+  end
+end

data/lib/salty_slugs/utils.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+begin
+  require "unicode"
+rescue LoadError
+  require "iconv"
+end
+
+module SaltySlugs
+  module Utils
+    def self.sluggify(text)
+      return nil if text.blank?
+      
+      if defined?(Transliteration)
+      	str = Transliteration.transliterate(text)
+      	str = str.gsub(/\W+/, '-').gsub(/^-+/,'').gsub(/-+$/,'').downcase
+        return str
+      elsif defined?(Unicode)
+        str = Unicode.normalize_KD(text).gsub(/[^\x00-\x7F]/n,'')
+        str = str.gsub(/\W+/, '-').gsub(/^-+/,'').gsub(/-+$/,'').downcase
+        return str
+      else
+        str = Iconv.iconv('ascii//translit//ignore', 'utf-8', text).to_s
+        str.gsub!(/\W+/, ' ')
+        str.strip!
+        str.downcase!
+        str.gsub!(/\ +/, '-')
+        return str
+      end
+    end
+  end
+end

data/lib/salty_slugs/version.rb

@@ -0,0 +1,3 @@
+module SaltySlugs
+  VERSION = "1.0.0".freeze
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: galetahub-salty_slugs
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Igor Galeta
+- Pavlo Galeta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-16 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Abstraction of word-based slugs for URLs, w/ or w/o leading numeric IDs.
+email: galeta.igor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/salty_slugs.rb
+- lib/salty_slugs/active_record.rb
+- lib/salty_slugs/railtie.rb
+- lib/salty_slugs/transliteration.rb
+- lib/salty_slugs/utils.rb
+- lib/salty_slugs/version.rb
+has_rdoc: true
+homepage: https://github.com/galetahub/salty_slugs
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Generated slugs
+test_files: []
+