snaptable 0.6.4 → 0.7.0

data/README.md

@@ -1,177 +0,0 @@
-# Snaptable
-
-A gem that generate HTML tables from your models in order to display them in your admin views. It supports pagination, sorting and searching. It is also possible to customize the tables.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'snaptable'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install snaptable
-
-Include the assets:
-
-```css
-# application.css
-/*
- *= require_self
- *= require_tree .
- *= require snaptable
- */
-
-```
-
-```js
-# application.js
-//= require_tree .
-//= require snaptable
-```
-
-## Usage
-
-### Basic table
-
-In your controller, instantiate a new `Table` with minimum two arguments: the controller itself and the model to use.
-
-```ruby
-def index
-  @table = Table.new(self, Article)
-end
-```
-
-Then, in order to enable sorting, call the method `respond` on the table.
-
-```ruby
-def index
-  @table = Table.new(self, Article)
-  @table.respond
-end
-```
-
-Finally, in your view, generate the table where you wish.
-
-```html
-<div>
-  <%= @table.present %>
-</div>
-```
-
-The elements in the table are clickable. Click on an element and use the links above the table to edit or destroy it. If you double-click, you are directly redirect to the edit page. Furthermore, the columns are sortable. Click on a label to sort the data by a column.
-
-### Options
-
-You can customize the table when you instantiate it. Pass you own collection in the third argument.
-
-```ruby
-@articles = Article.last(3)
-Table.new(self, Article, @articles)
-```
-
-Pass the options in the fourth argument. Here is a list:
-
-* buttons [true]: enable the buttons above the table to add, edit or destroy an element.
-* search [false]: enable searching. Add a search field above the table.
-
-```ruby
-Table.new(self, Article, nil, { search: true, buttons: false })
-```
-
-You can also configure the table in the view. The `present` method takes a single named argument to let you add a custom buttons bar. Pass the name of a partial to the parameter `buttons` and the content will be added above the table.
-
-```erb
-<div>
-  <%= @table.present(buttons: "my_custom_partial") %>
-</div>
-```
-
-### Custom class
-
-If you need more control on the displayed fields or on the search, you can easily create your own table.
-Create a directory `app/tables`. Then create a file `my_model_table.rb`. Inside declare a class `MyModelTable` that inherits from `BaseTable`.
-You must necessarily write a method called `model` that returns the model to use for your table.
-
-```ruby
-# article_table.rb
-class ArticleTable < BaseTable
-
-  def model
-    Article
-  end
-
-end
-```
-
-From that point, you have a working table, but it acts exactly the same than the basic table. You have few possibilities to change the behavior.
-If you want to change the table's columns, write a method `attributes` that returns an array of the model's attributes you want to display. It supports associations by allowing you to put a hash.
-
-```ruby
-def attributes
-  [:title, :content, { user: :name }]
-end
-```
-
-You can also change how the URL to edit and delete an element is generated. By default, it uses the element's id, but you can specify an other attribute. Write a method `url` that returns an attribute.
-
-```ruby
-def url
-  :slug
-end
-```
-
-By default, the search is done on the string fields of the model. If you want to search on the associations, create a module `Search` inside the class. Then declare a method `self.fields` that returns a hash and `self.associations` that returns an array. Be careful, the search is only possible on string fields.
-
-```ruby
-class ArticleTable < BaseTable
-
-  def model
-    Article
-  end
-
-  def attributes
-    [:title, :content, { user: :name }]
-  end
-
-  def url
-    :slug
-  end
-
-  module Search
-
-    def self.associations
-      [:user, :category]
-    end
-
-    def self.fields
-      { articles: [:title, :content], user: [:name, :email], category: [:name] }
-    end
-
-  end
-```
-
-### Permission
-
-if you want to use a permission system, you can enable it in an initializer.
-
-```ruby
-# initializers/snaptable.rb
-Snaptable.use_permission = true
-```
-
-When the table fetches the data, it will use `current_permission.records(controller, model, token)`. It is up to you to implement the class and its method that respond to those three arguments.
-
-## Contributing
-
-1. Fork it ( https://github.com/khcr/snaptable/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "snaptable"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/snaptable/rails/engine.rb

@@ -1,11 +0,0 @@
-module Snaptable
-  module Rails
-    class Engine < ::Rails::Engine
-      require "will_paginate"
-
-      initializer "Snaptable.assets.precompile" do |app|
-        app.config.assets.precompile +=%w(autotable.js autotable.css)
-      end
-    end
-  end
-end

data/lib/snaptable/rails/version.rb

@@ -1,5 +0,0 @@
-module Snaptable
-  module Rails
-    VERSION = "0.6.4"
-  end
-end

data/lib/snaptable/rails.rb

@@ -1,7 +0,0 @@
-require 'snaptable/rails/engine'
-require 'snaptable/rails/version'
-
-module Snaptable
-  module Rails
-  end
-end

data/snaptable.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'snaptable/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "snaptable"
-  spec.version       = Snaptable::VERSION
-  spec.authors       = ["khcr"]
-  spec.email         = ["kocher.ke@gmail.com"]
-
-  spec.summary       = "A gem that generate HTML tables from your models in order to display them in your admin views."
-  spec.description   = spec.summary
-  spec.homepage      = "http://github.com/khcr/snaptable"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-
-  spec.add_dependency "rails", ">= 4.2.0"
-  spec.add_dependency "railties", ">= 4.2.0"
-  spec.add_dependency "will_paginate"
-  spec.add_dependency "sass-rails"
-  spec.add_dependency "jquery-rails"
-end