tabulatr2 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed16072e8467181351d73105aa639ef912bf45ac
+  data.tar.gz: 2687df6d54ad1eb562ec38af9ee643659103f51d
+SHA512:
+  metadata.gz: 94aa03bf3924604e5e9d884f58b61a605fdc2b79f557b0e40fb01953438c06f7a17516f2f6df7555ec1e2d3b27b29699744ba55c38a9cb7dd1d040aedae33ee4
+  data.tar.gz: 2b19e830e2ffd98159636950e057c8fc5939f9cf9922942af7d7f09326ec82bfa031497485f0d18f54b9f2b5dfce7db14b851df0f13d08753f1b436a87b660f8

data/.gitignore

@@ -0,0 +1,9 @@
+pkg
+tabulatr-*.gem
+Gemfile.lock
+.bundle
+spec/dummy/tmp/*
+tags
+log
+.DS_Store
+.rake_tasks~

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - '2.0.0'
+script: "bundle exec rspec spec"

data/Changelog.textile

@@ -0,0 +1,124 @@
+h1. Changelog for tabulatr
+
+* Fixed <tt>:filter_width</tt> not working for <tt>select</tt> filters.
+* Giving a Hash as <tt>:format</tt> option gives the corresponding value.
+* We now allow column presets:
+  <pre>
+  Tabulatr.config do |config|
+    #...
+    config.column_presets({
+    config.column_presets({
+      :action_column => {:width => '100px'},
+      :smallint => { :width =>  '55px', :filter_width =>  '30px', :align => 'right' },
+      :id  =>      :smallint,
+      :sid =>      { :width => '200px', :filter_width => '170px', :filter => :like },
+      :title =>    { :filter => :like },
+      :count =>    { :map => false, :width => '40px', :filter => false, :align => 'right' },
+      :moo =>      { :width =>  '155px', :filter_width =>  '120px', :align => 'right' }
+    })
+  end
+  </pre>
+
+Now, every column will check whether there is as entry corresponding to its name in this table and get the content as 'default' options.
+
+  <pre>
+    <%= table_for @regions do |t|
+      t.column :id
+      t.column :sid
+      # ...
+    end %>
+  </pre>
+
+so, the :id column has all the options defined above. The :action_column entry is used for 'action' columns.
+
+But even better, you can use arbitrary presets:
+
+  <pre>
+  t.column :foo, :preset => :moo
+  </pre>
+
+gets the :moo preset.
+
+h2. 0.4.2
+
+* Fixed two more bugs breaking ruby 1.8 compatibility. (Thanks to <a href="https://github.com/moabite">moabite</a> for reporting)
+
+h2. 0.4.1
+
+* Fixed a "bug" breaking ruby 1.8 compatibility. (Thanks to <a href="https://github.com/moabite">moabite</a> for reporting)
+
+h2. 0.4.0
+
+* Mongoid now really works.
+* A lot of cleanup in the finder code (million thanks to <a href="https://github.com/plukevdh">plukevdh</a>)
+* You can use <tt>table_for</tt> for 'normal' arrays that weren't found with <tt>find_for_table</tt>.
+* Added a :name_mapping option to find_for_table to allow filtering by compund expressions, example:
+
+  <pre>
+  @customers = Customer.find_for_table(params,
+    name_mapping: {
+      name: '("addresses"."firstname" || \' \' || "addresses"."lastname")',
+      address: '("addresses"."street" || \' \' || "addresses"."zip_code" || \' \' || "addresses"."city")'
+    },
+    default_order: 'updated_at desc'
+  )
+  </pre>
+
+* Added Mysql2Adapter to the ActiveRecord connection list (thanks to <a href="https://github.com/AaronLasseigne">AaronLasseigne</a>).
+* Monkeypatch mongoid only if it is present. (thanks to <a href="https://github.com/rwz">rwz</a>)
+
+h2. 0.3.0
+
+* Converted into a Rails 3.1 engine and moved css and images to use the new asset pipeline. Works with 3.0.x -- 'opefully. Thanks to all that reported the problem.
+* Header cells are now auto translated. Thanks to <a href="https://github.com/niedhui">niedhui</a>!
+
+h2. 0.2.1
+
+* Fixed a ruby 1.8 syntax issue. (Thanks to <a href="https://github.com/TBAA">TBAA</a> for reporting.)
+
+h2. 0.2.0
+
+* Mongoid can also be used in place of ActiveRecord
+* fixed handling of the primary_key column and name
+* Added dom_id to tables tr. Thanks to <a href="https://github.com/sterrym">sterrym (Tim Glen)</a>!
+* Added note on "Request-URI Too Large error" to README
+
+h2. 0.1.3
+
+* nicer table headers. Thanks to <a href="https://github.com/troya2" target="_blank">troya2 (Troy Anderson)</a>!
+
+h2. 0.1.2
+
+* Fixed bug with nil exception on 'empty' belongs_to association. Thanks to <a href="https://github.com/dgm" target="_blank">dgm</a>!
+
+h2. 0.1.1
+
+* Fixed bug with "Select ..." buttons introduced in 0.1.0.
+* Added tests for these buttons.
+
+h2. v0.1.0
+
+* new <tt>find_for_table</tt> option <tt>:stateful</tt>. If
+
+<pre>
+  MyFancyModel.find_for_table params, :stateful => session
+</pre>
+
+is given, the current sorting, filtering, selecting and paging information is stored to the session and restored when reopened. Great for procession specifically filtered lists.
+
+h2. v0.0.5 (2011-03-28)
+
+* new column option :map (defaults to true) to disable automatic mapping on the enries of the association as in
+
+  <pre>
+  <%= table_for @products do |t|
+    ...
+    t.association :tags, :title # mapped to all tags
+    t.association :tags, :count, :map => false # called on the list-of-tags
+  end %>
+  </pre>
+
+
+h2. v0.0.4 (2011-03-27)
+
+* fixed the path to paging/sorting images installed by generator. Thanks to <a href="https://github.com/sdsykes" target="_blank">sdsykes</a>!

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'tabulatr2', path: './', require: 'tabulatr'
+
+gem 'jquery-rails'
+
+
+
+group :development, :test do
+  gem 'sqlite3', :require => 'sqlite3'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'launchy'
+  gem 'database_cleaner', '< 1.1.0'
+  gem 'poltergeist'
+  gem 'sass-rails', '~> 4.0.0'
+  gem 'bootstrap-sass', github: 'thomas-mcdonald/bootstrap-sass', branch: '3'
+end

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2010-2011 by Provideal GmbH, Peter Horn
+http://www.provideal.net, peter.horn@provideal.net
+
+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,242 @@
+# Tabulatr2 - Index Tables made easy
+[![Code Climate](https://codeclimate.com/github/provideal/tabulatr2.png)](https://codeclimate.com/github/provideal/tabulatr2)
+
+**WARNING: Tabulatr2 is not production ready yet!**
+
+## Installation
+
+Require tabulatr2 in your Gemfile:
+```ruby
+gem 'tabulatr2', github: 'provideal/tabulatr2', require: 'tabulatr'
+```
+After that run `bundle` and `rails g tabulatr:install`.
+
+Also add `//= require tabulatr` to your application js file.
+
+### Security
+
+Tabulatr2 tries to do its best to secure your application. Specifically its secured against
+an attacker who tries to change the parameters of the table and include e.g. a `password` field.
+
+**Important:** But in order to make it so secure you have to alter the two `secret_tokens`
+in your `config/initializers/tabulatr.rb` file to different values.
+
+```ruby
+Tabulatr.config do |c|
+  c.secret_tokens = ['???', '???']
+end
+```
+
+
+
+## Usage
+
+### Models
+
+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
+
+## Controller
+
+In `ProductsController#index` we have:
+
+```ruby
+  def index
+    tabulatr_for Product
+  end
+```
+
+_Hint:_ If you want to prefilter your table, you can do that too! Just pass an `ActiveRecord::Relation` to `tabulatr_for`:
+```ruby
+  def index
+    tabulatr_for Product.where(active: true)
+  end
+```
+
+### View
+
+To get a simple Table, all we need to do is
+
+```erb
+  <%= table_for Product do |t|
+    t.column :title
+    t.column :price
+    t.column :active
+    t.association :vendor, :name
+    t.association :tags, :title
+  end %>
+```
+
+To add a checkbox column just add
+```ruby
+t.checkbox
+```
+
+
+To add e.g. edit-buttons, we would specify
+
+```erb
+  t.action do |record|
+    link_to "Edit", edit_product_path(record.id)
+  end
+```
+
+To add a select box with batch-actions (i.e., actions that are to be performed on all selected rows),
+we add an option to the table_for:
+
+```erb
+  <%= table_for Product, batch_actions: {'foo' => 'Foo', 'delete' => "Delete"} do |t|
+    ...
+  end %>
+```
+
+To handle the actual batch action, we have to add a block to the `find_for_table` call in the controller:
+
+```ruby
+  tabulatr_for Product do |batch_actions|
+    batch_actions.delete do |ids|
+      ids.each do |id|
+        Product.find(id).destroy
+      end
+      redirect_to index_select_products_path()
+      return
+    end
+    batch_actions.foo do |ids|
+      ... do whatever is foo-ish to the records
+    end
+  end
+```
+
+where the `ids` parameter to the block is actually an Array containing the numeric ids of the currently selected rows.
+
+
+## Features
+
+Tabulatr aims at making the ever-recurring task of creating listings of ActiveRecord models simple and uniform.
+
+We found ourselves reinventing the wheel in every project we made, by using
+
+* different paging mechanisms,
+* different ways of implementing filtering/searching,
+* different 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, we decided that their general tables are quite reasonable,
+and enterprise-proven -- so that's our starting point.
+
+Tabulatr tries to make these common tasks as simple/transparent as possible:
+* paging
+* selecting/checking/marking
+* filtering
+* batch actions
+
+
+## Options
+
+
+### Table Options
+
+These options are to be specified at the `table_for` level and change the appearance and behaviour of the table.
+
+```ruby
+  :table_class => 'tabulatr_table',               # class for the actual data table
+  :control_div_class_before => 'table-controls',  # class of upper div containing the paging and batch action controls
+  :control_div_class_after => 'table-controls',   # class of lower div containing the paging and batch action controls
+  :paginator_div_class => 'pagination',            # class of the div containing the paging controls
+
+  # which controls to be rendered above and below the table and in which order
+  :before_table_controls => [:filter, :paginator],
+  :after_table_controls => [],
+
+  :table_html => false,              # a hash with html attributes for the table
+  :row_html => false,                # a hash with html attributes for the normal trs
+  :header_html => false,             # a hash with html attributes for the header trs
+  :filter_html => false,             # a hash with html attributes for the filter trs
+  :filter => true,                   # false for no filter row at all
+  :paginate => false,                # true to show paginator, false for endless scrolling.
+                                     # number for limit of items to show via pagination
+  :sortable => true,                 # true to allow sorting (can be specified for every sortable column)
+  :batch_actions => false,           # :name => value hash of batch action stuff
+  :footer_content => false,          # if given, add a <%= content_for <footer_content> %> before the </table>
+  :path => '#'                       # where to send the AJAX-requests to
+```
+
+### Column Options
+
+```ruby
+  :header => false,                   # a string to write into the header cell
+  :width => false,                    # the width of the cell
+  :align => false,                    # horizontal alignment
+  :valign => false,                   # vertical alignment
+  :wrap => true,                      # wraps
+  :type => :string,                   # :integer, :date
+  :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 => true,                    # false for no filter field,
+                                       # container for options_for_select
+                                       # String from options_from_collection_for_select or the like
+                                       # :range for range spec
+                                       # :checkbox for a 0/1 valued checkbox
+  :checkbox_value => '1',             # value if checkbox is checked
+  :checkbox_label => '',              # text behind the checkbox
+  :filter_width => '97%',             # width of the filter <input>
+  :range_filter_symbol => '&ndash;',  # put between the <inputs> of the range filter
+  :sortable => true,                  # if set, sorting-stuff is added to the header cell
+  :format_methods => []               # javascript method to execute on this column
+```
+
+
+## Dependencies
+
+We use [whiny_hash](http://github.com/provideal/whiny_hash) to handle the options in a fail-early-manner.
+
+## Known Bugs
+
+### Request-URI Too Large error
+
+This is a problem particulary when using WEBrick, because WEBricks URIs must not exceed 2048 characters.
+And this limit is hard-coded IIRC. So – If you run into this limitation –
+please consider using another server.
+(Thanks to [stepheneb](https://github.com/stepheneb) for calling my attention back to this.)
+
+## Other, new bugs
+
+There are roughly another 997 bugs in Tabulatr2, although we do some testing.
+If you hunt them, please file an issue.
+
+## Contributing
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the Issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it, run them via `rspec spec` and check that they all pass.
+* Please try not to mess with the Rakefile, version, or history.
+  If you want to have your own version, or is otherwise necessary, that is fine,
+  but please isolate to its own commit so I can cherry-pick around it.
+* Feel free to send a pull request if you think others (me, for example) would like to have your change
+  incorporated into future versions of tabulatr.
+
+## MIT License
+
+Copyright (c) 2010-2013 Peter Horn, Provideal GmbH</a>
+
+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/Rakefile

@@ -0,0 +1,11 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec