search_object 0.1

data/example/app/assets/stylesheets/reset.css

@@ -0,0 +1,43 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	font-size: 100%;
+	font: inherit;
+	vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+	display: block;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}

data/example/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/example/app/controllers/posts_controller.rb

@@ -0,0 +1,5 @@
+class PostsController < ApplicationController
+  def index
+    @search = PostSearch.new params[:f], params[:page]
+  end
+end

data/example/app/models/post.rb

@@ -0,0 +1,13 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+
+  validates :user,           presence: true
+  validates :title,          presence: true
+  validates :body,           presence: true
+  validates :category_name,  presence: true
+  validates :views_count,    numericality: true
+  validates :likes_count,    numericality: true
+  validates :comments_count, numericality: true
+
+  delegate :name, to: :user, prefix: true
+end

data/example/app/models/post_search.rb

@@ -0,0 +1,44 @@
+class PostSearch
+  include SearchObject.module(:model, :sorting, :will_paginate)
+
+  scope { Post.all }
+
+  sort_by :created_at, :views_count, :likes_count, :comments_count
+
+  per_page 15
+
+  option :user_id
+  option :category_name
+
+  option :title do |scope, value|
+    scope.where 'title LIKE ?', escape_search_term(value)
+  end
+
+  option :published do |scope, value|
+    scope.where published: true if value.present?
+  end
+
+  option :term do |scope, value|
+    scope.where 'title LIKE :term OR body LIKE :term', term: escape_search_term(value)
+  end
+
+  option :created_after do |scope, value|
+    date = parse_date value
+    scope.where('DATE(created_at) >= ?', date) if date.present?
+  end
+
+  option :created_before do |scope, value|
+    date = parse_date value
+    scope.where('DATE(created_at) <= ?', date) if date.present?
+  end
+
+  private
+
+  def parse_date(date)
+    Date.strptime(date, '%Y-%m-%d') rescue nil
+  end
+
+  def escape_search_term(term)
+    "%#{term.gsub(/\s+/, '%')}%"
+  end
+end

data/example/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  has_many :posts
+
+  validates :name, presence: true, uniqueness: true
+end

data/example/app/views/layouts/application.html.slim

@@ -0,0 +1,12 @@
+doctype html
+html
+  head
+    title SearchObject example
+
+    = stylesheet_link_tag 'application', media: 'all'
+    = csrf_meta_tags
+
+  body
+    = yield
+
+  = javascript_include_tag 'application'

data/example/app/views/posts/index.html.slim

@@ -0,0 +1,48 @@
+= form_for @search, as: :f, method: :get, url: root_path, html: {id: 'search-form'} do |form|
+  = form.hidden_field :sort
+
+  h1 Listing #{pluralize @search.count, 'post'}
+
+  fieldset
+    = form.search_field :term, placeholder: 'Search term'
+    = date_field_tag 'f[created_after]', @search.created_after
+    = date_field_tag 'f[created_before]', @search.created_before
+    = form.submit 'Search'
+
+  table.table.table-striped
+    thead
+      tr
+        th = form.label :title, 'Title'
+        th = form.label :user_id, 'Author'
+        th = form.label :category_name, 'Category'
+        th = link_to 'Views', root_path(f: @search.sort_params_for(:views_count)), class: @search.sort?(:views_count) && 'active'
+        th = link_to 'Likes', root_path(f: @search.sort_params_for(:likes_count)), class: @search.sort?(:likes_count) && 'active'
+        th = link_to 'Comments', root_path(f: @search.sort_params_for(:comments_count)), class: @search.sort?(:comments_count) && 'active'
+        th = form.label :published, 'Published?'
+        th = link_to 'Created at', root_path(f: @search.sort_params_for(:created_at)), class: @search.sort?(:created_at) && 'active'
+      tr
+        th = form.text_field :title
+        th = form.select :user_id, User.all.map { |u| [u.name, u.id] }, include_blank: true
+        th = form.select :category_name, Post.pluck('DISTINCT category_name'), include_blank: true
+        th
+        th
+        th
+        th = form.check_box :published
+        th
+    tbody
+      - if @search.results?
+        - @search.results.each do |post|
+          tr
+            td = post.title
+            td = post.user_name
+            td = post.category_name
+            td = post.views_count
+            td = post.likes_count
+            td = post.comments_count
+            td = post.published ? 'Yes' : 'No'
+            td = l post.created_at, format: :short
+      - else
+        tr
+          td.empty colspan="8" No posts found
+
+  .pull-right = will_paginate @search.results, renderer: BootstrapPagination::Rails

data/example/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/example/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/example/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/example/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/example/config/application.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# Load SearchObject manually from lib
+$:.unshift File.expand_path('../../../lib', __FILE__)
+require 'search_object'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env)
+
+module Example
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/example/config/boot.rb

@@ -0,0 +1,4 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/example/config/database.yml

@@ -0,0 +1,12 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+

data/example/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Example::Application.initialize!

data/example/config/environments/development.rb

@@ -0,0 +1,29 @@
+Example::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/example/config/environments/test.rb

@@ -0,0 +1,37 @@
+Example::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end
+

data/example/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/example/config/initializers/secret_token.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+Example::Application.config.secret_key_base = 'de7dcb2c40f416eb022b006d3156fed75e5398e601c5c9219bde8181cb63d51a330ddca8580fd534038d5d7c69b7d0afa396f5f80538e94275d3e4917c7654e6'

data/example/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Example::Application.config.session_store :cookie_store, key: '_example_session'

data/example/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/example/config/routes.rb

@@ -0,0 +1,3 @@
+Example::Application.routes.draw do
+  root to: 'posts#index'
+end

data/example/db/migrate/20131102130117_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name, null: false
+      t.timestamps
+    end
+
+    add_index :users, :name, unique: true
+  end
+end

data/example/db/migrate/20131102130413_create_posts.rb

@@ -0,0 +1,18 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.integer :user_id, null: false
+      t.string :title, null: false
+      t.string :body, null: false
+      t.string :category_name, null: false
+      t.integer :views_count, null: false, default: 0
+      t.integer :likes_count, null: false, default: 0
+      t.integer :comments_count, null: false, default: 0
+      t.boolean :published, null: false, default: false
+      t.datetime :published_at
+      t.timestamps
+    end
+
+    add_index :posts, :user_id
+  end
+end

data/example/db/schema.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20131102130413) do
+
+  create_table "posts", force: true do |t|
+    t.integer  "user_id",                        null: false
+    t.string   "title",                          null: false
+    t.string   "body",                           null: false
+    t.string   "category_name",                  null: false
+    t.integer  "views_count",    default: 0,     null: false
+    t.integer  "likes_count",    default: 0,     null: false
+    t.integer  "comments_count", default: 0,     null: false
+    t.boolean  "published",      default: false, null: false
+    t.datetime "published_at"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "posts", ["user_id"], name: "index_posts_on_user_id"
+
+  create_table "users", force: true do |t|
+    t.string   "name",       null: false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "users", ["name"], name: "index_users_on_name", unique: true
+
+end