activegrid 1.0.0

data/README.md

@@ -0,0 +1,28 @@
+# ActiveGrid
+
+ActiveGrid is a gem to allow Rails apps to easily add data grids 
+that can be sorted, paginated, filtered and styled.
+
+## Description
+
+Using the ActiveGrid gem consists of a few steps:
+
+  1) Add the following to your Gemfile and run "bundle":
+    
+      gem "activegrid"
+      
+  2) Setup your controller to have a collection of ActiveRecord objects. Something like this would be fine:
+     
+     @models = Model.scoped.activegrid_filter_sort_paginate
+     
+  3) In your view, add the activegrid helper
+  
+     <%= activegrid @products, paginate: 10 do |grid, model| %>
+       <%= grid.column :name, filter: %W[Blah Gizmo Widget], sortable: true do %>
+         <%= link_to model.name, product_path(model) %>
+       <% end %>
+
+       <%= grid.column :description, filter: "string", sortable: true do %>
+         <%= model.description %>
+       <% end %>
+     <% end %>

data/Rakefile

@@ -0,0 +1,39 @@
+#!/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    = 'ActiveGrid'
+  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/javascripts/activegrid.js

@@ -0,0 +1,73 @@
+//= require jquery
+//= require jquery_ujs
+
+$(function() {
+  $("table[data-activegrid=true]").each(function(index, table) {
+    var self = $(table);
+    var name = self.attr("data-activegrid-name");
+    var page = 1;
+    var pages = self.attr("data-activegrid-pages");
+    var paginate = self.attr("data-activegrid-paginate");
+    var order = null;
+    var filterField = null, filterValue = null;
+
+    var baseURL = function() {
+      var url = "?"
+      url += encodeURI("activegrid[name]") + "=" + encodeURI(name);
+      url += "&" + encodeURI("activegrid[limit]") + "=" + encodeURI(paginate);
+      url += "&" + encodeURI("activegrid[offset]") + "=" + encodeURI((page - 1) * paginate);
+      return url;
+    };
+
+    var updateTable = function() {
+      var url = "?"
+      url += encodeURI("activegrid[name]") + "=" + encodeURI(name);
+      url += "&" + encodeURI("activegrid[limit]") + "=" + encodeURI(paginate);
+      url += "&" + encodeURI("activegrid[offset]") + "=" + encodeURI((page - 1) * paginate);
+
+      if (order) {
+        url += "&" + encodeURI("activegrid[order]") + "=" + encodeURI(order);
+      }
+
+      if (filterField) {
+        url += "&" + encodeURI("activegrid[filter][field]") + "=" + encodeURI(filterField);
+        url += "&" + encodeURI("activegrid[filter][value]") + "=" + encodeURI(filterValue);
+      }
+
+      $.ajax({ url: url, dataType: "script" });
+    };
+
+    // Sorting
+    var resetSortDirection = function() {
+      var set = $("th[data-activegrid-sort=true]", table);
+      set.data("activegrid-sort-direction", null).removeClass("activegrid-sort-asc").removeClass("activegrid-sort-desc");
+    };
+    $("th[data-activegrid-sort=true]", table).click(function() {
+      var self = $(this);
+      var field = self.attr("data-activegrid-sort-field");
+      var direction = self.data("activegrid-sort-direction");
+      var newDirection = direction == "asc" ? "desc" : "asc";
+      resetSortDirection();
+
+      self.data("activegrid-sort-direction", newDirection).addClass("activegrid-sort-" + newDirection);
+      order = field + (newDirection == "asc" ? "" : " DESC");
+      updateTable();
+    });
+
+    // Filtering
+    $(":input[data-activegrid-filter=true]", table).change(function() {
+      var self = $(this);
+      var field = self.attr("data-activegrid-filter-field");
+
+      filterField = field;
+      filterValue = self.val();
+      updateTable();
+    });
+
+    // TODO: pagination (back and forward buttons, list of pages)
+  });
+});
+
+function activegrid_update(element, body) {
+  $("#" + element + " tbody").html(body);
+};

data/app/assets/stylesheets/activegrid.css

@@ -0,0 +1,4 @@
+table.activegrid
+{
+
+}

data/app/controllers/active_grid/controller.rb

@@ -0,0 +1,53 @@
+module ActiveGrid
+  class Controller < ::ApplicationController
+    helper do
+      attr_accessor :_activegrid
+
+      def activegrid(name_or_options = {}, &block)
+        if name_or_options.is_a?(Hash)
+          _activegrid.options.merge!(name_or_options)
+          _activegrid.block = block
+        else
+          if grid = activegrids[name_or_options]
+            grid.to_html
+          else
+            raise "No such activegrid #{name}"
+          end
+        end
+      end
+    end
+
+    private
+      def activegrid(name, scope, partial = "#{name}/grid")
+        raise "scope must be an ActiveRecord::Relation" unless scope.is_a?(ActiveRecord::Relation)
+
+        if params = self.params[:activegrid] and params[:name] == name.to_s
+          scope = scope.order(params[:order]) if params[:order]
+          scope = scope.limit(params[:limit]) if params[:limit]
+          scope = scope.offset(params[:offset]) if params[:offset]
+
+          if filter = params[:filter]
+            table = scope.klass.arel_table
+            scope = scope.where(table[filter[:field]].matches("%#{filter[:value]}%"))
+          end
+
+          @element = "#{name}_grid"
+          @grid = ActiveGrid::Grid.new(view_context, name, scope, partial)
+
+          respond_to do |format|
+            format.js { render "active_grid/update" }
+          end
+
+          true
+        else
+          activegrids[name] = ActiveGrid::Grid.new(view_context, name, scope, partial)
+          false
+        end
+      end
+
+      def activegrids
+        @activegrids ||= {}
+      end
+      helper_method :activegrids
+  end
+end

data/app/lib/active_grid/column.rb

@@ -0,0 +1,42 @@
+module ActiveGrid
+  class Column
+    attr_reader :block, :name, :options, :view
+
+    def initialize(view, name, options = {}, &block)
+      @view, @name, @options, @block = view, name, options, block
+    end
+
+    def header
+      # TODO: localization?
+      options[:header] || name.to_s.titleize
+    end
+
+    def filter
+      tag_options = {}
+      tag_options["data-activegrid-filter-field"] = name
+      tag_options["data-activegrid-filter"] = true
+
+      case filter = options[:filter]
+      when "string"
+        view.text_field_tag("activegird_filter_#{name}", nil, tag_options)
+      when Array
+        view.select_tag("activegrid_filter_#{name}", view.options_for_select(filter), tag_options)
+      end
+    end
+
+    def tag_options
+      tag_options = {}
+
+      if options[:sortable]
+        tag_options["class"] = "activegrid-sort"
+        tag_options["data-activegrid-sort-field"] = name
+        tag_options["data-activegrid-sort"] = options[:sortable]
+      end
+      tag_options
+    end
+
+    def value
+      view.capture(&block)
+    end
+  end
+end

data/app/lib/active_grid/grid.rb

@@ -0,0 +1,90 @@
+module ActiveGrid
+  class Grid
+    attr_reader :columns, :name, :options, :partial, :scope, :view
+    attr_accessor :block
+
+    def initialize(view, name, scope, partial, options = {})
+      @columns = []
+      @view, @name, @scope, @partial, @options = view, name, scope, partial, options
+
+      self.view._activegrid = self
+      self.view.render(partial)
+    end
+
+    def header
+      mode :header do
+        view.content_tag(:tr, view.capture(self, nil, &block))
+      end
+    end
+
+    def filters
+      mode :filter do
+        view.content_tag(:tr, view.capture(self, nil, &block))
+      end
+    end
+
+    def body
+      mode :body do
+        models.map do |model|
+          view.content_tag(:tr, view.capture(self, model, &block))
+        end.reduce(:<<)
+      end
+    end
+
+    def column(name, options = {}, &block)
+      column = Column.new(view, name, options, &block)
+
+      case mode
+      when :header
+        columns << column
+        view.content_tag(:th, column.header, column.tag_options)
+      when :filter
+        view.content_tag(:th, column.filter)
+      when :body
+        view.content_tag(:td, column.value)
+      end
+    end
+
+    def mode(value = nil, &block)
+      if value
+        begin
+          old_mode, @mode = @mode, value
+          yield
+        ensure
+          @mode = old_mode
+        end
+      else
+        @mode
+      end
+    end
+
+    def models
+      if paginate = options[:paginate]
+        scope.limit(paginate)
+      else
+        scope
+      end
+    end
+
+    def tag_options
+      tag_options = {}
+      tag_options["id"] = "#{name}_grid"
+      tag_options["class"] = "activegrid"
+      tag_options["data-activegrid"] = true
+      tag_options["data-activegrid-name"] = name
+
+      if options[:paginate]
+        tag_options["data-activegrid-pages"] = (scope.count / options[:paginate].to_f).ceil
+        tag_options["data-activegrid-paginate"] = options[:paginate]
+      end
+
+      tag_options
+    end
+
+    def to_html
+      view.content_tag(:table, tag_options) do
+        view.content_tag(:thead, header << filters) << view.content_tag(:tbody, body)
+      end
+    end
+  end
+end

data/app/views/active_grid/update.js.erb

@@ -0,0 +1 @@
+activegrid_update("<%= escape_javascript(@element) %>", "<%= escape_javascript @grid.body %>");

data/lib/activegrid/engine.rb

@@ -0,0 +1,10 @@
+require "rails"
+require "jquery/rails"
+
+module ActiveGrid
+  class Engine < Rails::Engine
+    initializer "activegrid.config.assets.precompile", :before => "sprockets.environment" do |app|
+      app.config.assets.precompile.concat %W[activegrid.css activegrid.js]
+    end
+  end
+end

data/lib/activegrid/version.rb

@@ -0,0 +1,3 @@
+module ActiveGrid
+  VERSION = "1.0.0"
+end

data/lib/activegrid.rb

@@ -0,0 +1,4 @@
+module ActiveGrid
+  require "activegrid/version"
+  require "activegrid/engine"
+end

data/test/activegrid_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ActiveGridTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ActiveGrid
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'psych'
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,4 @@
+//= require jquery
+//= require jquery_ujs
+//= require activegrid
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,5 @@
+/*
+ *= require_self
+ *= require activegrid
+ *= require_tree .
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/products_controller.rb

@@ -0,0 +1,81 @@
+class ProductsController < ActiveGrid::Controller
+  # GET /products
+  # GET /products.json
+  def index
+    @products = Product.scoped
+
+
+    activegrid :products, @products
+  end
+
+  # GET /products/1
+  # GET /products/1.json
+  def show
+    @product = Product.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render json: @product }
+    end
+  end
+
+  # GET /products/new
+  # GET /products/new.json
+  def new
+    @product = Product.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render json: @product }
+    end
+  end
+
+  # GET /products/1/edit
+  def edit
+    @product = Product.find(params[:id])
+  end
+
+  # POST /products
+  # POST /products.json
+  def create
+    @product = Product.new(params[:product])
+
+    respond_to do |format|
+      if @product.save
+        format.html { redirect_to @product, notice: 'Product was successfully created.' }
+        format.json { render json: @product, status: :created, location: @product }
+      else
+        format.html { render action: "new" }
+        format.json { render json: @product.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /products/1
+  # PUT /products/1.json
+  def update
+    @product = Product.find(params[:id])
+
+    respond_to do |format|
+      if @product.update_attributes(params[:product])
+        format.html { redirect_to @product, notice: 'Product was successfully updated.' }
+        format.json { head :ok }
+      else
+        format.html { render action: "edit" }
+        format.json { render json: @product.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /products/1
+  # DELETE /products/1.json
+  def destroy
+    @product = Product.find(params[:id])
+    @product.destroy
+
+    respond_to do |format|
+      format.html { redirect_to products_url }
+      format.json { head :ok }
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/products_helper.rb

@@ -0,0 +1,2 @@
+module ProductsHelper
+end

data/test/dummy/app/models/product.rb

@@ -0,0 +1,2 @@
+class Product < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/products/_form.html.erb

@@ -0,0 +1,33 @@
+<%= form_for(@product) do |f| %>
+  <% if @product.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@product.errors.count, "error") %> prohibited this product from being saved:</h2>
+
+      <ul>
+      <% @product.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </div>
+  <div class="field">
+    <%= f.label :description %><br />
+    <%= f.text_area :description %>
+  </div>
+  <div class="field">
+    <%= f.label :price %><br />
+    <%= f.text_field :price %>
+  </div>
+  <div class="field">
+    <%= f.label :quantity %><br />
+    <%= f.number_field :quantity %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/test/dummy/app/views/products/_grid.html.erb

@@ -0,0 +1,9 @@
+<%= activegrid paginate: 10 do |grid, model| %>
+  <%= grid.column :name, filter: %W[blah Gizmo Widget], sortable: true do %>
+    <%= link_to model.name, product_path(model) %>
+  <% end %>
+
+  <%= grid.column :description, filter: "string", sortable: true do %>
+    <%= model.description %>
+  <% end %>
+<% end %>

data/test/dummy/app/views/products/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing product</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @product %> |
+<%= link_to 'Back', products_path %>

data/test/dummy/app/views/products/index.html.erb

@@ -0,0 +1,7 @@
+<h1>Listing products</h1>
+
+<%= activegrid :products %>
+
+<br />
+
+<%= link_to 'New Product', new_product_path %>

data/test/dummy/app/views/products/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New product</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', products_path %>

data/test/dummy/app/views/products/show.html.erb

@@ -0,0 +1,25 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <b>Name:</b>
+  <%= @product.name %>
+</p>
+
+<p>
+  <b>Description:</b>
+  <%= @product.description %>
+</p>
+
+<p>
+  <b>Price:</b>
+  <%= @product.price %>
+</p>
+
+<p>
+  <b>Quantity:</b>
+  <%= @product.quantity %>
+</p>
+
+
+<%= link_to 'Edit', edit_product_path(@product) %> |
+<%= link_to 'Back', products_path %>

data/test/dummy/config/application.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "activegrid"
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+
+    config.filter_parameters += [:password]
+
+    config.assets.enabled = true
+    config.assets.version = '1.0'
+  end
+end
+