administrate-field-has_many_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e5a699068fe8d5f017ca36b723813241ed8033046c4324fda887978702841d2
+  data.tar.gz: 8d9bcb27f7f35be527c14534f94bf6bf31df444acfe1ac4838027425540cfc8f
+SHA512:
+  metadata.gz: d4a8b0ef760d8b84902714733ee9560a9b883914d8fcf96a80481c6122236e045b7e292b87e2803e28e94e878d7a84ebe0da5d68b1c56d83bb1eaf4a3f2c4bd5
+  data.tar.gz: 0c18bd52a87f50b35fa1e8e1c7ecdb710bd892129a231fef133ffff306ed728c7993f9b15bfb93a2967aca7d779d3e135f5ea4de78e07c8d9d212c0a627e8582

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,38 @@
+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/**/*'
+
+Rails/ApplicationRecord:
+  Exclude:
+    - 'spec/**/*'
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma

data/.simplecov

@@ -0,0 +1,11 @@
+SimpleCov.start 'rails' do
+  add_group 'app', 'app'
+  add_group 'lib', 'lib'
+
+  refuse_coverage_drop
+
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ])
+end

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.1
+  - 2.3.4
+cache: bundler
+install: bundle install
+script:
+  - bundle exec rubocop -D
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at developer@fishbrain.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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,59 @@
+# Administrate::Field::HasManySearch
+
+A plugin to search through `has_many` associations in [thoughtbot's Administrate](https://github.com/thoughtbot/administrate) Rails engine.
+
+## Usage
+
+Add it to your `Gemfile`:
+
+```ruby
+gem 'administrate-field-has_many_search'
+```
+
+Run bundler to install:
+
+```sh
+bundle install
+```
+
+Add it to your Administrate dashboard, for instance:
+
+```ruby
+class PostDashboard < Administrate::BaseDashboard
+  ATTRIBUTE_TYPES = {
+    authors: Field::HasManySearch.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/redrick/administrate-field-has_many_search/issues/new).
+
+This is meant to be an welcoming and friendly place for collaboration. Therefore, all contributors are expected to adhere to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+It is licensed under the MIT license. See [LICENSE](LICENSE) for details.
+
+## Screenshot
+
+![Screenshot](https://user-images.githubusercontent.com/865364/167399301-49f7de4b-6240-4875-b509-6f354fe62503.png)
+
+## Credits
+
+I have to give much credit to [Fishbrain AB](https://fishbrain.com)
+This was not only inspired, but shamelessly copy-pasted from
+[here](https://github.com/fishbrain/administrate-field-belongs_to_search) for
+convenience, many thanks guys :)

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

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name = 'administrate-field-has_many_search'
+  gem.version = '0.1.0'.freeze
+  gem.authors = ['Klas Eskilson', 'Andrej Antas']
+  gem.email = ['klas.eskilson@gmail.com', 'andrej@antas.cz']
+  gem.homepage = 'https://github.com/redrick/administrate-field-has_many_search'
+  gem.summary = 'Plugin that adds search capabilities to has_many 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', '< 1.0'
+  gem.add_dependency 'jbuilder', '~> 2'
+  gem.add_dependency 'rails', '>= 4.2', '< 7.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', '~> 13.0'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'rubocop', '~> 0.76.0'
+  gem.add_development_dependency 'simplecov', '~> 0'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+
+  gem.description = <<-DESCRIPTION
+  Add support to search through (potentially large) has_many associations in your Administrate dashboards.
+  DESCRIPTION
+end

data/app/assets/javascripts/has_many_search.js

@@ -0,0 +1,28 @@
+// belongs_to form
+$(function() {
+  $(".field-unit--has-many-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/has_many_search/_form.html.erb

@@ -0,0 +1,28 @@
+<%#
+# 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.attribute, for: "#{f.object_name}_#{field.attribute_key}" %> 
+</div>
+<div class="field-unit__field">
+  <%= f.select(field.attribute_key,
+               nil,
+               {},
+               multiple: true,
+               'data-url': polymorphic_url([namespace, field.associated_class], format: :json)) do %>
+    <%= options_for_select(field.associated_resource_options, field.selected_options) %>
+  <% end %>
+</div>

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

@@ -0,0 +1,16 @@
+<%#
+# 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.
+%>
+
+<%= pluralize(field.data.size, t("activerecord.models.#{field.attribute.to_s.singularize}", default: field.attribute.to_s.humanize.downcase.singularize, count: field.data.size)) %>

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

@@ -0,0 +1,32 @@
+<%#
+# 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.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/has_many_search.rb

@@ -0,0 +1,29 @@
+require "administrate/field/has_many"
+require "rails"
+
+module Administrate
+  module Field
+    class HasManySearch < Administrate::Field::HasMany
+      class Engine < ::Rails::Engine
+        initializer "administrate-field-has_many_search.add_assets" do |app|
+          app.config.assets.precompile << "has_many_search.js" if app.config.respond_to? :assets
+          Administrate::Engine.add_javascript "has_many_search.js" if defined?(Administrate::Engine)
+        end
+      end
+
+      def associated_resource_options
+        if data.blank?
+          []
+        else
+          data.map do |d|
+            [display_candidate_resource(d), d.id]
+          end
+        end
+      end
+
+      def associated_class
+        super
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-has_many_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Klas Eskilson
+- Andrej Antas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-05-09 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.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: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.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) has_many associations
+  in your Administrate dashboards.\n"
+email:
+- klas.eskilson@gmail.com
+- andrej@antas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- administrate-field-has_many_search.gemspec
+- app/assets/javascripts/has_many_search.js
+- app/views/administrate/application/index.json.jbuilder
+- app/views/fields/has_many_search/_form.html.erb
+- app/views/fields/has_many_search/_index.html.erb
+- app/views/fields/has_many_search/_show.html.erb
+- lib/administrate/field/has_many_search.rb
+homepage: https://github.com/redrick/administrate-field-has_many_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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Plugin that adds search capabilities to has_many associations for Administrate
+test_files: []