presenting 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Lance Ivy
+
+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

@@ -0,0 +1,10 @@
+Presenting
+==========
+Bringing together my work on ActiveScaffold and Components into standardized, reusable view macros.
+
+Performance
+===========
+I don't see why it wouldn't be fast. But if anyone "discovers":http://rpm.newrelic.com a "problem":http://ruby-prof.rubyforge.org/, we can go from there. Why worry early?
+
+
+Copyright (c) 2008 Lance Ivy, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the presenting plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the presenting plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Presenting'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/assets/javascript/search.js

@@ -0,0 +1,13 @@
+$('.presentation-search .compact fieldset label').livequery(function() {
+  var label = $(this);
+  var field = label.siblings('input');
+  if (!field[0] || field.attr('type') == 'checkbox') return;
+  
+  label.addClass('overlabel');
+  
+  var hide_label = function() { label.css('text-indent', '-1000px') };
+  var show_label = function() { this.value || label.css('text-indent', '0px') };
+  
+  $(field).focus(hide_label).blur(show_label).each(hide_label).each(show_label);
+  $(label).click(function() {field.focus()});
+});

data/app/assets/stylesheets/details-color.css

@@ -0,0 +1,7 @@
+.presentation-details dt {
+  color: #444;
+}
+
+.presentation-details dd {
+  border-color: #888;
+}

data/app/assets/stylesheets/details.css

@@ -0,0 +1,10 @@
+.presentation-details dt {
+  font-weight: bold;
+}
+
+.presentation-details dd {
+  margin-left: 0;
+  padding-bottom: 0.5em;
+  border-bottom: 1px dotted;
+  margin-bottom: 0.5em;
+}

data/app/assets/stylesheets/form.css

@@ -0,0 +1 @@
+.presentation-form {}

data/app/assets/stylesheets/grid-color.css

@@ -0,0 +1,71 @@
+.presentation-grid a {
+  color: #06c;
+}
+
+.presentation-grid {
+  font-family: sans-serif;
+  background-color: #fff;
+}
+
+.presentation-grid caption {  
+  background-color: transparent;
+}
+
+.presentation-grid thead {
+  background-color: transparent;
+}
+
+.presentation-grid thead th {
+  border-bottom: 2px solid #aaa;
+  font-weight: normal;
+  color: #666;
+  background-color: transparent;
+}
+
+.presentation-grid tbody tr.even {
+  background-color: #e6f2ff;
+  border-bottom: 1px solid #c5dbf7;
+  border-top: 1px solid #c5dbf7;
+}
+
+.presentation-grid tbody td.sorted {
+  background-color: #f5f5f5;
+}
+
+.presentation-grid tbody tr.even td.sorted {
+  background-color: #c5dbf7;
+}
+
+.presentation-grid tfoot .pagination {
+  margin-top: 0.5em;
+}
+
+.presentation-grid tfoot .pagination a {
+  text-decoration: none;
+}
+
+.presentation-grid tfoot .pagination .prev_page,
+.presentation-grid tfoot .pagination .next_page {
+  padding: 0.1em 0.5em;
+  background-color: #eee;
+  border: 1px solid #e5e5e5;
+}
+
+.presentation-grid tfoot .pagination a.prev_page:hover,
+.presentation-grid tfoot .pagination a.next_page:hover {
+  background-color: #e6f2ff;
+  border-color: #c5dbf7;
+}
+
+.presentation-grid tfoot .pagination .prev_page {
+  margin-right: 0.7em;
+}
+
+.presentation-grid tfoot .pagination .next_page {
+  margin-left: 0.7em;
+}
+
+.presentation-grid tfoot .pagination .current {
+  padding: 0.1em 0.5em;
+  border: 1px solid #e5e5e5;
+}

data/app/assets/stylesheets/grid.css

@@ -0,0 +1,64 @@
+/** cellspacing **/
+.presentation-grid table,
+.presentation-grid td,
+.presentation-grid th {
+  border: 0;
+  border-collapse: collapse;
+}
+
+.presentation-grid table {
+  width: 100%;
+}
+
+.presentation-grid caption {
+  text-align: left;
+  font-weight: bold;
+  padding-left: 0.2em;
+}
+
+.presentation-grid th {
+  padding: 0.2em 0.5em 0em 0.2em;
+  text-align: left;
+  vertical-align: bottom;
+}
+
+.presentation-grid th a {
+  text-decoration: none;
+}
+
+.presentation-grid td {
+  padding: 0.4em 0.5em 0.4em 0.2em;
+  vertical-align: top;
+}
+
+.presentation-grid ul.actions {
+  overflow: auto;
+  zoom: 1;
+  float: right;
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+
+.presentation-grid ul.actions li {
+  float: left;
+}
+
+.presentation-grid ul.actions li a {
+  font-weight: normal;
+  display: block;
+  padding: 0em 0.3em;
+  text-decoration: none;
+}
+
+.presentation-grid ul.actions li a:hover {
+  text-decoration: underline;
+}
+
+.presentation-grid ul.actions li a {
+  outline: none;
+}
+
+.presentation-grid caption ul.actions {
+  margin-right: 0.5em;
+}

data/app/assets/stylesheets/search-color.css

@@ -0,0 +1,16 @@
+.presentation-search label {
+  color: #666;
+}
+
+.presentation-search fieldset {
+  border: 1px solid #c5dbf7;
+  background-color: #e6f2ff;
+  padding: 2px;
+}
+
+.presentation-search fieldset.submit {
+  border: 0px;
+  padding: 0px;
+  background-color: transparent;
+}
+

data/app/assets/stylesheets/search.css

@@ -0,0 +1,45 @@
+.presentation-search {
+  overflow: hidden;
+  zoom: 1;
+}
+
+.presentation-search fieldset {
+  border: 0;
+  margin: 0 0.5em 1em 0;
+  padding: 0;
+  float: left;
+  width: 145px;
+}
+
+.presentation-search fieldset label {
+  font-weight: normal;
+  margin: 0;
+  padding: 0;
+  text-transform: none;
+}
+
+.presentation-search fieldset input,
+.presentation-search fieldset select {
+  padding: 0px;
+  margin: 0px;
+}
+
+/* for overlabels (requires javascript) */
+
+.presentation-search .compact label {
+  display: inline;
+}
+
+.presentation-search .compact fieldset {
+  position: relative;
+  width: auto;
+}
+
+.presentation-search .compact fieldset label.overlabel {
+  display: block;
+  position: absolute;
+  top: 0.2em;
+  left: 0.5em;
+  z-index: 1;
+  cursor: text;
+}

data/app/controllers/presentation/assets_controller.rb

@@ -0,0 +1,42 @@
+class Presentation::AssetsController < ActionController::Base
+  # TODO: consider packaging a minifier so we get the perfect solution: a cached, minified bundle of assets
+  caches_page :stylesheet, :javascript
+
+  def stylesheet
+    dir = asset_path(:stylesheets)
+    sheet = params[:id].split(',').collect{ |id| File.read("#{dir}/#{id}.css") }.join("\n")
+    
+    respond_to do |type|
+      type.css {render :text => sheet}
+    end
+  end
+  
+  # TODO: bundle unobtrusive javascripts that can add behavior.
+  # - jquery vs prototype (i'll develop jquery, and wait for prototype contributions)
+  # - ajax links with html response
+  # - - inline
+  # - - modal dialog
+  # - ajax links with js response
+  # - ajax links with no response
+  # - inline editing
+  # - "dirty" form awareness
+  # - tabbed forms
+  # - tooltips for extended information (e.g. column description or truncated field text)
+  # - basic form validation
+  # - - required fields
+  # TODO: tests for ujs
+  def javascript
+    dir = asset_path(:javascript)
+    script = params[:id].split(',').collect{ |id| File.read("#{dir}/#{id}.js") }.join("\n")
+    
+    respond_to do |type|
+      type.js {render :text => script}
+    end
+  end
+  
+  protected
+  
+  def asset_path(type)
+    File.join(File.dirname(__FILE__), '..', '..', 'assets', type.to_s)
+  end
+end

data/app/views/presentations/_details.erb

@@ -0,0 +1,11 @@
+<div class="presentation-details">
+  <% if @details.title %>
+  <h3><%= @details.title %></h3>
+  <% end %>
+  <dl>
+    <% @details.fields.each do |field| %>
+      <dt><%= field.name %></dt>
+      <dd><%= present(field.value_from(@details.presentable), :h => field.sanitize?) %></dd>
+    <% end %>
+  </dl>
+</div>

data/app/views/presentations/_field_search.erb

@@ -0,0 +1,14 @@
+<div class="presentation-search">
+  <% form_tag @search.url, :method => :get, :class => ("compact" if @search.compact) do %>
+    <% @search.fields.each do |field| %>
+      <fieldset>
+        <label><%= field.name %></label>
+        <%= present(field, "#{field.type}_search", :name => "search[#{field.param}][value]") %>
+      </fieldset>
+    <% end %>
+    <fieldset class="submit">
+      <input type="submit" value="Search" class="submit" />
+      <%= link_to 'reset', @search.url %>
+    </fieldset>
+  <% end %>
+</div>

data/app/views/presentations/_form.erb

@@ -0,0 +1,20 @@
+<% form_for @form.presentable, :url => @form.url, :method => @form.method, :html => @form.html do |f| %>
+  <% @form.groups.each do |group| %>
+    <fieldset>
+      <% unless group.name.blank? %>
+        <legend><%= group.name %></legend>
+      <% end %>
+      <% group.fields.each do |field| %>
+        <% if field.type.to_sym == :hidden %>
+          <%= f.present(field) %>
+        <% else %>
+          <div class="field">
+            <%= f.label field.name, field.label %>
+            <%= f.present(field) %>
+          </div>
+        <% end %>
+      <% end %>
+    </fieldset>
+  <% end %>
+  <%= f.submit @form.button %>
+<% end %>

data/app/views/presentations/_grid.erb

@@ -0,0 +1,70 @@
+<div id="<%= @grid.id %>" class="presentation-grid">
+  <table>
+    <% unless @grid.title.blank? and @grid.links.empty? %>
+      <caption>
+        <% unless @grid.links.empty? %>
+          <ul class="actions">
+            <% @grid.links.each do |link| %>
+              <li><%= link %></li>
+            <% end %>
+          </ul>
+        <% end %>
+        
+        <%= @grid.title %>
+      </caption>
+    <% end %>
+    <thead>
+      <tr>
+        <% @grid.fields.each do |field| %>
+          <th class="<%= field.id %>">
+            <% if field.sortable? %>
+              <%= link_to field.name, field.sorted_url(request), :class => "sortable" %>
+            <% else %>
+              <%= field.name %>
+            <% end %>
+          </th>
+        <% end %>
+        <% unless @grid.record_links.empty? %>
+          <th></th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody>
+      <% if @grid.presentable.blank? %>
+        <tr>
+          <td colspan="<%= @grid.colspan %>">
+            No records found.
+          </td>
+        </tr>
+      <% else %>
+        <% @grid.presentable.each do |record| %>
+          <tr class="<%= cycle('odd', 'even') %>">
+            <% @grid.fields.each do |field| %>
+              <td class="<%= [field.id, ('sorted' if field.is_sorted?(request))].compact.join(' ') %>">
+                <%= present(field.value_from(record), :h => field.sanitize?) %>
+              </td>
+            <% end %>
+            <% unless @grid.record_links.empty? %>
+              <td>
+                <ul class="actions">
+                  <% @grid.record_links.each do |link| %>
+                    <li><%= link.call(record) %></li>
+                  <% end %>
+                </ul>
+              </td>
+            <% end %>
+          </tr>
+        <% end %>
+      <% end %>
+    </tbody>
+    <% if @grid.paginate? %>
+      <tfoot>
+        <tr>
+          <td colspan="<%= @grid.colspan %>">
+            <%= will_paginate @grid.presentable %>
+          </td>
+        </tr>
+      </tfoot>
+    <% end %>
+  </table>
+</div>

data/app/views/presentations/_search.erb

@@ -0,0 +1,7 @@
+<div class="presentation-search">
+  <% form_tag @search.url, :method => :get do %>
+    <%= text_field_tag 'search', params[:search] %>
+    <input type="submit" value="Search" class="submit" />
+    <%= link_to 'reset', @search.url %>
+  <% end %>
+</div>

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  Presenting.draw_routes(map)
+end

data/lib/presentation/base.rb

@@ -0,0 +1,48 @@
+module Presentation
+  class Base
+    include Presenting::Configurable
+    
+    def render
+      view.render :partial => "presentations/#{self.class.to_s.split('::').last.underscore}"
+    end
+    
+    attr_accessor :presentable
+    
+    ##
+    ## begin ActionView compat
+    ##
+    
+    attr_accessor :controller # not strictly for compat, but it makes the compat easy
+    
+    def request
+      controller.request
+    end
+    
+    def url_for(*args)
+      controller.url_for(*args)
+    end
+    
+    def params
+      request.parameters
+    end
+    
+    ## end ActionView compat
+    
+    protected
+    
+    # what the presentation is called in its templates
+    def iname
+      :presentation
+    end
+    
+    # a reference to the view
+    def view #:nodoc:
+      @view ||= Presenting::View.new(ActionController::Base.view_paths, assigns_for_view, self)
+    end
+    
+    def assigns_for_view
+      {iname => self, :_request => request}
+    end
+    
+  end
+end

data/lib/presentation/details.rb

@@ -0,0 +1,19 @@
+module Presentation
+  # TODO: abstract what's common between Record and Grid into a shared module or reusable objects or something
+  class Details < Grid
+    def iname; :details end
+    
+    # The display title for this presentation. Will default based on the id.
+    attr_accessor :title
+    
+    def fields=(args)
+      args.each do |field|
+        self.fields << field
+      end
+    end
+    
+    def fields
+      @fields ||= Presenting::FieldSet.new(Presenting::Attribute, :name, :value)
+    end
+  end
+end

data/lib/presentation/field_search.rb

@@ -0,0 +1,65 @@
+module Presentation
+  class FieldSearch < Search
+    # This method supports the configuration-on-initialization paradigm. It makes:
+    #   present = Presentation::FieldSearch.new(:fields => [
+    #     {:a => {:type => :list, :options => %w(foo bar baz)}},
+    #     :b,
+    #     {:c => :boolean}
+    #   ])
+    #
+    # equivalent to:
+    #
+    #   present = Presentation::FieldSearch.new
+    #   present.fields << {:a => {:type => :list, :options => %w(foo bar baz)}}
+    #   present.fields << :b
+    #   present.fields << {:c => :boolean}
+    def fields=(args)
+      args.each do |field|
+        self.fields << field
+      end
+    end
+    
+    def fields
+      @fields ||= Presenting::FieldSet.new(Field, :param, :type)
+    end
+    
+    def compact
+      @compact != false
+    end
+    attr_writer :compact
+    
+    class Field
+      include Presenting::Configurable
+      
+      # the display name of the field.
+      attr_reader :name
+      def name=(val)
+        @name = val.is_a?(Symbol) ? val.to_s.titleize : val
+      end
+      
+      # the parameter name of the field. note that this is not necessarily the name of a database column or record attribute.
+      # it simply needs to be recognized as a "field" by the controller logic.
+      attr_reader :param
+      def param=(val)
+        self.name ||= val
+        @param = val.to_s.underscore.downcase.gsub(' ', '_')
+      end
+      
+      # the type of search interface for this field. supported options:
+      # * :text     (default)
+      # * :checkbox
+      # * :time     [planned]
+      # * :list     [planned]
+      def type
+        @type ||= :text
+      end
+      attr_writer :type
+      
+      # extra options for the field.
+      def options
+        @options ||= {}
+      end
+      attr_writer :options
+    end
+  end
+end