acts_as_nice_url 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [Nicolas Cavigneaux]
+
+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

@@ -0,0 +1,61 @@
+-*-markdown-*-
+
+NiceUrl
+=======
+
+This acts_as extension provides the capabilities for creating a nice url based on an attribute of the current object. You can set / unset the object id in front of the URL and choose the object attribute to use to generate the URL.
+
+Installation
+------------
+
+In your Rails app root, use the following command-line : 
+
+	cd vendor/plugins
+	hg clone http://bitbucket.org/Bounga/acts_as_nice_url/
+	
+or install it system-wide :
+
+	$ sudo gem install flash_helper
+	
+and require it in Rails::Initializer (environment.rb) :
+
+	config.gem 'flash_helper'
+
+
+Example
+-------
+
+In your model :
+
+	class Player < ActiveRecord::Base
+	  acts_as_nice_url :id => false, :title => :full_name
+	end
+	
+then in your views :
+
+	link_to(:controller => :players, :action => :show, :id => @player)
+
+or	
+
+	player_path(@player)
+
+**Use id only in some case**
+
+
+If you want to use the **id only** in the generated URL, you have to fill the id parameter with the id only, not the full object :
+
+	link_to(:controller => :players, :action => :show, :id => @player.id)
+
+or	
+
+	player_path(@player.id)
+	
+Other
+-----
+
+For more information see [Project homepage](http://www.bitbucket.org/Bounga/acts_as_nice_url/)
+
+Problems, comments, and suggestions are welcome on the [ticket system](http://www.bitbucket.org/Bounga/acts_as_nice_url/issues/new/)
+
+
+Copyright (c) 2008 Nicolas Cavigneaux, released under the MIT license

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rubyforge'
+
+SPEC = Gem::Specification.new do |s|
+   s.name               = 'acts_as_nice_url'
+   s.version            = '1.0.0'
+   s.authors            = ['Nicolas Cavigneaux']
+   s.email              = 'nico@bounga.org'
+   s.homepage           = 'http://www.bitbucket.org/Bounga/acts_as_nice_url'
+   s.rubyforge_project  = %q{nice-url}
+   s.summary            = 'A Ruby on Rails extension to generate pretty URLs from models data '
+   s.description        = 'This Ruby on Rails acts_as extension provides the capabilities for creating a nice url based on an attribute of the current object. You can set / unset the object id in front of the URL and choose the object attribute to use to generate the URL.'
+   s.files              = [ "Rakefile", "init.rb", "install.rb", "README", "LICENSE", "uninstall.rb" ] +
+                          Dir.glob("{bin,assets,doc,lib,tasks,test}/**/*")
+   s.test_file          = "test/nice_url_test.rb"
+   s.has_rdoc           = true
+   s.extra_rdoc_files   = ['README']
+   s.require_paths      = ["lib"]
+   s.add_dependency('activerecord')
+end
+
+desc 'run unit tests'
+task :default => :test
+
+task :gem
+Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_bz2 = true
+end
+
+desc "Install gem file #{SPEC.name}-#{SPEC.version}.gem"
+task :install => [:gem] do
+  sh "gem install pkg/#{SPEC.name}-#{SPEC.version}.gem"
+end
+
+desc "Publish documentation to RubyForge"
+task :publish_doc => [:rdoc] do
+  rf = Rake::RubyForgePublisher.new(SPEC.rubyforge_project, 'bounga')
+  rf.upload
+  puts "Published documentation to RubyForge"
+end
+
+desc "Release gem #{SPEC.name}-#{SPEC.version}.gem"
+task :release => [:gem, :publish_doc] do
+  rf = RubyForge.new.configure
+  puts "Logging in"
+  rf.login
+
+  puts "Releasing #{SPEC.name} v.#{SPEC.version}"
+
+  files = Dir.glob('pkg/*.{zip,bz2,gem}')
+  rf.add_release SPEC.rubyforge_project, SPEC.rubyforge_project, SPEC.version, *files
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.title    = 'Acts_as_nice_url'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'nice_url'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/nice_url.rb

@@ -0,0 +1,71 @@
+module Bounga
+  module Acts
+    module NiceUrl
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      # This acts_as extension provides the capabilities for creating a nice url based on an attribute of the current object.
+      # You can set / unset the object id in front of the URL and choose the object attribute to use to generate the URL.
+      #
+      # This extension requires Iconv to be install on your system
+      #
+      # Author example:
+      #
+      #   class Author < ActiveRecord::Base
+      #     acts_as_nice_url :id => false, :title => :full_name
+      #   end
+      module ClassMethods
+        # Configuration options are:
+        #
+        # * +id+ - specifies if the object id has to be in front of the URL or not (default: +true+)
+        # * +title+ - specifies the object attribute to use to generate the URL. You can use a symbol 
+        # or a string (default: +title+)
+        def acts_as_nice_url(options = {})
+          include Bounga::Acts::NiceUrl::InstanceMethods
+          
+          configuration = { :id => true, :title => :title }
+          configuration.update(options) if options.is_a?(Hash)
+          
+          class_eval <<-EOV
+            def nice_title
+              #{configuration[:title]}
+            end
+
+            def nice_id
+              #{configuration[:id]}
+            end
+          EOV
+        end
+      end
+
+      # All the methods available to a record that has had <tt>acts_as_nice_url</tt> specified.
+      module InstanceMethods
+        def to_param
+          # Convert non-ascii characters
+          s = Iconv.new('us-ascii//TRANSLIT', 'utf-8').iconv(nice_title.to_s).strip.downcase
+          # Remove spaces
+          s = s.gsub(/\s+/, '-')
+          # Replace dots
+          s = s.gsub('.', '-')
+          # Remove reserved characters
+          s = s.gsub(/[^a-z0-9\-]/, '')
+          # Remove multiple dashes
+          s = s.gsub(/([\-]){2,}/, '\1')
+          # Remove ending dashes
+          s = s.gsub(/[\-]+$/, '')
+          
+          if nice_id
+            s = [self.id, s].join('-')
+          end
+          
+          return s
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Bounga::Acts::NiceUrl)
+
+

data/tasks/nice_url_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :nice_url do
+#   # Task goes here
+# end

data/test/nice_url_test.rb

@@ -0,0 +1,103 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'active_record'
+require 'iconv'
+
+require "#{File.dirname(__FILE__)}/../init"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :authors do |t|
+      t.string :name, :title
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Mixin < ActiveRecord::Base
+  def self.table_name() "authors" end
+end
+
+class AuthorDefault < Mixin
+  acts_as_nice_url
+end
+
+class AuthorWithoutId < Mixin
+  acts_as_nice_url :id => false
+end
+
+class AuthorTuned < Mixin
+  acts_as_nice_url :title => :name
+end
+
+class AuthorTunedWithoutId < Mixin
+  acts_as_nice_url :id => false, :title => :name
+end
+
+class AuthorString < Mixin
+  acts_as_nice_url :title => 'name'
+end
+
+class NiceUrlTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    Mixin.create! :name => 'Nicolas Cavigneaux', :title => 'Rails lover'
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_defaults
+    assert_equal "1-rails-lover", AuthorDefault.find(:first).to_param
+  end
+  
+  def test_without_id
+    assert_equal "rails-lover", AuthorWithoutId.find(:first).to_param
+  end
+  
+  def test_tuned
+    assert_equal "1-nicolas-cavigneaux", AuthorTuned.find(:first).to_param
+  end
+  
+  def test_tuned_without_id
+    assert_equal "nicolas-cavigneaux", AuthorTunedWithoutId.find(:first).to_param
+  end
+  
+  def test_string
+    assert_equal "1-nicolas-cavigneaux", AuthorString.find(:first).to_param
+  end
+  
+  def test_non_ascii_char
+    author = AuthorDefault.find(:first)
+    author.title = "Réalisation de tests"
+    assert_equal "1-realisation-de-tests", author.to_param
+  end
+  
+  def test_reserved_char
+    author = AuthorDefault.find(:first)
+    author.title = "Rails lover%/...#?*!"
+    assert_equal "1-rails-lover", author.to_param
+  end
+  
+  def test_multiple_dashes
+    author = AuthorDefault.find(:first)
+    author.title = "Rails ---lover"
+    assert_equal "1-rails-lover", author.to_param
+  end
+  
+  def test_end_dashes
+    author = AuthorDefault.find(:first)
+    author.title = "Rails lover---"
+    assert_equal "1-rails-lover", author.to_param
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_nice_url
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Nicolas Cavigneaux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This Ruby on Rails acts_as extension provides the capabilities for creating a nice url based on an attribute of the current object. You can set / unset the object id in front of the URL and choose the object attribute to use to generate the URL.
+email: nico@bounga.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Rakefile
+- init.rb
+- install.rb
+- README
+- LICENSE
+- uninstall.rb
+- lib/nice_url.rb
+- tasks/nice_url_tasks.rake
+- test/nice_url_test.rb
+has_rdoc: true
+homepage: http://www.bitbucket.org/Bounga/acts_as_nice_url
+post_install_message: 
+rdoc_options: []
+
+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: nice-url
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A Ruby on Rails extension to generate pretty URLs from models data
+test_files: 
+- test/nice_url_test.rb