README.md in active_mocker-1.6.2 vs README.md in active_mocker-1.6.3

- old
+ new

@@ -35,11 +35,11 @@ * [Contributing](#contributing) --------------------------- -## Documentation +## Documentation [![Inline docs](http://inch-ci.org/github/zeisler/active_mocker.png?branch=master)](http://inch-ci.org/github/zeisler/active_mocker) [rdoc](http://rdoc.info/github/zeisler/active_mocker/master/ActiveMocker) ------------------------------------------ @@ -69,15 +69,19 @@ * Requires Ruby MRI =< 2.1. ## Setup + + See [example_rails_app](https://github.com/zeisler/active_mocker/tree/master/example_rails_app) for complete setup. + + ### Generate Mocks Running this rake task builds/rebuilds the mocks. It will be ran automatically after every schema modification. If the model changes this rake task needs to be called manually. You could add a file watcher for when your models change and have it run the rake task. - rake active_mocker::build + rake active_mocker:build ## Usage #db/schema.rb @@ -252,11 +256,11 @@ PersonMock::CONSTANT_VALUE => 13 ### Scoped Methods -* As long the mock file that holds the scope method is required it will be available but implemented. +* As long the mock file that holds the scope method is required it will be available but raise an `unimplemented error` when called. ### Managing Mocks Deletes All Records for Loaded Mocks - (Useful in after(:each) to clean up state between examples) @@ -339,12 +343,12 @@ * Scale and Precision are not supported. ### Known Limitations * Model names and table names must follow the default ActiveRecord naming pattern. * Whatever associations are setup in one mock object will not be reflected in any other objects. - * There partial support for this feature coming in v1.6 when `ActiveMocker::Mock.config.experimental = true` is set. + * There's partial support for it to work more like ActiveRecord in v1.6 when `ActiveMocker::Mock.config.experimental = true` is set. When v1.7 comes out these features will be moved out of experimantal. -* Validation are not present in mocks. +* Validation/Callbacks are not present in mocks. A Work around is putting the method into a module with required ActiveSupport/ActiveModel dependencies and make sure the code is supported by the mock. * Sql queries, joins, etc will never be supported. ## Inspiration Thanks to Jeff Olfert for being my original inspiration for this project.