table_me 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= TableMe
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/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    = 'TableMe'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+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/app/assets/stylesheets/table_me/table_me.sass

@@ -0,0 +1,171 @@
+.table-me
+  display: inline-block
+  font-size: 1.2em
+.table-me-table
+  color: #eee
+  display: inline-block
+  float: left
+  font-family: 'Helvetica', 'Arial', 'Sans-Serif'
+  a 
+    color: #909BAC
+    text-decoration: none
+  a:visited
+    color: #909BAC
+  table
+    border-collapse: collapse
+    th
+      border-top: 1px solid #777
+      border-left: 1px solid #777
+      border-bottom: 1px solid #000
+      border-right: 1px solid #000
+      color: #fff
+      height: 25px
+      background: #444 /* Old browsers */
+      background: -moz-linear-gradient(top,  #444 0%, #212121 99%) /* FF3.6+ */
+      background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#444), color-stop(99%,#212121)) /* Chrome,Safari4+ */
+      background: -webkit-linear-gradient(top,  #444 0%,#212121 99%) /* Chrome10+,Safari5.1+ */
+      background: -o-linear-gradient(top,  #444 0%,#212121 99%) /* Opera 11.10+ */
+      background: -ms-linear-gradient(top,  #444 0%,#212121 99%) /* IE10+ */
+      background: linear-gradient(top,  #444 0%,#212121 99%) /* W3C */
+      filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#444', endColorstr='#212121',GradientType=0 ) /* IE6-9 */
+      a
+        padding: 8px 8px 8px 16px
+        color: #fff
+        vertical-align: center
+        background: image-url('table_me/orderable.png') 5px 15px no-repeat
+      a:visited
+        color: #fff
+      a.asc
+        background-position: 5px -17px
+      a.desc
+        background-position: 5px -43px
+    td
+      border-left: 1px solid #666
+      border-right: 1px solid #666
+      border-collapse: collapse
+      padding: 8px
+      .red,
+      .orange,
+      .green,
+        padding: 3px 7px
+        border: 1px solid #C55
+        font-size: .9em
+      .red
+        background-color: #F77
+        color: #a33
+      .green
+        background-color: #AfA
+        color: #090
+        border-color: #2A2
+      .orange
+        background-color: #FA0
+        color: #840
+        border-color: #C70
+    td:last-child
+      border-right: none
+    td:first-child
+      border-left: none
+    tr
+      border: none
+    .odd
+      background-color: rgba(255,255,255,0.1)
+  .table-me-pagination-info
+    padding-bottom: 8px
+    text-align: right
+    h3
+      position: relative
+      top: -7px
+      font-size: 1.2em
+      color: #FFF
+      float: left
+      font-family: 'Helvetica', 'Arial', 'Sans-Serif'
+      margin: 0
+      line-height: 1.4em
+    p
+      font-size: .8em
+      line-height: 1.4em
+      margin: 0
+  .table-me-pagination-controls
+    padding-top: 8px
+    text-align: right
+
+.table-filters
+  color: #fff
+  font-family: 'Helvetica', 'Arial', 'Sans-Serif'
+  padding: 10px
+  border-radius: 5px
+  margin: 0 25px
+  float: right
+  background-color: #333
+  border-left: 1px solid #aaa
+  border-top: 1px solid #aaa
+  border-right: 1px solid #000
+  border-bottom: 1px solid #000
+  h3
+    margin: 0 0 10px 0
+    padding: 0
+    font-size: 1em
+  form
+    margin-bottom: 10px
+  form:last-child
+    margin: 0
+  input
+    width: auto
+    padding: 5px
+    margin: 0 8px 0 0
+  input[type=submit]
+    width: auto
+    padding: 5px 8px
+    border-left: 1px solid #aaa
+    border-top: 1px solid #aaa
+    border-right: 1px solid #000
+    border-bottom: 1px solid #000
+    color: #fff
+    background: #444 /* Old browsers */
+    background: -moz-linear-gradient(top,  #444 0%, #212121 99%) /* FF3.6+ */
+    background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#444), color-stop(99%,#212121)) /* Chrome,Safari4+ */
+    background: -webkit-linear-gradient(top,  #444 0%,#212121 99%) /* Chrome10+,Safari5.1+ */
+    background: -o-linear-gradient(top,  #444 0%,#212121 99%) /* Opera 11.10+ */
+    background: -ms-linear-gradient(top,  #444 0%,#212121 99%) /* IE10+ */
+    background: linear-gradient(top,  #444 0%,#212121 99%) /* W3C */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#444', endColorstr='#212121',GradientType=0 ) /* IE6-9 */
+  
+.table-me-table.light
+  color: #555
+  a 
+    color: #707a8b
+  a:visited
+    color: #7079ba
+  table
+    th
+      border-top: 1px solid #eee
+      border-left: 1px solid #eee
+      border-bottom: 1px solid #999
+      border-right: 1px solid #999
+      color: #FFF
+      background: #ccc /* Old browsers */
+      background: -moz-linear-gradient(top,  #ccc 0%, #aaa 99%) /* FF3.6+ */
+      background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#ccc), color-stop(99%,#aaa)) /* Chrome,Safari4+ */
+      background: -webkit-linear-gradient(top,  #ccc 0%,#aaa 99%) /* Chrome10+,Safari5.1+ */
+      background: -o-linear-gradient(top,  #ccc 0%,#aaa 99%) /* Opera 11.10+ */
+      background: -ms-linear-gradient(top,  #ccc 0%,#aaa 99%) /* IE10+ */
+      background: linear-gradient(top,  #ccc 0%,#aaa 99%) /* W3C */
+      filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ccc', endColorstr='#aaa',GradientType=0 ) /* IE6-9 */
+    td
+      border-left: 1px solid #aaa
+      border-right: 1px solid #aaa
+    td:last-child
+      border-right: none
+    td:first-child
+      border-left: none
+    tr
+      border: none
+    .odd
+      background-color: rgba(000,000,000,0.1)
+  .table-me-pagination-info
+    h3
+      color: #444
+
+
+
+

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/table_me/builder.rb

@@ -0,0 +1,36 @@
+require_relative 'column'
+require_relative 'filter'
+module TableMe
+  # This class is responsible for building the various elements of the 
+  # table through a blog passed into the table_for_presenter
+
+  class Builder
+    attr_accessor :options
+    attr_reader :columns, :names, :filters
+    def initialize table_options
+      self.options = table_options
+      @columns = []
+      @names = []
+    end
+
+    # Define a column
+    def column name,options = {}, &block
+      @columns << TableMe::Column.new(name,options, &block)
+      @names << name
+    end
+
+    #define a filter
+    def filter name
+      TableMe::Filter.new(options, name)
+    end
+
+    def filters
+      TableMe::Filter.filters_for options[:name]
+    end
+
+    def clear_filter
+      # TODO this seems a bit hacky to me, Will want to rework this at some point
+      filters.last.display_clear
+    end
+  end
+end

data/lib/table_me/column.rb

@@ -0,0 +1,19 @@
+module TableMe
+  # This class is the column object that gets created 
+  # everytime a column is used in the table_for_presenter block
+  # It's basically a value object which keeps track of the data 
+  # for each individual column.
+  class Column
+    attr_accessor :name, :content, :sortable
+    def initialize column_name, args = {}, &block
+      self.name = column_name
+      self.content = block
+      
+      if block
+        self.sortable = args[:sort_on]
+      else
+        self.sortable = column_name
+      end
+    end
+  end
+end

data/lib/table_me/engine.rb

@@ -0,0 +1,28 @@
+require_relative '../table_me_helper/table_me_helper'
+require_relative '../table_for_helper/table_for_helper'
+
+module TableMe
+  class Engine < ::Rails::Engine
+    isolate_namespace TableMe
+
+    # send the helper methods to actionview and action controller
+    initializer "table_me" do
+      ActionView::Base.send :include, TableMe::TableForHelper
+      ActionController::Base.send :include, TableMe::TableMeHelper
+    end
+
+    initializer "table_me.load_app_instance_data" do |app|
+      TableMe.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initializer "table_me.load_static_assets" do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, view_specs: false
+    end
+  end
+end

data/lib/table_me/filter.rb

@@ -0,0 +1,81 @@
+require_relative 'url_builder'
+module TableMe
+  # This class creates the filter forms for searching a table.
+  # Unlike the column class, the filter class is responsible
+  # for creating it's own view. See the table_for_helper file
+  # for documentation on how to use filters
+  class Filter
+    attr_accessor :options, :column_name
+    
+    @@filters = {}
+
+    def initialize options, column_name
+      self.options = options
+      self.column_name = column_name
+
+      @@filters[options[:name]] ||= []
+
+
+      @@filters[options[:name]].delete_if {|item| item.column_name == column_name}
+      @@filters[options[:name]] << self 
+    end
+
+    # Display the filter form
+    def display
+      initial_value = options[:search] && options[:search][:column] == column_name.to_s ? options[:search][:query] : ''
+      <<-HTML.strip_heredoc
+        <form method='get' action="?">
+          <label for='search'>#{column_name.to_s.split('_').join(" ").titleize}</label>
+          <input type='text' name="tm_#{options[:name]}[search][query]" value="#{initial_value}"/>
+          <input type='hidden' name="tm_#{options[:name]}[search][column]" value="#{column_name}"/>
+          <input type='hidden' name="tm_#{options[:name]}[new_search]" value="true"/>
+          #{create_other_fields options}
+          <input id='search' type='submit' value='Search' />
+        </form>
+      HTML
+
+    end
+
+    # display a clear filters button, this clears the filters if any are active.
+    # This could/should be just a link styled like a button, there really isn't a
+    # need for it to be a form
+    # TODO Change this into a link instead of a form
+    def display_clear
+      <<-HTML.strip_heredoc if options[:search]
+        <form method='get' action="?">
+          #{create_other_fields options}
+          <input id='search' type='submit' value='Clear Filter' />
+        </form>
+      HTML
+    end
+
+    # getter for all the filters
+    def self.filters_for table_name
+      @@filters[table_name]
+    end
+
+    private
+
+    def create_other_fields options
+      inputs = []
+      TableMe::UrlBuilder.filter_options(options).each do |option|
+        option.each do |k,v|
+          if k.to_s == 'search'
+            # Adon't add the search fields if they are the current table
+            unless option[:name] == options[:name]
+              inputs << "<input type='hidden' name='tm_#{option[:name]}[search][query]' value='#{v[:query]}'/>"
+              inputs << "<input type='hidden' name='tm_#{option[:name]}[search][column]' value='#{v[:column]}'/>"
+            end
+          else
+            inputs << "<input type='hidden' name='tm_#{option[:name]}[#{k.to_s}]' value='#{v}'/>"
+          end
+        end
+      end
+      inputs.join("\n")
+    end
+
+    def url_for_tables options
+      TableMe::UrlBuilder.url_for options
+    end
+  end
+end

data/lib/table_me/table_for_helper/table_for_helper.rb

@@ -0,0 +1,112 @@
+require File.expand_path('../../../table_me/table_for_presenter', __FILE__)
+  
+  # In your view you can create the table from the one initialized in the controller, 
+  # the first parameter of table_for is the name set in table_me. By default the class 
+  # name is used if a name isn't set.
+
+  # table_for :user
+  # Now, this will list all columns from the database in your table, which you 
+  # may not always want to do. You can pass a block of columns to be more specific:
+
+  # table_for :user do |t|
+  #   t.column :id
+  #   t.column :email
+  #   t.column :created_at
+  # end
+
+  # This will give you a user table with the columns id, email, and created_at.
+
+  # What if you want to customize the output of the column? Each column can also 
+  # take a block of content:
+
+  # table_for :user do |t|
+  #   t.column :id
+  #   t.column :email do |c|
+  #     "<h1>c.email</h1>"
+  #   end
+  #   t.column :created_at
+  # end
+
+  # Now, when a block is used to alter the content of a column, the sorting is lost, 
+  # since the table can no longer assume what is in the column. You need to set a sort_on 
+  # param to tell the column what to sort by. For example:
+
+  # table_for :user do |t|
+  #   t.column :id
+  #   t.column :email, sort_on: :email do |c|
+  #     "<h1>c.email</h1>"
+  #   end
+  #   t.column :created_at
+  # end
+
+  # Filters
+  # You can add basic filter fields to the table by using the filter method. Right now, 
+  # only one filter can be applied and the filters are search fields. I would like to 
+  # eventually add different types for different types of data. I would like to eventually 
+  # add in the ability for multiple filter types with a single search button, but the basic 
+  # form is all I need at the moment. Ajax enabled filtering would be freaking great as well.
+
+  # Filter usage:
+
+  # table_for :user do |t|
+  #   t.filter :email
+  #   t.filter :name
+  #   t.column :id
+  #   t.column :email 
+  #   t.column :name
+  # end
+
+module TableMe
+  module TableForHelper
+    def table_for(model,options = {}, &block)
+      table_for_presenter = TableForPresenter.new(model,options,&block)
+      table_for_presenter.build_table
+    end
+    
+    # Lets say that you want to have a visual que for if a user is an admin:
+    # table_for :user do |t|
+    #   t.column :id
+    #   t.column :admin do |c|
+    #     highlight_cell c.admin, green: true
+    #   end
+    #   t.column :created_at
+    # end
+
+    # You can put a green box around true in the column by passing an array to the color 
+    # where the first value is the actual table value your looking for, while the second item 
+    # is what will be used in the table field. But what if you want to change that true to the 
+    # word 'Admin' and lets put a red box around all the non admins and make them say 'peons':
+
+    # table_for :user do |t|
+    #   t.column :id
+    #   t.column :admin do |c|
+    #     highlight_cell c.admin, green: [true, 'Admin'], red: [false, 'peon']
+    #   end
+    #   t.column :created_at
+    # end
+
+    def highlight_cell value, colors
+      color_value = output_value = color = ''
+
+      colors.each do |k,v|
+        if v.kind_of? Array
+          color_value = v[0]
+          output_value = v[1]
+        else
+          output_value = color_value = v
+        end
+        
+        if color_value == value
+          color = k.to_s
+          break
+        end
+      end
+
+      unless color.empty?
+        "<span class='#{color}'>#{output_value}</span>".html_safe
+      else
+        value
+      end
+    end
+  end
+end