lena 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af1c091763d076159eb0bf25c8a8dc5c324108fb
+  data.tar.gz: 61316f9e5b1c8acad448fc65753c7038202546c6
+SHA512:
+  metadata.gz: 7f6409860c8a4d0ea141264dd6a478e16d5dd3ef6ad26db77273658763fcb943a2ec53b16ccee02b4503a46210b2e987453f4c2983437c87d2c4f29404bfd18d
+  data.tar.gz: a562b29218b58b5f36ca29f88c636842bfa57643bcc537b1bc620f3250f84e429eea364533a1a2e87137a3fd77a4a6495d27f5d69fe563a9db2d4d93ba1aae05

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Whitney Young
+
+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.rdoc

@@ -0,0 +1,48 @@
+= Leña {<img src="https://secure.travis-ci.org/wbyoung/lena.png"/>}[http://travis-ci.org/wbyoung/lena] {<img src="https://codeclimate.com/github/wbyoung/lena.png"/>}[https://codeclimate.com/github/wbyoung/lena] {<img src="https://coveralls.io/repos/wbyoung/lena/badge.png"/>}[https://coveralls.io/r/wbyoung/lena]
+
+Leña provides simple server-side JavaScript error logging for production Rails applications. This allows you to better track errors that occur in your front-end code.
+
+== Installation
+
+Add the following to your +application.js+:
+
+    //= require lena
+
+Add the following to your +routes.rb+:
+
+    mount Lena::Engine => "/lena"
+
+Update your +application.html.erb+:
+
+  <%= javascript_include_tag "application", lena.configuration %>
+
+If you use Turbolinks or provide other options for your javascript include, you can merge them: <tt>lena.configuration.merge("data-something" => true)</tt>.
+
+== Usage Client Side
+
+Leña will now track all exceptions that are thrown in your application. You can also use Leña to log individual errors without throwing an exception. In your JavaScript, simply:
+
+    lena.log('My Error Message')
+
+== Usage Server Side
+
+Leña will simply throw an exception, <tt>Lena::JavaScriptError</tt>, when it receives a log message. Why? Because you should be using {something}[https://github.com/smartinez87/exception_notification] to report server errors when they occur. Also that's basically what's happening on the client side, so why not throw an exception on the server?
+
+If you need to configure what Leña does, you can add +config/initializers/lena.rb+:
+
+    Lena.setup do |config|
+      config.javascript_handler = Proc.new do |params|
+        # Custom handling of log message here
+      end
+    end
+
+
+== Alternative Setup
+
+An alternative to setting up Leña on your +application.js+ file is to import Leña separately. This may impact performance, but it will catch compiler errors in any scripts included after it:
+
+  <%= javascript_include_tag "lena", lena.configuration %>
+
+== License
+
+This project is distributed under the MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+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    = 'Lena'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/app/assets/javascripts/lena.coffee

@@ -0,0 +1,78 @@
+throw new Error('Lena has already been loaded!') if window.lena != undefined
+
+# Global settings for Leña read from the script element that loaded this.
+Settings = do ->
+  elements = document.getElementsByTagName 'script'
+  read = (attribute) ->
+    attributes = (el.getAttribute(attribute) for el in elements)
+    attributes = (attribute for attribute in attributes when attribute)
+    attributes[0]
+  destination: read('data-lena-destination')
+  submitURL: read('data-lena-url')
+
+# The handlers for each type of logging.
+# These take an object with the following properties:
+#   message: The error message
+#   stacktrace: The stack trace that led to the error (could be null)
+handlers =
+  remote: (data) ->
+    query = for key, value of data when value
+      "#{key}=#{encodeURIComponent(value)}"
+    xhr = new XMLHttpRequest()
+    xhr.open "post", Settings.submitURL, true
+    xhr.setRequestHeader 'Content-type', 'application/x-www-form-urlencoded'
+    xhr.send query.join('&')
+
+  local: (data) ->
+    message = data.message
+    message = "#{message}\n#{data.stacktrace}" if data.stacktrace
+
+    if console?.warn
+      console.warn(message)
+    else if console?.log
+      console.log(message)
+    else
+      alert(message)
+
+# The main Leña handler. All user calls go through here. The final
+# data is aggregated before it is dispatched to one of the handlers.
+lena = (message, stacktrace, destinations=[]) ->
+  if stacktrace == undefined
+    try
+      throw new Error('')
+    catch e
+      stacktrace = e.stack
+    try
+      stacktrace = stacktrace.split("\n")[2..].join("\n")
+    try
+      stacktrace ||= 'unsupported'
+
+  data =
+    message: message
+    stacktrace: stacktrace
+
+  handlers[d](data) for d in destinations
+
+# Log a message via Leña. This uses the configuration values to determine
+# where the message should be sent (remote/local/both).
+lena.log = (message, stacktrace) ->
+  destinations = []
+  switch Settings.destination
+    when 'local' then destinations = ['local']
+    when 'remote' then destinations = ['remote']
+    else destinations = ['local', 'remote']
+  lena(message, stacktrace, destinations)
+
+# Log a message via Leña. Only logs remote (server).
+lena.remote = (message, stacktrace) ->
+  lena(message, stacktrace, ['remote'])
+
+# Log a message via Leña. Only logs to local (browser).
+lena.local = (message, stacktrace) ->
+  lena(message, stacktrace, ['local'])
+
+window.lena = lena
+window.lena.onerror = window.onerror
+window.onerror = (exception, url, linenum) ->
+  lena.log("#{exception}\nResource: #{url}:#{linenum}", null)
+  if lena.onerror then lena.onerror() else true

data/app/controllers/lena/lena_controller.rb

@@ -0,0 +1,8 @@
+module Lena
+  class LenaController < ActionController::Base
+    def log
+      Lena::Engine.config.javascript_handler.call params
+      render text: ""
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Lena::Engine.routes.draw do
+  post 'log', to: 'lena#log', as: :submission
+end

data/lib/lena.rb

@@ -0,0 +1,4 @@
+require "lena/engine"
+
+module Lena
+end

data/lib/lena/engine.rb

@@ -0,0 +1,20 @@
+require 'lena/rails/routing'
+
+module Lena
+  class JavaScriptError < Exception; end
+
+  class Engine < ::Rails::Engine
+    isolate_namespace Lena
+    initializer "lena.assets.precompile" do |app|
+      app.config.assets.precompile += %w(lena.js)
+    end
+
+    config.javascript_handler = Proc.new do
+      raise JavaScriptError.new
+    end
+  end
+
+  def self.setup
+    yield Engine.config
+  end
+end

data/lib/lena/rails/routing.rb

@@ -0,0 +1,7 @@
+require 'lena/routing'
+
+module ActionDispatch::Routing
+  class RoutesProxy
+    include Lena::Routing
+  end
+end

data/lib/lena/routing.rb

@@ -0,0 +1,13 @@
+module Lena
+  # Extending the object that's returned from rails routing helpers (for
+  # instance +main_app+ or +lena+) that allow calling specific URL helper
+  # methods.
+  module Routing
+    def configuration
+      return {
+        'data-lena-destination' => Rails.env.development? ? "local" : "",
+        'data-lena-url' => self.submission_path,
+      }
+    end
+  end
+end

data/lib/lena/version.rb

@@ -0,0 +1,3 @@
+module Lena
+  VERSION = "0.0.1"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require lena
+//= require_tree .

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/views/application/index.html

@@ -0,0 +1,3 @@
+<h1>Home Page</h1>
+<script type="text/javascript">
+</script>

data/spec/dummy/app/views/application/log.html

@@ -0,0 +1,4 @@
+<h1>Error Generating Page</h1>
+<script type="text/javascript">
+lena.log('Simple error log')
+</script>

data/spec/dummy/app/views/application/throw.html

@@ -0,0 +1,4 @@
+<h1>Error Generating Page</h1>
+<script type="text/javascript">
+throw new Error('Simple error throw');
+</script>

data/spec/dummy/app/views/application/throw_callstack.html

@@ -0,0 +1,10 @@
+<h1>Error Generating Page</h1>
+<script type="text/javascript">
+function callUndefined() {
+  undefinedFunctionCall();
+}
+function begin() {
+  callUndefined();
+}
+begin();
+</script>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= javascript_include_tag "application", lena.configuration.merge("data-turbolinks-track" => true) %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require "lena"
+
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,9 @@
+Dummy::Application.configure do
+  config.cache_classes = false
+  config.eager_load = false
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.action_mailer.raise_delivery_errors = false
+  config.active_support.deprecation = :log
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,12 @@
+Dummy::Application.configure do
+  config.cache_classes = true
+  config.eager_load = false
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.action_controller.allow_forgery_protection = false
+  config.action_mailer.delivery_method = :test
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/lena.rb

@@ -0,0 +1,10 @@
+
+# For testing, we'll store all events into an array
+Lena.class.send(:cattr_accessor, :events)
+Lena.events = []
+
+Lena.setup do |config|
+  config.javascript_handler = Proc.new do |params|
+    Lena.events << params
+  end
+end

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+Dummy::Application.config.secret_key_base = '71332c3167f676af35edf85850150c3d311af76e1888679e5b424459a8045ba9bdfcd07ddf39a45db4e11922ab74a14a5b6e7e82a5f1d8014affcfc266ecab74'

data/spec/dummy/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  mount Lena::Engine => "/lena"
+  root to: 'application#index'
+  get 'log', to: 'application#log'
+  get 'throw', to: 'application#throw'
+  get 'throw_callstack', to: 'application#throw_callstack'
+end