dynamic_fieldsets 0.0.16 → 0.1.0

data/lib/dynamic_fieldsets/field_with_field_options.rb

@@ -0,0 +1,58 @@
+module DynamicFieldsets
+  # Adds methods to a model extending DynamicFieldsets::Field so that it works with field options
+  # when saving and accessing data
+  module FieldWithFieldOptions
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_field_with_field_options(args = {})
+        validate :at_least_one_field_option
+        include DynamicFieldsets::FieldWithFieldOptions::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      
+      # 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
+      #
+      # Converts the ids into field option names for :name part of the return hash
+      #
+      # @return [Array] An array of field record values
+      def collect_field_records_by_fsa_and_fsc(fsa, fsc)
+        records = DynamicFieldsets::FieldRecord.where(:fieldset_associator_id => fsa.id, :fieldset_child_id => fsc.id)
+        return records.collect do |r| 
+          { 
+            :value => r.value, 
+            :name => DynamicFieldsets::FieldOption.find(r.value.to_i).name
+          }
+        end
+      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[:name]
+      end
+
+      def uses_field_options?
+        true
+      end
+
+      # validation for field options
+      def at_least_one_field_option
+        if self.field_options.empty?
+          self.errors.add(:field_options, "This field must have options")
+        end
+      end
+      
+      # @return [FieldOptions] Returns all field options that are enabled
+      def options
+        return self.field_options.reject{ |option| !option.enabled }
+      end
+    end
+  end
+end
+

data/lib/dynamic_fieldsets/field_with_multiple_answers.rb

@@ -0,0 +1,89 @@
+module DynamicFieldsets
+  module FieldWithMultipleAnswers
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_field_with_multiple_answers(args = {})
+        include DynamicFieldsets::FieldWithMultipleAnswers::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def show_partial_locals(args)
+        output = super(args)
+        output[:values] = args[:values].collect { |value| get_value_for_show(value) }
+        return output
+      end
+
+      # Updates the field records for the field based on the given values
+      #
+      # Manages multiple records
+      #
+      # @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, values)
+        # make sure values is an array in case the input from the form is bad
+        throw "Form value type mismatch error: The value from the form must be Array for #{self.inspect}." unless values.is_a?(Array)
+        
+        # create new records if the values are not in the db
+        values.each do |value|
+          if fieldset_child.field_records.select{ |record| record.value == value }.empty?
+            DynamicFieldsets::FieldRecord.create!( :fieldset_associator_id => fsa.id,
+              :fieldset_child_id => fieldset_child.id,
+              :value => value)
+          end
+        end
+      
+        # remove records in the db that are not in the input values
+        # note that if a record is updated, it is treated as a creation and deletion instead of a single update
+        fieldset_child.field_records.each do |record|
+          if !values.include?(record.value)
+            record.destroy
+          end
+        end
+      end
+
+      # Gets the first field record matching the parameters
+      #
+      # @param [DynamicFieldsets::FieldsetAssociator] fsa The associator
+      # @param [DynamicFieldsets::FieldsetChild] fsc The fieldset child
+      # @return [Array] An array of field records
+      def get_values_using_fsa_and_fsc(fsa, fsc)
+        collect_field_records_by_fsa_and_fsc(fsa, fsc)
+      end
+
+      # @return [String] Default multiple answer partial filename
+      def show_partial
+        "/dynamic_fieldsets/show_partials/show_multiple_answers"
+      end
+
+      # Returns a list of values for the form
+      #
+      # Only returns the :value part of the input
+      #
+      # @param [Array] values A list of values for the field already saved to the database
+      # @return [Array] An array of field option values saved in the db, or the defaults if none are in the db
+      def values_or_defaults_for_form(values)
+        if values.nil? || values.empty?
+          if field_defaults.length == 0
+            return []
+          else
+            return collect_default_values
+          end
+        else
+          return values.collect { |v| v[:value] }
+        end  
+      end
+
+      # @return [Array] Alias for field_defaults
+      def defaults
+        return self.field_defaults if options?
+        return nil
+      end
+    end
+  end
+end

data/lib/dynamic_fieldsets/field_with_single_answer.rb

@@ -0,0 +1,84 @@
+module DynamicFieldsets
+  module FieldWithSingleAnswer
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def acts_as_field_with_single_answer(args = {})
+        include DynamicFieldsets::FieldWithSingleAnswer::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      def show_partial_locals(args)
+        output = super(args)
+        output[:value] = get_value_for_show(args[:value])
+        return output
+      end
+
+      # Updates the field records for the field based on the given values
+      #
+      # Saves or updates a single field record
+      #
+      # @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)
+        # make sure the value is a string in case the input from the form is bad
+        throw "Form value type mismatch error: The value from the form must be String for #{self.inspect}." unless value.is_a?(String)
+
+        # retrieve record
+        field_record = DynamicFieldsets::FieldRecord.where(:fieldset_associator_id => fsa.id, :fieldset_child_id => fieldset_child.id).first
+        if field_record.nil? 
+          # create record
+          DynamicFieldsets::FieldRecord.create!(
+            :fieldset_associator_id => fsa.id, 
+            :fieldset_child_id => fieldset_child.id, 
+            :value => value)
+        else 
+          # update record
+          field_record.value = value 
+          field_record.save
+        end
+      end
+
+      # Gets the first field record matching the parameters
+      #
+      # @param [DynamicFieldsets::FieldsetAssociator] fsa The associator
+      # @param [DynamicFieldsets::FieldsetChild] fsc The fieldset child
+      # @return [String] The first field record
+      def get_values_using_fsa_and_fsc(fsa, fsc)
+        collect_field_records_by_fsa_and_fsc(fsa, fsc).first
+      end
+
+      # @return [String] Default single answer partial filename
+      def show_partial
+        "/dynamic_fieldsets/show_partials/show_single_answer"
+      end
+
+      # @return [String] Alias for field_defaults.first
+      def default
+        return self.field_defaults.first
+      end
+
+      # Returns a list of values for the form
+      #
+      # @param [String] value A value for the field already saved to the database
+      # @return [String] A field option saved in the db, or the default if value is blank
+      def value_or_default_for_form(value)
+        if value.nil? || value[:value].nil?
+          if field_defaults.length == 0
+            return ""
+          else
+            return collect_default_values.first
+          end
+        else
+          value[:value]
+        end  
+      end
+    end
+  end
+end
+

data/lib/dynamic_fieldsets/railtie.rb

@@ -1,6 +1,5 @@
 require 'rails'
 
-# no configuration yet
 require 'dynamic_fieldsets/config'
 
 module DynamicFieldsets
@@ -8,6 +7,12 @@ module DynamicFieldsets
     initializer 'dynamic_fieldsets' do |app|
       require 'dynamic_fieldsets/dynamic_fieldsets_in_model'
       ActiveRecord::Base.send :include, DynamicFieldsets::DynamicFieldsetsInModel
+      require 'dynamic_fieldsets/field_with_field_options'
+      ActiveRecord::Base.send :include, DynamicFieldsets::FieldWithFieldOptions
+      require 'dynamic_fieldsets/field_with_multiple_answers'
+      ActiveRecord::Base.send :include, DynamicFieldsets::FieldWithMultipleAnswers
+      require 'dynamic_fieldsets/field_with_single_answer'
+      ActiveRecord::Base.send :include, DynamicFieldsets::FieldWithSingleAnswer
     end
   end
 end

data/lib/generators/dynamic_fieldsets/install_generator.rb

@@ -15,7 +15,7 @@ module DynamicFieldsets
 
       desc <<DESC
 Description:
-  Copies over migrations and config for the multipart form system.
+  Copies over migrations and config for the dynamic fieldsets system.
 DESC
 
       # Implement the required interface for Rails::Generators::Migration.
@@ -30,9 +30,9 @@ DESC
       end
 
       # Creates the config file
-      # Commented out until the config actually has information
+      # Mostly commented out until the config actually has information
       def copy_config_file
-        #copy_file "config.rb", "config/initializers/acts_as_multipart_form.rb"
+        copy_file "config.rb", "config/initializers/dynamic_fieldsets.rb"
       end
 
       # Creates the migration

data/lib/generators/dynamic_fieldsets/templates/config.rb

@@ -0,0 +1,15 @@
+DynamicFieldsets.configure do |config|
+  # If cache classes is off, this field needs to be set.  Otherwise, rails issues
+  # can cause the single table inheritance to fail.  This is due to the object
+  # space getting reset after every request.  In production and test environemnts, 
+  # this information will not be used because the object space will be complete.
+  # config.available_field_types = [ "DynamicFieldsets::CheckboxField", "DynamicFieldsets::"DateField", "DynamicFieldsets::"DatetimeField", "DynamicFieldsets::InstructionField", "DynamicFieldsets::MultipleSelectField", "DynamicFieldsets::RadioField", "DynamicFieldsets::SelectField", "DynamicFieldsets::TextField", "DynamicFieldsets::TextareaField" ]
+
+  # This should correspond to the beginning of the id for the fields for on the form
+  # For example: fsa-8
+  # config.form_fieldset_associator_prefix = "fsa-"
+
+  # This should correspond to the beginning of the field section of form inputs
+  # For example: fsa-8[field-7]
+  # config.form_field_prefix = "field-"
+end

data/lib/generators/dynamic_fieldsets/templates/migrations/install_migration.rb

@@ -35,7 +35,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration
     create_table :dynamic_fieldsets_fields do |t|
       t.string :name
       t.string :label, :required => true
-      t.string :field_type, :required => true
+      t.string :type, :required => true
       t.boolean :required, :default => false
       t.boolean :enabled, :default => true
 

data/spec/dummy/config/initializers/dynamic_fieldsets.rb

@@ -0,0 +1,15 @@
+DynamicFieldsets.configure do |config|
+  # If cache classes is off, this field needs to be set.  Otherwise, rails issues
+  # can cause the single table inheritance to fail.  This is due to the object
+  # space getting reset after every request.  In production and test environemnts, 
+  # this information will not be used because the object space will be complete.
+  # config.available_field_types = [ "DynamicFieldsets::CheckboxField", "DynamicFieldsets::"DateField", "DynamicFieldsets::"DatetimeField", "DynamicFieldsets::InstructionField", "DynamicFieldsets::MultipleSelectField", "DynamicFieldsets::RadioField", "DynamicFieldsets::SelectField", "DynamicFieldsets::TextField", "DynamicFieldsets::TextareaField" ]
+
+  # This should correspond to the beginning of the id for the fields for on the form
+  # For example: fsa-8
+  # config.form_fieldset_associator_prefix = "fsa-"
+
+  # This should correspond to the beginning of the field section of form inputs
+  # For example: fsa-8[field-7]
+  # config.form_field_prefix = "field-"
+end

data/spec/dummy/db/migrate/20120213211033_create_dynamic_fieldsets_tables.rb

@@ -35,7 +35,7 @@ class CreateDynamicFieldsetsTables < ActiveRecord::Migration
     create_table :dynamic_fieldsets_fields do |t|
       t.string :name
       t.string :label, :required => true
-      t.string :field_type, :required => true
+      t.string :type, :required => true
       t.boolean :required, :default => false
       t.boolean :enabled, :default => true
 

data/spec/dummy/db/schema.rb

@@ -84,7 +84,7 @@ ActiveRecord::Schema.define(:version => 20120213211033) do
   create_table "dynamic_fieldsets_fields", :force => true do |t|
     t.string   "name"
     t.string   "label"
-    t.string   "field_type"
+    t.string   "type"
     t.boolean  "required",   :default => false
     t.boolean  "enabled",    :default => true
     t.datetime "created_at"

data/spec/dummy/features/step_definitions/field_steps.rb

@@ -2,7 +2,7 @@ Given /^a field exists$/ do
   @field = DynamicFieldsets::Field.create(
     :name => "Test field",
     :label => "Test field",
-    :field_type => "textfield",
+    :type => "textfield",
     :enabled => true,
     :required => true)
 end
@@ -26,14 +26,14 @@ end
 Then /^I should see that field listed$/ do
   @field = DynamicFieldsets::Field.last
   page.should have_content(@field.name)
-  page.should have_content(@field.field_type)
+  page.should have_content(@field.type)
 end
 
 Then /^I should see the data for that field$/ do
   @field = DynamicFieldsets::Field.last
   page.should have_content(@field.name)
   page.should have_content(@field.label)
-  page.should have_content(@field.field_type)
+  page.should have_content(@field.type)
   page.should have_content(@field.enabled)
   page.should have_content(@field.required)
 
@@ -63,5 +63,5 @@ end
 
 Then /^I should not see that field listed$/ do
   page.should_not have_content(@field.name)
-  page.should_not have_content(@field.field_type)
+  page.should_not have_content(@field.type)
 end

data/spec/dummy/features/step_definitions/fieldset_children_steps.rb

@@ -19,7 +19,7 @@ def create_child_field(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "textfield",
+    :type => "textfield",
     :enabled => true,
     :required => true)
   DynamicFieldsets::FieldsetChild.create(:fieldset => parent, :child => child_field, :order_num => order_num)
@@ -55,7 +55,7 @@ end
 Then /^I should see the child field information$/ do
   @child_field = DynamicFieldsets::Field.last
   page.should have_content(@child_field.name)
-  page.should have_content(@child_field.field_type)
+  page.should have_content(@child_field.type)
 end
 
 Then /^I should see the child fieldset information$/ do

data/spec/dummy/features/step_definitions/javascript_steps.rb

@@ -19,7 +19,7 @@ def create_textfield(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "textfield",
+    :type => "textfield",
     :enabled => true,
     :required => true)
   DynamicFieldsets::FieldsetChild.create(:fieldset => parent, :child => child_field, :order_num => order_num)
@@ -30,7 +30,7 @@ def create_radio(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "radio",
+    :type => "radio",
     :enabled => true,
     :required => true,
     :field_options => [DynamicFieldsets::FieldOption.create(
@@ -47,7 +47,7 @@ def create_textarea(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "textarea",
+    :type => "textarea",
     :enable => true,
     :required => true)
   DynamicFieldsets::FieldsetChild.create(:fieldset => parent, :child => child_field, :order_num => order_num)
@@ -58,7 +58,7 @@ def create_checkbox(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "checkbox",
+    :type => "checkbox",
     :enable => true,
     :required => true,
     :field_options => [DynamicFieldsets::FieldOption.create(
@@ -75,7 +75,7 @@ def create_select(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "select",
+    :type => "select",
     :enable => true,
     :required => true,
     :field_options => [DynamicFieldsets::FieldOption.create(
@@ -92,7 +92,7 @@ def create_multi_select(parent, order_num = 1)
   child_field = DynamicFieldsets::Field.create(
     :name => "Child Field",
     :label => "Child Field",
-    :field_type => "multiple_select",
+    :type => "multiple_select",
     :enable => true,
     :required => true,
     :field_options => [DynamicFieldsets::FieldOption.create(
@@ -111,7 +111,7 @@ def create_instruction(parent, order_num = 2)
   child_field = DynamicFieldsets::Field.create(
     :name => "Dependent Field",
     :label => "Dependent Field",
-    :field_type => "instruction",
+    :type => "instruction",
     :enable => true,
     :required => true
   )