mil_friendly_id 4.0.9.8

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,150 @@
+# FriendlyId
+
+[![Build Status](http://travis-ci.org/norman/friendly_id.png)](http://travis-ci.org/norman/friendly_id)
+
+FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
+Ruby on Rails. It allows you to create pretty URLs 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 URLs 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, i18n, Globalize support, scoped slugs, reserved words, and custom
+slug generators.
+
+FriendlyId is compatible with Active Record **3.0** and higher.
+
+## Version 4.x
+
+FriendlyId 4.x introduces many changes incompatible with 3.x. If you're
+upgrading, please [read the
+docs](http://rubydoc.info/github/norman/friendly_id/master/file/WhatsNew.md) to see what's
+new.
+
+## Docs
+
+The current docs can always be found
+[here](http://rubydoc.info/github/norman/friendly_id/master/frames).
+
+The best place to start is with the
+[Guide](http://rubydoc.info/github/norman/friendly_id/master/file/Guide.rdoc),
+which compiles the top-level RDocs into one outlined document.
+
+You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid).
+
+## Rails Quickstart
+
+    gem install friendly_id
+
+    rails new my_app
+
+    cd my_app
+
+    gem "friendly_id", "~> 4.0.1"
+
+    rails generate scaffold user name:string slug:string
+
+    # edit db/migrate/*_create_users.rb
+    add_index :users, :slug, unique: true
+
+    rake db:migrate
+
+    # edit app/models/user.rb
+    class User < ActiveRecord::Base
+      extend FriendlyId
+      friendly_id :name, use: :slugged
+    end
+
+    User.create! name: "Joe Schmoe"
+
+    rails server
+
+    GET http://localhost:3000/users/joe-schmoe
+
+    # If you're adding FriendlyId to an existing app and need
+    # to generate slugs for existing users, do this from the
+    # console, runner, or add a Rake task:
+    User.find_each(&:save)
+
+
+## Benchmarks
+
+The latest benchmarks for FriendlyId are maintained
+[here](http://bit.ly/friendly-id-benchmarks).
+
+
+## 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.**
+* Full stack trace and error message (if you have them).
+* Any snippets of relevant model, view or controller code that shows how you
+  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.
+
+For more info on how to report bugs, please see [this
+article](http://yourbugreportneedsmore.info/).
+
+## Thanks and Credits
+
+FriendlyId was originally created by Norman Clarke and Adrian Mugnolo, with
+significant help early in its life by Emilio Tagua. I'm deeply gratful for the
+generous contributions over the years from [many
+volunteers](https://github.com/norman/friendly_id/contributors).
+
+Part of the inspiration to rework FriendlyId came from Darcy Laycock's library
+[Slugged](https://github.com/Sutto/slugged), which he was inspired to create
+because of frustrations he experienced while using FriendlyId 3.x. Seeing a
+smart programmer become frustrated with my code was enough of a kick in the
+butt to make me want to significantly improve this library.
+
+Many thanks to him for providing valid, real criticism while still being a cool
+about it. I definitely recommend you check out his library if for some reason
+FriendlyId doesn't do it for you.
+
+Thanks also to Loren Segal and Nick Plante for YARD and the
+[rubydoc.info](http://rubydoc.info/) website which FriendlyId uses for
+documentation.
+
+Lastly, FriendlyId uses [Travis](http://travis-ci.org/) for continuous
+integration. It's an excellent, free service created by a whole bunch of [good
+people](https://github.com/travis-ci) - if you're not already using it, you
+should be!
+
+## License
+
+Copyright (c) 2008-2012 Norman Clarke and contributors, released under the 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/Rakefile

@@ -0,0 +1,108 @@
+require "rubygems"
+require "rake/testtask"
+
+task :default => :test
+
+task :load_path do
+  %w(lib test).each do |path|
+    $LOAD_PATH.unshift(File.expand_path("../#{path}", __FILE__))
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :clean do
+  %x{rm -rf *.gem doc pkg coverage}
+  %x{rm -f `find . -name '*.rbc'`}
+end
+
+task :gem do
+  %x{gem build mil_friendly_id.gemspec}
+end
+
+task :yard => :guide do
+  puts %x{bundle exec yard}
+end
+
+task :bench => :load_path do
+  require File.expand_path("../bench", __FILE__)
+end
+
+task :guide do
+  def read_comments(path)
+    path  = File.expand_path("../#{path}", __FILE__)
+    match = File.read(path).match(/\n=begin(.*)\n=end/m)[1].to_s
+    match.split("\n").reject {|x| x =~ /^@/}.join("\n")
+  end
+
+  buffer = []
+
+  buffer << read_comments("lib/friendly_id.rb")
+  buffer << read_comments("lib/friendly_id/base.rb")
+  buffer << read_comments("lib/friendly_id/slugged.rb")
+  buffer << read_comments("lib/friendly_id/history.rb")
+  buffer << read_comments("lib/friendly_id/scoped.rb")
+  buffer << read_comments("lib/friendly_id/simple_i18n.rb")
+  buffer << read_comments("lib/friendly_id/globalize.rb")
+  buffer << read_comments("lib/friendly_id/reserved.rb")
+
+  File.open("Guide.rdoc", "w") do |file|
+    file.write("#encoding: utf-8\n")
+    file.write(buffer.join("\n"))
+  end
+end
+
+namespace :test do
+
+  desc "Run each test class in a separate process"
+  task :isolated do
+    dir = File.expand_path("../test", __FILE__)
+    Dir["#{dir}/*_test.rb"].each do |test|
+      puts "Running #{test}:"
+      puts %x{ruby -Ilib -Itest #{test}}
+    end
+  end
+end
+
+namespace :db do
+
+  desc "Create the database"
+  task :create => :load_path do
+    require "helper"
+    driver = FriendlyId::Test::Database.driver
+    config = FriendlyId::Test::Database.config[driver]
+    commands = {
+      "mysql"    => "mysql -u #{config['username']} -e 'create database #{config["database"]};' >/dev/null",
+      "postgres" => "psql -c 'create database #{config['database']};' -U #{config['username']} >/dev/null"
+    }
+    %x{#{commands[driver] || true}}
+  end
+
+  desc "Create the database"
+  task :drop => :load_path do
+    require "helper"
+    driver = FriendlyId::Test::Database.driver
+    config = FriendlyId::Test::Database.config[driver]
+    commands = {
+      "mysql"    => "mysql -u #{config['username']} -e 'drop database #{config["database"]};' >/dev/null",
+      "postgres" => "psql -c 'drop database #{config['database']};' -U #{config['username']} >/dev/null"
+    }
+    %x{#{commands[driver] || true}}
+  end
+
+  desc "Set up the database schema"
+  task :up => :load_path do
+    require "helper"
+    FriendlyId::Test::Schema.up
+  end
+
+  desc "Drop and recreate the database schema"
+  task :reset => [:drop, :create]
+
+end
+
+task :doc => :yard

data/WhatsNew.md

@@ -0,0 +1,95 @@
+# What's New in FriendlyId 4?
+
+## Back to basics
+
+FriendlyId is mostly a different codebase from FriendlyId 3. However, this isn't
+the "big rewrite," it's the "small rewrite:"
+
+Adding new features with each release is not sustainable. This release *removes*
+features, but makes it possible to add them back as addons. We can also remove
+some complexity by relying on the better default functionality provided by newer
+versions of Active Support and Active Record.
+
+Here's what's changed:
+
+## New configuration and setup
+
+FriendlyId is no longer added to Active Record by default, you must explicitly
+add it to each model you want to use it in. The method and options have also
+changed:
+
+    # FriendlyId 3
+    class Post < ActiveRecord::Base
+      has_friendly_id :title, :use_slugs => true
+    end
+
+    # FriendlyId 4
+    class Post < ActiveRecord::Base
+      extend FriendlyId
+      friendly_id :title, :use => :slugged
+    end
+
+It also adds a new "defaults" method for configuring all models:
+
+    FriendlyId.defaults do |config|
+      config.use :slugged, :reserved
+      config.base = :name
+    end
+
+## Active Record 3+ only
+
+For 2.3 support, you can use FriendlyId 3.x, which will continue to be
+maintained until people don't want it any more.
+
+## In-table slugs
+
+FriendlyId no longer creates a separate slugs table - it just stores the
+generated slug value in the model table, which is simpler, faster and what most
+want by default. Keeping slug history in a separate table is an
+{FriendlyId::History optional add-on} for FriendlyId 4.
+
+## No more multiple finds
+
+    Person.find "joe-schmoe"               # Supported
+    Person.find ["joe-schmoe", "john-doe"] # No longer supported
+
+If you want find by more than one friendly id, build your own query:
+
+    Person.where(:slug => ["joe-schmoe", "john-doe"])
+
+This lets us do *far* less monkeypatching in Active Record. How much less?
+FriendlyId overrides the base find with a mere 2 lines of code, and otherwise
+changes nothing else. This means more stability and less breakage between Rails
+updates.
+
+## No more finder status
+
+FriendlyId 3 offered finder statuses to help you determine when an outdated
+or non-friendly id was used to find the record, so that you could decide whether
+to permanently redirect to the canonical URL. However, there's a simpler way to
+do that, so this feature has been removed:
+
+    if request.path != person_path(@person)
+      return redirect_to @person, :status => :moved_permanently
+    end
+
+## Bye-bye Babosa
+
+[Babosa](http://github.com/norman/babosa) is FriendlyId 3's slugging library.
+
+FriendlyId 4 doesn't use it by default because the most important pieces of it
+were already accepted into Active Support 3.
+
+However, Babosa is still useful, for example, for idiomatically transliterating
+Cyrillic ([or other
+language](https://github.com/norman/babosa/tree/master/lib/babosa/transliterator))
+strings to ASCII. It's very easy to include - just override
+`#normalize_friendly_id` in your model:
+
+    class MyModel < ActiveRecord::Base
+      ...
+
+      def normalize_friendly_id(text)
+        text.to_slug.normalize! :transliterations => :russian
+      end
+    end

data/bench.rb

@@ -0,0 +1,63 @@
+require File.expand_path("../test/helper", __FILE__)
+require "ffaker"
+
+N = 1000
+
+def transaction
+  ActiveRecord::Base.transaction { yield ; raise ActiveRecord::Rollback }
+end
+
+class Array
+  def rand
+    self[Kernel.rand(length)]
+  end
+end
+
+Book = Class.new ActiveRecord::Base
+
+class Journalist < ActiveRecord::Base
+  extend FriendlyId
+  friendly_id :name, :use => :slugged
+end
+
+class Manual < ActiveRecord::Base
+  extend FriendlyId
+  friendly_id :name, :use => :history
+end
+
+BOOKS       = []
+JOURNALISTS = []
+MANUALS     = []
+
+100.times do
+  name = Faker::Name.name
+  BOOKS       << (Book.create! :name => name).id
+  JOURNALISTS << (Journalist.create! :name => name).friendly_id
+  MANUALS     << (Manual.create! :name => name).friendly_id
+end
+
+ActiveRecord::Base.connection.execute "UPDATE manuals SET slug = NULL"
+
+Benchmark.bmbm do |x|
+  x.report 'find (without FriendlyId)' do
+    N.times {Book.find BOOKS.rand}
+  end
+  x.report 'find (in-table slug)' do
+    N.times {Journalist.find JOURNALISTS.rand}
+  end
+  x.report 'find (external slug)' do
+    N.times {Manual.find MANUALS.rand}
+  end
+
+  x.report 'insert (without FriendlyId)' do
+    N.times {transaction {Book.create :name => Faker::Name.name}}
+  end
+
+  x.report 'insert (in-table-slug)' do
+    N.times {transaction {Journalist.create :name => Faker::Name.name}}
+  end
+
+  x.report 'insert (external slug)' do
+    N.times {transaction {Manual.create :name => Faker::Name.name}}
+  end
+end

data/friendly_id.gemspec

@@ -0,0 +1,43 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require "friendly_id"
+
+Gem::Specification.new do |s|
+  s.name              = "friendly_id"
+  s.version           = FriendlyId::VERSION
+  s.authors           = ["Norman Clarke", "Philip Arndt"]
+  s.email             = ["norman@njclarke.com", "parndt@gmail.com"]
+  s.homepage          = "http://github.com/norman/friendly_id"
+  s.summary           = "A comprehensive slugging and pretty-URL plugin."
+  s.rubyforge_project = "friendly_id"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths     = ["lib"]
+
+  s.add_development_dependency "railties", "~> 3.2.0"
+  s.add_development_dependency "activerecord", "~> 3.2.0"
+  s.add_development_dependency "minitest", "3.2.0"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "maruku"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "i18n"
+  s.add_development_dependency "ffaker"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "globalize3"
+
+  s.description = <<-EOM
+FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
+Ruby on Rails. It allows you to create pretty URLs and work with human-friendly
+strings as if they were numeric ids for Active Record models.
+EOM
+
+  s.post_install_message = <<-EOM
+NOTE: FriendlyId 4.x breaks compatibility with 3.x. If you're upgrading
+from 3.x, please see this document:
+
+http://rubydoc.info/github/norman/friendly_id/master/file/WhatsNew.md
+
+EOM
+
+end