findologic / libflexport

FINDOLOGIC export toolkit for XML and CSV data export

MIT License

4 stars 5 forks source link

Move examples into the library to be able to instance them #108

Closed TheKeymaster closed 5 years ago

TheKeymaster commented 5 years ago

Purpose

A developer knows how to use classes in order to create examples that would help him understanding stuff. The current implementation creates a class in the same file as it uses the class. Also you can not instantiate a new object of this class as it has no namespace definitions and is therefore not autoloaded by composer.

This will be implemented as a guide for plugins where the customer needs to fetch his own product data.

Approach

Move files from /examples to src/Examples with appropriate namespace.

Open Questions and Pre-Merge TODOs

[x] composer lint and composer fix was executed.
[ ] Tests were written and pass with 100% coverage.
[x] ~~A issue with a detailed explanation of the problem/enhancement was created and linked.~~ Not really relevant.

codecov-io commented 5 years ago

Codecov Report

Merging #108 into develop will not change coverage. The diff coverage is n/a.

@@           Coverage Diff            @@
##             develop   #108   +/-   ##
========================================
  Coverage        100%   100%           
  Complexity       265    265           
========================================
  Files             49     49           
  Lines            694    694           
========================================
  Hits             694    694

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 71d0eb9...3b832f0. Read the comment docs.

howard commented 5 years ago

@TheKeymaster I don't exactly understand the purpose of this change. All it looks like to me is examples being mixed with the actual library, which could create the misleading impression that the examples are part of the library. Not only is this misleading, if we're being string, we'll have to consider the examples part of our external API then and keep them as stable as the actual library.

TheKeymaster commented 5 years ago

Closing this PR as discussed in person.