accepts-flattened-values 0.1.3 → 1.0.0

data/lib/accepts-flattened-values.rb

@@ -0,0 +1,74 @@
+require "active_support/concern"
+require "active_support/core_ext/class/attribute"
+
+module AcceptsFlattenedValues
+  require "accepts-flattened-values/version"
+
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :flattened_values_options, :instance_writer => false
+    self.flattened_values_options = {}
+  end
+
+  module ClassMethods
+    def accepts_flattened_values_for(*attr_names)
+      options = { :separator => ",", :attribute => :value }
+      options.update(attr_names.extract_options!)
+      options.assert_valid_keys(:separator, :attribute)
+
+      attr_names.each do |association_name|
+        if reflection = reflect_on_association(association_name)
+          reflection.options[:autosave] = true
+          add_autosave_association_callbacks(reflection)
+
+          options = options.merge(:klass => reflection.klass)
+          self.flattened_values_options = flattened_values_options.merge(association_name.to_sym => options)
+
+          unless reflection.collection?
+            raise ArugmentError, "Assocation `#{association_name}' must be a has_many or has_and_belongs_to_many."
+          end
+
+          # def pirate_values
+          #   retrieve_flattened_values_for_association(:pirate)
+          # end
+          # def pirate_values=(string)
+          #   assign_flattened_values_for_association(:pirate, string)
+          # end
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            if method_defined?(:#{association_name}_values)
+              remove_method(:#{association_name}_values)
+            end
+            def #{association_name}_values
+              retrieve_flattened_values_for_association(:#{association_name})
+            end
+            if method_defined?(:#{association_name}_values=)
+              remove_method(:#{association_name}_values=)
+            end
+            def #{association_name}_values=(string)
+              assign_flattened_values_for_association(:#{association_name}, string)
+            end
+          RUBY
+        else
+          raise ArgumentError, "No association found for name `#{association_name}'. Has it been defined yet?"
+        end
+      end
+    end
+  end
+
+  protected
+    def retrieve_flattened_values_for_association(association)
+      options = flattened_values_options[association]
+      send(association).map(&options[:attribute]).join(options[:separator])
+    end
+
+    def assign_flattened_values_for_association(association, values)
+      options = flattened_values_options[association]
+      values = values.split(options[:separator])
+
+      records = values.map do |value|
+        options[:klass].where(options[:attribute] => value).first_or_initialize
+      end
+      send("#{association}=", records)
+    end
+end

data/lib/accepts-flattened-values/version.rb

@@ -0,0 +1,3 @@
+module AcceptsFlattenedValues
+  VERSION = "1.0.0"
+end

metadata

@@ -1,92 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: accepts-flattened-values
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Samuel Kadolph
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-13 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
-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
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: accepts-flattened-values is a mixin for ActiveRecord to be used on any
+  model with a has_many or has_and_belongs_to_many association. The purpose of this
+  mixin is to simplify a tag like association for any model or association.
+email:
+- samuel@kadolph.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- CHANGELOG
-- LICENSE
-- README
-files: 
-- CHANGELOG
-- LICENSE
-- README
-- lib/accepts_flattened_values/mixin.rb
-- lib/accepts_flattened_values.rb
-has_rdoc: true
-homepage: http://github.com/samuelkadolph/accepts-flattened-values/wiki
+extra_rdoc_files: []
+files:
+- lib/accepts-flattened-values/version.rb
+- lib/accepts-flattened-values.rb
+homepage: http://samuelkadolph.github.com/accepts-flattened-values/
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --main
-- README
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.21
 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 has_many or
+  has_and_belongs_to_many assocation.
 test_files: []
-

data/CHANGELOG

@@ -1,11 +0,0 @@
-==== accepts-flattened-values 0.1.3
-* updated gem homepage to new github wiki
-
-==== accepts-flattened-values 0.1.2
-* updated gemspec to use activerecord and activesupport 3.0.0.rc
-
-==== 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/LICENSE

@@ -1,22 +0,0 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-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 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

@@ -1,27 +0,0 @@
-== 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.rb

@@ -1,11 +0,0 @@
-require 'active_support'
-
-module AcceptsFlattenedValues
-  extend ActiveSupport::Autoload
-
-  autoload :Mixin
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.send(:include, AcceptsFlattenedValues::Mixin)
-end

data/lib/accepts_flattened_values/mixin.rb

@@ -1,106 +0,0 @@
-module AcceptsFlattenedValues::Mixin
-  extend ActiveSupport::Concern
-
-  included do
-    class_inheritable_accessor :flattened_values_options, :flattened_values_klasses
-    self.flattened_values_options = {}
-    self.flattened_values_klasses = {}
-  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!)
-      options.assert_valid_keys(:separator, :value)
-
-      attr_names.each do |association_name|
-        if reflection = reflect_on_association(association_name)
-          reflection.options[:autosave] = true
-          add_autosave_association_callbacks(reflection)
-          flattened_values_options[association_name.to_sym] = options
-          flattened_values_klasses[association_name.to_sym] = reflection.klass
-
-          unless reflection.collection?
-            raise ArugmentError, "Assocation `#{association_name}' must be a collection."
-          end
-
-          # def pirate_values
-          #   get_flattened_values_for_association(:pirate)
-          # end
-          #
-          # def pirate_values=(values)
-          #   assign_flattened_values_for_association(:pirate, values)
-          # end
-          class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
-            if method_defined?(:#{association_name}_values)
-              remove_method(:#{association_name}_values)
-            end
-            def #{association_name}_values
-              get_flattened_values_for_association(:#{association_name})
-            end
-
-            if method_defined?(:#{association_name}_values=)
-              remove_method(:#{association_name}_values=)
-            end
-            def #{association_name}_values=(values)
-              assign_flattened_values_for_association(:#{association_name}, values)
-            end
-          RUBY_EVAL
-        else
-          raise ArgumentError, "No association found for name `#{association_name}'. Has it been defined yet?"
-        end
-      end
-    end
-  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)
-
-      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]
-      values  = values.split(options[:separator])
-
-      new_ids = []
-      values.each do |value|
-        object = klass.send(:"find_or_create_by_#{options[:value]}", value)
-        new_ids << object.id
-      end
-
-      send(:"#{association_name.to_s.singularize}_ids=", new_ids)
-    end
-end