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

Fix config.log_silently? #324

Merged
merged 3 commits into from
Apr 12, 2016
Merged

Fix config.log_silently? #324

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0fa5ba
fix log_silently config
Mar 8, 2016
8334328
fix bool
Mar 8, 2016
7bc2054
add comment
Mar 8, 2016
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
2 changes: 1 addition & 1 deletion lib/asset_sync/config.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def fail_silently?
end

def log_silently?
ENV['RAILS_GROUPS'] == 'assets' || self.log_silently == false
ENV['RAILS_GROUPS'] == 'assets' || !!self.log_silently
Copy link
Member

Choose a reason for hiding this comment

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

Should we consider nil as false?
I know the default value is true, but if someone accidentally assigned nil to that attribute
Should we throw warning or something?

Copy link
Author

Choose a reason for hiding this comment

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

Maybe if we warned on nil elsewhere in handling the config options? For something as benign as logging, casting nil to false is probably OK :)

Copy link
Member

Choose a reason for hiding this comment

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

OK let's do it later (maybe until someone complains)

Copy link
Author

Choose a reason for hiding this comment

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

👍

end

def enabled?
Expand Down
11 changes: 11 additions & 0 deletions spec/unit/asset_sync_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,17 @@
it "should default log_silently to true" do
expect(AssetSync.config.log_silently).to be_truthy
end

it "log_silently? should reflect the configuration" do
AssetSync.config.log_silently = false
expect(AssetSync.config.log_silently?).to eq(false)
end

it "log_silently? should always be true if ENV['RAILS_GROUPS'] == 'assets'" do
AssetSync.config.log_silently = false
expect(ENV).to receive(:[]).with('RAILS_GROUPS').and_return('assets')
Copy link
Member

Choose a reason for hiding this comment

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

I think it should be allow(ENV)?
Since It looks like part of test setup to me.

If I guess it wrong please tell me what it is.

Copy link
Author

Choose a reason for hiding this comment

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

expect(ENV) has the same behavior (stubbing) as allow(ENV) but also sets up an expectation that the var will be checked in ENV. Just adds more coverage, but I can change it if you would prefer.

Copy link
Member

Choose a reason for hiding this comment

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

OK I think it's fine to have expect
But you should add a comment explaining what that line does (stub + expect)
It's easier for people to read comments than finding history => PR => Line note :)

Edit: Changed some wording

Copy link
Author

Choose a reason for hiding this comment

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

I think it is self-explanatory, but I have added a comment to be sure :)

expect(AssetSync.config.log_silently?).to eq(true)
end

it "should default cdn_distribution_id to nil" do
expect(AssetSync.config.cdn_distribution_id).to be_nil
Expand Down