dynamic_fieldsets 0.0.16 → 0.1.0

data/app/models/dynamic_fieldsets/fieldset_associator.rb

@@ -1,6 +1,6 @@
 module DynamicFieldsets
   class FieldsetAssociator < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_fieldset_associators"
+    self.table_name = "dynamic_fieldsets_fieldset_associators"
 
     belongs_to :fieldset
     belongs_to :fieldset_model, :polymorphic => true
@@ -41,43 +41,18 @@ module DynamicFieldsets
     end
 
     # Returns a hash of field record values
-    # Fun nonintuitive stuff here
     #
-    # The hash keys are field ids
-    # The hash values are field_record values or field_records ids depending on the field type
-    # The hash values are usually strings but sometimes arrays
-    # If a field that expects a single value has multiple values, it will
-    # choose one to use arbitrarily
-    #
-    # multiple_select: [option_ids,]
-    # checkbox: [option_ids,]
-    # select: option_id
-    # radio: option_id
-    # textfield: "value"
-    # textarea: "value"
-    # date: "value"
-    # datetime: "value"
-    # instruction: "value"
+    # This version returns a tree structure for nested fieldsets
+    # Could lead to all sorts of problems
     #
     # @return [Hash] A hash of field record values associated with field ids
     def field_values
-      output = {}
-      self.field_records.each do |record|
-        fieldtype = record.fieldset_child.child.field_type
-        child_id = record.fieldset_child.id
-        if fieldtype == "checkbox" || fieldtype == "multiple_select"
-          output[child_id] = [] unless output[child_id].is_a? Array
-          # note record.id array
-          output[child_id].push record.value.to_i
-        elsif fieldtype == "radio" || fieldtype == "select"
-          # note record.id
-          output[child_id] = record.value.to_i
-        else
-          # note record.value
-          output[child_id] = record.value
-        end
-      end
-      return output
+      fieldset.get_values_using_fsa(self)
+    end
+
+    #  given the params, passes along to the fieldset
+    def update_fieldset_records_with_form_information(fsa_params)
+      fieldset.update_field_records_with_form_information(fsa_params)
     end
 
     # Record whose field matches the name and associator matches the current associator

data/app/models/dynamic_fieldsets/fieldset_child.rb

@@ -3,7 +3,7 @@ module DynamicFieldsets
   # FieldsetChild
   # @author Jeremiah Hemphill, John "hex" Carter
   class FieldsetChild < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_fieldset_children"
+    self.table_name = "dynamic_fieldsets_fieldset_children"
 
     # Constants
 
@@ -46,16 +46,6 @@ module DynamicFieldsets
       self.order_num = self.last_order_num + 1 if self.order_num.nil?
     end
 
-    # Methods
-
-    # Returns a list of all the values in the FIELDSET_CHILD_LIST constant
-    #
-    # @params [None]
-    # @returns [Array] An array of all the values stored in FIELDSET_CHILD_LIST
-    def fieldset_child_list
-      return FIELDSET_CHILD_LIST
-    end
-
     # Sends a validation error if there are any duplicate pairings of fieldsets and fieldset children.
     # 
     # @params [None]
@@ -102,19 +92,42 @@ module DynamicFieldsets
       parent_array.pop
       return false
     end
-    
+
+    # Filters
+
+    # Scopes and Static Methods
+
     scope :ordered, order( 'order_num asc' )
-    
+
+    # Methods
+
     # @return [ActiveRecord::Relation] Collection of FieldsetChildren that are direct descendents; ascending order.
     def children
       FieldsetChild.where( fieldset_id: self.child_id ).ordered
     end
-    
-    # @return [ActiveRecord::Relation] Collection of FieldsetChildren that share the same parent; ascending order.
-    def siblings
-      sib = FieldsetChild.where( fieldset_id: self.fieldset_id ).ordered
-      sib.delete_if{ |child| child.id == self.id }
-      sib
+
+    # Returns a list of all the values in the FIELDSET_CHILD_LIST constant
+    #
+    # @params [None]
+    # @returns [Array] An array of all the values stored in FIELDSET_CHILD_LIST
+    def fieldset_child_list
+      return FIELDSET_CHILD_LIST
+    end
+
+    # returns all the field record values for a single fieldset child
+    #
+    # @param [DynamicFieldsets::FieldsetAssociator] The parent fsa
+    # @return [Hash] A hash of field record values using the fieldset child id as they key
+    def get_value_using_fsa(fsa)
+      output = {}
+      if child.class == DynamicFieldsets::Fieldset
+        return child.get_values_using_fsa(fsa)
+      elsif child.class.superclass == DynamicFieldsets::Field
+        return child.get_values_using_fsa_and_fsc(fsa, self) 
+      else
+        # I am not sure if we need to use child.superclass equals Field due to the sti
+        throw "there is a problem with fieldset_child.get_value_using_fsa possibly due to the single table inheritance."
+      end
     end
     
     # @return [Integer] The order number of the last sibling.
@@ -122,11 +135,6 @@ module DynamicFieldsets
       return 0 if siblings.empty?
       return self.siblings.last[:order_num]
     end
-    
-
-    def to_hash
-      return { "id" => self.id, "fieldset_id" => self.fieldset_id, "child_id" => self.child_id, "child_type" => self.child_type }
-    end
 
     # Returns the root fieldset of the child
     # Loops up the parent fieldset field until the parent is nil, then returns the child
@@ -145,5 +153,16 @@ module DynamicFieldsets
         return root_fieldset(parent_as_a_child.first.fieldset)
       end
     end
+    
+    # @return [ActiveRecord::Relation] Collection of FieldsetChildren that share the same parent; ascending order.
+    def siblings
+      sib = FieldsetChild.where( fieldset_id: self.fieldset_id ).ordered
+      sib.delete_if{ |child| child.id == self.id }
+      sib
+    end
+    
+    def to_hash
+      return { "id" => self.id, "fieldset_id" => self.fieldset_id, "child_id" => self.child_id, "child_type" => self.child_type }
+    end
   end
 end

data/app/models/dynamic_fieldsets/instruction_field.rb

@@ -0,0 +1,35 @@
+module DynamicFieldsets
+  # A special field used only for instruction
+  # No user input is included
+  #
+  # Note that this field does not use the default header and footer partials for the fields
+  class InstructionField < Field
+    # no answers possible, need an include for this?
+
+    def show_partial
+      "/dynamic_fieldsets/show_partials/show_instruction"
+    end
+    # @return [Boolean] False because this field does not have the standard question: answer styling
+    def use_form_header_partial?
+      false
+    end
+
+    # @return [Boolean] False because this field does not have the standard question: answer styling
+    def use_form_footer_partial?
+      false
+    end
+
+    # @return [Hash] The label for the instruction plus the rest of the partial data
+    def form_partial_locals(args)
+      output = super
+      output[:label] = self.label
+      return output
+    end
+
+    # Do not update any options for the instruction
+    def update_field_records(fsa, fieldset_child, value)
+      # do nothing
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/multiple_select_field.rb

@@ -0,0 +1,43 @@
+module DynamicFieldsets
+  # A select field that handles multiple selections
+  #
+  # Even though it just uses a select tag helper with multiple: true, the backend is quite different
+  # from the select field.  It uses the multiple_answers mixin and all of the value and default
+  # methods return arrays instead of strings.
+  class MultipleSelectField < Field
+    acts_as_field_with_field_options
+    acts_as_field_with_multiple_answers
+
+    # @return [Hash] Sets multiple to true along with the standard arguments
+    def html_attribute_hash
+      super.merge!({
+        :multiple => true
+      })
+    end
+
+    # @return [Hash] data for the form partial
+    def form_partial_locals(args)
+      super.merge!({
+        :selected_ids => values_or_defaults_for_form(args[:values]),
+        :collection => self.options
+      })
+    end
+
+    # this returns field option ids based on the field default values
+    # due to funness with field options
+    #
+    # there is a good chance this is only needed due to a bug in multiple select's save default method 
+    # We may need to take a look at this in the future.  I think it could be moved to a mixin. (JH 2-28-2012)
+    # @return [Array] An array of field option ids that correspond to the field defaults
+    def collect_default_values
+      output = []
+      field_defaults.each do |default|
+        # find a field option with the same name as the default
+        # add it's id to the output
+        output << field_options.select { |option| option.name == default.value }.first.id
+      end
+      return output
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/radio_field.rb

@@ -0,0 +1,27 @@
+module DynamicFieldsets
+  # Radio buttons input
+  class RadioField < Field
+    acts_as_field_with_field_options
+    acts_as_field_with_single_answer
+
+    # Note that the radio buttons need special data per field option
+    # output[:options] contains information for each of the field options for the radio field
+    #
+    # @return [Hash] Data needed for the radio buttons partial
+    def form_partial_locals(args)
+      output = super
+      output[:options] = []
+      field_options.each do |option|
+        output[:options] << {
+          :name => "#{DynamicFieldsets.config.form_fieldset_associator_prefix}#{args[:fsa].id}[#{DynamicFieldsets.config.form_field_prefix}#{args[:fieldset_child].id}]",
+          :value => option.id.to_s,
+          :checked => value_or_default_for_form(args[:values]).eql?(option.id.to_s),
+          :html_attributes => html_attribute_hash,
+          :label => option.name,
+        }
+      end
+      return output
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/select_field.rb

@@ -0,0 +1,16 @@
+module DynamicFieldsets
+  # Select input with one selection possible
+  class SelectField < Field
+    acts_as_field_with_field_options
+    acts_as_field_with_single_answer
+
+    # @return [Hash] data for the form partial
+    def form_partial_locals(args)
+      super.merge({
+        :selected_id => value_or_default_for_form(args[:value]).to_i,
+        :collection => self.options
+      })
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/text_field.rb

@@ -0,0 +1,14 @@
+module DynamicFieldsets
+  # Text field input
+  class TextField < Field
+    acts_as_field_with_single_answer
+
+    # @return [Hash] data for the form partial
+    def form_partial_locals(args)
+      output = super
+      output[:attrs][:value] = value_or_default_for_form(args[:value])
+      return output
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/textarea_field.rb

@@ -0,0 +1,40 @@
+module DynamicFieldsets
+  # Textarea input
+  #
+  # Note that this one is a little different than normal because the textarea does not store it's data
+  # in a value attribute
+  class TextareaField < Field
+    acts_as_field_with_single_answer
+
+    # @return [Integer] Default number of columns for the textarea
+    def default_cols
+      40
+    end
+
+    # @return [Integer] Default number of rows for the textarea
+    def default_rows
+      6
+    end
+
+    # @return [Hash] Html attributes for the textarea with default cols and rows if none are set
+    def html_attribute_hash
+      # this should get overriden by attributes the user sets
+      # with the call to super
+      output = {
+        :cols => default_cols,
+        :rows => default_rows,
+      }
+      output.merge!(super)
+      return output
+    end
+
+    # @return [Hash] Data for the form partial
+    def form_partial_locals(args)
+      output = super
+      output[:content] = value_or_default_for_form(args[:value])
+      output[:attrs][:name] = output[:name]
+      return output
+    end
+  end
+end
+

data/app/views/dynamic_fieldsets/fields/_form.html.erb

@@ -1,63 +1,61 @@
-<%= form_for(@field) do |f| %>
-  <% if @field.errors.any? %>
-    <div id="error_explanation">
-      <h2><%= pluralize(@field.errors.count, "error") %> prohibited this field from being saved:</h2>
-
-      <ul>
-      <% @field.errors.full_messages.each do |msg| %>
-        <li><%= msg %></li>
-      <% end %>
-      </ul>
-    </div>
-  <% end %>
-  
-  <%= hidden_field_tag :parent, params[:parent] %>
+<% if @field.errors.any? %>
+  <div id="error_explanation">
+    <h2><%= pluralize(@field.errors.count, "error") %> prohibited this field from being saved:</h2>
 
-  <div class="field">
-    <%= f.label :name %>: (internal)<br/>
-    <%= f.text_field :name %>
-  </div>
-  <div class="field">
-    <%= f.label :label %>: (displayed on the form)<br/>
-    <%= f.text_field :label %>
+    <ul>
+    <% @field.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
   </div>
+<% end %>
 
-  <div class="field">
-    <%= f.label :field_type %>: 
-    <%= f.select :field_type, options_for_select(DynamicFieldsets::Field.field_types, @field.field_type), :include_blank => "Choose One" %>
-  </div>
-  <% @field.field_options.each do |field_option| %>
-    <%= f.fields_for :field_options, field_option do |field_option_form| %>
-      <%= render :partial => "field_option_fields", :locals => {:f => field_option_form} %>
-    <% end %>
-  <% end %>
-  <p><%= link_to_add_fields "Add Field Option", f, :field_options %></p>
+<%= hidden_field_tag :parent, params[:parent] %>
 
-  <div class="field">
-    <%= f.label :required %>
-    <%= f.check_box :required %>
-  </div>
-  <div class="field">
-    <%= f.label :enabled %>
-    <%= f.check_box :enabled %>
-  </div>
+<div class="field">
+  <%= f.label :name %>: (internal)<br/>
+  <%= f.text_field :name %>
+</div>
+<div class="field">
+  <%= f.label :label %>: (displayed on the form)<br/>
+  <%= f.text_field :label %>
+</div>
 
-  <% @field.field_defaults.each do |field_default| %>
-    <%= f.fields_for :field_defaults, field_default do |field_default_form| %>
-      <%= render :partial => "field_default_fields", :locals => {:f => field_default_form, :obj => field_default} %>
-    <% end %>
+<div class="field">
+  <%= f.label :type %>: 
+  <%= f.select :type, options_for_select(DynamicFieldsets::Field.descendant_collection, @field.type), :include_blank => "Choose One" %>
+</div>
+<% @field.field_options.each do |field_option| %>
+  <%= f.fields_for :field_options, field_option do |field_option_form| %>
+    <%= render :partial => "field_option_fields", :locals => {:f => field_option_form} %>
   <% end %>
-  <p><%= link_to_add_fields "Add Default Value", f, :field_defaults %></p>
+<% end %>
+<p><%= link_to_add_fields "Add Field Option", f, :field_options %></p>
 
-  <% @field.field_html_attributes.each do |field_html_attribute| %>
-    <%= f.fields_for :field_html_attributes, field_html_attribute do |field_html_attribute_form| %>
-      <%= render :partial => "field_html_attribute_fields", :locals => {:f => field_html_attribute_form} %>
-    <% end %>
+<div class="field">
+  <%= f.label :required %>
+  <%= f.check_box :required %>
+</div>
+<div class="field">
+  <%= f.label :enabled %>
+  <%= f.check_box :enabled %>
+</div>
+
+<% @field.field_defaults.each do |field_default| %>
+  <%= f.fields_for :field_defaults, field_default do |field_default_form| %>
+    <%= render :partial => "field_default_fields", :locals => {:f => field_default_form, :obj => field_default} %>
   <% end %>
-  <p><%= link_to_add_fields "Add Html Attribute", f, :field_html_attributes %></p>
+<% end %>
+<p><%= link_to_add_fields "Add Default Value", f, :field_defaults %></p>
 
-  <div class="actions">
-    <%= f.submit %>
-  </div>
+<% @field.field_html_attributes.each do |field_html_attribute| %>
+  <%= f.fields_for :field_html_attributes, field_html_attribute do |field_html_attribute_form| %>
+    <%= render :partial => "field_html_attribute_fields", :locals => {:f => field_html_attribute_form} %>
+  <% end %>
 <% end %>
+<p><%= link_to_add_fields "Add Html Attribute", f, :field_html_attributes %></p>
+
+<div class="actions">
+  <%= f.submit %>
+</div>
 <%= render :partial => "/dynamic_fieldsets/shared/nested_model_javascript" %>