ez_datatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0632a6d479ebcbd822f99ad5543927e27096607f
+  data.tar.gz: 6e3cb6d929c0e8eeaf322d55d3292384203b2a32
+SHA512:
+  metadata.gz: 3f809d88e08241094ff2f1c0191bd19dc6215b8d3aeee2664a8e9302556e4da66d535b459fb98a61906353f51e24fdd2f0b35f1e7e740b3a8e46dc4baaf9bf53
+  data.tar.gz: 971f0a187125d0558a6e22e3714a1406a852a4010ced1326926aae68bd31204f5b58918f2a220f08d01e586f70ae556a4493e3deb16bea31863305bc186cf1ae

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Mic
+
+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,109 @@
+# EzDatatable
+
+Easy and Customizable datatable for Ruby on Rails. Usually in admin panel you gonna need to list data from your 
+model and have a search bar to filter the data and buttons for View, Edit, Delete model. 
+So This is just another gem that help you handle those kinds of boring jobs. 
+
+*** Currently support only MySQL.
+
+### Usage
+
+1 - Add to your Gemfile
+
+```
+gem 'ez_datatable'
+```
+
+2 - Install the gem
+
+```
+bundle install
+```
+
+3 - Run the install generator (This will generate view files "views/ez_datatable/_table.html.erb")
+
+```
+rails generate ez_datatable:view
+```
+
+4 - Include EzDatatable module in controller (yo)
+
+```ruby
+include EzDatatable::Controller
+```
+
+Example (You can put it one place at "ApplicationController" if you like): 
+
+```ruby
+class BooksController < ApplicationController
+	include EzDatatable::Controller
+end
+```
+ 
+5 - Include EzDatatable module in model
+
+```ruby
+include EzDatatable::Model
+```
+
+Example (You can put it one place at "ApplicationController" if you like): 
+
+```ruby
+class Book < ApplicationRecord
+	include EzDatatable::Model
+end
+```
+
+6 - **Create class method and instance method in model. see example in the link below (/test/dummy/app/models/book.rb).**
+
+*** Please read the comments in the example model.
+
+[Click Here to See Example](test/dummy/app/models/book.rb)
+
+7 - Setup action in controller (You can use with will_paginate)
+
+7.1 - You must pass params[:filter] and params[:operator] to "search" method
+
+```ruby
+@books = Book.search(params[:filter], params[:operator]).paginate(per_page: 10, page: params[:page])
+```
+
+7.2 - You must pass collections and datatable configuration to "_table" method
+
+```ruby
+@table = _table(@books, Book.datatable_config)
+```
+
+Example:
+
+```ruby
+def index
+	@books = Book.search(params[:filter], params[:operator]).paginate(per_page: 10, page: params[:page])
+	@table = _table(@books, Book.datatable_config)
+end
+```
+
+8. Display Datatable in view (example: in index.html.erb)
+
+```ruby
+<%= @table %>
+```
+
+### Screenshots
+
+##### Table
+
+![Before](screenshots/example_before.png)
+
+##### After Search
+
+![After](screenshots/example_after.png)
+
+### Todos
+
+- support PostgreSQL 
+
+### Notes
+
+I normally use this datatable in every projects but as a services class. So everytime i start a new project have to copy and paste those related files to new projects. 
+Now i decide to build it as a gem so me and my colleagues can use this a lot easier :)

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EzDatatable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/ez_datatable.rb

@@ -0,0 +1,6 @@
+require "ez_datatable/railtie"
+require "ez_datatable/model"
+require "ez_datatable/controller"
+
+module EzDatatable
+end

data/lib/ez_datatable/controller.rb

@@ -0,0 +1,26 @@
+module EzDatatable
+  module Controller
+    def _table(collections, config)
+	    context = Rails.configuration.paths['app/views']
+	    view = ActionView::Base.new(context)
+			view.class.include Rails.application.routes.url_helpers
+			view.render partial: '/ez_datatable/table', locals: { collections: collections, config: config, params: params, request: request }
+    end
+
+    def self.send(collection, attr)
+			val = collection
+			attrs = attr.split('.')
+			if attrs.count > 1
+				attrs.each_with_index do |attr, i|
+					if i == 0
+						attr = attr.singularize
+					end
+					val = val.public_send(attr) if val
+				end
+			else
+				val = val.public_send(attr)
+			end
+			val
+		end
+  end
+end

data/lib/ez_datatable/model.rb

@@ -0,0 +1,47 @@
+module EzDatatable
+  module Model
+    def self.included(klass)
+      klass.include Rails.application.routes.url_helpers
+      klass.scope :search, -> filters, operator = nil do
+        conditions = []
+        if filters
+          config = self.datatable_config
+          filters.each do |key, val|
+            if config[:search]
+              current_config = config[:search].select { |hash| hash[:attr] == key }.first
+
+              # data_type
+              if current_config && current_config[:data_type]
+                if current_config[:data_type] == 'integer'
+                  val = val.to_i
+                else
+                  val = val.to_s
+                end
+              end
+
+              operator = current_config[:operator] ? current_config[:operator] : ''
+
+              unless val.blank? || val == 0
+                if operator == 'equal'
+                  conditions << ["#{key} = '#{val}'"]
+                elsif operator == 'start_between'
+                  conditions << ["#{key} >= '#{val}'"]
+                elsif operator == 'end_between'
+                  conditions << ["#{key} <= '#{val}'"]
+                elsif operator == 'between'
+                  d_start = Date.strptime("#{val.split(' - ')[0]}", '%m/%d/%Y').to_formatted_s(:db)
+                  d_end = Date.strptime("#{val.split(' - ')[1]}", '%m/%d/%Y').to_formatted_s(:db)
+                  conditions << ["#{key} between '#{d_start}' AND '#{d_end}'"]
+                else
+                  conditions << ["#{key} LIKE '%#{val}%'"]
+                end
+              end
+            end
+          end
+        end
+
+        where(conditions.join(" AND "))
+      end
+    end
+  end
+end

data/lib/ez_datatable/railtie.rb

@@ -0,0 +1,4 @@
+module EzDatatable
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/ez_datatable/version.rb

@@ -0,0 +1,3 @@
+module EzDatatable
+  VERSION = '0.1.0'
+end

data/lib/generators/ez_datatable/locales/ez_datatable.en.yml

@@ -0,0 +1,4 @@
+en:
+  ez_datatable:
+    reset: "Reset"
+    search: "Search"

data/lib/generators/ez_datatable/templates/_table.html.erb

@@ -0,0 +1,89 @@
+<div class="datatable">
+	<% if config[:search] %>
+		<div class="search">
+			<form method="get" action="" class="search-form row">
+				<input type="hidden" name="search" value="true" />
+
+				<% config[:search].each_with_index do |col, index| %>
+					<div class="form-group <%= config[:num_cols] ? "col-md-#{12 / config[:num_cols]}" : "col-md-6" %>">
+						<label for="search_<%= col[:attr] %>" class="control-label" style="text-align: left;"><%= col[:label] %></label>
+ 						<% if col[:field] == 'select' %>
+ 							<select 
+ 								col_<%= col[:attr] %>" 
+ 								name="filter[<%= col[:attr] %>]" 
+ 								class="form-control<%= col[:class_name] ? " #{col[:class_name]}" : "" %>"
+ 								<%= col[:data] ? (col[:data] || {}).map { |key, val| "data-#{key}=#{val}" }.join(" ") : "" %>
+ 							>
+ 								<% col[:options].each do |option| %>
+ 									<% if params[:filter] && params[:filter][col[:attr].to_sym].to_s == option.last.to_s %>
+ 										<option value="<%= option.last %>" selected="selected"><%= option.first %></option>
+ 									<% else %>
+ 										<option value="<%= option.last %>"><%= option.first %></option>
+ 									<% end %>
+ 								<% end %>
+ 							</select>
+ 						<% else %>
+ 							<input 
+ 								type="text" 
+ 								id="col_<%= col[:attr] %>" 
+ 								name="filter[<%= col[:attr] %>]" 
+ 								class="form-control<%= col[:class_name] ? " #{col[:class_name]}" : "" %>" 
+ 								<%= col[:data] ? (col[:data] || {}).map { |key, val| "data-#{key}=#{val}" }.join(" ") : "" %>
+ 								value="<%= params[:filter][col[:attr].to_sym] if params[:filter] %>" 
+ 							/>
+ 						<% end %>
+					</div>
+				<% end %>
+
+				<% if !config[:search].empty? %>
+					<div class="col-md-12">
+						<input type="submit" value="<%= config[:search_btn] && config[:search_btn][:label] ? config[:search_btn][:label] : t('ez_datatable.search') %>" class="btn btn-sm <%= config[:search_btn] && config[:search_btn][:class_name] ? config[:search_btn][:class_name] : 'btn-sm btn-primary' %>" />
+						<% if !config.key?(:hide_reset) || config.key?(:hide_reset) && config[:hide_reset] != true %>
+							<a href="<%= request.path %>" class="btn btn-sm btn-primary reset"><%= t('ez_datatable.reset') %></a>
+						<% end %>
+					</div>
+				<% end %>
+			</form>
+		</div>
+	<% end %>
+
+	<div class="table-responsive m-t-20">
+		<table class="table table-hover">
+			<thead>
+				<tr>
+					<% config[:cols].each do |col| %>
+					  <th><%= col[:label] ? col[:label] : '' %></th>
+					<% end %>
+				</tr>
+			</thead>
+
+			<tbody>
+				<% collections.each do |collection| %>
+					<tr>
+						<% config[:cols].each do |col| %>
+							<% if col[:attr] %>
+								<% if col[:link] %>
+									<td>
+										<a href="<%= collection.send("datatable_link")[col[:link].to_sym] %>" <%= col[:target] ? "target=_blank" : nil %>><%= collection[col[:attr].to_sym] %></a>
+									</td>
+								<% else %>
+									<td><%= EzDatatable::Controller.send(collection, col[:attr]) %></td>
+								<% end %>
+							<% elsif col[:actions] %>
+								<td class="actions">
+									<% col[:actions].each do |action| %>
+										<% if collection.send("datatable_link")[action[:link].to_sym] %>
+											<a href="<%= collection.send("datatable_link")[action[:link].to_sym] %>" <%= action[:target] ? "target=_blank" : nil %> class="<%= action[:class] %> btn-sm"><%= action[:label] %></a>
+										<% end %>
+									<% end %>
+								</td>
+							<% else %>
+								<td>-</td>
+							<% end %>
+						<% end %>
+					</tr>
+				<% end %>
+			</tbody>
+		</table>
+	</div>
+</div>

data/lib/generators/ez_datatable/view_generator.rb

@@ -0,0 +1,10 @@
+module EzDatatable
+	class ViewGenerator < Rails::Generators::Base
+  	source_root File.expand_path('templates', __dir__)
+
+	  def create_initializer_file
+	    copy_file "_table.html.erb", "app/views/ez_datatable/_table.html.erb"
+	    copy_file "../locales/ez_datatable.en.yml", "config/locales/ez_datatable.en.yml"
+	  end
+	end
+end

data/lib/tasks/ez_datatable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ez_datatable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ez_datatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy and Customizable datatable for Ruby on Rails (Currently support
+  only MySQL).
+email:
+- kittiphong.mic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ez_datatable.rb
+- lib/ez_datatable/controller.rb
+- lib/ez_datatable/model.rb
+- lib/ez_datatable/railtie.rb
+- lib/ez_datatable/version.rb
+- lib/generators/ez_datatable/locales/ez_datatable.en.yml
+- lib/generators/ez_datatable/templates/_table.html.erb
+- lib/generators/ez_datatable/view_generator.rb
+- lib/tasks/ez_datatable_tasks.rake
+homepage: https://github.com/michelloworld
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easy and Customizable datatable for Ruby on Rails (Currently support only
+  MySQL).
+test_files: []