bimbamboom_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb8eb0a094fe9230f9b71eb9d4b6f393dd7cf809b7cadb625aeb3fe2e8226366
+  data.tar.gz: fd665f7d73f6526f3a7e7c4f3ee2a9c1e11d7a691a8578dbdbafcc42e9bc48cf
+SHA512:
+  metadata.gz: adc494b7b1af23d960f5073c02f0d8aa6ed088f8c5ffadd2b8c85e7b668a9bc6ed4f889ab5afeb4ccfc35e6e045fab112b3ddf4901c499dfdf387fee786731fb
+  data.tar.gz: 0aa958f5aa67f2b831c00f4857720121d4ad263a0ebaab487d2b5073926982c5eb50e4ef485f444db6d7aef4a9100dd8bba605e29118fce2b33a7ac56e7f83bf

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_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/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 vincent.viricel@gmail.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bimbamboom_search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 HHGB12
+
+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,43 @@
+# BimbamboomSearch
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bimbamboom_search`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bimbamboom_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bimbamboom_search
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/bimbamboom_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BimbamboomSearch project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bimbamboom_search/blob/master/CODE_OF_CONDUCT.md).

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/app/assets/javascripts/belongs_to_search.js

@@ -0,0 +1,12 @@
+// 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,
+    });
+  });
+});

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/bimbamboom_search.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bimbamboom_search/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bimbamboom_search"
+  spec.version       = BimbamboomSearch::VERSION
+  spec.authors       = ["HHGB12"]
+  spec.email         = ["vincent.viricel@gmail.com"]
+
+  spec.summary       = 'Plugin that adds search capabilities to belongs_to associations for Administrate'
+  spec.description   = <<-DESCRIPTION
+  Add support to search through (potentially large) belongs_to associations in your Administrate dashboards.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/HHGB12/bimbamboom_search'
+  spec.license       = "MIT"
+
+
+  # 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 "bundler", "~> 2.0"
+  # spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.require_paths = %w[lib]
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.test_files = `git ls-files -z -- {spec}/*`.split("\x0")
+
+  spec.add_dependency 'administrate', '>= 0.3', '< 1.0'
+  spec.add_dependency 'jbuilder', '~> 2'
+  spec.add_dependency 'rails', '>= 4.2', '< 6.0'
+  spec.add_dependency 'selectize-rails', '~> 0.6'
+
+  spec.add_development_dependency 'coveralls', '~> 0'
+  spec.add_development_dependency 'factory_girl', '~> 4.8'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '0.49.0'
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bimbamboom_search"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bimbamboom_search.rb

@@ -0,0 +1,20 @@
+require "bimbamboom_search/version"
+require 'administrate/field/belongs_to'
+require 'rails'
+
+module Administrate
+  module Field
+    class BelongsToSearch < Administrate::Field::BelongsTo
+      class Engine < ::Rails::Engine
+        initializer 'administrate-field-belongs_to_search.add_assets' do |app|
+          app.config.assets.precompile << 'belongs_to_search.js' if app.config.respond_to? :assets
+          Administrate::Engine.add_javascript 'belongs_to_search.js' if defined?(Administrate::Engine)
+        end
+      end
+
+      def associated_class
+        super
+      end
+    end
+  end
+end

data/lib/bimbamboom_search/version.rb

@@ -0,0 +1,3 @@
+module BimbamboomSearch
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: bimbamboom_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HHGB12
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-20 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: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !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.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.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.\n"
+email:
+- vincent.viricel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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
+- bimbamboom_search.gemspec
+- bin/console
+- bin/setup
+- lib/bimbamboom_search.rb
+- lib/bimbamboom_search/version.rb
+homepage: https://github.com/HHGB12/bimbamboom_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.7.6
+signing_key: 
+specification_version: 4
+summary: Plugin that adds search capabilities to belongs_to associations for Administrate
+test_files: []