record_collection 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a18dd599ddae39a9097d25b2aff3489b383ad91
-  data.tar.gz: 52835347a7fa4e3b8185e8c5595f00d14339fbd4
+  metadata.gz: c3ab00ef1adc5b2fba1f11c6775bdb5cedf3d131
+  data.tar.gz: 466e4feeaf5bbbee5f62dddf126159834a131c67
 SHA512:
-  metadata.gz: b1c6b9cbc3bbb195eccd046bf7ef02a82fa68287b0046ef96fad14bad9886faa2689cb664afd8f424a3d5639362df2c5783e9146db7b3e948753fc3640bbbab2
-  data.tar.gz: 5df9fa42f9c1a695a1ed9691750f5cd3da7177b3ce1644707492904e263fac46a6754baae688c6e55b5b0497d2faf52bf951f23b64c5e0333dbbb8478e3c6de6
+  metadata.gz: be027edc729b7fb5c1bf0059c7bd6e874c68a788deb6970e0f648b1311549791479022306ab116df3bd6ae34cb1ae4f3e98951f08fb03bc6486013fd5b629962
+  data.tar.gz: 56cee9b7123367bcd065c0edb1be3cd1d576e584574943f9f29283ac3153796f4ce08e6cd0f05e9f1f8078a58fbbdb253f01de0c2ce75ee476a13ba6a9d36c41

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
-- 2.2.0
+  - 2.1.6
+  - 2.2.2
+addons:
+  code_climate:
+    repo_token: 22819b10ef9110a7fef884ab105239fc16fd0562ac79ae54c2204b5e07343919

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in record_collection.gemspec
 gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end

data/README.md

@@ -1,6 +1,8 @@
 # RecordCollection
-[<img src="https://secure.travis-ci.org/bterkuile/record_collection.png?branch=master" alt="Build Status" />](http://travis-ci.org/bterkuile/record_collection)
+[![Gem Version](https://badge.fury.io/rb/record_collection.svg)](http://badge.fury.io/rb/record_collection)
+[![Build Status](https://travis-ci.org/bterkuile/record_collection.svg?branch=master)](https://travis-ci.org/bterkuile/record_collection)
 [![Code Climate](https://codeclimate.com/github/bterkuile/record_collection/badges/gpa.svg)](https://codeclimate.com/github/bterkuile/record_collection)
+[![Test Coverage](https://codeclimate.com/github/bterkuile/record_collection/badges/coverage.svg)](https://codeclimate.com/github/bterkuile/record_collection/coverage)
 
 record\_collection is a gem that adds functionality to rails to work
 with collections. This consists of a few components:
@@ -11,6 +13,14 @@ with collections. This consists of a few components:
 * the optionals helpers for managing attributes on the collection of
   records you may or may not want to edit in the collection form
 
+This gem is created for a project where acting on collections of records
+was a key feature of the application. If you require really heavy client
+side logic on collections, a client side framework might be the way to go
+treating all records CRUD individually. This gem add two 'resourceful'
+actions to a resource controller to act on collections (a subset) of
+your records. Advanced failure handling is missing. Normal active
+model validation is implemented.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/record_collection/rails/form_options_helper.rb

@@ -16,15 +16,13 @@ class ActionView::Helpers::FormBuilder
   end
 
   def optional_boolean(attr, options = {})
-    classes = get_optional_classes(attr, options.merge(base_class: 'optional-boolean'))
-    label_tag = label(attr, options[:label])
-    check_box_tag = check_box(attr, options)
-    add_collection_ids @template.content_tag(:div, label_tag + check_box_tag , class: classes, data: get_data_attributes(attr, options))
-  end
-
-  def optional_check_box(attr, options = {})
-    optional_boolean(attr, options)
+    #classes = get_optional_classes(attr, options.merge(base_class: 'optional-boolean'))
+    #label_tag = label(attr, options[:label])
+    #check_box_tag = check_box(attr, options)
+    #add_collection_ids @template.content_tag(:div, label_tag + check_box_tag , class: classes, data: get_data_attributes(attr, options))
+    optional_form_element(:check_box, attr, options.reverse_merge(base_class: 'optional-boolean'))
   end
+  alias_method :optional_check_box, :optional_boolean
 
   def optional_input(attr, options = {})
     classes = get_optional_classes(attr, options.reverse_merge(base_class: 'optional-input'))
@@ -32,42 +30,45 @@ class ActionView::Helpers::FormBuilder
   end
 
   def optional_text_field(attr, options={})
-    classes = get_optional_classes(attr, options.reverse_merge(base_class: 'optional-text-field'))
-    add_collection_ids @template.content_tag(:div, label(attr, options[:label]) + text_field(attr, options), class: classes, data: get_data_attributes(attr))
+    optional_form_element(:text_area, attr, options.reverse_merge(base_class: 'optional-text-field'))
   end
 
   def optional_text_area(attr, options={})
+    optional_form_element(:text_area, attr, options.reverse_merge(base_class: 'optional-text-area'))
+  end
+
+  def get_optional_classes(attr, options = {})
+    classes = [options[:base_class] || 'optional-input', 'optional-attribute-container', attr, active_class(attr)]
+    classes << 'disabled' if options[:disabled]
+    classes << 'one' if !object.is_a?(RecordCollection::Base) or object.one?
+    classes << 'error' if object.errors[attr].present?
+    classes
+  end
+
+  def optional_form_element(element, attr, options = {})
     classes = get_optional_classes(attr, options.reverse_merge(base_class: 'optional-text-area'))
-    add_collection_ids @template.content_tag(:div, label(attr, options[:label]) + text_area(attr, options), class: classes, data: get_data_attributes(attr))
+    add_collection_ids @template.content_tag(:div, label(attr, options[:label]) + send(element, attr, options), class: classes, data: get_data_attributes(attr, options))
   end
 
+  private
+
   def get_data_attributes(attr, options = {})
-    one = true
-    one = object.one? if object.is_a? RecordCollection::Base
+    one = object.is_a?(RecordCollection::Base) ? object.one? : true
     attrs = {attribute: attr, one: one}
     attrs[:disabled] = true if options[:disabled]
     attrs
   end
 
-  def get_optional_classes(attr, options = {})
-    active = false
+  def active_class(attr)
+    active = false # default
     if object.respond_to?(:uniform_collection_attribute)
       uniform_value = object.uniform_collection_attribute(attr, set_if_nil: true)
-      # The field is active when the uniform value is not nil
+      # The field is active when the uniform value is not nil, 
+      # aka has a value
       active = !uniform_value.nil?
     end
-    active = true unless object.public_send(attr).nil? # Activate if collection attribute is not nil
-    classes = [options[:base_class] || 'optional-input', 'optional-attribute-container', attr]
-    classes << (active ? 'active' : 'inactive')
-    classes << 'disabled' if options[:disabled]
-    if object.is_a? RecordCollection::Base
-      classes << 'one' if object.one?
-    else
-      # Assume normal record, this always behaves like one
-      classes << 'one'
-    end
-    classes << 'error' if object.errors[attr].present?
-    classes
+    active = true unless object.public_send(attr).nil? # Activate if collection or record attribute is not nil
+    active ? 'active' : 'inactive'
   end
 end
 

data/lib/record_collection/version.rb

@@ -1,3 +1,3 @@
 module RecordCollection
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
 end

data/record_collection.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   #spec.add_development_dependency "rspec", ">= 3.1.0"
   spec.add_development_dependency "rspec-rails", "~> 3.1"
+  spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "pry", ">= 0.1"
   spec.add_development_dependency "rails", "~> 4.1"
   spec.add_development_dependency "sqlite3"

data/spec/dummy/app/models/project/collection.rb

@@ -1,3 +1,4 @@
 class Project::Collection < RecordCollection::Base
   attribute :finished, type: Boolean
+  attribute :description
 end

data/spec/dummy/app/views/projects/collection_edit.html.slim

@@ -1,7 +1,8 @@
-h1 Edit multiple employees
+h1 Edit multiple projects
 = form_for @collection, url: [:collection_update, @collection] do |f|
   = render 'form_errors', target: @collection
   .form-inputs= f.optional_boolean :finished, disabled: true
+  .form-inputs= f.optional_text_area :description
   .form-actions= f.submit
 .page-actions
   = link_to 'Back', employees_path

data/spec/dummy/config/locales/record_collection.en.yml

@@ -1,7 +1,7 @@
 en:
   activerecord:
     collections:
-      employee: Group
+      employee: Employees collection
     attributes:
       employee:
         section: Department

data/spec/dummy/db/migrate/20150721122805_add_description_to_projects.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToProjects < ActiveRecord::Migration
+  def change
+    add_column :projects, :description, :text
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150204125014) do
+ActiveRecord::Schema.define(version: 20150721122805) do
 
   create_table "employees", force: :cascade do |t|
     t.string   "name"
@@ -26,8 +26,9 @@ ActiveRecord::Schema.define(version: 20150204125014) do
     t.string   "name"
     t.boolean  "finished"
     t.string   "state"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
+    t.datetime "created_at",  null: false
+    t.datetime "updated_at",  null: false
+    t.text     "description"
   end
 
 end

data/spec/features/translations_spec.rb

@@ -4,6 +4,6 @@ RSpec.feature "Multi select", type: :feature do
   scenario "Selecting all", js: true do
     employee = Employee.create name: 'E1', section: 'ABC', admin: true, vegan: false
     visit collection_edit_employees_path(ids: [employee.id])
-    find('[name="commit"]').value.should eq "Update Group"
+    find('[name="commit"]').value.should eq "Update Employees collection"
   end
 end

data/spec/rails/form_builder_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
 
-RSpec.describe ActionView::Helpers::FormBuilder do
+describe ActionView::Helpers::FormBuilder do
   let(:employee){ Employee.create section: 'SE1' }
-  subject{ described_class.new :collection, Employee::Collection.new([employee]), @template, {}}
+  let(:arguments){ {form_object: Employee::Collection.new([employee])} }
+  subject{ described_class.new :collection, arguments[:form_object], @template, {}}
   before do
     # http://pivotallabs.com/testing-custom-form-builder/
     @template = Object.new
@@ -17,8 +18,79 @@ RSpec.describe ActionView::Helpers::FormBuilder do
     end
 
     it "does not raise when the object is not a collection object" do
-      form_builder = described_class.new :employee, employee, @template, {}
-      expect{ form_builder.collection_ids }.not_to raise_error
+      arguments[:form_object] = employee
+      expect{ subject.collection_ids }.not_to raise_error
     end
   end
+
+  describe '#get_optional_classes' do
+
+    describe 'active/inactive' do
+      it "does not include active when record has no value" do
+        employee.section = nil
+        subject.get_optional_classes(:section).should_not include'active'
+        subject.get_optional_classes(:section).should include'inactive'
+      end
+
+      it "includes active when record has en empty value" do
+        employee.section = ''
+        subject.get_optional_classes(:section).should include'active'
+        subject.get_optional_classes(:section).should_not include'inactive'
+      end
+
+      it 'includes active when two records have the same value' do
+        employee_2 = Employee.create section: 'SE1'
+        arguments[:form_object] = Employee::Collection.new([employee, employee_2])
+        subject.get_optional_classes(:section).should include'active'
+        subject.get_optional_classes(:section).should_not include'inactive'
+      end
+
+      it 'does not include active when two records have different values' do
+        employee_2 = Employee.create section: 'SE2'
+        arguments[:form_object] = Employee::Collection.new([employee, employee_2])
+        subject.get_optional_classes(:section).should_not include'active'
+        subject.get_optional_classes(:section).should include'inactive'
+      end
+    end
+    
+    describe 'one' do
+      it "includes one if only one record is present" do
+        subject.get_optional_classes(:section).should include'one'
+      end
+
+      it "includes one if the form record is not a collection but a normal record" do
+        arguments[:form_object] = employee
+        subject.get_optional_classes(:section).should include'one'
+      end
+
+      it "does not include one for a collection having more than one records" do
+        employee_2 = Employee.create section: 'SE2'
+        arguments[:form_object] = Employee::Collection.new([employee, employee_2])
+        subject.get_optional_classes(:section).should_not include'one'
+      end
+    end
+
+    describe 'error' do
+      it "has no error class without any arguments set" do
+        subject.get_optional_classes(:section).should_not include'error'
+      end
+
+      it "has no error class with valid argument set" do
+        arguments[:form_object].update(section: 'Se9').should be_truthy
+        subject.get_optional_classes(:section).should_not include'error'
+      end
+
+      it "has error class with invalid argument set" do
+        arguments[:form_object].update(section: 'INVALID NAME').should be false
+        subject.get_optional_classes(:section).should include'error'
+      end
+    end
+
+    describe 'disabled' do
+      it "adds disabled when given as option" do
+        subject.get_optional_classes(:section, disabled: true).should include'disabled'
+      end
+    end
+
+  end
 end

data/spec/record_selection/name_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe RecordCollection::Name do
+  let(:employee){ Employee.create section: 'SE1' }
+  subject{ Employee::Collection.new([employee]).model_name }
+
+  its(:singular_route_key){ should eq 'employee' }
+  its(:route_key){ should eq 'employees' }
+  its(:human){ should eq 'Employees collection' }
+end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 ENV["RAILS_ENV"] = "test"
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 
 require 'pry'
-
 require File.expand_path("../../spec/dummy/config/environment.rb",  __FILE__)
 ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../spec/dummy/db/migrate", __FILE__)]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: record_collection
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Benjamin ter Kuile
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -452,6 +466,7 @@ files:
 - spec/dummy/db/migrate/20150204103712_add_vegan_to_employees.rb
 - spec/dummy/db/migrate/20150204103925_add_admin_to_employees.rb
 - spec/dummy/db/migrate/20150204125014_create_projects.rb
+- spec/dummy/db/migrate/20150721122805_add_description_to_projects.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
@@ -468,6 +483,7 @@ files:
 - spec/fixtures/collections.rb
 - spec/rails/form_builder_spec.rb
 - spec/record_selection/base_spec.rb
+- spec/record_selection/name_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bterkuile/record_collection
 licenses:
@@ -564,6 +580,7 @@ test_files:
 - spec/dummy/db/migrate/20150204103712_add_vegan_to_employees.rb
 - spec/dummy/db/migrate/20150204103925_add_admin_to_employees.rb
 - spec/dummy/db/migrate/20150204125014_create_projects.rb
+- spec/dummy/db/migrate/20150721122805_add_description_to_projects.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
@@ -580,5 +597,6 @@ test_files:
 - spec/fixtures/collections.rb
 - spec/rails/form_builder_spec.rb
 - spec/record_selection/base_spec.rb
+- spec/record_selection/name_spec.rb
 - spec/spec_helper.rb
 has_rdoc: