administrate-field-lazy_belongs_to 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6af0d252d532323cb506524d73fa060e83ae40ad7d2ac54ef5e402cb596d128
+  data.tar.gz: ef6b9e1cd805114f87080be3025d853f04acc81b7907f688ed76a8be1ab8f9e1
+SHA512:
+  metadata.gz: 9c5ed7524305bedfe7a46f07298830842dcb4aed3e31c85cc7efd097ded09e2b9c0f2359b76dcd0d2ff0bcfd6bdfba43c62de4de988463d78c4aee054d0857c2
+  data.tar.gz: 5dc7ba9b932bd07bec785c52bc688ad6189a86d61885c4a3336082df9e93a49bbb313391099576cbdc67412aa3700bff3ce7aec7cbe139d8af35dfd8e4e2e7bc

data/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/workspace.xml
+.idea/usage.statistics.xml
+.idea/tasks.xml
+
+.idea/dataSources**
+.idea/dataSources.local.xml

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build administrate-field-hyperlink-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install administrate-field-hyperlink-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install administrate-field-hyperlink-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push administrate-field-hyperlink-0.1.0.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run tests" fullCmd="test" taksId="test" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.idea/administrate-field-lazy_belongs_to.iml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="actioncable (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionmailer (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionpack (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionview (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activejob (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activerecord (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activestorage (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="administrate (v0.11.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="arel (v9.0.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="autoprefixer-rails (v9.5.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.5, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="crass (v1.0.4, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="datetime_picker_rails (v0.0.7, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="erubi (v1.8.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="execjs (v2.7.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ffi (v1.10.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="globalid (v0.4.2, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.6.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="jquery-rails (v4.3.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="kaminari (v1.1.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="kaminari-actionview (v1.1.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="kaminari-activerecord (v1.1.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="kaminari-core (v1.1.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.2.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mail (v2.7.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="marcel (v0.3.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="method_source (v0.9.2, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mimemagic (v0.3.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mini_mime (v1.0.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mini_portile2 (v2.4.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.11.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="momentjs-rails (v2.20.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nio4r (v2.3.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.10.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack (v2.0.6, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack-test (v1.1.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rails (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rails-dom-testing (v2.0.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rails-html-sanitizer (v1.0.4, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="railties (v5.2.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.5.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-fsevent (v0.10.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rb-inotify (v0.10.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sass (v3.7.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sass-listen (v4.0.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sass-rails (v5.0.7, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="selectize-rails (v0.12.6, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sprockets (v3.7.2, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sprockets-rails (v3.2.1, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thor (v0.20.3, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.6, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tilt (v2.0.9, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v1.2.5, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="websocket-driver (v0.7.0, ruby-2.5.3-p105) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="websocket-extensions (v0.1.3, ruby-2.5.3-p105) [gem]" level="application" />
+  </component>
+</module>

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="JSUnresolvedVariable" enabled="false" level="WEAK WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.5.3-p105" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/administrate-field-lazy_belongs_to.iml" filepath="$PROJECT_DIR$/.idea/administrate-field-lazy_belongs_to.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - ruby-head
+before_install:
+  - gem install bundler -v 2.0.1
+  - gem update --system
+  - gem --version
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+install:
+  - bundle install --with development --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+:baby: Initial commit

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Derk-Jan Karrenbeld
+
+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,130 @@
+# Administrate::Field::LazyBelongsTo
+
+[![Build Status: master](https://travis-ci.com/XPBytes/administrate-field-lazy_belongs_to.svg)](https://travis-ci.com/XPBytes/administrate-field-lazy_belongs_to)
+[![Gem Version](https://badge.fury.io/rb/administrate-field-lazy_belongs_to.svg)](https://badge.fury.io/rb/administrate-field-lazy_belongs_to)
+[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+
+An input field that shows search results of an association, lazily.
+
+![Example](./example.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'administrate-field-lazy_belongs_to'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install administrate-field-lazy_belongs_to
+
+## Usage
+
+This field needs a bit of setup, unless you're using [XPBytes/administrate-base_controller](https://github.com/XPBytes/administrate-base_controller),
+in order to lazily collect the values you're looking for:
+
+You need to have a route that yields an array of objects with at least the value and label you want to show. The best
+way is to re-use everything administrate offers you, which is the default behaviour of `Administrate::BaseController`:
+
+```ruby
+class BookController < Admin::ApplicationController
+  def index
+    respond_to do |format|
+      format.json do
+        resources = Administrate::Search.new(scoped_resource, dashboard_class, params[:search].to_s.strip).run
+        resources = apply_resource_includes(resources)
+        resources = order.apply(resources)
+        resources = resources.page(params[:page]).per(records_per_page)
+
+        render json: resources
+      end
+
+      format.any { super }
+    end
+  end
+end
+```
+
+This way, your already existing route also is available in JSON. You may optimize this by only use the id and value
+field: `resources.to_json(fields: %i[id name])`.
+
+The rest of the setup is as easy as any other field, except that you need to tell the field where to query the results,
+which key it should use for the value (defaults to `id`) and the label (defaults to `name`).
+
+```ruby
+require "administrate/base_dashboard"
+
+class BookDashboard < Administrate::BaseDashboard
+  # ATTRIBUTE_TYPES
+  # a hash that describes the type of each of the model's fields.
+  #
+  # Each different type represents an Administrate::Field object,
+  # which determines how the attribute is displayed
+  # on pages throughout the dashboard.
+  ATTRIBUTE_TYPES = {
+    id: Field::String,
+    name: Field::String,
+    author: Field::LazyBelongsTo.with_options(
+      placeholder: 'Select the author',
+      action: ->(field, q:) { field.url_helpers.admin_publisher_books_path(field.resource.publisher, search: q) },
+      value_attribute: :id,
+      label_attribute: :name
+    ),
+    created_at: Field::DateTime,
+    updated_at: Field::DateTime
+  }.freeze
+  
+  # ...
+end
+```
+
+You get the `field` and the search template `q` as argument and named argument. By default this is `{q}` which is
+replaced with the actual query on the front-end. You can use the `field.resource` shortcut to scope the url; in this
+example above it will only show authors with the current publisher.
+
+### Options
+
+| option | type | default | description |
+|--------|------|---------|-------------|
+| `placeholder` | `string` | `'Select a %<associated_class>s'` | The button text if there is no current value |
+| `action` | `lambda -> (field, q: string)` |  | The path to get the associated |
+| `value_attribute` | `string` or `symbol` | `id` | The attribute that you want to store in the field (`association_id`) |
+| `label_attribute` | `string` or `symbol` | `name` | The attribute that you want to show to the user (label) | 
+| `size` | `number` | `10` | The number of results to show at most (the rest will scroll) |
+
+## Related
+
+- [`Administrate`](https://github.com/thoughtbot/administrate): A Rails engine that helps you put together a super-flexible admin dashboard.
+- [`Administrate::BaseController`](https://github.com/XPBytes/administrate-base_controller): :stars: A set of application controller improvements.
+
+### Concerns
+
+- [`Administrate::DefaultOrder`](https://github.com/XPBytes/administrate-default_order): :1234: Sets the default order for a resource in a administrate controller.
+- [`Administrate::SerializedFields`](https://github.com/XPBytes/administrate-serialized_fields): :ab: Automatically deserialize administrate fields on form submit.
+
+### Fields
+
+- [`Administrate::Field::Hyperlink`](https://github.com/XPBytes/administrate-field-hyperlink): :pencil: A `string` field that is shows a hyperlink.
+- [`Adminisrtate::Field::JsonEditor`](https://github.com/XPBytes/administrate-field-json_editor): :pencil: A `text` field that shows a [JSON editor](https://github.com/josdejong/jsoneditor).
+- [`Administrate::Field::ScopedBelongsTo`](https://github.com/XPBytes/administrate-field-scoped_belongs_to): :pencil: A `belongs_to` field that yields itself to the scope `lambda`.
+- [`Administrate::Field::ScopedHasMany`](https://github.com/XPBytes/administrate-field-scoped_has_many): :pencil: A `has_many` field that yields itself to the scope `lambda`.
+- [`Administrate::Field::TimeAgo`](https://github.com/XPBytes/administrate-field-time_ago): :pencil: A `date_time` field that shows its data as `time_ago` since.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 [XPBytes/administrate-field-lazy_belongs_to](https://github.com/XPBytes/administrate-field-lazy_belongs_to).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/administrate-field-lazy_belongs_to.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'administrate/field/lazy_belongs_to/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'administrate-field-lazy_belongs_to'
+  spec.version       = Administrate::Field::LazyBelongsToVersion::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld']
+  spec.email         = ['derk-jan@xpbytes.com']
+
+  spec.summary       = 'A belongs to-like field that lazily loads candidates from a custom endpoint.'
+  spec.homepage      = 'https://github.com/XPBytes/administrate-field-lazy_belongs_to'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage + '/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'administrate', '>= 0.11.0', '< 1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/app/assets/javascripts/administrate-field-lazy_belongs_to/application.js

@@ -0,0 +1,2 @@
+//= require_tree .
+//= require_self

data/app/assets/javascripts/administrate-field-lazy_belongs_to/components/lazy_belongs_to.js

@@ -0,0 +1,106 @@
+function bindLazyBelongsTos() {
+  const lazySelects = document.querySelectorAll('[data-component="lazy-belongs-to"]')
+
+  lazySelects.forEach(lazySelect => {
+    const target = lazySelect.querySelector('input[type="hidden"]')
+    const input = lazySelect.querySelector('input[type="search"]')
+    const button = lazySelect.querySelector('button[type="button"]')
+    const popout = lazySelect.querySelector('[data-target="popout"]')
+    const output = lazySelect.querySelector('[data-target="output"]')
+    const select = output.querySelector('select')
+
+    const options = JSON.parse(lazySelect.getAttribute('data-lazy-belongs-to'))
+
+    let controller = undefined
+    let lastResult = undefined
+
+    function onQuery (event) {
+      const value = event.currentTarget.value
+
+      if (controller) {
+        // abort the previous request
+        controller.abort()
+      }
+
+      controller = new AbortController()
+      const { signal } = controller
+      console.log({ hidden: target.value, selected: select.value, query: value })
+
+      fetch(options.url.replace('{q}', value).replace('%7Bq%7D', value), {
+        signal,
+        headers: { Accept: 'application/json' }
+      })
+        .then(r => r.json())
+        .then(r => r.map(e => ({ value: e[options.value], label: e[options.label] })))
+        .then(rs => {
+          const currentResult = JSON.stringify((rs))
+
+          if (lastResult && lastResult === currentResult) {
+            return
+          }
+
+          lastResult = currentResult
+
+          while (select.lastChild) {
+            select.removeChild(select.lastChild);
+          }
+
+          const currentValue = target.value
+
+          rs.forEach(r => {
+            const option = document.createElement('option')
+            option.setAttribute('value', r.value)
+            option.innerText = r.label
+            option.selected = currentValue === r.value
+            select.appendChild(option)
+          })
+
+          select.setAttribute('size', "" + Math.max(2, Math.min(Number(select.getAttribute('data-max-size')), rs.length)))
+        })
+        .catch(error => {
+          if (error.name === 'AbortError') {
+            return /* ignore, this is an aborted promise */
+          }
+          console.error(error)
+        })
+    }
+
+    function showPopout() {
+      popout.classList.add('active')
+    }
+
+    function hidePopout() {
+      popout.classList.remove('active')
+    }
+
+    input.addEventListener('input', onQuery)
+    button.addEventListener('click', showPopout)
+
+    document.addEventListener('click', (e) => {
+      const lazy = e.target && e.target.closest('[data-component="lazy-belongs-to"]')
+      if (lazy !== lazySelect) {
+        hidePopout()
+      }
+    })
+
+    select.addEventListener('change', (e) => {
+      if (!e.currentTarget.value) {
+        return
+      }
+
+      target.value = e.currentTarget.value
+      button.textContent = e.currentTarget.selectedOptions[0].textContent
+      hidePopout()
+    })
+
+    button.removeAttribute('disabled')
+  })
+}
+
+if (Turbolinks && Turbolinks.supported) {
+  document.addEventListener("turbolinks:load", function () {
+    bindLazyBelongsTos()
+  })
+} else {
+  document.addEventListener('DOMContentLoaded', bindLazyBelongsTos)
+}

data/app/assets/stylesheets/administate-field-lazy_belongs_to/application.css

@@ -0,0 +1,4 @@
+/*
+*= require_self
+*= require_tree .
+*/

data/app/assets/stylesheets/administate-field-lazy_belongs_to/components/lazy_belongs_to.css

@@ -0,0 +1,63 @@
+.field-unit--lazy-belongs-to .popout {
+    display: none;
+    background-color: white;
+    box-shadow: rgba(13, 22, 38, 0.1) 0px 0px 0px 1px, rgba(13, 22, 38, 0.1) 0px 4px 11px;
+    margin-top: 8px;
+    position: absolute;
+    z-index: 2;
+    border-radius: 4px;
+}
+
+.field-unit--lazy-belongs-to .popout.active {
+    display: block;
+}
+
+.field-unit--lazy-belongs-to .search {
+    height: 100%;
+    width: auto;
+    line-height: 38px;
+    display: block;
+    padding: 8px;
+    position: relative;
+    box-sizing: border-box;
+    min-width: 240px;
+    border-color: rgb(204, 204, 204);
+    border-radius: 4px;
+    border-style: solid;
+    border-width: 1px;
+    transition: all 100ms ease 0s;
+    margin: 8px;
+}
+
+.field-unit--lazy-belongs-to .icon {
+    display: none;
+    position: absolute;
+    right: 15px;
+    top: 15px;
+    color: rgb(204, 204, 204);
+    height: 18px;
+    width: 18px;
+    pointer-events: none;
+}
+
+.field-unit--lazy-belongs-to .search:placeholder-shown + .field-unit--lazy-belongs-to .icon {
+    display: block;
+}
+
+.field-unit--lazy-belongs-to .results {
+    display: block;
+    box-shadow: rgba(0, 0, 0, 0.1) 0px 1px 0px inset;
+}
+
+.field-unit--lazy-belongs-to .results select {
+    width: 100%;
+    border: 0;
+
+    -webkit-appearance: none;
+    -moz-appearance: none;
+    appearance: none;
+}
+
+.field-unit--lazy-belongs-to .results option {
+    padding: 8px;
+}

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

@@ -0,0 +1,50 @@
+<%#
+# LazyBelongsTo Form Partial
+
+This partial renders an input element for belongs_to relationships.
+Instead of the default, this only loads the results lazily
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::LazyBelongsTo][1].
+  A wrapper around the [Administrate::Field::BelongsTo][2] field
+
+[1]: http://www.rubydoc.info/gems/administrate-field-lazy_belongs_to/Administrate/Field/LazyBelongsTo
+[2]: http://www.rubydoc.info/gems/administrate/Administrate/Field/BelongsTo
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.permitted_attribute %>
+</div>
+<div class="field-unit__field"
+     data-component="lazy-belongs-to"
+     data-lazy-belongs-to="<%=
+       {
+         url: field.templated_action,
+         value: field.value_attribute,
+         label: field.label_attribute
+       }.to_json
+     %>"
+>
+  <%= f.hidden_field(field.permitted_attribute) %>
+
+  <button type="button" disabled="disabled"><%= field.current_value %></button>
+
+  <div class="popout" data-target="popout">
+    <input type="search" class="search" placeholder="Search...">
+    <i class="icon">
+      <svg width="18" height="18" viewBox="0 0 24 24" focusable="false" role="presentation">
+        <path d="M16.436 15.085l3.94 4.01a1 1 0 0 1-1.425 1.402l-3.938-4.006a7.5 7.5 0 1 1 1.423-1.406zM10.5 16a5.5 5.5 0 1 0 0-11 5.5 5.5 0 0 0 0 11z" fill="currentColor" fill-rule="evenodd"></path>
+      </svg>
+    </i>
+    <output class="results" data-target="output">
+      <select data-max-size="<%= field.size %>">
+        <option></option>
+      </select>
+    </output>
+  </div>
+</div>
+

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

@@ -0,0 +1,28 @@
+<%#
+# LazyBelongsTo 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::LazyBelongsTo][1].
+  A wrapper around the [Administrate::Field::BelongsTo][2] field
+
+[1]: http://www.rubydoc.info/gems/administrate-field-lazy_belongs_to/Administrate/Field/LazyBelongsTo
+[2]: http://www.rubydoc.info/gems/administrate/Administrate/Field/BelongsTo
+%>
+
+<% if field.data %>
+  <% if valid_action?(:show, field.associated_class) %>
+    <%= link_to(
+      field.display_associated_resource,
+      [namespace, field.data],
+    ) %>
+  <% else %>
+    <%= field.display_associated_resource %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,28 @@
+<%#
+# LazyBelongsTo 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::LazyBelongsTo][1].
+  A wrapper around the [Administrate::Field::BelongsTo][2] field
+
+[1]: http://www.rubydoc.info/gems/administrate-field-lazy_belongs_to/Administrate/Field/LazyBelongsTo
+[2]: http://www.rubydoc.info/gems/administrate/Administrate/Field/BelongsTo
+%>
+
+<% if field.data %>
+  <% if valid_action?(:show, field.associated_class) %>
+    <%= link_to(
+      field.display_associated_resource,
+      [namespace, field.data],
+    ) %>
+  <% else %>
+    <%= field.display_associated_resource %>
+  <% end %>
+<% end %>

data/lib/administrate/field/lazy_belongs_to/version.rb

@@ -0,0 +1,7 @@
+module Administrate
+  module Field
+    module LazyBelongsToVersion
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/administrate/field/lazy_belongs_to.rb

@@ -0,0 +1,48 @@
+require 'administrate/field/belongs_to'
+require 'administrate/field/lazy_belongs_to/version'
+require 'rails/engine'
+
+module Administrate
+  module Field
+    class LazyBelongsTo < Administrate::Field::BelongsTo
+      include LazyBelongsToVersion
+
+      class Engine < ::Rails::Engine
+        Administrate::Engine.add_javascript 'administrate-field-lazy_belongs_to/application'
+        Administrate::Engine.add_stylesheet 'administrate-field-lazy_belongs_to/application'
+
+        isolate_namespace Administrate
+      end
+
+      def to_s
+        data
+      end
+
+      def display_placeholder
+        options.fetch(:placeholder) do
+          format('Select a %<association>s', association: associated_class.name)
+        end
+      end
+
+      def current_value
+        data ? display_associated_resource : display_placeholder
+      end
+
+      def templated_action
+        options.fetch(:action).call(self, q: '{q}')
+      end
+
+      def value_attribute
+        options.fetch(:value_attribute) { 'id' }
+      end
+
+      def label_attribute
+        options.fetch(:label_attribute) { 'name' }
+      end
+
+      def url_helpers
+        Rails.application.routes.url_helpers
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-lazy_belongs_to
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derk-Jan Karrenbeld
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: 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'
+description: 
+email:
+- derk-jan@xpbytes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".idea/.rakeTasks"
+- ".idea/administrate-field-lazy_belongs_to.iml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- administrate-field-lazy_belongs_to.gemspec
+- app/assets/javascripts/administrate-field-lazy_belongs_to/application.js
+- app/assets/javascripts/administrate-field-lazy_belongs_to/components/lazy_belongs_to.js
+- app/assets/stylesheets/administate-field-lazy_belongs_to/application.css
+- app/assets/stylesheets/administate-field-lazy_belongs_to/components/lazy_belongs_to.css
+- app/views/fields/lazy_belongs_to/_form.html.erb
+- app/views/fields/lazy_belongs_to/_index.html.erb
+- app/views/fields/lazy_belongs_to/_show.html.erb
+- example.png
+- lib/administrate/field/lazy_belongs_to.rb
+- lib/administrate/field/lazy_belongs_to/version.rb
+homepage: https://github.com/XPBytes/administrate-field-lazy_belongs_to
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/XPBytes/administrate-field-lazy_belongs_to
+  source_code_uri: https://github.com/XPBytes/administrate-field-lazy_belongs_to
+  changelog_uri: https://github.com/XPBytes/administrate-field-lazy_belongs_to/CHANGELOG.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A belongs to-like field that lazily loads candidates from a custom endpoint.
+test_files: []