rails_info 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,58 @@
+= RailsInfo
+
+Wiki[https://github.com/applicat/rails_info/wiki] 
+
+Experimental engine for a rails application besides admin and continous integration web interface which extends standard /rails/info (properties through public.html iframe and on Rails 3 Edge / Rails 4 also the routes action) about some extra information resources in development environment.
+
+It should be the place for other rake commands besides "rake routes" such as brakeman or best practices.
+
+Prepare for sporadic Ruby segmentation faults caused by the Python powered syntax highlighter pygments in the early stages of this project (at least under Ruby 1.9.3 & Rails 3.2.6 on MacOS). 
+There will be a configuration option for deactivating syntax highlighting soon for the time being without a solution for this problem.
+
+Tested on MacOS with: Rails 3.1 & Ruby 1.9.2, Rails 3.2.6 & Ruby 1.9.3.
+
+== Installation
+
+In <b>Rails 3</b>, add this under your development group to the Gemfile of your Rails 3 application and run the +bundle+ command.
+
+  gem "rails_info"
+
+== Getting Started
+
+=== 1) Request the Web interface
+
+Just start your Rails 3 application server and request the following page in your browser.
+
+  http://localhost:3001/rails/info
+
+=== 2) Custom Exception Stack Trace View
+
+Add the following line at the top of your ApplicationController to replace the standard stack trace view by a customized version which displays the code snippet for each file of the stack trace inline:
+
+  include RailsInfo::Controller::ExceptionDiagnostics
+
+Consider those sporadic Ruby segmentation faults mentioned above when you include this line ;-)
+
+=== 3) RSpec Log
+
+Write the result of an rspec command to log/rspec.log
+
+  bundle exec rspec spec/whatever_you_want > log/rspec.log
+
+Run your rails development server if not already started and request the following page:
+
+  http://localhost:3000/rails/info/logs/test/rspec
+
+== Wiki Docs
+
+* TODO
+
+== Contribution
+
+Just follow the screencast of Ryan Bates on railscasts.com: 
+
+  http://railscasts.com/episodes/300-contributing-to-open-source
+
+== License 
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/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    = 'RailsInfo'
+  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 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/rails_info/application.js

@@ -0,0 +1,6 @@
+//= require jquery
+//= require jquery.ui.all
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require ./base
+//= require ./bootstrap

data/app/assets/javascripts/rails_info/base.js.coffee

@@ -0,0 +1,6 @@
+$(document).ready ->
+  $( ".accordions" ).each (k, v) ->
+    $(v).accordion({ autoHeight: false });
+    
+  $(".tabs").each (k, v) ->
+    $(v).tabs({ autoHeight: false });

data/app/assets/javascripts/rails_info/bootstrap.js.coffee

@@ -0,0 +1,4 @@
+jQuery ->
+  $("a[rel=popover]").popover()
+  $(".tooltip").tooltip()
+  $("a[rel=tooltip]").tooltip()

data/app/assets/stylesheets/rails_info/application.css

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * 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 'rails_info/bootstrap_and_overrides'
+ *= require 'rails_info/base'
+ */

data/app/assets/stylesheets/rails_info/base.css.scss

@@ -0,0 +1,22 @@
+/*
+ *= require jquery.ui.all
+ */
+
+/*body {
+  font-family: Arial;
+}*/
+
+.ui-widget {
+  font-family: Arial;
+  font-size: 10px;
+}
+
+html, body, div, span {
+  font-family: Arial;
+  font-size: 10px;
+}
+
+.nav a {
+  font-family: Arial;
+  font-size: 10px;
+}

data/app/assets/stylesheets/rails_info/bootstrap_and_overrides.css.less

@@ -0,0 +1,63 @@
+@import "twitter/bootstrap/bootstrap";
+/*body { 
+	padding-top: 60px;
+	padding-left: 20px;
+}*/
+
+@import "twitter/bootstrap/responsive";
+
+pre {
+    background-color: white;
+    border: 0px;
+    border-radius: 0px;
+    display: block;
+    font-size: 10px;
+    line-height: 18px;
+    margin: 0px;
+    padding: 0px;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+}
+
+code, pre {
+  font-family: Arial;
+}
+
+code {
+    border-radius: 0px;
+    border-width: 0px;
+    color: black;
+    background-color: white;
+    font-size: 10px;
+    padding: 0px;
+}
+
+.nav a {
+  font-size:14px ! important;
+}
+
+// Set the correct sprite paths
+@iconSpritePath: asset-path('twitter/bootstrap/glyphicons-halflings.png');
+@iconWhiteSpritePath: asset-path('twitter/bootstrap/glyphicons-halflings-white.png');
+
+// Set the Font Awesome (Font Awesome is default. You can disable by commenting below lines)
+// Note: If you use asset_path() here, your compiled boostrap_and_overrides.css will not 
+//       have the proper paths. So for now we use the absolute path.
+@fontAwesomeEotPath: '/assets/fontawesome-webfont.eot';
+@fontAwesomeWoffPath: '/assets/fontawesome-webfont.woff';
+@fontAwesomeTtfPath: '/assets/fontawesome-webfont.ttf';
+@fontAwesomeSvgPath: '/assets/fontawesome-webfont.svg';
+
+// Font Awesome
+@import "fontawesome";
+
+// Your custom LESS stylesheets goes here
+//
+// Since bootstrap was imported above you have access to its mixins which
+// you may use and inherit here
+//
+// If you'd like to override bootstrap's own variables, you can do so here as well
+// See http://twitter.github.com/bootstrap/less.html for their names and documentation
+//
+// Example:
+// @linkColor: #ff0000;

data/app/assets/stylesheets/rails_info/exception.css

@@ -0,0 +1,17 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * 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 jquery.ui.all
+ *= require rails_info/bootstrap_and_overrides
+ *= require rails_info/base
+ *= require rails_info/exception/base
+ *= require rails_info/exception/pygments
+ */

data/app/assets/stylesheets/rails_info/exception/base.css.scss

@@ -0,0 +1,31 @@
+table {
+  padding: 0px; margin:0px;
+  font-family: Arial;
+  border: 1px solid black;
+  border-collapse: collapse;
+}
+
+td {
+  padding: 0px 5px;
+  margin: 0px;
+  border: 1px solid black;
+  vertical-align:top;
+}
+
+td.number {
+  font-size: 12px;
+  vertical-align:bottom;
+}
+
+pre {
+  font-size:14px;
+  display: inline;
+}
+
+pre.stack_trace_message {
+  display: block;
+  background-color: #EEEEEE;
+  font-size: 11px;
+  padding: 10px;
+  white-space: pre-wrap;
+}

data/app/assets/stylesheets/rails_info/exception/pygments.css.erb

@@ -0,0 +1,5 @@
+<%= Pygments.css(style: "colorful") %>
+
+.hll, .hll span {
+  background-color: #FFFFCC ! important; 
+}

data/app/controllers/rails_info/data_controller.rb

@@ -0,0 +1,9 @@
+class RailsInfo::DataController < RailsInfoController
+  def index
+    @rails_info_data = ::RailsInfo::DataPresenter.new(view_context)
+  end
+
+  def update_multiple_data
+    RailsInfo::Data.update_multiple_data(params[:data]) if params[:delete]
+  end
+end

data/app/controllers/rails_info/logs/server_controller.rb

@@ -0,0 +1,10 @@
+class RailsInfo::Logs::ServerController < RailsInfoController
+  def new
+    @rails_info_log = ::RailsInfo::Logs::ServerPresenter.new(view_context, log: params[:log], debug: params[:debug])
+  end
+
+  def update
+    @rails_info_log = ::RailsInfo::Logs::ServerPresenter.new(log: params[:log], debug: params[:debug])
+    render 'new'
+  end
+end

data/app/controllers/rails_info/logs/test/rspec_controller.rb

@@ -0,0 +1,16 @@
+class RailsInfo::Logs::Test::RspecController < RailsInfoController
+  layout 'rails_info/exception'
+  
+  def new
+    @rails_info_log = ::RailsInfo::Logs::Test::RspecPresenter.new(
+      view_context, log: {rails_root: Rails.root.to_s}.merge(params[:log] || {}), debug: params[:debug] 
+    )
+  end
+
+  def update
+    @rails_info_log = ::RailsInfo::Logs::Test::RspecPresenter.new(
+      view_context, log: params[:log], debug: params[:debug]
+    )
+    render 'new'
+  end
+end

data/app/controllers/rails_info/model_controller.rb

@@ -0,0 +1,5 @@
+class RailsInfo::ModelController < RailsInfoController
+  def index
+    @rails_info_model = ::RailsInfo::ModelPresenter.new(view_context)
+  end
+end

data/app/controllers/rails_info/properties_controller.rb

@@ -0,0 +1,4 @@
+class RailsInfo::PropertiesController < RailsInfoController
+  def index
+  end
+end

data/app/controllers/rails_info/routes_controller.rb

@@ -0,0 +1,4 @@
+class RailsInfo::RoutesController < RailsInfoController
+  def index
+  end
+end

data/app/controllers/rails_info/stack_traces_controller.rb

@@ -0,0 +1,11 @@
+class RailsInfo::StackTracesController < RailsInfoController
+  layout 'rails_info/exception'
+  
+  def new
+  end
+  
+  def create
+    @stack_trace = RailsInfo::StackTracePresenter.new(view_context, stack_trace: params[:stack_trace])
+    render 'new'
+  end
+end

data/app/controllers/rails_info_controller.rb

@@ -0,0 +1,16 @@
+class RailsInfoController < Rails::InfoController
+  include ::RailsInfo::Controller::ExceptionDiagnostics
+  
+  before_filter :check_if_all_requests_local
+  
+  #TODO: should inherit from ApplicationController especially for authentification & authorization purposes
+  layout 'rails_info'
+  
+  private
+
+  def check_if_all_requests_local
+    unless Rails.application.config.consider_all_requests_local || request.local?
+      render text: '<p>For security purposes, this information is only available to local requests.</p>', status: :forbidden
+    end
+  end
+end

data/app/helpers/rails_info/resources_helper.rb

@@ -0,0 +1,194 @@
+module RailsInfo::ResourcesHelper
+  TRANSLATED_COLUMNS = []
+  
+  def resource_tree(presenter, parent_id = '')   
+    content = ""
+     
+    presenter.each do |title, resource_presenter|
+      id = parent_id.blank? ? title.parameterize : "#{parent_id}-#{title.parameterize}"
+    
+      if resource_presenter[:sub_collection]   
+        content += content_tag(:li, raw(title) + resource_tree(resource_presenter[:sub_collection], id))  
+      else
+        content += content_tag(:li, title)
+      end      
+    end
+
+    content_tag(:ul, raw(content))
+  end
+  
+  def resource_presenter_renderer(presenter)
+    params['display_type'] == 'flat' ? raw(flat_resource_presenter_renderer(presenter)) : nested_resource_presenter_renderer(presenter)
+  end  
+  
+  def nested_resource_presenter_renderer(presenter, parent_id = '')
+    tabs_for do |tab|
+      presenter.each do |title,resource_presenter|  
+        id = parent_id.blank? ? title.parameterize : "#{parent_id}-#{title.parameterize}"
+        tab_title = resource_presenter[:group_by] ? "#{title} (Group by: #{resource_presenter[:group_by]})" : title    
+        tab.create(id, tab_title) do  
+          content = ""
+          
+          resource_presenter[:collection] = [resource_presenter[:collection]] unless resource_presenter[:collection].respond_to?('first')
+          
+          if resource_presenter[:collection]
+            content = render(
+              'shared/resource/section', {
+                :title => title, :collection => resource_presenter[:collection], :group_by => resource_presenter[:group_by],
+                :group_by_values => resource_presenter[:group_by_values]
+              }
+            )
+          end
+          
+          content += nested_resource_presenter_renderer(resource_presenter[:sub_collection], id) if resource_presenter[:sub_collection]
+                    
+          raw content
+        end
+      end
+    end
+  end
+  
+  def flat_resource_presenter_renderer(presenter, level = '')
+    content = ""
+    
+    presenter.each do |title,resource_presenter|          
+      content += render('shared/resource/section', :title => "#{level} #{title}", :collection => resource_presenter[:collection]) if resource_presenter[:collection]
+      
+      content += flat_resource_presenter_renderer(resource_presenter[:sub_collection], "#{level} -") if resource_presenter[:sub_collection]
+    end   
+    
+    content
+  end
+  
+  def collection_map(collection_map)
+    collection = []
+    
+    collection_map.each do |sub_collection|
+      sub_collection.each do |resource|
+        collection << resource
+      end
+    end
+    
+    collection_map.clear
+    
+    collection
+  end
+  
+  def grouped_collection(title, collection, group_by)
+    @grouped_collections ||= {}
+    
+    collection_key = "#{title}-{group_by}-#{collection.length}"
+    
+    return @grouped_collections[collection_key] if @grouped_collections[collection_key]
+    
+    @grouped_collections[collection_key] = ActiveSupport::OrderedHash.new
+
+    collection.each do |element|  
+      if element.is_a?(Hash)
+        key = element[group_by.to_s]
+      elsif element.respond_to?('translation') && element.translation.respond_to?(group_by)
+        key = element.translation.send(group_by)
+      else
+        key = element.send(group_by)
+      end
+      
+      if @grouped_collections[collection_key].has_key?(key)
+        @grouped_collections[collection_key][key] << element
+      else
+        @grouped_collections[collection_key][key] = [element]
+      end
+    end
+    
+    @grouped_collections[collection_key]
+  end
+  
+  def group_columns(title, collection, group_by = nil, group_by_values = nil)
+    collection_columns = grouped_collection(title, collection, group_by).keys
+    
+    if group_by_values.is_a?(Array)
+      group_by_values.delete_if {|c| !collection_columns.include?(c) }
+      collection_columns.delete_if {|c| group_by_values.include?(c) }
+      group_by_values + collection_columns
+    else
+      collection_columns
+    end
+  end
+  
+  def resource_columns(collection, group_by = nil)
+    collection_columns = []
+    
+    if collection.first.is_a?(Array)
+      raise "Please wrap the :collection by help.collection_map: #{collection.inspect}"
+    elsif collection.first.is_a?(Hash)
+      collection_columns = collection.first[:class].columns.map(&:name)
+    else
+      collection_columns = collection.first.attributes.keys
+    end
+      
+    exclude_columns = [
+      'current_code', 'last_code' # WorkflowControllerType binary columns
+    ]
+    
+    exclude_columns << group_by if group_by
+    
+    collection_columns.delete_if {|c| exclude_columns.include?(c) }
+  
+    unless collection.first.is_a?(Hash)
+      TRANSLATED_COLUMNS.each do |translated_column|
+        if !collection.first.attributes[translated_column] && collection.first.respond_to?('translation') && collection.first.translation.respond_to?(translated_column)
+          collection_columns << translated_column
+        end
+      end
+      end
+       
+    first_columns = ['id', 'sort_order', 'order', 'position', 'type', 'state', 'name', 'label', 'title', 'slug']    
+    first_columns.delete_if {|c| !collection_columns.include?(c) }
+    collection_columns.delete_if {|c| first_columns.include?(c) }
+    
+    bool_columns = ['final' ,'public', 'hidden']
+    bool_columns.delete_if {|c| !collection_columns.include?(c) }
+    collection_columns.delete_if {|c| bool_columns.include?(c) } 
+    
+    able_columns = collection_columns.select {|v| v.match('able') }  
+    collection_columns.delete_if {|c| able_columns.include?(c) }    
+    
+    is_columns = collection_columns.select {|v| v.match('is_') }  
+    collection_columns.delete_if {|c| is_columns.include?(c) }    
+    
+    id_columns = collection_columns.select {|v| v.match('_id') || v.match('_type') }  
+    collection_columns.delete_if {|c| id_columns.include?(c) }    
+    
+    at_columns = collection_columns.select {|v| v.match('_at') }     
+    collection_columns.delete_if {|c| at_columns.include?(c) }
+    
+    last_columns = []    
+    last_columns.delete_if {|c| !collection_columns.include?(c) }    
+    collection_columns.delete_if {|c| last_columns.include?(c) }
+    
+    standard_rails_timestamps = ['created_at', 'updated_at']
+    standard_rails_timestamps.delete_if {|c| !at_columns.include?(c) }
+    at_columns.delete_if {|c| at_columns.include?(c) }
+    
+    content_for :columns_order, "first_columns + collection_columns + bool_columns + able_columns + is_columns + id_columns + at_columns + last_columns + standard_rails_timestamps" unless content_for?(:columns_order)
+    
+    first_columns + collection_columns + bool_columns + able_columns + is_columns + id_columns + at_columns + last_columns + standard_rails_timestamps
+  end
+  
+  def resource_cell(row, column)
+    if row.is_a?(Hash)
+      return "" unless row.has_key?(column)
+      
+      content = row[column].to_s
+    else
+      return "" unless row.respond_to?(column)
+      
+      content = row.send(column).to_s
+    end
+    
+    truncate_length = params['truncate_length'] ? params['truncate_length'].to_i : 50
+    
+    content = content_tag(:span, truncate(raw(content), :length => truncate_length), :title => content) if content.length > truncate_length
+      
+    content
+  end 
+end