activemodel 3.0.20 → 3.1.0.beta1

data/lib/active_model/observer_array.rb

@@ -0,0 +1,104 @@
+require 'set'
+
+module ActiveModel
+  # Stores the enabled/disabled state of individual observers for
+  # a particular model classes.
+  class ObserverArray < Array
+    attr_reader :model_class
+    def initialize(model_class, *args)
+      @model_class = model_class
+      super(*args)
+    end
+
+    def disabled_for?(observer)
+      disabled_observers.include?(observer.class)
+    end
+
+    def disable(*observers, &block)
+      set_enablement(false, observers, &block)
+    end
+
+    def enable(*observers, &block)
+      set_enablement(true, observers, &block)
+    end
+
+    protected
+
+      def disabled_observers
+        @disabled_observers ||= Set.new
+      end
+
+      def observer_class_for(observer)
+        return observer if observer.is_a?(Class)
+
+        if observer.respond_to?(:to_sym) # string/symbol
+          observer.to_s.camelize.constantize
+        else
+          raise ArgumentError, "#{observer} was not a class or a " +
+            "lowercase, underscored class name as expected."
+        end
+      end
+
+      def start_transaction
+        disabled_observer_stack.push(disabled_observers.dup)
+        each_subclass_array do |array|
+          array.start_transaction
+        end
+      end
+
+      def disabled_observer_stack
+        @disabled_observer_stack ||= []
+      end
+
+      def end_transaction
+        @disabled_observers = disabled_observer_stack.pop
+        each_subclass_array do |array|
+          array.end_transaction
+        end
+      end
+
+      def transaction
+        start_transaction
+
+        begin
+          yield
+        ensure
+          end_transaction
+        end
+      end
+
+      def each_subclass_array
+        model_class.descendants.each do |subclass|
+          yield subclass.observers
+        end
+      end
+
+      def set_enablement(enabled, observers)
+        if block_given?
+          transaction do
+            set_enablement(enabled, observers)
+            yield
+          end
+        else
+          observers = ActiveModel::Observer.descendants if observers == [:all]
+          observers.each do |obs|
+            klass = observer_class_for(obs)
+
+            unless klass < ActiveModel::Observer
+              raise ArgumentError.new("#{obs} does not refer to a valid observer")
+            end
+
+            if enabled
+              disabled_observers.delete(klass)
+            else
+              disabled_observers << klass
+            end
+          end
+
+          each_subclass_array do |array|
+            array.set_enablement(enabled, observers)
+          end
+        end
+      end
+  end
+end

data/lib/active_model/observing.rb

@@ -1,73 +1,95 @@
 require 'singleton'
+require 'active_model/observer_array'
 require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/module/aliasing'
 require 'active_support/core_ext/module/remove_method'
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/enumerable'
+require 'active_support/descendants_tracker'
 
 module ActiveModel
   module Observing
     extend ActiveSupport::Concern
 
+    included do
+      extend ActiveSupport::DescendantsTracker
+    end
+
     module ClassMethods
       # == Active Model Observers Activation
       #
       # Activates the observers assigned. Examples:
       #
+      #   class ORM
+      #     include ActiveModel::Observing
+      #   end
+      #
       #   # Calls PersonObserver.instance
-      #   ActiveRecord::Base.observers = :person_observer
+      #   ORM.observers = :person_observer
       #
       #   # Calls Cacher.instance and GarbageCollector.instance
-      #   ActiveRecord::Base.observers = :cacher, :garbage_collector
+      #   ORM.observers = :cacher, :garbage_collector
       #
       #   # Same as above, just using explicit class references
-      #   ActiveRecord::Base.observers = Cacher, GarbageCollector
+      #   ORM.observers = Cacher, GarbageCollector
       #
       # Note: Setting this does not instantiate the observers yet.
       # +instantiate_observers+ is called during startup, and before
       # each development request.
       def observers=(*values)
-        @observers = values.flatten
+        observers.replace(values.flatten)
       end
 
       # Gets the current observers.
       def observers
-        @observers ||= []
+        @observers ||= ObserverArray.new(self)
+      end
+
+      # Gets the current observer instances.
+      def observer_instances
+        @observer_instances ||= []
       end
 
-      # Instantiate the global Active Record observers.
+      # Instantiate the global observers.
       def instantiate_observers
         observers.each { |o| instantiate_observer(o) }
       end
 
+      # Add a new observer to the pool.
+      # The new observer needs to respond to 'update', otherwise it
+      # raises an +ArgumentError+ exception.
       def add_observer(observer)
         unless observer.respond_to? :update
           raise ArgumentError, "observer needs to respond to `update'"
         end
-        @observer_instances ||= []
-        @observer_instances << observer
+        observer_instances << observer
       end
 
+      # Notify list of observers of a change.
       def notify_observers(*arg)
-        if defined? @observer_instances
-          for observer in @observer_instances
-            observer.update(*arg)
-          end
+        for observer in observer_instances
+          observer.update(*arg)
         end
       end
 
+      # Total number of observers.
       def count_observers
-        @observer_instances.size
+        observer_instances.size
       end
 
       protected
         def instantiate_observer(observer) #:nodoc:
           # string/symbol
           if observer.respond_to?(:to_sym)
-            observer = observer.to_s.camelize.constantize.instance
+            observer.to_s.camelize.constantize.instance
           elsif observer.respond_to?(:instance)
             observer.instance
           else
-            raise ArgumentError, "#{observer} must be a lowercase, underscored class name (or an instance of the class itself) responding to the instance method. Example: Person.observers = :big_brother # calls BigBrother.instance"
+            raise ArgumentError,
+              "#{observer} must be a lowercase, underscored class name (or an " +
+              "instance of the class itself) responding to the instance " +
+              "method. Example: Person.observers = :big_brother # calls " +
+              "BigBrother.instance"
           end
         end
 
@@ -124,8 +146,8 @@ module ActiveModel
   # Observers will by default be mapped to the class with which they share a
   # name. So CommentObserver will be tied to observing Comment, ProductManagerObserver
   # to ProductManager, and so on. If you want to name your observer differently than
-  # the class you're interested in observing, you can use the Observer.observe class
-  # method which takes either the concrete class (Product) or a symbol for that
+  # the class you're interested in observing, you can use the <tt>Observer.observe</tt>
+  # class method which takes either the concrete class (Product) or a symbol for that
   # class (:product):
   #
   #   class AuditObserver < ActiveModel::Observer
@@ -150,8 +172,13 @@ module ActiveModel
   # The AuditObserver will now act on both updates to Account and Balance by treating
   # them both as records.
   #
+  # If you're using an Observer in a Rails application with Active Record, be sure to
+  # read about the necessary configuration in the documentation for
+  # ActiveRecord::Observer.
+  #
   class Observer
     include Singleton
+    extend ActiveSupport::DescendantsTracker
 
     class << self
       # Attaches the observer to the supplied model classes.
@@ -197,7 +224,9 @@ module ActiveModel
 
     # Send observed_method(object) if the method exists.
     def update(observed_method, object) #:nodoc:
-      send(observed_method, object) if respond_to?(observed_method)
+      return unless respond_to?(observed_method)
+      return if disabled_for?(object)
+      send(observed_method, object)
     end
 
     # Special method sent by the observed class when it is inherited.
@@ -211,5 +240,11 @@ module ActiveModel
       def add_observer!(klass) #:nodoc:
         klass.add_observer(self)
       end
+
+      def disabled_for?(object)
+        klass = object.class
+        return false unless klass.respond_to?(:observers)
+        klass.observers.disabled_for?(self)
+      end
   end
 end

data/lib/active_model/secure_password.rb

@@ -0,0 +1,67 @@
+require 'bcrypt'
+
+module ActiveModel
+  module SecurePassword
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Adds methods to set and authenticate against a BCrypt password.
+      # This mechanism requires you to have a password_digest attribute.
+      #
+      # Validations for presence of password, confirmation of password (using
+      # a "password_confirmation" attribute) are automatically added.
+      # You can add more validations by hand if need be.
+      #
+      # Example using Active Record (which automatically includes ActiveModel::SecurePassword):
+      #
+      #   # Schema: User(name:string, password_digest:string)
+      #   class User < ActiveRecord::Base
+      #     has_secure_password
+      #   end
+      #
+      #   user = User.new(:name => "david", :password => "", :password_confirmation => "nomatch")
+      #   user.save                                                      # => false, password required
+      #   user.password = "mUc3m00RsqyRe"
+      #   user.save                                                      # => false, confirmation doesn't match
+      #   user.password_confirmation = "mUc3m00RsqyRe"
+      #   user.save                                                      # => true
+      #   user.authenticate("notright")                                  # => false
+      #   user.authenticate("mUc3m00RsqyRe")                             # => user
+      #   User.find_by_name("david").try(:authenticate, "notright")      # => nil
+      #   User.find_by_name("david").try(:authenticate, "mUc3m00RsqyRe") # => user
+      def has_secure_password
+        attr_reader   :password
+
+        validates_confirmation_of :password
+        validates_presence_of     :password_digest
+
+        include InstanceMethodsOnActivation
+
+        if respond_to?(:attributes_protected_by_default)
+          def self.attributes_protected_by_default
+            super + ['password_digest']
+          end
+        end
+      end
+    end
+
+    module InstanceMethodsOnActivation
+      # Returns self if the password is correct, otherwise false.
+      def authenticate(unencrypted_password)
+        if BCrypt::Password.new(password_digest) == unencrypted_password
+          self
+        else
+          false
+        end
+      end
+
+      # Encrypts the password into the password_digest attribute.
+      def password=(unencrypted_password)
+        @password = unencrypted_password
+        unless unencrypted_password.blank?
+          self.password_digest = BCrypt::Password.create(unencrypted_password)
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serialization.rb

@@ -15,7 +15,7 @@ module ActiveModel
   #     attr_accessor :name
   #
   #     def attributes
-  #       @attributes ||= {'name' => 'nil'}
+  #       {'name' => name}
   #     end
   #
   #   end
@@ -45,7 +45,7 @@ module ActiveModel
   #     attr_accessor :name
   #
   #     def attributes
-  #       @attributes ||= {'name' => 'nil'}
+  #       {'name' => name}
   #     end
   #
   #   end
@@ -79,15 +79,8 @@ module ActiveModel
         attribute_names -= except
       end
 
-      method_names = Array.wrap(options[:methods]).inject([]) do |methods, name|
-        methods << name if respond_to?(name.to_s)
-        methods
-      end
-
-      (attribute_names + method_names).inject({}) { |hash, name|
-        hash[name] = send(name)
-        hash
-      }
+      method_names = Array.wrap(options[:methods]).map { |n| n if respond_to?(n.to_s) }.compact
+      Hash[(attribute_names + method_names).map { |n| [n, send(n)] }]
     end
   end
 end

data/lib/active_model/serializers/json.rb

@@ -18,58 +18,58 @@ module ActiveModel
       # Returns a JSON string representing the model. Some configuration can be
       # passed through +options+.
       #
-      # The option <tt>ActiveModel::Base.include_root_in_json</tt> controls the
-      # top-level behavior of <tt>to_json</tt>. It is <tt>true</tt> by default. When it is <tt>true</tt>,
-      # <tt>to_json</tt> will emit a single root node named after the object's type. For example:
+      # The option <tt>include_root_in_json</tt> controls the top-level behavior
+      # of +as_json+. If true (the default) +as_json+ will emit a single root
+      # node named after the object's type. For example:
       #
       #   konata = User.find(1)
-      #   konata.to_json
+      #   konata.as_json
       #   # => { "user": {"id": 1, "name": "Konata Izumi", "age": 16,
       #                   "created_at": "2006/08/01", "awesome": true} }
       #
       #   ActiveRecord::Base.include_root_in_json = false
-      #   konata.to_json
+      #   konata.as_json
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true}
       #
-      # The remainder of the examples in this section assume include_root_in_json is set to
-      # <tt>false</tt>.
+      # The remainder of the examples in this section assume +include_root_in_json+
+      # is false.
       #
-      # Without any +options+, the returned JSON string will include all
-      # the model's attributes. For example:
+      # Without any +options+, the returned JSON string will include all the model's
+      # attributes. For example:
       #
       #   konata = User.find(1)
-      #   konata.to_json
+      #   konata.as_json
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true}
       #
       # The <tt>:only</tt> and <tt>:except</tt> options can be used to limit the attributes
       # included, and work similar to the +attributes+ method. For example:
       #
-      #   konata.to_json(:only => [ :id, :name ])
+      #   konata.as_json(:only => [ :id, :name ])
       #   # => {"id": 1, "name": "Konata Izumi"}
       #
-      #   konata.to_json(:except => [ :id, :created_at, :age ])
+      #   konata.as_json(:except => [ :id, :created_at, :age ])
       #   # => {"name": "Konata Izumi", "awesome": true}
       #
-      # To include any methods on the model, use <tt>:methods</tt>.
+      # To include the result of some method calls on the model use <tt>:methods</tt>:
       #
-      #   konata.to_json(:methods => :permalink)
+      #   konata.as_json(:methods => :permalink)
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true,
       #         "permalink": "1-konata-izumi"}
       #
-      # To include associations, use <tt>:include</tt>.
+      # To include associations use <tt>:include</tt>:
       #
-      #   konata.to_json(:include => :posts)
+      #   konata.as_json(:include => :posts)
       #   # => {"id": 1, "name": "Konata Izumi", "age": 16,
       #         "created_at": "2006/08/01", "awesome": true,
       #         "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"},
       #                   {"id": 2, author_id: 1, "title": "So I was thinking"}]}
       #
-      # 2nd level and higher order associations work as well:
+      # Second level and higher order associations work as well:
       #
-      #   konata.to_json(:include => { :posts => {
+      #   konata.as_json(:include => { :posts => {
       #                                  :include => { :comments => {
       #                                                :only => :body } },
       #                                  :only => :title } })

data/lib/active_model/serializers/xml.rb

@@ -33,7 +33,6 @@ module ActiveModel
         protected
 
           def compute_type
-            return if value.nil?
             type = ActiveSupport::XmlMini::TYPE_NAMES[value.class.name]
             type ||= :string if value.respond_to?(:to_str)
             type ||= :yaml
@@ -78,10 +77,9 @@ module ActiveModel
         end
 
         def serializable_methods
-          Array.wrap(options[:methods]).inject([]) do |methods, name|
-            methods << self.class::MethodAttribute.new(name.to_s, @serializable) if @serializable.respond_to?(name.to_s)
-            methods
-          end
+          Array.wrap(options[:methods]).map do |name|
+            self.class::MethodAttribute.new(name.to_s, @serializable) if @serializable.respond_to?(name.to_s)
+          end.compact
         end
 
         def serialize
@@ -136,6 +134,29 @@ module ActiveModel
 
       # Returns XML representing the model. Configuration can be
       # passed through +options+.
+      #
+      # Without any +options+, the returned XML string will include all the model's
+      # attributes. For example:
+      #
+      #   konata = User.find(1)
+      #   konata.to_xml
+      #
+      #   <?xml version="1.0" encoding="UTF-8"?>
+      #   <user>
+      #     <id type="integer">1</id>
+      #     <name>David</name>
+      #     <age type="integer">16</age>
+      #     <created-at type="datetime">2011-01-30T22:29:23Z</created-at>
+      #   </user>
+      #
+      # The <tt>:only</tt> and <tt>:except</tt> options can be used to limit the attributes
+      # included, and work similar to the +attributes+ method.
+      #
+      # To include the result of some method calls on the model use <tt>:methods</tt>.
+      #
+      # To include associations use <tt>:include</tt>.
+      #
+      # For further documentation see activerecord/lib/active_record/serializers/xml_serializer.xml.
       def to_xml(options = {}, &block)
         Serializer.new(self, options).serialize(&block)
       end