compass_ae_console 1.0.0

data/README.md

@@ -0,0 +1,5 @@
+![Logo](http://github.com/portablemind/compass_agile_enterprise/raw/master/erp_app/public/images/art/compass-logo-1-medium.png)
+
+#Compass Console
+
+Compass Console is an application that sits on top of the Compass AE framework that allows the user to interact with their rails application with a simulated rails console.

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CompassAeConsole'
+  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
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/controllers/compass_ae_console/erp_app/desktop/base_controller.rb

@@ -0,0 +1,142 @@
+module CompassAeConsole
+  module ErpApp
+    module Desktop
+      class BaseController < ::ErpApp::Desktop::BaseController
+        def command
+          logger.debug("command received:#{params}")
+          begin
+            result=""
+
+            # NOTE- the console uses a shared binding. this is due to the fact
+            # that binding instances are not serializable and cant be stored
+            # in a user session. Until this is resolved we use a global var.
+            # this should not pose a problem as the console should only be used
+            # in development or by a sysadmin. 
+
+            # the shared binding is needed to allow for variable scope visibility
+            # across multiple requests 
+            if($session_binding==nil)
+              $session_binding=binding
+            end
+
+            command_message=params[:command_message]
+            logger.debug("console session context:#{$session_binding}")
+            logger.debug("command:#{command_message}")
+
+            # here we handle any desktop console-specific command
+            # these can include non-eval related funtions
+            # or provide shortcuts to common eval expressions
+            result = case command_message 
+            when /^-help/
+              help_message
+            when /^-clear/
+              #this is actually handled in the console desktop application
+              #evaluate_command("")
+            when /^-time/
+              evaluate_command("Time.now")
+            when /^-whoami/
+              evaluate_command("current_user.username")
+            else
+              evaluate_command(command_message)  
+            end
+
+            logger.debug("result#{result}")
+
+            result_message =result.to_s.gsub("\n", "<br />\n")
+            render :json=> {:success=>"#{result_message}<hr><br>"}
+          end
+        end
+        private
+        #****************************************************************************
+        def help_message()
+          message = "<font color='lightgray'><b>Compass Desktop Console Help<b><hr>"
+          message<< "<ul>"
+          message<< "<li>-clear : <font color='yellow'>Clear screen contents.</font></li>"
+          message<< "<li>-help : <font color='yellow'>This help list.</font></li>"
+          message<< "<li>-time : <font color='yellow'>Current time.</font></li>"
+          message<< "<li>-whoami : <font color='yellow'>Logged in as.</font></li>"
+          message<< "</ul> </font>"
+        end
+        #****************************************************************************
+        def highlight_class(klass)
+          klass.columns.map do |column|
+             "<font color='yellow'>#{column.name}</font><font color='lightgray'>:</font><font color='gold'>#{column.type}</font>"
+          end
+        end
+        
+        def hightlight_instance(instance)
+          buffer=""
+          instance.attributes.keys.sort.each do |model_attribute_key|
+            ErpTechSvcs::Util::CompassLogger.debug("key:#{model_attribute_key}")
+
+            buffer<<"<font color='yellow'>#{model_attribute_key}</font> <font color='lightgray'>=</font><font color='gold'>#{instance.attributes[model_attribute_key]}</font> <font color='lightgray'>, </font>"
+          end
+          return buffer
+        end
+        #****************************************************************************
+
+        def evaluate_command(command_message)
+          ErpTechSvcs::Util::CompassLogger.debug("evaluate_command(#{command_message}")
+          begin
+            result_eval = $session_binding.eval(command_message)
+            if(result_eval.respond_to?("superclass") &&  result_eval.superclass == ActiveRecord::Base)
+              result = render_active_record_model(result_eval)
+            elsif (result_eval.is_a? Array)
+              result = render_array(result_eval)
+            elsif (result_eval.is_a? Hash)
+              result = render_hash(result_eval)
+            else
+              #result="#{result_eval.class.to_s} #{result_eval.to_s}<br>"
+              result = "#{result_eval.to_s}<br>"
+            end
+
+          rescue Exception => e
+            result = "<font color='red'>#{e.to_s}</font>"
+          end
+
+          result
+        end
+        #****************************************************************************
+        def render_active_record_model(result_eval)
+          ErpTechSvcs::Util::CompassLogger.debug("render_active_record_model:#{result_eval}")
+          "<font color='YellowGreen'>#{result_eval.class} </font><br>#{highlight_class(result_eval)} "
+        end
+        #****************************************************************************
+        def render_array(result_eval)
+          result="#{result_eval.class.to_s}<br>"
+          ErpTechSvcs::Util::CompassLogger.debug("render_array:#{result_eval}")
+          count=0
+          result_eval.each do |array_element|
+            if(array_element.is_a? ActiveRecord::Base)
+              result<< "<font color='YellowGreen'>#{array_element.class}<font color='yellow'>[</font><font color='white'>#{count}</font><font color='yellow'>]</font> </font>#{hightlight_instance(array_element)} <br><br>"
+            else
+              result<<"<font color='YellowGreen'>#{array_element.class}<font color='yellow'>[</font><font color='white'>#{count}</font><font color='yellow'>]</font> </font>#{array_element} <br><br>"
+            end
+            count=count+1
+          end
+          result
+        end
+        #****************************************************************************
+        def render_hash(result_eval)
+          ErpTechSvcs::Util::CompassLogger.debug("render_hash:#{result_eval}")
+          result="#{result_eval.class.to_s}<br>"
+          count=0
+          result_eval.keys.each do |hash_key|
+            symbol_modifier=''
+            if(hash_key.is_a? Symbol)
+              symbol_modifier=':'
+            end
+            if(hash_key.is_a? ActiveRecord::Base)
+
+              result<< "<font color='YellowGreen'>#{result_eval.class}<font color='yellow'>[</font><font color='white'>#{symbol_modifier}#{hash_key}</font><font color='yellow'>] => </font> </font>#{highlight(result_eval[hash_key])} <br>"
+            else
+              result<<"<font color='YellowGreen'>#{result_eval.class}<font color='yellow'>[</font><font color='white'>#{symbol_modifier}#{hash_key}</font><font color='yellow'>] => </font> </font>#{result_eval[hash_key]} <br>"
+            end
+            count=count+1
+          end
+          result
+        end
+      end
+    end#end BaseController
+  end#end ErpApp
+end#end Console

data/config/routes.rb

@@ -0,0 +1,3 @@
+CompassAeConsole::Engine.routes.draw do
+  match '/erp_app/desktop/(/:action(.:format))' => "erp_app/desktop/base"
+end

data/db/data_migrations/20110824020426_create_desktop_app_console.rb

@@ -0,0 +1,19 @@
+class CreateDesktopAppConsole
+  def self.up
+    app = DesktopApplication.create(
+      :description => 'Compass Console',
+      :icon => 'icon-console',
+      :javascript_class_name => 'Compass.ErpApp.Desktop.Applications.CompassAeConsole',
+      :internal_identifier => 'compass_ae_console',
+      :shortcut_id => 'compass_console-win'
+    )
+    
+    app.preference_types << PreferenceType.iid('desktop_shortcut')
+    app.preference_types << PreferenceType.iid('autoload_application')
+    app.save
+  end
+
+  def self.down
+    DesktopApplication.destroy_all(['internal_identifier = ?','compass_ae_console'])
+  end
+end

data/lib/compass_ae_console.rb

@@ -0,0 +1,8 @@
+#compass libraries
+require 'erp_app'
+require 'erp_forms'
+
+require "compass_ae_console/engine"
+
+module CompassAeConsole
+end

data/lib/compass_ae_console/engine.rb

@@ -0,0 +1,10 @@
+module CompassAeConsole
+  class Engine < Rails::Engine
+    isolate_namespace CompassAeConsole
+    
+    initializer "compass_console.merge_public" do |app|
+      app.middleware.insert_before Rack::Lock, ::ActionDispatch::Static, "#{root}/public"
+    end
+    
+  end
+end

data/lib/compass_ae_console/version.rb

@@ -0,0 +1,3 @@
+module CompassAeConsole
+  VERSION = "1.0.0"
+end

data/public/javascripts/erp_app/desktop/applications/compass_ae_console/module.js

@@ -0,0 +1,180 @@
+//**************************************************
+// Compass Desktop Console
+//**************************************************
+var desktop_console_history=new Array();
+var desktop_console_history_index=0;
+//----------------------------------
+// add startsWith method to string
+String.prototype.startsWith = function (str){
+    return this.indexOf(str) == 0;
+};
+//---------------------------------
+var startup_heading="<font color='goldenrod'><b>Compass Console Version 0.01</b>&nbsp;(<font color='white'>-help</font> for Help)</font><br>"
+//---------------------------------
+function sendCommand(destination,command){
+    update_history_panel("<font color='white'>"+command+"</font>")
+     
+    if(command.startsWith("-clear")){
+        clear_history_panel(startup_heading+"<br><hr>");
+    }else{
+     
+    Ext.Ajax.request({
+        url: '/compass_ae_console/erp_app/desktop/command',
+        params: {
+             
+            command_message: command
+        },
+        success: function(response){
+            var text = response.responseText;
+            var result =Ext.JSON.decode(text)
+            update_history_panel("<font color='yellow'>"+result.success+"</font>")
+        }
+    });
+    }
+}
+//---------------------------------
+function clear_history_panel(text){
+    var panel=Ext.getCmp('console_history_panel');
+    
+    panel.update(""+text+"<br>");
+                
+    var d = panel.body.dom;
+    d.scrollTop = d.scrollHeight - d.offsetHeight+10;
+    panel.doLayout();
+}
+//---------------------------------
+function update_history_panel(text){
+    var panel=Ext.getCmp('console_history_panel');
+    var old = panel.body.dom.innerHTML;
+    panel.update(old+""+text+"<br>");
+                
+    var d = panel.body.dom;
+    d.scrollTop = d.scrollHeight - d.offsetHeight+10;
+    panel.doLayout();
+}
+
+//---------------------------------
+var console_history_panel ={
+    xtype: 'panel',
+    
+    id : 'console_history_panel',
+    region: 'center',
+    bodyStyle: "background-image:url(/images/console_background.png) !important",
+    autoScroll:true,
+    html : startup_heading
+}
+
+//---------------------------------
+
+var console_text_area ={
+    xtype: 'textarea',
+    region : 'south',
+    style: "{background-image:url(/images/console_background.png)}",
+    autoscroll: true,
+    id: "console_text_area",
+    enableKeyEvents: true,
+    listeners: {
+        afterrender: function(field) {
+            field.focus();
+          },
+       
+                
+        // use key-up for textarea since ENTER does not affect focus traversal
+        keyup: function(field, e){
+            //console.log("textarea keyup:"+e);
+            if (e.getKey() == e.ENTER){
+                     
+                sendCommand('console_text_area',field.getValue());
+                // add to history 
+                desktop_console_history[desktop_console_history.length]=field.getValue().substring(0,field.getValue().length-1);
+                //update index
+                desktop_console_history_index=desktop_console_history.length
+                field.setValue("");
+            }else if (e.getKey() == e.UP){
+                     
+                if(desktop_console_history.length==0){
+                // no history to display
+                }else{
+                    desktop_console_history_index--;
+                    if(desktop_console_history_index >=0){
+                         
+                    }
+                    else{
+                        desktop_console_history_index=desktop_console_history.length-1
+                }
+                    field.setValue(desktop_console_history[desktop_console_history_index]);    
+                }
+                   
+            }else if (e.getKey() == e.DOWN){
+                     
+                if(desktop_console_history.length==0){
+                // no history to display
+                }else{
+                    desktop_console_history_index++;
+                    if(desktop_console_history_index >=(desktop_console_history.length)){
+                         desktop_console_history_index=0
+                    }
+                    else{
+                        //desktop_console_history_index=desktop_console_history.length-1
+                }
+                    field.setValue(desktop_console_history[desktop_console_history_index]);    
+                }
+            }
+        }
+    
+    }
+}
+//---------------------------------
+var console_panel={
+    xtype: 'panel',
+    layout: 'border',
+    items :[ console_history_panel,console_text_area]
+       
+}
+
+//---------------------------------
+
+Ext.define("Compass.ErpApp.Desktop.Applications.CompassAeConsole",{
+    extend:"Ext.ux.desktop.Module",
+    id:'compass_console-win',
+    init : function(){
+        this.launcher = {
+            text: 'Compass Console',
+            iconCls:'icon-console',
+            handler: this.createWindow,
+            scope: this
+        }
+    },
+
+    createWindow : function(){
+        var desktop = this.app.getDesktop();
+        var win = desktop.getWindow('console');
+        if(!win){
+            win = desktop.createWindow({
+                id: 'console',
+                title:'Compass Console',
+                width:1000,
+                height:670,
+                iconCls: 'console_icon',
+                shim:false,
+                animCollapse:false,
+                resizable : false,
+                constrainHeader:true,
+                layout: 'fit',
+                items:[console_panel]
+                ,
+                tools:[ 
+                {
+                    type:'help',
+                    tooltip: 'about',
+                    handler: function(event, toolEl, panel){
+                        Ext.Msg.alert("About","<center><b>Compass Console</b><br><i>Version 0.01</i>")
+                    }
+                }]
+                 
+            });
+        }
+        win.show();
+        sendCommand('console_text_area',"Rails.version ");
+    }
+});

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/