tabletastic 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Davey
+
+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,51 @@
+= Tabletastic
+
+Inspired by the projects table_builder and formtastic,
+I realized how often I created tables for my active record collections.
+This is my attempt to simply this (the default scaffold):
+
+    <table>
+      <tr>
+        <th>Title</th>
+        <th>Body</th>
+        <th>Author Id</th>
+      </tr>
+      <% for post in @posts %>
+        <tr>
+          <td><%=h post.title %></td>
+          <td><%=h post.body %></td>
+          <td><%=h post.author_id %></td>
+          <td><%=h author.name %></td>
+          <td><%= link_to "Show", post %></td>
+          <td><%= link_to "Edit", edit_post_path(post) %></td>
+          <td><%= link_to "Destroy", post, :confirm => 'Are you sure?', :method => :delete %></td>
+          </tr>
+      <% end %>
+    </table>
+
+into this:
+
+    <% table_for(@posts) do |t| %>
+       <%= t.data :title, :body, :author %>
+    <% end %>
+
+
+== Warning
+THIS PROJECT IS UNDER HEAVY DEVELOPMENT.
+IT IS NOT RECOMMENDED FOR USE IN PRODUCTION APPLICATIONS
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Joshua Davey. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+GEM = "tabletastic"
+LONGDESCRIPTION = %Q{A table builder for active record collections \
+  that produces semantically rich and accessible markup}
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = GEM
+    s.summary = %Q{A smarter table builder for Rails collections}
+    s.description = LONGDESCRIPTION
+    s.email = "josh@joshuadavey.com"
+    s.homepage = "http://github.com/jgdavey/tabletastic"
+    s.authors = ["Joshua Davey"]
+    s.require_path = 'lib'
+
+    s.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Test the tabletastic plugin with specdoc formatting and colors'
+Spec::Rake::SpecTask.new('specdoc') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["--format specdoc", "-c"]
+end
+
+desc 'Test the tabletastic plugin with rcov'
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'spec,Library']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Tabletastic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/tabletastic.rb

@@ -0,0 +1,109 @@
+module Tabletastic
+
+  def table_for(collection, *args)
+    options = args.extract_options!
+    options[:html] ||= {}
+    options[:html][:id] ||= get_id_for(collection)
+    concat(tag(:table, options[:html], true))
+    yield TableBuilder.new(collection, self)
+    concat("</table>")
+  end
+
+  def get_id_for(collection)
+    !collection.empty? && collection.first.class.to_s.tableize
+  end
+
+  class TableBuilder
+    @@association_methods = %w[to_label display_name full_name name title username login value to_s]
+
+    def initialize(collection, template)
+      @collection, @template = collection, template
+    end
+
+    def data(*args, &block)
+      if block_given?
+        yield self
+        @template.concat(headers)
+        @template.concat(body)
+      else
+        @fields = args unless args.empty?
+        headers + body
+      end
+    end
+
+    def headers
+      content_tag(:thead) do
+        header_row
+      end
+    end
+
+    def header_row
+      output = "<tr>"
+      fields.each do |field|
+        output += content_tag(:th, field.to_s.humanize)
+      end
+      output += "</tr>"
+    end
+
+    def body
+      content_tag(:tbody) do
+        body_rows
+      end
+    end
+
+    def body_rows
+      @collection.inject("") do |rows, record|
+        rowclass = @template.cycle("odd","even")
+        rows += @template.content_tag_for(:tr, record, :class => rowclass) do
+          tds_for_row(record)
+        end
+      end
+    end
+
+    def tds_for_row(record)
+      fields.inject("") do |cells, field|
+        cells += content_tag(:td, cell_for(record, field))
+      end
+    end
+
+    def cell_for(record, method_or_attribute)
+      result = record.send(method_or_attribute)
+      return result if result.is_a?(String)
+      to_string = detect_string_method(result)
+      result.send(to_string) if to_string
+    end
+
+    def detect_string_method(association)
+      @@association_methods.detect { |method| association.respond_to?(method) }
+    end
+
+    def cell(method_or_attribute)
+      @fields ||= []
+      @fields << method_or_attribute.to_sym
+      return ""
+    end
+
+    def fields
+      return @fields if defined?(@fields)
+      if @collection.empty?
+        @fields = []
+      else
+        object = @collection.first
+        associations = object.class.reflect_on_all_associations(:belongs_to) if object.class.respond_to?(:reflect_on_all_associations)
+        @fields = object.class.content_columns.map(&:name)
+        if associations
+          associations = associations.map(&:name)
+          @fields += associations
+        end
+        @fields -= %w[created_at updated_at created_on updated_on lock_version version]
+        @fields.map!(&:to_sym)
+      end
+    end
+
+    private
+
+      def content_tag(name, content = nil, options = nil, escape = true, &block)
+        @template.content_tag(name, content, options, escape, &block)
+      end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), *%w[.. lib tabletastic])
+ActionView::Base.send :include, Tabletastic

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+
+def smart_require(lib_name, gem_name, gem_version = '>= 0.0.0')
+  begin
+    require lib_name if lib_name
+  rescue LoadError
+    if gem_name
+      gem gem_name, gem_version
+      require lib_name if lib_name
+    end
+  end
+end
+
+smart_require 'spec', 'spec', '>= 1.2.8'
+require 'spec/autorun'
+smart_require false, 'rspec-rails', '>= 1.2.7.1'
+smart_require 'hpricot', 'hpricot', '>= 0.6.1'
+smart_require 'rspec_hpricot_matchers', 'rspec_hpricot_matchers', '>= 1.0.0'
+smart_require 'active_support', 'activesupport', '>= 2.3.4'
+smart_require 'action_controller', 'actionpack', '>= 2.3.4'
+smart_require 'action_view', 'actionpack', '>= 2.3.4'
+
+Spec::Runner.configure do |config|
+  config.include(RspecHpricotMatchers)
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tabletastic'
+
+module TabletasticSpecHelper
+  include ActionView::Helpers::UrlHelper
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+  include ActionView::Helpers::ActiveRecordHelper
+  include ActionView::Helpers::RecordIdentificationHelper
+  include ActionView::Helpers::RecordTagHelper
+  include ActionView::Helpers::CaptureHelper
+  include ActiveSupport
+  include ActionController::PolymorphicRoutes
+
+  def self.included(base)
+    base.class_eval do
+      attr_accessor :output_buffer
+      def protect_against_forgery?
+        false
+      end
+    end
+  end
+
+  module ::RspecHpricotMatchers
+    def have_table_with_tag(selector, inner_text_or_options = nil, options = {}, &block)
+      HaveTag.new("table", nil, {}) &&
+        HaveTag.new(selector, inner_text_or_options, options, &block)
+    end
+  end
+
+  class ::Post
+    def id
+    end
+  end
+  class ::Author
+  end
+
+  def mock_everything
+    def post_path(post); "/posts/#{post.id}"; end
+    def edit_post_path(post); "/posts/#{post.id}/edit"; end
+
+    # Sometimes we need a mock @post object and some Authors for belongs_to
+    @post = mock('post')
+    @post.stub!(:class).and_return(::Post)
+    @post.stub!(:id).and_return(nil)
+    @post.stub!(:author)
+    ::Post.stub!(:human_attribute_name).and_return { |column_name| column_name.humanize }
+    ::Post.stub!(:human_name).and_return('Post')
+
+    @fred = mock('user')
+    @fred.stub!(:class).and_return(::Author)
+    @fred.stub!(:name).and_return('Fred Smith')
+    @fred.stub!(:id).and_return(37)
+
+    ::Author.stub!(:find).and_return([@fred])
+    ::Author.stub!(:human_attribute_name).and_return { |column_name| column_name.humanize }
+    ::Author.stub!(:human_name).and_return('Author')
+    ::Author.stub!(:reflect_on_association).and_return { |column_name| mock('reflection', :options => {}, :klass => Post, :macro => :has_many) if column_name == :posts }
+
+    @freds_post = mock('post')
+    @freds_post.stub!(:class).and_return(::Post)
+    @freds_post.stub!(:title).and_return('Fred\'s Post')
+    @freds_post.stub!(:body)
+    @freds_post.stub!(:id).and_return(19)
+    @freds_post.stub!(:author).and_return(@fred)
+    @freds_post.stub!(:author_id).and_return(@fred.id)
+    @fred.stub!(:posts).and_return([@freds_post])
+    @fred.stub!(:post_ids).and_return([@freds_post.id])
+
+    @mock_reflection_belongs_to_author = mock('reflection', :options => {}, :name => :author, :klass => ::Author, :macro => :belongs_to)
+
+    ::Post.stub!(:reflect_on_association).and_return do |column_name|
+      @mock_reflection_belongs_to_author if column_name == :author
+    end
+
+    ::Post.stub!(:reflect_on_all_associations).with(:belongs_to).and_return([])
+  end
+end

data/spec/tabletastic_spec.rb

@@ -0,0 +1,206 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+include TabletasticSpecHelper
+include Tabletastic
+
+
+describe "Tabletastic#table_for" do
+
+  before do
+    @output_buffer = ''
+  end
+
+  describe "basics" do
+    it "should start with an empty output buffer" do
+      output_buffer.should_not have_tag("table")
+    end
+
+    it "should build a basic table" do
+      table_for([]) do |t|
+      end
+      output_buffer.should have_tag("table")
+    end
+
+    context "headers and table body" do
+      before do
+        table_for([]) do |t|
+          concat(t.headers)
+          concat(t.body)
+        end
+      end
+
+      it "should build a basic table and headers" do
+        output_buffer.should have_table_with_tag("thead")
+      end
+
+      it "should build a basic table and body" do
+        output_buffer.should have_table_with_tag("tbody")
+      end
+    end
+
+    context "with options" do
+      it "should pass along html options" do
+        table_for([], :html => {:class => 'special'}) do |t|
+        end
+        output_buffer.should have_tag("table.special")
+      end
+    end
+  end
+
+  describe "#data" do
+    before do
+      mock_everything
+      ::Post.stub!(:content_columns).and_return([mock('column', :name => 'title'), mock('column', :name => 'body'), mock('column', :name => 'created_at')])
+      @post.stub!(:title).and_return("The title of the post")
+      @post.stub!(:body).and_return("Lorem ipsum")
+      @post.stub!(:created_at).and_return(Time.now)
+      @post.stub!(:id).and_return(2)
+      @posts = [@post]
+    end
+
+    context "without a block" do
+      context "with no other arguments" do
+        before do
+          table_for(@posts) do |t|
+            concat(t.data)
+          end
+        end
+
+        it "should output table with id of the class of the collection" do
+          output_buffer.should have_tag("table#posts")
+        end
+
+        it "should output headers" do
+          output_buffer.should have_table_with_tag("thead")
+        end
+
+        it "should have a <th> for each attribute" do
+          # title and body
+          output_buffer.should have_table_with_tag("th", :count => 2)
+        end
+
+        it "should include header for Title" do
+          output_buffer.should have_table_with_tag("th", "Title")
+        end
+
+        it "should include header for Body" do
+          output_buffer.should have_table_with_tag("th", "Body")
+        end
+
+        it "should output body" do
+          output_buffer.should have_table_with_tag("tbody")
+        end
+
+        it "should include a row for each record" do
+          output_buffer.should have_table_with_tag("tbody") do |tbody|
+            tbody.should have_tag("tr", :count => 1)
+          end
+        end
+
+        it "should have data for each field" do
+          output_buffer.should have_table_with_tag("td", "The title of the post")
+          output_buffer.should have_table_with_tag("td", "Lorem ipsum")
+        end
+
+        it "should include the id for the <tr> for each record" do
+          output_buffer.should have_table_with_tag("tr#post_#{@post.id}")
+        end
+
+        it "should cycle row classes" do
+          @output_buffer = ""
+          @posts = [@post, @post]
+          table_for(@posts) do |t|
+            concat(t.data)
+          end
+          output_buffer.should have_table_with_tag("tr.odd")
+          output_buffer.should have_table_with_tag("tr.even")
+        end
+
+        context "when collection has associations" do
+          it "should handle belongs_to associations" do
+            ::Post.stub!(:reflect_on_all_associations).with(:belongs_to).and_return([@mock_reflection_belongs_to_author])
+            @posts = [@freds_post]
+            @output_buffer = ""
+            table_for(@posts) do |t|
+              concat(t.data)
+            end
+            output_buffer.should have_table_with_tag("th", "Author")
+            output_buffer.should have_table_with_tag("td", "Fred Smith")
+          end
+        end
+      end
+
+      context "with a list of attributes" do
+        before do
+          table_for(@posts) do |t|
+            concat(t.data(:title, :created_at))
+          end
+        end
+
+        it "should call each method passed in, and only those methods" do
+          output_buffer.should have_table_with_tag("th", "Title")
+          output_buffer.should have_table_with_tag("th", "Created at")
+          output_buffer.should_not have_table_with_tag("th", "Body")
+        end
+      end
+    end
+
+    context "with a block" do
+      context "and normal columns" do
+        before do
+          table_for(@posts) do |t|
+            t.data do
+              concat(t.cell(:title))
+              concat(t.cell(:body))
+            end
+          end
+        end
+
+        it "should include the data for the fields passed in" do
+          output_buffer.should have_table_with_tag("th", "Title")
+          output_buffer.should have_tag("td", "The title of the post")
+          output_buffer.should have_tag("td", "Lorem ipsum")
+        end
+      end
+
+      context "and normal/association columns" do
+        before do
+          ::Post.stub!(:reflect_on_all_associations).with(:belongs_to).and_return([@mock_reflection_belongs_to_author])
+          @posts = [@freds_post]
+          table_for(@posts) do |t|
+            t.data do
+              concat(t.cell(:title))
+              concat(t.cell(:author))
+            end
+          end
+        end
+
+        it "should include normal columns" do
+          output_buffer.should have_table_with_tag("th:nth-child(1)", "Title")
+          output_buffer.should have_table_with_tag("td:nth-child(1)", "Fred's Post")
+        end
+
+        it "should include belongs_to associations" do
+          output_buffer.should have_table_with_tag("th:nth-child(2)", "Author")
+          output_buffer.should have_table_with_tag("td:nth-child(2)", "Fred Smith")
+        end
+      end
+    end
+  end
+end
+
+describe TableBuilder do
+  before do
+    mock_everything
+    ::Post.stub!(:content_columns).and_return([mock('column', :name => 'title'), mock('column', :name => 'body'), mock('column', :name => 'created_at')])
+    @posts = [@post, Post.new]
+    @builder = TableBuilder.new(@posts, nil)
+  end
+
+  it "should detect attributes" do
+    @builder.fields.should include(:title)
+  end
+
+  it "should reject marked attributes" do
+    @builder.fields.should_not include(:created_at)
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: tabletastic
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Davey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-15 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: A table builder for active record collections   that produces semantically rich and accessible markup
+email: josh@joshuadavey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tabletastic.rb
+- rails/init.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/tabletastic_spec.rb
+has_rdoc: true
+homepage: http://github.com/jgdavey/tabletastic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A smarter table builder for Rails collections
+test_files: 
+- spec/spec_helper.rb
+- spec/tabletastic_spec.rb