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.

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

Already on GitHub? Sign in to your account

Add Configuration#dig() and ConfigView#dig() #1221

Merged
merged 1 commit into from Sep 22, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions lib/nanoc/base/entities/configuration.rb
Expand Up @@ -96,6 +96,11 @@ def [](key)
@wrapped[key]
end

contract C::Args[C::Any] => C::Any
def dig(*keys)
@wrapped.dig(*keys)
end

contract C::Any, C::Maybe[C::Any], C::Maybe[C::Func[C::None => C::Any]] => C::Any
def fetch(key, fallback = NONE, &_block)
@wrapped.fetch(key) do
Expand Down
6 changes: 6 additions & 0 deletions lib/nanoc/base/views/config_view.rb
Expand Up @@ -47,5 +47,11 @@ def each(&block)
@context.dependency_tracker.bounce(unwrap, attributes: true)
@config.each(&block)
end

# @see Hash#dig
def dig(*keys)
@context.dependency_tracker.bounce(unwrap, attributes: keys)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

attributes is a list of top-level attributes that are touched, so this should be keys.first instead. Nanoc only tracks dependencies of keys one level deep.

(keys will also work, but generate unnecessary dependencies.)

@config.dig(*keys)
end
end
end
34 changes: 26 additions & 8 deletions spec/nanoc/base/views/config_view_spec.rb
Expand Up @@ -5,7 +5,7 @@
Nanoc::Int::Configuration.new(hash: hash)
end

let(:hash) { { amount: 9000, animal: 'donkey' } }
let(:hash) { { amount: 9000, animal: 'donkey', foo: { bar: :baz } } }

let(:view) { described_class.new(config, view_context) }

Expand Down Expand Up @@ -41,12 +41,12 @@
expect(dependency_tracker).to receive(:bounce).with(config, attributes: [key])
end

context 'with existant key' do
context 'with existing key' do
let(:key) { :animal }
it { is_expected.to eql('donkey') }
end

context 'with non-existant key' do
context 'with non-existing key' do
let(:key) { :weapon }
it { is_expected.to eql(nil) }
end
Expand All @@ -57,15 +57,15 @@
expect(dependency_tracker).to receive(:bounce).with(config, attributes: [key])
end

context 'with existant key' do
context 'with existing key' do
let(:key) { :animal }

subject { view.fetch(key) }

it { is_expected.to eql('donkey') }
end

context 'with non-existant key' do
context 'with non-existing key' do
let(:key) { :weapon }

context 'with fallback' do
Expand Down Expand Up @@ -95,12 +95,12 @@
expect(dependency_tracker).to receive(:bounce).with(config, attributes: [key])
end

context 'with existant key' do
context 'with existing key' do
let(:key) { :animal }
it { is_expected.to eql(true) }
end

context 'with non-existant key' do
context 'with non-existing key' do
let(:key) { :weapon }
it { is_expected.to eql(false) }
end
Expand All @@ -115,7 +115,25 @@
res = []
view.each { |k, v| res << [k, v] }

expect(res).to eql([[:amount, 9000], [:animal, 'donkey']])
expect(res).to eql([[:amount, 9000], [:animal, 'donkey'], [:foo, { bar: :baz }]])
end
end

describe '#dig' do
subject { view.dig(*keys) }

before do
expect(dependency_tracker).to receive(:bounce).with(config, attributes: keys)
end

context 'with existing keys' do
let(:keys) { %i[foo bar] }
it { is_expected.to eql(:baz) }
end

context 'with non-existing keys' do
let(:keys) { %i[foo baz bar] }
it { is_expected.to eql(nil) }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer be_nil over eql(nil)

end
end

Expand Down