datatables_server_side 0.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Layon Ferreira
+
+MIT License
+
+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,78 @@
+# DatatablesServerSide
+
+Simple rails gem to simplify the creation of datatables json response.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'datatables_server_side'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install datatables_server_side
+
+## Usage
+
+This gem is inspired on Rails Casts  [#340 DataTables](http://railscasts.com/episodes/340-datatables). Its recommended to watch.
+
+**Installation**: run the *installer* generator
+    
+    rails g datatables_server_side:installer
+It will create a datatables folder inside the *app* folder
+
+After that you will have to create a datatable.
+
+To **Generate** a datatable run:
+
+    rails g dadatatables_server_side:datatable Example
+
+this will create a ruby file */app/datatables/example_datatable.rb*
+
+You will have to define two methods:
+
+A **data** method with the object that will be returned.
+example:
+
+    def data
+        records.map do |example|
+         [
+            example.id,
+            example.name,
+            example.description,
+         ]
+    end
+and a **fetch_records** method, that will be responsible for retrieve the query results from the model example:
+
+    def fetch_records
+        filter_params={}
+        filter_params[:offset]= params['iDisplayStart'] if params['iDisplayStart'].present?
+        filter_params[:limit]= params['iDisplayLength'].to_i if params['iDisplayLength'].present?
+        filter_params[:sort]= params['sSortDir_0'] if params['sSortDir_0'].present?
+        Example.find(:all,:params => filter_params)
+    end
+finally you should add the the **datatables object** to the json response on your controller. example:
+    
+    def index
+        respond_to do |format|
+            format.html
+            format.json{ render json: RodaDatatable.new(view_context)}
+        end
+    end
+#Contacts
+Any questions contact me:
+
+**Website**:<http://layonferreira.com/>
+
+**Email**: <me@layonferreira.com>
+
+#License
+MIT License
+
+Copyright (c) 2015 [Layon Ferreira](http://layonferreira.com/)

data/Rakefile

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

data/datatables_server_side.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'datatables_server_side/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'datatables_server_side'
+  spec.version       = DatatablesServerSide::VERSION
+  spec.authors       = ['Layon Ferreira']
+  spec.email         = ['layon@live.com.pt']
+  spec.summary       = %q{Simple gem that helps the creation of json datatables json responses.}
+  spec.description   = %q{Simple gem that helps the creation of json datatables json responses.}
+  spec.homepage      = 'https://github.com/layonferreira/datatables_server_side'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '~> 2.6'
+  spec.add_development_dependency 'generator_spec' , '~> 0.9'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+# DEPENDENCIES
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'actionview'
+  spec.add_dependency('railties', '>= 3.2.6', '< 5')
+end
+
+

data/lib/datatables_server_side.rb

@@ -0,0 +1,61 @@
+require 'datatables_server_side/version'
+require 'active_support'
+require 'active_support/core_ext/string/output_safety.rb' #raw() and h() methods
+require 'active_support/core_ext/module/delegation.rb'# delegate method
+require 'action_view'
+module DatatablesServerSide
+  class Datatables
+    delegate :params, :link_to, :content_tag, :can?, :current_user, :t, to: :@view
+    # delegate :h, to: ERB::Util
+    include ActionView::Helpers::OutputSafetyHelper # this is to use raw()
+    # include ApplicationHelper
+
+    def initialize(view)
+      @view = view
+    end
+
+    def as_json(options = {})
+      raise NotImplementedError
+    end
+
+    protected
+
+    def data
+      raise NotImplementedError
+    end
+
+    def safe_attributes(data)
+      data.map! do |array_value|
+        if array_value.class==Array
+          safe_attributes(array_value)
+        elsif array_value.class!=NilClass
+          array_value.to_s.html_safe
+        end
+      end
+    end
+
+    def records
+      @records ||= fetch_records
+    end
+
+    def fetch_records
+      raise NotImplementedError
+    end
+
+    def page
+      params[:iDisplayStart].present? ? params[:iDisplayStart].to_i/per_page + 1 : 1
+    end
+
+    def per_page
+      (params[:sSortDir_0].present? && params[:iDisplayLength].to_i > 0) ? params[:iDisplayLength].to_i : 10
+    end
+
+    def sort_column
+      raise NotImplementedError
+    end
+
+    def sort_direction
+      (params[:sSortDir_0].present? && params[:sSortDir_0] == 'desc') ? 'desc' : 'asc'
+    end
+  end
+end

data/lib/datatables_server_side/version.rb

@@ -0,0 +1,3 @@
+module DatatablesServerSide
+  VERSION = "0.1.0"
+end

data/lib/generators/datatables_server_side/datatable_generator.rb

@@ -0,0 +1,12 @@
+require 'thor/group'
+module DatatablesServerSide
+  module Generators
+    class DatatableGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      argument :table_name, :type => :string
+      def generate_datatable
+        template "generic_datatable.rb","app/datatables/#{table_name.underscore}_datatable.rb"
+      end
+    end
+  end
+end

data/lib/generators/datatables_server_side/installer_generator.rb

@@ -0,0 +1,11 @@
+require 'thor/group'
+module DatatablesServerSide
+  module Generators
+    class InstallerGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      def generate_installer
+        empty_directory 'app/datatables'
+      end
+    end
+  end
+end

data/lib/generators/templates/generic_datatable.rb

@@ -0,0 +1,37 @@
+class <%= table_name.camelize %>Datatable < DatatablesServerSide::Datatables
+ #You can delegate paths to the @view context, example
+ #delegate :model_path, :delete_model_path, :edit_model_path, to: :@view
+
+# the json response that will be returned
+  def as_json(options = {})
+  {
+      sEcho: params[:sEcho].to_i,
+      iTotalRecords: <%= table_name.camelize.singularize %>.count,
+      iTotalDisplayRecords: records.length,
+      aaData: safe_attributes(data)
+    }
+  end
+
+  private
+
+# returns the data object, it should contain the object that datatable will parse, example
+# def data
+#   records.map do |example|
+#     [
+#        example.id,
+#        example.name,
+#        example.description,
+#     ]
+# end
+
+  def data
+# TODO ADD your code here
+  end
+
+#this method is responsible for connect with model, here you should add your filters.
+  def fetch_records
+     <%= table_name.underscore  %> = <%= table_name.camelize.singularize %>.all
+     <%= table_name.underscore %>
+  end
+
+end

data/spec/datatable_generator_spec.rb

@@ -0,0 +1,20 @@
+require 'generator_spec'
+require 'generators/datatables_server_side/datatable_generator'
+describe DatatablesServerSide::Generators::DatatableGenerator, type: :generator do
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  arguments %w(TestOfGenerator)
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+  it 'creates a file with the correct name' do
+    run_generator
+    assert_file 'app/datatables/test_of_generator_datatable.rb'
+  end
+
+  it 'creates a file with correct class' do
+    run_generator
+    assert_file 'app/datatables/test_of_generator_datatable.rb',/class TestOfGeneratorDatatable < DatatablesServerSide::Datatables/
+  end
+
+end

data/spec/datatables_spec.rb

@@ -0,0 +1,70 @@
+require 'datatables_server_side'
+describe DatatablesServerSide::Datatables do
+  def getTable
+    context = double(:render => "some content...", :link_to => "<a href='www.somewhere.com'>somewhere</a>") #TODO improve this stub
+    DatatablesServerSide::Datatables.new(context)
+  end
+
+# checks each element inside array to be html_safe
+  def is_all_values_safe?(data)
+    is_valid=true
+    data.each do |array_value|
+      if array_value.class==Array
+        is_valid= is_valid && is_all_values_safe?(array_value)
+      elsif array_value.class!=NilClass
+        is_valid= is_valid && array_value.html_safe?
+      end
+    end
+    return is_valid
+  end
+
+  def get_dummy_data
+    array_of_text = Array.new
+    data=Array.new
+    array_of_text[0]="teste"
+    array_of_text[1]="teste"
+    array_of_text[2]="<a>teste</a>"
+    data[0]="teste"
+    data[1]=array_of_text
+    data
+  end
+
+  it 'initializes' do
+    my_table=getTable
+    my_table.class.should eq(DatatablesServerSide::Datatables)
+  end
+
+
+  it 'protects records with html safe' do
+    my_table=getTable
+    safe_records=my_table.send(:safe_attributes, get_dummy_data)
+    is_all_values_safe?(safe_records).should eq true
+  end
+
+
+  it 'gets the correct page' do
+    my_table=getTable
+    my_table.stub(:per_page){10}
+    my_table.stub(:params){{iDisplayStart: nil}}
+    my_table.send(:page).should eq 1
+    my_table.stub(:params){{iDisplayStart: 2}}
+    my_table.send(:page).should eq 1
+    my_table.stub(:params){{iDisplayStart: 10}}
+    my_table.send(:page).should eq 2
+  end
+
+
+  it 'have default per page of 10' do
+    my_table=getTable
+    my_table.stub(:params){{iDisplayLength: nil}}
+    my_table.send(:per_page).should eq 10
+  end
+
+
+  it 'have default sor direction of asc' do
+    my_table=getTable
+    my_table.stub(:params){{sSortDir_0: nil}}
+    my_table.send(:sort_direction).should eq 'asc'
+  end
+
+end

data/spec/installer_generator_spec.rb

@@ -0,0 +1,15 @@
+require 'generator_spec'
+require 'generators/datatables_server_side/installer_generator'
+describe DatatablesServerSide::Generators::InstallerGenerator, type: :generator do
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+  it 'creates the empty directory' do
+    run_generator
+    assert_directory 'app/datatables'
+  end
+
+end
+

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: datatables_server_side
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Layon Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Simple gem that helps the creation of json datatables json responses.
+email:
+- layon@live.com.pt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/datatable_server_side.iml"
+- ".idea/dictionaries/Layon.xml"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/scopes/scope_settings.xml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- datatables_server_side.gemspec
+- lib/datatables_server_side.rb
+- lib/datatables_server_side/version.rb
+- lib/generators/datatables_server_side/datatable_generator.rb
+- lib/generators/datatables_server_side/installer_generator.rb
+- lib/generators/templates/generic_datatable.rb
+- spec/datatable_generator_spec.rb
+- spec/datatables_spec.rb
+- spec/installer_generator_spec.rb
+homepage: https://github.com/layonferreira/datatables_server_side
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple gem that helps the creation of json datatables json responses.
+test_files:
+- spec/datatable_generator_spec.rb
+- spec/datatables_spec.rb
+- spec/installer_generator_spec.rb