everett 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9a4844f265ec031ab1001d8f5600f4f5d14c005
-  data.tar.gz: 78ec39f0f8bbfc0e651c416ea7ee14a086dee58b
+  metadata.gz: 920a79c76d642ee25609e003dcac93b30a254983
+  data.tar.gz: 07f1bc61977121160a4ea199da1354b6ff8ac7e7
 SHA512:
-  metadata.gz: 40912e945e0961017752771bd31667046812b76a1de29da451c795b4dff5645beecc6a08c19e42ee0246eb7a46a15d4b25e000cec9659b99b9a7c3937b168859
-  data.tar.gz: a414083ee2f1b2604811c036a6f8a3b0c9de71e23c0d1b18de895f9bb047a9c8efe0c60b29311427a0ef5d0cbf9e878e0a6a6ce524fbb7efcf0965569a7a2120
+  metadata.gz: 14804ff35c6d5049dd8700314e2c62481d347cfacb30296f4462e263620956f9dfe38c6721beb66672b3642eb350c2c6cfa4a6d31ee048ed3551fd3969bb1876
+  data.tar.gz: 1efe1f6e2fed80ab406cad0afd187394418366daaf6edb20d365bd5e0e2cb9f99d4ee55b5fc3b882d83f54aa2f6b46ae13266027a3ae431ce10244f675e62dc1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+## [0.2.1](https://github.com/yasaichi/everett/releases/tag/v0.2.1) (December 26, 2016)
+* Improve the gem summary, description and README
+* Add CHANGELOG
+
+## [0.2.0](https://github.com/yasaichi/everett/releases/tag/v0.2.0) (December 17, 2016)
+* [Implement core classes and modules](https://github.com/yasaichi/everett/pull/1)
+* [Implement a rails generator to create the initializer](https://github.com/yasaichi/everett/pull/2)
+
+## [0.1.0](https://github.com/yasaichi/everett/releases/tag/v0.1.0) (December 10, 2016)
+* The initial release to reserve the gem name

data/README.md

@@ -4,7 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/yasaichi/everett/badges/gpa.svg)](https://codeclimate.com/github/yasaichi/everett)
 [![Test Coverage](https://codeclimate.com/github/yasaichi/everett/badges/coverage.svg)](https://codeclimate.com/github/yasaichi/everett/coverage)
 
-Everett is a simple observer for Rails 5 ActiveRecord.
+Everett is a substitute for `ActiveRecord::Observer` on Rails 5.
 
 ## Installation
 Put this in your Gemfile:
@@ -22,31 +22,32 @@ $ rails g everett:install
 They will install the initializer into `config/initializers/everett.rb`.
 
 ## Usage
+### Overview
 Observers allow you to implement trigger-like behavior outside the original classes.  
-You can put them anywhere, for example `app/observers/comment_observer.rb`:
+You can put them anywhere, for example `app/observers/contact_observer.rb`:
 
 ```ruby
-class CommentObserver < Everett::Observer
-  def after_create(comment)
-    Rails.logger.info("New comment was posted.")
+class ContactObserver < Everett::Observer
+  def after_create(contact)
+    Rails.logger.info('New contact added!')
   end
 
-  def after_destroy(comment)
-    Rails.logger.info("Comment with an id of #{comment.id} was destroyed.")
+  def after_destroy(contact)
+    Rails.logger.info("Contact with an id of #{contact.id} was destroyed!")
   end
 end
 ```
 
 This observer prints a log message when specific callbacks are triggered.
 
-Like [rails-observers](https://github.com/rails/rails-observers), the convention is to name observers after the class they observe.  
+Just like `ActiveRecord::Observer`, the convention is to name observers after the class they observe.  
 If you need to change this, or want to use one observer for several classes, use `observe`:
 
 ```ruby
 class NotificationsObserver < Everett::Observer
   observe :comment, :like
 
-  def after_create_commit(record)
+  def after_create(record)
     # notifiy users of new comment or like
   end
 end
@@ -56,9 +57,48 @@ Note that you must register observers first to activate them.
 This can be done by adding the following line into `config/initializers/everett.rb`:
 
 ```ruby
-config.observers = :comment_observer, :notifications_observer
+config.observers = :contact_observer, :notifications_observer
+```
+
+### after\_{create,update,destroy}\_commit
+Since `after_create_commit`, `after_update_commit` and `after_destroy_commit` were introduced in Rails 5,
+you can also use them in observers:
+
+```ruby
+class CommentObserver < Everett::Observer
+  def after_create_commit(comment)
+    CommentMailer.notification(comment).deliver_now
+  end
+end
+```
+
+This observer sends an email after a record has been created.
+
+## Migration from rails-observers
+Since Everett is highly compatible with `ActiveRecord::Observer`,
+you can easily migrate from [rails-observers](https://github.com/rails/rails-observers).  
+All you need to do is as follows:
+
+### 1. Replace `ActiveRecord::Observer` with `Everett::Observer`
+
+```diff
+-class ContactObserver < ActiveRecord::Observer
++class ContactObserver < Everett::Observer
 ```
 
+### 2. Register observers in `config/initializers/everett.rb`
+
+```diff
+# config/application.rb
+-config.active_record.observers = :contact_observer, :notifications_observer
+
+# config/initializers/everett.rb
++config.observers = :contact_observer, :notifications_observer
+```
+
+### 3. Check the test suite passes
+If you find any bugs, please document them on [the issues page](https://github.com/yasaichi/everett/issues).
+
 ## Contributing
 You should follow the steps below.
 

data/lib/everett/version.rb

@@ -1,3 +1,3 @@
 module Everett
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everett
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-17 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -150,13 +164,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Everett is a simple observer for Rails 5 ActiveRecord.
+description: Everett is a substitute for ActiveRecord::Observer on Rails 5.
 email:
 - yasaichi@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -194,5 +209,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Simple observer for Rails 5 ActiveRecord
+summary: Substitute for ActiveRecord::Observer on Rails 5
 test_files: []