get_schwifty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f937f9b21a7ac4b56fff5a6502f91a8ab92c8a15
+  data.tar.gz: 4118a97184ccef0f2f8d793c53e6a5856b840b15
+SHA512:
+  metadata.gz: afebf12398a35645ca1aea418a6c2a988160336d9e0916010ac339d95c2c0b5b624191cb2dd3290f3a1ac81dcea59fe1155a135ae890c036ac5310885d525661
+  data.tar.gz: 0c08a37cb35a502231f25865157276e91ac3f4c08d5c798802f4d01dba75a666710fd1913421389e392e40a17e745b3778370e9f8949816f6639dd95c78b6ee6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Daniel Westendorf
+
+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,160 @@
+# GetSchwifty
+>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.
+
+## 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.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "get_schwifty"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install get_schwifty
+```
+
+Install the plugin
+```bash
+$ rails generate get_schwifty:install
+```
+Follow the instructions printed.
+
+
+## Usage
+
+Generate your first GetSchwifty 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.
+```ruby
+# app/cables/calculator_cable.rb
+
+class CalculatorCable < BaseCable
+  def fibonacci
+    n = SecureRandom.rand(30..40)
+    calculated = calculate_fibonacci(n)
+    stream partial: "calculator/fibonacci", locals: { calculated: calculated, n: n }
+  end
+
+  private
+
+  def calculate_fibonacci(n)
+    return n if n <= 1
+    calculate_fibonacci( n - 1 ) + calculate_fibonacci( n - 2 )
+  end
+end
+```
+
+When the data has been queried/generated, the partial is rendered. `stream` is a wrapper around the normal Rails `render`.
+
+```erb
+# app/views/cables/calculator/_fibonacci.html.erb
+<p class="take-off-your-pants">
+  Fibonacci of <%= n %> is <%= calculated %>
+</p>
+
+```
+
+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`.
+
+```erb
+# app/views/yourpage.html.erb
+... Other HTML ...
+<%= get_schwifty "calculator#fibonacci" do %>
+  <p>
+    This will get displayed while the cable is waiting to get schwifty.
+    Maybe markup for a loading animation?
+  </p>
+<%- end %>
+... Other HTML ...
+```
+
+Load the page, and you should get the whole page back quickly, while the Fibonacci comes later.
+
+### 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.
+
+#### 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).
+``` ruby
+# app/channels/connection.rb
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = find_verified_user
+    end
+
+    private
+
+    def find_verified_user
+      if current_user = User.find_by(id: cookies.signed[:user_id])
+        current_user
+      else
+        reject_unauthorized_connection
+      end
+    end
+  end
+end
+```
+
+Let's assume the `User#fibonacci` returns and integer to use in the `CalculatorCable#fibonacci`.
+```ruby
+# app/cables/calculator_cable.rb
+
+class CalculatorCable < BaseCable
+  def fibonacci
+    n = identifiers[:current_user]
+    ... same code as before ..
+  end
+end
+```
+
+Similarly, any other identifiers created in the connection will follow suite and be made available in your cable. Additionally, you may want to add getter methods to `BaseCable` make accessing identifiers easier.
+
+#### Params
+
+Code reusability is the Rails way, so maybe we need to tweak how the cable's action is invoked dynamically, based on where the HTML is to be rendered. This is easy as pie, simply pass a hash of parameters to the `get_schwifty` view helper.
+
+```erb
+# app/views/yourpage.html.erb
+... Other HTML ...
+<%= get_schwifty "calculator#fibonacci", min_start: 3 do %>
+  ... same as before ...
+<%- end %>
+... Other HTML ...
+```
+
+These params will be available in your cable action.
+```ruby
+# app/cables/calculator_cable.rb
+
+class CalculatorCable < BaseCable
+  def fibonacci
+    n = SecureRandom.rand(params[:min_start]..40)
+    ... same code as before ..
+  end
+end
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+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')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/get_schwifty.js

@@ -0,0 +1,44 @@
+GetSchwifty = function(app) {
+  _App = app;
+
+  function dispatchEvent(ev, el, data) {
+    data = data || {}
+    var event = new CustomEvent('getSchwifty.' + ev, {
+      detail: data,
+      bubbles: true
+    });
+    el.dispatchEvent(event)
+  };
+
+  return {
+    showMeWhatYouGot: function(selector) {
+      selector = selector || '';
+
+      [].forEach.call(document.querySelectorAll(selector + ' [data-get-schwifty]'), function(el) {
+        var schwiftyJobId = el.getAttribute('data-get-schwifty');
+        var schwiftyParams = JSON.parse(el.getAttribute('data-get-schwifty-params')) || {};
+
+        dispatchEvent('subscribe:before', el, { schwiftyJobId: schwiftyJobId, paschwiftyParamsrams: schwiftyParams });
+
+        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 });
+
+            cable.perform('rendered');
+            cable.unsubscribe();
+          }
+        });
+
+        dispatchEvent('subscribe:after', el, { schwiftyJobId: schwiftyJobId })
+      });
+    }
+  };
+}

data/lib/generators/get_schwifty/cable_generator.rb

@@ -0,0 +1,20 @@
+module GetSchwifty
+  module Generators
+    class CableGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../../templates", __FILE__)
+      argument :actions, type: :array, default: [], banner: "action action"
+
+      def create_cable_files
+        template "cables/cable.rb", File.join("app", "cables", class_path, "#{file_name}_cable.rb")
+
+        actions.each do |action|
+          template "views/cables/action.html.erb", File.join("app", "views", "cables", class_path, file_name, "_#{action}.html.erb")
+        end
+      end
+
+      def print_readme
+        readme "CABLE"
+      end
+    end
+  end
+end

data/lib/generators/get_schwifty/install_generator.rb

@@ -0,0 +1,42 @@
+module GetSchwifty
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Installs required files for getting schwifty in here"
+
+      def copy_controller
+        template "controllers/get_schwifty_controller.rb", "app/controllers/get_schwifty_controller.rb"
+      end
+
+      def copy_channel
+        template "channels/get_schwifty_channel.rb", "app/channels/get_schwifty_channel.rb"
+      end
+
+      def copy_job
+        template "jobs/get_schwifty_runner_job.rb", "app/jobs/get_schwifty_runner_job.rb"
+      end
+
+      def create_cables_directories
+        empty_directory "app/cables"
+        empty_directory "app/views/cables"
+      end
+
+      def copy_base_cable
+        template "cables/base_cable.rb", "app/cables/base_cable.rb"
+      end
+
+      def autoload_cables_path
+       application %(config.autoload_paths << config.root.join("app", "cables"))
+      end
+
+      def copy_get_schwifty_channel_js
+        template "assets/javascripts/get_schwifty_channel.js", "app/assets/javascripts/channels/get_schwifty_channel.js"
+      end
+
+      def print_readme
+        readme "INSTALL"
+      end
+    end
+  end
+end

data/lib/generators/templates/CABLE

@@ -0,0 +1,38 @@
+===============================================================================
+
+How to use your cable:
+
+  1. Use the get_schwifty view helper to insert the cable into your markup.
+
+      <%= get_schwifty "dashboard#fibonacci" do %>
+        <p>
+          This will get displayed while the cable is waiting to get schwifty.
+          Maybe markup for a loading animation?
+        </p>
+      <%- end %>
+
+  2. Update your cable action to implement the slow performing code. This code
+     will get schwifty in your background job queue.
+
+      # app/cables/dashboard.rb
+      def fibonacci
+        n = SecureRandom.rand(20..40)
+        calculated = calculate_fibonacci(n)
+        stream partial: "dashboard/fibonacci", locals: { calculated: calculated, n: n }
+      end
+
+      private
+
+      def calculate_fibonacci(n)
+        return n if n <= 1
+        calculate_fibonacci( n - 1 ) + calculate_fibonacci( n - 2 )
+      end
+
+  3. Implement the partial view for the cable action.
+
+      # app/views/cables/dashboard/_fibonacci.html.erb
+      <p>
+        Fibonacci of <%= n %>: <%= calculated %>
+      </p>
+
+===============================================================================

data/lib/generators/templates/INSTALL

@@ -0,0 +1,26 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Restart your server. app/cables has been added to the load path, and it
+     is necessary to restart your web server and any non-async job queues.
+
+     ActionCable requires that you use a servers such as Puma as your development
+     webserver.
+
+  2. Ensure you're using a shared cache store. Rails by default uses an
+     in-memory cache store, which can't be accessed between processes.
+     http://guides.rubyonrails.org/caching_with_rails.html#activesupport-cache-filestore
+
+       # config/environments/development.rb
+       config.cache_store = :file_store, "tmp/cache"
+
+  3. Add the get_schwifty javascript to your application.js
+
+       //= require get_schwifty
+
+  4. Setup your first cable to get schwifty
+
+       rails g get_schwifty:cable Dashboard fibonacci
+
+===============================================================================

data/lib/generators/templates/assets/javascripts/get_schwifty_channel.js

@@ -0,0 +1,3 @@
+document.addEventListener("DOMContentLoaded", function() {
+  GetSchwifty(App).showMeWhatYouGot();
+});

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

@@ -0,0 +1,10 @@
+# Base cable class to inherit from when getting schwifty
+class BaseCable < GetSchwifty::Cable::Base
+  # Access to pundit helper methods for authorization
+  # include Pundit
+
+  # Utility method shared accross cables for accessing the current user
+  # def current_user
+  #   identifiers[:user]
+  # end
+end

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

@@ -0,0 +1,16 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_class_path %>/application_cable"
+<% end -%>
+<% module_namespacing do -%>
+class <%= class_name %>Cable < BaseCable
+<% actions.each do |action| -%>
+  def <%= action %>
+    a = 1
+    b = 2
+
+    stream partial: "<%= class_name.underscore %>/<%= action %>", locals: { a: a, b: b }
+  end
+<%= "\n" unless action == actions.last -%>
+<% end -%>
+end
+<% end -%>

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

@@ -0,0 +1,4 @@
+# Channel for handling schwifty subscriptions
+class GetSchwiftyChannel < ApplicationCable::Channel
+  include GetSchwifty::Channel
+end

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

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

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

@@ -0,0 +1,4 @@
+# Job for running schwifty cables in ActiveJob
+class GetSchwiftyRunnerJob < ApplicationJob
+  include GetSchwifty::Job
+end

data/lib/generators/templates/views/cables/action.html.erb

@@ -0,0 +1 @@
+<!-- Slow to generate HTML goes here -->

data/lib/get_schwifty/cable/base.rb

@@ -0,0 +1,22 @@
+module GetSchwifty
+  module Cable
+    class Base
+      attr_reader :schwifty_job_id, :identifiers, :params
+
+      def initialize(schwifty_job_id, params, identifiers)
+        @schwifty_job_id = schwifty_job_id
+        @identifiers = identifiers.symbolize_keys!
+        @params = params
+      end
+
+      private
+
+      def stream(*args)
+        ActionCable.server.broadcast(
+          schwifty_job_id,
+          GetSchwiftyController.renderer.new.render(*args).squish
+        )
+      end
+    end
+  end
+end

data/lib/get_schwifty/channel.rb

@@ -0,0 +1,40 @@
+module GetSchwifty
+  module Channel
+    def subscribed
+      reject if route.blank?
+
+      stream_from channel_name
+      GetSchwiftyRunnerJob.perform_later(channel_name, controller, action, params, *identifiers.flatten)
+    end
+
+    def rendered
+      Rails.cache.write(channel_name, nil)
+    end
+
+    def route
+      Rails.cache.read(channel_name)
+    end
+
+    def controller
+      (route.split("#").first + "_cable").camelize
+    end
+
+    def action
+      route.split("#").last
+    end
+
+    def identifiers
+      connection.identifiers.collect do |key|
+        [key.to_s, send(key)]
+      end
+    end
+
+    def schwifty_job_id
+      params[:id]
+    end
+
+    def channel_name
+      "get_schwifty:#{schwifty_job_id}"
+    end
+  end
+end

data/lib/get_schwifty/helper.rb

@@ -0,0 +1,25 @@
+module GetSchwifty
+  module Helper
+    def get_schwifty(route, params = nil, &blk)
+      id = SecureRandom.hex
+      Rails.cache.write("get_schwifty:#{id}", route, expires_in: 10.minutes)
+
+      opts = {
+        "data-get-schwifty" => id
+      }
+
+      opts["data-get-schwifty-params"] = params.to_json if params
+
+      args = [
+        :div, nil, opts
+      ]
+
+      if block_given?
+        args.reject!(&:nil?)
+        return content_tag(*args, &blk)
+      end
+
+      content_tag(*args)
+    end
+  end
+end

data/lib/get_schwifty/job.rb

@@ -0,0 +1,7 @@
+module GetSchwifty
+  module Job
+    def perform(schwifty_job_id, klass_name, method, params, *identifiers)
+      klass_name.constantize.new(schwifty_job_id, params, Hash[*identifiers]).send(method)
+    end
+  end
+end

data/lib/get_schwifty/version.rb

@@ -0,0 +1,3 @@
+module GetSchwifty
+  VERSION = '0.1.0'
+end

data/lib/get_schwifty.rb

@@ -0,0 +1,16 @@
+require "get_schwifty/helper"
+require "get_schwifty/channel"
+require "get_schwifty/job"
+require "get_schwifty/cable/base"
+
+module GetSchwifty
+  class Engine < ::Rails::Engine
+    config.assets.paths += [File.expand_path("../../app/assets/javascripts", __FILE__)] if config.respond_to?(:assets)
+
+    initializer :get_schwifty do |app|
+      ActiveSupport.on_load(:action_view) do
+        include GetSchwifty::Helper
+      end
+    end
+  end
+end

data/lib/tasks/get_schwifty_tasks.rake

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: get_schwifty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Westendorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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: capybara
+  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: selenium-webdriver
+  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: sqlite3
+  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: redis
+  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'
+description: "\n                    Offload the rendering of slow view partials with
+  ActiveJob and ActionCable to reduce page load times.\n                  "
+email:
+- daniel@prowestech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/get_schwifty.js
+- lib/generators/get_schwifty/cable_generator.rb
+- lib/generators/get_schwifty/install_generator.rb
+- lib/generators/templates/CABLE
+- lib/generators/templates/INSTALL
+- lib/generators/templates/assets/javascripts/get_schwifty_channel.js
+- lib/generators/templates/cables/base_cable.rb
+- lib/generators/templates/cables/cable.rb
+- lib/generators/templates/channels/get_schwifty_channel.rb
+- lib/generators/templates/controllers/get_schwifty_controller.rb
+- lib/generators/templates/jobs/get_schwifty_runner_job.rb
+- lib/generators/templates/views/cables/action.html.erb
+- lib/get_schwifty.rb
+- lib/get_schwifty/cable/base.rb
+- lib/get_schwifty/channel.rb
+- lib/get_schwifty/helper.rb
+- lib/get_schwifty/job.rb
+- lib/get_schwifty/version.rb
+- lib/tasks/get_schwifty_tasks.rake
+homepage: https://github.com/danielwestendorf/get_schwifty
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Render view partials with ActiveJob and ActionCable.
+test_files: []