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.

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

Bring Parable to 1.0.0 #27

Merged
merged 86 commits into from
Feb 4, 2018
Merged

Bring Parable to 1.0.0 #27

merged 86 commits into from
Feb 4, 2018

Conversation

devvoh
Copy link
Owner

@devvoh devvoh commented Nov 23, 2017

Things to do:

  • Make sure all components are under test 100% without relying on any surrounding piece of code, especially Framework.
  • Update in-package documentation:
    • Update README.md to read like a 1.0.0 release and including examples of current use.
    • Add a CONTRIBUTING.md file to explain how to contribute and that not every suggestion will make the cut.
    • Update CHANGELOG.md to 1.0.0 final.
  • Create Parable Documentation 'site'
    • Build ParaDoc (working title) to simply generate a documentation site, using Parable itself as a base.
    • Write the documentation articles.
      • Installation
      • Introduction
      • Using Parable
        • Overview
        • ...the rest
    • Put it online at https://devvoh.com/parable/docs
  • Parable website
    • Make https://devvoh.com/parable redirect to the github repo for now.
    • Set up a simple introductory website with download, documentation and github links.
    • Remove the redirect

Optional:

@devvoh devvoh added this to the 1.0.0 milestone Nov 23, 2017
@devvoh devvoh self-assigned this Nov 23, 2017
@devvoh
Copy link
Owner Author

devvoh commented Nov 23, 2017

Yo, @caelaris, @jerry1970, @dmvdbrugge, @RickWong and @FaaPz!

Tagging y'all since I know you guys well enough to directly ask for feedback. So here goes.

I'd add some of you as reviewers, but that includes providing repo Collaborator access and that's a little far for my tastes 😉

Feedback on these changes would be much appreciated! I'll be working on and off the next month on the check list, but if there's anything you feel strongly about so far, let me know 🙂

Note: this includes meta-things outside of code changes, general things about releasing a 1.0.0 that you would prefer to see go along with it.

@RickWong
Copy link

😎🎉⚡️ nice

@jerry1970
Copy link
Contributor

Congrats! 🎉

@devvoh
Copy link
Owner Author

devvoh commented Nov 23, 2017

It's not a release yet, @jerry1970 😉

I created this PR mostly because I'd like to finally do all those things I haven't had to worry about while pre-releasing this thing for years 😂

@devvoh
Copy link
Owner Author

devvoh commented Nov 23, 2017

Looking for:

  • Examples of "good" documentation (looking at both tone and technical depth to go into)
  • Any suggestions to limit inconsistencies in how the components work.
  • Any suggestions for missing functionality (but try to limit it to not extending the scope of Parable by suggesting).

Etcetera. Anything you can think of, this is the moment to let it all out!

Man, this can't go wrong 😅

@@ -8,7 +8,7 @@ class Hook
protected $hooks = [];

/**
* Add hook referencing $closure to $event, returns false if $callable isn't a function
* Add hook referencing $closure to $event, returns false if $callable isn't a function.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the second half of this comment needs a rewrite, because in no way it returns false.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Agreed. Good find, will go through comments and try to catch all these mismatches 👍

const HOOK_INIT_DATABASE_AFTER = "parable_init_database_after";
const PARABLE_VERSION = '1.0.0';

const HOOK_HTTP_404 = "parable_http_404";
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't these be either alphabetical or in the exact order they're called? (Assuming whatever document generator you'll be using doesn't do that, if it does then forget it.)

Copy link
Owner Author

Choose a reason for hiding this comment

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

Honestly I'm pretty sure there is logic behind this madness, but I can't come up with it. That means I'll make this look prettier ;)

Copy link
Owner Author

Choose a reason for hiding this comment

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

I've re-ordered them mostly alphabetically, but I've kept the before/during/after order in there was well.


echo str_repeat(PHP_EOL, $count);
return $this;
}

/**
* Move the cursor forward by $characters places and reset the lineLength.
Copy link
Contributor

Choose a reason for hiding this comment

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

You can remove the and reset the lineLength here and all the other places, now that lineLength is gone.
Should be replaced with and disables line clearing in the places (not this one) where it does.

@devvoh
Copy link
Owner Author

devvoh commented Nov 27, 2017

Merged in @dmvdbrugge's PR #29 for dynamic return types plugin for phpstorm.

devvoh and others added 29 commits December 8, 2017 17:54
- Check if posix_isatty function exists before calling
- Get terminal width and height for Windows (both cmd and shell)
Also constants for defaults.
See new test, dp-testcases with index 5, 6, 7, and 9 fail without these changes.
Fix getOption() and getProvidedValue() for they break on falsy values.
Break the routes and then unbreak them again.
@devvoh devvoh merged commit da0a632 into master Feb 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants