accepts-flattened-values 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,2 +1,5 @@
-==== accepts-flattened-values 1.0.0
+==== accepts-flattened-values 0.1.1
+* renamed accepts-flattened-values.rb so it won't be auto required
+
+==== accepts-flattened-values 0.1.0
 * Initial version

data/README

@@ -0,0 +1,27 @@
+== accepts-flattened-values
+
+accepts-flattenved-values is a mixin for ActiveRecord to be used on any model with a has_many or
+has_and_belongs_to_many association. The primary purpose of this mixin is to simplify a tag like association for any
+model or association.
+
+== Getting Started
+
+
+== Example
+
+    create_table :users do { |t| t.string :name, :null => false }
+    create_table :interests do { |t| t.string :value, :null => false }
+    create_table :interests_users, :id => false { |t| t.references :interest; t.references :user }
+
+    class User < ActiveRecord::Base
+      accepts_flattened_values_for :interests
+    end
+
+    u = User.create(:name => "Sam")
+    u.interests.create(:value => "ruby")
+    u.interests.create(:value => "ruby on rails")
+    u.interests.create(:value => "soccer")
+
+    u.interests_values # => "ruby,ruby on rails,soccer"
+    u.interests_values = "ruby,soccer,whatever"
+    u.interests # => [#<Interest value: "ruby">, <Interest value: "soccer">, <Interest value: "whatever">]

data/lib/accepts_flattened_values/mixin.rb

@@ -10,6 +10,30 @@ module AcceptsFlattenedValues::Mixin
   end
 
   module ClassMethods
+    # == Flattened Values
+    #
+    # Flattened values allow you to save single value entities in a has_many or has_and_belongs_to_many association.
+    # By default flattened values updating is turned off, you can enable it using the accepts_flattened_values_for
+    # class method. When you enable flattened values an attribute writer is defined on the model.
+    #
+    # The attribute writer is named after the association, which means that
+    # in the following example, two new methods are added to your model:
+    # <tt>interests_values=(values)</tt> and
+    # <tt>skills_values=(values)</tt>.
+    #
+    #   class User < ActiveRecord::Base
+    #     has_many :interests
+    #     has_many :skills
+    #
+    #     accepts_nested_attributes_for :interests, :skills
+    #   end
+    #
+    # Note that the <tt>:autosave</tt> option is automatically enabled on every
+    # association that accepts_flattened_values_for is used for.
+    #
+    # === Options
+    # * <tt>:separator</tt> the separator used to join and split the string value. Defaults to ','
+    # * <tt>:value</tt> the field to use for the string values on the associatied model. Defaults to ':value'
     def accepts_flattened_values_for(*attr_names)
       options = { :separator => ',', :value => :value }
       options.update(attr_names.extract_options!)
@@ -56,6 +80,8 @@ module AcceptsFlattenedValues::Mixin
   end
 
   private
+    # Collects the <tt>options[:value]</tt>field from all the entities from an association and joins them together
+    # into a single string separated by <tt>options[:separator]</tt>.
     def get_flattened_values_for_association(association_name)
       options     = flattened_values_options[association_name]
       association = send(association_name)
@@ -63,6 +89,9 @@ module AcceptsFlattenedValues::Mixin
       association.collect(&options[:value]).join(options[:separator])
     end
 
+    # Splits the given string with <tt>options[:separator]</tt> and for each value, calls
+    # <tt>find_or_create_by_#{option[:value]}</tt> then adds the existing or new entity's id to an array and assigns
+    # the array to <tt>singular_ids=</tt>.
     def assign_flattened_values_for_association(association_name, values)
       options = flattened_values_options[association_name]
       klass   = flattened_values_klasses[association_name]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Samuel Kadolph
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-19 00:00:00 -04:00
+date: 2010-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 3
@@ -37,7 +37,7 @@ dependencies:
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 3
@@ -47,27 +47,30 @@ dependencies:
         version: 3.0.0.beta4
   type: :runtime
   version_requirements: *id002
-description: accepts-flattened-values is mixin for activerecord that flattens single values from a has and belongs to many assocations into a string and vice versa.
+description: accepts-flattened-values is mixin for ActiveRecord that flattens single values from a has_many or has_and_belongs_to_many assocation into a string and vice versa.
 email: samuel@kadolph.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- CHANGELOG
+- README
+- LICENSE
 files: 
 - CHANGELOG
 - README
 - LICENSE
-- lib/accepts-flattened-values.rb
 - lib/accepts_flattened_values/mixin.rb
+- lib/accepts_flattened_values.rb
 has_rdoc: true
-homepage: http://github.com/samuelkadolph/accepts-flattened-values
+homepage: http://wiki.github.com/samuelkadolph/accepts-flattened-values/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -90,6 +93,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: accepts-flattened-values is an activerecord mixin to flatten a habtm assocation.
+summary: accepts-flattened-values is an ActiveRecord mixin to flatten a habtm assocation.
 test_files: []