snaptable 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41a46aa96e307baf3ccdf299cdf0775f37d558e1
+  data.tar.gz: bac55a7791146152abeb42727d92c0287434f8e7
+SHA512:
+  metadata.gz: dcca510c040d61d7dd672c93951ad9cc3198fb208d03c4d705d732ad50758615c87f3dd3dd01180be747851ad0fc227a918052bcfd89a58645af50aa6a7dff7b
+  data.tar.gz: 8456f737cdf4b70d0e7ae6b2f7adb7c7ab5bb7af6a87a309df92ca219b26ac4ac30e973e121f38a049d14b6de3fafcaea4d10c30d1c54f12be961bd948ad05e0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autotable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 khcr
+
+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,31 @@
+# Snaptable
+
+A gem that generate HTML tables from your models to display in your admin views. It supports pagination (carrierwave), 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
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/assets/javascripts/autotable.js

@@ -0,0 +1,37 @@
+/* Admin table */
+
+$(document).on("ready page:load", function() {
+  
+  var tableButtons = $('.table_buttons'),
+      editButton = tableButtons.find('a[class="edit"]'),
+      deleteButton = tableButtons.find('a[class="delete"]'),
+      path = window.location.pathname + '/';
+      table = $("#admin_table");
+
+  // add ajax to the pagination
+  table.on("click", ".pagination a", function() {
+    $.getScript(this.href);
+    return false;
+  });
+
+  // line clickable
+  table.on("click", "tbody tr", function(e) {
+    var id = $(this).data('url') ;
+    if ( typeof id !== 'undefined' && !$(this).hasClass('selected') ) {
+      $('tr.selected').removeClass('selected');
+      $(this).addClass('selected');
+      deleteButton.add(editButton).addClass("on");
+      editButton.attr('href', path + id + '/edit');
+      deleteButton.attr('href', path + id);
+    }
+  });
+
+  // Double click
+  table.on("dblclick", "tbody tr", function() {
+    var id = $(this).data('url');
+    if ( typeof id !== 'undefined' ) {
+      window.location = path + id + '/edit';
+    }
+  });
+
+});

data/app/assets/stylesheets/autotable.css.scss

@@ -0,0 +1,88 @@
+/* Table */
+
+#admin_table {
+  width: 100%;
+  overflow: auto;
+
+  table {
+    border-collapse: collapse;
+    width: 100%;
+    max-width: 100%;
+    line-height: 21px;
+    margin: 57px 0 0 0;
+    thead {
+      tr {
+        th {
+          vertical-align: bottom;
+          border-bottom: 1px solid #DADADA;
+          padding: 10px 8px 5px 8px;
+          font-size: 13px;
+          text-align: left;
+          background: #3d3d3e;
+          color: #c0c0c0;
+          font-weight: 400;
+          &:not(:first-child) {
+          }
+          &:not(:last-child) {
+          }
+          a {
+            color:#c0c0c0;
+            font-weight: bold;
+          }
+        }
+      }
+    }
+    tbody {
+      td {
+        font-size: 12px;
+        padding: 7px 8px;
+        &:not(:first-child) {
+          border-left: 1px solid #DADADA;
+        }
+      }
+    }
+    tr.even {
+      background: #f8f8f8;
+    }
+    tr.selected {
+      background: #F0BEBE;
+    }
+  }
+
+  .none {
+    text-align: center;
+  }
+
+  .table_buttons {
+    text-align: right;
+    padding: 20px;
+    position: absolute;
+  }
+
+  .table_buttons a {
+    padding: 7px 10px;
+    border-radius: 3px;
+    color: #fff;
+    font-weight: lighter;
+    font-size: 14px;
+  }
+
+  .table_buttons a {
+    background: #aaa;
+    pointer-events: none;
+    cursor: default;
+  }
+
+  .table_buttons a.on {
+    background: #7f72f5;
+    pointer-events: auto;
+    cursor: auto;
+  }
+
+  .table_buttons a.add {
+    background: #7f72f5;
+    pointer-events: auto;
+    cursor: auto;
+  }
+
+}

data/app/views/application/_buttons.html.erb

@@ -0,0 +1,5 @@
+<div class="table_buttons">
+	<%= link_to "Ajouter", request.path + "/new", class: "add" %>
+	<a class="edit" href="#">Editer</a>
+	<a class="delete" href="#" data-method="delete" rel="nofollow" data-confirm="Etes-vous sûr de vouloir supprimer cette entrée ?">Supprimer</a>
+</div>

data/app/views/application/_search_field.html.erb

@@ -0,0 +1,9 @@
+<p>Rechercher</p>
+
+<%= form_tag nil, method: :get, remote: true do %>
+
+	<%= search_field_tag :query, params[:query] %>
+
+	<%= submit_tag "Chercher" %>
+
+<% end %>

data/app/views/base.html.erb

@@ -0,0 +1,25 @@
+<%= render 'search_field' if presenter.options[:search] == true %>
+<%= render 'buttons' unless presenter.options[:buttons] == false %>
+<table>
+	<thead>
+		<tr>
+			<% presenter.column_names.each do |column| %>
+			<th><%= presenter.sortable(column) %></th>
+			<% end %>
+		</tr>
+	</thead>
+	<tbody>
+		<% if presenter.records.any? %>
+			<% presenter.records.each do |record| %>
+				<tr class="<%= cycle('odd', 'even') %>" data-url="<%= presenter.url(record) %>">
+					<% presenter.values(record).each do |value| %>
+						<td><%= truncate((strip_tags value), length: 40) %></td>
+					<% end %>
+				</tr>
+			<% end %>
+		<% else %>
+			<tr><td class="none" colspan="<%= presenter.column_names.count %>">Il n'y a aucun élément à afficher.</td></tr>
+		<% end %>
+	</tbody>
+</table>
+<%= will_paginate presenter.records %>

data/app/views/sort.js.erb

@@ -0,0 +1 @@
+$('#admin_table').html('<%= j @table.present %>') ;

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

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

data/lib/snaptable/constructor/base_table.rb

@@ -0,0 +1,51 @@
+require 'snaptable/constructor/sortable'
+require 'snaptable/constructor/collection'
+require 'snaptable/constructor/renderer'
+
+module Snaptable
+  module Constructor 
+
+      class BaseTable < SimpleDelegator
+        include Sortable
+        include Collection
+        include Renderer
+
+        def initialize(parent, collection = nil, options = {})
+          super(parent)
+          @collection = collection
+          @options = options
+          @token = stored_token
+        end
+
+        def options
+          @options
+        end
+
+        def column_names
+          model.column_names
+        end
+
+        def url(e)
+          e.id
+        end
+
+        def values(element)
+          attributes.map do |attribute|
+            if attribute.is_a? Symbol 
+              element.send(attribute)
+            else
+              element.send(*attribute.keys).send(*attribute.values)
+            end.to_s
+          end
+        end
+
+        private
+
+        def stored_token
+          session[:token] = params[:token] if params[:token]
+          return session[:token]
+        end
+      end
+
+  end
+end

data/lib/snaptable/constructor/collection.rb

@@ -0,0 +1,41 @@
+module Snaptable
+  module Constructor
+    module Collection
+
+      def collection
+        @collection ||= model.includes(belongs_to_associations)
+      end
+
+      def records
+        @records ||= filter(collection).paginate(page: params[:page], per_page: 30).order(sort_column + " " + sort_direction)
+      end
+
+      def filter(collection)
+        if options[:search] == true
+          collection.joins(search_associations).where(query_fields, query: "%#{params[:query]}%", id: params[:query].to_i)
+        else
+          collection
+        end
+      end
+
+      private
+
+      def query_fields
+        self.class::Search.fields.map do |key, values|
+          values.map do |value|
+            values.map{ |v| "#{key}.#{v} LIKE :query OR"}.join(" ")
+          end
+        end.join(" ") + " #{column_name('id')} = :id"
+      end
+
+      def search_associations
+        self.class::Search.associations
+      end
+
+      def belongs_to_associations
+        model.reflect_on_all_associations(:belongs_to).map{ |a| a.name }
+      end
+
+    end
+  end
+end

data/lib/snaptable/constructor/renderer.rb

@@ -0,0 +1,18 @@
+module Snaptable
+  module Constructor    
+    module Renderer
+
+      def present
+        render_to_string('/base', layout: false, locals: { presenter: self }).html_safe
+      end
+
+      def respond
+        respond_to do |format|
+          format.html
+          format.js { render '/sort' }
+        end
+      end
+
+    end
+  end
+end

data/lib/snaptable/constructor/sortable.rb

@@ -0,0 +1,43 @@
+module Snaptable
+  module Constructor
+    module Sortable
+
+      def sortable(column)
+        if model.reflect_on_association(column.gsub /_id/, '').nil?
+          view_context.link_to({sort: column, direction: direction(column), query: params[:query], page: page}, {remote: true, class: css_class(column)}) do
+            model.human_attribute_name(column)
+          end
+        else
+          model.human_attribute_name(column)
+        end
+      end
+
+      def sort_column
+        column_names.include?(params[:sort]) ? column_name(params[:sort]) : column_name("id")
+      end
+      
+      def sort_direction
+        %w[asc desc].include?(params[:direction]) ? params[:direction] : "desc"
+      end
+
+      def page
+        params[:page] || 1
+      end
+
+      def css_class(column)
+        column_name(column) == sort_column ? "current #{sort_direction}" : nil
+      end
+
+      def direction(column)
+        column_name(column) == sort_column && sort_direction == "asc" ? "desc" : "asc"
+      end
+
+      private
+
+      def column_name(column)
+        "#{model.table_name}.#{column}"
+      end
+
+    end
+  end
+end

data/lib/snaptable/helpers/table.rb

@@ -0,0 +1,29 @@
+require 'snaptable/constructor/base_table'
+
+module Snaptable
+	module Helpers
+
+		class Table < Snaptable::Constructor::BaseTable
+
+			def initialize(parent, model, collection = nil, options = {})
+				super(parent, collection, options)
+				@model = model
+			end
+
+			def values(element)
+				element.attributes.map do |attr_name, attr_value|
+					if attr_value.is_a?(Date) || attr_value.is_a?(Time) || attr_value.is_a?(DateTime)
+						l(attr_value, format: :short)
+					else
+						attr_value
+					end.to_s
+				end
+			end
+
+			def model
+				@model
+			end
+
+		end
+	end
+end

data/lib/snaptable/rails/engine.rb

@@ -0,0 +1,9 @@
+module Snaptable
+  module Rails
+    class Engine < ::Rails::Engine
+      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

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

data/lib/snaptable/rails.rb

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

data/lib/snaptable/railtie.rb

@@ -0,0 +1,9 @@
+require 'snaptable/helpers/table'
+
+module Snaptable
+  class Railtie < Rails::Railtie
+    initializer 'Snaptable.tables' do
+      ActionController::Base.send :include, Helpers
+    end
+  end
+end

data/lib/snaptable/version.rb

@@ -0,0 +1,3 @@
+module Snaptable
+  VERSION = "0.2.0"
+end

data/lib/snaptable.rb

@@ -0,0 +1,3 @@
+require 'snaptable/version'
+require 'snaptable/railtie' if defined?(Rails)
+require 'snaptable/rails'

data/snaptable.gemspec

@@ -0,0 +1,26 @@
+# 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 to display 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 "railties", ">= 4.2.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: snaptable
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- khcr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: A gem that generate HTML tables from your models to display in your admin
+  views.
+email:
+- kocher.ke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/autotable.js
+- app/assets/stylesheets/autotable.css.scss
+- app/views/application/_buttons.html.erb
+- app/views/application/_search_field.html.erb
+- app/views/base.html.erb
+- app/views/sort.js.erb
+- bin/console
+- bin/setup
+- lib/snaptable.rb
+- lib/snaptable/constructor/base_table.rb
+- lib/snaptable/constructor/collection.rb
+- lib/snaptable/constructor/renderer.rb
+- lib/snaptable/constructor/sortable.rb
+- lib/snaptable/helpers/table.rb
+- lib/snaptable/rails.rb
+- lib/snaptable/rails/engine.rb
+- lib/snaptable/rails/version.rb
+- lib/snaptable/railtie.rb
+- lib/snaptable/version.rb
+- snaptable.gemspec
+homepage: http://github.com/khcr/snaptable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A gem that generate HTML tables from your models to display in your admin
+  views.
+test_files: []