record_collection 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57c83b9fc9b46bcfed66a78f8966f8a71a48cee6
+  data.tar.gz: 0c28f323778b1c26db44f619ebe7814cdc435263
+SHA512:
+  metadata.gz: 0833cd40aa97cf4c08af7be2feff96543b776eb024bb2ccd287b8b081fd3d492eb919e5b97ae7b29669fdced058c1191b49b1eb2f4b97f8da3e4b9b6c9160441
+  data.tar.gz: 9e7768139cba271ec1d58fb48c8e166609547708ee341d41a599d3de05751dfcfd15ae7aa87edc8961b92f17419d744126e55cb0a9ad9ebec11dcf17b9ae6c2c

data/.gitignore

@@ -0,0 +1,23 @@
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/temt
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/spec/
+spec/dummy/.sass-cache

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Benjamin ter Kuile
+
+MIT License
+
+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,217 @@
+# RecordCollection
+[<img src="https://secure.travis-ci.org/bterkuile/record_collection.png?branch=master" alt="Build Status" />](http://travis-ci.org/bterkuile/record_collection)
+
+record\_collection is a gem that adds functionality to rails to work
+with collections. This consists of a few components:
+
+* Collection objects containing some active record models and acting on
+  that collection.
+* the multi\_select helpers for selecting records from the index page
+* the optionals helpers for managing attributes on the collection of
+  records you may or may not want to edit in the collection form
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'record_collection'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install record_collection
+
+## Adding routes
+Add two collection routes to the normal resources definition.
+This call behaves exactly as the normal resources :... call, 
+but adds:
+```ruby
+ collection do
+   get :batch_actions
+   post :process_batch
+ end
+```
+So the route definition in `config/routes.rb` defined as:
+```ruby
+  batch_resources :employees, except: [:new]
+```
+is exactly the same as:
+```ruby
+  resources :employees, except: [:new] do
+    collection do
+      get :batch_actions
+      post :process_batch
+    end
+  end
+```
+
+## Defining the collection
+A good practice is to define your collection as a subclass of your
+resource class. So an employees collection should be defined like:
+`app/models/employee.rb`:
+```ruby
+class Employee < ActiveRecord::Base
+  # attribute :admin, type: Boolean (defined by database)
+  validates :name, presence: true
+  
+end
+```
+`app/models/employee/collection.rb`:
+```ruby
+class Employee::Collection < RecordCollection::Base
+  attribute :name
+  validates :section, format: {with: /\A\w{3}\Z/, if: 'section.present?' }
+  attribute :admin, type: Boolean
+  attribute :vegan, type: Boolean
+end
+```
+See the [active_attr](https://github.com/cgriego/active_attr) gem for
+attribute definitions.
+
+## Defining your controllers
+If you already used the specification `batch_resources :employees` in
+your [config/routes.rb](spec/dummy/config/routes.rb) file you can add
+the actions in your controller typically looking like:
+```ruby
+class EmployeesController < ApplicationController
+  # your standard actions here
+  
+  # GET /employees/batch_actions?ids[]=1&ids[]=3&...
+  def batch_actions
+    @employees = Employee.find(Array.wrap(params[:ids])) 
+    @collection = Employee::Collection.new(@employees)
+    redirect_to employees_path, alert: 'No employees selected' if @collection.empty? 
+  end
+
+  # POST /employees/process_batch
+  def process_batch
+    @employees = Employee.find(Array.wrap(params[:ids]))
+    @collection = Employee::Collection.new(@employees, params[:collection])
+    if @collection.save
+      redirect_to employees_path, notice: 'Collection is updated'
+    else
+      render 'batch_actions'
+    end
+  end  
+end
+```
+For more advanced use of the collection the pattern above can of course
+be different eg: different collection objects for the same active record
+model types.
+
+## Creating your views
+The
+[app/views/employess/batch_actions.html.slim](spec/dummy/app/views/employees/batch_actions.html.slim) view is a tricky one.
+Since we are working on a collection of record, and want to edit those
+attributes we just want a normal form for editing the attributes,
+treating the collection as the record itself. The problem however is
+that some attributes can be in a mixed state, say two employees, one
+having `admin => true`, the other one `admin => false`. If I only want
+to update the section they are both in, I want to leave the admin
+attribute allone. To accomplish this, this gem provides the `optional`
+helpers. These helpers make it easy to manage a form of attributes where
+you can determine which attributes you want to manage for this
+particular collection of records. This gem also support [simple_form](https://github.com/plataformatec/simple_form)
+gem where you can replace `f.input :attribute, ...etc` with
+`f.optional_input :attribute, ...etc`. Our current example works with
+the standard [form_helpers](http://guides.rubyonrails.org/form_helpers.html)<br>
+### currently supported helpers:
+* `optional_boolean`
+* `optional_text_field`
+* `optional_input` ([simple_form](https://github.com/plataformatec/simple_form))
+
+The form you create typically looks like:
+```slim
+h1 Edit multiple employees
+= form_for @collection, url: [:process_batch, @collection.record_class] do |f|
+  = f.collection_ids
+  .form-inputs= f.optional_text_field :section
+  .form-inputs= f.optional_boolean :admin
+  .form-inputs= f.optional_boolean :vegan
+  .form-actions= f.submit
+.page-actions
+  = link_to 'Back', employees_path
+```
+
+That is the view part. Be sure to read the optionals section for a
+better understanding of how the optional fields work.
+
+## Selecting records from the index using checkboxes (multi_select)
+The idea behind working with collections is that you end up as a `GET` request at:
+`+controller+/batch_actions?ids[]=2&ids[]=3` etc. How you achieve this
+is totally up to yourself, but this gem provides you with a nice
+standard way of selecting records from the index page. To filter records
+to a specific subset the [ransack](https://github.com/activerecord-hackery/ransack) 
+gem also provides a nice way to add filtering to the index page. To add
+checkbox selecting to your page this gem assumes the following
+structure using the [Slim lang](http://slim-lang.com/): 
+```slim
+table.with-selection
+  thead
+    tr
+      th Name
+      th Section
+  tbody
+    - @employees.each do |employee|
+      tr data-record=employee.attributes.to_json
+```
+Note that each row needs a json version of the record at least
+containing its id.<br>
+Implement the multiselect dependencies in your manifest files, typically
+being `app/assets/javascripts/application.js`:
+```javascript
+//= require record_collection/multi_select
+```
+And for the styling provided by this gem ([app/assets/stylesheets/application.css](spec/dummy/app/assets/stylesheets/application.css.sass)):
+```css
+/*
+ *= require record_collection/multi_select
+ */
+```
+The styling uses the [font-awesome-rails](http://fortawesome.github.io/Font-Awesome/) gem, so this gem should be
+present in your `Gemfile`:
+```ruby
+gem 'font-awesome-rails'
+```
+Of course you are welcome to create your own awesome styling and send it
+to me so I can add it as a theme :smile:.
+
+## Optionals
+Optionals is the name for the feature in this gem that activates
+collection attributes to be sumitted in the form or not. Since for a
+mixed collection on an attribute you might not want to edit, but another
+attribute you do want to edit you add the optionals functionality to
+your manifests. This is similar to the `multi_select` feature:
+```javascript
+//= require record_collection/optionals
+```
+And for the styling provided by this gem ([app/assets/stylesheets/application.css](spec/dummy/app/assets/stylesheets/application.css.sass)):
+```css
+/*
+ *= require record_collection/optionals
+ */
+```
+
+**TODO: more explanation about optionals**
+
+## Special thanks
+
+Special thanks for this project goes to:<br>
+<a href="http://companytools.nl/" target="_blank"><img src="http://companytools.nl/assets/logo2-f5f9a19c745e753a4d52b5c0a1a7c6d7.png" alt="Companytools"></a>
+&nbsp;&nbsp;
+<a href="http://fourstack.nl" target="_blank"><img src="http://fourstack.nl/logo1.png" alt="FourStack"></a>
+&nbsp;&nbsp;
+<a href="http://www.kpn.com" target="_blank"><img src="http://www.kpn.com/ss/Satellite/yavUnLl8hN7yMh6Gh2IPWqYD60HbUkXsNK4iD8PcUpR0bnBXyZZtwQUuCgSUG72CJE/MungoBlobs/kpn_logo.png"></a>
+
+## Contributing
+
+1. Fork it ( https://github.com/bterkuile/record_collection/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+#RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/app/assets/javascripts/record_collection/application.js.coffee

@@ -0,0 +1 @@
+#= require_tree .

data/app/assets/javascripts/record_collection/multi_select.js.coffee

@@ -0,0 +1,66 @@
+class MultiSelect
+  setup: (table) ->
+    return unless table and table.length
+    table.data 'multi_select', @
+    @set 'table', table
+
+    @set 'resource', table.data('resource')
+    # Add an extra th to all header rows
+    table.find('thead tr').each -> $(this).prepend("<th></th>")
+
+    # Create a toggle for selecting an deselecting all records
+    # and add it to the last header row
+    #toggle_all = $("<input type='checkbox'></input>").addClass('selection-toggle-all').click ->
+      #checked = $(this).is(':checked')
+      #table.find('td.selection input').prop 'checked', checked
+    toggle_all = $("<span></span>").addClass('selection-toggle-all unchecked').click ->
+      if $(this).hasClass('checked')
+        table.find('td.selection .checker').removeClass('checked').addClass('unchecked')
+        $(this).removeClass('checked').addClass('unchecked')
+      else
+        table.find('td.selection .checker').removeClass('unchecked').addClass('checked')
+        $(this).removeClass('unchecked').addClass('checked')
+    table.find('thead tr:last th:first').append toggle_all
+
+    # Create a toggle/checkbox for all records and add it to the row
+    #record_toggle = $("<input type='checkbox'></input>")
+    record_toggle = $("<span></span>").addClass('checker unchecked').click ->
+      if $(this).hasClass('checked')
+        $(this).removeClass('checked').addClass('unchecked')
+      else
+        $(this).removeClass('unchecked').addClass('checked')
+    record_td = $('<td></td>').addClass('selection').append(record_toggle)
+    table.find('tbody tr').prepend record_td
+
+    @setup_selection_actions()
+
+    toggle_all.click() if table.data('preselected')
+
+  # Find all buttons in the table footer and attach the action given their action data attribute
+  setup_selection_actions: ->
+    selector = this
+    @table.find('tfoot button').click ->
+      $.post Routes["actions_#{selector.get('resource')}_path"](),
+        ids: selector.selected_ids().toArray()
+        selection_action: $(this).data('action')
+
+  # use set and get as a good reactive pattern
+  # implement the raw version, can become more complex int the future
+  set: (path, value) -> @[path] = value
+  get: (path) -> @[path]
+
+  #selected_records: -> @table.find("td.selection input:checked").map( -> $(this).parents('tr').data('record') )
+  selected_records: -> @table.find("td.selection .checked").map( -> $(this).parents('tr').data('record') )
+  selected_ids: -> @selected_records().map( -> this.id ).toArray()
+root = @
+root.MultiSelect = new MultiSelect()
+$.fn.multi_select = ->
+  if @.hasClass('with-selection') or @.prop('tagName') is 'TABLE'
+    select = new MultiSelect()
+    root.MultiSelect = select
+    select.setup @
+  else
+    @.find('table.with-selection').each (i, el)->
+      select = new MultiSelect()
+      root.MultiSelect = select
+      select.setup $(el)

data/app/assets/javascripts/record_collection/optionals.js.coffee

@@ -0,0 +1,101 @@
+class Optionals
+  setup: (target)->
+    @setup_inputs(target)
+
+  setup_inputs: (target)->
+    target.find('.optional-attribute-container').each (i, el)=>
+      container = $(el)
+      if container.hasClass('optional-boolean')
+        @optionalBoolean container
+      else
+        @prependActivator(container)
+
+  # Replace the <input type="checkbox"> for a <input type="hidden" # value="0|1"> fields
+  # managed by the javascript
+  optionalBoolean: (container)->
+    check_box = container.find('input')
+    initially_checked = check_box.is(':checked')
+    field_name = check_box.attr('name')
+
+    label_text = container.find('label').text()
+
+    value_field = $('<input>').attr('type', 'hidden').val(0)
+    # Set name based on activated state
+    if container.hasClass('active')
+      value_field.attr 'name', field_name
+    else
+      value_field.attr 'name', "disabled_#{field_name}"
+
+    # Clear the container and initialize to inactive
+    container.html('')
+
+    label = $('<span></span>').addClass('optional-boolean-label').text label_text
+
+    activator_toggle = $('<span></span>').addClass('optional-boolean-activator-toggle').click ->
+      container.toggleClass('active').toggleClass('inactive')
+      if container.hasClass('active')
+        value_field.attr 'name', value_field.attr('name').replace(/^disabled_/, '')
+      else
+        value_field.attr 'name', "disabled_#{value_field.attr('name')}"
+
+    value_toggle = $('<span></span>').addClass('optional-boolean-toggle').click ->
+      return if container.hasClass('inactive')
+      if $(@).hasClass('active')
+        value_field.val(0)
+        $(@).removeClass('active').addClass('inactive')
+      else
+        value_field.val(1)
+        $(@).addClass('active').removeClass('inactive')
+
+    if initially_checked
+      value_toggle.addClass('active')
+      value_field.val(1)
+    else
+      value_toggle.addClass('inactive')
+
+    container.append activator_toggle
+    container.append label
+    container.append value_toggle
+    container.append value_field
+
+  prependActivator: (container)->
+      value_field = container.find('select,input')
+      # INITIAL STATE IS DISABLED, Activation by triggering click if needed
+      value_field.attr 'name', "disabled_#{value_field.attr('name')}"
+
+      label_text = container.find('label').text()
+
+      # Activator container
+      activator_container = $('<div></div>').addClass('optional-input-activator-container inactive')
+      activator_container.addClass container.data('attribute')
+      activator_container.addClass('error') if container.hasClass('error')
+      activator_toggle = $('<span></span>').addClass('optional-input-activator-toggle').click ->
+        activator_container.toggleClass('active').toggleClass('inactive')
+        #label.toggleClass('inactive')
+        if activator_container.hasClass('active')
+          value_field.attr 'name', value_field.attr('name').replace(/^disabled_/, '')
+          #value_toggle.show()
+          container.removeClass('inactive')
+        else
+          value_field.attr 'name', "disabled_#{value_field.attr('name')}"
+          #value_toggle.hide()
+          container.addClass('inactive')
+      activator_label = $('<span></span>').addClass('optional-input-activator-label').text label_text
+      activator_container.append activator_toggle
+      activator_container.append activator_label
+
+      container.before(activator_container)
+
+      container.find('label').remove()
+
+      activator_toggle.click() if container.hasClass('active')
+
+root = @
+root.Optionals = new Optionals()
+$.fn.optionals = (action_or_options = {})->
+  if typeof action_or_options is 'string'
+    #nothing
+  else
+    optionals = new Optionals(action_or_options)
+    optionals.setup(@)
+    root.Optionals = optionals