activeadmin-ajax_filter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 623bc73b23aeeffb17a649881dd93aac161501e7
+  data.tar.gz: 20c10cfbdf0e62cf2c4a9398e1b347c4607bf86f
+SHA512:
+  metadata.gz: 332257481022b85e17431c08bd7dd30535c56ae3fec0bdbe4161583089bbe44643515e4bebe18741b59ae88c666c815af15219bb3e224abb375f817fbfff7468
+  data.tar.gz: 3d2a382207e390bdba1ecbf104e48751d4511414c254ce706bb3309ebf4553ca80fbee3f6ad580c4e05501691eb4ec72cb3fc4c9f632c03843449b85862a9117

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+before_install: gem install bundler -v 1.10.6

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, ethnicity, 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 activeadmin-ajax_filter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Emelyanov
+
+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,73 @@
+# Activeadmin::AjaxFilter
+
+This gem extends ActiveAdmin so that your can use filters with AJAX-powered input.
+
+## Prerequisites
+
+This extension assumes that you're using [Active Admin](https://github.com/activeadmin/activeadmin) with [Ransack](https://github.com/activerecord-hackery/ransack)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activeadmin-ajax_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeadmin-ajax_filter
+
+## Usage
+
+Include this line in your JavaScript code (active_admin.js.coffee)
+
+```coffeescript
+    #= require activeadmin-ajax_filter
+```
+
+Include this line in your CSS code (active_admin.scss)
+
+```scss
+    @import "activeadmin-ajax_filter";
+```
+
+Include `ActiveAdmin::AjaxFilter` module to the ActiveAdmin relation resource for which you want to support filtering and add `ajax_select` filter to main resource. For example:
+
+```ruby
+    # Relation-resource
+    ActiveAdmin.register User do
+        include ActiveAdmin::AjaxFilter
+    ...
+
+    # Main resource
+    ActiveAdmin.register Invoice do
+        filter :user, as: :ajax_select, data: { search_fields: [:email, :customer_uid], limit: 7 }
+```
+
+You can use next parameters in `data` hash:
+
+* limit - count of the items which will be requested by AJAX, by default `5`
+* value_field - value field for html select element, by default `id`
+* search_fields - fields by which AJAX search will be performed, required parameter 
+* ransack - ransack query which will be applied, by default it's builded from `search_fields` with `or` and `contains` clauses, e.g.: `email_or_customer_uid_cont`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/holyketzer/activeadmin-ajax_filter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/activeadmin-ajax_filter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_admin/ajax_filter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'activeadmin-ajax_filter'
+  gem.version       = ActiveAdmin::AjaxFilter::VERSION
+  gem.authors       = ['Alex Emelyanov']
+  gem.email         = ['aemelyanov@spbtv.com']
+
+  gem.summary       = 'AJAX filters for ActiveAdmin'
+  gem.description   = 'Allows to define filter by relation for ActiveAdmin resource pages using Ransacker to dynamicaly load items while user is typing symbols in filter'
+  gem.homepage      = 'https://github.com/holyketzer/activeadmin-ajax_filter'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.bindir        = 'exe'
+  gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activeadmin', '>= 1.0.0.pre1'
+  gem.add_dependency 'coffee-rails', '~> 4.1', '>= 4.1.0'
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.3', '>= 3.3.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.11'
+  gem.add_development_dependency 'temping', '~> 3.3', '>= 3.3.0'
+end

data/app/assets/javascripts/activeadmin-ajax_filter.js.coffee

@@ -0,0 +1,61 @@
+$ ->
+  $('.filter_ajax_select select').each (_, select) ->
+    select = $(select)
+    valueField = select.data('value-field')
+    searchFields = select.data('search-fields').split(' ')
+
+    loadOptions = (q, callback) ->
+      $.ajax
+        url: 'users/filter'
+        type: 'GET'
+        dataType: 'json'
+        data:
+          q: q
+          limit: select.data('limit')
+        error: ->
+          callback()
+        success: (res) ->
+          callback(res)
+
+    select.selectize
+      valueField: valueField
+      labelField: searchFields[0]
+      searchField: searchFields
+      options: []
+      create: false
+      render:
+        option: (item, escape) ->
+          html = searchFields.map (field, index)->
+            value = escape(item[field])
+
+            if index == 0
+              klass = 'primary'
+            else
+              klass = 'secondary'
+
+            "<span class='#{klass}'>#{value}</span>"
+
+          "<div class='item'>#{html.join('')}</div>"
+
+      load: (query, callback) ->
+        if query.length
+          q = {}
+          q[select.data('ransack')] = query
+          loadOptions(q, callback)
+        else
+          callback()
+
+      onInitialize: ->
+        selectize = this
+        selectedValue = select.data('selected-value')
+        selectedRansack = "#{valueField}_eq"
+
+        if selectedValue
+          q = {}
+          q[selectedRansack] = selectedValue
+
+          loadOptions(q, (res)->
+            if res.length
+              selectize.addOption(res[0])
+              selectize.addItem(res[0][valueField])
+          )

data/app/assets/stylesheets/activeadmin-ajax_filter.css

@@ -0,0 +1,13 @@
+.filter_ajax_select .selectize-dropdown {
+  .item {
+    border-bottom: light-gray 1px solid;
+  }
+
+  .primary {
+    font-weight: bold;
+  }
+
+  .primary, .secondary {
+    display: block;
+  }
+}

data/bin/console

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

@@ -0,0 +1,23 @@
+require 'active_admin'
+require 'active_admin/ajax_filter/engine'
+require 'active_admin/ajax_filter/version'
+require 'active_admin/inputs/filters/ajax_select_input'
+
+module ActiveAdmin
+  module AjaxFilter
+    class << self
+      # @param [ActiveAdmin::DSL] dsl
+      # @return [void]
+      #
+      def included(dsl)
+        dsl.instance_eval do
+          collection_action :filter, method: :get do
+            scope = collection.ransack(params[:q]).result
+
+            render json: scope.order(:created_at).limit(params[:limit] || 10)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/ajax_filter/engine.rb

@@ -0,0 +1,9 @@
+require 'rails/engine'
+
+module ActiveAdmin
+  module AjaxFilter
+    # Including an Engine tells Rails that this gem contains assets
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/active_admin/ajax_filter/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module AjaxFilter
+    VERSION = '0.1.1'
+  end
+end

data/lib/active_admin/inputs/filters/ajax_select_input.rb

@@ -0,0 +1,53 @@
+module ActiveAdmin
+  module Inputs
+    module Filters
+      class AjaxSelectInput < SelectInput
+        DEFAULT_LIMIT = 5
+
+        def pluck_column
+          klass.reorder("#{method} asc").limit(collection_limit).uniq.pluck(method)
+        end
+
+        def collection_from_association
+          super.limit(collection_limit)
+        end
+
+        def input_html_options
+          super.merge(
+            'data-limit' => collection_limit,
+            'data-value-field' => value_field,
+            'data-search-fields' => search_fields,
+            'data-ransack' => ransack,
+            'data-selected-value' => selected_value,
+          )
+        end
+
+        def ajax_data
+          options[:data] || {}
+        end
+
+        def collection_limit
+          ajax_data[:limit] || DEFAULT_LIMIT
+        end
+
+        def value_field
+          ajax_data[:value_field] || :id
+        end
+
+        def search_fields
+          ajax_data[:search_fields] || raise(ArgumentError, 'search_fields in required')
+        end
+
+        def ransack
+          ajax_data[:ransack] || "#{search_fields.join('_or_')}_cont"
+        end
+
+        def selected_value
+          if @object
+            @object.try(:send, input_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activeadmin-ajax_filter.rb

@@ -0,0 +1 @@
+require 'active_admin/ajax_filter'

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-ajax_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Emelyanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: Allows to define filter by relation for ActiveAdmin resource pages using
+  Ransacker to dynamicaly load items while user is typing symbols in filter
+email:
+- aemelyanov@spbtv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeadmin-ajax_filter.gemspec
+- app/assets/javascripts/activeadmin-ajax_filter.js.coffee
+- app/assets/stylesheets/activeadmin-ajax_filter.css
+- bin/console
+- bin/setup
+- lib/active_admin/ajax_filter.rb
+- lib/active_admin/ajax_filter/engine.rb
+- lib/active_admin/ajax_filter/version.rb
+- lib/active_admin/inputs/filters/ajax_select_input.rb
+- lib/activeadmin-ajax_filter.rb
+homepage: https://github.com/holyketzer/activeadmin-ajax_filter
+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: AJAX filters for ActiveAdmin
+test_files: []