rconsole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5308fb25a24e1518c04da5afe10620bd20661818
+  data.tar.gz: 6f5eed2802219b004f805273e8bc0beb59445299
+SHA512:
+  metadata.gz: 69ef0459617c51621d361f76e0a6ea0916010bc63c69c1aace575f74bb854f90b8c18498e86a385dafc2822720c865bf83b44147b698c012f87e70d962b28361
+  data.tar.gz: 3f0346b120701edad2486522e59a6be1573d0fefefd09cb9701bc57be8affd03487b8548ee89c4c545d366e8bb4574fbb2299bd95e8540417ca6edd5c8ef40e1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Sergey Rezvanov
+
+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,53 @@
+Rconsole
+========
+
+Rconsole is a Rails plugin which allows you to output debug messages from ruby code to the
+browser console.
+
+## Installation
+
+First add the following lines to your application `Gemfile`:
+
+``` ruby
+group :development
+  gem 'rconsole', '~> 0.1.0'
+end
+```
+
+Then run `bundle install` to update your's gems bundle.
+
+Now you need include `rconsole.js` asset file by adding the following lines to
+your layout view:
+
+``` ruby
+javascript_include_tag(:rconsole) if Rails.env.development?
+```
+
+Really easy!
+
+## Usage
+
+Just use `rconsole.log` anywhere you need, e.g:
+
+``` ruby
+class HomeController < ActionController::Base
+  def index
+    rconsole.log 'Hello from Ruby!'
+    respond_with({})
+  end
+end
+```
+
+Then you will see the message on your browser console. Just like this:
+
+![Hello from Ruby!](https://dl.dropboxusercontent.com/u/11845683/hello_from_ruby.png)
+
+Enjoy!
+
+## Contributors
+
++ [Sergey Rezvanov](http://github.com/rezwyi)
+
+## Copyright
+
+See LICENSE file.

data/app/controllers/rconsole_controller.rb

@@ -0,0 +1,7 @@
+class RconsoleController < ActionController::Base
+  respond_to :json
+
+  def dump
+    respond_with rconsole.dump
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get '/rconsole' => 'rconsole#dump'
+end

data/lib/rconsole.rb

@@ -0,0 +1,5 @@
+require 'rconsole/version'
+require 'rconsole/base'
+require 'rconsole/helpers'
+require 'rconsole/middleware'
+require 'rconsole/engine'

data/lib/rconsole/base.rb

@@ -0,0 +1,21 @@
+require 'singleton'
+
+module Rconsole
+  class Base
+    include Singleton
+
+    def initialize
+      @dump = []
+    end
+
+    def log(message)
+      @dump << message
+    end
+
+    def dump
+      dump = @dump.dup
+      @dump.clear
+      dump
+    end
+  end
+end

data/lib/rconsole/engine.rb

@@ -0,0 +1,21 @@
+module Rconsole
+  class Engine < ::Rails::Engine
+    initializer 'rconsole.middleware' do |app|
+      app.middleware.use Rconsole::Middleware
+    end
+    
+    initializer 'rconsole.include_helpers' do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :include, Rconsole::Helpers
+      end
+
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, Rconsole::Helpers
+      end
+
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, Rconsole::Helpers
+      end
+    end
+  end
+end

data/lib/rconsole/helpers.rb

@@ -0,0 +1,13 @@
+module Rconsole
+  module Helpers
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def rconsole
+        Base.instance
+      end
+    end
+  end
+end

data/lib/rconsole/middleware.rb

@@ -0,0 +1,14 @@
+module Rconsole
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call env
+    rescue Exception => e
+      Rconsole::Base.instance.dump
+      raise e
+    end
+  end
+end

data/lib/rconsole/version.rb

@@ -0,0 +1,3 @@
+module Rconsole
+  VERSION = '0.1.0'
+end

data/rconsole.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/rconsole/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'rconsole'
+  s.summary = 'Simple way to print debug messages from ruby code directly to browser console'
+  s.description = s.summary
+  
+  s.version = Rconsole::VERSION
+  s.platform  = Gem::Platform::RUBY
+
+  s.authors = ['Sergey Rezvanov']
+  s.email = ['sergey@rezvanov.info']
+  s.homepage = 'https://github.com/rezwyi/rconsole'
+
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+end

data/vendor/assets/javascripts/rconsole.js

@@ -0,0 +1,23 @@
+var Rconsole = {};
+XMLHttpRequest.prototype.originOpen = XMLHttpRequest.prototype.open;
+
+(Rconsole.dump = function() {
+  var xhr = new XMLHttpRequest()
+      dump = []
+      i = 0;
+  
+  xhr.originOpen('get', '/rconsole.json', false);
+  xhr.send();
+  
+  if (xhr.readyState === 4 && xhr.status === 200) {
+    dump = JSON.parse(xhr.responseText);
+    for (i; i < dump.length; i++) console.log(dump[i]);
+  }
+})();
+
+XMLHttpRequest.prototype.open = function() {
+  this.addEventListener('readystatechange', function(){
+    if (this.readyState === 4 && this.status === 200) Rconsole.dump();
+  });
+  XMLHttpRequest.prototype.originOpen.apply(this, arguments);
+}

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rconsole
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Rezvanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-08 00:00:00.000000000 Z
+dependencies: []
+description: Simple way to print debug messages from ruby code directly to browser
+  console
+email:
+- sergey@rezvanov.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- app/controllers/rconsole_controller.rb
+- config/routes.rb
+- lib/rconsole.rb
+- lib/rconsole/base.rb
+- lib/rconsole/engine.rb
+- lib/rconsole/helpers.rb
+- lib/rconsole/middleware.rb
+- lib/rconsole/version.rb
+- rconsole.gemspec
+- vendor/assets/javascripts/rconsole.js
+homepage: https://github.com/rezwyi/rconsole
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Simple way to print debug messages from ruby code directly to browser console
+test_files: []