try to fix the declared with not given

[zysend]

No description provided.

[zysend]

try to fix #2275

puts declared(params)
puts declared(params, include_missing: false)
puts declared(params, include_missing: false, include_not_dependent: false)

case 1,2

params

{"device_config":{"rtsp":"fake_rtsp", "number":"fake_rtsp"}}

result

{"device_type"=>nil, "device_config"=>{"number"=>"fake_rtsp"}}
{"device_config"=>{"number"=>"fake_rtsp"}}
{}

case 3

params

{"device_type": "type1","device_config":{"rtsp":"fake_rtsp", "number":"fake_rtsp"}}

result

{"device_type"=>"type1", "device_config"=>{"number"=>"fake_rtsp"}}
{"device_type"=>"type1", "device_config"=>{"number"=>"fake_rtsp"}}
{"device_type"=>"type1", "device_config"=>{"rtsp"=>"fake_rtsp"}}

[dblock]

This is great, albeit a bit complicated. I don't have anything better to suggest, but consider some refactoring to make it a bit cleaner/better organized/.

• I think include_not_dependent should be called something else, what exactly does it do? exclude anything that is not given (given is evaluated?) or anything that's inside any given block? So maybe evaluate_given or just given: true/false?
• Will nested given work? Let's add some tests/open some more bugs?
• This needs documentation, and CHANGELOG.

[zysend]

Thanks for your advice.

• include_not_dependent is not logical and readable，so I choose the evaluate_given.

• My previous tests covered too few cases, so I added more tests.
  Then I found a bug on the declared_params_with_scope and I think again if the way is really organized.
  Finally, I choose a new binding way between the attr and scope instand of the attrs and scope.
  The new way is cleaner, but maybe unsafely(changes declared_params directly) and slowly(A scope may run meets_dependency? many times).

[zysend]

• Added documentation, and CHANGELOG.

[dblock]

Code looks good, some minor stuff below. Let's work on the documentation.

Regarding performance: this is only a problem when calling declared(params), right? So there's no regression during execution in most cases, so I am not worried. Let me know if I misunderstood.

[zysend]

I changed the structure of @declared_params, it will be initialized when api is initialized and only used when #declared(params) is called.
if you do not set decared_params_scope=false when using #declared(params), @declared_params will behave the same as the old data structure.

Thanks for the review, I will revise it soon.

[zysend]

I revised the docs and modified the default value of evaluate_given(evaluate_given: false means that it does not evaluate given and will return all declared_params).

[dblock]

Looks great! Let's fix the English a little in README and this is good to go!

[zysend]

Great advise and I have changed these.

[dblock]

I merged the change, thanks for contributing @zysend !

[zysend]

Thanks for your advise.