Hide Private headers and LocalCache.hh

[ahcorde]

This PR is related with these issues: #44 and #29

Private headers and LocalCache.hh moved to the src folder.

Signed-off-by: ahcorde [email protected]

[scpeters]

I think we can remove the following exclusion in the include folder's CMakeLists.txt:

• https://github.com/ignitionrobotics/ign-fuel-tools/blob/master/include/ignition/fuel_tools/CMakeLists.txt#L3

[codecov]

Codecov Report

Merging #109 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #109   +/-   ##
=======================================
  Coverage   76.23%   76.23%           
=======================================
  Files          19       19           
  Lines        2554     2554           
=======================================
  Hits         1947     1947           
  Misses        607      607           

Impacted Files	Coverage Δ
src/FuelClient.cc	65.85% <ø> (ø)
src/LocalCache.cc	80.12% <ø> (ø)
src/Model.cc	87.50% <ø> (ø)
src/ModelIter.cc	100.00% <ø> (ø)
src/WorldIter.cc	91.01% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4e6f2f1...3aa0644. Read the comment docs.

[chapulina]

I think we should tick-tock the headers that were being installed, because there may be users counting on them. That would be ModelIterPrivate, ModelPrivate and LocalCache.

The process would be:

• Dome: add IGN_DEPRECATED to all constructors and static functions of the classes to be removed
• Ign-E: Move the headers to src

[chapulina]

Just checking @scpeters and @nkoenig - your approvals mean you don't think a tick-tock cycle is needed? I could agree with that for the Private classes, but I really think we should tick-tock the LocalCache.

[scpeters]

Just checking @scpeters and @nkoenig - your approvals mean you don't think a tick-tock cycle is needed? I could agree with that for the Private classes, but I really think we should tick-tock the LocalCache.

it was a lazy review on my part. I think tick-tocking is probably right for LocalCache, but since it's targeted at the next major version, I think the Private header files could just be removed

[ahcorde]

I'm fine doing this:

• Dome: add IGN_DEPRECATED to all constructors and static functions of the classes to be removed
• Ign-E: Move the headers to src

But I have a question @chapulina. Right now the collection-dome.yaml is pointing to master, which means there is no difference right now between Dome and ign-E.

• Should we wait until a tag for ign-fuel-tools in Dome (ign-fuel-tools5) is created ?
• Which other way to proceed ?

[chapulina]

no difference right now between Dome and ign-E.

Yup, you're right. What we usually do is add the deprecations now, and once we branch ign-fuel-tools5 off of master, we bump master's version and also remove the deprecated functions.

[ahcorde]

Deprecated LocalCache constructor. The other headers are moved to src

[chapulina]

Can you fix the conflicts, @ahcorde ? Then if CI is clear this LGTM.

[ahcorde]

Done @chapulina ;)

[chapulina]

We should suppress the deprecation warnings caused by LocalCache. Here's an example of how we usually do it.

Also, please add a 4.X to 5.X section to Migration.md with a note that the Private classes are no longer installed and the LocalCache is deprecated.

[chapulina]

@osrf-jenkins run tests por favor