french_toast 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a63ea01184bb8c09aa820ba590173e4d369cfacd
+  data.tar.gz: 1765b295c089915f311b815e2f83f432573af171
+SHA512:
+  metadata.gz: ad4a28c4eed8868d82215a46a3884f36261554ff309576e404b9b079ee4e0acd4eded01f3117e16348b2dbcf67635d31e6666934eb2bd01922059c5ddbc1949c
+  data.tar.gz: ee4a0e2f58caa3d6bbf318ddf06c6c4f42c713a00d36c0b747cac4a842729d7829a0c8ee0d572508e8dbd889ddd7f3c6efa525ddb0d449e82d3fd08465a43418

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/
+spec/examples.txt
+/spec/dummy/.byebug_history
+db/migrate/*_create_last_notifications.rb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+dist: trusty
+language: ruby
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+services:
+  - redis-server
+script: xvfb-run bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+- This change log file.
+- Contributing guidelines.
+- A readme.
+- A license.
+
+[Unreleased]: https://github.com/thoughtbot/french_toast/compare/v0.3.0...HEAD

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing
+
+We love contributions from everyone.
+By participating in this project,
+you agree to abide by the thoughtbot [code of conduct].
+
+  [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
+
+We expect everyone to follow the code of conduct
+anywhere in thoughtbot's project codebases,
+issue trackers, chatrooms, and mailing lists.
+
+## Contributing Code
+
+1. Fork the repo.
+
+  ```
+  git clone git@github.com:thoughtbot/french_toast.git
+  ```
+
+1. Make sure the tests pass:
+
+  ```
+  rake
+  ```
+
+1. Make your change, with new passing tests. Follow the [style guide][style].
+
+  [style]: https://github.com/thoughtbot/guides/tree/master/style
+
+1. Mention how your changes affect the project to other developers and users in
+the [change log].
+
+1. Push to your fork. Write a [good commit message][commit]. Submit a pull request.
+
+  [change log]: CONTRIBUTING.md
+  [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+Others will give constructive feedback.
+This is a time for discussion and improvements,
+and making the necessary changes will be required before we can
+merge the contribution.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in french_toast.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 thoughtbot, inc.
+
+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,146 @@
+# French Toast
+[![Build Status](https://travis-ci.org/thoughtbot/french_toast.svg?branch=master)](https://travis-ci.org/thoughtbot/french_toast)
+[![Code Climate](https://codeclimate.com/github/thoughtbot/french_toast/badges/gpa.svg)](https://codeclimate.com/github/thoughtbot/french_toast)
+
+Communicate information about background jobs in Rails seamlessly.
+
+FrenchToast attempts to streamline some [progressive enhancement](https://en.wikipedia.org/wiki/Progressive_enhancement) by providing a simple and opinionated interface. In order to best take advantage of this, it is important to render that information on the backend. This allows FrenchToast to figure out the best possible communication stream, by starting the most basic functionality and slowly building up to more enhanced features.
+
+With `FrenchToast` it will:
+
+1. Communicate through websockets
+2. If that is unavailable, communicate on next page refresh
+3. If the user hasn't seen the content, send them an email
+
+## Installation
+
+- Add the `FrenchToast` gem to your Gemfile:
+
+  ```
+  gem "french_toast"
+  ```
+
+- Run `bundle install` from your shell.
+
+- Generate migrations so ``FrenchToast`` can render information when javascript isn't available.
+
+```
+rails generate french_toast:install
+rake db:migrate
+```
+
+## Usage
+
+### General
+
+The `#french_toast` helper provides the simplest interface for `FrenchToast`. It can be used, for example, on the `application` layout.
+
+```erb
+# application.html.erb
+<%= french_toast %>
+```
+
+`FrenchToast` looks for templates by default in the `views/french_toast` folder.
+
+```erb
+# _foo.html.erb
+<div>You'll see me eventually! <%= your_name %></div>
+```
+
+Use `#notify` with the name of the template to be rendered to render that template on the page.
+
+```ruby
+# something_job.rb
+class SomethingJob
+  def perform
+    `FrenchToast`.notify("foo", payload: { your_name: "Jim-bob" })
+  end
+end
+```
+
+Where you specified `#french_toast` you will see the `foo.html.erb` template fully rendered using the best channel available to your user.
+
+### Specifying sections
+
+`FrenchToast` gives you the option to be more specific about what kind of content should be rendered.
+
+Provide a namespace to `#french_toast` helper
+
+```erb
+# posts/index.html.erb
+<%= french_toast :post %>
+```
+
+Referencing a template the same way, provide `name` attribute to `#notify` will render the template only where it is namespaced.
+
+```ruby
+#... something_job.rb
+def perform
+  `FrenchToast`.notify("foo", name: :post, payload: {})
+end
+```
+
+Where `#french_toast` was specified with `:post`, the `foo.html.erb` template will be rendered.
+
+### Synchronous render control
+
+`FrenchToast` by default will store information in your database to be displayed later if a user is unable to receive information asynchronously. This can be prevented if there is already a faster, simpler way to communicate information on page load.
+
+For example, `FrenchToast` is being used to update a list of posts on a page through websockets, but there is already a code to render each post on the server. You can prevent `FrenchToast` from storing that content on the server.
+
+On the `#french_toast` helper you can specify the `synchronous` attribute, which helps specify the type of communication allowed.
+
+```erb
+<%= french_toast :post, synchronous: false %>
+```
+
+### Granular template control
+
+`FrenchToast` by default assumes HTML templates are being rendered on the page. There are times that require more granular control of the template because the information being sent is not HTML.
+
+A custom template can be specified and referenced using the `template` attribute on the `#french_toast` helper.
+
+```erb
+<%= french_toast :text, template: "text_only" %>
+```
+
+Create a template in `french_toast/templates` and use the `#french_toast_tag` helper to generate the necessary HTML that can be identified by `FrenchToast`.
+
+```erb
+# _text_only.html.erb
+<div class="my-own-thing" >
+  <%= french_toast_tag :p %>
+</div>
+
+```
+
+## Contributing
+
+See the [CONTRIBUTING] document.
+Thank you, [contributors]!
+
+  [CONTRIBUTING]: CONTRIBUTING.md
+  [contributors]: https://github.com/thoughtbot/french_toast/graphs/contributors
+
+## License
+
+French Toast is Copyright (c) 2016 thoughtbot, inc.
+It is free software, and may be redistributed
+under the terms specified in the [LICENSE] file.
+
+  [LICENSE]: LICENSE.md
+
+## About
+
+[<img src="http://presskit.thoughtbot.com/images/signature.svg" width="250" alt="thoughtbot logo">][thoughtbot]
+
+French Toast is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community]
+or [hire us][hire] to help build your product.
+
+  [thoughtbot]: https://thoughtbot.com?utm_source=github
+  [community]: https://thoughtbot.com/community?utm_source=github
+  [hire]: https://thoughtbot.com/hire-us?utm_source=github

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = '*/*_spec.rb'
+  end
+
+  task default: :spec
+rescue LoadError
+end

data/app/assets/javascripts/french_toast.js

@@ -0,0 +1,9 @@
+App.cable.subscriptions.create({
+  channel: "NotifierChannel"
+}, {
+  received: function(content) {
+    if (content !== undefined) {
+      $("[data-french-toast-content]").html(content);
+    }
+  }
+});

data/app/helpers/french_toast/helper.rb

@@ -0,0 +1,22 @@
+module FrenchToast
+  module Helper
+    def french_toast
+      render "application/french_toast_template"
+    end
+
+    def french_toast_notification
+      @french_toast_notification ||=
+        FrenchToast::LastNotification.find_or_create_by(
+          session: cookies[:key],
+        ).tap(&:destroy)
+    end
+
+    def french_toast_content?
+      french_toast_notification.data?
+    end
+
+    def french_toast_content
+      french_toast_notification.data
+    end
+  end
+end

data/app/mailers/french_toast/notifier_mailer.rb

@@ -0,0 +1,10 @@
+module FrenchToast
+  class NotifierMailer < ActionMailer::Base
+    def article_processed(email)
+      mail(
+        from: "us@example.com",
+        to: email,
+      )
+    end
+  end
+end

data/app/models/french_toast/last_notification.rb

@@ -0,0 +1,3 @@
+module FrenchToast
+  class LastNotification < ActiveRecord::Base; end
+end

data/app/views/application/_french_toast_template.html.erb

@@ -0,0 +1,11 @@
+<div id="french-toast-js-container" aria-live="polite" role="alert">
+  <div class="french-toast-c-content" data-french-toast-content>
+    <% if french_toast_content? %>
+      <%= french_toast_content.html_safe %>
+    <% end %>
+  </div>
+
+  <noscript>
+    Refresh page for updates.
+  </noscript>
+</div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "french_toast"
+
+# 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

data/bin/setup

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+export RAILS_ENV=test
+
+bundle install
+
+(
+cd spec/dummy && \
+  rm db/migrate/*_create_last_notifications.rb
+  bundle install && \
+  rake db:environment:set db:drop db:create && \
+  rails generate french_toast:install && \
+  rake db:migrate
+)

data/french_toast.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'french_toast/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "french_toast"
+  spec.version       = FrenchToast::VERSION
+  spec.email         = ["ralph@thoughtbot.com"]
+  spec.summary       = %q{Communicate information about background jobs}
+  spec.description   = %q{Recipe for French toast from scratch: first, invent universe}
+  spec.homepage      = "https://github.com/thoughtbot/french_toast"
+  spec.license       = "MIT"
+  spec.authors       = [
+    "Elle Meredith",
+    "Eric Collins",
+    "Geoff Harcourt",
+    "George Brocklehurst",
+    "Ian Zabel",
+    "Mike Burns",
+    "Tyson Gach",
+    "Yianna Kokalas",
+  ]
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_dependency "rails", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "pry-byebug", "~> 3.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "jquery-rails", "~> 4.3"
+end

data/lib/french_toast.rb

@@ -0,0 +1,4 @@
+require "french_toast/version"
+require "french_toast/notifier"
+require "french_toast/engine"
+require "generators/french_toast/install_generator"

data/lib/french_toast/engine.rb

@@ -0,0 +1,6 @@
+require "french_toast"
+
+module FrenchToast
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/french_toast/notifier.rb

@@ -0,0 +1,33 @@
+module FrenchToast
+  class Notifier
+    def initialize(session_key)
+      @session_key = session_key
+    end
+
+    def notify(partial_name)
+      processed_payload = process(partial_name)
+      store(processed_payload)
+      notify_by_action_cable(processed_payload)
+    end
+
+    private
+
+    attr_reader :session_key
+
+    def process(partial_name)
+      ApplicationController.render(partial: "french_toast/#{partial_name}")
+    end
+
+    def notify_by_action_cable(payload)
+      ActionCable.server.broadcast(session_key, payload.html_safe)
+    end
+
+    def store(payload)
+      LastNotification.find_or_create_by(
+        session: session_key,
+      ).tap do |notification|
+        notification.update(data: payload)
+      end
+    end
+  end
+end

data/lib/french_toast/version.rb

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

data/lib/generators/french_toast/install_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module FrenchToast
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_last_notification_migration
+        migration_template(
+          "create_last_notifications.rb",
+          "db/migrate/create_last_notifications.rb",
+        )
+      end
+    end
+  end
+end

data/lib/generators/french_toast/templates/create_last_notifications.rb

@@ -0,0 +1,10 @@
+class CreateLastNotifications < ActiveRecord::Migration[5.0]
+  def change
+    create_table :last_notifications do |t|
+      t.timestamps
+
+      t.string :session, index: true
+      t.string :data
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: french_toast
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elle Meredith
+- Eric Collins
+- Geoff Harcourt
+- George Brocklehurst
+- Ian Zabel
+- Mike Burns
+- Tyson Gach
+- Yianna Kokalas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: 'Recipe for French toast from scratch: first, invent universe'
+email:
+- ralph@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/javascripts/french_toast.js
+- app/helpers/french_toast/helper.rb
+- app/mailers/french_toast/notifier_mailer.rb
+- app/models/french_toast/last_notification.rb
+- app/views/application/_french_toast_template.html.erb
+- bin/console
+- bin/setup
+- french_toast.gemspec
+- lib/french_toast.rb
+- lib/french_toast/engine.rb
+- lib/french_toast/notifier.rb
+- lib/french_toast/version.rb
+- lib/generators/french_toast/install_generator.rb
+- lib/generators/french_toast/templates/create_last_notifications.rb
+homepage: https://github.com/thoughtbot/french_toast
+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.11
+signing_key: 
+specification_version: 4
+summary: Communicate information about background jobs
+test_files: []