checkboxes 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+.yardoc
+doc
+spec/dummy/log/*.log

data/.infinity_test

@@ -0,0 +1,3 @@
+infinity_test do
+   use :rubies => %w(1.8.7@3.x 1.9.2@3.x), :test_framework => :rspec
+end

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--tty
+--format nested

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.textile

@@ -0,0 +1,58 @@
+h2. Introduction
+
+This gem will help you to handle _has_many :through_ associations when you need to add/remove these ones with checkboxes. If you think about this type of situation you do the same steps for each association you have to handle with checkboxes. I exctracted this gem from a project where I had to handle about ten associations with checkboxes.
+
+h2. How to use it
+
+The best way to describe throughcheckboxes is to show some code:
+
+In your model:
+
+<pre>
+class User < ActiveRecord::Base
+    has_many :groups,:through=>:user_groups
+    has_many :user_groups
+    # add your associations
+    checkboxes_for :groups
+end
+
+class Group < ActiveRecord::Base
+    attr_accessible :name
+
+    def to_s
+        name
+    end
+end
+
+class UserGroup < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :group
+end
+</pre>
+
+In your view:
+
+<pre>
+<%= form_for @user do |f| %>
+  <%= f.error_messages %>
+  <%= f.checkboxes_for :groups  %>
+  </p>
+  <p><%= f.submit %></p>
+<% end %>
+</pre>
+
+and that's all. Now, when you submit your form you get the has_many :through association updated.
+
+h2. Roadmap
+
+* improve documentation
+* write options for helper
+* write more helpers
+
+h2. Copyright
+
+This program is free software. It comes without any warranty,
+to the extent permitted by applicable law. You can redistribute
+it and/or modify it under the terms of the Do What The Fuck You
+Want To Public License, Version 2, as published by Sam Hocevar.
+See http://sam.zoy.org/wtfpl/COPYING for more details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs'
+task :default => :spec  
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/checkboxes.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "checkboxes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "checkboxes"
+  s.version     = Checkboxes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["lucapette"]
+  s.email       = ["lucapette@gmail.com"]
+  s.homepage    = "https://github.com/lucapette/checkboxes"
+  s.summary     = %q{This gem will handle has_many :through association with checkboxes}
+  s.description = %q{This gem will help you to handle has_many :through associations when you need to add/remove these ones with checkboxes.}
+
+  s.rubyforge_project = "checkboxes"
+  s.add_development_dependency 'sqlite3'
+  s.add_dependency "rails", ">= 3.0.0"
+  s.add_development_dependency "rspec-rails", ">= 2.5.0"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "factory_girl"
+  s.add_development_dependency "rspec_tag_matchers"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/checkboxes.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'action_view'
+require 'checkboxes/core'
+require 'checkboxes/methods'
+require 'checkboxes/helpers'
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send :include, Checkboxes::Methods
+end
+
+if defined?(ActionView::Helpers::FormBuilder)
+  ActionView::Helpers::FormBuilder.send :include,Checkboxes::Helpers::FormBuilderExtension
+end

data/lib/checkboxes/core.rb

@@ -0,0 +1,48 @@
+module Checkboxes
+
+  module Core # This module contains utility methods for both extensions and helpers.
+
+    class CheckboxesNameError <  StandardError; end
+
+    extend self
+
+    # Checks the validity of the relations
+    # on a given class.
+    # A relation will be valid:
+    # * It exists
+    # * It's an _has_many
+    # * It uses the _through_ option
+    # @todo makes error raised more specific
+    # @raise CheckboxesNameError Generic Error
+    # @return [boolean] It returns _true_, it raises an exception if the validation fails.
+    def validate(klass, *relations)
+      for relation in relations
+        unless (klass.reflections[relation].present? &&
+                klass.reflections[relation].macro == :has_many &&
+                klass.reflections[relation].options[:through].present?)
+          raise CheckboxesNameError, "#{relation} isn't an has_many :through for model #{klass}, check it out please."
+        end
+      end
+    end
+
+    # Returns the class of a relation of
+    # of a given class.
+    # It cares about the _source_ option of the
+    # _has_many_.
+    # @return [class]
+    def relation_klass(klass, relation)
+      source=klass.reflections[relation].options[:source]
+      relation_klass = source.present? ? source.to_s : relation.to_s
+      relation_klass.classify.constantize
+    end
+
+    # Returns a pattern name for the attr_accessor used for handling checkboxes.
+    # @return [String]
+    def field_name(relation)
+      "__#{relation}_ids"
+    end
+
+
+  end
+
+end

data/lib/checkboxes/helpers.rb

@@ -0,0 +1,25 @@
+module Checkboxes
+
+  module Helpers
+
+    module FormBuilderExtension
+
+      def checkboxes_for(relation)
+
+        field_name=Checkboxes::Core.field_name(relation)
+
+        output = ""
+        output << "#{self.label(relation)}<br />"
+        for record in Checkboxes::Core.relation_klass(self.object.class, relation).all
+          output << @template.check_box_tag("#{@object_name}[#{field_name}][]",record.id,self.object.send(relation).include?(record),:id=>record)
+          output << "#{record}<br />"
+        end
+        output << @template.hidden_field_tag("#{@object_name}[#{field_name}][]")
+        output.html_safe
+      end
+
+    end
+
+  end
+
+end

data/lib/checkboxes/methods.rb

@@ -0,0 +1,43 @@
+module Checkboxes
+
+  # This module contains all the methods that _concern_ with
+  # ActiveRecord::Base.
+  module Methods
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Use it in your model for the relations you need to
+      # handle with checkboxes.
+      # @return [nil]
+      # @raise CheckboxesNameError If any relation is not valid.
+      def checkboxes_for(*relations)
+
+        klass = self
+
+        Checkboxes::Core.validate(klass, *relations)
+
+        relations.each do |relation|
+
+          field_name=Checkboxes::Core.field_name(relation)
+
+          attr_accessible field_name.to_sym
+
+          define_method "#{field_name}=" do |ids|
+            send("#{relation}=",ids.select { |id| id.present? }.map {|id| Checkboxes::Core.relation_klass(klass, relation).find(id)})
+          end
+
+          define_method field_name do
+            send("#{relation}").map {|e| e.id}
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/checkboxes/version.rb

@@ -0,0 +1,3 @@
+module Checkboxes
+  VERSION = "0.0.1"
+end

data/spec/checkboxes/helpers_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe "helper method" do
+
+  before(:each) do
+    @user = Factory(:user)
+    @template = ActionView::Base.new
+    @builder = ActionView::Helpers::FormBuilder.new(:user, @user, @template, {}, proc {})
+  end
+
+  context "with a bad relation" do
+    it "raises an exception" do
+      lambda { @builder.checkboxes_for :groupes }.should raise_error
+    end
+  end
+
+  context "with a good relation" do
+
+    before(:each) do
+      @user.groups << Factory(:group)
+      @output_buffer = @builder.checkboxes_for :groups
+    end
+
+    it "contains a label for the given relation" do
+      @output_buffer.should have_tag("label",/#{:groups.to_s.camelize}/)
+    end
+
+    it "contains a checked checkbox for each relation" do
+      @output_buffer.should have_tag("input[@checked]", :count=>@user.groups.count)
+    end
+
+  end
+
+end

data/spec/checkboxes/integration_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+feature "adding association using checkboxes" do
+  before(:all) do
+    class User < ActiveRecord::Base
+      checkboxes_for :groups
+    end
+  end
+
+  it "should add the checked association" do
+    @user = Factory.create(:user)
+    @groups=FactoryGirl.create_list(:group, 2)
+    @g1 = @groups.first
+
+    visit edit_user_path(@user)
+    check(@g1.to_s)
+    click_on('Update User')
+
+    page.should have_content(@g1.to_s)
+  end
+
+  it "should remove the unchecked association" do
+    @user = Factory.create(:user)
+    @g1 =  Factory.create(:group)
+
+    @user.groups << @g1
+
+    visit edit_user_path(@user)
+    uncheck(@g1.to_s)
+
+    click_on('Update User')
+
+    page.should have_no_content(@g1.to_s)
+  end
+end

data/spec/checkboxes/methods_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe "checkboxes_for" do
+
+  context "with a bad relation" do
+    it "raises an exception" do
+      lambda {
+        class User
+          checkboxes_for :gropues
+        end
+      }.should raise_error(Checkboxes::Core::CheckboxesNameError)
+    end
+  end
+
+  context "with a good association" do
+
+    before(:each) do
+      class User
+        checkboxes_for :groups
+      end
+      @user = Factory(:user)
+    end
+
+    it "adds instance getter" do
+      @user.should respond_to Checkboxes::Core::field_name(:groups)
+    end
+
+    it "adds instance setter" do
+      @user.should respond_to "#{Checkboxes::Core::field_name(:groups)}=".to_sym
+    end
+
+    it "saves relations through added method" do
+      g1 = Factory(:group)
+      g2 = Factory(:group)
+      @user.send("#{Checkboxes::Core::field_name(:groups)}=",[g1.id, g2.id])
+      @user.should have(2).groups
+    end
+
+    it "delete relations through added method" do
+      g1 = Factory(:group)
+      g2 = Factory(:group)
+      @user.send("#{Checkboxes::Core::field_name(:groups)}=",[g1.id, g2.id])
+      @user.send("#{Checkboxes::Core::field_name(:groups)}=",[g1.id])
+      @user.groups.should_not include g2
+    end
+
+  end
+
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/welcome.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/welcome.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/controllers/application_controller.rb

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

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,41 @@
+class UsersController < ApplicationController
+  def index
+    @users = User.all
+  end
+
+  def show
+    @user = User.find(params[:id])
+  end
+
+  def new
+    @user = User.new
+  end
+
+  def create
+    @user = User.new(params[:user])
+    if @user.save
+      redirect_to @user, :notice => "Successfully created user."
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @user = User.find(params[:id])
+  end
+
+  def update
+    @user = User.find(params[:id])
+    if @user.update_attributes(params[:user])
+      redirect_to @user, :notice  => "Successfully updated user."
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @user = User.find(params[:id])
+    @user.destroy
+    redirect_to users_url, :notice => "Successfully destroyed user."
+  end
+end