paper_boy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07e7a9c1d5184e6ac88469259ccc656fd8703b57d767e1f6f67d257f8b0ce6bb
+  data.tar.gz: da636ce15158cd085ee5ce04971c15cd7dcdb1a51cdc278fbbbc0ffc6515e51b
+SHA512:
+  metadata.gz: 14b26e13ceb4ff52152837905ed23596d7927d9a9bc415bb994e4c26cf547f6643d8023c4a23a0d7f7fd37248a4200523c4493d4a25c3a629315e47ff40a65b5
+  data.tar.gz: bf8f0cdd38b4e0dff0f8f94964a0d5ac0865df9c841153f8d65a08aa2ea3e4a2d833849de350393d70962751d32ba9122ac9a5150601efa19fe8455c7c28752c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+gemspec
+
+gem "rake", "~> 10.0"
+
+group :test do
+  gem "rspec", "~> 3.0"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yoshiyuki Hirano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# PaperBoy
+
+Automatically deliver notifications to subscribers from controllers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paper_boy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paper_boy
+
+## Usage
+
+At first, execute install command:
+
+    $ bin/rails generate paper_boy:install
+
+Include `PaperBoy` in `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include PaperBoy
+end
+```
+
+And you generate subscriber class with generator command:
+
+    $ bin/rails g paper_boy:subscriber
+
+Then you implement subscriber class:
+
+```ruby
+class UsersSubscriber < ApplicationSubscriber
+  def create(event)
+    payload = event.payload
+
+    # All instance variables are set from controller class.
+    user = payload[:current_user]
+
+    # implement something (mailer, slack notifier ...etc)
+  end
+
+  attach_to :"users"
+end
+```
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "paper_boy"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/generators/controller_override.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+require "rails/generators/rails/controller/controller_generator"
+require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
+
+module Rails
+  module Generators
+    class ControllerGenerator
+      hook_for :subscriber, type: :boolean, default: true do |generator|
+        invoke generator, [name.pluralize]
+      end
+    end
+
+    class ScaffoldControllerGenerator
+      hook_for :subscriber, type: :boolean, default: true do |generator|
+        invoke generator, [name.pluralize]
+      end
+    end
+  end
+end

data/lib/generators/paper_boy/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an application subscriber as a starting point for your application.

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

@@ -0,0 +1,11 @@
+module PaperBoy
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_application_loyalty
+        copy_file "application_subscriber.rb.tt", "app/subscribers/application_subscriber.rb"
+      end
+    end
+  end
+end

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

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

data/lib/generators/rails/subscriber/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a subscriber for a controller with the given name.
+
+Example:
+    rails generate subscriber users
+
+    This will create:
+        app/subscribers/users_subscriber.rb

data/lib/generators/rails/subscriber/subscriber_generator.rb

@@ -0,0 +1,14 @@
+module Rails
+  module Generators
+    class SubscriberGenerator < NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "Subscriber"
+
+      def create_subscriber
+        template "subscriber.rb.tt", File.join("app/subscribers", class_path, "#{file_name}_subscriber.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+class <%= class_name %>Subscriber < ApplicationSubscriber
+  # def action(event)
+  #   payload = event.payload
+  # end
+
+  attach_to :"<%= plural_name %>"
+end
+<% end -%>

data/lib/generators/rspec/subscriber_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class SubscriberGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template 'subscriber_spec.rb.tt', File.join('spec/subscribers', class_path, "#{plural_name}_subscriber_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/subscriber_spec.rb.tt

@@ -0,0 +1,4 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>Subscriber do
+end

data/lib/generators/test_unit/subscriber_generator.rb

@@ -0,0 +1,12 @@
+module TestUnit
+  module Generators
+    class SubscriberGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "SubscriberTest"
+
+      def create_test_file
+        template 'subscriber_test.rb.tt', File.join('test/subscribers', class_path, "#{plural_name}_subscriber_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/test_unit/templates/subscriber_test.rb.tt

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= class_name %>SubscriberTest < ActiveSupport::TestCase
+end

data/lib/paper_boy/railtie.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module ActiveModel
+  class Railtie < Rails::Railtie
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      require_relative '../generators/controller_override'
+    end
+  end
+end
+
+module PaperBoy
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      app.config.paths.add 'app/subscribers', eager_load: true, glob: "**/*_subscriber.rb"
+    end
+
+    config.to_prepare do
+      Dir[Rails.root.join("app", "subscribers", "**", "*_subscriber.rb")].each { |f| require(f) }
+    end
+  end
+end

data/lib/paper_boy/version.rb

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

data/lib/paper_boy.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "paper_boy/railtie" if defined?(Rails)
+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
+
+  private
+
+    def paper_boy_deliver!
+      ActiveSupport::Notifications.instrument(paper_boy_event_name, paper_boy_context)
+    end
+
+    def paper_boy_event_name
+      "#{params[:action]}.#{params[:controller]}"
+    end
+
+    def paper_boy_context
+      instance_variable_names.each_with_object({}) do |name, payload|
+        next if IGNORE_IVARS.include?(name)
+        payload[name.sub(/\A@_?/, "")] = instance_variable_get(name)
+      end.compact
+    end
+end

data/paper_boy.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "paper_boy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "paper_boy"
+  spec.version       = PaperBoy::VERSION
+  spec.authors       = ["Yoshiyuki Hirano"]
+  spec.email         = ["yhirano@me.com"]
+  spec.summary       = %q{Automatically deliver notifications to subscribers from controllers.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/yhirano55/paper_boy"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: paper_boy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-24 00:00:00.000000000 Z
+dependencies: []
+description: Automatically deliver notifications to subscribers from controllers.
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/controller_override.rb
+- lib/generators/paper_boy/install/USAGE
+- lib/generators/paper_boy/install/install_generator.rb
+- lib/generators/paper_boy/install/templates/application_subscriber.rb.tt
+- lib/generators/rails/subscriber/USAGE
+- lib/generators/rails/subscriber/subscriber_generator.rb
+- lib/generators/rails/subscriber/templates/subscriber.rb.tt
+- lib/generators/rspec/subscriber_generator.rb
+- lib/generators/rspec/templates/subscriber_spec.rb.tt
+- lib/generators/test_unit/subscriber_generator.rb
+- lib/generators/test_unit/templates/subscriber_test.rb.tt
+- lib/paper_boy.rb
+- lib/paper_boy/railtie.rb
+- lib/paper_boy/version.rb
+- paper_boy.gemspec
+homepage: https://github.com/yhirano55/paper_boy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Automatically deliver notifications to subscribers from controllers.
+test_files: []