friendly_id4 4.0.0.beta3 → 4.0.0.beta4

data/lib/friendly_id.rb

@@ -14,21 +14,27 @@ module FriendlyId
   autoload :History,  "friendly_id/history"
 
   # FriendlyId takes advantage of `extended` to do basic model setup, primarily
-  # extending FriendlyId::Base to add #friendly_id as a class method for
-  # configuring how a model is going to use FriendlyId. In previous versions of
-  # this library, ActiveRecord::Base was patched by default to include methods
-  # needed to configure friendly_id, but this version tries to be a little less
-  # invasive.
+  # extending {FriendlyId::Base} to add {FriendlyId::Base#friendly_id
+  # friendly_id} as a class method.
   #
-  # In addition to adding the #friendly_id method, the class instance variable
-  # +@friendly_id_config+ is added. This variable is an instance of an anonymous
-  # subclass of FriendlyId::Configuration. This is done to allow for
-  # subsequently loaded modules like FriendlyId::Slugged to add functionality to
-  # the configuration only for the current class, and thereby isolating other
-  # classes from large feature changes a module could potentially introduce. The
-  # upshot of this is, you can have two Active Record models that both have a
+  # Previous versions of FriendlyId simply patched ActiveRecord::Base, but this
+  # version tries to be less invasive.
+  #
+  # In addition to adding {FriendlyId::Base.friendly_id friendly_id}, the class
+  # instance variable +@friendly_id_config+ is added. This variable is an
+  # instance of an anonymous subclass of {FriendlyId::Configuration}. This
+  # allows subsequently loaded modules like {FriendlyId::Slugged} and
+  # {FriendlyId::Scoped} to add functionality to the configuration class only
+  # for the current class, rather than monkey patching
+  # {FriendlyId::Configuration} directly. This isolates other models from large
+  # feature changes an addon to FriendlyId could potentially introduce.
+  #
+  # The upshot of this is, you can htwo Active Record models that both have a
   # @friendly_id_config, but each config object can have different methods and
   # behaviors depending on what modules have been loaded, without conflicts.
+  # Keep this in mind if you're hacking on FriendlyId.
+  #
+  # For examples of this, see the source for {Scoped.included}.
   def self.extended(base)
     base.instance_eval do
       extend FriendlyId::Base

data/lib/friendly_id/base.rb

@@ -2,15 +2,24 @@ module FriendlyId
   # Class methods that will be added to ActiveRecord::Base.
   module Base
 
-    def friendly_id(*args, &block)
-      if block_given?
-        yield(friendly_id_config)
-      else
-        base    = args.shift
-        options = args.extract_options!
-        @friendly_id_config.use options.delete :use
-        @friendly_id_config.send :set, options.merge(:base => base)
-      end
+    # Configure FriendlyId for a model. Use this method to configure FriendlyId
+    # for your model.
+    #
+    #   class Post < ActiveRecord::Base
+    #     extend FriendlyId
+    #     friendly_id :title, :use => :slugged
+    #   end
+    #
+    # @option options [Symbol] :use The name of an addon to use. By default, FriendlyId
+    #   provides {FriendlyId::Slugged :slugged}, {FriendlyId::History :history}
+    #   and {FriendlyId::Scoped :scoped}.
+    # @option options [Symbol] :slug_column Available when using +:slugged+.
+    #   Configures the name of the column where FriendlyId will store the slug.
+    #   Defaults to +:slug+.
+    def friendly_id(base = nil, options = {}, &block)
+      @friendly_id_config.use options.delete :use
+      @friendly_id_config.send :set, options.merge(:base => base)
+      yield @friendly_id_config if block_given?
       before_save do |record|
         record.instance_eval {@current_friendly_id = friendly_id}
       end

data/lib/friendly_id/version.rb

@@ -3,7 +3,7 @@ module FriendlyId
     MAJOR = 4
     MINOR = 0
     TINY  = 0
-    BUILD = 'beta3'
+    BUILD = 'beta4'
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end
 end

data/test/base_test.rb

@@ -17,7 +17,7 @@ class CoreTest < MiniTest::Unit::TestCase
   test "friendly_id should accept a block" do
     klass = Class.new(ActiveRecord::Base) do
       extend FriendlyId
-      friendly_id do |config|
+      friendly_id :foo do |config|
         config.use :slugged
         config.base = :foo
         config.slug_column = :bar

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: friendly_id4
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta3
+  version: 4.0.0.beta4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-26 00:00:00.000000000 -03:00
+date: 2011-07-29 00:00:00.000000000 -03:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70311865559640 !ruby/object:Gem::Requirement
+  requirement: &70126503605200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70311865559640
+  version_requirements: *70126503605200
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70311865558600 !ruby/object:Gem::Requirement
+  requirement: &70126503604500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70311865558600
+  version_requirements: *70126503604500
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &70311865558040 !ruby/object:Gem::Requirement
+  requirement: &70126503603900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.1.2
   type: :development
   prerelease: false
-  version_requirements: *70311865558040
+  version_requirements: *70126503603900
 - !ruby/object:Gem::Dependency
   name: ffaker
-  requirement: &70311865557340 !ruby/object:Gem::Requirement
+  requirement: &70126503603440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311865557340
+  version_requirements: *70126503603440
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70311865556780 !ruby/object:Gem::Requirement
+  requirement: &70126503602760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311865556780
+  version_requirements: *70126503602760
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70311865556100 !ruby/object:Gem::Requirement
+  requirement: &70126503602100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311865556100
+  version_requirements: *70126503602100
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70311865555640 !ruby/object:Gem::Requirement
+  requirement: &70126503601460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311865555640
+  version_requirements: *70126503601460
 description: ! "    FriendlyId is the \"Swiss Army bulldozer\" of slugging and permalink
   plugins\n    for Ruby on Rails. It allows you to create pretty URL's and work with\n
   \   human-friendly strings as if they were numeric ids for ActiveRecord models.\n"