wisper_plus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d600365a12c2f4160ec3c6559f374ae2c085c96833677b55bf761cfac9845f1
+  data.tar.gz: 2c47e6f91ab1751ad9cb2851677d4179fc3c1a352e11ff971260cf18f4ca3aef
+SHA512:
+  metadata.gz: 5e9b0fce3f74b4d25ad1fc88d608d997584741fe41637e4c2e9e617c6fe2a8c6e3e9f1ad47ff7819a318a1e9ccdd0ee60dc017796cf48017d843640f9df0b47f
+  data.tar.gz: b8e92c159efecea5308163c7e023b38b2a9a7b76e0fa577566b4aaf9b9cddd02b18fb97d97742fbd349a1b4cc153343282271a794e26b6dd9b4230406e423dff

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.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in wisper_plus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ben Sharpe
+
+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,39 @@
+# WisperPlus
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wisper_plus`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wisper_plus'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wisper_plus
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wisper_plus.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wisper_plus"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wisper_plus/railtie.rb

@@ -0,0 +1,29 @@
+require 'rails'
+
+class WisperPlus::Railtie < Rails::Railtie
+
+  config.after_initialize do
+
+    # Link any Models to their <Model>Subscriber class
+    Dir.glob(Rails.root.join('app/models/**/*.rb').to_s) do |filename|
+      next if filename.index('/concerns/')
+      filename = filename.remove(Rails.root.join('app/models/').to_s)[0..-4]
+      klass = filename.camelize.constantize
+      next unless klass.ancestors.include?(ApplicationRecord)
+      begin
+        notifier_klass = "#{klass}Subscriber".constantize
+        klass.subscribe(notifier_klass.new, async: false)
+        if Rails.env.development?
+          puts "🔹 #{klass.to_s.magenta} #{'subscriber'.blue}"
+        end
+        if !klass.ancestors.include?(Wisper::Publisher)
+          puts "🔸 #{klass} is not including Wisper::ActiveRecord::Publisher".yellow
+        end
+      rescue NameError
+        # ignore
+      end
+    end
+
+  end
+
+end

data/lib/wisper_plus/version.rb

@@ -0,0 +1,3 @@
+module WisperPlus
+  VERSION = "0.1.0"
+end

data/lib/wisper_plus.rb

@@ -0,0 +1,89 @@
+require "wisper_plus/version"
+require 'wisper_plus/railtie'
+require 'wisper'
+
+### ACTIVERECORD SUPPORT
+module Wisper
+  module ActiveRecord
+    # ActiveRecord extension to automatically publish events for CRUD lifecycle
+    # see https://github.com/krisleech/wisper/wiki/Rails-CRUD-with-ActiveRecord
+    # see https://github.com/krisleech/wisper-activerecord
+    module Publisher
+      extend ActiveSupport::Concern
+      include Wisper::Publisher
+
+      included do
+        after_commit :broadcast_create, on: :create
+        after_commit :broadcast_update, on: :update
+        after_commit :broadcast_destroy, on: :destroy
+      end
+
+      private
+
+        # broadcast MODEL_created event to subscribed listeners
+        def broadcast_create
+          broadcast(:after_create, self)
+        end
+
+        # broadcast MODEL_updated event to subscribed listeners
+        # pass the set of changes for background jobs to know what changed
+        # see https://github.com/krisleech/wisper-activerecord/issues/17
+        def broadcast_update
+          broadcast(:after_update, self, previous_changes.with_indifferent_access) if previous_changes.any?
+        end
+
+        # broadcast MODEL_destroyed to subscribed listeners
+        # pass a serialized version of the object attributes
+        # for listeners since the object is no longer accessible in the database
+        def broadcast_destroy
+          broadcast(:after_destroy, attributes.with_indifferent_access)
+        end
+    end
+  end
+
+  ### ACTIVEJOB SUPPORT
+  if defined?(ActiveJob)
+    class ActiveJobBroadcaster
+      def broadcast(subscriber, publisher, event, args)
+        # Turn objects in args into GlobalID strings
+        args = args.map { |e| e.respond_to?(:to_global_id) ? e.to_global_id.to_s : e }
+        Wrapper.perform_later(subscriber.class.name, event, JSON.dump(args))
+      end
+
+      class Wrapper < ::ActiveJob::Base
+        queue_as :default
+
+        def perform(class_name, event, args)
+          listener = class_name.constantize.new
+          if listener.respond_to?(event)
+            args = JSON.parse(args).map do |e|
+              if e.is_a?(String) && e.starts_with?("gid://")
+                begin
+                  GlobalID::Locator.locate(e)
+                rescue ActiveRecord::RecordNotFound
+                  listener = nil
+                end
+              else
+                e
+              end
+            end
+            ap event
+            listener&.public_send(event, *args)
+          end
+        end
+      end
+
+      def self.register
+        Wisper.configure do |config|
+          config.broadcaster :active_job, ActiveJobBroadcaster.new
+          config.broadcaster :async,      ActiveJobBroadcaster.new
+        end
+      end
+    end
+  end
+
+  Wisper::ActiveJobBroadcaster.register
+end
+
+
+

data/wisper_plus.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wisper_plus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper_plus"
+  spec.version       = WisperPlus::VERSION
+  spec.authors       = ["Ben Sharpe"]
+  spec.email         = ["bsharpe@gmail.com"]
+
+  spec.summary       = %q{Handy additions to Wisper}
+  spec.description   = %q{Add ActiveRecord callback support; ActiveJob support and Automagic connection of subscriber classes to publisher models}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/}) || f.match(%r{\.gem$})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'activesupport', '>= 3', '< 6'
+
+  spec.add_dependency 'wisper', '>= 1.6', '< 3.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: wisper_plus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Sharpe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Add ActiveRecord callback support; ActiveJob support and Automagic connection
+  of subscriber classes to publisher models
+email:
+- bsharpe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wisper_plus.rb
+- lib/wisper_plus/railtie.rb
+- lib/wisper_plus/version.rb
+- wisper_plus.gemspec
+homepage: ''
+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: Handy additions to Wisper
+test_files: []