has_friendly_name 0.2.0

data/README.md

@@ -0,0 +1,41 @@
+Digineo HasFriendlyName gem
+=========
+
+## Description
+  HasFriendlyName adds a search engine friendly name to your active record model.
+  It also extends the String class with a "to_friendly" method
+
+## Installation:
+add the following to your config/enviroment.rb
+
+  config.gem "has_friendly_name"
+
+
+## Add friendly_name column to your model
+  
+## Examples & usage
+
+### add an unique friendly_name to your model
+  If your user model has a name method and you want an unique friendly_name just use:
+    
+    class User < ActiveRecord::Base  
+      has_friendly_name
+    end
+  
+  first record with name *myStylish~Name* gets the following friendly_name: *mystylish-name*
+  
+  the second record with the same name gets the following friendly_name: *mystylish-name-2*
+
+### customize
+  HasFriendlyName comes with serveal configuration options:
+  
+    class User < ActiveRecord::Base  
+      has_friendly_name(:unique => false, :from => :title, :downcase => false, :titelize => true, :seperator => "_")
+    end
+  
+  first record with name *myStylish~Name* gets the following friendly_name: *MyStylish_Name*
+  
+  the second record with the same name gets the same because unique is false
+
+Copyright (c) 2010 Dennis Meise [Digineo GmbH](http://www.digineo.de/ "Digineo GmbH") , released under the MIT license
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_friendly_name plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_friendly_name plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasFriendlyName'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+require 'string_extensions'
+require 'has_friendly_name'
+ActiveRecord::Base.send(:include, HasFriendlyName)

data/lib/has_friendly_name.rb

@@ -0,0 +1,38 @@
+# HasFriendlyName
+module HasFriendlyName
+  
+  def self.included(base)
+    base.extend ClassMethods 
+  end
+  
+  module ClassMethods
+    # adds friendly_name to your model. Options are:
+    # * unique => boolean - should the friendly_name be unique for this model? appends count if name has been taken
+    # * to_downcase - friendly_name will be downcased
+    # * titelize - friendly_name will be titelized
+    def has_friendly_name(options={})
+      self.cattr_accessor :has_friendly_name_options
+      self.has_friendly_name_options = {:unique => true, :titelize => false, :downcase => true, :from => :name}.merge(options)
+      before_create :generate_friendly_name
+      include HasFriendlyName::InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    
+    def generate_friendly_name              
+      self.friendly_name = send(self.has_friendly_name_options[:from].to_s.to_sym).to_friendly(self.has_friendly_name_options)
+      
+      if self.has_friendly_name_options[:unique] 
+        checkmodel=self.class.find_by_friendly_name(self.friendly_name)          
+        if checkmodel and checkmodel!=self
+          self.friendly_name+='-'+(self.class.count+1).to_s
+        end
+      end
+          
+      self.friendly_name
+    end
+    
+  end
+  
+end

data/lib/string_extensions.rb

@@ -0,0 +1,50 @@
+class String
+  
+  def to_friendly(given_options={})
+    options = {:seperator => "-", :downcase => true, :titleize => false}.merge(given_options)
+    res = self    
+    res = res.titleize if options[:titleize]
+    res = res.gsub(/'/, "").gsub(/\W+/, " ").gsub(/\s\s*/, " ").strip.gsub(/\s/, options[:seperator])
+    res.gsub!(/ß/u, 'ss')
+    res.gsub!(/[ü]/u, 'ue')
+    res.gsub!(/«/, '')
+    res.gsub!(/»/, '')
+    res.gsub!(/[ä]/u, 'ae')
+    res.gsub!(/[ö]/u, 'oe')
+    res.gsub!(/ó/, 'o')    
+    res.gsub!(/Ä/u, 'ae')
+    res.gsub!(/Ö/u, 'Oe')
+    res.gsub!(/Ü/u, 'Ue')
+    
+    res.gsub!(/é/u, 'e')
+    res.gsub!(/è/u, 'e')
+    res.gsub!(/ê/u, 'e')
+    res.gsub!(/É/u, 'e')
+    res.gsub!(/È/u, 'e')
+    res.gsub!(/Ê/u, 'e')
+    
+    res.gsub!(/á/u, 'a')
+    res.gsub!(/à/u, 'a')
+    res.gsub!(/â/u, 'a')
+    res.gsub!(/Á/u, 'a')
+    res.gsub!(/À/u, 'a')
+    res.gsub!(/Â/u, 'A')
+    
+    res.gsub!(/ú/u, 'u')
+    res.gsub!(/ù/u, 'u')
+    res.gsub!(/û/u, 'u')
+    res.gsub!(/Ú/u, 'u')
+    res.gsub!(/Ù/u, 'u')
+    res.gsub!(/Û/u, 'u')
+    
+    res.gsub!(/í/u, 'i')
+    res.gsub!(/ì/u, 'i')
+    res.gsub!(/î/u, 'i')
+    res.gsub!(/Ì/u, 'i')
+    res.gsub!(/Í/u, 'i')
+    res.gsub!(/Î/u, 'i')
+    res.gsub!(/[^a-z^0-9^-^ ]+/i, options[:seperator])
+    options[:downcase] ? res.downcase : res
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "..", "init")

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: has_friendly_name
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dennis Meise
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: github@digineo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- init.rb
+- Rakefile
+- README.md
+- lib/has_friendly_name.rb
+- lib/string_extensions.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://www.digineo.de
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: HasFriendlyName adds a search engine friendly name to your active record model.
+test_files: []
+