throughcheckboxes 0.0.4 → 0.0.5

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.yardoc
+doc

data/README.textile

@@ -1,3 +1,41 @@
-Very beta rails gem. No docs, no tests.
+h2. Introduction
 
-I'll try to provide them soon.
+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
+
+  # adds your associations
+  checkboxes_for :groups
+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
+
+* write tests
+* write options for helper
+* write more helpers

data/lib/throughcheckboxes/checkboxes_for.rb

@@ -1,11 +1,17 @@
 module ThroughCheckboxes
 
+    # This module contains all the methods that _concern_ with
+    # ActiveRecord::Base.
     module Checkboxesfor
 
         extend ActiveSupport::Concern
 
         module ClassMethods
 
+            # Use it in your model for the relations you need to
+            # handle with checkboxes.
+            # @return [nil]
+            # @raise ThroughCheckboxesNameError If any relation is  not valid.
             def checkboxes_for(*relations)
 
                 klass = self

data/lib/throughcheckboxes/core.rb

@@ -1,12 +1,21 @@
 module ThroughCheckboxes
 
-    module Core
+    module Core # This module contains utility methods for both extensions and helpers.
 
         class ThroughCheckboxesNameError <  StandardError; end
 
-        def self.validate(klass, *relations)
+        # 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 ThroughCheckboxesNameError 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? && 
+                unless (klass.reflections[relation].present? &&
                         klass.reflections[relation].macro == :has_many &&
                         klass.reflections[relation].options[:through].present?)
                     raise ThroughCheckboxesNameError, "#{relation} isn't an has_many :through for model #{klass}, check it out please."
@@ -14,16 +23,24 @@ module ThroughCheckboxes
             end
         end
 
-        def self.relation_klass(klass, relation)
+        # 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
 
-        def self.field_name(relation)
+        # Returns a pattern name for the attr_accessor used for handling checkboxes.
+        # @return [String]
+        def field_name(relation)
             "#{relation}_ids"
         end
 
+        extend self
 
     end
     

data/lib/throughcheckboxes/version.rb

@@ -1,3 +1,3 @@
-module Throughcheckboxes
-  VERSION = "0.0.4"
+module ThroughCheckboxes
+  VERSION = "0.0.5"
 end

data/throughcheckboxes.gemspec

@@ -4,7 +4,7 @@ require "throughcheckboxes/version"
 
 Gem::Specification.new do |s|
   s.name        = "throughcheckboxes"
-  s.version     = Throughcheckboxes::VERSION
+  s.version     = ThroughCheckboxes::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["lucapette"]
   s.email       = ["lucapette@gmail.com"]

metadata

@@ -2,7 +2,7 @@
 name: throughcheckboxes
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - lucapette
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-13 00:00:00 +01:00
+date: 2011-03-19 00:00:00 +01:00
 default_executable: 
 dependencies: []