tabulatr 0.0.1 → 0.0.2

data/.gitignore

@@ -1 +1,2 @@
 pkg
+tabulatr-*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -2,12 +2,12 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem "rails"
-gem "whiny_hash"
-gem "id_stuffer"
-
 group :development, :test do
+  gem 'sqlite3-ruby', :require => 'sqlite3'
+  gem 'ruby-debug19'
   gem 'rspec'
   gem 'rspec-rails'
-  gem 'webrat'
+  gem 'capybara'
+  gem 'launchy'
+  gem 'database_cleaner'
 end

data/Gemfile.lock

@@ -1,48 +1,73 @@
 PATH
   remote: .
   specs:
-    tabulatr (0.0.1)
+    tabulatr (0.0.2)
       id_stuffer (>= 0.0.1)
-      rails (~> 3.0.3)
+      rails (~> 3.0)
       whiny_hash (>= 0.0.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.3)
-      actionpack (= 3.0.3)
-      mail (~> 2.2.9)
-    actionpack (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.4)
       rack (~> 1.2.1)
       rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.6)
+      rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
       arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-    activesupport (3.0.3)
-    arel (2.0.7)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    archive-tar-minitar (0.5.2)
+    arel (2.0.9)
     builder (2.1.2)
+    capybara (0.4.1.2)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.8)
+    childprocess (0.1.7)
+      ffi (~> 0.6.3)
+    columnize (0.3.2)
+    configuration (1.2.0)
+    culerity (0.2.15)
+    database_cleaner (0.6.6)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
     i18n (0.5.0)
     id_stuffer (0.0.1)
+    json_pure (1.5.1)
+    launchy (0.4.0)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
     mail (2.2.15)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
@@ -51,56 +76,74 @@ GEM
     mime-types (1.16)
     nokogiri (1.4.4)
     polyglot (0.3.1)
-    rack (1.2.1)
+    rack (1.2.2)
     rack-mount (0.6.13)
       rack (>= 1.0.0)
-    rack-test (0.5.6)
+    rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.3)
-      actionmailer (= 3.0.3)
-      actionpack (= 3.0.3)
-      activerecord (= 3.0.3)
-      activeresource (= 3.0.3)
-      activesupport (= 3.0.3)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
       bundler (~> 1.0)
-      railties (= 3.0.3)
-    railties (3.0.3)
-      actionpack (= 3.0.3)
-      activesupport (= 3.0.3)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
       rake (>= 0.8.7)
       thor (~> 0.14.4)
     rake (0.8.7)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    rspec-rails (2.3.1)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
       actionpack (~> 3.0)
       activesupport (~> 3.0)
       railties (~> 3.0)
-      rspec (~> 2.3.0)
+      rspec (~> 2.5.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.3)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
     thor (0.14.6)
     treetop (1.4.9)
       polyglot (>= 0.3.1)
-    tzinfo (0.3.23)
-    webrat (0.7.2)
-      nokogiri (>= 1.2.0)
-      rack (>= 1.0)
-      rack-test (>= 0.5.3)
+    tzinfo (0.3.25)
     whiny_hash (0.0.2)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  id_stuffer
-  rails
+  capybara
+  database_cleaner
+  launchy
   rspec
   rspec-rails
+  ruby-debug19
+  sqlite3-ruby
   tabulatr!
-  webrat
-  whiny_hash

data/README.textile

@@ -11,7 +11,7 @@ We found ourselves reinventing the wheel in every project we made, by using
 * difterent ways of implementing selecting and batch actions,
 * different layouts.
 
-We finally thought that whilst gems like Formtastic or SimpleForm provide a really cool, uniform, and concise way to implement forms, it's time for a table builder. During a project with Magento (*shiver*) we decided that their general tables are quite reasonable, and enterprise-proven -- so that's our starting point. 
+We finally thought that whilst gems like Formtastic or SimpleForm provide a really cool, uniform, and concise way to implement forms, it's time for a table builder. During a project with Magento (*shiver*) we decided that their general tables are quite reasonable, and enterprise-proven -- so that's our starting point.
 
 h3. Visual Components
 
@@ -19,10 +19,10 @@ Every Tabulatr table consists of the following components:
 
 * a wrapping form
 * a 'Controls Container' containing the table-controls as
-  * the paginator, 
-  * the batch_actions, 
-  * the submit button, 
-  * controls to manage selecting/checking/marking, 
+  * the paginator,
+  * the batch_actions,
+  * the submit button,
+  * controls to manage selecting/checking/marking,
   * an info_text
 * The actual table consisting of
   * A header row,
@@ -30,7 +30,7 @@ Every Tabulatr table consists of the following components:
   * data rows,
   * possibly a selecting/checking/marking column
   * possibly action links/buttons
-  
+
 Whilst this is a strong decision, we made everything as-configurable-as-possible, there are roughly 150 options you can use to tweak almost every aspect of Tabulatr.
 
 h3. Features
@@ -49,7 +49,7 @@ We suppose we have a couple of models
 * tags has and belong to many products
 * vendors have many products
 * products belong to vendors and have and belong to many tags
-  
+
 h3. Controller
 
 In the products controllers index action we have:
@@ -62,7 +62,7 @@ In the products controllers index action we have:
 
 the find_for_table method is injected into ActiveRecord by Tabulatr, it retrieves all relevant data from the params hash automagically.
 
-h3.View
+h3. View
 
 To get a simple Table, all we need to do is
 
@@ -79,15 +79,18 @@ To get a simple Table, all we need to do is
 
 but the result is pretty fancy, already:
 
-<img src="assets/simple_table.png" />
+<img src="https://github.com/provideal/tabulatr/raw/master/assets/simple_table.png" />
 
 To add a column with ckeckboxes (thus giving all the "Select ..." buttons a reasonable semantics), we simply add a
+
 <pre>
-  t.checkbox  
+  t.checkbox
 </pre>
+
 row.
 
 To add e.g. edit-buttons, we specify
+
 <pre>
   t.action do |record|
     link_to "Edit", edit_product_path(record)
@@ -95,6 +98,7 @@ To add e.g. edit-buttons, we specify
 </pre>
 
 To add a select-popup with batch-actions (i.e., actions that are to be perfored on all selected rows), we add an option to the table_for:
+
 <pre>
   <%= table_for @products, :batch_actions => {'foo' => 'Foo', 'delete' => "Delete"} do |t|
     ...
@@ -102,6 +106,7 @@ To add a select-popup with batch-actions (i.e., actions that are to be perfored
 </pre>
 
 to handle the actual batch action, we have to add a block to the <tt>find_for_table</tt> call in the controller:
+
 <pre>
   @products = Product.find_for_table(params) do |batch_actions|
     batch_actions.delete do |ids|
@@ -112,12 +117,47 @@ to handle the actual batch action, we have to add a block to the <tt>find_for_ta
       return
     end
     batch_actions.foo do |ids|
-      # do whatever is foo-ish to the records
+      ... do whatever is foo-ish to the records
     end
   end
 </pre>
+
 where the <tt>ids</tt> parameter to the block is actually an Array containing the numeric ids of the currently selected rows.
 
+h2. Installation
+
+Installation is pretty straightforward. Just include a line
+
+<pre>
+  gem 'tabulatr', '...current version here'
+</pre>
+
+in your applications <tt>Gemfile</tt>, then run <tt>bundle install</tt>.
+
+If you want to use a predefined stylesheet and the images for sorting and paging, just issue
+
+<pre>
+  $ rails g tabulatr:install
+       create  public/stylesheets/tabulatr.css
+       create  public/images/tabulatr/buttons_lite_background.png
+       create  public/images/tabulatr/pager_arrow_left.gif
+       create  public/images/tabulatr/pager_arrow_left_off.gif
+       create  public/images/tabulatr/pager_arrow_right.gif
+       create  public/images/tabulatr/pager_arrow_right_off.gif
+       create  public/images/tabulatr/sort_arrow_down.gif
+       create  public/images/tabulatr/sort_arrow_down_off.gif
+       create  public/images/tabulatr/sort_arrow_up.gif
+       create  public/images/tabulatr/sort_arrow_up_off.gif
+  -------------------------------------------------------
+  Please note: We have copied a sample stylesheet to 
+    public/stylesheets/tabulatr.css
+  to actually use it in your application, please include 
+  it in your layout file. You may use s/th like
+    <%= stylesheet_link_tag :tabulatr %>
+  for that.
+  -------------------------------------------------------
+</pre>
+
 h2. Options
 
 Literally every aspect of Tabulatr can be tweaked to fit your needs. You may add or remove components, change the class or other html attributes of the generated html nodes. There are options of several types:
@@ -127,40 +167,40 @@ h3. Table Options
 These options are to be specified at the form_for level and change the appearance and behaviour of the table. This is taken from <tt>lib/tabulatr/tabulatr/settings.rb</tt>
 
 <pre>
-  remote: false,                               # add data-remote="true" to form
-  form_class: 'tabulatr_form',                 # class of the overall form
-  table_class: 'tabulatr_table',               # class for the actual data table
-  sortable_class: 'sortable',                  # class for the header of a sortable column
-  sorting_asc_class: 'sorting-asc',            # class for the currently asc sorting column
-  sorting_desc_class: 'sorting-desc',          # class for the currently desc sorting column
-  page_left_class: 'page-left',                # class for the page left button
-  page_right_class: 'page-right',              # class for the page right button
-  page_no_class: 'page-no',                    # class for the page no <input>
-  control_div_class_before: 'table-controls',  # class of the upper div containing the paging and batch action controls
-  control_div_class_after: 'table-controls',   # class of the lower div containing the paging and batch action controls
-  paginator_div_class: 'paginator',            # class of the div containing the paging controls
-  batch_actions_div_class: 'batch-actions',    # class of the div containing the batch action controls
+  remote: false,                                # add data-remote="true" to form
+  form_class: 'tabulatr_form',                  # class of the overall form
+  table_class: 'tabulatr_table',                # class for the actual data table
+  sortable_class: 'sortable',                   # class for the header of a sortable column
+  sorting_asc_class: 'sorting-asc',             # class for the currently asc sorting column
+  sorting_desc_class: 'sorting-desc',           # class for the currently desc sorting column
+  page_left_class: 'page-left',                 # class for the page left button
+  page_right_class: 'page-right',               # class for the page right button
+  page_no_class: 'page-no',                     # class for the page no <input>
+  control_div_class_before: 'table-controls',   # class of the upper div containing the paging and batch action controls
+  control_div_class_after: 'table-controls',    # class of the lower div containing the paging and batch action controls
+  paginator_div_class: 'paginator',             # class of the div containing the paging controls
+  batch_actions_div_class: 'batch-actions',     # class of the div containing the batch action controls
   select_controls_div_class: 'check-controls',  # class of the div containing the check controls
-  submit_class: 'submit-table',                # class of submit button
-  pagesize_select_class: 'pagesize_select',    # class of the pagesize select element
-  select_all_class: 'select-btn',              # class of the select all button
-  select_none_class: 'select-btn',             # class of the select none button
-  select_visible_class: 'select-btn',          # class of the select visible button
-  unselect_visible_class: 'select-btn',        # class of the unselect visible button
-  select_filtered_class: 'select-btn',         # class of the select filtered button
-  unselect_filtered_class: 'select-btn',       # class of the unselect filteredbutton
-  info_text_class: 'info-text',                # class of the info text div
-
-  batch_actions_label: 'Batch Action: ',       # Text to show in front of the batch action select
-  batch_actions_type: :select,                 # :select or :button depending on the kind of input you want
-  batch_actions_class: 'batch-action-inputs',  # class to apply on the batch action input elements
-  submit_label: 'Apply',                       # Text on the submit button
-  select_all_label: 'Select All',              # Text on the select all button
-  select_none_label: 'Select None',            # Text on the select none button
-  select_visible_label: 'Select visible',      # Text on the select visible button
-  unselect_visible_label: 'Unselect visible',  # Text on the unselect visible button
-  select_filtered_label: 'Select filtered',    # Text on the select filtered button
-  unselect_filtered_label: 'Unselect filtered',# Text on the unselect filtered button
+  submit_class: 'submit-table',                 # class of submit button
+  pagesize_select_class: 'pagesize_select',     # class of the pagesize select element
+  select_all_class: 'select-btn',               # class of the select all button
+  select_none_class: 'select-btn',              # class of the select none button
+  select_visible_class: 'select-btn',           # class of the select visible button
+  unselect_visible_class: 'select-btn',         # class of the unselect visible button
+  select_filtered_class: 'select-btn',          # class of the select filtered button
+  unselect_filtered_class: 'select-btn',        # class of the unselect filteredbutton
+  info_text_class: 'info-text',                 # class of the info text div
+
+  batch_actions_label: 'Batch Action: ',        # Text to show in front of the batch action select
+  batch_actions_type: :select,                  # :select or :button depending on the kind of input you want
+  batch_actions_class: 'batch-action-inputs',   # class to apply on the batch action input elements
+  submit_label: 'Apply',                        # Text on the submit button
+  select_all_label: 'Select All',               # Text on the select all button
+  select_none_label: 'Select None',             # Text on the select none button
+  select_visible_label: 'Select visible',       # Text on the select visible button
+  unselect_visible_label: 'Unselect visible',   # Text on the unselect visible button
+  select_filtered_label: 'Select filtered',     # Text on the select filtered button
+  unselect_filtered_label: 'Unselect filtered', # Text on the unselect filtered button
   info_text: "Showing %1$d, total %2$d, selected %3$d, matching %4$d",
 
   # which controls to be rendered above and below the tabel and in which order
@@ -208,7 +248,6 @@ h3. Column Options
   td_html: false,                  # a hash with html attributes for the cells
   th_html: false,                  # a hash with html attributes for the header cell
   filter_html: false,              # a hash with html attributes for the filter cell
-  filter_html: false,              # a hash with html attributes for the filter cell
   filter: true,                    # false for no filter field,
                                    # container for options_for_select
                                    # String from options_from_collection_for_select or the like
@@ -225,13 +264,14 @@ h3. Column Options
   sortable: true                   # if set, sorting-stuff is added to the header cell
 </pre>
 
-h3. Global settings 
+h3. Global settings
 
 These settings are *not* supposed to be changed on a per-table basis. This is necessary, because the <tt>find_for_table</tt> method needs to rely on a priori information.
 
 h4. Table Form Options
 
-This hash contains all the information about the naming of the generated form elements. To override them, you should, in an initializer, call 
+This hash contains all the information about the naming of the generated form elements. To override them, you should, in an initializer, call
+
 <pre>
   Tabulatr.table_form_options(my_options_hash)
 </pre>
@@ -251,7 +291,8 @@ This hash contains all the information about the naming of the generated form el
 
 h4. Paginate options
 
-To override these, you should, in an initializer, call 
+To override these, you should, in an initializer, call
+
 <pre>
   Tabulatr.paginate_options(my_options_hash)
 </pre>
@@ -262,16 +303,16 @@ To override these, you should, in an initializer, call
   pagesizes: [10, 20, 50]
 </pre>
 
-h2.Dependencies
+h2. Dependencies
 
 We use
-* <a href="http://github.com/providel/whiny_hash">WhinyHash</a> to handle the options in a fail-early-manner,
-* <a href="http://github.com/providel/id_stuffer">IdStuffer</a> to compress the _remembered_ ids.
-* And... eh... It's an extension for rails, so it might be handy to have a version of rails 3 and ruby 1.9.
+* <a href="http://github.com/provideal/whiny_hash">WhinyHash</a> to handle the options in a fail-early-manner,
+* <a href="http://github.com/provideal/id_stuffer">IdStuffer</a> to compress the _remembered_ ids.
+* And... eh... It's an extension for Rails 3, so it might be handy to have a version of Rails 3 and Ruby 1.9.2.
 
-h2.Bugs
+h2. Bugs
 
-There are, definitely, roughly 1000 bugs in Tabulatr, although we do some testing (see <tt>spec/dummy_app/spec</tt>). So if you hunt them, please let me know.
+There are, definitely, roughly 1000 bugs in Tabulatr, although we do some testing (see <tt>spec/</tt>). So if you hunt them, please let me know.
 
 h2. License