paper_boy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e7a9c1d5184e6ac88469259ccc656fd8703b57d767e1f6f67d257f8b0ce6bb
-  data.tar.gz: da636ce15158cd085ee5ce04971c15cd7dcdb1a51cdc278fbbbc0ffc6515e51b
+  metadata.gz: 322f3a888b5ba1d4ed7720523a4e76fc9594a029c0a8b4f3b2c621764398b911
+  data.tar.gz: 1ccec0f8a25f2ff682fc00576a5983ff2ea6ac87b3972e3dd57313c159420332
 SHA512:
-  metadata.gz: 14b26e13ceb4ff52152837905ed23596d7927d9a9bc415bb994e4c26cf547f6643d8023c4a23a0d7f7fd37248a4200523c4493d4a25c3a629315e47ff40a65b5
-  data.tar.gz: bf8f0cdd38b4e0dff0f8f94964a0d5ac0865df9c841153f8d65a08aa2ea3e4a2d833849de350393d70962751d32ba9122ac9a5150601efa19fe8455c7c28752c
+  metadata.gz: cc94274907490e08b575cbd24cc330126011605d6636584c87fb185961cec5e14712d60cf30ff28e8ab5d634b02060f432c413bb16a39dcc4d081aed85e293d3
+  data.tar.gz: 78798241e5dc8fd247ec1229b9f74b3f3470eed16bbf7910cde2e263f3233b48ea6424100e3b5694226a7803dde43df509f76ed4889f54f5090adfca626315c2

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -1,6 +1,6 @@
 # PaperBoy
 
-Automatically deliver notifications to subscribers from controllers.
+Automatically deliver notifications to subscribers from controllers (lightweight mixin using `ActiveSupport::Notifications`)
 
 ## Installation
 
@@ -22,7 +22,7 @@ Or install it yourself as:
 
 At first, execute install command:
 
-    $ bin/rails generate paper_boy:install
+    $ bin/rails g paper_boy:install
 
 Include `PaperBoy` in `ApplicationController`:
 
@@ -36,7 +36,7 @@ And you generate subscriber class with generator command:
 
     $ bin/rails g paper_boy:subscriber
 
-Then you implement subscriber class:
+Then you implement `app/subscribers/users_subscriber.rb`:
 
 ```ruby
 class UsersSubscriber < ApplicationSubscriber
@@ -46,7 +46,8 @@ class UsersSubscriber < ApplicationSubscriber
     # All instance variables are set from controller class.
     user = payload[:current_user]
 
-    # implement something (mailer, slack notifier ...etc)
+    # implement something (mailer, notifier, logger ...etc)
+    logger.info user
   end
 
   attach_to :"users"

data/lib/generators/paper_boy/install/templates/application_subscriber.rb.tt

@@ -1,2 +1,2 @@
-class ApplicationSubscriber < ActiveSupport::Subscriber
+class ApplicationSubscriber < PaperBoy::Subscriber::Base
 end

data/lib/generators/rails/subscriber/templates/subscriber.rb.tt

@@ -4,6 +4,6 @@ class <%= class_name %>Subscriber < ApplicationSubscriber
   #   payload = event.payload
   # end
 
-  attach_to :"<%= plural_name %>"
+  attach_to :"<%= class_name.underscore %>"
 end
 <% end -%>

data/lib/paper_boy.rb

@@ -2,29 +2,12 @@
 
 require "active_support/concern"
 require "paper_boy/railtie" if defined?(Rails)
+require "paper_boy/subscriber"
 require "paper_boy/version"
 
 module PaperBoy
   extend ActiveSupport::Concern
 
-  IGNORE_IVARS = %w[
-    @_action_has_layout
-    @_routes
-    @_request
-    @_response
-    @_lookup_context
-    @_action_name
-    @_response_body
-    @marked_for_same_origin_verification
-    @_config
-    @_db_runtime
-    @_view_context_class
-    @_view_renderer
-    @_url_options
-    @_view_runtime
-    @_params
-  ]
-
   included do
     after_action :paper_boy_deliver!
   end
@@ -41,8 +24,16 @@ module PaperBoy
 
     def paper_boy_context
       instance_variable_names.each_with_object({}) do |name, payload|
-        next if IGNORE_IVARS.include?(name)
+        next if ignore_ivars.include?(name)
         payload[name.sub(/\A@_?/, "")] = instance_variable_get(name)
       end.compact
     end
+
+    def ignore_ivars
+      Rails.application.config.paper_boy.ignore_ivars - skip_ignore_ivars
+    end
+
+    def skip_ignore_ivars
+      Rails.application.config.paper_boy.skip_ignore_ivars
+    end
 end

data/lib/paper_boy/railtie.rb

@@ -13,6 +13,26 @@ end
 
 module PaperBoy
   class Railtie < Rails::Railtie
+    config.paper_boy = ActiveSupport::OrderedOptions.new
+    config.paper_boy.ignore_ivars = %w[
+      @_action_has_layout
+      @_routes
+      @_request
+      @_response
+      @_lookup_context
+      @_action_name
+      @_response_body
+      @marked_for_same_origin_verification
+      @_config
+      @_db_runtime
+      @_view_context_class
+      @_view_renderer
+      @_url_options
+      @_view_runtime
+      @_params
+    ]
+    config.paper_boy.skip_ignore_ivars = []
+
     config.after_initialize do |app|
       app.config.paths.add 'app/subscribers', eager_load: true, glob: "**/*_subscriber.rb"
     end

data/lib/paper_boy/subscriber.rb

@@ -0,0 +1,13 @@
+require "active_support/subscriber"
+
+module PaperBoy
+  module Subscriber
+    class Base < ActiveSupport::Subscriber
+      include ActiveSupport::Rescuable
+
+      def logger
+        Rails.logger
+      end
+    end
+  end
+end

data/lib/paper_boy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaperBoy
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_boy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yoshiyuki Hirano
@@ -21,7 +21,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -40,6 +39,7 @@ files:
 - lib/generators/test_unit/templates/subscriber_test.rb.tt
 - lib/paper_boy.rb
 - lib/paper_boy/railtie.rb
+- lib/paper_boy/subscriber.rb
 - lib/paper_boy/version.rb
 - paper_boy.gemspec
 homepage: https://github.com/yhirano55/paper_boy

data/Gemfile.lock

@@ -1,34 +0,0 @@
-PATH
-  remote: .
-  specs:
-    paper_boy (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  paper_boy!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.1