awesome_tables 0.0.3 → 0.0.4

data/Manifest

@@ -2,8 +2,13 @@ MIT-LICENSE
 Manifest
 README
 Rakefile
+lib/app/views/awesome_tables/_base.html.erb
 lib/awesome_tables.rb
+lib/awesome_tables/awesome_table.rb
+lib/awesome_tables/formatters.rb
+lib/awesome_tables/formatters/html.rb
 lib/awesome_tables/railtie.rb
+lib/awesome_tables/scrap.rb
 lib/awesome_tables/view_helpers/action_view.rb
 test/awesome_tables_test.rb
 test/test_helper.rb

data/README

@@ -1,13 +1,55 @@
 AwesomeTables
 =============
 
-Introduction goes here.
+This rails gem is used to easily display, consistently styled tables. It is still very much a work in progress.
 
 
 Example
 =======
 
-Example goes here.
+In order to use an awesome_table, first you must register it in a helper. Two examples are below.
 
+    AwesomeTables::AwesomeTable::register :posts do |t|
+	    t.set_caption "Posts"
+	    t.column :published_at, :display_published_at
+	    t.column :post, :partial => 'awesome_tables/posts/body'
+	    t.column :comment_count, :comment_counter, :with_image => 'comment-grey-bubble.png'
+	  end
 
-Copyright (c) 2010 [name of plugin creator], released under the MIT license
+	  AwesomeTables::AwesomeTable::register :users do |t|
+	    t.set_caption "Users"
+	    t.column :full_name
+	    t.column :login
+	    t.column :email
+	    t.column :state
+	  end
+
+Now you can use them in your views
+
+		<%= awesome_table :users, @users %>
+    <%= awesome_table :posts, @posts %>
+
+There are currently 3 different ways to declare a column.
+1. t.column(:method) A plain td can be created by passing in an object attribute. The header will be a titlized version of the method name.
+2. t.column(:header_text, :method) If you want the header text to be different than the method. 
+3. t.column(:header_text, :partial => 'path/to/partial) If your td data is more complex than a method name, add a partial option.
+
+Eventually, I want to be able to create columns that use view_helpers, but I haven't spent enough time investigating how to get that working.
+4. t.column(:header_text, link_to(obj.name, obj))
+
+The :with_image option will use the image as the column header instead header text. That code and the way it is used needs some attention. Things have changed a little bit since I put that in there.
+
+You'll need to make sure that you create an awesome tables view folder. There is a base example table contained in lib/app/views/awesome_tables.
+
+TODO
+====
+
+* create a generator that creates awesome_tables view folder and copies a base table into it.
+* tests, tests, tests
+* allow use of helpers in column calls
+* figure out how to change the templates so that they don't have column loops inside of the object loop
+* add more and better options support. Currently there is only a :class (and :with_image) option for columns and the way the :class option is implemented looks nasty.
+* have awesome_tables infer objects the way will_paginate does. That was working, I changed it for some reason to work around something that I can't currently remember.
+* create different formatters so awesome_tables can be used to output tables in formats other than html tables.
+
+Copyright (c) 2010 Dan Engle, released under the MIT license

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('awesome_tables', '0.0.3') do |p|
+Echoe.new('awesome_tables', '0.0.4') do |p|
   p.description    = "A gem for some awesome tables"
   p.url            = "http://github.com/danengle/awesome_tables"
   p.author         = "Dan Engle"

data/awesome_tables.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{awesome_tables}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Engle"]
   s.cert_chain = ["/Users/danengle/.ssh/gem-public_cert.pem"]
-  s.date = %q{2010-10-10}
+  s.date = %q{2010-10-24}
   s.description = %q{A gem for some awesome tables}
   s.email = %q{engle.68 @nospam@ gmail.com}
-  s.extra_rdoc_files = ["README", "lib/awesome_tables.rb", "lib/awesome_tables/railtie.rb", "lib/awesome_tables/view_helpers/action_view.rb"]
-  s.files = ["MIT-LICENSE", "Manifest", "README", "Rakefile", "lib/awesome_tables.rb", "lib/awesome_tables/railtie.rb", "lib/awesome_tables/view_helpers/action_view.rb", "test/awesome_tables_test.rb", "test/test_helper.rb", "awesome_tables.gemspec"]
+  s.extra_rdoc_files = ["README", "lib/app/views/awesome_tables/_base.html.erb", "lib/awesome_tables.rb", "lib/awesome_tables/awesome_table.rb", "lib/awesome_tables/formatters.rb", "lib/awesome_tables/formatters/html.rb", "lib/awesome_tables/railtie.rb", "lib/awesome_tables/scrap.rb", "lib/awesome_tables/view_helpers/action_view.rb"]
+  s.files = ["MIT-LICENSE", "Manifest", "README", "Rakefile", "lib/app/views/awesome_tables/_base.html.erb", "lib/awesome_tables.rb", "lib/awesome_tables/awesome_table.rb", "lib/awesome_tables/formatters.rb", "lib/awesome_tables/formatters/html.rb", "lib/awesome_tables/railtie.rb", "lib/awesome_tables/scrap.rb", "lib/awesome_tables/view_helpers/action_view.rb", "test/awesome_tables_test.rb", "test/test_helper.rb", "awesome_tables.gemspec"]
   s.homepage = %q{http://github.com/danengle/awesome_tables}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Awesome_tables", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/app/views/awesome_tables/_base.html.erb

@@ -0,0 +1,35 @@
+<table>
+  <% if table.caption? %>
+    <caption class="medium_round_top"><%= table.caption %></caption>
+  <% end %>
+  <tr>
+    <% table.columns.each do |column| %>
+      <th<%= " class=#{column[:class]}" unless column[:class].blank? %>><%= column[:image].blank? ? column[:header] : image_tag(column[:image]) %></th>
+    <% end %>
+  </tr>
+  <% if table.data.blank? %>
+    <tr><td colspan="<%= table.columns.size %>">0 results</td></tr>
+  <% else %>
+    <% table.data.each do |object| %>
+      <tr>
+        <% table.columns.each do |column| %>
+          <td<%= " class=#{column[:class]}" unless column[:class].blank? %>>
+            <% if object.respond_to?(column[:method]) %>
+                <%= object.send(column[:method]) %>
+            <% else %>
+              <%= render :partial => column[:method], :locals => { :obj => object } %>
+            <% end %>
+          </td>
+        <% end %>
+      </tr>
+    <% end %>
+    <% if table.paginate? %>
+      <tr>
+        <td class="pagination_links" colspan="<%= table.columns.size %>">
+          <div class="pagination_info"><%= page_entries_info table.data %></div>
+          <%= will_paginate table.data %>
+        </td>
+      </tr>
+    <% end %>
+  <% end %>
+</table>

data/lib/awesome_tables/awesome_table.rb

@@ -0,0 +1,53 @@
+module AwesomeTables
+  class AwesomeTable
+    @@tables = {}
+    
+    attr_accessor :data, :columns, :partial, :caption
+
+    def self.register(table_type, &block)
+      raise AwesomeTables::NoBlockGivenException unless block_given?
+      @@tables[table_type] = block
+    end
+    
+    def initialize(table_type, data = [], options = {})
+      @data = data
+      @paginate = true if @data.is_a? WillPaginate::Collection
+      @columns = []
+      @template = options[:template] ||= 'awesome_tables/base'
+      # is this the best way to do this?
+      raise AwesomeTables::UnknownTableTypeException if @@tables[table_type].blank?
+      @@tables[table_type].call(self)
+    end
+    
+    def caption?
+      !@caption.blank?
+    end
+    
+    def paginate?
+      @paginate
+    end
+    
+    def set_caption(caption)
+      @caption = caption
+    end
+    # example column colls
+    # t.column :created_at, :display_created_at
+    # t.column :body, :partial => 'awesome_tables/posts/body'
+    # t.column :comments, :comment_count, :with_image => 'comments.png'
+    # t.column :full_name
+    def column(*args)
+      name = args[0].to_s.titleize
+      if args[1].nil?
+        method = args[0]
+      elsif args[1].is_a? Symbol
+        method = args[1]
+        options = args[2]
+      else
+        raise AwesomeTables::NoPartialProvidedException unless args[1].keys.include?(:partial)
+        method = args[1].delete(:partial)
+        options = args[1]
+      end
+      @columns << { :header => name, :method => method, :options => options ||= {} }
+    end
+  end
+end

data/lib/awesome_tables/formatters/html.rb

@@ -0,0 +1,11 @@
+=begin
+require 'awesome_tables/formatters'
+
+module AwesomeTables
+  module Formatters
+    class Html < Formatter
+      def self.output
+    end
+  end
+end
+=end

data/lib/awesome_tables/formatters.rb

@@ -0,0 +1,13 @@
+=begin
+require 'awesome_tables/formatters/html'
+
+module AwesomeTables
+  class Formatter
+    class << self
+      def output(type, awesome_table)
+        case type
+      end
+    end
+  end
+end
+=end

data/lib/awesome_tables/railtie.rb

@@ -1,4 +1,5 @@
 require 'awesome_tables'
+require 'awesome_tables/awesome_table'
 
 module AwesomTables
   class Railtie < Rails::Railtie

data/lib/awesome_tables/scrap.rb

@@ -0,0 +1,3 @@
+def test(*args)
+  puts "1. #{args}"
+end

data/lib/awesome_tables/view_helpers/action_view.rb

@@ -1,8 +1,13 @@
 module AwesomeTables
   module ViewHelpers
     module ActionView
-      def awesome_table(table_type, data = [])
-        "awesome_table: #{table_type}, #{data.size}"
+      # TODO make this only need table_type and infer objects by name
+      # TODO add a render method so calling partial is not needed here
+      #    e.g. AwesomeTables::AwesomeTable.new(table_type, data).render
+      def awesome_table(table_type, data)
+        raise "awesome_table data is not an Array" unless data.is_a? Array
+        awesome_table = AwesomeTables::AwesomeTable.new(table_type, data)
+        render :partial => awesome_table.template, :locals => { :table => awesome_table }
       end
     end
   end

data/lib/awesome_tables.rb

@@ -1,4 +1,13 @@
 module AwesomeTables
+  
+  class NoBlockGivenException < Exception
+  end
+  
+  class UnknownTableTypeException < Exception 
+  end 
+  
+  class NoPartialException < Exception
+  end
 end
 
 if defined?(::Rails::Railtie)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Dan Engle
@@ -35,7 +35,7 @@ cert_chain:
   2MS0NMYj
   -----END CERTIFICATE-----
 
-date: 2010-10-10 00:00:00 -05:00
+date: 2010-10-24 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -47,16 +47,26 @@ extensions: []
 
 extra_rdoc_files: 
 - README
+- lib/app/views/awesome_tables/_base.html.erb
 - lib/awesome_tables.rb
+- lib/awesome_tables/awesome_table.rb
+- lib/awesome_tables/formatters.rb
+- lib/awesome_tables/formatters/html.rb
 - lib/awesome_tables/railtie.rb
+- lib/awesome_tables/scrap.rb
 - lib/awesome_tables/view_helpers/action_view.rb
 files: 
 - MIT-LICENSE
 - Manifest
 - README
 - Rakefile
+- lib/app/views/awesome_tables/_base.html.erb
 - lib/awesome_tables.rb
+- lib/awesome_tables/awesome_table.rb
+- lib/awesome_tables/formatters.rb
+- lib/awesome_tables/formatters/html.rb
 - lib/awesome_tables/railtie.rb
+- lib/awesome_tables/scrap.rb
 - lib/awesome_tables/view_helpers/action_view.rb
 - test/awesome_tables_test.rb
 - test/test_helper.rb