jsdebug-rails 0.1.0

data/lib/generators/jsdebug/install/install_generator.rb

@@ -0,0 +1,18 @@
+module Jsdebug
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_install
+        copy_file "jsdebug.js", "app/assets/javascripts/jsdebug.js"
+      end
+
+      def inject_jsdebug
+        inject_into_file "app/assets/javascripts/application.js", :before => "//= require_tree" do
+          "//= require_environment 'jsdebug' 'development'\n"
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/jsdebug/install/templates/jsdebug.js

@@ -0,0 +1,203 @@
+/*!
+ * Rails Jsdebug
+ * Dual licensed under the MIT and GPL licenses.
+ *
+ * Based upon the plugin by "Cowboy" Ben Alman
+ * http://benalman.com/projects/javascript-debug-console-log/
+ */
+
+// Script: JavaScript Debug: A simple wrapper for console.log
+// Tested with Internet Explorer 6-8, Firefox 3-3.6, Safari 3-4, Chrome 3-5, Opera 9.6-10.5
+//
+// About: License
+// Dual licensed under the MIT and GPL licenses.
+//
+// About: Support and Testing
+// Information about what browsers this code has been tested in.
+//
+// Browsers Tested - Internet Explorer 6-8, Firefox 3-3.6, Safari 3-4, Chrome
+// 3-5, Opera 9.6-10.5
+//
+// About: Examples
+//
+// These working examples, complete with fully commented code, illustrate a few
+// ways in which this plugin can be used.
+//
+// Examples - http://benalman.com/code/projects/javascript-debug/examples/debug/
+//
+// Topic: Pass-through console methods
+//
+// assert, clear, count, dir, dirxml, exception, group, groupCollapsed,
+// groupEnd, profile, profileEnd, table, time, timeEnd, trace
+//
+// These console methods are passed through (but only if both the console and
+// the method exists), so use them without fear of reprisal.
+
+window.debug = (function(){
+  var window = this,
+
+    // Some convenient shortcuts.
+    aps = Array.prototype.slice,
+    con = window.console,
+
+    // Public object to be returned.
+    that = {},
+
+    callback_func,
+    callback_force,
+
+    // Logging methods, in "priority order". Not all console implementations
+    // will utilize these, but they will be used in the callback passed to
+    // setCallback.
+    log_methods = [ 'error', 'warn', 'info', 'debug', 'log' ],
+
+    // Pass these methods through to the console if they exist, otherwise just
+    // fail gracefully. These methods are provided for convenience.
+    pass_methods = 'assert clear count dir dirxml exception group groupCollapsed groupEnd profile profileEnd table time timeEnd trace'.split(' '),
+    idx = pass_methods.length,
+
+    // Logs are stored here so that they can be recalled as necessary.
+    logs = [];
+
+  while ( --idx >= 0 ) {
+    (function( method ){
+
+      // Generate pass-through methods. These methods will be called, if they
+      // exist, as long as the logging level is non-zero.
+      that[ method ] = function() {
+        con && con[ method ]
+          && con[ method ].apply( con, arguments );
+      }
+
+    })( pass_methods[idx] );
+  }
+
+  idx = log_methods.length;
+  while ( --idx >= 0 ) {
+    (function( idx, level ){
+
+      // Method: debug.log
+      //
+      // Call the console.log method if available. Adds an entry into the logs
+      // array for a callback .
+      //
+      // Usage:
+      //
+      //  debug.log( object [, object, ...] );                               - -
+      //
+      // Arguments:
+      //  object - (Object) Any valid JavaScript object.
+
+      // Method: debug.debug
+      //
+      // Call the console.debug method if available, otherwise call console.log.
+      // Adds an entry into the logs array.
+      //
+      // Usage:
+      //
+      //  debug.debug( object [, object, ...] );                             - -
+      //
+      // Arguments:
+      //
+      //  object - (Object) Any valid JavaScript object.
+
+      // Method: debug.info
+      //
+      // Call the console.info method if available, otherwise call console.log.
+      // Adds an entry into the logs array.
+      //
+      // Usage:
+      //
+      //  debug.info( object [, object, ...] );                              - -
+      //
+      // Arguments:
+      //
+      //  object - (Object) Any valid JavaScript object.
+
+      // Method: debug.warn
+      //
+      // Call the console.warn method if available, otherwise call console.log.
+      // Adds an entry into the logs array.
+      //
+      // Usage:
+      //
+      //  debug.warn( object [, object, ...] );                              - -
+      //
+      // Arguments:
+      //
+      //  object - (Object) Any valid JavaScript object.
+
+      // Method: debug.error
+      //
+      // Call the console.error method if available, otherwise call console.log.
+      // Adds an entry into the logs array.
+      //
+      // Usage:
+      //
+      //  debug.error( object [, object, ...] );                             - -
+      //
+      // Arguments:
+      //
+      //  object - (Object) Any valid JavaScript object.
+
+      that[ level ] = function() {
+        var args = aps.call( arguments ),
+          log_arr = [ level ].concat( args );
+
+        logs.push( log_arr );
+        exec_callback( log_arr );
+
+        if ( !con ) { return; }
+
+        con.firebug ? con[ level ].apply( window, args )
+          : con[ level ] ? con[ level ]( args )
+          : con.log( args );
+      };
+
+    })( idx, log_methods[idx] );
+  }
+
+  // Execute the callback function if set.
+  function exec_callback( args ) {
+    if ( callback_func && (callback_force || !con || !con.log) ) {
+      callback_func.apply( window, args );
+    }
+  };
+
+  // Method: debug.setCallback
+  //
+  // Set a callback to be used if logging isn't possible due to console.log
+  // not existing. If unlogged logs exist when callback is set, they will all
+  // be logged immediately unless a limit is specified.
+  //
+  // Usage:
+  //
+  //  debug.setCallback( callback [, force ] [, limit ] )
+  //
+  // Arguments:
+  //
+  //  callback - (Function) The aforementioned callback function. The first
+  //    argument is the logging level, and all subsequent arguments are those
+  //    passed to the initial debug logging method.
+  //  force - (Boolean) If false, log to console.log if available, otherwise
+  //    callback. If true, log to both console.log and callback.
+  //  limit - (Number) If specified, number of lines to limit initial scrollback
+  //    to.
+
+  that.setCallback = function() {
+    var args = aps.call( arguments ),
+      max = logs.length,
+      i = max;
+
+    callback_func = args.shift() || null;
+    callback_force = typeof args[0] === 'boolean' ? args.shift() : false;
+
+    i -= typeof args[0] === 'number' ? args.shift() : max;
+
+    while ( i < max ) {
+      exec_callback( logs[i++] );
+    }
+  };
+
+  return that;
+})();

data/lib/jsdebug-rails.rb

@@ -0,0 +1,19 @@
+
+module Jsdebug
+  module Rails
+    require 'jsdebug/directive_processor'
+    require 'jsdebug/processor'
+    require 'jsdebug/railtie'
+    require "jsdebug/version"
+  end
+end
+
+# TODO: Remove in 1.0.0 Version
+if defined?(Rails::VERSION::STRING) && Rails::VERSION::STRING.match(/^3\.1\.0\.beta/)
+  message = "WARNING: Jsdebug-rails #{Jsdebug::Rails::VERSION} is incompatible with Rails #{Rails::VERSION::STRING}. Please upgrade to Rails 3.1.0.rc1 or higher."
+  if defined?(Rails.logger) && Rails.logger
+    Rails.logger.warn(message)
+  else
+    warn(message)
+  end
+end

data/lib/jsdebug/directive_processor.rb

@@ -0,0 +1,11 @@
+module Jsdebug
+  module Rails
+
+    class DirectiveProcessor < Sprockets::DirectiveProcessor
+
+      def process_require_environment_directive(path, environment="production development test")
+        process_require_directive(path) if environment.include? ::Rails.env
+      end
+    end
+  end
+end

data/lib/jsdebug/processor.rb

@@ -0,0 +1,63 @@
+require 'tilt'
+
+module Jsdebug
+  module Rails
+    class Processor < Tilt::Template
+      # TODO: More control can be given here for customization.
+      # log levels are(0..4): :debug, :info, :warn, :error, and :fatal
+      def is_jsdebug_allowed?
+        ::Rails.logger.level == 0
+      end
+
+      def prepare
+      end
+
+      def evaluate(context, locals, &block)
+        #      return data if is_jsdebug_allowed?
+
+        log_methods = %w[log debug info warn error].
+          map{|c| Regexp.escape "debug.#{c}"}
+        block_methods = %w[start end].
+          map{|c| Regexp.escape "debug_#{c}"}
+        pass_methods = %w[assert clear count dir dirxml exception group groupCollapsed groupEnd profile profileEnd table time timeEnd trace].
+          map{|c| Regexp.escape "debug.#{c}"}
+
+
+        log_regex = Regexp.new log_methods.map{|c| "#{c}#{Regexp.escape '('}"}.join("|")
+        debug_regex = Regexp.new (log_methods + pass_methods).join("|")
+        any_debug_regex = Regexp.new (log_methods + pass_methods + block_methods).join("|")
+
+        if %w[jsdebug jquery jquery_ujs jquery-ui].include? name || !data =~ any_debug_regex
+          return data
+        end
+
+        new_data = []
+        index = 0
+        debug_block = false
+        data.each_line do |line|
+          index += 1
+
+          if(is_jsdebug_allowed? && line.match(log_regex))
+            cmd = line.scan(log_regex).first
+            new_data << line.gsub(cmd, "#{cmd}'[#{name}::#{index}]', ")
+          else
+            if (!is_jsdebug_allowed?)
+              if line.match(/debug_start/)
+                debug_block = true
+              elsif line.match(/debug_end/)
+                debug_block = false
+                next
+              end
+
+              next if debug_block
+            end
+
+            new_data << line if !line.match(debug_regex)
+          end
+        end
+
+        return new_data.join("")
+      end
+    end
+  end
+end

data/lib/jsdebug/railtie.rb

@@ -0,0 +1,13 @@
+require "rails"
+module Jsdebug
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do |app|
+        app.assets.unregister_processor 'application/javascript', Sprockets::DirectiveProcessor
+        app.assets.register_processor 'application/javascript', Jsdebug::Rails::DirectiveProcessor
+
+        app.assets.register_processor 'application/javascript', Jsdebug::Rails::Processor
+      end
+    end
+  end
+end

data/lib/jsdebug/version.rb

@@ -0,0 +1,5 @@
+module Jsdebug
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: jsdebug-rails
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Peterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    - - "!="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sprockets
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.beta.10
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.14"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0.rc.6
+  type: :development
+  version_requirements: *id005
+description: Jsdebug extends the asset pipeline for javascript logging.
+email: 
+- jeremy.g.peterson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/jsdebug/install/install_generator.rb
+- lib/generators/jsdebug/install/templates/jsdebug.js
+- lib/jsdebug/directive_processor.rb
+- lib/jsdebug/processor.rb
+- lib/jsdebug/railtie.rb
+- lib/jsdebug/version.rb
+- lib/jsdebug-rails.rb
+homepage: http://rubygems.org/gems/jsdebug-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: jsdebug-rails
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Provides javascript loging for development and removes statements when in production.
+test_files: []
+