report_ui 0.0.1.alpha

data/fixture_rails_root/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/fixture_rails_root/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/fixture_rails_root/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/fixture_rails_root/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/fixture_rails_root/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/generators/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate reporter Thing
+
+    This will create:
+        what/will/it/create

data/generators/reporter_generator.rb

@@ -0,0 +1,3 @@
+class ReporterGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+end

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+
+require 'report_ui'

data/install.rb

@@ -0,0 +1,2 @@
+# Install hook code here
+`rake report_ui:install`

data/lib/app/controllers/reports_controller.rb

@@ -0,0 +1,32 @@
+class ReportsController < ApplicationController
+  unloadable
+  expose :report
+
+  expose(:reports) { Report.all }
+
+  expose(:custom_reports) do
+    if respond_to?(:current_user) && current_user.respond_to?(:reports)
+      current_user.reports
+    else
+      []
+    end
+  end
+
+  expose(:available_columns) { report.available_columns }
+
+  #def new; end
+  #def show; end
+  #def index; end
+  #def edit; end
+
+  def create
+    report = Report.new(params[:report])
+
+    if report.save
+      flash[:notice] = 'Report was successfully created.'
+      redirect_to(report)
+    else
+      render :action => "new"
+    end
+  end
+end

data/lib/app/models/report.rb

@@ -0,0 +1,36 @@
+class Report < ActiveRecord::Base
+  serialize :used_columns
+  validates_presence_of :used_columns
+
+  def available_columns
+    ::ReportUi.reportable_models.inject({}) do |result, model|
+      result.merge(model => model.columns.inject({}) do |model_attrs, attr|
+        model_attrs.merge(attr.name.to_sym => ((self.used_columns || []).include?("#{model.name}##{attr.name}")))
+      end)
+    end
+  end
+
+  def query
+    case type
+    when 'ruby'
+      eval(code)
+    when 'sql'
+      Report.find_by_sql(code)
+    end
+  end
+
+
+  def humanized_column_names
+    column_names.map(&:humanize)
+  end
+
+  def column_names
+    used_columns.map do |full_col|
+      full_col.scan(/#(.*)/).flatten[0]
+    end
+  end
+
+  def data
+    eval code
+  end
+end

data/lib/app/views/layouts/reports.html.haml

@@ -0,0 +1,11 @@
+!!!
+%html
+  %head
+    %title Reports
+    =stylesheet_link_tag 'reporter/formtastic', 'reporter/formtastic_changes', 'reporter/jquery-ui', 'reporter/screen', :media =>  'screen, projection'
+    =stylesheet_link_tag 'reporter/print', :media => 'print'
+    = javascript_include_tag 'reporter/jquery.js','reporter/jquery-ui.min.js', 'reporter/application.js'
+    = csrf_meta_tag
+  %body.bp
+    #container
+      = yield

data/lib/app/views/reports/_columns_editor.html.haml

@@ -0,0 +1,14 @@
+%ul#models
+  -available_columns.keys.each do |model|
+    %li
+      =link_to model.name.underscore.humanize, "#columns_for_#{model.name}"
+-available_columns.each do |model, attrs|
+  %div(id="columns_for_#{model.name}")
+    -attrs.each do |attr_name, shown|
+      %li
+        %label(for="#{model.name}#{attr_name}")= attr_name.to_s.humanize
+        =check_box_tag("#{model.name}_#{attr_name}", "#{model.name}: #{attr_name.to_s.humanize}", shown)
+%br
+%button.button_button Ok
+
+%button.button_button Cancel

data/lib/app/views/reports/_details.html.haml

@@ -0,0 +1,5 @@
+%h4=report.name
+%p=report.description
+
+=link_to 'View Report', report_path(report), :class => 'button_button'
+=link_to 'Edit/Save as', edit_report_path(report), :class => 'button_button'

data/lib/app/views/reports/_form.html.haml

@@ -0,0 +1,2 @@
+-f.inputs :name => '' do
+  =f.input :name

data/lib/app/views/reports/_report_details_edit.html.haml

@@ -0,0 +1,11 @@
+#columns
+  %h3
+    Columns
+    =link_to "Edit", report_columns_path(report)
+#sorts
+  %h3 Sorts
+#filters
+  %h3 Filters
+#schedule
+  %h3 Schedule
+

data/lib/app/views/reports/_reports_table.html.haml

@@ -0,0 +1,10 @@
+%table
+  %thead
+    %tr
+      %th Name
+      %th Description
+  %tbody
+    -reports.each do |report|
+      %tr(class="#{ cycle('odd', 'even') }" rel="#{report.id}")
+        %td=report.name
+        %td=report.description

data/lib/app/views/reports/edit.html.haml

@@ -0,0 +1,2 @@
+%h1="Editing #{report.name}"
+

data/lib/app/views/reports/index.html.haml

@@ -0,0 +1,19 @@
+%h1 Listing reports
+#reports
+  %h2 Canned Reports
+
+  -if reports.present?
+    =render 'reports/reports_table', :reports => reports
+  -else
+    %p There are no canned reports
+
+  %h2 Favorite Reports
+
+  -if custom_reports.present?
+    =render 'reports/reports_table', :reports => custom_reports
+  -else
+    %p There are no custom reports.
+  =link_to 'New Report', new_report_path, :class => 'button_button'
+#report_details
+  %h2 Report Details
+

data/lib/app/views/reports/new.html.haml

@@ -0,0 +1,38 @@
+-semantic_form_for report, :html => {:class => 'bp'} do |f|
+  %h1 Creating a new report
+  #sidebar.span-4
+    %h3 Selected Options
+    =f.commit_button 'Run/Save'
+    #columns
+      %h4
+        Columns
+        =link_to "Edit", '#columns_editor', :rel => 'toggle_within/#editors'
+      %ul
+        %li Click 'Edit' to add columns to the report.
+    #sorts
+      %h4
+        Sorts
+        =link_to "Edit", '#sorts_editor'
+      %ul
+        %li Click 'Edit' to sort by one or more columns.
+    #filters
+      %h4
+        Filters
+        =link_to "Edit", '#filters_editor'
+      %ul
+        %li Click 'Edit' to filter data in the report.
+    #schedule
+      %h4
+        Schedule
+        =link_to "Edit", '#schedule_editor'
+      %ul
+        %li Click 'Edit' to create a schedule for this report to run automatically.
+    =f.commit_button 'Run/Save'
+  #content.span-20.last
+    =render 'form', :f => f
+    #editors
+      #columns_editor(style='display: none')
+        =render 'columns_editor'
+      #sorts_editor(style='display: none')
+      #filters_editor(style='display: none')
+      #schedule_editor(style='display: none')