administrate-field-lazy_has_many 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c52ef6f020f9a6ebe97cfbaf55bc989c47b295d86528c5ddc8594e164a0f80f0
+  data.tar.gz: 0dc0efd9692215d81171b7212cb545fc00605b29e35cdc9bdb1e3a1e43c619b7
+SHA512:
+  metadata.gz: 25729b85a7ee139a00c87e43922f20f941de234d2fc258d5b35b1122f1da7af6d008315e681f049cb8669543bff2e2b38e984c5f36b301dd93367af3839d55ac
+  data.tar.gz: 031b6ad09db90bfa7b483d75095bd7adab9915c10a9104c282d33d7e2e40f7ba1687f0d554190d57fe41ce5a584c25fea3b42aab07b633e9da1c5de04ce45f7f

data/.gitattributes

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

data/.gitignore

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

data/CHANGELOG.md

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Aftab Akram
+
+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,86 @@
+# Administrate::Field::LazyHasMany
+
+[![Gem Version](https://badge.fury.io/rb/administrate-field-lazy_has_many)](http://badge.fury.io/rb/administrate-field-lazy_has_many) [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+
+An input field that shows search results of has many association, lazily from a custom endpoint.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'administrate-field-lazy_has_many'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install administrate-field-lazy_has_many
+
+## Usage
+
+### Controller
+You need to have a route that does the following:
+1. yields an array of objects with at least the value and text you want to show i.e `[{value: 1, text: option1}]`
+2. Respond to `search` attribute
+3. Limit result `result_limit`
+
+The best way is to re-use everything administrate search feature.
+You must define this action in administrate related entity  controller
+```ruby
+     def books_data
+      result_limit = params[:result_limit] || 10
+      search_term = params[:search].to_s.strip
+      resources = Administrate::Search.new(scoped_resource, dashboard_class, search_term).run
+      resources = resources.limit(result_limit).map do |resource|
+        { value: resource.id, text: dashboard.display_resource(resource) }
+      end
+      if resources.blank?
+        render_empty_array
+      else
+        render json: resources
+      end
+    end
+```
+Above example action that could work for every model, but you can change the implementation as per need.
+The only catch is it must return the comply with above conditions.
+
+### Field
+Field is pretty easy and it does support all the features of administrate has_many field. You can provide all has_many options as per your use case.
+The only require attribute is `action` which must be rails path helper.
+```ruby
+require "administrate/base_dashboard"
+
+class PostDashboard < 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,
+    title: Field::String,
+    contributors: Field::LazyHasMany.with_options(
+      action: 'admin_form_contributors_data_path', result_limit: 10
+    ),
+    created_at: Field::DateTime,
+    updated_at: Field::DateTime
+  }.freeze
+
+  # ...
+end
+```
+i.e `result_limit` attribute maximum result value the field will post to action endpoint with `search` paramter
+
+## Contributing
+
+1. Fork it ( https://github.com/Aftab-Akram/administrate-field-lazy_has_many )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

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_has_many.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'administrate/field/lazy_has_many/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'administrate-field-lazy_has_many'
+  spec.version       = Administrate::Field::LazyHasManyVersion::VERSION
+  spec.authors       = ['Aftab Akram']
+  spec.email         = ['aftabakram04@gmail.com']
+
+  spec.summary       = 'A has many to-like field that lazily loads candidates from a custom endpoint.'
+  spec.homepage      = 'https://github.com/Aftab-Akram/administrate-field-lazy_has_many'
+  spec.license       = 'MIT'
+
+  # 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'
+  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/stylesheets/administrate-field-lazy_has_many/application.css

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

data/app/assets/stylesheets/administrate-field-lazy_has_many/components/lazy_has_many.css

@@ -0,0 +1,26 @@
+.selectize-control::before{
+    -moz-transition: opacity 0.2s;
+    -webkit-transition: opacity 0.2s;
+    transition: opacity 0.2s;
+    content: " ";
+    z-index: 2;
+    position: absolute;
+    display: block;
+    top: 50%;
+    right: 34px;
+    width: 16px;
+    height: 16px;
+    margin: -8px 0 0 0;
+    border: 10px solid #f3f3f3;
+    border-top: 10px solid #5e5858;
+    border-radius: 50%;
+    opacity: 0;
+    animation: spin 2s linear infinite;
+}
+.selectize-control.loading::before{
+  opacity: 0.4;
+}
+@keyframes spin {
+  0% { transform: rotate(0deg); }
+  100% { transform: rotate(360deg); }
+}

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

@@ -0,0 +1,35 @@
+<div class="field-unit__label">
+  <%= f.label field.attribute, for: "#{f.object_name}_#{field.attribute_key}" %>
+</div>
+<div class="field-unit__field">
+  <%= f.select(field.attribute_key, nil, {}, multiple: true) do %>
+    <%= options_for_select(field.associated_resource_options, field.selected_options) %>
+  <% end %>
+</div>
+
+<script>
+ $(document).ready(function() {
+    let xhr;
+    let select_filed = $("#<%= field.custom_attribute_id%>").selectize({
+      load: function (query, callback) {
+        if (!query.length) return callback();
+        $.ajax({
+          url: "<%= field.action%>",
+          type: "GET",
+          dataType: "json",
+          data: {
+            search: query,
+            result_limit: "<%= field.result_limit%>"
+          },
+          error: function () {
+            callback();
+          },
+          success: function (res) {
+            callback(res);
+          },
+        });
+      },
+    });
+});
+</script>
+

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

@@ -0,0 +1,13 @@
+<%#
+# HasMany Index Partial
+This partial renders a has_many relationship,
+to be displayed on a resource's index page.
+By default, the relationship is rendered
+as a count of how many objects are associated through the relationship.
+## Local variables:
+- `field`:
+  An instance of [Administrate::Field::HasMany][1].
+  A wrapper around the has_many relationship pulled from the database.
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasMany
+%>
+<%= pluralize(field.data.size, field.attribute.to_s.humanize.downcase.singularize) %>

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

@@ -0,0 +1,31 @@
+<%#
+# HasMany Show Partial
+This partial renders a has_many relationship,
+to be displayed on a resource's show page.
+By default, the relationship is rendered
+as a table of the first few associated resources.
+The columns of the table are taken
+from the associated resource class's dashboard.
+## Local variables:
+- `field`:
+  An instance of [Administrate::Field::HasMany][1].
+  Contains methods to help display a table of associated resources.
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasMany
+%>
+<% if field.resources.any? %>
+  <% order = field.order_from_params(params.fetch(field.name, {})) %>
+  <% page_number = params.fetch(field.name, {}).fetch(:page, nil) %>
+  <%= render(
+    "collection",
+    collection_presenter: field.associated_collection(order),
+    collection_field_name: field.name,
+    page: page,
+    resources: field.resources(page_number, order),
+    table_title: field.name,
+  ) %>
+  <% if field.more_than_limit? %>
+    <%= paginate field.resources(page_number), param_name: "#{field.name}[page]" %>
+  <% end %>
+<% else %>
+  <%= t("administrate.fields.has_many.none", default: "–") %>
+<% end %>

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

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

data/lib/administrate/field/lazy_has_many.rb

@@ -0,0 +1,45 @@
+require 'administrate/field/has_many'
+require 'administrate/field/lazy_has_many/version'
+require 'rails/engine'
+require 'administrate/engine'
+
+module Administrate
+  module Field
+    class LazyHasMany < Administrate::Field::HasMany
+      include LazyHasManyVersion
+
+      class Engine < ::Rails::Engine
+        Administrate::Engine.add_stylesheet 'administrate-field-lazy_belongs_to/application'
+
+        isolate_namespace Administrate
+      end
+
+      def candidate_resources
+        if options.key?(:includes)
+          includes = options.fetch(:includes)
+          associated_class.includes(*includes).where(id: data.map(&:id))
+        else
+          associated_class.where(id: data.map(&:id))
+        end
+      end
+
+      def custom_attribute_id
+        "#{resource.class.name.underscore}_#{attribute_key}"
+      end
+
+      def to_s
+        data.map { |v| display_candidate_resource(v) }
+      end
+
+      def action
+        raise StandardError.new 'action is missing' if options[:action].blank?
+
+        Rails.application.routes.url_helpers.send(options[:action])
+      end
+
+      def result_limit
+        options[:result_limit] || 10
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-lazy_has_many
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aftab Akram
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-06 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !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:
+- aftabakram04@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- administrate-field-lazy_has_many.gemspec
+- app/assets/stylesheets/administrate-field-lazy_has_many/application.css
+- app/assets/stylesheets/administrate-field-lazy_has_many/components/lazy_has_many.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
+- lib/administrate/field/lazy_has_many.rb
+- lib/administrate/field/lazy_has_many/version.rb
+homepage: https://github.com/Aftab-Akram/administrate-field-lazy_has_many
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A has many to-like field that lazily loads candidates from a custom endpoint.
+test_files: []