Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for defining default values as option for ActiveSupport::Configurable accessors #42030

Merged
merged 1 commit into from
Jul 29, 2021
Merged

Add support for defining default values as option for ActiveSupport::Configurable accessors #42030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
ActiveSupport::Configurable default value option 
Sometimes it can be very strange or long have to define default values
for config accessors as blocks, specially when config is a simple value
like 1, true, :symbol. This commit adds the ability to specify those
values by just passing a ` default` option when defining the accessor.

It also makes config accessor's interface similar to other Rails
methods like `class_attribute`, which also has the instance_reader,
instance_writer and instance_accessor options.
  • Loading branch information
@diegotoral
diegotoral committed Jul 20, 2021
commit 99525cb6ffee2dadf4b11ce1a8094a353ef1a566
9 changes: 6 additions & 3 deletions activesupport/lib/active_support/configurable.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,19 @@ def configure
# User.new.allowed_access = true # => NoMethodError
# User.new.allowed_access # => NoMethodError
#
# Also you can pass a block to set up the attribute with a default value.
# Also you can pass <tt>default</tt> or a block to set up the attribute with a default value.
#
# class User
# include ActiveSupport::Configurable
# config_accessor :allowed_access, default: false
# config_accessor :hair_colors do
# [:brown, :black, :blonde, :red]
# end
# end
#
# User.allowed_access # => false
# User.hair_colors # => [:brown, :black, :blonde, :red]
def config_accessor(*names, instance_reader: true, instance_writer: true, instance_accessor: true) # :doc:
def config_accessor(*names, instance_reader: true, instance_writer: true, instance_accessor: true, default: nil) # :doc:
names.each do |name|
raise NameError.new("invalid config attribute name") unless /\A[_A-Za-z]\w*\z/.match?(name)

Expand All @@ -118,7 +120,8 @@ def config_accessor(*names, instance_reader: true, instance_writer: true, instan
class_eval reader, __FILE__, reader_line if instance_reader
class_eval writer, __FILE__, writer_line if instance_writer
end
send("#{name}=", yield) if block_given?

send("#{name}=", block_given? ? yield : default)
end
end
private :config_accessor
Expand Down
11 changes: 10 additions & 1 deletion activesupport/test/configurable_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class Child < Parent
assert_not_respond_to instance, :baz=
end

test "configuration accessors can take a default value" do
test "configuration accessors can take a default value as a block" do
parent = Class.new do
include ActiveSupport::Configurable
config_accessor :hair_colors, :tshirt_colors do
Expand All @@ -62,6 +62,15 @@ class Child < Parent
assert_equal [:black, :blue, :white], parent.tshirt_colors
end

test "configuration accessors can take a default value as an option" do
parent = Class.new do
include ActiveSupport::Configurable
config_accessor :foo, default: :bar
end

assert_equal :bar, parent.foo
end

test "configuration hash is available on instance" do
instance = Parent.new
assert_equal :bar, instance.config.foo
Expand Down