Set up an area for the enhanced 1.2.x interface.

Comcast / sirius

A distributed system library for managing application reference data

http://comcast.github.io/sirius/

Apache License 2.0

298 stars 49 forks source link

Set up an area for the enhanced 1.2.x interface. #27

Closed comcast-jonm closed 10 years ago

comcast-jonm commented 10 years ago

This creates a new package specifically for the 1.2 interface. The idea is that we could collect interface enhancements in similar packages as we go on.
Deprecated the old Sirius (1.1.x) interface.

Discussion questions:

What else should go into this package? Ideally this should be everything that a client would need to interact with.
What do you think of creating a versioned package like this?
Is the package in the right place?
Does the package need a package.html (or whatever the ScalaDoc equivalent is)?
I suspect we will find we want classes like Sirius1Dot2Impl that are essentially interface adapters to a single SiriusImpl. One complicating factor is that SiriusImpl is a "public" class in 1.1.x because the SiriusFactory returns it. So probably the single, private core class needs a different name (SiriusFacade?).

References:

PRs #21 and #23 are related.
Issues #8, #11, #17, #19, and #25.

smuir commented 10 years ago

This looks like the right general approach, I'm not familiar enough with explicitly versioned APIs in Java/Scala to know if there's anything non-standard about this. One question about packages though: in one of the other open issues we seemed to settle on the top-level class (sirius) being the home for the public API classes, so maybe this should come under there, not under api.

smuir commented 10 years ago

I'm not sure what is the best way to share some code that builds on this to show at least the interface of the out-of-band data approach I suggested in #19. It doesn't even compile at this point, so I don't want to create a PR.

comcast-jonm commented 10 years ago

I think it's ok to create a PR, just put (DO NOT MERGE) on the subject/summary line for it. It's a fine way to get feedback and it's ok for it not to build.

Alternatively, you can push it up to a branch on your GitHub fork and just point us to it.

smuir commented 10 years ago

Okay, I pushed it to branch sirius1dot2_tagged on my fork, and based it off of the @jonm-comcast sirius1dot2 changes. The commit history is a mess because I inadvertently incorporated some of my SiriusFactory changes, but the actual diffs vs the sirius1dot2 tree look correct.

comcast-jonm commented 10 years ago

This PR is a prerequisite for #21, but we released 1.2.0 before this got in. I think I need to revise this and:

create the Sirius1Dot3 interface, as otherwise described
update trunk version number to 1.3.0-SNAPSHOT

Does that sound right?

smuir commented 10 years ago

Yes, I think that's the correct course of action

comcast-jonm commented 10 years ago

I'm going to close this PR because it was generated from a lost repository that existed prior to making this repository public; also it needs to be revisited anyway since we've already released 1.2.x.