administrate-field-belongs_to_search 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41209459176c92826ff7ae2539c7b52643fa10bb
+  data.tar.gz: b5f6cb2068cb07d1059b6a7f66a88b6b0b2be228
+SHA512:
+  metadata.gz: d5733597a1a50f44b4280bf8f2289063eecc10357d14216130c532305ad24bdebdd52d6f5df44824a48acb7237d6c4197a9b706875fac57cbaeb70f21f6de42d
+  data.tar.gz: a7e3631147fedfc2534410d85d83e9cadf35d8053a3c6f76949616bc3caa745c6637013f8345f125196ee1e2acdeaa797acd42ca6e1f90d40d7e6e85e5b1c054

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/.rubocop.yml

@@ -0,0 +1,31 @@
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+Metrics/ClassLength:
+  Max: 220
+
+Metrics/AbcSize:
+  Max: 35
+
+Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# allow multiline `expect { ... }.to do_something`
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+# specs tend to get long
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,6 @@
+before_install:
+  - rvm install 2.2.2
+install: bundle install
+script:
+  - bundle exec rubocop
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## Upcoming release
+
+## 0.1.2
+
+* Re-push unbroken 0.1.1
+
+## 0.1.1
+
+* Fix broken Rails dependency (klaseskilson)
+
+## 0.1.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Fishbrain AB.
+
+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,58 @@
+# Administrate::Field::BelongsToSearch
+
+[![Build Status](https://travis-ci.org/fishbrain/administrate-field-belongs_to_search.svg?branch=master)](https://travis-ci.org/fishbrain/administrate-field-belongs_to_search)
+
+A plugin to search through `belongs_to` associations in [thoughtbot's Administrate](https://github.com/thoughtbot/administrate) Rails engine.
+
+## Usage
+
+Add it to your `Gemfile`:
+
+```ruby
+gem 'administrate-field-belongs_to_search', '~> 0.1.2'
+```
+
+Run bundler to install:
+
+```sh
+bundle install
+```
+
+Add it to your Administrate dashboard, for instance:
+
+```ruby
+class PostDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    author: Field::BelongsToSearch.with_options(class_name: 'User')
+  }
+# ...
+```
+
+With this, you should be good to go!
+
+## Develop and contribute
+
+Fork and clone the repo. Install dependencies and run test using:
+
+```sh
+bundle install
+bundle exec rake
+```
+
+Then, implement your feature/fix, [write a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+and submit a pull request to this repository. If you only have some feedback or are unsure about how to do something, you're welcome to
+submit an [issue](https://github.com/fishbrain/administrate-field-belongs_to_search/issues/new).
+
+## License
+
+This plugin is Copyright © 2017 Fishbrain AB. It is licensed under the MIT license. See [LICENSE](LICENSE) for details.
+
+========
+
+![Fishbrain AB](http://i.imgur.com/wOMiqE8.png)
+
+This plugin is maintained by [Fishbrain AB](https://fishbrain.com).
+
+At Fishbrain, we're passionate about the outdoors and conservation. Together, we work to bring you the best app for fishing, hands down.
+
+If you love working with amazing and talented people in tight-knit teams, [join us](https://fishbrain.com/jobs/)!

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+##
+# Configure the test suite.
+##
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+##
+# By default, just run the tests.
+##
+task default: :spec

data/administrate-field-belongs_to_search.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name = 'administrate-field-belongs_to_search'
+  gem.version = '0.1.2'.freeze
+  gem.authors = ['Klas Eskilson']
+  gem.email = ['klas.eskilson@gmail.com']
+  gem.homepage = 'https://github.com/fishbrain/administrate-field-belongs_to_search'
+  gem.summary = 'Plugin that adds search capabilities to belongs_to associations for Administrate'
+  gem.license = 'MIT'
+
+  gem.require_paths = %w(lib)
+  gem.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  gem.test_files = `git ls-files -z -- {spec}/*`.split("\x0")
+
+  gem.add_dependency 'administrate', '~> 0.3'
+  gem.add_dependency 'rails', '>= 4.2', '< 5.1'
+  gem.add_dependency 'selectize-rails', '~> 0.6'
+
+  gem.add_development_dependency 'coveralls', '~> 0'
+  gem.add_development_dependency 'factory_girl', '~> 4.8'
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'rubocop', '~> 0'
+  gem.add_development_dependency 'simplecov', '~> 0'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+
+  gem.description = <<-DESCRIPTION
+Add support to search through (potentially large) belongs_to associations in your Administrate dashboards.
+  DESCRIPTION
+end

data/app/assets/javascripts/belongs_to_search.js

@@ -0,0 +1,28 @@
+// belongs_to form
+$(function() {
+  $(".field-unit--belongs-to-search select").each(function initializeSelectize(index, element) {
+    var $element = $(element);
+    $element.selectize({
+      valueField: 'id',
+      labelField: 'dashboard_display_name',
+      searchField: 'dashboard_display_name',
+      create: false,
+      searchUrl: $element.data('url') + '?search=',
+
+      load: function(query, callback) {
+        if (!query.length) return callback();
+        var searchUrl = this.settings.searchUrl;
+        $.ajax({
+          url: searchUrl + encodeURIComponent(query),
+          type: 'GET',
+          error: function() {
+            callback();
+          },
+          success: function(res) {
+            callback(res.resources);
+          }
+        });
+      },
+    });
+  });
+});

data/app/views/administrate/application/index.json.jbuilder

@@ -0,0 +1,23 @@
+# ## Index
+#
+# This view is the template for the index page.
+#
+# ## Local variables:
+#
+# - `page`:
+#   An instance of [Administrate::Page::Collection][1].
+#   Contains helper methods to help display a table,
+#   and knows which attributes should be displayed in the resource's table.
+# - `resources`:
+#   An instance of `ActiveRecord::Relation` containing the resources
+#   that match the user's search criteria.
+#   By default, these resources are passed to the table partial to be displayed.
+# - `search_term`:
+#   A string containing the term the user has searched for, if any.
+#
+# [1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Collection
+
+json.resources resources do |resource|
+  json.id resource.id
+  json.dashboard_display_name @_dashboard.display_resource(resource)
+end

data/app/views/fields/belongs_to_search/_form.html.erb

@@ -0,0 +1,27 @@
+<%#
+# BelongsToSearch Form Partial
+
+This partial renders an search input element for belongs_to relationships.
+By default, the input is a collection select box
+that displays all possible records to associate with.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [BelongsToWithSearchField].
+  Contains helper methods for displaying a collection select box.
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.permitted_attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.select(field.permitted_attribute,
+               nil,
+               {},
+               'data-url': polymorphic_url([namespace, field.associated_class], format: :json)) do %>
+    <%= options_for_select(field.associated_resource_options, field.selected_option) %>
+  <% end %>
+</div>

data/app/views/fields/belongs_to_search/_index.html.erb

@@ -0,0 +1,21 @@
+<%#
+# BelongsToSearch Index Partial
+
+This partial renders a belongs_to relationship,
+to be displayed on a resource's index page.
+
+By default, the relationship is rendered as a link to the associated object.
+
+## Local variables:
+
+- `field`:
+  An instance of Administrate::Field::BelongsToSearch.
+  A wrapper around the belongs_to relationship pulled from the database.
+%>
+
+<% if field.data %>
+  <%= link_to(
+    field.display_associated_resource,
+    [namespace, field.data],
+  ) %>
+<% end %>

data/app/views/fields/belongs_to_search/_show.html.erb

@@ -0,0 +1,21 @@
+<%#
+# BelongsToSearch Show Partial
+
+This partial renders a belongs_to relationship,
+to be displayed on a resource's show page.
+
+By default, the relationship is rendered as a link to the associated object.
+
+## Local variables:
+
+- `field`:
+  An instance of Administrate::Field::BelongsToSearch.
+  A wrapper around the belongs_to relationship pulled from the database.
+%>
+
+<% if field.data %>
+  <%= link_to(
+    field.display_associated_resource,
+    [namespace, field.data],
+  ) %>
+<% end %>

data/lib/administrate/field/belongs_to_search.rb

@@ -0,0 +1,25 @@
+require 'administrate/field/belongs_to'
+require 'rails'
+
+module Administrate
+  module Field
+    class BelongsToSearch < Administrate::Field::BelongsTo
+      class Engine < ::Rails::Engine
+        config.assets.precompile << 'belongs_to_search.js' if config.respond_to? :assets
+        Administrate::Engine.add_javascript 'belongs_to_search.js' if defined?(Administrate::Engine)
+      end
+
+      def associated_resource_options
+        if data.nil?
+          []
+        else
+          [[display_candidate_resource(data), data.id]]
+        end
+      end
+
+      def associated_class
+        super
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-belongs_to_search
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Klas Eskilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: selectize-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |
+  Add support to search through (potentially large) belongs_to associations in your Administrate dashboards.
+email:
+- klas.eskilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- administrate-field-belongs_to_search.gemspec
+- app/assets/javascripts/belongs_to_search.js
+- app/views/administrate/application/index.json.jbuilder
+- app/views/fields/belongs_to_search/_form.html.erb
+- app/views/fields/belongs_to_search/_index.html.erb
+- app/views/fields/belongs_to_search/_show.html.erb
+- lib/administrate/field/belongs_to_search.rb
+homepage: https://github.com/fishbrain/administrate-field-belongs_to_search
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Plugin that adds search capabilities to belongs_to associations for Administrate
+test_files: []