breezy 0.1.0

data/test/breezy_test.rb

@@ -0,0 +1,171 @@
+require 'test_helper'
+
+class BreezyController < TestController
+  before_action do
+    @_use_breezy_html = false
+  end
+
+  def simple_action
+    render plain: ''
+  end
+
+  def redirect_to_same_origin
+    redirect_to "#{request.protocol}#{request.host}/path"
+  end
+
+  def redirect_to_different_host
+    redirect_to "#{request.protocol}foo.#{request.host}/path"
+  end
+
+  def redirect_to_different_protocol
+    redirect_to "#{request.protocol == 'http://' ? 'https://' : 'http://'}#{request.host}/path"
+  end
+
+  def redirect_to_back
+    if Rails.version >= "5.0"
+      redirect_back(fallback_location: '/')
+    else
+      redirect_to :back
+    end
+  end
+
+  def redirect_to_unescaped_path
+    redirect_to "#{request.protocol}#{request.host}/foo bar"
+  end
+end
+
+class BreezyTest < ActionController::TestCase
+  tests BreezyController
+
+  test "request referer returns xhr referer or standard referer" do
+    @request.env['HTTP_REFERER'] = 'referer'
+    assert_equal 'referer', @request.referer
+
+    @request.env['HTTP_X_XHR_REFERER'] = 'xhr-referer'
+    assert_equal 'xhr-referer', @request.referer
+  end
+
+  test "url for with back uses xhr referer when available" do
+    @request.env['HTTP_REFERER'] = 'referer'
+    assert_equal 'referer', @controller.view_context.url_for(:back)
+
+    @request.env['HTTP_X_XHR_REFERER'] = 'xhr-referer'
+    assert_equal 'xhr-referer', @controller.view_context.url_for(:back)
+  end
+
+  test "redirect to back uses xhr referer when available" do
+    @request.env['HTTP_REFERER'] = 'http://test.host/referer'
+    get :redirect_to_back
+    assert_redirected_to 'http://test.host/referer'
+
+    @request.env['HTTP_X_XHR_REFERER'] = 'http://test.host/xhr-referer'
+    get :redirect_to_back
+    assert_redirected_to 'http://test.host/xhr-referer'
+  end
+
+  test "sets request method cookie on non get requests" do
+    post :simple_action
+    assert_equal 'POST', cookies[:request_method]
+    put :simple_action
+    assert_equal 'PUT', cookies[:request_method]
+  end
+
+  test "pops request method cookie on get request" do
+    cookies[:request_method] = 'TEST'
+    get :simple_action
+    assert_nil cookies[:request_method]
+  end
+
+  test "sets xhr redirected to header on redirect requests coming from breezy" do
+    get :redirect_to_same_origin
+    get :simple_action
+    assert_nil @response.headers['X-XHR-Redirected-To']
+
+    @request.env['HTTP_X_XHR_REFERER'] = 'http://test.host/'
+    get :redirect_to_same_origin
+    @request.env['HTTP_X_XHR_REFERER'] = nil
+    get :simple_action
+    assert_equal 'http://test.host/path', @response.headers['X-XHR-Redirected-To']
+  end
+
+  test "changes status to 403 on breezy requests redirecting to different origin" do
+    get :redirect_to_different_host
+    assert_response :redirect
+
+    get :redirect_to_different_protocol
+    assert_response :redirect
+
+    @request.env['HTTP_X_XHR_REFERER'] = 'http://test.host'
+
+    get :redirect_to_different_host
+    assert_response :forbidden
+
+    get :redirect_to_different_protocol
+    assert_response :forbidden
+
+    get :redirect_to_same_origin
+    assert_response :redirect
+  end
+
+  test "handles invalid xhr referer on redirection" do
+    @request.env['HTTP_X_XHR_REFERER'] = ':'
+    get :redirect_to_same_origin
+    assert_response :redirect
+  end
+
+  test "handles unescaped same origin location on redirection" do
+    @request.env['HTTP_X_XHR_REFERER'] = 'http://test.host/'
+    get :redirect_to_unescaped_path
+    assert_response :redirect
+  end
+
+  test "handles unescaped different origin location on redirection" do
+    @request.env['HTTP_X_XHR_REFERER'] = 'https://test.host/'
+    get :redirect_to_unescaped_path
+    assert_response :forbidden
+  end
+end
+
+class BreezyIntegrationTest < ActionDispatch::IntegrationTest
+  setup do
+    @session = open_session
+  end
+
+  test "sets xhr redirected to header on redirect requests coming from breezy" do
+    get '/redirect_hash'
+    get response.location
+    assert_nil response.headers['X-XHR-Redirected-To']
+
+    if Rails.version >= '5.0'
+      get '/redirect_hash', headers: { 'HTTP_X_XHR_REFERER' => 'http://www.example.com/' }
+    else
+      get '/redirect_hash', nil, { 'HTTP_X_XHR_REFERER' => 'http://www.example.com/' }
+    end
+    assert_response :redirect
+    assert_nil response.headers['X-XHR-Redirected-To']
+
+    if Rails.version >= '5.0'
+      get response.location, headers: { 'HTTP_X_XHR_REFERER' => nil }
+    else
+      get response.location, nil, { 'HTTP_X_XHR_REFERER' => nil }
+    end
+    assert_equal 'http://www.example.com/breezy/simple_action', response.headers['X-XHR-Redirected-To']
+    assert_response :ok
+
+    if Rails.version >= '5.0'
+      get '/redirect_path', headers: { 'HTTP_X_XHR_REFERER' => 'http://www.example.com/' }
+    else
+      get '/redirect_path', nil, { 'HTTP_X_XHR_REFERER' => 'http://www.example.com/' }
+    end
+    assert_response :redirect
+    assert_nil response.headers['X-XHR-Redirected-To']
+
+    if Rails.version >= '5.0'
+      get response.location, headers: { 'HTTP_X_XHR_REFERER' => nil }
+    else
+      get response.location, nil, { 'HTTP_X_XHR_REFERER' => nil }
+    end
+    assert_equal 'http://www.example.com/breezy/simple_action', response.headers['X-XHR-Redirected-To']
+    assert_response :ok
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class ConfigurationTest < ActiveSupport::TestCase
+  def restore_default_config
+    Breezy.configuration = nil
+    Breezy.configure {}
+  end
+
+  setup do
+    restore_default_config
+  end
+
+  test 'configuration with an empty block defaults to application.js and application.css' do
+    Breezy.configure do |config|
+    end
+
+    track_assets = ['application.js', 'application.css']
+    assert_equal track_assets, Breezy.configuration.track_assets
+  end
+
+  test 'configuration with track_assets specified' do
+    Breezy.configure do |config|
+      config.track_assets = ['app.js']
+    end
+
+    default_track_assets = ['app.js']
+    assert_equal default_track_assets, Breezy.configuration.track_assets
+  end
+end

data/test/dependency_tracker_test.rb

@@ -0,0 +1,66 @@
+# taken from jbuilder's jbuilder_dependency_tracker_test.rb
+
+require 'test_helper'
+require 'breezy_template/dependency_tracker'
+
+
+class FakeTemplate
+  attr_reader :source, :handler
+  def initialize(source, handler = :jbuilder)
+    @source, @handler = source, handler
+  end
+end
+
+
+class BreezyTemplateDependencyTrackerTest < ActiveSupport::TestCase
+  def make_tracker(name, source)
+    template = FakeTemplate.new(source)
+    BreezyTemplate::DependencyTracker.new(name, template)
+  end
+
+  def track_dependencies(source)
+    make_tracker('breezy_template', source).dependencies
+  end
+
+  test 'jbuilder direct partial! feature are not allowed' do
+    dependencies = track_dependencies <<-RUBY
+      json.partial! 'path/to/partial', foo: bar
+      json.partial! 'path/to/another/partial', :fizz => buzz
+    RUBY
+
+    assert_equal [], dependencies
+  end
+
+  test 'detects partial with options (1.9 style)' do
+    dependencies = track_dependencies <<-RUBY
+      json.content hello: 'world', partial: 'path/to/partial', foo: :bar
+    RUBY
+
+    assert_equal %w[path/to/partial], dependencies
+  end
+
+  test 'detects partial with options (1.8 style)' do
+    dependencies = track_dependencies <<-RUBY
+      json.content :hello => 'world', :partial => 'path/to/partial', :foo => :bar
+    RUBY
+
+    assert_equal %w[path/to/partial], dependencies
+  end
+
+  test 'detects partial in indirect collecton calls' do
+    dependencies = track_dependencies <<-RUBY
+      json.comments @post.comments, partial: 'comments/comment', as: :comment
+    RUBY
+
+    assert_equal %w[comments/comment], dependencies
+  end
+
+  test 'detects explicit depedency' do
+    dependencies = track_dependencies <<-RUBY
+      # Template Dependency: path/to/partial
+      json.foo 'bar'
+    RUBY
+
+    assert_equal %w[path/to/partial], dependencies
+  end
+end

data/test/engine_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class EngineTest < ActiveSupport::TestCase
+  test "does not include itself in action controller base when breezy auto include is false" do
+    refute ActionController::Base.included_modules.any? { |m| m.name && m.name.include?('Breezy') }
+  end
+end

data/test/render_test.rb

@@ -0,0 +1,124 @@
+require 'test_helper'
+
+class RenderController < TestController
+  require 'action_view/testing/resolvers'
+
+  append_view_path(ActionView::FixtureResolver.new(
+    'render/action.js.breezy' => 'json.author "john smith"',
+    'render/action.html.erb' => 'john smith',
+    'render/implied_render_with_breezy.js.breezy' => 'json.author "john smith"',
+    'render/implied_render_with_breezy.html.erb' => 'john smith',
+    'layouts/application.html.erb' => "<html><head><%=breezy_tag%></head><body><%=yield%></body></html>"
+  ))
+
+  layout 'application'
+
+  before_action do
+    @_use_breezy_html = false
+  end
+
+  before_action :use_breezy_html, only: [:simple_render_with_breezy, :implied_render_with_breezy]
+
+  def render_action
+    render :action
+  end
+
+  def simple_render_with_breezy
+    render :action
+  end
+
+  def implied_render_with_breezy
+  end
+
+  def render_action_with_breezy_false
+    render :action, breezy: false
+  end
+
+  def form_authenticity_token
+    "secret"
+  end
+end
+
+class RenderTest < ActionController::TestCase
+  tests RenderController
+
+
+  setup do
+    Breezy.configuration.track_assets = ['app.js']
+  end
+
+  teardown do
+    Breezy.configuration.track_assets = []
+  end
+
+  test "render action via get" do
+    get :render_action
+    assert_normal_render 'john smith'
+  end
+
+  test "simple render with breezy" do
+    get :simple_render_with_breezy
+    assert_breezy_html({author: "john smith"})
+  end
+
+  test "implied render with breezy" do
+    get :implied_render_with_breezy
+    assert_breezy_html({author: "john smith"})
+  end
+
+  test "simple render with breezy via get js" do
+    @request.accept = 'application/javascript'
+    get :simple_render_with_breezy
+    assert_breezy_js({author: "john smith"})
+  end
+
+  test "render action via xhr and get js" do
+    @request.accept = 'application/javascript'
+    get :simple_render_with_breezy, xhr: true
+    assert_breezy_js({author: "john smith"})
+  end
+
+  test "render with breezy false" do
+    get :render_action_with_breezy_false
+    assert_normal_render("john smith")
+  end
+
+  test "render with breezy false via xhr get" do
+    @request.accept = 'text/html'
+    get :render_action_with_breezy_false, xhr: true
+    assert_normal_render("john smith")
+  end
+
+  test "render action via xhr and put" do
+    @request.accept = 'text/html'
+    put :render_action, xhr: true
+    assert_normal_render 'john smith'
+  end
+
+  private
+
+  def assert_breezy_html(content)
+    assert_response 200
+    view = @response.request.params['action'].camelcase
+    assert_equal "<html><head><script type='text/javascript'>Breezy.replace((function(){return ({\"data\":#{content.to_json},\"view\":\"Render#{view}\",\"csrf_token\":\"secret\",\"assets\":[\"/app.js\"]});})());</script></head><body></body></html>", @response.body
+    assert_equal 'text/html', @response.content_type
+  end
+
+  def assert_breezy_js(content)
+    assert_response 200
+    assert_equal '(function(){return ({"data":' + content.to_json + ',"view":"RenderSimpleRenderWithBreezy","csrf_token":"secret","assets":["/app.js"]});})()', @response.body
+    assert_equal 'text/javascript', @response.content_type
+  end
+
+  def assert_breezy_replace_js(content)
+    assert_response 200
+    assert_equal 'Breezy.replace((function(){return ({"data":' + content.to_json + ',"csrf_token":"secret","assets":["/app.js"]});})());', @response.body
+    assert_equal 'text/javascript', @response.content_type
+  end
+
+  def assert_normal_render(content)
+    assert_response 200
+    assert_equal "<html><head></head><body>#{content}</body></html>", @response.body
+    assert_equal 'text/html', @response.content_type
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'abstract_controller'
+require 'abstract_controller/railties/routes_helpers'
+require 'action_controller'
+require 'breezy'
+require "active_support"
+require 'active_record'
+require 'active_support/testing/autorun' if Rails.version >= '4'
+require 'active_support/test_case'
+
+ActiveSupport::TestCase.test_order = :random if ActiveSupport::TestCase.respond_to?(:test_order=)
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+Rails.cache = ActiveSupport::Cache::MemoryStore.new
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+require 'support/models'
+require 'support/test_application'
+

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: breezy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johny Ho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: mocha
+  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'
+description: 
+email: jho406@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/assets/javascripts/breezy.coffee
+- lib/breezy.rb
+- lib/breezy/active_support.rb
+- lib/breezy/configuration.rb
+- lib/breezy/cookies.rb
+- lib/breezy/helpers.rb
+- lib/breezy/render.rb
+- lib/breezy/version.rb
+- lib/breezy/x_domain_blocker.rb
+- lib/breezy/xhr_headers.rb
+- lib/breezy/xhr_redirect.rb
+- lib/breezy/xhr_url_for.rb
+- test/blade_helper.rb
+- test/breezy_template_test.rb
+- test/breezy_test.rb
+- test/configuration_test.rb
+- test/dependency_tracker_test.rb
+- test/engine_test.rb
+- test/render_test.rb
+- test/test_helper.rb
+homepage: https://github.com/jho406/breezy/
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Turbolinks for react and rails
+test_files:
+- test/blade_helper.rb
+- test/breezy_template_test.rb
+- test/breezy_test.rb
+- test/configuration_test.rb
+- test/dependency_tracker_test.rb
+- test/engine_test.rb
+- test/render_test.rb
+- test/test_helper.rb