get_schwifty 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efeaf60c498883cadecc040b078c405a9490f86c
-  data.tar.gz: ae6c6b127933885076ac0144a2a0566eaf394fe8
+  metadata.gz: 855d3f63a838d8f8c920bd22a27b92cbb6a2efe7
+  data.tar.gz: 5e6f2c371471b7c93b7fda2fb61f125bd9ca5e3d
 SHA512:
-  metadata.gz: aeac7f9f8c7a71738f5b5bdc3d7045e10e984a2beb116071a92bd9669f8264e453fee18437c8f781f9f6136c143cd5eb1cf2297bbcb6ceb4a21dc7ec6f857237
-  data.tar.gz: d231ecb37e5ee75fa47986c7ad9896dc08a9ba9a92d6c9fac943ca22ac9d3df54cf1a718aa1563db56af3400b22c87c324251ef87ae33f8f1bf98fb3e478a62e
+  metadata.gz: e02f65f4ad6989bbfe0f097cc2c79a56dfc8969db8f02a21b645d89bb0ec8b5ecb6d416c05f76b407712eb91ccb126926e52c56be3ee4341ade620acdb6168bf
+  data.tar.gz: 84338811e747a31467807fa278e59092c06bb2ebd3a502aface746d6e04cf62a7767adc2b24826fb525c3497777ba1f9ca8cc6b371958e1acd33b5075022e0cc

data/README.md

@@ -1,15 +1,17 @@
-# GetSchwifty
+# get_schwifty
 >Oh, yeah!
 You gotta get schwifty.
 You gotta get schwifty in here.
 
-GetSchwifty is a Rails plugin for rendering slow view partials in a background job and sending them to the client over ActionCable websockets.
+get_schwifty is a Rails plugin for rendering slow view partials in a background job and sending them to the client over ActionCable websockets.
+
+[![CI](https://travis-ci.org/danielwestendorf/get_schwifty.svg?branch=master)](https://travis-ci.org/danielwestendorf/get_schwifty) [![Gem Version](https://badge.fury.io/rb/get_schwifty.svg)](https://badge.fury.io/rb/get_schwifty)
 
 ## Justification
 
 Slow-to-render HTML elements can be expensive (hosting) and unavoidable (technical debt, slow libs, expensive db queries, etc). Rendering in-line in your web server consumes a connection which could be serving other clients. Sometimes it's better to just return a minimal page quickly, and let the data backfill as it's generated.
 
-GetSchwifty is all about quick responses by utilizing background jobs to do the rendering for your and delivering it to the client with ActionCable.
+get_schwifty is all about quick responses by utilizing background jobs to do the rendering for your and delivering it to the client with ActionCable.
 
 ## Caveats
 
@@ -21,7 +23,6 @@ get_schwifty was extracted from [HireLoop.io](https://www.hireloop.io), a platfo
 
 Make hiring delightful by closing the loop between hiring managers and every applicant. Automate the trival tasks associated with screening job applicants, lowering the barrier for easy and clear communication.
 
-![](https://travis-ci.org/danielwestendorf/get_schwifty.svg?branch=master)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -49,12 +50,12 @@ Follow the instructions printed.
 
 ## Usage
 
-Generate your first GetSchwifty Cable
+Generate your first get_schwifty Cable
 ```bash
 $ rails generate get_schwifty:cable Calculator fibonacci
 ```
 
-Cables are a place to put your data access logic. Think Controllers for each GetSchwifty cable.
+Cables are a place to put your data access logic. Think Controllers for each get_schwifty cable.
 ```ruby
 # app/cables/calculator_cable.rb
 
@@ -74,7 +75,7 @@ class CalculatorCable < BaseCable
 end
 ```
 
-When the data has been queried/generated, the partial is rendered. `stream` is a wrapper around the normal Rails `render`.
+When the data has been queried/generated, the partial is rendered. `stream` is a wrapper around the normal Rails `render`. Want to redirect to another location? use the pass the path or URL to the `redirect` method.
 
 ```erb
 # app/views/cables/calculator/_fibonacci.html.erb
@@ -84,7 +85,7 @@ When the data has been queried/generated, the partial is rendered. `stream` is a
 
 ```
 
-Lastly, we need to tell the app where to render this chunk of HTML. GetSchwifty uses a similar routing syntax to Rails routes of `cablecontrollername#action`.
+Lastly, we need to tell the app where to render this chunk of HTML. get_schwifty uses a similar routing syntax to Rails routes of `cablecontrollername#action`.
 
 ```erb
 # app/views/yourpage.html.erb
@@ -102,7 +103,7 @@ Load the page, and you should get the whole page back quickly, while the Fibonac
 
 ### Identifiers & Params
 
-Random data isn't very useful. Unauthenticated data isn't very cool either. Usually in Rails data scoping belongs starts at a current_user method. GetSchwifty will make any identefiers or params made available in the channel subscription within your cables. Let's take a look at an example.
+Random data isn't very useful. Unauthenticated data isn't very cool either. Usually in Rails data scoping belongs starts at a current_user method. get_schwifty will make any identefiers or params made available in the channel subscription within your cables. Let's take a look at an example.
 
 #### Identifiers
 Here we'll find the current user. This is copied form the [Rails Guides](http://guides.rubyonrails.org/action_cable_overview.html#connection-setup).

data/Rakefile

@@ -1,33 +1,29 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'GetSchwifty'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "GetSchwifty"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
+require "bundler/gem_tasks"
 
-
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 
-
 task default: :test

data/app/assets/javascripts/get_schwifty.js

@@ -8,7 +8,23 @@ GetSchwifty = function(app) {
       bubbles: true
     });
     el.dispatchEvent(event)
-  };
+  }
+
+  function replaceContent(schwiftyJobId, oldEl, response) {
+    dispatchEvent('render:before', oldEl, { schwiftyJobId: schwiftyJobId, response: response });
+
+    var newContent = document.createRange().createContextualFragment(response.body);
+    var newEl = newContent.firstChild;
+    oldEl.parentNode.replaceChild(newContent, oldEl);
+
+    dispatchEvent('render:after', newEl, { schwiftyJobId: schwiftyJobId, html: response });
+  }
+
+  function redirectTo(schwiftyJobId, oldEl, response) {
+    dispatchEvent('redirect:before', oldEl, { schwiftyJobId: schwiftyJobId, response: response });
+
+    window.location = response.body;
+  }
 
   return {
     showMeWhatYouGot: function(selector) {
@@ -23,14 +39,15 @@ GetSchwifty = function(app) {
         var subscription = Object.assign({ channel: "GetSchwiftyChannel", id: schwiftyJobId }, schwiftyParams);
 
         var cable = _App.cable.subscriptions.create(subscription, {
-          received: function(html) {
-            dispatchEvent('render:before', el, { schwiftyJobId: schwiftyJobId, html: html });
-
-            var newContent = document.createRange().createContextualFragment(html);
-            var newEl = newContent.firstChild;
-            el.parentNode.replaceChild(newContent, el)
-
-            dispatchEvent('render:after', newEl, { schwiftyJobId: schwiftyJobId, html: html });
+          received: function(response) {
+
+            switch (response.status) {
+              case 302:
+              redirectTo(schwiftyJobId, el, response);
+              break;
+              default:
+              replaceContent(schwiftyJobId, el, response);
+            }
 
             cable.perform('rendered');
             cable.unsubscribe();

data/lib/generators/get_schwifty/cable_generator.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module GetSchwifty
   module Generators
+    # :nodoc
     class CableGenerator < Rails::Generators::NamedBase
       source_root File.expand_path("../../templates", __FILE__)
       argument :actions, type: :array, default: [], banner: "action action"

data/lib/generators/get_schwifty/install_generator.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module GetSchwifty
   module Generators
+    # :nodoc
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
@@ -31,7 +34,7 @@ module GetSchwifty
       end
 
       def autoload_cables_path
-       application %(config.autoload_paths << config.root.join("app", "cables"))
+        application %(config.autoload_paths << config.root.join("app", "cables"))
       end
 
       def copy_get_schwifty_channel_js

data/lib/generators/templates/cables/base_cable.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 # Base cable class to inherit from when getting schwifty
 class BaseCable < GetSchwifty::Cable::Base
+  include Rails.application.routes.url_helpers
   # Access to pundit helper methods for authorization
   # include Pundit
 

data/lib/generators/templates/channels/get_schwifty_channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Channel for handling schwifty subscriptions
 class GetSchwiftyChannel < ApplicationCable::Channel
   include GetSchwifty::Channel

data/lib/generators/templates/controllers/get_schwifty_controller.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Used for rendering partials in schwifty background jobs
 class GetSchwiftyController < ApplicationController
-  prepend_view_path Rails.root.join(*%w(app views cables)).to_s
+  prepend_view_path Rails.root.join("app", "views", "cables").to_s
 end

data/lib/generators/templates/get_schwifty.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # GetSchwifty configuration initializer
 # Use this file to configure GetSchwifty for your needs
 GetSchwifty.configure do |config|

data/lib/generators/templates/jobs/get_schwifty_runner_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Job for running schwifty cables in ActiveJob
 class GetSchwiftyRunnerJob < ApplicationJob
   include GetSchwifty::Job

data/lib/get_schwifty.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require "get_schwifty/helper"
 require "get_schwifty/channel"
 require "get_schwifty/job"
 require "get_schwifty/cable/base"
 
+# :nodoc
 module GetSchwifty
   mattr_accessor :allow_rerender
   @@allow_rerender = true
@@ -11,10 +14,12 @@ module GetSchwifty
     yield self
   end
 
+  # :nodoc
   class Engine < ::Rails::Engine
-    config.assets.paths += [File.expand_path("../../app/assets/javascripts", __FILE__)] if config.respond_to?(:assets)
+    asset_path = File.expand_path("../../app/assets/javascripts", __FILE__)
+    config.assets.paths += [asset_path] if config.respond_to?(:assets)
 
-    initializer :get_schwifty do |app|
+    initializer :get_schwifty do |_app|
       ActiveSupport.on_load(:action_view) do
         include GetSchwifty::Helper
       end

data/lib/get_schwifty/cable/base.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module GetSchwifty
   module Cable
+    # :nodoc
     class Base
       attr_reader :schwifty_job_id, :identifiers, :params
 
@@ -14,7 +17,16 @@ module GetSchwifty
       def stream(*args)
         ActionCable.server.broadcast(
           schwifty_job_id,
-          GetSchwiftyController.renderer.new.render(*args).squish
+          status: 200,
+          body: GetSchwiftyController.renderer.new.render(*args).squish
+        )
+      end
+
+      def redirect(url)
+        ActionCable.server.broadcast(
+          schwifty_job_id,
+          status: 302,
+          body: url
         )
       end
     end

data/lib/get_schwifty/channel.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module GetSchwifty
+  # :nodoc
   module Channel
     def subscribed
       reject if route.blank?

data/lib/get_schwifty/helper.rb

@@ -1,8 +1,9 @@
 module GetSchwifty
+  # :nodoc
   module Helper
     def get_schwifty(route, params = nil, &blk)
       id = SecureRandom.hex
-      Rails.cache.write("get_schwifty:#{id}", route, expires_in: 10.minutes)
+      Rails.cache.write("get_schwifty:#{id}", route)
 
       opts = {
         "data-get-schwifty" => id

data/lib/get_schwifty/job.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module GetSchwifty
+  # :nodoc
   module Job
     def perform(schwifty_job_id, klass_name, method, params, *identifiers)
       klass_name.constantize.new(schwifty_job_id, params, Hash[*identifiers]).send(method)

data/lib/get_schwifty/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GetSchwifty
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/tasks/get_schwifty_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :get_schwifty do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: get_schwifty
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Westendorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,8 +94,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n                    Offload the rendering of slow view partials with
-  ActiveJob and ActionCable to reduce page load times.\n                  "
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: Offload the rendering of slow view partials with ActiveJob and ActionCable
+  to reduce page load times.
 email:
 - daniel@prowestech.com
 executables: []
@@ -145,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Render view partials with ActiveJob and ActionCable.