code_buddy 0.0.8 → 0.1.0

data/README.rdoc

@@ -2,9 +2,17 @@
 
 CodeBuddy makes it easy for you to understand the code behind each line of a Ruby exception stack.  When something goes wrong during development and you get an exception do you read through the stack trace and  start opening files in VIM or TextMate?  With CodeBuddy the stack trace and source files are all available in your browser making it easy to understand what's going on.
 
+{See a Live Demo of CodeBuddy}[http://www.alexrothenberg.com/examples/code_buddy/]
+
 == Use it in your Rails app
 
-Simply add one line to your app's Gemfile and the Rails exception page just got better.
+Follow the instructions below to add CodeBuddy to your Rails 3 or Rails 2 app then the Rails exception page just got better.
+
+Make sure you've set the config setting config.consider_all_requests_local=true (it should already be that way in development.rb).  Now whenever you see a exception page you'll be able to click on the stack and see it inside CodeBuddy.
+
+=== Rails 3
+
+Add one line to your app's Gemfile.
 
   gem 'code_buddy'
 
@@ -12,13 +20,17 @@ And install it:
 
   $ bundle install
 
-Now when you're running in development (or any environment with config.consider_all_requests_local=true) whenever you see a exception page you'll be able to click on the stack and see it inside CodeBuddy.
+=== Rails 2
+
+Add these two lines to your environment.rb
+
+  config.gem 'code_buddy'
+  config.middleware.use "CodeBuddy::ShowApp"
 
-== Run as a Sinatra app
+== Run as a standalone app
 
   $ gem install code_buddy
-  $ code_buddy
-  == Sinatra/1.1.0 has taken the stage on 4567 for development with backup from Mongrel
+  $ code_buddy start
 
 Now open http://localhost:4567 and paste your stack.
 

data/lib/code_buddy/app.rb

@@ -2,7 +2,7 @@ module CodeBuddy
   class App < Sinatra::Base
     set :views,  File.expand_path(File.dirname(__FILE__) + '/views')
     set :public, File.expand_path(File.dirname(__FILE__) + '/public')
-    
+
     class << self
       attr_reader   :stack
       attr_accessor :path_prefix
@@ -20,15 +20,6 @@ module CodeBuddy
       redirect "#{path_prefix}/stack"
     end
 
-    get '/new' do
-      erb :form
-    end
-
-    post '/new' do
-      self.class.stack_string = params[:stack]
-      redirect "#{path_prefix}/stack"
-    end
-
     get '/stack' do
       display_stack(0)
     end
@@ -38,7 +29,16 @@ module CodeBuddy
       display_stack(params[:selected].to_i)
     end
 
+    post '/new' do
+      return 'Sorry CodeBuddy cannot paste a stack unless CodeBuddy is running locally.  This is for your own safety.' unless local_request?
+
+      self.class.stack_string = params[:stack]
+      redirect "#{path_prefix}/stack"
+    end
+
     get '/edit/:selected' do
+      return "Sorry CodeBuddy cannot edit a file unless CodeBuddy is running locally"                      unless local_request?
+
       self.class.stack.edit(params[:selected].to_i)
     end
 
@@ -49,8 +49,13 @@ module CodeBuddy
     end
 
     def path_prefix
-      self.class.path_prefix 
+      self.class.path_prefix
+    end
+
+    def local_request?
+      request.ip == '127.0.0.1'
     end
 
+
   end
 end

data/lib/code_buddy/middleware.rb

@@ -2,12 +2,14 @@ module CodeBuddy
   class ShowApp
     def initialize(app)
       @app = app
+
+      CodeBuddy::App.path_prefix = '/code_buddy'
     end
 
     def call(env)
-      if env['PATH_INFO'] =~ /^\/code_buddy(.*)/ #&& Rails.env.development?
-        env['PATH_INFO'] = $1
-        App.new.call(env)
+      if env['PATH_INFO'] =~ /^\/code_buddy(.*)/
+        env['PATH_INFO'] = $1 #strip the code_buddy/ prefix
+        CodeBuddy::App.new.call(env)
       else
         @app.call(env)
       end

data/lib/code_buddy/public/javascripts/code_buddy.js

@@ -10,7 +10,7 @@ CodeBuddy.backbone.Address = Backbone.Model.extend({
 
 CodeBuddy.backbone.Addresses = Backbone.Collection.extend({
   model:CodeBuddy.backbone.Address,
-  
+
   bookmarked: function() {
     return this.select(function(address){
       return address.get('bookmarked');
@@ -23,7 +23,7 @@ CodeBuddy.backbone.Stack = Backbone.Model.extend({
     _.bindAll(this, 'toggleBookmark', 'selectNextBookmark')
     this.bind('change:selected', this.selectionChanged);
     this.set({
-      addresses: new CodeBuddy.backbone.Addresses(this.get('stack_frames')) 
+      addresses: new CodeBuddy.backbone.Addresses(this.get('stack_frames'))
     })
   },
 
@@ -32,11 +32,11 @@ CodeBuddy.backbone.Stack = Backbone.Model.extend({
       this.set({ selected: newSelected })
     }
   },
-  
+
   selectPrevious: function() {
     this.setSelection(this.get('selected') - 1)
   },
-  
+
   selectNext: function() {
     this.setSelection(this.get('selected') + 1)
   },
@@ -91,11 +91,11 @@ CodeBuddy.backbone.AddressView = Backbone.View.extend({
     click: "open",
     dblclick: "toggleBookmark"
   },
-  
+
   open: function() {
     CodeBuddy.stack.set({selected: this.model.cid.substr(1)-1});
   },
-  
+
   toggleBookmark: function() {
     this.open();
     CodeBuddy.stack.toggleBookmark();
@@ -103,7 +103,7 @@ CodeBuddy.backbone.AddressView = Backbone.View.extend({
 
   render: function() {
     $(this.el).removeClass('selected bookmarked')
-    
+
     var html = this.template(this.model.toJSON())
 
     $(this.el).html(html);
@@ -123,23 +123,23 @@ CodeBuddy.backbone.StackView = Backbone.View.extend({
   el: $("#stack"),
 
   initialize: function() {
-    _.bindAll(this, 'selectNext', 'selectPrevious')
+    _.bindAll(this, 'selectNext', 'selectPrevious', 'addOneAddress')
     this.model.view = this;
     this.model.get('addresses').each(this.addOneAddress);
   },
-  
+
   selectPrevious: function() {
     this.model.selectPrevious();
     this.ensureVisibility();
     return false;
   },
-  
+
   selectNext: function() {
     this.model.selectNext();
     this.ensureVisibility();
     return false;
   },
-  
+
   ensureVisibility: function() {
     var offset = $(CodeBuddy.stack.selectedAddress().view.el).offset()
     var windowHeight = $(window).height()
@@ -155,48 +155,48 @@ CodeBuddy.backbone.StackView = Backbone.View.extend({
 
   addOneAddress: function(address, index) {
     var view = new CodeBuddy.backbone.AddressView({model: address});
-    this.$("#stack").append(view.render().el);
+    $(this.el).append(view.render().el);
   }
 })
 
 CodeBuddy.backbone.CodeView = Backbone.View.extend({
   el:$("#code-viewer"),
-  
+
   initialize: function() {
     _.bindAll(this, 'toggleCommands','increaseOpacity', 'decreaseOpacity', 'toggle')
     this.code = this.$("#code")
     this.current = this.$("#current")
     this.opacity = parseFloat(this.el.css("opacity"))
   },
-  
+
   render: function() {
     this.current.html('<div>' + CodeBuddy.stack.selectedAddress().get('path') + '</div>')
     this.code.html(CodeBuddy.stack.selectedAddress().get('code'))
   },
-  
+
   toggleCommands: function() {
     this.$("#legend").toggle()
   },
-  
+
   toggle: function() {
-	  this.el.toggle()
+    this.el.toggle()
   },
 
   editCode: function() {
-	  $.get('../edit/' + CodeBuddy.stack.get('selected'))
+    $.get('../edit/' + CodeBuddy.stack.get('selected'))
   },
-  
+
   setOpacity: function(newOpacity) {
     if(newOpacity < 0) newOpacity = 0;
     if(newOpacity > 1) newOpacity = 1;
     this.el.css("opacity", newOpacity);
     this.opacity = newOpacity;
   },
-  
+
   increaseOpacity: function() {
     this.setOpacity(this.opacity + 0.1)
   },
-  
+
   decreaseOpacity: function() {
     this.setOpacity(this.opacity - 0.1)
   }
@@ -204,22 +204,24 @@ CodeBuddy.backbone.CodeView = Backbone.View.extend({
 
 CodeBuddy.backbone.FormView = Backbone.View.extend({
   el:$(".form"),
-  
+
   initialize: function() {
     _.bindAll(this, 'show', 'hide')
     this.el.find('textarea').bind('keydown', 'esc', this.hide)
   },
-  
+
   show: function(){
     this.el.show();
-    $("#code-viewer").hide()
+    CodeBuddy.codeView.el.hide()
+    CodeBuddy.stackView.el.hide()
     this.el.find("textarea").focus()
     return false;
   },
-  
+
   hide: function(){
     this.el.hide();
-    $("#code-viewer").show()
+    CodeBuddy.codeView.el.show()
+    CodeBuddy.stackView.el.show()
     return false;
   }
 })
@@ -242,11 +244,11 @@ CodeBuddy.setGlobalKeyBindings = function(){
 
 CodeBuddy.setup = function(stackJson) {
   CodeBuddy.form = new CodeBuddy.backbone.FormView
-  
+
+  this.stack = new this.backbone.Stack(stackJson);
+  this.stackView = new this.backbone.StackView({model: this.stack});
+  this.codeView = new this.backbone.CodeView();
   if(stackJson) {
-    this.stack = new this.backbone.Stack(stackJson);
-    this.stackView = new this.backbone.StackView({model: this.stack});
-    this.codeView = new this.backbone.CodeView();
     this.codeView.render();
     this.setStackKeyBindings();
     CodeBuddy.form.hide()
@@ -254,4 +256,7 @@ CodeBuddy.setup = function(stackJson) {
     CodeBuddy.form.show()
   }
   CodeBuddy.setGlobalKeyBindings()
+  $('#new_stack').click(function(){
+    CodeBuddy.form.show()
+  })
 }

data/lib/code_buddy/rails2/monkey_patch_action_controller.rb

@@ -18,4 +18,3 @@ module ActionController
   end
 end
 
-CodeBuddy::App.path_prefix = '/code_buddy'

data/lib/code_buddy/rails3/railtie.rb

@@ -2,11 +2,10 @@ module CodeBuddy
   class Railtie < Rails::Railtie
     initializer "code_buddy.add_middleware" do |app|
       if app.config.action_dispatch.show_exceptions
-        app.middleware.swap ActionDispatch::ShowExceptions, CodeBuddy::ShowExceptions
+        app.middleware.swap          ActionDispatch::ShowExceptions, CodeBuddy::ShowExceptions, app.config.consider_all_requests_local
         app.middleware.insert_before CodeBuddy::ShowExceptions, CodeBuddy::ShowApp
       end
     end
-    CodeBuddy::App.path_prefix = '/code_buddy'
   end
 
   class ShowExceptions < ActionDispatch::ShowExceptions
@@ -16,7 +15,7 @@ module CodeBuddy
     end
 
     def rescue_action_locally(request, exception)
-      App.exception = exception
+      CodeBuddy::App.exception = exception
       super
     end
   end

data/lib/code_buddy/stack_frame.rb

@@ -39,15 +39,19 @@ module CodeBuddy
         "<span class=\"coderay\">Unable to read file:\n&nbsp;\"#{@path}\"</span>"
       end
     end
-    
+
+    # different syntaxes for opening to a line number for different editors
     def open_in_editor
-      case ENV['EDITOR']
+      editor = ENV['CODE_BUDDY_EDITOR'] || ENV['EDITOR']
+      case editor
       when 'mate'
         `mate #{path} -l #{line}`
-      when 'mvim'
-        `mvim +#{line} #{path}` 
+      when /(mvim|emacsclient)/
+        `#{$1} +#{line} #{path}`
+      when 'netbeans'
+        `netbeans #{path}:#{line}`
       else
-        puts "Sorry unable to open the file for editing.  Please set your environment variable to either mate or mvim 'export EDITOR=mate' and restart the server"
+        puts "Sorry unable to open the file for editing.  Please set your environment variable to either mate or mvim 'export CODE_BUDDY_EDITOR=mate' and restart the server"
       end
     end
   end

data/lib/code_buddy/version.rb

@@ -1,3 +1,3 @@
 module CodeBuddy
-  VERSION = '0.0.8'
+  VERSION = '0.1.0'
 end

data/lib/code_buddy/views/banner.erb

@@ -2,5 +2,7 @@
   <div class="item"><img src="<%= @static_file_prefix  %>images/buddy.jpeg" class="buddy"/></div>
   <div class="item"><span class="title">CodeBuddy</span><br/>See your Ruby stack come alive</div>
   <div class="link"><a href="http://github.com/patshaughnessy/code_buddy">about</a></div>
-  <div class="link"><a href="<%= @static_file_prefix  %>new">paste stack</a></div>
+  <% if local_request? %>
+    <div class="link"><a href="#" id='new_stack'>paste stack</a></div>
+  <% end %>
 </div>

data/lib/code_buddy/views/index.erb

@@ -4,7 +4,7 @@
   <%= erb :banner %>
   <div class="form">
     Paste your stack:
-    <form method="post" action="/new">
+    <form method="post" action="<%= @static_file_prefix  %>new">
       <textarea name="stack" rows="40" cols="130" class="stack_form"></textarea><br/>
       <input type="submit" value="submit"/>
     </form>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: code_buddy
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 8
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors: 
 - Pat Shaughnessy, Alex Rothenberg, Daniel Higginbotham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -05:00
+date: 2011-03-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -269,7 +269,6 @@ files:
 - lib/code_buddy/stack_frame.rb
 - lib/code_buddy/version.rb
 - lib/code_buddy/views/banner.erb
-- lib/code_buddy/views/form.erb
 - lib/code_buddy/views/header.erb
 - lib/code_buddy/views/index.erb
 - spec/app_spec.rb
@@ -307,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: code_buddy
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: See the Ruby code running in your app.

data/lib/code_buddy/views/form.erb

@@ -1,13 +0,0 @@
-<html>
-<%= erb :header %>
-<body>
-  <%= erb :banner %>
-  <div class="form">
-    Paste your stack:
-    <form method="post" action="/new">
-      <textarea name="stack" rows="40" cols="130" class="stack_form"></textarea><br/>
-      <input type="submit" value="submit"/>
-    </form>
-  </div>
-</body>
-</html>