class Object
Constants
- APP_PATH
- ASSETS_ROOT
- AnotherObjectHelperTest
- AppRoutes
- ApplicationController
- Bowtie
- CACHE_DIR
- COMPONENT_ROOT
- Car
- Category
- Conflict
- Customer
- DEFAULT_APP_FILES
- DEFAULT_PLUGIN_FILES
- DecoratedTester
- Developer
- EXPECTED_DEFAULT_TIMEZONE
- EXPECTED_TIME_ZONE_AWARE_ATTRIBUTES
- EXPECTED_ZONE
This method makes sure that tests don't leak global state related to time zones.
- Event
- ExpandedPayment
- FILE_STORE_PATH
Don't change '/../temp/' cavalierly or you might hose something you don't want hosed
- FIXTURES_ROOT
- FIXTURE_LOAD_PATH
- FRAMEWORKS
- FRAMEWORK_NAMES
- Game
- HasBlock
- Invoice
- MIGRATIONS_ROOT
- MultipleConstantFile
- Neckbeard
- ORIGINAL_LOCALES
- ORIG_ARGV
- ObjectHelper
- PATH_TO_AR
- PROCESS_COUNT
- Payment
- Post
- Product
- Project
- QUOTED_TYPE
Quote “type” if it's a reserved word for the current connection.
- RAILS_FRAMEWORK_ROOT
- RAILS_ISOLATED_ENGINE
- RECORDS
- RaisesArbitraryException
- SCHEMA_ROOT
- SERVICE_CONFIGURATIONS
- Scroll
- ShouldNotBeAutoloaded
- SiblingConstant
- Someone
- Somewhere
- TEST_ROOT
- TIME
- Tester
- Throws
- TypO
- VENDOR_PATH
Public Class Methods
# File activejob/test/support/backburner/inline.rb, line 7 def self.enqueue(job_class, args = [], opts = {}) job_class.perform(*args) end
# File activerecord/lib/rails/generators/active_record/model/templates/module.rb, line 3 def self.table_name_prefix '<%= namespaced? ? namespaced_class_path.join('_') : class_path.join('_') %>_' end
Private Class Methods
# File actioncable/test/client_test.rb, line 14 def initialize(*) @application_data_buffer = nil super end
Public Instance Methods
# File railties/lib/rails/generators/test_unit/mailer/templates/preview.rb, line 9 def <%= action %> <%= class_name %>Mailer.<%= action %> end <% end -%> end
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 activesupport/lib/active_support/core_ext/object/acts_like.rb, line 9 def acts_like?(duck) respond_to? :"acts_like_#{duck}?" end
An object is blank if it's false, empty, or a whitespace string. For example, false
, '', ' ', nil
, [], and {} are all blank.
This simplifies
!address || address.empty?
to
address.blank?
@return [true, false]
# File activesupport/lib/active_support/core_ext/object/blank.rb, line 18 def blank? respond_to?(:empty?) ? !!empty? : !self end
# File activerecord/lib/rails/generators/active_record/migration/templates/migration.rb, line 3 def change <% attributes.each do |attribute| -%> <%- if attribute.reference? -%> add_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %> <%- elsif attribute.token? -%> add_column :<%= table_name %>, :<%= attribute.name %>, :string<%= attribute.inject_options %> add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true <%- else -%> add_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %> <%- if attribute.has_index? -%> add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %> <%- end -%> <%- end -%> <%- end -%> end <%- elsif migration_action == 'join' -%> def change create_join_table :<%= join_tables.first %>, :<%= join_tables.second %> do |t| <%- attributes.each do |attribute| -%> <%- if attribute.reference? -%> t.references :<%= attribute.name %><%= attribute.inject_options %> <%- else -%> <%= '# ' unless attribute.has_index? -%>t.index <%= attribute.index_name %><%= attribute.inject_index_options %> <%- end -%> <%- end -%> end end <%- else -%> def change <% attributes.each do |attribute| -%> <%- if migration_action -%> <%- if attribute.reference? -%> remove_reference :<%= table_name %>, :<%= attribute.name %><%= attribute.inject_options %> <%- else -%> <%- if attribute.has_index? -%> remove_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %> <%- end -%> remove_column :<%= table_name %>, :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %> <%- end -%> <%- end -%> <%- end -%> end <%- end -%>
# File railties/lib/rails/test_help.rb, line 33 def create_fixtures(*fixture_set_names, &block) FixtureSet.create_fixtures(ActiveSupport::TestCase.fixture_path, fixture_set_names, {}, &block) end
# File activerecord/test/cases/helper.rb, line 31 def current_adapter?(*types) types.any? do |type| ActiveRecord::ConnectionAdapters.const_defined?(type) && ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters.const_get(type)) end end
Returns a deep copy of object if it's duplicable. If it's not duplicable, returns self
.
object = Object.new dup = object.deep_dup dup.instance_variable_set(:@a, 1) object.instance_variable_defined?(:@a) # => false dup.instance_variable_defined?(:@a) # => true
# File activesupport/lib/active_support/core_ext/object/deep_dup.rb, line 15 def deep_dup duplicable? ? dup : self end
# File activerecord/test/cases/helper.rb, line 125 def disable_extension!(extension, connection) return false unless connection.supports_extensions? return true unless connection.extension_enabled?(extension) connection.disable_extension extension connection.reconnect! end
Can you safely dup this object?
False for method objects; true otherwise.
# File activesupport/lib/active_support/core_ext/object/duplicable.rb, line 26 def duplicable? true end
# File activerecord/test/cases/helper.rb, line 116 def enable_extension!(extension, connection) return false unless connection.supports_extensions? return connection.reconnect! if connection.extension_enabled?(extension) connection.enable_extension extension connection.commit_db_transaction if connection.transaction_open? connection.reconnect! end
# File activesupport/lib/active_support/core_ext/string/output_safety.rb, line 126 def html_safe? false end
Returns true if this object is included in the argument. Argument must be any object which responds to #include?
. Usage:
characters = ["Konata", "Kagami", "Tsukasa"] "Konata".in?(characters) # => true
This will throw an ArgumentError
if the argument doesn't respond to #include?
.
# File activesupport/lib/active_support/core_ext/object/inclusion.rb, line 12 def in?(another_object) another_object.include?(self) rescue NoMethodError raise ArgumentError.new("The parameter passed to #in? must respond to #include?") end
# File activerecord/test/cases/helper.rb, line 38 def in_memory_db? current_adapter?(:SQLite3Adapter) && ActiveRecord::Base.connection_pool.spec.config[:database] == ":memory:" end
Returns a hash with string keys that maps instance variable names without “@” to their corresponding values.
class C def initialize(x, y) @x, @y = x, y end end C.new(0, 1).instance_values # => {"x" => 0, "y" => 1}
# File activesupport/lib/active_support/core_ext/object/instance_variables.rb, line 14 def instance_values Hash[instance_variables.map { |name| [name[1..-1], instance_variable_get(name)] }] end
Returns an array of instance variable names as strings including “@”.
class C def initialize(x, y) @x, @y = x, y end end C.new(0, 1).instance_variable_names # => ["@y", "@x"]
# File activesupport/lib/active_support/core_ext/object/instance_variables.rb, line 27 def instance_variable_names instance_variables.map(&:to_s) end
# File activerecord/test/cases/helper.rb, line 133 def load_schema # silence verbose schema loading original_stdout = $stdout $stdout = StringIO.new adapter_name = ActiveRecord::Base.connection.adapter_name.downcase adapter_specific_schema_file = SCHEMA_ROOT + "/#{adapter_name}_specific_schema.rb" load SCHEMA_ROOT + "/schema.rb" if File.exist?(adapter_specific_schema_file) load adapter_specific_schema_file end ActiveRecord::FixtureSet.reset_cache ensure $stdout = original_stdout end
# File activerecord/test/cases/helper.rb, line 47 def mysql_enforcing_gtid_consistency? current_adapter?(:Mysql2Adapter) && "ON" == ActiveRecord::Base.connection.show_variable("enforce_gtid_consistency") end
# File activejob/lib/rails/generators/job/templates/job.rb, line 5 def perform(*args) # Do something later end
Returns the receiver if it's present otherwise returns nil
. object.presence
is equivalent to
object.present? ? object : nil
For example, something like
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'
@return [Object]
# File activesupport/lib/active_support/core_ext/object/blank.rb, line 45 def presence self if present? end
Returns the receiver if it's included in the argument otherwise returns nil
. Argument must be any object which responds to #include?
. Usage:
params[:bucket_type].presence_in %w( project calendar )
This will throw an ArgumentError
if the argument doesn't respond to #include?
.
@return [Object]
# File activesupport/lib/active_support/core_ext/object/inclusion.rb, line 26 def presence_in(another_object) in?(another_object) ? self : nil end
An object is present if it's not blank.
@return [true, false]
# File activesupport/lib/active_support/core_ext/object/blank.rb, line 25 def present? !blank? end
# File activerecord/examples/performance.rb, line 47 def progress_bar(int); print "." if (int % 100).zero? ; end
# File actioncable/lib/rails/generators/channel/templates/channel.rb, line 3 def subscribed # stream_from "some_channel" end
# File activerecord/test/cases/helper.rb, line 43 def subsecond_precision_supported? ActiveRecord::Base.connection.supports_datetime_with_precision? end
# File activerecord/test/cases/helper.rb, line 51 def supports_savepoints? ActiveRecord::Base.connection.supports_savepoints? end
Alias of to_s
.
# File activesupport/lib/active_support/core_ext/object/to_query.rb, line 7 def to_param to_s end
Converts an object into a string suitable for use as a URL query string, using the given key
as the param name.
# File activesupport/lib/active_support/core_ext/object/to_query.rb, line 13 def to_query(key) "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}" end
Invokes the public method whose name goes as first argument just like public_send
does, except that if the receiver does not respond to it the call returns nil
rather than raising an exception.
This method is defined to be able to write
@person.try(:name)
instead of
@person.name if @person
try
calls can be chained:
@person.try(:spouse).try(:name)
instead of
@person.spouse.name if @person && @person.spouse
try
will also return nil
if the receiver does not respond to the method:
@person.try(:non_existing_method) # => nil
instead of
@person.non_existing_method if @person.respond_to?(:non_existing_method) # => nil
try
returns nil
when called on nil
regardless of whether it responds to the method:
nil.try(:to_i) # => nil, rather than 0
Arguments and blocks are forwarded to the method if invoked:
@posts.try(:each_slice, 2) do |a, b| ... end
The number of arguments in the signature must match. If the object responds to the method the call is attempted and ArgumentError
is still raised in case of argument mismatch.
If try
is called without arguments it yields the receiver to a given block unless it is nil
:
@person.try do |p| ... end
You can also call try with a block without accepting an argument, and the block will be instance_eval'ed instead:
@person.try { upcase.truncate(50) }
Please also note that try
is defined on Object
. Therefore, it won't work with instances of classes that do not have Object
among their ancestors, like direct subclasses of BasicObject
.
# File activesupport/lib/active_support/core_ext/object/try.rb, line 29
Same as try
, but raises a NoMethodError
exception if the receiver is not nil
and does not implement the tried method.
"a".try!(:upcase) # => "A" nil.try!(:upcase) # => nil 123.try!(:upcase) # => NoMethodError: undefined method `upcase' for 123:Integer
# File activesupport/lib/active_support/core_ext/object/try.rb, line 94
# File activesupport/lib/active_support/core_ext/uri.rb, line 10 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) { |match| [match[1, 2].hex].pack("C") }.force_encoding(enc) end
# File actioncable/lib/rails/generators/channel/templates/channel.rb, line 7 def unsubscribed # Any cleanup needed when channel is unsubscribed end
# File activerecord/test/cases/helper.rb, line 89 def verify_default_timezone_config if Time.zone != EXPECTED_ZONE $stderr.puts <<-MSG \n#{self} Global state `Time.zone` was leaked. Expected: #{EXPECTED_ZONE} Got: #{Time.zone} MSG end if ActiveRecord::Base.default_timezone != EXPECTED_DEFAULT_TIMEZONE $stderr.puts <<-MSG \n#{self} Global state `ActiveRecord::Base.default_timezone` was leaked. Expected: #{EXPECTED_DEFAULT_TIMEZONE} Got: #{ActiveRecord::Base.default_timezone} MSG end if ActiveRecord::Base.time_zone_aware_attributes != EXPECTED_TIME_ZONE_AWARE_ATTRIBUTES $stderr.puts <<-MSG \n#{self} Global state `ActiveRecord::Base.time_zone_aware_attributes` was leaked. Expected: #{EXPECTED_TIME_ZONE_AWARE_ATTRIBUTES} Got: #{ActiveRecord::Base.time_zone_aware_attributes} MSG end end
# File activerecord/test/cases/helper.rb, line 55 def with_env_tz(new_tz = "US/Eastern") old_tz, ENV["TZ"] = ENV["TZ"], new_tz yield ensure old_tz ? ENV["TZ"] = old_tz : ENV.delete("TZ") end
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
When you don't pass an explicit receiver, it executes the whole block in merging options context:
class Account < ActiveRecord::Base with_options dependent: :destroy do has_many :customers has_many :products has_many :invoices has_many :expenses end end
with_options
can also be nested since the call is forwarded to its receiver.
NOTE: Each nesting level will merge inherited defaults in addition to their own.
class Post < ActiveRecord::Base with_options if: :persisted?, length: { minimum: 50 } do validates :content, if: -> { content.present? } end end
The code is equivalent to:
validates :content, length: { minimum: 50 }, if: -> { content.present? }
Hence the inherited default for `if` key is ignored.
NOTE: You cannot call class methods implicitly inside of with_options. You can access these methods using the class name instead:
class Phone < ActiveRecord::Base enum phone_number_type: [home: 0, office: 1, mobile: 2] with_options presence: true do validates :phone_number_type, inclusion: { in: Phone.phone_number_types.keys } end end
# File activesupport/lib/active_support/core_ext/object/with_options.rb, line 78 def with_options(options, &block) option_merger = ActiveSupport::OptionMerger.new(self, options) block.arity.zero? ? option_merger.instance_eval(&block) : block.call(option_merger) end
# File activerecord/test/cases/helper.rb, line 62 def with_timezone_config(cfg) verify_default_timezone_config old_default_zone = ActiveRecord::Base.default_timezone old_awareness = ActiveRecord::Base.time_zone_aware_attributes old_zone = Time.zone if cfg.has_key?(:default) ActiveRecord::Base.default_timezone = cfg[:default] end if cfg.has_key?(:aware_attributes) ActiveRecord::Base.time_zone_aware_attributes = cfg[:aware_attributes] end if cfg.has_key?(:zone) Time.zone = cfg[:zone] end yield ensure ActiveRecord::Base.default_timezone = old_default_zone ActiveRecord::Base.time_zone_aware_attributes = old_awareness Time.zone = old_zone end