README.md in best_boy-2.0.3 vs README.md in best_boy-2.1.0

- old
+ new

@@ -8,11 +8,11 @@ What does this gem do? ---------------------- -best_boy logs "create" and "delete" events as well as custom events triggered in controller actions. It uses an own polimorphic database table to log each event. +best_boy logs "create" and "delete" events as well as custom events triggered by controller actions. It uses its own polymorphic database table to log each event. At the moment, best_boy only provides support for ActiveRecord models. Rails version support ---------------------- @@ -57,10 +57,21 @@ Run the migration rake db:migrate +Changelog +--------- +#### 2.1.0 +* Code cleanup - now compatible with RSpec 3 syntax +* Support a "dry-run" test mode +* Reduce public methods added by `BestBoy::Eventable` ([#4](https://github.com/Absolventa/best_boy/issues/4)) +* Remove mass-assignments that could cause problems with the protected_attributes gem [#8](https://github.com/Absolventa/best_boy/issues/8) +* Do not expose mixed-in controller method ([#9](https://github.com/Absolventa/best_boy/issues/9))) +* Avoid potential callbacks for callbacks switch ([#10](https://github.com/Absolventa/best_boy/issues/10)) + + Update in Version 2 -------------------------------- From Version 2.x on BestBoy uses aggregated tables for the admin panel. You need to copy the new migrations to your app by running @@ -105,11 +116,29 @@ This will log custom events for a object and a event phrase. You can specify this event with a event_source parameter to log maybe seperate create actions. If no Object is given, it will raise an exception as well as if no event is provided. +#### Test mode +BestBoy features a sandbox mode for your testing environment from version 2.1 onward. It will prevent the creation of BestBoy records. Activate it in your spec_helper.rb or test_helper.rb globally: + + BestBoy.test_mode = true + +If you want to test your BestBoy integration, you can run your code like this: + + BestBoy.in_real_mode do + # your expectations / asserts + end + +Conversely, you can also sandbox a specific code block: + + BestBoy.in_test_mode do + # database will be spared + end + + BestBoyEvent table ------------------ t.integer "owner_id" # owner model id t.string "owner_type" # owner model class type @@ -163,27 +192,25 @@ The latter would destroy and recover the all reports created after beginning of Feb 1st, 2010 up to now. Budget some time for this task, since it can take long if your BestBoyEvent table has grown very big. -Used gems and resource ----------------------- -[Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4 +Used gems and resources +----------------------- +* [Twitter Bootstrap](http://twitter.github.com/bootstrap/) in its version 2.0.4 +* [Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style +* [Winston Teo Yong Wei](https://github.com/winston/google_visualr) Google_Visualr in its version 2.1.2 -[Stefan Petre](http://www.eyecon.ro/bootstrap-datepicker) for Datepicker in Twitter Bootstrap style -[Winston Teo Yong Wei](https://github.com/winston/google_visualr) Google_Visualr in its version 2.1.2 - - Contributors in alphabetic order -------------------------------- -@cseydel -@danscho -@neumanrq +* [carpodaster](https://github.com/carpodaster) +* [cseydel](https://github.com/cseydel) +* [danscho](https://github.com/danscho) +* [neumannrq](https://github.com/neumannrq) Thanks ------ -We are extremely grateful to everyone contributing to this project. -Big thanks to each contributor on Impressionist. This gem helped me a long way to get here in modelling and creating a gem. +We ♥ PRs – thanks to everyone contributing to this project. Big thanks to each contributor on Impressionist. This gem helped me ([cseydel](https://github.com/cseydel)) a long way to get here in modelling and creating a gem. -See LICENSE.txt for details on licenses. +See [LICENSE.txt](https://raw.github.com/Absolventa/best_boy/master/LICENSE.txt) for usage and licensing details.