combinaut_rehearsal 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1a4bc4a5f3d48de6ee54ae530bab070de5fe26ba587d9fee5aa68ba1233cf66
+  data.tar.gz: 949c60a9477008abe1f43fcce62eafd6a81825d4dd48919c60d0310e762a7a75
+SHA512:
+  metadata.gz: 0deadea53bcd5b1842294c04ea5a3add8b48b22b3e7360941f0f1aeba523a4eb8df3f1d7a3c7a13762671e317ebdb713efcb161283eeb8e6c14da6aebe04388f
+  data.tar.gz: 1bfa5bfecc56881d9587bcaa93590126f287f2c23806b138a68e987d8fed5d966be0fa5fc8624aa7ee30ee7803e56fc92eaf0803fd334fbbeea7947df59ab118

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,59 @@
+# Rehearsal
+
+Rehearsal is a Rack Middleware gem that allows model changes to be previewed without persisting them to the database.
+It achieves this by intercepting the original update request and spawning a second request to Rails for a preview,
+wrapping both in a single database transaction that is rolled back after the preview is generated.
+
+## Installation
+
+Simply include the gem in your bundle, or `require` it by hand.
+
+## Setup
+
+### trigger
+
+The trigger defines a proc that enables the rehearsal mechanism for the request. Keep in mind the request has not yet
+reached Rails itself, and won't have data from `ApplicationController`.
+
+```ruby
+# This is the default trigger, but you can override it with any proc you want
+Rehearsal::Configuration.trigger = ->(request) {
+  request.params['rehearsal'] == 'true'
+}
+```
+
+### preview_url
+
+The preview url is the path of the second request which will show the preview of the changes made in the first request.
+The preview url may be defined in the following ways:
+
+- as a param, i.e. `params[:preview_url]` This method overrides all other methods of setting the url
+- as a proc, e.g. `Rehearsal::Configuration.preview_url = ->(controller) { controller.my_preview_url }`
+- as a symbol, e.g. `Rehearsal::Configuration.preview_url = :some_method` The method will be called on the controller the update request is sent to
+- as a value, e.g. `Rehearsal::Configuration.preview_url = '/my_previews'`
+
+NOTE: If left blank, the preview url will be determined from the response of the update request. If that request returns
+a redirect, the redirect chain will be followed until the response is not a redirect.
+
+### redirect_limit
+
+The number of allowable redirects can be configured in order to defend against an infinite redirecting bug. This is
+defaulted to a sane value, but can be adjusted as necessary.
+
+```ruby
+Rehearsal::Configuration.redirect_limit = 3
+```
+
+## Response Headers
+
+Since the request is redirected internally to the preview url, the browser will show the original request url.
+Rehearsal injects a `rehearsal.preview_url` header into the response, setting it to the url of the final
+preview url after redirection. A potential use case for this data is to rewrite the
+browser url history so that when the response returns, it shows the url of the preview instead of the original request.
+
+```erb
+<%= tag(:meta, property: 'preview_url', content: request['rehearsal.preview_url']) %>
+<script>
+  window.history.replaceState(null, null, $('meta[property=preview_url]').attr('content'));
+</script>
+```

data/lib/combinaut_rehearsal.rb

@@ -0,0 +1 @@
+require 'rehearsal'

data/lib/rehearsal.rb

@@ -0,0 +1,3 @@
+require 'rails'
+require 'rehearsal/configuration'
+require 'rehearsal/railtie'

data/lib/rehearsal/configuration.rb

@@ -0,0 +1,14 @@
+require 'ostruct'
+
+module Rehearsal
+  module Configuration
+    mattr_accessor :preview_url
+    mattr_accessor :trigger
+    mattr_accessor :redirect_limit
+
+    self.trigger = ->(request) {
+      request.params['rehearsal'] == 'true'
+    }
+    self.redirect_limit = 15
+  end
+end

data/lib/rehearsal/controller_extensions.rb

@@ -0,0 +1,12 @@
+require 'digest'
+
+module Rehearsal
+  module ControllerExtensions
+    module InstanceMethods
+      def preview_url
+        # Override this method in the host app controllers
+        nil
+      end
+    end
+  end
+end

data/lib/rehearsal/engine.rb

@@ -0,0 +1,11 @@
+require 'rehearsal/controller_extensions'
+
+module Rehearsal
+  class Engine < Rails::Engine
+    initializer 'rehearsal.load_controller_extensions' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include ControllerExtensions::InstanceMethods
+      end
+    end
+  end
+end

data/lib/rehearsal/middleware.rb

@@ -0,0 +1,110 @@
+require 'uri'
+
+module Rehearsal
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @original_env = env.dup
+      @request_env = env
+      @redirects_followed = []
+      request = Rack::Request.new(@request_env)
+
+      if rehearsal?(request)
+        rehearse(request) { process_request(request) }
+      else
+        process_request(request)
+      end
+    end
+
+    private
+
+    def rehearse(request)
+      ActiveRecord::Base.logger.info "Rehearsal beginning"
+      response = nil
+      ActiveRecord::Base.transaction do
+        response = objectify_response(yield)
+        if response.successful? || response.redirect?
+          preview_url = preview_url(request)
+          response = request_url(preview_url) if preview_url
+          response = follow_redirect(response) while response.redirect?
+        end
+
+        raise ActiveRecord::Rollback
+      end
+      ActiveRecord::Base.logger.info "Rehearsal ending"
+
+      return [response.status, response.header, response.body]
+    end
+
+    def rehearsal?(request)
+      case Configuration.trigger
+      when Proc
+        Configuration.trigger.call(request)
+      else
+        Configuration.trigger
+      end
+    end
+
+    def preview_url(request)
+      return request.params['preview_url'] if request.params.key?('preview_url')
+      case Configuration.preview_url
+      when Symbol
+        action_controller.send(Configuration.preview_url)
+      when Proc
+        Configuration.preview_url.call(action_controller)
+      else
+        Configuration.preview_url
+      end
+    end
+
+    def follow_redirect(response)
+      @redirects_followed << response.location
+      if @redirects_followed.count > Configuration.redirect_limit
+        raise TooManyRedirectsError, "Exceeded redirect limit of #{Configuration.redirect_limit}: #{redirect_history}"
+      elsif @redirects_followed.count(response.location) > 1
+        raise RedirectLoopError, "Redirect loop detected: #{redirect_history}"
+      end
+      request_url(response.location)
+    end
+
+    def request_url(url)
+      uri = URI(url)
+      params = Rack::Utils.parse_query(uri.query)
+      request = ActionDispatch::Request.new @original_env.dup.merge({
+        'rehearsal.preview_url' => url,
+        'REQUEST_METHOD' => 'GET',
+        'REQUEST_URI' => url,
+        'REQUEST_PATH' => uri.path,
+        'PATH_INFO' => uri.path,
+        'QUERY_STRING' => uri.query,
+        'rack.request.form_hash' => {}
+      })
+
+      return objectify_response(process_request(request))
+    end
+
+    def process_request(request)
+      @app.call(request.env)
+    end
+
+    def objectify_response(response)
+      Rack::Response.new(response[2], response[0], response[1])
+    end
+
+    def action_controller
+      @request_env.fetch('action_controller.instance')
+    end
+
+    def redirect_history
+      @redirects_followed.join(' -> ')
+    end
+  end
+
+  # EXCEPTIONS
+  class RehearsalError < StandardError; end
+  class RedirectLoopError < RehearsalError; end
+  class TooManyRedirectsError < RehearsalError; end
+end

data/lib/rehearsal/railtie.rb

@@ -0,0 +1,9 @@
+require 'rehearsal/middleware'
+
+module Rehearsal
+  class Railtie < Rails::Railtie
+    initializer "rehearsal.init" do |app|
+      app.config.middleware.use(Rehearsal::Middleware)
+    end
+  end
+end

data/lib/rehearsal/version.rb

@@ -0,0 +1,3 @@
+module Rehearsal
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: combinaut_rehearsal
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Ryan Wallace
+- Nicholas Jakobsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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'
+description: Rack Middleware that handles directs incoming requests to their aliased
+  path targets
+email:
+- hello@combinaut.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/combinaut_rehearsal.rb
+- lib/rehearsal.rb
+- lib/rehearsal/configuration.rb
+- lib/rehearsal/controller_extensions.rb
+- lib/rehearsal/engine.rb
+- lib/rehearsal/middleware.rb
+- lib/rehearsal/railtie.rb
+- lib/rehearsal/version.rb
+homepage: http://github.com/combinaut/rehearsal
+licenses: []
+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.9
+signing_key: 
+specification_version: 4
+summary: Rack Middleware that handles directs incoming requests to their aliased path
+  targets
+test_files: []