@@ -1,20 +1,19 @@ -Copyright (c) 2008 [name of plugin creator] +Copyright (c) 2008 Norman Clarke and Adrian Mugnolo. -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: +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 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. +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. MIT-LICENSE @@ -79,7 +79,7 @@ the new URL: ==== What if the title isn't unique? -Frieldly_id will append a number to the end of the id to keep it unique if +Friendly_id will append a number to the end of the id to keep it unique if necessary: - /posts/new-version-released @@ -150,7 +150,7 @@ ids in the url. http://agilewebdevelopment.com/plugins/acts_as_friendly_param -acts_as_sluggable - Provides fully textual slugs, but no slug versioning. +acts_as_slugable - Provides fully textual slugs, but no slug versioning. http://agilewebdevelopment.com/plugins/acts_as_slugable README @@ -11,8 +11,8 @@ module Randomba # Set up an ActiveRecord model to use a friendly_id. # - # The method argument can be one of your model's columns, or a method you - # use to generate the slug. + # The method argument can be one of your model's columns, or a method + # you use to generate the slug. # # Options: # * <tt>:use_slug</tt> - Defaults to false. Use slugs when you want to use a non-unique text field for friendly ids. @@ -48,8 +48,8 @@ module Randomba end module SingletonMethods - # Extends ActiveRecord::Base::find to allow simple finds by the - # friendly id: + # Extends ActiveRecord::Base.find to allow simple finds by friendly id. + # # @record = Record.find("record name") def find(*args) find_using_friendly_id(args.first) or super(*args) @@ -57,9 +57,9 @@ module Randomba end module NonSluggableClassMethods - # Finds the record using only the friendly id. If it can't be found using - # the friendly id, then it returns false. If you pass in any argument other - # than an instance of String, then it also returns false. + # Finds the record using only the friendly id. If it can't be found + # using the friendly id, then it returns false. If you pass in any + # argument other than an instance of String, then it also returns false. def find_using_friendly_id(slug_text) return false unless slug_text.kind_of?(String) finder = "find_by_#{self.friendly_id_options[:method].to_s}".to_sym @@ -111,9 +111,9 @@ module Randomba module SluggableClassMethods - # Finds the record using only the friendly id. If it can't be found using - # the friendly id, then it returns false. If you pass in any argument other - # than an instance of String, then it also returns false. + # Finds the record using only the friendly id. If it can't be found + # using the friendly id, then it returns false. If you pass in any + # argument other than an instance of String, then it also returns false. def find_using_friendly_id(slug_text) return false unless slug_text.kind_of?(String) slug = Slug.find_by_name_and_sluggable_type(slug_text, self.to_s) @@ -159,7 +159,8 @@ module Randomba alias best_id friendly_id - # Returns the most recent slug, which is used to determine the friendly id. + # Returns the most recent slug, which is used to determine the friendly + # id. def slug slugs.first end @@ -198,8 +199,9 @@ module Randomba Iconv.new("ascii//translit//ignore", "utf-8").iconv(Unicode.normalize_KD(string)) end - # Get the string used as the basis of the friendly id. If you set the option - # to remove diacritics from the friendly id's then they will be removed. + # Get the string used as the basis of the friendly id. If you set the + # option to remove diacritics from the friendly id's then they will be + # removed. def friendly_id_base if self.friendly_id_options[:strip_diacritics] Slug::normalize(strip_diacritics(send(self.friendly_id_options[:method].to_sym))) @@ -212,7 +214,8 @@ module Randomba protected # Sets the slug that was used to find the record. This can be used to - # determine whether the record was found using the most recent friendly id. + # determine whether the record was found using the most recent friendly + # id. def finder_slug=(val) @finder_slug = val end lib/friendly_id.rb @@ -8,9 +8,8 @@ class Slug < ActiveRecord::Base # and an appended numeric suffix, i.e., "an-example-slug" and # "an-example-slug-2" # - # The first two arguments are required, after which you may pass in the same - # arguments as ActiveRecord::Base::find. - # + # The first two arguments are required, after which you may pass in the + # same arguments as ActiveRecord::Base.find. def self.count_matches(slug_text, sluggable_type, *args) slugs = with_scope({:find => {:conditions => ["name LIKE '#{slug_text}%' AND sluggable_type = ?", sluggable_type]}}) do lib/slug.rb bb86a20cbb5b5f3d8d44aa0bef86ad6dc0306ad5 adrian adrian@ea912711-22be-dc11-9221-0002b3ee6c52 http://github.com/norman/friendly_id/commit/eebc4f3020f32c264cb227ed20d3d36bd778bde5 eebc4f3020f32c264cb227ed20d3d36bd778bde5 2008-01-23T06:33:46-08:00 2008-01-23T06:33:46-08:00 Changed/fixed documentation and license files. Thanks to Emilio Tagua for pointing out several typos and missing information. git-svn-id: http://svn.randomba.org/friendly_id/trunk@16 ea912711-22be-dc11-9221-0002b3ee6c52 11ddc5e3fe81fd4a53e10dc8ada2539e7cb2d691 adrian adrian@ea912711-22be-dc11-9221-0002b3ee6c52