dynamic_fieldsets 0.0.16 → 0.1.0

data/app/models/dynamic_fieldsets.rb

@@ -0,0 +1,2 @@
+module DynamicFieldsets
+end

data/app/models/dynamic_fieldsets/checkbox_field.rb

@@ -0,0 +1,29 @@
+module DynamicFieldsets
+  # Creates checkbox tags on a form
+  #
+  # Includes support for predefined field options and multiple selected answers
+  class CheckboxField < Field
+    acts_as_field_with_field_options
+    acts_as_field_with_multiple_answers
+
+    # Note that the checkbox needs individual data for each of the included options
+    # This means that some things, such as the name are duplicated for each field option
+    # 
+    #
+    # @return [Hash] Data needed for the checkbox form 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 => values_or_defaults_for_form(args[:values]).include?(option.id.to_s),
+          :label => option.name,
+          :html_attributes => html_attribute_hash
+        }
+      end
+      return output
+    end 
+  end
+end

data/app/models/dynamic_fieldsets/date_field.rb

@@ -0,0 +1,37 @@
+module DynamicFieldsets
+  # Creates date tags on a form
+  #
+  # The date tag currently defaults to the current date if nothing is set with the year range starting 70 years in the past
+  #
+  # The value of the input is stored as a string so costly Date.parse calls are used to parse the string
+  # This may have to be changed in the future
+  class DateField < Field
+    acts_as_field_with_single_answer
+
+    # Returns the current value if set, then the default value if set, then the current date as a Date object
+    #
+    # @return [Date] The current time stored in the date field
+    def get_date_or_today(value)
+      default_date = value_or_default_for_form(value)
+      if default_date.empty?
+        return Date.today
+      else
+        # not sure why Date.parse doesn't work here
+        return Time.parse(default_date)
+      end
+    end
+
+    # Includes information used in the date_options argument (third) on the date select helper
+    #
+    # @return [Hash] Data for the date form partial
+    def form_partial_locals(args)
+      output = super
+      output[:date_options] = { 
+        :start_year => Time.now.year - 70,
+        :default => get_date_or_today(args[:value])
+      }
+      return output
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/datetime_field.rb

@@ -0,0 +1,36 @@
+module DynamicFieldsets
+  # Creates datetime tags on a form
+  #
+  # The datetime tag currently defaults to the current time if nothing is set with the year range starting 70 years in the past
+  #
+  # The value of the input is stored as a string so costly Time.parse calls are used to parse the string
+  # This may have to be changed in the future
+  class DatetimeField < Field
+    acts_as_field_with_single_answer
+
+    # Returns the current value if set, then the default value if set, then the current time as a Time object
+    #
+    # @return [Time] The current time stored in the datetime field
+    def get_datetime_or_today(value)
+      default_time = value_or_default_for_form(value)
+      if default_time.empty?
+        return Time.now
+      else
+        return Time.parse(default_time)
+      end
+    end
+
+    # Includes information used in the date_options argument (third) on the date select helper
+    #
+    # @return [Hash] Data for the datetime form partial
+    def form_partial_locals(args)
+      output = super
+      output[:date_options] = { 
+        :start_year => Time.now.year - 70,
+        :default => get_datetime_or_today(args[:value])
+      }
+      return output
+    end
+  end
+end
+

data/app/models/dynamic_fieldsets/dependency.rb

@@ -4,7 +4,7 @@ module DynamicFieldsets
   #
   # @author John "hex" Carter
   class Dependency < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_dependencies"
+    self.table_name = "dynamic_fieldsets_dependencies"
 
     RELATIONSHIP_LIST = ["equals","not equals","includes","not includes","blank","not blank"]
 

data/app/models/dynamic_fieldsets/dependency_clause.rb

@@ -3,7 +3,7 @@ module DynamicFieldsets
   #
   # @author Jeremiah Hemphill
   class DependencyClause < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_dependency_clauses"
+    self.table_name = "dynamic_fieldsets_dependency_clauses"
     belongs_to :dependency_group  
 
     has_many :dependencies

data/app/models/dynamic_fieldsets/dependency_group.rb

@@ -1,6 +1,6 @@
 module DynamicFieldsets
   class DependencyGroup < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_dependency_groups"
+    self.table_name = "dynamic_fieldsets_dependency_groups"
     belongs_to :fieldset_child
 
     has_many :dependency_clauses

data/app/models/dynamic_fieldsets/field.rb

@@ -3,8 +3,9 @@ module DynamicFieldsets
   #
   # @author Jeremiah Hemphill, Ethan Pemble
   class Field < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_fields"
-    # Relations
+    self.table_name = "dynamic_fieldsets_fields"
+
+    # Associations
     
     # parents
     has_many :fieldset_children, :dependent => :destroy, :as => :child
@@ -25,67 +26,194 @@ module DynamicFieldsets
     # Validations
     validates_presence_of :name
     validates_presence_of :label
-    validates_presence_of :field_type
+    validates_presence_of :type
     validates_inclusion_of :enabled, :in => [true, false]
     validates_inclusion_of :required, :in => [true, false]
-    validate :has_field_options, :field_type_in_field_types
 
-    # validates inclusion of wasn't working so I made it a custom validation
-    # refactor later when I figure out how rails works
-    def field_type_in_field_types
-      if !Field.field_types.include?(self.field_type)
-        self.errors.add(:field_type, "The field type must be one of the available field types.")
+
+    # Scopes and Static Methods
+
+    # Either calls the defaul descendants method or pulls the data from the config
+    # Deals with weird single table inheritance issues with cache classes off
+    # Causes errors only in development mode
+    #
+    # @return [Array<String>] An array of descendant class names
+    def self.descendants
+      if ::Rails.application.config.cache_classes
+        super
+      else
+        DynamicFieldsets.config.available_field_types
       end
     end
     
-    # Custom validation for fields with multiple options on update
-    def has_field_options
-      if options? && self.field_options.empty?
-        self.errors.add(:field_options, "This field must have options")
-      end
+    # @return [Array<String>] Humanized collection of descendants
+    def self.descendant_collection
+      descendants.collect { |d| [d.to_s.gsub("DynamicFieldsets::", "").underscore.humanize, d.to_s ] }
     end
+    
+    # Form partial Methods
 
-    # @returns [Array] An array of allowable field types
-    def self.field_types
-      ["select", "multiple_select", "checkbox", "radio", "textfield", "textarea", "date", "datetime", "instruction"]
+    # @return [String] Name of partial to render for the form
+    def form_partial
+      "/dynamic_fieldsets/form_partials/" + self.class.to_s.gsub("DynamicFieldsets::", "").underscore
     end
 
-    # @returns [Array] An array of field types that use options
-    def self.option_field_types
-      ["select", "multiple_select", "checkbox", "radio"]
+    # @return [String] Name of the input header for the form
+    def form_header_partial
+      "/dynamic_fieldsets/form_partials/input_header"
     end
-    
-    # @return [Boolean] True if the field is of type 'select', 'multiple_select', 'radio', or 'checkbox'
-    def options?
-      Field.option_field_types.include? self.field_type
+
+    # @return [Boolean] By default, use the header partial
+    def use_form_header_partial?
+      true
     end
-    
-    # @return [FieldOptions] Returns all field options that are enabled
-    def options
-      return self.field_options.reject{ |option| !option.enabled }
+
+    # @return [String] Name of the input footer for the form
+    def form_footer_partial
+      "/dynamic_fieldsets/form_partials/input_footer"
     end
-    
+
+    # @return [Boolean] By default, use the footer partial
+    def use_form_footer_partial?
+      true
+    end
+
+    # @return [Hash] Data needed for the form partial
+    def form_partial_locals(args)
+      output = {
+        :fsa => args[:fsa],
+        :fieldset_child => args[:fieldset_child],
+        :attrs => self.html_attribute_hash,
+        # for use in helpers like text_field and date_select
+        :object => "#{DynamicFieldsets::config.form_fieldset_associator_prefix}#{args[:fsa].id}",
+        :method => "#{DynamicFieldsets::config.form_field_prefix}#{args[:fieldset_child].id}",
+      }
+      # name for use in helpers like select_tag, check_box_tag, or anything ending with _tag
+      # this is more of a convenience method
+      output[:name] = "#{output[:object]}[#{output[:method]}]"
+      output[:id] = "#{output[:object]}_#{output[:method]}"
+      return output
+    end
+
+    # @return [Hash] A hash of html attribute key: value pairs
+    def html_attribute_hash
+      attrs = {}
+      field_html_attributes.each{ |a| attrs.merge! a.attribute_name.to_sym => a.value } if !field_html_attributes.empty?
+      return attrs
+    end
+     
+    # Show partial Methods
+
+    # This method must be overriden
+    #
+    # @return [String] Name of partial to render for the show page
+    def show_partial
+      "/dynamic_fieldsets/show_partials/show_incomplete"
+    end
+
+    # This method must be overriden if show_header_partial returns true
+    #
+    # @return [String] Name of the input header for the show
+    def show_header_partial
+      "/dynamic_fieldsets/show_partials/show_incomplete_header"
+    end
+
+    # @return [Boolean] By default, do not use the header partial
+    def use_show_header_partial?
+      false
+    end
+
+    # This method must be overriden if show_footer_partial returns true
+    #
+    # @return [String] Name of the input footer for the show
+    def show_footer_partial
+      "/dynamic_fieldsets/show_partials/show_incomplete_footer"
+    end
+
+    # @return [Boolean] By default, do not use the footer partial
+    def use_show_footer_partial?
+      false
+    end
+
+    # Note that this method is really weird
+    # You would think that the value displayed should be figured out here
+    # but instead, it is figured out first, then passed in, in the arguments hash
+    #
+    # @return [Hash] Information needed for the show partial, don't know what I need yet
+    def show_partial_locals(args)
+      # these should be incredibly temporary
+      {
+        :value => args[:value],
+        :values => args[:values],
+        :label => self.label,
+      }
+    end
+
+    # given a value hash for a field, return the part that needs to be shown on the show page
+    def get_value_for_show(value)
+      value[:value]
+    end
+
+    # Other Methods
+
     # @return [Boolean] False if field_default.value is empty
     def has_defaults?
       return self.field_defaults.length > 0
     end
-    
-    # @return [Array] Alias for field_defaults
-    def defaults
-      return self.field_defaults if options?
-      return nil
-    end
-    
-    # @return [String] Alias for field_defaults.first
-    def default
-      return nil if options?
-      return self.field_defaults.first
-    end
 
     # @return [Boolean] True if there are any field records for the field or if it is in any fieldsets
     def in_use?
       self.fieldset_children.count { |child| !child.fieldset_id.nil? || !child.field_records.empty? } > 0
     end
-    
+
+    # Fields such as selects, checkboxes, and radios use predefined field options for their values
+    # By default, a field does not use field options
+    #
+    # @return [Boolean] Whether the field uses field options, defaults to false
+    def uses_field_options?
+      false
+    end
+
+    # this collects defaults so that we can use them for fields
+    # note that this should be overridden when the field uses field options
+    # in that case, it should return field option ids instead of field option names
+    # 
+    # I'm sorry
+    def collect_default_values
+      field_defaults.collect { |d| d[:value] }
+    end
+
+    # This method should be overridden by the field subclasses
+    #
+    # @param [DynamicFieldsets::FieldsetAssociator] fsa The associator
+    # @param [DynamicFieldsets::FieldsetChild] fsc The fieldset child
+    # @return [Nil] An empty result
+    def get_values_using_fsa_and_fsc(fsa, fsc)
+      return nil
+    end
+
+    # Collects the field records for the field so they can be used on the front end
+    # These are only the currently saved values in the database, don't worry 
+    # about defaults here
+    #
+    # This works for fields that do not use field options
+    #
+    # @return [Array] An array of field record values
+    def collect_field_records_by_fsa_and_fsc(fsa, fsc)
+      # I think this needs to return some sort of hash
+      records = DynamicFieldsets::FieldRecord.where(:fieldset_associator_id => fsa.id, :fieldset_child_id => fsc.id)
+      return records.collect { |r| { :value => r.value } }
+    end
+
+    # Updates the field records for the field based on the given values
+    #
+    # This must be overridden if it is used
+    #
+    # @param [DynamicFieldsets::FieldsetAssociator] fsa The associator the value is attached to
+    # @param [DynamicFieldsets::FieldsetChild] fieldset_child The fieldset child for the value
+    # @param [Array or String] value The new values inputted by the user from the form
+    def update_field_records(fsa, fieldset_child, value)
+      throw "Field.update_field_records must be overridden to save data from the form."
+    end
   end
 end

data/app/models/dynamic_fieldsets/field_default.rb

@@ -5,7 +5,7 @@ module DynamicFieldsets
   #
   # @authors Scott Sampson, Jeremiah Hemphill, Ethan Pemble
   class FieldDefault < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_field_defaults"
+    self.table_name = "dynamic_fieldsets_field_defaults"
     #relations
     belongs_to :field
     
@@ -21,7 +21,7 @@ module DynamicFieldsets
     #
     # http://www.youtube.com/watch?v=BeP6CpUnfc0 
     def convert_option_name_to_id
-      if Field.option_field_types.include?(self.field.field_type)
+      if field.uses_field_options?
         option = FieldOption.find_by_name(self.value)
         self.value = option.id unless option.nil?
       end
@@ -29,7 +29,7 @@ module DynamicFieldsets
 
     # @return [String] Either the value or the name of the field option reference by the value
     def pretty_value
-      if !self.field.nil? && Field.option_field_types.include?(self.field.field_type)
+      if !self.field.nil? && field.uses_field_options?
         option = FieldOption.find_by_id(self.value)
         if !option.nil?
           return option.name

data/app/models/dynamic_fieldsets/field_html_attribute.rb

@@ -5,7 +5,7 @@ module DynamicFieldsets
   #
   # @authors Scott Sampson, Jeremiah Hemphill, Ethan Pemble
   class FieldHtmlAttribute < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_field_html_attributes"
+    self.table_name = "dynamic_fieldsets_field_html_attributes"
     #relations
     belongs_to :field
     

data/app/models/dynamic_fieldsets/field_option.rb

@@ -5,7 +5,7 @@ module DynamicFieldsets
   #
   # @authors Scott Sampson, Jeremiah Hemphill, Ethan Pemble
   class FieldOption < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_field_options"
+    self.table_name = "dynamic_fieldsets_field_options"
     #relations
     belongs_to :field
     

data/app/models/dynamic_fieldsets/field_record.rb

@@ -2,7 +2,7 @@ module DynamicFieldsets
   # Stores a single record's answer to a field in a fieldset
   # Fields with multiple answers should have multiple records in this model
   class FieldRecord < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_field_records"
+    self.table_name = "dynamic_fieldsets_field_records"
 
     belongs_to :fieldset_child
     belongs_to :fieldset_associator

data/app/models/dynamic_fieldsets/fieldset.rb

@@ -3,7 +3,7 @@ module DynamicFieldsets
   #
   # @author Jeremiah Hemphill, Ethan Pemble
   class Fieldset < ActiveRecord::Base
-    set_table_name "dynamic_fieldsets_fieldsets"
+    self.table_name = "dynamic_fieldsets_fieldsets"
 
     # Relations
     has_many :fieldset_associators
@@ -43,6 +43,10 @@ module DynamicFieldsets
     
     # The collected descendents of a fieldset.
     # This group is sorted by order number on the fieldsetchild model 
+    # 
+    # IMPORTANT NOTE: At first glance, this looks like it should return a collection of fieldset children.  It does not.
+    # This is a relic from the original design, and there is code working around the issue in several different places.
+    #
     # @return [Array] Ordered collection of descendent fields and fieldsets.
     def children
       collected_children = []
@@ -60,5 +64,36 @@ module DynamicFieldsets
     def has_children?
       return !self.fieldset_children.empty?
     end
+
+    # returns field record values for every field in the fsa
+    #
+    # note that this adds a hierarchy to the values
+    # not sure if this will require a rewrite somewhere else
+    #
+    # @param [DynamicFieldsets::FieldsetAssociator] The parent fsa
+    # @return [Hash] A hash of field record values using the fieldset child id as they key
+    def get_values_using_fsa(fsa)
+      output = {}
+      fieldset_children.each do |child|
+        output[child.id] = child.get_value_using_fsa(fsa)
+      end      
+      return output
+    end
+
+    # Updates field options based on information from the form
+    #
+    # The form values should only be values for the current fsa
+    #
+    # @param [Hash] form_values Information from the form
+    def update_field_records_with_form_information(form_values)
+      form_values.each_pair do |fieldset_child_key, value|
+        if fieldset_child_key.start_with?(DynamicFieldsets.config.form_field_prefix)
+          fieldset_child_id = fieldset_child_key.gsub(/^#{DynamicFieldsets.config.form_field_prefix}/, "")
+          fieldset_child = fieldset_children.select { |child| child.id == fieldset_child_id.to_i }.first
+          # this could potentially hit a fieldset and cause problems
+          fieldset_child.child.update_field_records(self, fieldset_child, value)
+        end
+      end
+    end
   end
 end