activerecord 1.0.0 → 2.0.0

data/lib/active_record/schema_dumper.rb

@@ -0,0 +1,171 @@
+require 'stringio'
+require 'bigdecimal'
+
+module ActiveRecord
+  # This class is used to dump the database schema for some connection to some
+  # output format (i.e., ActiveRecord::Schema).
+  class SchemaDumper #:nodoc:
+    private_class_method :new
+    
+    # A list of tables which should not be dumped to the schema. 
+    # Acceptable values are strings as well as regexp.
+    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+    cattr_accessor :ignore_tables 
+    @@ignore_tables = []
+
+    def self.dump(connection=ActiveRecord::Base.connection, stream=STDOUT)
+      new(connection).dump(stream)
+      stream
+    end
+
+    def dump(stream)
+      header(stream)
+      tables(stream)
+      trailer(stream)
+      stream
+    end
+
+    private
+
+      def initialize(connection)
+        @connection = connection
+        @types = @connection.native_database_types
+        @info = @connection.select_one("SELECT * FROM schema_info") rescue nil
+      end
+
+      def header(stream)
+        define_params = @info ? ":version => #{@info['version']}" : ""
+
+        stream.puts <<HEADER
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of ActiveRecord to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(#{define_params}) do
+
+HEADER
+      end
+
+      def trailer(stream)
+        stream.puts "end"
+      end
+
+      def tables(stream)
+        @connection.tables.sort.each do |tbl|
+          next if ["schema_info", ignore_tables].flatten.any? do |ignored|
+            case ignored
+            when String; tbl == ignored
+            when Regexp; tbl =~ ignored
+            else
+              raise StandardError, 'ActiveRecord::SchemaDumper.ignore_tables accepts an array of String and / or Regexp values.'
+            end
+          end 
+          table(tbl, stream)
+        end
+      end
+
+      def table(table, stream)
+        columns = @connection.columns(table)
+        begin
+          tbl = StringIO.new
+
+          if @connection.respond_to?(:pk_and_sequence_for)
+            pk, pk_seq = @connection.pk_and_sequence_for(table)
+          end
+          pk ||= 'id'
+
+          tbl.print "  create_table #{table.inspect}"
+          if columns.detect { |c| c.name == pk }
+            if pk != 'id'
+              tbl.print %Q(, :primary_key => "#{pk}")
+            end
+          else
+            tbl.print ", :id => false"
+          end
+          tbl.print ", :force => true"
+          tbl.puts " do |t|"
+
+          column_specs = columns.map do |column|
+            raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" if @types[column.type].nil?
+            next if column.name == pk
+            spec = {}
+            spec[:name]      = column.name.inspect
+            spec[:type]      = column.type.to_s
+            spec[:limit]     = column.limit.inspect if column.limit != @types[column.type][:limit] && column.type != :decimal
+            spec[:precision] = column.precision.inspect if !column.precision.nil?
+            spec[:scale]     = column.scale.inspect if !column.scale.nil?
+            spec[:null]      = 'false' if !column.null
+            spec[:default]   = default_string(column.default) if !column.default.nil?
+            (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
+            spec
+          end.compact
+
+          # find all migration keys used in this table
+          keys = [:name, :limit, :precision, :scale, :default, :null] & column_specs.map(&:keys).flatten
+
+          # figure out the lengths for each column based on above keys
+          lengths = keys.map{ |key| column_specs.map{ |spec| spec[key] ? spec[key].length + 2 : 0 }.max }
+
+          # the string we're going to sprintf our values against, with standardized column widths
+          format_string = lengths.map{ |len| "%-#{len}s" }
+
+          # find the max length for the 'type' column, which is special
+          type_length = column_specs.map{ |column| column[:type].length }.max
+
+          # add column type definition to our format string
+          format_string.unshift "    t.%-#{type_length}s "
+
+          format_string *= ''
+
+          column_specs.each do |colspec|
+            values = keys.zip(lengths).map{ |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
+            values.unshift colspec[:type]
+            tbl.print((format_string % values).gsub(/,\s*$/, ''))
+            tbl.puts
+          end
+
+          tbl.puts "  end"
+          tbl.puts
+          
+          indexes(table, tbl)
+
+          tbl.rewind
+          stream.print tbl.read
+        rescue => e
+          stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
+          stream.puts "#   #{e.message}"
+          stream.puts
+        end
+        
+        stream
+      end
+
+      def default_string(value)
+        case value
+        when BigDecimal
+          value.to_s
+        when Date, DateTime, Time
+          "'" + value.to_s(:db) + "'"
+        else
+          value.inspect
+        end
+      end
+      
+      def indexes(table, stream)
+        indexes = @connection.indexes(table)
+        indexes.each do |index|
+          stream.print "  add_index #{index.table.inspect}, #{index.columns.inspect}, :name => #{index.name.inspect}"
+          stream.print ", :unique => true" if index.unique
+          stream.puts
+        end
+        stream.puts unless indexes.empty?
+      end
+  end
+end

data/lib/active_record/serialization.rb

@@ -0,0 +1,98 @@
+module ActiveRecord #:nodoc:
+  module Serialization
+    class Serializer #:nodoc:
+      attr_reader :options
+
+      def initialize(record, options = {})
+        @record, @options = record, options.dup
+      end
+
+      # To replicate the behavior in ActiveRecord#attributes,
+      # :except takes precedence over :only.  If :only is not set
+      # for a N level model but is set for the N+1 level models,
+      # then because :except is set to a default value, the second
+      # level model can have both :except and :only set.  So if
+      # :only is set, always delete :except.
+      def serializable_attribute_names
+        attribute_names = @record.attribute_names
+
+        if options[:only]
+          options.delete(:except)
+          attribute_names = attribute_names & Array(options[:only]).collect { |n| n.to_s }
+        else
+          options[:except] = Array(options[:except]) | Array(@record.class.inheritance_column)
+          attribute_names = attribute_names - options[:except].collect { |n| n.to_s }
+        end
+
+        attribute_names
+      end
+
+      def serializable_method_names
+        Array(options[:methods]).inject([]) do |method_attributes, name|
+          method_attributes << name if @record.respond_to?(name.to_s)
+          method_attributes
+        end
+      end
+
+      def serializable_names
+        serializable_attribute_names + serializable_method_names
+      end
+
+      # Add associations specified via the :includes option.
+      # Expects a block that takes as arguments:
+      #   +association+ - name of the association
+      #   +records+     - the association record(s) to be serialized
+      #   +opts+        - options for the association records
+      def add_includes(&block)
+        if include_associations = options.delete(:include)
+          base_only_or_except = { :except => options[:except],
+                                  :only => options[:only] }
+
+          include_has_options = include_associations.is_a?(Hash)
+          associations = include_has_options ? include_associations.keys : Array(include_associations)
+
+          for association in associations
+            records = case @record.class.reflect_on_association(association).macro
+            when :has_many, :has_and_belongs_to_many
+              @record.send(association).to_a
+            when :has_one, :belongs_to
+              @record.send(association)
+            end
+
+            unless records.nil?
+              association_options = include_has_options ? include_associations[association] : base_only_or_except
+              opts = options.merge(association_options)
+              yield(association, records, opts)
+            end
+          end
+
+          options[:include] = include_associations
+        end
+      end
+
+      def serializable_record
+        returning(serializable_record = {}) do
+          serializable_names.each { |name| serializable_record[name] = @record.send(name) }
+          add_includes do |association, records, opts|
+            if records.is_a?(Enumerable)
+              serializable_record[association] = records.collect { |r| self.class.new(r, opts).serializable_record }
+            else
+              serializable_record[association] = self.class.new(records, opts).serializable_record
+            end
+          end
+        end
+      end
+
+      def serialize
+        # overwrite to implement
+      end
+
+      def to_s(&block)
+        serialize(&block)
+      end
+    end
+  end
+end
+
+require 'active_record/serializers/xml_serializer'
+require 'active_record/serializers/json_serializer'

data/lib/active_record/serializers/json_serializer.rb

@@ -0,0 +1,71 @@
+module ActiveRecord #:nodoc:
+  module Serialization
+    # Returns a JSON string representing the model. Some configuration is
+    # available through +options+.
+    #
+    # Without any +options+, the returned JSON string will include all
+    # the model's attributes. For example:
+    #
+    #   konata = User.find(1)
+    #   konata.to_json
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true}
+    #
+    # The :only and :except options can be used to limit the attributes
+    # included, and work similar to the #attributes method. For example:
+    #
+    #   konata.to_json(:only => [ :id, :name ])
+    #
+    #   {"id": 1, "name": "Konata Izumi"}
+    #
+    #   konata.to_json(:except => [ :id, :created_at, :age ])
+    #
+    #   {"name": "Konata Izumi", "awesome": true}
+    #
+    # To include any methods on the model, use :methods.
+    #
+    #   konata.to_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 :include.
+    #
+    #   konata.to_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:
+    #
+    #   konata.to_json(:include => { :posts => {
+    #                                  :include => { :comments => {
+    #                                                :only => :body } },
+    #                                  :only => :title } })
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}],
+    #               "title": "Welcome to the weblog"},
+    #              {"comments": [{"body": "Don't think too hard"}],
+    #               "title": "So I was thinking"}]}
+    def to_json(options = {})
+      JsonSerializer.new(self, options).to_s
+    end
+
+    def from_json(json)
+      self.attributes = ActiveSupport::JSON.decode(json)
+      self
+    end
+
+    class JsonSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
+      def serialize
+        serializable_record.to_json
+      end
+    end
+  end
+end

data/lib/active_record/serializers/xml_serializer.rb

@@ -0,0 +1,315 @@
+module ActiveRecord #:nodoc:
+  module Serialization
+    # Builds an XML document to represent the model.   Some configuration is
+    # available through +options+, however more complicated cases should
+    # override ActiveRecord's to_xml.
+    #
+    # By default the generated XML document will include the processing
+    # instruction and all object's attributes.  For example:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <topic>
+    #     <title>The First Topic</title>
+    #     <author-name>David</author-name>
+    #     <id type="integer">1</id>
+    #     <approved type="boolean">false</approved>
+    #     <replies-count type="integer">0</replies-count>
+    #     <bonus-time type="datetime">2000-01-01T08:28:00+12:00</bonus-time>
+    #     <written-on type="datetime">2003-07-16T09:28:00+1200</written-on>
+    #     <content>Have a nice day</content>
+    #     <author-email-address>david@loudthinking.com</author-email-address>
+    #     <parent-id></parent-id>
+    #     <last-read type="date">2004-04-15</last-read>
+    #   </topic>
+    #
+    # This behavior can be controlled with :only, :except,
+    # :skip_instruct, :skip_types and :dasherize.  The :only and
+    # :except options are the same as for the #attributes method.
+    # The default is to dasherize all column names, to disable this,
+    # set :dasherize to false.  To not have the column type included
+    # in the XML output, set :skip_types to true.
+    #
+    # For instance:
+    #
+    #   topic.to_xml(:skip_instruct => true, :except => [ :id, :bonus_time, :written_on, :replies_count ])
+    #
+    #   <topic>
+    #     <title>The First Topic</title>
+    #     <author-name>David</author-name>
+    #     <approved type="boolean">false</approved>
+    #     <content>Have a nice day</content>
+    #     <author-email-address>david@loudthinking.com</author-email-address>
+    #     <parent-id></parent-id>
+    #     <last-read type="date">2004-04-15</last-read>
+    #   </topic>
+    #
+    # To include first level associations use :include
+    #
+    #   firm.to_xml :include => [ :account, :clients ]
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <firm>
+    #     <id type="integer">1</id>
+    #     <rating type="integer">1</rating>
+    #     <name>37signals</name>
+    #     <clients type="array">
+    #       <client>
+    #         <rating type="integer">1</rating>
+    #         <name>Summit</name>
+    #       </client>
+    #       <client>
+    #         <rating type="integer">1</rating>
+    #         <name>Microsoft</name>
+    #       </client>
+    #     </clients>
+    #     <account>
+    #       <id type="integer">1</id>
+    #       <credit-limit type="integer">50</credit-limit>
+    #     </account>
+    #   </firm>
+    #
+    # To include any methods on the object(s) being called use :methods
+    #
+    #   firm.to_xml :methods => [ :calculated_earnings, :real_earnings ]
+    #
+    #   <firm>
+    #     # ... normal attributes as shown above ...
+    #     <calculated-earnings>100000000000000000</calculated-earnings>
+    #     <real-earnings>5</real-earnings>
+    #   </firm>
+    #
+    # To call any Proc's on the object(s) use :procs.  The Proc's
+    # are passed a modified version of the options hash that was
+    # given to #to_xml.
+    #
+    #   proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
+    #   firm.to_xml :procs => [ proc ]
+    #
+    #   <firm>
+    #     # ... normal attributes as shown above ...
+    #     <abc>def</abc>
+    #   </firm>
+    #
+    # Alternatively, you can also just yield the builder object as part of the to_xml call:
+    #
+    #   firm.to_xml do |xml|
+    #     xml.creator do
+    #       xml.first_name "David"
+    #       xml.last_name "Heinemeier Hansson"
+    #     end
+    #   end
+    #
+    #   <firm>
+    #     # ... normal attributes as shown above ...
+    #     <creator>
+    #       <first_name>David</first_name>
+    #       <last_name>Heinemeier Hansson</last_name>
+    #     </creator>
+    #   </firm>
+    #
+    # You can override the to_xml method in your ActiveRecord::Base
+    # subclasses if you need to.  The general form of doing this is
+    #
+    #   class IHaveMyOwnXML < ActiveRecord::Base
+    #     def to_xml(options = {})
+    #       options[:indent] ||= 2
+    #       xml = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+    #       xml.instruct! unless options[:skip_instruct]
+    #       xml.level_one do
+    #         xml.tag!(:second_level, 'content')
+    #       end
+    #     end
+    #   end
+    def to_xml(options = {}, &block)
+      serializer = XmlSerializer.new(self, options)
+      block_given? ? serializer.to_s(&block) : serializer.to_s
+    end
+
+    def from_xml(xml)
+      self.attributes = Hash.from_xml(xml).values.first
+      self
+    end
+  end
+
+  class XmlSerializer < ActiveRecord::Serialization::Serializer #:nodoc:
+    def builder
+      @builder ||= begin
+        options[:indent] ||= 2
+        builder = options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent])
+
+        unless options[:skip_instruct]
+          builder.instruct!
+          options[:skip_instruct] = true
+        end
+
+        builder
+      end
+    end
+
+    def root
+      root = (options[:root] || @record.class.to_s.underscore).to_s
+      dasherize? ? root.dasherize : root
+    end
+
+    def dasherize?
+      !options.has_key?(:dasherize) || options[:dasherize]
+    end
+
+
+    # To replicate the behavior in ActiveRecord#attributes,
+    # :except takes precedence over :only.  If :only is not set
+    # for a N level model but is set for the N+1 level models,
+    # then because :except is set to a default value, the second
+    # level model can have both :except and :only set.  So if
+    # :only is set, always delete :except.
+    def serializable_attributes
+      serializable_attribute_names.collect { |name| Attribute.new(name, @record) }
+    end
+
+    def serializable_method_attributes
+      Array(options[:methods]).inject([]) do |method_attributes, name|
+        method_attributes << MethodAttribute.new(name.to_s, @record) if @record.respond_to?(name.to_s)
+        method_attributes
+      end
+    end
+
+    def add_attributes
+      (serializable_attributes + serializable_method_attributes).each do |attribute|
+        add_tag(attribute)
+      end
+    end
+
+    def add_procs
+      if procs = options.delete(:procs)
+        [ *procs ].each do |proc|
+          proc.call(options)
+        end
+      end
+    end
+
+    def add_tag(attribute)
+      builder.tag!(
+        dasherize? ? attribute.name.dasherize : attribute.name,
+        attribute.value.to_s,
+        attribute.decorations(!options[:skip_types])
+      )
+    end
+
+    def add_associations(association, records, opts)
+      if records.is_a?(Enumerable)
+        tag = association.to_s
+        tag = tag.dasherize if dasherize?
+        if records.empty?
+          builder.tag!(tag, :type => :array)
+        else
+          builder.tag!(tag, :type => :array) do
+            association_name = association.to_s.singularize
+            records.each do |record|
+              record.to_xml opts.merge(
+                :root => association_name,
+                :type => (record.class.to_s.underscore == association_name ? nil : record.class.name)
+              )
+            end
+          end
+        end
+      else
+        if record = @record.send(association)
+          record.to_xml(opts.merge(:root => association))
+        end
+      end
+    end
+
+    def serialize
+      args = [root]
+      if options[:namespace]
+        args << {:xmlns=>options[:namespace]}
+      end
+
+      if options[:type]
+        args << {:type=>options[:type]}
+      end
+
+      builder.tag!(*args) do
+        add_attributes
+        procs = options.delete(:procs)
+        add_includes { |association, records, opts| add_associations(association, records, opts) }
+        options[:procs] = procs
+        add_procs
+        yield builder if block_given?
+      end
+    end
+
+    class Attribute #:nodoc:
+      attr_reader :name, :value, :type
+
+      def initialize(name, record)
+        @name, @record = name, record
+
+        @type  = compute_type
+        @value = compute_value
+      end
+
+      # There is a significant speed improvement if the value
+      # does not need to be escaped, as #tag! escapes all values
+      # to ensure that valid XML is generated.  For known binary
+      # values, it is at least an order of magnitude faster to
+      # Base64 encode binary values and directly put them in the
+      # output XML than to pass the original value or the Base64
+      # encoded value to the #tag! method. It definitely makes
+      # no sense to Base64 encode the value and then give it to
+      # #tag!, since that just adds additional overhead.
+      def needs_encoding?
+        ![ :binary, :date, :datetime, :boolean, :float, :integer ].include?(type)
+      end
+
+      def decorations(include_types = true)
+        decorations = {}
+
+        if type == :binary
+          decorations[:encoding] = 'base64'
+        end
+
+        if include_types && type != :string
+          decorations[:type] = type
+        end
+
+        if value.nil?
+          decorations[:nil] = true
+        end
+
+        decorations
+      end
+
+      protected
+        def compute_type
+          type = @record.class.serialized_attributes.has_key?(name) ? :yaml : @record.class.columns_hash[name].type
+
+          case type
+            when :text
+              :string
+            when :time
+              :datetime
+            else
+              type
+          end
+        end
+
+        def compute_value
+          value = @record.send(name)
+
+          if formatter = Hash::XML_FORMATTING[type.to_s]
+            value ? formatter.call(value) : nil
+          else
+            value
+          end
+        end
+    end
+
+    class MethodAttribute < Attribute #:nodoc:
+      protected
+        def compute_type
+          Hash::XML_TYPE_NAMES[@record.send(name).class.name] || :string
+        end
+    end
+  end
+end

data/lib/active_record/timestamp.rb

@@ -0,0 +1,41 @@
+module ActiveRecord
+  # Active Record automatically timestamps create and update operations if the table has fields
+  # named created_at/created_on or updated_at/updated_on.
+  #
+  # Timestamping can be turned off by setting
+  #   <tt>ActiveRecord::Base.record_timestamps = false</tt>
+  #
+  # Timestamps are in the local timezone by default but can use UTC by setting
+  #   <tt>ActiveRecord::Base.default_timezone = :utc</tt>
+  module Timestamp
+    def self.included(base) #:nodoc:
+      base.alias_method_chain :create, :timestamps
+      base.alias_method_chain :update, :timestamps
+
+      base.class_inheritable_accessor :record_timestamps, :instance_writer => false
+      base.record_timestamps = true
+    end
+
+    private
+      def create_with_timestamps #:nodoc:
+        if record_timestamps
+          t = self.class.default_timezone == :utc ? Time.now.utc : Time.now
+          write_attribute('created_at', t) if respond_to?(:created_at) && created_at.nil?
+          write_attribute('created_on', t) if respond_to?(:created_on) && created_on.nil?
+
+          write_attribute('updated_at', t) if respond_to?(:updated_at)
+          write_attribute('updated_on', t) if respond_to?(:updated_on)
+        end
+        create_without_timestamps
+      end
+
+      def update_with_timestamps #:nodoc:
+        if record_timestamps
+          t = self.class.default_timezone == :utc ? Time.now.utc : Time.now
+          write_attribute('updated_at', t) if respond_to?(:updated_at)
+          write_attribute('updated_on', t) if respond_to?(:updated_on)
+        end
+        update_without_timestamps
+      end
+  end
+end