friendly_id_globalize3 3.2.0

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2008-2010 Norman Clarke, Adrian Mugnolo and Emilio Tagua.
+
+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,99 @@
+# FriendlyId
+
+FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
+Ruby on Rails. It allows you to create pretty URL's and work with
+human-friendly strings as if they were numeric ids for Active Record models.
+
+Using FriendlyId, it's easy to make your application use URL's like:
+
+    http://example.com/states/washington
+
+instead of:
+
+    http://example.com/states/4323454
+
+## FriendlyId Features
+
+FriendlyId offers many advanced features, including: slug history and
+versioning, scoped slugs, reserved words, custom slug generators, and
+excellent Unicode support. For complete information on using FriendlyId,
+please see the [FriendlyId Guide](http://norman.github.com/friendly_id/file.Guide.html).
+
+FriendlyId is compatible with Active Record **2.3.x** and **3.0**.
+
+## Docs, Info and Support
+
+* [FriendlyId Guide](http://norman.github.com/friendly_id/file.Guide.html)
+* [API Docs](http://norman.github.com/friendly_id)
+* [Google Group](http://groups.google.com/group/friendly_id)
+* [Source Code](http://github.com/norman/friendly_id/)
+* [Issue Tracker](http://github.com/norman/friendly_id/issues)
+
+## Rails Quickstart
+
+Note that the example below uses Rails 3. But don't worry: FriendlyId will
+continue to support 2.3.x until Rails 3.1 is released.
+
+    gem install friendly_id
+
+    rails new my_app
+
+    cd my_app
+
+    # add to Gemfile
+    gem "friendly_id", "~> 3.2"
+
+    rails generate friendly_id
+    rails generate scaffold user name:string cached_slug:string
+
+    rake db:migrate
+
+    # edit app/models/user.rb
+    class User < ActiveRecord::Base
+      has_friendly_id :name, :use_slug => true
+    end
+
+    User.create! :name => "Joe Schmoe"
+
+    rails server
+
+    GET http://0.0.0.0:3000/users/joe-schmoe
+
+## Sequel and DataMapper, too
+
+[Alex Coles](http://github.com/myabc) maintains an implemntation of
+[FriendlyId for DataMapper](http://github.com/myabc/friendly_id_datamapper) that supports almost
+all the features of the Active Record version.
+
+Norman Clarke maintains an implementation of
+[FriendlyId forSequel](http://github.com/norman/friendly_id_sequel) with some of the features
+of the Active Record version.
+
+## Bugs
+
+Please report them on the [Github issue tracker](http://github.com/norman/friendly_id/issues)
+for this project.
+
+If you have a bug to report, please include the following information:
+
+* **Version information for FriendlyId, Rails and Ruby.**
+* Stack trace and error message.
+* Any snippets of relevant model, view or controller code that shows how your
+  are using FriendlyId.
+
+If you are able to, it helps even more if you can fork FriendlyId on Github,
+and add a test that reproduces the error you are experiencing.
+
+## Credits
+
+FriendlyId was created by Norman Clarke, Adrian Mugnolo, and Emilio Tagua.
+
+If you like FriendlyId, please recommend us on Working With Rails:
+
+* [http://bit.ly/recommend-norman](http://bit.ly/recommend-norman)
+* [http://bit.ly/recommend-emilio](http://bit.ly/recommend-emilio)
+* [http://bit.ly/recommend-adrian](http://bit.ly/recommend-adrian)
+
+Thanks!
+
+Copyright (c) 2008-2010, released under the MIT license.

data/Rakefile

@@ -0,0 +1,75 @@
+require "rubygems"
+require "bundler/setup"
+require "rake"
+require "rake/testtask"
+require "rake/gempackagetask"
+require "rake/clean"
+
+task :default => :test
+
+CLEAN << "pkg" << "doc" << "coverage" << ".yardoc"
+Rake::GemPackageTask.new(eval(File.read("friendly_id.gemspec"))) { |pkg| }
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ["--output-dir=doc"]
+    t.options << "--files" << ["Guide.md", "Contributors.md", "Changelog.md"].join(",")
+  end
+rescue LoadError
+end
+
+begin
+  require "rcov/rcovtask"
+  Rcov::RcovTask.new do |r|
+    r.test_files = FileList["test/**/*_test.rb"]
+    r.verbose = true
+    r.rcov_opts << "--exclude gems/*"
+  end
+rescue LoadError
+end
+
+
+Rake::TestTask.new(:test) { |t| t.pattern = "test/**/*_test.rb" }
+
+namespace :test do
+  task :rails do
+    rm_rf "fid"
+    sh "rails --template extras/template-gem.rb fid"
+    sh "cd fid; rake test"
+  end
+  Rake::TestTask.new(:friendly_id) { |t| t.pattern = "test/*_test.rb" }
+  Rake::TestTask.new(:ar) { |t| t.pattern = "test/active_record_adapter/*_test.rb" }
+
+  desc "Test against lots of versions"
+  task :pre_release do
+    ["ree-1.8.7-2010.02", "ruby-1.9.2-p0"].each do |ruby|
+      ["sqlite3", "mysql", "postgres"].each do |driver|
+        [2, 3].each do |ar_version|
+          command = "rake-#{ruby} test AR=#{ar_version} DB=#{driver}"
+          puts command
+          puts `#{command}`
+        end
+      end
+    end
+  end
+
+  namespace :rails do
+    task :plugin do
+      rm_rf "fid"
+      sh "rails --template extras/template-plugin.rb fid"
+      sh "cd fid; rake test"
+    end
+  end
+end
+
+task :pushdocs do
+  branch = `git branch | grep "*"`.chomp.gsub("* ", "")
+  sh "git stash"
+  sh "git checkout gh-pages"
+  sh "cp -rp doc/* ."
+  sh 'git commit -a -m "Regenerated docs"'
+  sh "git push origin gh-pages"
+  sh "git checkout #{branch}"
+  sh "git stash apply"
+end

data/extras/README.txt

@@ -0,0 +1,3 @@
+These templates are here to generate FriendlyId-enabled Rails apps for
+testing. They are for developers, they are not intended for generating
+"real" applications.

data/extras/bench.rb

@@ -0,0 +1,40 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+$:.unshift File.expand_path(File.dirname(__FILE__))
+$:.uniq!
+
+require "extras"
+require 'rbench'
+FACTOR = 10
+
+RBench.run(TIMES) do
+
+  column :times
+  column :default
+  column :no_slug
+  column :slug
+  column :cached_slug
+
+  report 'find model by id', (TIMES * FACTOR).ceil do
+    default { User.find(get_id) }
+    no_slug { User.find(USERS.rand) }
+    slug { Post.find(POSTS.rand) }
+    cached_slug { District.find(DISTRICTS.rand) }
+  end
+
+  report 'find model using array of ids', (TIMES * FACTOR).ceil do
+    default { User.find(get_id(2)) }
+    no_slug { User.find(USERS.rand(2)) }
+    slug { Post.find(POSTS.rand(2)) }
+    cached_slug { District.find(DISTRICTS.rand(2)) }
+  end
+
+  report 'find model using id, then to_param', (TIMES * FACTOR).ceil do
+    default { User.find(get_id).to_param }
+    no_slug { User.find(USERS.rand).to_param }
+    slug { Post.find(POSTS.rand).to_param }
+    cached_slug { District.find(DISTRICTS.rand).to_param }
+  end
+
+  summary 'Total'
+
+end

data/extras/extras.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby -KU
+require File.dirname(__FILE__) + '/../test/test_helper'
+require File.dirname(__FILE__) + '/../test/active_record_adapter/ar_test_helper'
+require 'ffaker'
+
+TIMES = (ENV['N'] || 100).to_i
+POSTS     = []
+DISTRICTS = []
+USERS     = []
+
+User.delete_all
+Post.delete_all
+District.delete_all
+Slug.delete_all
+
+100.times do
+  name = Faker::Name.name
+  USERS     << (User.create!     :name => name).friendly_id
+  POSTS     << (Post.create!     :name => name).friendly_id
+  DISTRICTS << (District.create! :name => name).friendly_id
+end
+
+def get_id(returns = 1)
+  (1..100).to_a.rand(returns)
+end
+
+class Array
+  def rand(returns = 1)
+    @return = []
+    returns.times do
+      until @return.length == returns do
+        val = self[Kernel.rand(length)]
+        @return << val unless @return.include? val
+      end
+    end
+    return returns == 1 ? @return.first : @return
+  end
+end

data/extras/prof.rb

@@ -0,0 +1,19 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+$:.unshift File.expand_path(File.dirname(__FILE__))
+$:.uniq!
+
+require "extras"
+require 'ruby-prof'
+
+# RubyProf.measure_mode = RubyProf::MEMORY
+GC.disable
+RubyProf.start
+100.times do
+  Post.find(slug = POSTS.rand)
+end
+result = RubyProf.stop
+GC.enable
+# printer = RubyProf::CallTreePrinter.new(result)
+printer = RubyProf::GraphPrinter.new(result)
+version = ActiveRecord::VERSION::STRING.gsub(".", "")
+printer.print(File.new("prof#{version}.txt", "w"))

data/extras/template-gem.rb

@@ -0,0 +1,26 @@
+run "rm public/index.html"
+gem "friendly_id"
+gem "haml"
+gem "will_paginate"
+run "haml --rails ."
+generate "friendly_id"
+generate :haml_scaffold, "post title:string"
+route "map.root :controller => 'posts', :action => 'index'"
+rake "db:migrate"
+rake "db:fixtures:load"
+file 'app/models/post.rb',
+%q{class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+end}
+file 'test/fixtures/slugs.yml',
+%q{
+one:
+  name: mystring
+  sequence: 1
+  sluggable: one (Post)
+
+two:
+  name: mystring
+  sequence: 1
+  sluggable: two (Post)
+}

data/extras/template-plugin.rb

@@ -0,0 +1,28 @@
+run "rm public/index.html"
+inside 'vendor/plugins' do
+  run "git clone ../../../ friendly_id"
+end
+gem "haml"
+gem "will_paginate"
+run "haml --rails ."
+generate "friendly_id"
+generate :haml_scaffold, "post title:string"
+route "map.root :controller => 'posts', :action => 'index'"
+rake "db:migrate"
+rake "db:fixtures:load"
+file 'app/models/post.rb',
+%q{class Post < ActiveRecord::Base
+  has_friendly_id :title, :use_slug => true
+end}
+file 'test/fixtures/slugs.yml',
+%q{
+one:
+  name: mystring
+  sequence: 1
+  sluggable: one (Post)
+
+two:
+  name: mystring
+  sequence: 2
+  sluggable: two (Post)
+}

data/generators/friendly_id/friendly_id_generator.rb

@@ -0,0 +1,30 @@
+class FriendlyIdGenerator < Rails::Generator::Base
+
+  RAKE_TASKS = File.join("..", "..", "..", "lib", "tasks", "friendly_id.rake")
+
+  def manifest
+    record do |m|
+      unless options[:skip_migration]
+        m.migration_template('create_slugs.rb', 'db/migrate', :migration_file_name => 'create_slugs')
+      end
+      unless options[:skip_tasks]
+        m.directory "lib/tasks"
+        m.file RAKE_TASKS, "lib/tasks/friendly_id.rake"
+      end
+    end
+  end
+
+  protected
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-migration", "Don't generate a migration for the slugs table") do |value|
+      options[:skip_migration] = value
+    end
+    opt.on("--skip-tasks", "Don't add friendly_id Rake tasks to lib/tasks") do |value|
+      options[:skip_tasks] = value
+    end
+  end
+
+end

data/generators/friendly_id/templates/create_slugs.rb

@@ -0,0 +1,18 @@
+class CreateSlugs < ActiveRecord::Migration
+  def self.up
+    create_table :slugs do |t|
+      t.string :name
+      t.integer :sluggable_id
+      t.integer :sequence, :null => false, :default => 1
+      t.string :sluggable_type, :limit => 40
+      t.string :scope
+      t.datetime :created_at
+    end
+    add_index :slugs, :sluggable_id
+    add_index :slugs, [:name, :sluggable_type, :sequence, :scope], :name => "index_slugs_on_n_s_s_and_s", :unique => true
+  end
+
+  def self.down
+    drop_table :slugs
+  end
+end

data/lib/friendly_id.rb

@@ -0,0 +1,93 @@
+require "babosa"
+require "forwardable"
+require "friendly_id/slug_string"
+require "friendly_id/configuration"
+require "friendly_id/status"
+require "friendly_id/slugged"
+
+# FriendlyId is a comprehensive Ruby library for slugging and permalinks with
+# ActiveRecord.
+# @author Norman Clarke
+# @author Emilio Tagua
+# @author Adrian Mugnolo
+module FriendlyId
+
+  # An error based on this class is raised when slug generation fails
+  class SlugGenerationError < StandardError ; end
+
+  # Raised when the slug text is blank.
+  class BlankError < SlugGenerationError ; end
+
+  # Raised when the slug text is reserved.
+  class ReservedError < SlugGenerationError ; end
+
+  module Base
+    # Set up a model to use a friendly_id. This method accepts a hash with
+    # {FriendlyId::Configuration several possible options}.
+    #
+    # @param [#to_sym] method The column or method that should be used as the
+    #   basis of the friendly_id string.
+    #
+    # @param [Hash] options For valid configuration options, see
+    #   {FriendlyId::Configuration}.
+    #
+    # @example
+    #
+    #   class User < ActiveRecord::Base
+    #     has_friendly_id :user_name
+    #   end
+    #
+    #   class Post < ActiveRecord::Base
+    #     has_friendly_id :title, :use_slug => true, :approximate_ascii => true
+    #   end
+    #
+    # @see FriendlyId::Configuration
+    def has_friendly_id(method, options = {})
+      raise NotImplementedError
+    end
+
+    # Does the model class use the FriendlyId plugin?
+    def uses_friendly_id?
+      respond_to? :friendly_id_config
+    end
+  end
+
+end
+
+class String
+  def parse_friendly_id(separator = nil)
+    separator ||= FriendlyId::Configuration::DEFAULTS[:sequence_separator]
+    name, sequence = split(/#{Regexp.escape(separator)}(\d+)?\z/)
+    return name, (sequence ||= 1).to_i
+  end
+end
+
+class Object
+
+  # Is the object a friendly id? Note that the return value here is
+  # +false+ if the +id+ is definitely not friendly, and +nil+ if it can
+  # not be determined.
+  # The return value will be:
+  # * +true+ - if the id is definitely friendly (i.e., a string with non-numeric characters)
+  # * +false+ - if the id is definitely unfriendly (i.e., an Integer, a model instance, etc.)
+  # * +nil+ - if it can not be determined (i.e., a numeric string like "206".)
+  # @return [true, false, nil]
+  # @see #unfriendly?
+  def friendly_id?
+    if kind_of?(Integer) or kind_of?(Symbol) or self.class.respond_to? :friendly_id_config
+      false
+    elsif to_i.to_s != to_s
+      true
+    end
+  end
+
+  # Is the object a numeric id?
+  # @return [true, false, nil] +true+ if definitely unfriendly, +false+ if
+  #   definitely friendly, else +nil+.
+  # @see #friendly?
+  def unfriendly_id?
+    val = friendly_id? ; !val unless val.nil?
+  end
+end
+
+require "friendly_id/railtie" if defined?(Rails) && Rails.version >= "3"