datatables_records_mapper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36786fef7544a37d18a5cced22bfbbcfafac284d
+  data.tar.gz: bfbf32616e9a58c0a011905d12383538d3916164
+SHA512:
+  metadata.gz: f48f14a597d99120a0051bd4ed8b7d9769c77669fe70626a48f29e03680b4b0ee07ff6a46fabd45ce1ab5bc99db40a8c5a93271f3693bb19177402a25d655688
+  data.tar.gz: 0f73c8b57ff1f04abe6ac266b623d6d635fca6053462b4e45974fceda2c97406f3021e9a33b1b6d0acae2516d5b10beabbdc1c35ef36fba143d789d13b65747f

data/.gitignore

@@ -0,0 +1,44 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in datatables_records_mapper.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    datatables_records_mapper (1.0.0)
+      activemodel (~> 4.2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.9)
+      activesupport (= 4.2.9)
+      builder (~> 3.1)
+    activesupport (4.2.9)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    byebug (9.1.0)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    i18n (0.8.6)
+    method_source (0.8.2)
+    minitest (5.10.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    shoulda-matchers (3.1.1)
+      activesupport (>= 4.0.0)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  byebug
+  datatables_records_mapper!
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shoulda-matchers
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Klismann
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Klismann
+
+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,88 @@
+The purpose of this gem is to handle the ajax calls made by the [datatables plugin](https://datatables.net).
+
+It parses some of the parameters (not all are yet supported) and returns the required data.
+
+USAGE:
+To use this gem you will need to call the mapper class passing as arguments the model, parameters and a mapper. In this
+example, it is used a mapper which uses a partial view to render the actions column.
+
+First, let's take a look at a piece of controller code:
+```erb
+def services_list
+  respond_to do |format|
+    format.json { render json: services_list_data }
+  end
+end
+
+private
+
+def services_list_data
+  mapper = ModelMappers::ServiceMapper.new(service_actions)
+  DatatablesRecordsMapper::Mapper
+    .new(Service, params, mapper)
+    .mapped_records
+end
+
+def service_actions
+  @service_actions ||= Proc.new do |service|
+    render_to_string(
+      'actions',
+      locals: { service_id: service.id },
+      formats: :html,
+      layout: false
+    )
+  end
+end
+```
+
+This code is responsible for the endpoint 'GET services/services_list'. It instanciates a mapper for the model Service,
+which uses the service_acitons proc to render the actions column.
+
+The mapper code:
+```erb
+module ModelMappers
+  class ServiceMapper
+    def initialize(actions_renderer)
+      @actions_renderer = actions_renderer
+    end
+
+    def map(service)
+      {
+        id: service.id,
+        title: service.title,
+        description: service.description,
+        actions: @actions_renderer.call(service)
+      }
+    end
+  end
+end
+```
+
+The only restriction in this class is the method 'map', which is used by the gem to return the data.
+
+The actions partial view:
+```erb
+a.btn.btn-success.btn-margin-right title=(I18n.t 'links.default.actions.show') href=(service_path(service_id))
+  span.fa.fa-search
+```
+
+The model code:
+```erb
+class Service < ActiveRecord::Base
+  class << self
+    def search(search_parameter, options)
+      services = Service.all
+      return services unless search_parameter.present?
+      search_parameter = "%#{search_parameter.downcase}%"
+      services.where('LOWER(title) like ? OR LOWER(description) like ?', search_parameter, search_parameter)
+    end
+
+    def paginate(services, limit, offset)
+      services.
+        order('id desc').
+        limit(limit).
+        offset(offset)
+    end
+  end
+end
+```

data/README.rdoc

@@ -0,0 +1,3 @@
+= DatatablesRecordsMapper
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'DatatablesRecordsMapper'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "datatables_records_mapper"
+
+# 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/datatables_records_mapper.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "datatables_records_mapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "datatables_records_mapper"
+  spec.version       = DatatablesRecordsMapper::VERSION
+  spec.authors       = ["klismannsm"]
+  spec.email         = ["klismannsm@gmail.com"]
+
+  spec.summary       = 'Map records to a format used by jquery datatables plugin'
+  spec.description   = 'This gem interprets the parameters passed by the ajax call made by the datatables plugin and returns the requested records'
+  spec.homepage      = 'https://github.com/klismannsm/datatables_records_mapper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'byebug'
+  spec.add_dependency "activemodel", "~> 4.2.6"
+end

data/lib/datatables_records_mapper.rb

@@ -0,0 +1,6 @@
+require 'datatables_records_mapper/version'
+require 'datatables_records_mapper/mapper'
+require 'datatables_records_mapper/filter'
+
+module DatatablesRecordsMapper
+end

data/lib/datatables_records_mapper/filter.rb

@@ -0,0 +1,44 @@
+module DatatablesRecordsMapper
+  class Filter
+    def initialize(model, params, options = {})
+      @model = model
+      @params = params
+      @options = options
+    end
+
+    def record_list
+      number_of_filtered_records = records.length
+      paginated_records = @model.paginate(records, limit, offset)
+      {
+        'recordsTotal' => @model.count,
+        'recordsFiltered' => number_of_filtered_records,
+        'data' => paginated_records
+      }
+    end
+
+    private
+
+    def records
+      @records ||= begin
+      return @model.search(search_parameter, param_options) unless @options.has_key? :records
+      @model.search(@options[:records], search_parameter, param_options)
+      end
+    end
+
+    def search_parameter
+      @params[:search][:value]
+    end
+
+    def param_options
+      @param_options ||= @params[:options] || {}
+    end
+
+    def limit
+      @params[:length]
+    end
+
+    def offset
+      @params[:start]
+    end
+  end
+end

data/lib/datatables_records_mapper/mapper.rb

@@ -0,0 +1,21 @@
+module DatatablesRecordsMapper
+  class Mapper
+    def initialize(model, params, mapper, options = {})
+      @model = model
+      @params = params
+      @mapper = mapper
+      @options = options
+    end
+
+    def mapped_records
+      records['data'] = records['data'].map { |r| @mapper.map(r) }
+      records
+    end
+
+    private
+
+    def records
+      @records ||= DatatablesRecordsMapper::Filter.new(@model, @params, @options).record_list
+    end
+  end
+end

data/lib/datatables_records_mapper/version.rb

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

data/lib/tasks/datatables_records_mapper_tasks.rake

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

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: datatables_records_mapper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- klismannsm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+description: This gem interprets the parameters passed by the ajax call made by the
+  datatables plugin and returns the requested records
+email:
+- klismannsm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- MIT-LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- bin/console
+- datatables_records_mapper.gemspec
+- lib/datatables_records_mapper.rb
+- lib/datatables_records_mapper/filter.rb
+- lib/datatables_records_mapper/mapper.rb
+- lib/datatables_records_mapper/version.rb
+- lib/tasks/datatables_records_mapper_tasks.rake
+homepage: https://github.com/klismannsm/datatables_records_mapper
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Map records to a format used by jquery datatables plugin
+test_files: []