activeobject 0.0.3

data/lib/active_support/callbacks.rb

@@ -0,0 +1,303 @@
+module ActiveSupport
+  # Callbacks are hooks into the lifecycle of an object that allow you to trigger logic
+  # before or after an alteration of the object state.
+  #
+  # Mixing in this module allows you to define callbacks in your class.
+  #
+  # Example:
+  #   class Storage
+  #     include ActiveSupport::Callbacks
+  #
+  #     define_callbacks :before_save, :after_save
+  #   end
+  #
+  #   class ConfigStorage < Storage
+  #     before_save :saving_message
+  #     def saving_message
+  #       puts "saving..."
+  #     end
+  #
+  #     after_save do |object|
+  #       puts "saved"
+  #     end
+  #
+  #     def save
+  #       run_callbacks(:before_save)
+  #       puts "- save"
+  #       run_callbacks(:after_save)
+  #     end
+  #   end
+  #
+  #   config = ConfigStorage.new
+  #   config.save
+  #
+  # Output:
+  #   saving...
+  #   - save
+  #   saved
+  #
+  # Callbacks from parent classes are inherited.
+  #
+  # Example:
+  #   class Storage
+  #     include ActiveSupport::Callbacks
+  #
+  #     define_callbacks :before_save, :after_save
+  #
+  #     before_save :prepare
+  #     def prepare
+  #       puts "preparing save"
+  #     end
+  #   end
+  #
+  #   class ConfigStorage < Storage
+  #     before_save :saving_message
+  #     def saving_message
+  #       puts "saving..."
+  #     end
+  #
+  #     after_save do |object|
+  #       puts "saved"
+  #     end
+  #
+  #     def save
+  #       run_callbacks(:before_save)
+  #       puts "- save"
+  #       run_callbacks(:after_save)
+  #     end
+  #   end
+  #
+  #   config = ConfigStorage.new
+  #   config.save
+  #
+  # Output:
+  #   preparing save
+  #   saving...
+  #   - save
+  #   saved
+  module Callbacks
+    class CallbackChain < Array
+      def self.build(kind, *methods, &block)
+        methods, options = extract_options(*methods, &block)
+        methods.map! { |method| Callback.new(kind, method, options) }
+        new(methods)
+      end
+
+      def run(object, options = {}, &terminator)
+        enumerator = options[:enumerator] || :each
+
+        unless block_given?
+          send(enumerator) { |callback| callback.call(object) }
+        else
+          send(enumerator) do |callback|
+            result = callback.call(object)
+            break result if terminator.call(result, object)
+          end
+        end
+      end
+
+      # TODO: Decompose into more Array like behavior
+      def replace_or_append!(chain)
+        if index = index(chain)
+          self[index] = chain
+        else
+          self << chain
+        end
+        self
+      end
+
+      def find(callback, &block)
+        select { |c| c == callback && (!block_given? || yield(c)) }.first
+      end
+
+      def delete(callback)
+        super(callback.is_a?(Callback) ? callback : find(callback))
+      end
+
+      private
+        def self.extract_options(*methods, &block)
+          methods.flatten!
+          options = methods.extract_options!
+          methods << block if block_given?
+          return methods, options
+        end
+
+        def extract_options(*methods, &block)
+          self.class.extract_options(*methods, &block)
+        end
+    end
+
+    class Callback
+      attr_reader :kind, :method, :identifier, :options
+
+      def initialize(kind, method, options = {})
+        @kind       = kind
+        @method     = method
+        @identifier = options[:identifier]
+        @options    = options
+      end
+
+      def ==(other)
+        case other
+        when Callback
+          (self.identifier && self.identifier == other.identifier) || self.method == other.method
+        else
+          (self.identifier && self.identifier == other) || self.method == other
+        end
+      end
+
+      def eql?(other)
+        self == other
+      end
+
+      def dup
+        self.class.new(@kind, @method, @options.dup)
+      end
+
+      def hash
+        if @identifier
+          @identifier.hash
+        else
+          @method.hash
+        end
+      end
+
+      def call(*args, &block)
+        evaluate_method(method, *args, &block) if should_run_callback?(*args)
+      rescue LocalJumpError
+        raise ArgumentError,
+          "Cannot yield from a Proc type filter. The Proc must take two " +
+          "arguments and execute #call on the second argument."
+      end
+
+      private
+        def evaluate_method(method, *args, &block)
+          case method
+            when Symbol
+              object = args.shift
+              object.send(method, *args, &block)
+            when String
+              eval(method, args.first.instance_eval { binding })
+            when Proc, Method
+              method.call(*args, &block)
+            else
+              if method.respond_to?(kind)
+                method.send(kind, *args, &block)
+              else
+                raise ArgumentError,
+                  "Callbacks must be a symbol denoting the method to call, a string to be evaluated, " +
+                  "a block to be invoked, or an object responding to the callback method."
+              end
+          end
+        end
+
+        def should_run_callback?(*args)
+          if options[:if]
+            evaluate_method(options[:if], *args)
+          elsif options[:unless]
+            !evaluate_method(options[:unless], *args)
+          else
+            true
+          end
+        end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+    	# 定义回调
+    	#
+    	# 例如:
+    	#   callbacks = %w(before_save)
+    	#   base.define_callbacks *callbacks
+    	# 等价于
+    	#   class << base
+    	#     def before_save(*methods,&block)
+    	#       callbacks= CallbackChain.build(:before_save,*methods,&block)
+    	#       (@before_save_callbacks ||= CallbackChain.new).concat callbacks
+    	#     end
+    	#
+    	#     def before_save_callback_chain
+    	#       @before_save_callbacks ||= CallbackChain.new
+    	#       if superclass.respond_to?(:before_save_callback_chain)
+    	#         CallbackChain.new(superclass.before_save_callback_chain+@before_save_callbacks)
+    	#       else
+    	#         @before_save_callbacks
+      #       end
+    	#     end
+    	#   end
+      def define_callbacks(*callbacks)
+        callbacks.each do |callback|
+          class_eval <<-"end_eval"
+            def self.#{callback}(*methods, &block)
+              callbacks = CallbackChain.build(:#{callback}, *methods, &block)
+              (@#{callback}_callbacks ||= CallbackChain.new).concat callbacks
+            end
+
+            def self.#{callback}_callback_chain
+              @#{callback}_callbacks ||= CallbackChain.new
+
+              if superclass.respond_to?(:#{callback}_callback_chain)
+                CallbackChain.new(superclass.#{callback}_callback_chain + @#{callback}_callbacks)
+              else
+                @#{callback}_callbacks
+              end
+            end
+          end_eval
+        end
+      end
+    end
+
+    # Runs all the callbacks defined for the given options.
+    #
+    # If a block is given it will be called after each callback receiving as arguments:
+    #
+    #  * the result from the callback
+    #  * the object which has the callback
+    #
+    # If the result from the block evaluates to false, the callback chain is stopped.
+    #
+    # Example:
+    #   class Storage
+    #     include ActiveSupport::Callbacks
+    #
+    #     define_callbacks :before_save, :after_save
+    #   end
+    #
+    #   class ConfigStorage < Storage
+    #     before_save :pass
+    #     before_save :pass
+    #     before_save :stop
+    #     before_save :pass
+    #
+    #     def pass
+    #       puts "pass"
+    #     end
+    #
+    #     def stop
+    #       puts "stop"
+    #       return false
+    #     end
+    #
+    #     def save
+    #       result = run_callbacks(:before_save) { |result, object| result == false }
+    #       puts "- save" if result
+    #     end
+    #   end
+    #
+    #   config = ConfigStorage.new
+    #   config.save
+    #
+    # Output:
+    #   pass
+    #   pass
+    #   stop
+    def run_callbacks(kind, options = {}, &block)
+      # self.class.send("#{kind}_callback_chain")
+      #
+      self.class.send("#{kind}_callback_chain").run(self, options, &block)
+    end
+  end
+end

data/lib/active_support/core_ext/array/access.rb

@@ -0,0 +1,53 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Array #:nodoc:
+      # Makes it easier to access parts of an array.
+      module Access
+        # Returns the tail of the array from +position+.
+        #
+        #   %w( a b c d ).from(0)  # => %w( a b c d )
+        #   %w( a b c d ).from(2)  # => %w( c d )
+        #   %w( a b c d ).from(10) # => nil
+        #   %w().from(0)           # => nil
+        def from(position)
+          self[position..-1]
+        end
+        
+        # Returns the beginning of the array up to +position+.
+        #
+        #   %w( a b c d ).to(0)  # => %w( a )
+        #   %w( a b c d ).to(2)  # => %w( a b c )
+        #   %w( a b c d ).to(10) # => %w( a b c d )
+        #   %w().to(0)           # => %w()
+        def to(position)
+          self[0..position]
+        end
+
+        # Equal to <tt>self[1]</tt>.
+        def second
+          self[1]
+        end
+
+        # Equal to <tt>self[2]</tt>.
+        def third
+          self[2]
+        end
+
+        # Equal to <tt>self[3]</tt>.
+        def fourth
+          self[3]
+        end
+
+        # Equal to <tt>self[4]</tt>.
+        def fifth
+          self[4]
+        end
+
+        # Equal to <tt>self[41]</tt>. Also known as accessing "the reddit".
+        def forty_two
+          self[41]
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/array/conversions.rb

@@ -0,0 +1,183 @@
+require 'builder'
+
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Array #:nodoc:
+      module Conversions
+        # Converts the array to a comma-separated sentence where the last element is joined by the connector word. Options:
+        # * <tt>:connector</tt> - The word used to join the last element in arrays with two or more elements (default: "and")
+        # * <tt>:skip_last_comma</tt> - Set to true to return "a, b and c" instead of "a, b, and c".        
+        def to_sentence(options = {})          
+          options.assert_valid_keys(:connector, :skip_last_comma, :locale)
+          
+          default = I18n.translate(:'support.array.sentence_connector', :locale => options[:locale])
+          default_skip_last_comma = I18n.translate(:'support.array.skip_last_comma', :locale => options[:locale])
+          options.reverse_merge! :connector => default, :skip_last_comma => default_skip_last_comma
+          options[:connector] = "#{options[:connector]} " unless options[:connector].nil? || options[:connector].strip == ''
+
+          case length
+            when 0
+              ""
+            when 1
+              self[0].to_s
+            when 2
+              "#{self[0]} #{options[:connector]}#{self[1]}"
+            else
+              "#{self[0...-1].join(', ')}#{options[:skip_last_comma] ? '' : ','} #{options[:connector]}#{self[-1]}"
+          end
+        end
+        
+
+        # Calls <tt>to_param</tt> on all its elements and joins the result with
+        # slashes. This is used by <tt>url_for</tt> in Action Pack. 
+        def to_param
+          collect { |e| e.to_param }.join '/'
+        end
+
+        # Converts an array into a string suitable for use as a URL query string,
+        # using the given +key+ as the param name.
+        #
+        #   ['Rails', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
+        def to_query(key)
+          prefix = "#{key}[]"
+          collect { |value| value.to_query(prefix) }.join '&'
+        end
+
+        def self.included(base) #:nodoc:
+          base.class_eval do
+            alias_method :to_default_s, :to_s
+            alias_method :to_s, :to_formatted_s
+          end
+        end
+
+        # Converts a collection of elements into a formatted string by calling
+        # <tt>to_s</tt> on all elements and joining them:
+        #
+        #   Blog.find(:all).to_formatted_s # => "First PostSecond PostThird Post"
+        #
+        # Adding in the <tt>:db</tt> argument as the format yields a prettier
+        # output:
+        #
+        #   Blog.find(:all).to_formatted_s(:db) # => "First Post,Second Post,Third Post"
+        def to_formatted_s(format = :default)
+          case format
+            when :db
+              if respond_to?(:empty?) && self.empty?
+                "null"
+              else
+                collect { |element| element.id }.join(",")
+              end
+            else
+              to_default_s
+          end
+        end
+
+        # Returns a string that represents this array in XML by sending +to_xml+
+        # to each element. Active Record collections delegate their representation
+        # in XML to this method.
+        #
+        # All elements are expected to respond to +to_xml+, if any of them does
+        # not an exception is raised.
+        #
+        # The root node reflects the class name of the first element in plural
+        # if all elements belong to the same type and that's not Hash:
+        #
+        #   customer.projects.to_xml
+        #
+        #   <?xml version="1.0" encoding="UTF-8"?>
+        #   <projects type="array">
+        #     <project>
+        #       <amount type="decimal">20000.0</amount>
+        #       <customer-id type="integer">1567</customer-id>
+        #       <deal-date type="date">2008-04-09</deal-date>
+        #       ...
+        #     </project>
+        #     <project>
+        #       <amount type="decimal">57230.0</amount>
+        #       <customer-id type="integer">1567</customer-id>
+        #       <deal-date type="date">2008-04-15</deal-date>
+        #       ...
+        #     </project>
+        #   </projects>
+        #
+        # Otherwise the root element is "records":
+        #
+        #   [{:foo => 1, :bar => 2}, {:baz => 3}].to_xml
+        #
+        #   <?xml version="1.0" encoding="UTF-8"?>
+        #   <records type="array">
+        #     <record>
+        #       <bar type="integer">2</bar>
+        #       <foo type="integer">1</foo>
+        #     </record>
+        #     <record>
+        #       <baz type="integer">3</baz>
+        #     </record>
+        #   </records>
+        #
+        # If the collection is empty the root element is "nil-classes" by default:
+        #
+        #   [].to_xml
+        #
+        #   <?xml version="1.0" encoding="UTF-8"?>
+        #   <nil-classes type="array"/>
+        #
+        # To ensure a meaningful root element use the <tt>:root</tt> option:
+        #
+        #   customer_with_no_projects.projects.to_xml(:root => "projects")
+        #
+        #   <?xml version="1.0" encoding="UTF-8"?>
+        #   <projects type="array"/>
+        #
+        # By default root children have as node name the one of the root
+        # singularized. You can change it with the <tt>:children</tt> option.
+        #
+        # The +options+ hash is passed downwards:
+        #
+        #   Message.all.to_xml(:skip_types => true)
+        #
+        #   <?xml version="1.0" encoding="UTF-8"?>
+        #   <messages>
+        #     <message>
+        #       <created-at>2008-03-07T09:58:18+01:00</created-at>
+        #       <id>1</id>
+        #       <name>1</name>
+        #       <updated-at>2008-03-07T09:58:18+01:00</updated-at>
+        #       <user-id>1</user-id>
+        #     </message>
+        #   </messages>
+        #
+        def to_xml(options = {})
+          raise "Not all elements respond to to_xml" unless all? { |e| e.respond_to? :to_xml }
+
+          options[:root]     ||= all? { |e| e.is_a?(first.class) && first.class.to_s != "Hash" } ? first.class.to_s.underscore.pluralize : "records"
+          options[:children] ||= options[:root].singularize
+          options[:indent]   ||= 2
+          options[:builder]  ||= Builder::XmlMarkup.new(:indent => options[:indent])
+
+          root     = options.delete(:root).to_s
+          children = options.delete(:children)
+
+          if !options.has_key?(:dasherize) || options[:dasherize]
+            root = root.dasherize
+          end
+
+          options[:builder].instruct! unless options.delete(:skip_instruct)
+
+          opts = options.merge({ :root => children })
+
+          xml = options[:builder]
+          if empty?
+            xml.tag!(root, options[:skip_types] ? {} : {:type => "array"})
+          else
+            xml.tag!(root, options[:skip_types] ? {} : {:type => "array"}) {
+              yield xml if block_given?
+              each { |e| e.to_xml(opts.merge({ :skip_instruct => true })) }
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/array/extract_options.rb

@@ -0,0 +1,20 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Array #:nodoc:
+      module ExtractOptions
+        # Extracts options from a set of arguments. Removes and returns the last
+        # element in the array if it's a hash, otherwise returns a blank hash.
+        #
+        #   def options(*args)
+        #     args.extract_options!
+        #   end
+        #
+        #   options(1, 2)           # => {}
+        #   options(1, 2, :a => :b) # => {:a=>:b}
+        def extract_options!
+          last.is_a?(::Hash) ? pop : {}
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/array/grouping.rb

@@ -0,0 +1,106 @@
+require 'enumerator'
+
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Array #:nodoc:
+      module Grouping
+        # Splits or iterates over the array in groups of size +number+,
+        # padding any remaining slots with +fill_with+ unless it is +false+.
+        # 
+        #   %w(1 2 3 4 5 6 7).in_groups_of(3) {|group| p group}
+        #   ["1", "2", "3"]
+        #   ["4", "5", "6"]
+        #   ["7", nil, nil]
+        #
+        #   %w(1 2 3).in_groups_of(2, ' ') {|group| p group}
+        #   ["1", "2"]
+        #   ["3", " "]
+        #
+        #   %w(1 2 3).in_groups_of(2, false) {|group| p group}
+        #   ["1", "2"]
+        #   ["3"]
+        def in_groups_of(number, fill_with = nil)
+          if fill_with == false
+            collection = self
+          else
+            # size % number gives how many extra we have;
+            # subtracting from number gives how many to add;
+            # modulo number ensures we don't add group of just fill.
+            padding = (number - size % number) % number
+            collection = dup.concat([fill_with] * padding)
+          end
+
+          if block_given?
+            collection.each_slice(number) { |slice| yield(slice) }
+          else
+            returning [] do |groups|
+              collection.each_slice(number) { |group| groups << group }
+            end
+          end
+        end
+
+        # Splits or iterates over the array in +number+ of groups, padding any
+        # remaining slots with +fill_with+ unless it is +false+.
+        #
+        #   %w(1 2 3 4 5 6 7 8 9 10).in_groups(3) {|group| p group}
+        #   ["1", "2", "3", "4"]
+        #   ["5", "6", "7", nil]
+        #   ["8", "9", "10", nil]
+        #
+        #   %w(1 2 3 4 5 6 7).in_groups(3, '&nbsp;') {|group| p group}
+        #   ["1", "2", "3"]
+        #   ["4", "5", "&nbsp;"]
+        #   ["6", "7", "&nbsp;"]
+        #
+        #   %w(1 2 3 4 5 6 7).in_groups(3, false) {|group| p group}
+        #   ["1", "2", "3"]
+        #   ["4", "5"]
+        #   ["6", "7"]
+        def in_groups(number, fill_with = nil)
+          # size / number gives minor group size;
+          # size % number gives how many objects need extra accomodation;
+          # each group hold either division or division + 1 items.
+          division = size / number
+          modulo = size % number
+
+          # create a new array avoiding dup
+          groups = []
+          start = 0
+
+          number.times do |index|
+            length = division + (modulo > 0 && modulo > index ? 1 : 0)
+            padding = fill_with != false &&
+              modulo > 0 && length == division ? 1 : 0
+            groups << slice(start, length).concat([fill_with] * padding)
+            start += length
+          end
+
+          if block_given?
+            groups.each{|g| yield(g) }
+          else
+            groups
+          end
+        end
+
+        # Divides the array into one or more subarrays based on a delimiting +value+
+        # or the result of an optional block.
+        #
+        #   [1, 2, 3, 4, 5].split(3)                # => [[1, 2], [4, 5]]
+        #   (1..10).to_a.split { |i| i % 3 == 0 }   # => [[1, 2], [4, 5], [7, 8], [10]]
+        def split(value = nil)
+          using_block = block_given?
+
+          inject([[]]) do |results, element|
+            if (using_block && yield(element)) || (value == element)
+              results << []
+            else
+              results.last << element
+            end
+
+            results
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/array/random_access.rb

@@ -0,0 +1,12 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Array #:nodoc:
+      module RandomAccess
+        # Returns a random element from the array.
+        def rand
+          self[Kernel.rand(length)]
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/array.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/array/conversions'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/array/grouping'
+require 'active_support/core_ext/array/random_access'
+
+class Array #:nodoc:
+  include ActiveSupport::CoreExtensions::Array::Access
+  include ActiveSupport::CoreExtensions::Array::Conversions
+  include ActiveSupport::CoreExtensions::Array::ExtractOptions
+  include ActiveSupport::CoreExtensions::Array::Grouping
+  include ActiveSupport::CoreExtensions::Array::RandomAccess
+end