trestle-search 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e66c7976251e2847893227f257d2d71928c01ec
+  data.tar.gz: 806335714fe6464a0d15f8787d8752b8e49dbf82
+SHA512:
+  metadata.gz: 598078f2d1171666b33708e3cc8b3258006307234f5acc6b32c0b803e93aeafad702c63953da1dfb5f0dbb98d61e8148a8003ba1c957f552136cb1cab52f61ea
+  data.tar.gz: 8dccd48ea03cfdadaa8cddb29d4bb4c3a673804423922135aa9d775091b9c5a4a9e481b6dbd7e3ae2b182e173611aca035430db3441bf6b895f97b2e1540edf6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trestle-auth.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,47 @@
+# Trestle Search (trestle-search)
+
+> Search plugin for the Trestle admin framework
+
+
+## Getting Started
+
+These instructions assume you have a working Trestle application. To integrate trestle-search, first add it to your application's Gemfile:
+
+```ruby
+gem 'trestle-search'
+```
+
+Run `bundle install`, and then restart your Rails server.
+
+To enable search capabilities within an admin resource, define a `search` block:
+
+```ruby
+Trestle.resource(:articles) do
+  search do |q|
+    Article.where("title ILIKE ?", "%#{q}%")
+  end
+end
+```
+
+The search block accepts one or two parameters; the first is the string value of the search query. The second, optional parameter is the full `params` hash.
+
+The search block will be called instead of the default (or custom) `collection` block when the `q` query parameter is present (i.e. when a search query has been entered). It must return a chainable scope.
+
+The original collection block can be called to avoid redefining scopes. For example:
+
+```ruby
+Trestle.resource(:articles) do
+  collection do
+    Article.order(created_at: :desc).includes(:author)
+  end
+
+  search do |q|
+    collection.where("title ILIKE ?", "%#{q}%")
+  end
+end
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [LGPLv3 License](https://opensource.org/licenses/LGPL-3.0).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/stylesheets/trestle/search.scss

@@ -0,0 +1,55 @@
+@import "trestle/support";
+
+.searchbox {
+  float: left;
+  max-width: 25%;
+  padding: 8px 0;
+
+  .input-group-addon {
+    background: none;
+    border: none;
+    padding-left: 0;
+  }
+
+  .form-control {
+    padding-left: 0;
+
+    background: none;
+    box-shadow: none;
+
+    border: none;
+    border-radius: 0;
+
+    border-bottom: 1px solid #ddd;
+
+    transition: border-color 500ms;
+
+    &:focus {
+      border-color: #555;
+    }
+  }
+
+  @media (max-width: $screen-xs-max) {
+    position: absolute;
+    top: 10px;
+    left: 10px;
+    width: $sidebar-width - 20px;
+    max-width: none;
+
+    padding: 0 12px;
+    background: white;
+    box-shadow: inset 0 1px 1px rgba(black, 0.075);
+    border-radius: 50px;
+
+    .form-control {
+      border-bottom: none;
+      font-size: 16px;
+    }
+  }
+}
+
+@media (max-width: $screen-xs-max) {
+  .app-sidebar {
+    padding-top: 40px;
+  }
+}

data/app/views/trestle/search/_search.html.erb

@@ -0,0 +1,10 @@
+<% if defined?(admin) && admin.respond_to?(:searchable?) && admin.searchable? -%>
+  <div class="searchbox">
+    <%= form_tag admin.path, method: :get do %>
+      <div class="input-group">
+        <span class="input-group-addon"><icon class="fa fa-search"></icon></span>
+        <%= text_field_tag :q, params[:q], class: "form-control", placeholder: t("admin.search.placeholder", default: "Search") %>
+      </div>
+    <% end %>
+  </div>
+<% end -%>

data/config/initializers/trestle.rb

@@ -0,0 +1,11 @@
+Trestle.configure do |config|
+  config.persistent_params << :q
+  
+  config.hook("stylesheets") do
+    stylesheet_link_tag "trestle/search"
+  end
+
+  config.hook("view.header") do
+    render "trestle/search/search"
+  end
+end

data/config/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  admin:
+    search:
+      placeholder: Search
+      results: Search Results

data/lib/trestle/search.rb

@@ -0,0 +1,13 @@
+require "trestle/search/version"
+
+module Trestle
+  module Search
+    extend ActiveSupport::Autoload
+
+    autoload :Builder
+    autoload :Controller
+    autoload :Resource
+  end
+end
+
+require "trestle/search/engine" if defined?(Rails)

data/lib/trestle/search/builder.rb

@@ -0,0 +1,9 @@
+module Trestle
+  module Search
+    module Builder
+      def search(&block)
+        admin.search = block
+      end
+    end
+  end
+end

data/lib/trestle/search/controller.rb

@@ -0,0 +1,13 @@
+module Trestle
+  module Search
+    module Controller
+      def index
+        super
+
+        if admin.searchable? && params[:q].present?
+          breadcrumb t("admin.search.results", default: "Search Results"), { q: params[:q] }
+        end
+      end
+    end
+  end
+end

data/lib/trestle/search/engine.rb

@@ -0,0 +1,13 @@
+module Trestle
+  module Search
+    class Engine < ::Rails::Engine
+      config.assets.precompile << "trestle/search.css"
+
+      initializer :extensions do
+        Trestle::Resource.singleton_class.send(:prepend, Trestle::Search::Resource)
+        Trestle::Resource::Builder.send(:include, Trestle::Search::Builder)
+        Trestle::Resource::Controller.send(:prepend, Trestle::Search::Controller)
+      end
+    end
+  end
+end

data/lib/trestle/search/resource.rb

@@ -0,0 +1,25 @@
+module Trestle
+  module Search
+    module Resource
+      attr_writer :search
+
+      def initialize_collection(params)
+        query_param = params[:q]
+
+        if searchable? && query_param.present?
+          search(query_param, params)
+        else
+          super(params)
+        end
+      end
+
+      def search(query, params)
+        instance_exec(query, params, &@search)
+      end
+
+      def searchable?
+        @search
+      end
+    end
+  end
+end

data/lib/trestle/search/version.rb

@@ -0,0 +1,5 @@
+module Trestle
+  module Search
+    VERSION = "0.2.0"
+  end
+end

data/trestle-search.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trestle/search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trestle-search"
+  spec.version       = Trestle::Search::VERSION
+
+  spec.authors       = ["Sam Pohlenz"]
+  spec.email         = ["sam@sampohlenz.com"]
+
+  spec.summary       = "Search plugin for the Trestle admin framework"
+  spec.description   = "Search plugin for the Trestle admin framework."
+  spec.homepage      = "https://www.trestle.io"
+  spec.license       = "LGPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "trestle", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: trestle-search
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sam Pohlenz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trestle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Search plugin for the Trestle admin framework.
+email:
+- sam@sampohlenz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/trestle/search.scss
+- app/views/trestle/search/_search.html.erb
+- config/initializers/trestle.rb
+- config/locale/en.yml
+- lib/trestle/search.rb
+- lib/trestle/search/builder.rb
+- lib/trestle/search/controller.rb
+- lib/trestle/search/engine.rb
+- lib/trestle/search/resource.rb
+- lib/trestle/search/version.rb
+- trestle-search.gemspec
+homepage: https://www.trestle.io
+licenses:
+- LGPL-3.0
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Search plugin for the Trestle admin framework
+test_files: []