better_sjr 1.0.0.beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bd12e13eaff8aea79b56f44d00afca72bc3fd95
+  data.tar.gz: 9a51b6f72a7e889b23d832bc67b1d6ca0002c459
+SHA512:
+  metadata.gz: 56b2ae8d222a50dfeadbadaca8b62846d693a84f4235801f99f8179aadc45822fae62c76f49013c5781fd4388da8d9a896c7ec78d6f3b9fc7a27ccca9241e9b0
+  data.tar.gz: da74643c1df10443d27f5c8f7f89e2fb5174911bccfb28a3aa2e37fd29a2a4927e9febde9aa82d058888a780a2ad2eae78fe2be31c31f5defc0cbda8eaaf94b4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/*.gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1
+gemfile:
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.0.gemfile
+matrix:
+  exclude:
+    - rvm: 2.1
+      gemfile: gemfiles/rails_5.0.gemfile
+before_install: gem install bundler -v 1.13.6

data/Appraisals

@@ -0,0 +1,27 @@
+if RUBY_VERSION >= "2.2.2"
+
+  appraise "rails-5.0" do
+    gem "rails", "~> 5.0.0"
+  end
+
+end
+
+appraise "rails-4.2" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails-4.1" do
+  gem "rails", "~> 4.1.0"
+end
+
+appraise "rails-4.0" do
+  gem "rails", "~> 4.0.0"
+end
+
+appraise "rails-3.2" do
+  gem "rails", "~> 3.2.0"
+
+  if RUBY_VERSION >= "2.2.2"
+    gem "test-unit", "~> 3.0"
+  end
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,62 @@
+# BetterSJR
+
+[![Build Status](https://travis-ci.org/carlosramireziii/better_sjr.svg?branch=master)](https://travis-ci.org/carlosramireziii/better_sjr)
+[![Inline docs](http://inch-ci.org/github/carlosramireziii/better_sjr.svg?branch=master)](http://inch-ci.org/github/carlosramireziii/better_sjr)
+
+BetterSJR improves server-generated JavaScript (SJR) responses in Rails by adding error messages for debugging. 
+
+When enabled, all SJR response templates will be automatically wrapped in a try-catch statement, 
+and the error message of any thrown exception will be printed to the console. 
+
+For more information on common SJR errors, [read this article](http://www.carlosramireziii.com/3-reasons-why-your-sjr-template-isnt-working.html?utm_source=github&utm_campaign=better_sjr).
+
+## Requirements
+
+### Ruby and Rails
+
+This gem has been tested against Ruby **>= 2.1** and Rails **>= 4.0**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'better_sjr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better_sjr
+
+## Usage
+
+Debugging is not enabled by default. 
+
+To enable in development only (recommended), add an initializer and set `debug_sjr`.
+
+```ruby
+# config/initializers/better_sjr.rb
+BetterSJR.debug_sjr = Rails.env.development?
+```
+
+JavaScript runtime errors will now be caught and printed to the browser console instead of failing silently.
+
+![Image of JavaScript runtime error in browser console](docs/assets/javascript_runtime_error_in_console.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carlosramireziii/better_sjr.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/better_sjr.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'better_sjr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "better_sjr"
+  spec.version       = BetterSJR::VERSION
+  spec.authors       = ["Carlos Ramirez III"]
+  spec.email         = ["carlos.e.ramirez.iii@gmail.com"]
+
+  spec.summary       = %q{Improvements to server-generated JavaScript (SJR) responses in Rails}
+  spec.homepage      = "https://github.com/carlosramireziii/better_sjr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if RUBY_VERSION < '2.2.2'
+    spec.add_development_dependency "activesupport", "< 5"
+  else
+    spec.add_development_dependency "activesupport"
+  end
+  spec.add_development_dependency "appraisal", "~> 2.1"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "combustion", "~> 0.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.5"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "better_sjr"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_DISABLE_SHARED_GEMS: "true"

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+gem "test-unit", "~> 3.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+
+gemspec :path => "../"

data/lib/better_sjr/on_load_action_view.rb

@@ -0,0 +1 @@
+ActionView::Renderer.prepend BetterSJR::RendererExtensions

data/lib/better_sjr/railtie.rb

@@ -0,0 +1,12 @@
+require "rails"
+
+module BetterSJR
+  # Makes BetterSJR behavior available to Rails apps on initialization
+  class Railtie < Rails::Railtie
+    initializer "better_sjr.initialize" do
+      ActiveSupport.on_load(:action_view) do
+        require "better_sjr/on_load_action_view"
+      end
+    end
+  end
+end

data/lib/better_sjr/renderer_extensions.rb

@@ -0,0 +1,27 @@
+module BetterSJR
+  # Wraps JavaScript formatted templates in a try-catch statement when rendered
+  module RendererExtensions
+    # Overrides default behavior by wrapping rendered content in a try-catch
+    # statement.
+    #
+    # If debugging is enabled and the template is JavaScript format, wrap the
+    # rendered content in a try-catch statement.
+    #
+    # @return [String] the rendered template content
+    def render_template(*)
+      if debugging_sjr? && rendering_js?
+        TryCatchStatement.new(super).wrapped_code
+      else
+        super
+      end
+    end
+
+    def debugging_sjr?
+      BetterSJR.debug_sjr
+    end
+
+    def rendering_js?
+      lookup_context.rendered_format.to_s == "js"
+    end
+  end
+end

data/lib/better_sjr/try_catch_statement.rb

@@ -0,0 +1,27 @@
+module BetterSJR
+  # Wraps a given code snippet in a JavaScript try-catch statement
+  class TryCatchStatement
+    # @return [String] the code without a try-catch statement surrounding it
+    attr_accessor :original_code
+
+    # Returns a new instance of TryCatchStatement
+    #
+    # @param code [String] the code to be surrounded by a try-catch statement
+    def initialize(code)
+      @original_code = code
+    end
+
+    # Wraps the original code in a try-catch statement
+    #
+    # @return [String] the try-catch statement
+    def wrapped_code
+      <<-TRYCATCH
+        try {
+          #{original_code}
+        } catch(e) {
+          console.error("Rails SJR error", e);
+        }
+      TRYCATCH
+    end
+  end
+end

data/lib/better_sjr/version.rb

@@ -0,0 +1,3 @@
+module BetterSJR
+  VERSION = "1.0.0.beta2".freeze
+end

data/lib/better_sjr.rb

@@ -0,0 +1,13 @@
+require "better_sjr/version"
+require "better_sjr/renderer_extensions"
+require "better_sjr/try_catch_statement"
+require "better_sjr/railtie"
+
+# Facilitates better debugging of Rails SJR templates
+module BetterSJR
+  class << self
+    # Controls whether or not debugging behavior is enabled
+    # @return [Boolean] value
+    attr_accessor :debug_sjr
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: better_sjr
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta2
+platform: ruby
+authors:
+- Carlos Ramirez III
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+description: 
+email:
+- carlos.e.ramirez.iii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better_sjr.gemspec
+- bin/console
+- bin/setup
+- config.ru
+- docs/assets/javascript_runtime_error_in_console.png
+- gemfiles/.bundle/config
+- gemfiles/rails_3.2.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- lib/better_sjr.rb
+- lib/better_sjr/on_load_action_view.rb
+- lib/better_sjr/railtie.rb
+- lib/better_sjr/renderer_extensions.rb
+- lib/better_sjr/try_catch_statement.rb
+- lib/better_sjr/version.rb
+homepage: https://github.com/carlosramireziii/better_sjr
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Improvements to server-generated JavaScript (SJR) responses in Rails
+test_files: []