spectabular 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.md

@@ -0,0 +1,68 @@
+#Spectabular
+
+_Spectabular_ provides a helper method which turns ActiveModel resources into tabular displays. It provides some minimal customization options.
+
+## Compatibility
+
+_Spectabular_ 2 is only compatible with Rails 3.0 and above. It has been tested on Rails 3.1 and 3.2.
+
+If you are using Rails 2, please use _Spectabular_ 1 (*Rails-2* branch).
+
+## Installation
+
+In your Rails application, add the following line to your `Gemfile`
+
+```ruby
+  gem 'spectabular', :git => 'git://feldpost@github.com/feldpost/spectabular.git'
+```
+
+Run `bundle install`.
+
+## Usage
+
+Assuming you have this in your controller:
+
+```ruby
+@articles = Article.all
+```
+
+In your views:
+
+### Default:
+
+```ruby
+  table_for :articles
+```
+
+Generates table with all content columns.
+
+### Specify columns to use:
+
+```ruby
+  table_for :articles, :title, :description
+```
+
+Only shows the _title_ and _description_ attributes.
+
+
+### Specify column headers and content to use:
+
+```ruby
+  table_for :articles,
+            "Title" => :helper_method,
+            "Description" => Proc.new {|record| record.description }
+```
+
+You can specify a helper method or block to be called. Both block and helper method take one argument, the record being passed to the table row.
+
+#### Note for Ruby 1.8
+
+Because Hashes in Ruby 1.8 are not ordered, in the above example the column order is not guaranteed. Thus, you can number your columns as such:
+
+```ruby
+  table_for :articles,
+            "1-Title" => :helper_method,
+            "2-Description" => Proc.new {|record| record.description }
+```
+
+The numeration markers are removed and column order is maintained. This is not necessary if you are using Ruby 1.9.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'Spectabular'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/lib/spectabular.rb

@@ -0,0 +1,6 @@
+require "spectabular/version"
+require 'spectabular/table'
+require 'spectabular/ordered_hash'
+require 'spectabular/helper'
+
+ActionController::Base.helper(Spectabular::Helper)

data/lib/spectabular/helper.rb

@@ -0,0 +1,98 @@
+module Spectabular
+  module Helper
+    
+    def table_for(collection,*columns)
+      @column_number = 0
+      columns = columns.first if columns.size <= 1
+      columns ||= default_columns_for(collection)
+      @table = Spectabular::Table.new(  :collection => instance_variable_get("@#{collection}"), 
+                                        :collection_name => collection.to_s.humanize, 
+                                        :columns => columns, 
+                                        :context => self
+                                        )
+      output = []
+      if @table.empty?
+        output << @table.empty_message.html_safe
+      else
+        output << content_tag(:table, join_formatted([spectabular_header,spectabular_body]), :class => "spectabular").html_safe
+        output << spectabular_pagination.html_safe
+      end
+      join_formatted output
+    end
+
+    protected
+    
+    def join_formatted(array,join_string="\n")
+      join_string.html_safe + safe_join(array, join_string.html_safe ) + join_string.html_safe
+    end
+
+    def spectabular_header
+      content_tag(:thead, header_row).html_safe
+    end
+    
+    def header_row
+      content_tag(:tr, join_formatted(mapped_headers)).html_safe
+    end
+    
+    def mapped_headers
+      @table.headers.map do |header| 
+          content_tag(:th, header)
+      end
+    end
+
+    def spectabular_body
+      content_tag(:tbody, join_formatted(mapped_body)).html_safe
+    end
+    
+    def mapped_body
+      @table.rows.map do |record,row| 
+        content_tag(:tr, join_formatted(mapped_row(row)), :id => dom_id(record), :class => row_class_for(record) )
+      end
+    end
+
+    def mapped_row(row)
+      row.map do |name,cell| 
+        content_tag :td, cell.to_s.html_safe, :class => cell_class_for(name,@column_number+=1)
+      end
+    end
+    
+    def row_class_for(record)
+      token = [cycle('odd','even')]
+      is_active = [:active?, :is_active?, :published?].find {|m| record.respond_to? m }
+      if is_active
+        token << (record.send(is_active) ? "active" : 'inactive')
+      end
+      token.join(" ")
+    end
+    
+    def cell_class_for(name,column_number)
+      column_number == 1 ? "tbl-#{name} lead" : name
+    end
+
+    def spectabular_pagination
+      return "" unless @table.will_paginate?
+      content_tag(:p, will_paginate(@table.collection), :class => 'pagination').html_safe
+    end
+    
+    def default_columns_for(collection)
+      {}.tap do |columns_hash|
+        collection.to_s.classify.constantize.content_columns.map do |c|
+          columns_hash[c.name.to_sym] = Proc.new {|a| default_formatting_for(a, c.name, c.type) }
+        end
+      end
+    end
+    
+    def default_formatting_for(record,name,column_type)
+      attribute = record.send(name)
+      case column_type
+      when :datetime
+        attribute.not_blank? ? attribute.strftime("%m/%d/%Y %H:%M:%S") : ""
+      when :boolean
+        attribute == true ? "Yes" : "No"
+      else
+        attribute.html_safe
+      end
+    end
+
+  end
+end

data/lib/spectabular/ordered_hash.rb

@@ -0,0 +1,37 @@
+class OrderedHash < Hash
+  alias_method :store, :[]=
+  alias_method :each_pair, :each
+
+  def initialize(key_array=[])
+    @keys = []
+    key_array.each do |k|
+      self[k[0]] = k[1]
+    end
+  end
+
+  def []=(key, val)
+    @keys << key
+    super
+  end
+
+  def delete(key)
+    @keys.delete(key)
+    super
+  end
+
+  def each
+    @keys.each { |k| yield k, self[k] }
+  end
+  
+  def map
+    @keys.map { |k| yield k, self[k] }
+  end
+
+  def each_key
+    @keys.each { |k| yield k }
+  end
+
+  def each_value
+    @keys.each { |k| yield self[k] }
+  end
+end

data/lib/spectabular/table.rb

@@ -0,0 +1,107 @@
+module Spectabular
+
+  class Table
+    attr_accessor :columns, :skip_sorting_row, :collection, :collection_name, :context, :will_paginate
+    attr_writer :default_empty
+
+    def initialize(options={})
+      options.each do |key,value|
+        self.send("#{key}=",value)
+      end
+    end
+
+    def columns
+      case @columns
+       when Array
+          @columns.flatten
+        when Hash
+          sorted_hash_for(@columns).map {|g| {:header => g[0].to_s.gsub(/^\d+\s?-\s?/,''), :helper => g[1]}}
+      else
+        [@columns]
+      end
+    end
+
+    def empty?
+      collection.blank?
+    end
+    
+    def default_empty
+      @default_empty ||= 'n/a'
+    end
+
+    def empty_message
+      "No #{collection_name} added yet"
+    end
+
+    def rows
+      ordered_hash.tap do |collection_hash|
+        collection.each do |record|
+          column_hash = ordered_hash
+            columns.each_with_index do |column,i|
+              column_hash[headers[i].parameterize] = cell(column,record) || default_empty
+            end
+          collection_hash[record] = column_hash
+        end
+      end
+    end
+
+    def cell(column,record)
+      if column.respond_to? :to_sym
+        record.send column.to_sym
+      else
+        if column[:helper]
+         column[:helper].respond_to?(:call) ? column[:helper].call(record) : context.send(column[:helper],record)
+        elsif column[:value] 
+          record.send column[:value]
+        else
+          nil
+        end
+      end
+    end
+
+    def will_paginate?
+      if will_paginate.nil?
+        collection_supports_pagination?
+      else
+        will_paginate
+      end
+    end
+
+    def headers
+      @headers ||= columns.map do |column|
+        if column.respond_to? :to_sym
+          column.to_s.humanize
+        else
+          column[:header].is_a?(Symbol) ? column[:header].to_s.humanize : column[:header].to_s
+        end
+      end
+    end
+
+    def default_empty
+      @default_empty || ''
+    end
+
+    protected
+    
+    def ordered_hash(*args)
+      if RUBY_VERSION < '1.9'
+        Hash.new(*args)
+      else
+        OrderedHash.new(*args)
+      end
+    end
+    
+    def sorted_hash_for(items)
+      if RUBY_VERSION < '1.9'
+        items.sort {|a,b| a[0].to_s <=> b[0].to_s }
+      else
+        items
+      end
+    end
+
+    def collection_supports_pagination?
+      collection.respond_to? :total_pages
+    end
+
+  end
+end

data/lib/spectabular/version.rb

@@ -0,0 +1,3 @@
+module Spectabular
+  VERSION = "2.0.0"
+end

data/lib/tasks/spectabular_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :spectabular do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.