Merge pull request #52 from levibostian/development

0.2.0-alpha release

CHANGELOG.md

@@ -1,3 +1,21 @@
+## [0.2.0-alpha] - 2019-03-15
+
+Testing utilities and improved API for CacheState objects!
+
+### Changed
+- **Breaking Change** The `deliver_()` functions in `OnlineCacheState` and `LocalCacheState` have been replaced with a more Kotlin like callback API with lambdas. [47](https://github.com/levibostian/Teller-Android/issues/47)
+- Remove Java close compatibility. Because Kotlin and Java work nicely together, Teller may still work nicely with Java, but Teller is no longer focusing on making sure that is the case. [46](https://github.com/levibostian/Teller-Android/issues/46)
+- Expose public properties to `OnlineCacheState`. 
+
+### Added 
+- Create code of conduct and add to the docs. 
+- Create set of utilities into Teller to assist in creating unit, integration, and instrumentation tests. 
+- Create section in docs on how to test with Teller in your app. 
+- Create tests in example to show examples on how to use Teller's testing utilities and to test the API as it's developed. 
+
+### Fixed
+- Fixed bug in `OnlineCacheState` where refresh calls may not call `refreshComplete()` after a fetch finished successfully. 
+
 ## [0.1.0-alpha] - 2019-02-21
 
 Changes to the API, docs, full test suite, thread safety and bug fixes.

CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at levi@curiosityio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

Dangerfile

@@ -12,13 +12,13 @@ end
 
 if github.branch_for_base == "master"
   if github.pr_body.include? "#non-release"
-    if !git.modified_files.include? "teller/*"
-      warn 'You edited some files in `teller/`. Are you sure this is a #non-release?'
+    if !git.modified_files.include? "teller-android/*"
+      warn 'You edited some files in `teller-android/`. Are you sure this is a #non-release?'
     end    
   else
     if !git.modified_files.include? "CHANGELOG.md"
       fail 'You need to edit the CHANGELOG.md file.'
     end
-    android_version_change.assert_version_name_changed("teller/build.gradle")
+    android_version_change.assert_version_name_changed("teller-android/build.gradle")
   end
 end

README.md

@@ -1,6 +1,7 @@
 [![Download](https://api.bintray.com/packages/levibostian/Teller-Android/com.levibostian.teller-android/images/download.svg) ](https://bintray.com/levibostian/Teller-Android/com.levibostian.teller-android/_latestVersion)
 [![Build](https://app.bitrise.io/app/4c0b872bdaf76300/status.svg?token=PYpJBThARi6LvucXS2noVw&branch=development)](https://app.bitrise.io/app/4c0b872bdaf76300)
 [![GitHub license](https://img.shields.io/github/license/levibostian/Teller-Android.svg)](https://github.com/levibostian/Teller-Android/blob/master/LICENSE)
+[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/JStumpp/awesome-android/blob/master/readme.md#other)
 
 # Teller
 
@@ -47,7 +48,7 @@ However, with Teller this pain goes away. By using Teller you will get the benef
 Here are some more benefits of Teller:
 
 * Small - The only dependency at this time is RxJava2 ([this issue is working to make it optional](https://github.com/levibostian/Teller-Android/issues/1))
-* Built in Kotlin, for Kotlin (also compatible with Java)
+* Built in Kotlin, for Kotlin
 * Not opinionated. Use any storage method you wish
 * Paging *just works*
 * Full test suite, full documentation
@@ -63,3 +64,22 @@ The very detailed documentation for Teller can be found [here](http://levibostia
 * Levi Bostian - [GitHub](https://github.com/levibostian), [Twitter](https://twitter.com/levibostian), [Website/blog](http://levibostian.com)
 
 ![Levi Bostian image](https://gravatar.com/avatar/22355580305146b21508c74ff6b44bc5?s=250)
+
+## Contribute
+
+Do you think Teller is cool? Want to help make it *more cool*? Great! We can use your help.
+
+Open source isn't just writing code. Teller could use your help with any of the
+following:
+
+- Finding (and reporting!) bugs.
+- New feature suggestions.
+- Answering questions on issues.
+- Documentation improvements.
+- Reviewing pull requests.
+- Helping to manage issue priorities.
+- Fixing bugs/new features.
+
+The Teller community is a very positive one, and the maintainers are committed to keeping things awesome. Like [in over 230,000+ other communities](https://github.com/search?l=Markdown&q=%22Contributor+Covenant%22+fork%3Afalse&type=Code), always assume positive intent; even if a comment sounds mean-spirited, give the person the benefit of the doubt.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by [its terms](https://github.com/levibostian/Teller-Android/blob/master/CODE_OF_CONDUCT.md).