everett 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2020c2867e74578114203161f55406734f7de0c1
-  data.tar.gz: 10a86170f32232631d56b5422032501019e3afa4
+  metadata.gz: 76ba4a01771b029f28c60867e66b3068f99753df
+  data.tar.gz: 04db4ea215cf000b6c3dd4ad46fb53a23050e4d7
 SHA512:
-  metadata.gz: ef55d9c3d72f24c36ca2dd6ab634c30f94b57647ff9e46a590f4c17375f3d405f3994adda4d1d8ed5b6e10017d8c61e74c5a1c7c1ec4fe75f450d7bc0f5dc399
-  data.tar.gz: 2d93e2ead15ba80352d72734cdb52a4ea06a5119308b576ae93f3af96f664f0e613992a58e42aa3c68633edf85a2e06539e6749821acca2eae1f103e3f82ef94
+  metadata.gz: bbd0e301693328ff85c1e3a26c18e0ffde43dec2926590f84c87b6c667095723e19721a8984f1d78dff52d7b56e1bd88e73ac1eb480c02068a31413110b993f8
+  data.tar.gz: b7d672ae6882bc1983b1637ee2e94b25c06dfd0d43715c2bf62917d10b22c01cbd7d8cf95785b7e25ef94aef8a42c2f78949f9006bb3ac0ccf02c3b17bed37a2

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # CHANGELOG
+## [0.3.0](https://github.com/yasaichi/everett/releases/tag/v0.3.0) (May 4, 2017)
+* [Implement generators to create a new observer and its test](https://github.com/yasaichi/everett/pull/5)
+
 ## [0.2.2](https://github.com/yasaichi/everett/releases/tag/v0.2.2) (December 27, 2016)
 * [Fix bug of after\_{create,update,destroy}\_commit callbacks](https://github.com/yasaichi/everett/pull/3)
 * Minor fix on README

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 yasaichi
+Copyright 2016 Yuichi Goto
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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 substitute for `ActiveRecord::Observer` on Rails 5.
+Everett is a substitute for Active Record Observer on Rails 5.
 
 ## Installation
 Put this in your Gemfile:
@@ -29,18 +29,18 @@ You can put them anywhere, for example `app/observers/contact_observer.rb`:
 ```ruby
 class ContactObserver < Everett::Observer
   def after_create(contact)
-    Rails.logger.info('New contact added!')
+    Rails.logger.info('New contact has been added!')
   end
 
   def after_destroy(contact)
-    Rails.logger.info("Contact with an id of #{contact.id} was destroyed!")
+    Rails.logger.info("Contact with an id of #{contact.id} has been destroyed!")
   end
 end
 ```
 
 This observer prints a log message when specific callbacks are triggered.
 
-Just like `ActiveRecord::Observer`, the convention is to name observers after the class they observe.  
+Just like Active Record 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
@@ -75,7 +75,7 @@ end
 This observer sends an email after a record has been created.
 
 ## Migration from rails-observers
-Since Everett is highly compatible with `ActiveRecord::Observer`,
+Since Everett is highly compatible with Active Record Observer,
 you can easily migrate from [rails-observers](https://github.com/rails/rails-observers).  
 All you need to do is as follows:
 
@@ -104,7 +104,7 @@ You should follow the steps below.
 
 1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
 2. Create a feature branch: `git checkout -b add-new-feature`
-3. Commit your changes: `git commit -am 'add new feature'`
+3. Commit your changes: `git commit -am 'Add new feature'`
 4. Push the branch: `git push origin add-new-feature`
 4. [Send us a pull request](https://help.github.com/articles/about-pull-requests/)
 

data/lib/everett/version.rb

@@ -1,3 +1,3 @@
 module Everett
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/generators/everett/install/USAGE

@@ -1,8 +1,8 @@
 Description:
-    Create a Everett initializer
+    Creates an Everett initializer.
 
 Example:
-    rails generate everett:install
+    `rails generate everett:install`
 
     This will create:
         config/initializers/everett.rb

data/lib/generators/everett/install/install_generator.rb

@@ -1,7 +1,9 @@
+require "rails/generators/base"
+
 module Everett
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root ::File.expand_path("../templates", __FILE__)
 
       def copy_initializer_file
         template "everett.rb", "config/initializers/everett.rb"

data/lib/generators/rails/observer/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Stubs out a new observer. Pass the observer name, either CamelCased or
+    under_scored, as an argument.
+
+Example:
+    `rails generate observer Account`
+
+    This will create:
+        app/models/account_observer.rb
+        test/unit/account_observer_test.rb (as needed)

data/lib/generators/rails/observer/observer_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators/named_base"
+
+module Rails
+  module Generators
+    class ObserverGenerator < ::Rails::Generators::NamedBase
+      check_class_collision suffix: "Observer"
+      source_root ::File.expand_path("../templates", __FILE__)
+
+      def create_observer_file
+        destination = ::File.join("app/models", class_path, "#{file_name}_observer.rb")
+        template "observer.rb.erb", destination
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/rails/observer/templates/observer.rb.erb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Observer < Everett::Observer
+end
+<% end -%>

data/lib/generators/test_unit/observer/observer_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators/test_unit"
+
+module TestUnit
+  module Generators
+    class ObserverGenerator < ::TestUnit::Generators::Base
+      check_class_collision suffix: "ObserverTest"
+      source_root ::File.expand_path("../templates", __FILE__)
+
+      def create_test_file
+        destination = ::File.join("test/unit", class_path, "#{file_name}_observer_test.rb")
+        template "observer_test.rb.erb", destination
+      end
+    end
+  end
+end

data/lib/generators/test_unit/observer/templates/observer_test.rb.erb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+<% module_namespacing do -%>
+class <%= class_name %>ObserverTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+<% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everett
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Everett is a substitute for ActiveRecord::Observer on Rails 5.
+description: Everett is a substitute for Active Record Observer on Rails 5.
 email:
 - yasaichi@users.noreply.github.com
 executables: []
@@ -185,6 +199,11 @@ files:
 - lib/generators/everett/install/USAGE
 - lib/generators/everett/install/install_generator.rb
 - lib/generators/everett/install/templates/everett.rb
+- lib/generators/rails/observer/USAGE
+- lib/generators/rails/observer/observer_generator.rb
+- lib/generators/rails/observer/templates/observer.rb.erb
+- lib/generators/test_unit/observer/observer_generator.rb
+- lib/generators/test_unit/observer/templates/observer_test.rb.erb
 - lib/tasks/everett_tasks.rake
 homepage: https://github.com/yasaichi/everett
 licenses:
@@ -209,5 +228,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Substitute for ActiveRecord::Observer on Rails 5
+summary: Substitute for Active Record Observer on Rails 5
 test_files: []