brightcontent 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63c828218e98472278afe774745ba8ac6e708b21
-  data.tar.gz: 581e8ed28905320b607820485eb65aecce8f305f
+  metadata.gz: 800182b4749990ccc8ef59573dbdf6fa6cc4093b
+  data.tar.gz: 484c9676dc21e37938f0c6b47b51f4e6acb88884
 SHA512:
-  metadata.gz: c1511bf4722afabd1cb9a9cb21ce1566f81b3a04f08d9b36178162f831968dd81b125a547a7fc1c63d50d2380dd2ae28a4d5442b4f64b596c832aeb4e824c5e3
-  data.tar.gz: bb6cba9a6eed2529dd8031fe9d01902615974978499a3898a458544d840aeb5330cfcd31808cda063dc0a38f0ccf902f28ba7c830d4f1a930deda8d1ec90c8ee
+  metadata.gz: b2abef9adc1716146aea208e4c5fbc639b3065c90d401f0d772177272e37bd71d5306a5983d20c25f95e2f3b18abdf080694dbca0688f51b9e5debeed3d5d712
+  data.tar.gz: 7162bc6bc2ede2f89d113d63f2b836570878958369f98943240212b221b9280412818a88012d7dd7c3fa4a87d2bfe233b3ed03f66c67c8ff25428e8384430dc6

data/README.md

@@ -11,7 +11,7 @@ Brightcontent, yet another rails CMS / admin panel
 * No standard 'cms-modules', we hate those, making custom is easy enough
 * Built in the rails way, use your normals models, only controllers and views are provided
 * Only exception: Page model is provided with tree structure, sorting, hidden and pretty urls like `/services/cleaning/houses`
-* Rails 4 only
+* Rails 4 only (currently >= 4.2 is not supported)
 * Strong Parameters support
 
 ![Brightcontent preview](doc/browser.jpg)
@@ -48,6 +48,93 @@ To add the resource to brightcontent run:
 
 Gratz! Projects can now be controlled with Brightcontent.
 
+Filters
+-------
+
+Using `filter_fields` you may define filters for your index pages:
+
+```ruby
+class BlogsController < Brightcontent::BaseController
+  filter_fields :author, :name
+end
+```
+
+The above will render two filters on the blogs index page. Blog belongs to Author, therefore by default the filter is displayed as a drop-down list containing all authors that have blogs. The name-filter is displayed as a drop-down list containing all values for the `name` attribute found in the blogs table.
+
+### Options
+
+In order to control the way filters are displayed and how they behave you can supply options:
+
+```ruby
+# Supplying options:
+filter_fields author: { ... }, name: { ... }
+
+# Combining filters without options and filters with options:
+filter_fields :author, name: { ... }
+```
+
+Basically all options are delegated to `SimpleForm::FormBuilder#input`, such as `:as`, `:input_html`, and `:label_method`. Refer to [Simple Form's documentation](http://www.rubydoc.info/github/plataformatec/simple_form/master/SimpleForm/FormBuilder#input-instance_method) for more information.
+
+#### Other options
+
+##### <tt>:collection</tt>
+
+Extends SimpleForm's `:collection` option. It also accepts a Proc, or method name as a symbol. It defaults to either a list of all existing values for the corresponding attribute or a list of all associated records in case of a belongs-to relationship.
+
+##### <tt>:predicate</tt>
+
+Allows for specifying the Ransack search predicate to be used. Set it to `false` to avoid a predicate. Defaults to "cont" (contains) for string type filters (`:string` or `:search`) and to "eq" (equals) for all other types. It defaults to `false` if the field name refers to [a ransackable scope](https://github.com/activerecord-hackery/ransack#using-scopesclass-methods). For more information refer to [Ransack's documentation](https://github.com/activerecord-hackery/ransack/wiki/Basic-Searching).
+
+### Examples
+
+```ruby
+class BlogsController < Brightcontent::BaseController
+  # Two default drop-down list filters:
+  filter_fields :name, :author
+
+  # Free form text filter, returns all blogs where name contains given query:
+  filter_fields name: { as: :string, predicate: "cont" }
+
+  # Same as above:
+  filter_fields name: { as: :string }
+
+  # Customized label:
+  filter_fields author: { label: "Written by" }
+
+  # Select filter with custom options:
+  filter_fields name: { collection: ["Game reviews", "Programming tips", "Arthur's blog"] }
+
+  # Belongs-to filter with custom options:
+  filter_fields author: { collection: ->{ Author.order(:name) }, label_method: :display_name }
+
+  # Or by means of a controller method:
+  filter_fields author: { collection: :published_authors }
+
+  # Or even a fully customized filter, using a fictitious custom SimpleForm input field:
+  filter_fields author: { as: :remote_select, url: "/authors.json?order=name" }
+
+  # Filter by start date:
+  filter_fields created_at: { as: :date, predicate: "gteq", label: "Posted since" }
+
+  # Filter by scope (see definition of Blog below):
+  filter_fields exclude_inactive: { as: :select, collection: [["Yes", true], ["No", false]] }
+
+  private
+
+  def published_authors
+    Author.published
+  end
+end
+
+def Blog < ActiveRecord::Base
+  scope :exclude_inactive, ->{ where(active: true) }
+
+  def self.ransackable_scopes(auth_object = nil)
+    [:exclude_inactive]
+  end
+end
+```
+
 Pages
 -----
 

data/VERSION

@@ -1 +1 @@
-2.1.5
+2.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brightcontent
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.2.0
 platform: ruby
 authors:
 - Developers at Brightin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brightcontent-core
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: brightcontent-pages
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: brightcontent-attachments
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.2.0
 description: Brightcontent, yet another Rails CMS / admin panel
 email: developers@brightin.nl
 executables: []
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Brightcontent gem