Class: Object

### Home Classes Methods

### In Files

- lib/active_support/core_ext/kernel/agnostics.rb
- lib/active_support/core_ext/load_error.rb
- lib/active_support/core_ext/object/acts_like.rb
- lib/active_support/core_ext/object/blank.rb
- lib/active_support/core_ext/object/duplicable.rb
- lib/active_support/core_ext/object/inclusion.rb
- lib/active_support/core_ext/object/instance_variables.rb
- lib/active_support/core_ext/object/to_json.rb
- lib/active_support/core_ext/object/to_param.rb
- lib/active_support/core_ext/object/to_query.rb
- lib/active_support/core_ext/object/try.rb
- lib/active_support/core_ext/object/with_options.rb
- lib/active_support/core_ext/string/output_safety.rb
- lib/active_support/core_ext/uri.rb
- lib/active_support/hash_with_indifferent_access.rb
- lib/active_support/json/encoding.rb
- lib/active_support/testing/performance.rb
- lib/active_support/xml_mini/jdom.rb

### Parent

BasicObject

### Namespace

- CLASS Object::HashWithIndifferentAccess
- CLASS Object::MissingSourceFile

### Methods

- #acts_like?
- #blank?
- #duplicable?
- #html_safe?
- #in?
- #instance_variable_names
- #presence
- #present?
- #to_json
- #to_param
- #to_query
- #try
- #unescape
- #with_options

### Included Modules

- Java

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# Object

### Constants

HashWithIndifferentAccess
MissingSourceFile
RUBY_ENGINE

### Public Instance Methods

acts_like?(duck) click to toggle source

A duck-type assistant method. For example, Active Support extends Date to define an acts_like_date? method, and extends Time to define acts_like_time?. As a result, we can do “x.acts_like?(:time)” and “x.acts_like?(:date)” to do duck-type-safe comparisons, since classes that we want to act like Time simply need to define an acts_like_time? method.

    # File lib/active_support/core_ext/object/acts_like.rb, line 7
    def acts_like?(duck)
      respond_to? :"acts_like_#{duck}?"
    end

blank?() click to toggle source

An object is blank if it’s false, empty, or a whitespace string. For example, “”, “ ”, `nil`, [], and {} are all blank.

This simplifies:

    if address.nil? || address.empty?

…to:

    if address.blank?

    # File lib/active_support/core_ext/object/blank.rb, line 14
    def blank?
      respond_to?(:empty?) ? empty? : !self
    end

duplicable?() click to toggle source

Can you safely dup this object?

False for `nil`, `false`, `true`, symbols, numbers, class and module objects; true otherwise.

    # File lib/active_support/core_ext/object/duplicable.rb, line 24
    def duplicable?
      true
    end

html_safe?() click to toggle source

    # File lib/active_support/core_ext/string/output_safety.rb, line 76
    def html_safe?
      false
    end

in?(*args) click to toggle source

Returns true if this object is included in the argument(s). Argument must be any object which responds to `#include?` or optionally, multiple arguments can be passed in. Usage:

    characters = ["Konata", "Kagami", "Tsukasa"]
    "Konata".in?(characters) # => true

    character = "Konata"
    character.in?("Konata", "Kagami", "Tsukasa") # => true

This will throw an ArgumentError if a single argument is passed in and it doesn’t respond to `#include?`.

    # File lib/active_support/core_ext/object/inclusion.rb, line 13
    def in?(*args)
      if args.length > 1
        args.include? self
      else
        another_object = args.first
        if another_object.respond_to? :include?
          another_object.include? self
        else
          raise ArgumentError.new("The single parameter passed to #in? must respond to #include?")
        end
      end
    end

instance_variable_names() click to toggle source

    # File lib/active_support/core_ext/object/instance_variables.rb, line 27
    def instance_variable_names
      instance_variables.map { |var| var.to_s }
    end

presence() click to toggle source

Returns object if it’s `present?` otherwise returns `nil`. `object.presence` is equivalent to `object.present? ? object : nil`.

This is handy for any representation of objects where blank is the same as not present at all. For example, this simplifies a common check for HTTP POST/query parameters:

    state   = params[:state]   if params[:state].present?
    country = params[:country] if params[:country].present?
    region  = state || country || 'US'

…becomes:

    region = params[:state].presence || params[:country].presence || 'US'

    # File lib/active_support/core_ext/object/blank.rb, line 37
    def presence
      self if present?
    end

present?() click to toggle source

An object is present if it’s not `blank?`.

    # File lib/active_support/core_ext/object/blank.rb, line 19
    def present?
      !blank?
    end

to_json(options = nil) click to toggle source

Dumps object in JSON (JavaScript Object Notation). See www.json.org for more info.

    # File lib/active_support/core_ext/object/to_json.rb, line 15
    def to_json(options = nil)
      ActiveSupport::JSON.encode(self, options)
    end

to_param() click to toggle source

Alias of `to_s`.

    # File lib/active_support/core_ext/object/to_param.rb, line 3
    def to_param
      to_s
    end

to_query(key) click to toggle source

Converts an object into a string suitable for use as a URL query string, using the given `key` as the param name.

Note: This method is defined as a default implementation for all Objects for Hash#to_query to work.

    # File lib/active_support/core_ext/object/to_query.rb, line 8
    def to_query(key)
      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
      "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
    end

try(*a, &b) click to toggle source

Invokes the method identified by the symbol `method`, passing it any arguments and/or the block specified, just like the regular Ruby `Object#send` does.

Unlike that method however, a `NoMethodError` exception will not be raised and `nil` will be returned instead, if the receiving object is a `nil` object or NilClass.

If try is called without a method to call, it will yield any given block with the object.

Please also note that `try` is defined on `Object`, therefore it won’t work with subclasses of `BasicObject`. For example, using try with `SimpleDelegator` will delegate `try` to target instead of calling it on delegator itself.

#### Examples

Without `try`

    @person && @person.name

or

    @person ? @person.name : nil

With `try`

    @person.try(:name)

`try` also accepts arguments and/or a block, for the method it is trying

    Person.try(:find, 1)
    @people.try(:collect) {|p| p.name}

Without a method argument try will yield to the block unless the receiver is nil.

    @person.try { |p| "#{p.first_name} #{p.last_name}" }

    # File lib/active_support/core_ext/object/try.rb, line 32
    def try(*a, &b)
      if a.empty? && block_given?
        yield self
      else
        __send__(*a, &b)
      end
    end

unescape(str, escaped = /%[a-fA-F\d]{2}/) click to toggle source

    # File lib/active_support/core_ext/uri.rb, line 12
    def unescape(str, escaped = /%[a-fA-F\d]{2}/)
      # TODO: Are we actually sure that ASCII == UTF-8?
      # YK: My initial experiments say yes, but let's be sure please
      enc = str.encoding
      enc = Encoding::UTF_8 if enc == Encoding::US_ASCII
      str.gsub(escaped) { [$&[1, 2].hex].pack('C') }.force_encoding(enc)
    end

with_options(options) click to toggle source

An elegant way to factor duplication out of options passed to a series of method calls. Each method called in the block, with the block variable as the receiver, will have its options merged with the default `options` hash provided. Each method called on the block variable must take an options hash as its final argument.

Without `with_options>`, this code contains duplication:

    class Account < ActiveRecord::Base
      has_many :customers, :dependent => :destroy
      has_many :products,  :dependent => :destroy
      has_many :invoices,  :dependent => :destroy
      has_many :expenses,  :dependent => :destroy
    end

Using `with_options`, we can remove the duplication:

    class Account < ActiveRecord::Base
      with_options :dependent => :destroy do |assoc|
        assoc.has_many :customers
        assoc.has_many :products
        assoc.has_many :invoices
        assoc.has_many :expenses
      end
    end

It can also be used with an explicit receiver:

    I18n.with_options :locale => user.locale, :scope => "newsletter" do |i18n|
      subject i18n.t :subject
      body    i18n.t :body, :user_name => user.name
    end

`with_options` can also be nested since the call is forwarded to its receiver. Each nesting level will merge inherited defaults in addition to their own.

    # File lib/active_support/core_ext/object/with_options.rb, line 40
    def with_options(options)
      yield ActiveSupport::OptionMerger.new(self, options)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.