question_chain 0.0.1

data/lib/question_chain/models/answers/ui_objects_relatable_category_drop_down_view.rb

@@ -0,0 +1,18 @@
+module Answers
+  class UiObjectsRelatableCategoryDropDownView < Answers::UiObjectView
+    
+    def prompt
+      ui_object.prompt
+    end
+    
+    # @return [Array<Hash<value => value, name => name>>]
+    def options
+      if answer_params
+        ui_object.options.map{|option| option.merge!(:selected => option["value"].to_s == value.to_s)}
+      else
+        ui_object.options
+      end
+    end
+    
+  end
+end

data/lib/question_chain/models/answers/ui_objects_text_field_view.rb

@@ -0,0 +1,8 @@
+module Answers
+  class UiObjectsTextFieldView < Answers::UiObjectView
+    
+    def value
+      super || default_value
+    end   
+  end
+end

data/lib/question_chain/models/chain_template.rb

@@ -0,0 +1,43 @@
+class ChainTemplate 
+  include MongoMapper::Document
+  include MongoMapper::StateMachine
+  
+  # == Keys
+  key :context, Hash # [Hash<content => [Array<MongoIds>]>]
+  key :account_id, ObjectId # used to override any specific question essentially
+  key :for_resource, String
+  key :parent_resource, String
+  key :active_at, Time
+  
+  # == State Machine
+  state_machine :initial => :pending do
+    state :pending
+    state :active
+
+    event :activate do
+      transitions :to => :active, :from => [:pending],  :on_transition => :set_active_at
+    end
+    
+    event :deactivate do
+      transitions :to => :pending, :from => [:active]
+    end
+  end
+  
+  # == Indexes
+  ensure_index :for_resource
+  
+  # == Validations
+  validates_presence_of :for_resource
+  validates_presence_of :context
+  validates_true_for :context, :logic => Proc.new{ !context.empty?}
+  
+  def self.attributes_for_api
+    %w(id name for_resource account_id parent_resource)
+  end
+  
+  protected
+  def set_active_at
+    self.active_at = Time.now
+    self.save!
+  end
+end

data/lib/question_chain/models/question.rb

@@ -0,0 +1,37 @@
+class Question
+  include MongoMapper::Document
+  include MongoMapper::Serialize
+  
+  # == Keys
+  key :name, String
+  key :label, String
+  key :_type, String
+  key :description, String
+  key :calculator_id, ObjectId
+  key :computation_id, ObjectId
+  timestamps!
+  
+  # == Indexes
+  ensure_index :names
+  ensure_index :label
+    
+  # == Validations
+  validates_presence_of :name
+  validates_uniqueness_of :name
+  
+  # == Associations
+  many :ui_groups, :order => :position.asc, :dependent => :destroy
+  
+  # == Hooks
+  def self.attributes_for_api
+    %w(id name description computation_id ui_groups label calculator_id)
+  end
+  
+  def to_json
+    attributes_for_api_resource.to_json
+  end
+  
+  def to_hash
+    Hashie::Mash.new(attributes_for_api_resources)
+  end
+end

data/lib/question_chain/models/relatable_category_filter.rb

@@ -0,0 +1,15 @@
+class RelatableCategoryFilter 
+  include MongoMapper::Document
+  include MongoMapper::Serialize
+  
+  # == Keys
+  key :filters, Array
+  key :ui_group_id, ObjectId
+  
+  # == Associations
+  belongs_to :ui_group
+  
+  def self.attributes_for_api
+    %w(id filters ui_group_id)
+  end
+end

data/lib/question_chain/models/rule.rb

@@ -0,0 +1,27 @@
+class Rule
+  include MongoMapper::EmbeddedDocument
+  include MongoMapper::Serialize
+  
+  # == Keys
+  key :fire_value, String
+  key :negate_value, :default => false
+  key :_type, String
+    
+  def ui_object_id
+    _parent_document.id
+  end
+  
+  # have to have this here to declear all subclass not being used?
+  def self.attributes_for_api
+    %w(id fire_value _type ui_object_id negate_value)
+  end
+  
+  # this will manipulate the question hash with the updated
+  # attributes for the affecting ui objects that are 
+  # attached to this rule
+  #
+  # @return [TrueClass] when the fire! is actually doing that
+  def fire!(value, question_hash = {})
+    raise NotImplementedError, "Need to set the fire! method"
+  end
+end

data/lib/question_chain/models/rules/attribute_change.rb

@@ -0,0 +1,28 @@
+module Rules
+  class AttributeChange < Rule
+    # {:id => {:atttibute_name => "new_state"}, :id => {:atttibute_name => "new_state"}}
+    key :affecting_ui_objects, Hash
+    key :compare_text_value, :default => false
+    
+    def self.attributes_for_api
+      %w(id fire_value _type affecting_ui_objects ui_object_id negate_value compare_text_value)
+    end
+    
+    # Checks to determine the value and the fire_value if cool 
+    # then the ui objects are updated depending on the affecting values
+    #
+    # @param [UiObject] ui_object the ui object that this rul is observing
+    # @param [String] value the value that the ui_object has
+    # @param [Array<Hash>] ui_objects
+    def fire!(value, ui_objects)
+      if negate_value ? value != self.fire_value : value == self.fire_value
+        affecting_ui_objects.each_pair do |key, value|
+          if ui_object = ui_objects.detect{|ui| ui["id"] == key}
+            ui_object["ui_attributes"].merge!(value)
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/question_chain/models/rules/choice_genenerator.rb

@@ -0,0 +1,5 @@
+module Rules
+  class ChoiceGenerator < Rule
+    
+  end
+end

data/lib/question_chain/models/rules/populate_drop_down.rb

@@ -0,0 +1,30 @@
+module Rules
+  class PopulateDropDown < Rule
+    
+    # == Keys
+    key :ui_object_attribute_check, Hash, :default => nil
+      
+    def fire!(value = nil, ui_objects_hash = {})
+      # does not matter what the value is in this instance
+      # it is used to get opions for the drop_down_target
+    end
+    
+    def drop_down_target_id
+      _parent_document.drop_down_target_id
+    end
+    
+    # ask the parent document to get the options
+    def get_options(object_ids = [])
+      options = []
+      _parent_document.get_target_drop_down_options(object_ids).each_pair do |key ,value|
+        options << {:name => value, :value => key}
+      end
+      options.sort_by{|option| option[:name]}
+    end
+    
+    def self.attributes_for_api
+      %w(id fire_value _type ui_object_id drop_down_target_id ui_object_attribute_check negate_value)
+    end
+    
+  end
+end

data/lib/question_chain/models/rules/search.rb

@@ -0,0 +1,19 @@
+module Rules
+  class Search < Rule
+      
+    def fire!(value = nil, ui_objects_hash = {})
+      # does not matter what the value is in this instance
+      # it is used to get opions for the drop_down_target
+    end
+        
+    # ask the parent document to get the options
+    def get_options(filter, relatable_category_names = [])
+      _parent_document.options(filter, relatable_category_names)
+    end
+    
+    def self.attributes_for_api
+      %w(id fire_value _type ui_object_id negate_value)
+    end
+
+  end
+end

data/lib/question_chain/models/rules/value_change.rb

@@ -0,0 +1,22 @@
+module Rules
+  class ValueChange < Rule
+    
+    # == Keys
+    key :affecting_ui_object_id, ObjectId
+    key :change_value, String
+    
+    # == Validations
+    validates_presence_of :affecting_ui_object_id
+    validates_presence_of :change_value
+    
+    def fire!(value = nil, ui_objects_hash = {})
+      # does not matter what the value is in this instance
+      # it is used to get opions for the drop_down_target
+    end
+            
+    def self.attributes_for_api
+      %w(id fire_value _type ui_object_id affecting_ui_object_id negate_value)
+    end
+
+  end
+end

data/lib/question_chain/models/ui_group.rb

@@ -0,0 +1,71 @@
+# holds a group of ui objects basically
+# keep simple to start of with 
+class UiGroup
+  include MongoMapper::Document
+  include MongoMapper::Serialize
+  
+  # == Keys
+  key :name, String
+  key :description, String
+  key :label, String
+  key :parent_id, ObjectId
+  key :parent_ids, Array
+  key :question_id, ObjectId
+  key :ui_attributes, Hash
+  key :css_classes, Array, :default => ["single"]
+  timestamps!
+  
+  # == Indexes
+  ensure_index :parent_ids
+  ensure_index :name
+  
+  # == Validations
+  validates_presence_of :name
+  validates_presence_of :label
+  validates_presence_of :question_id
+  
+  # == Associations
+  belongs_to :parent
+  belongs_to :question
+  many :ui_objects, :order => :position.asc
+  many :object_searches, :class_name => "UiObjects::ObjectSearch"
+  many :text_fields, :class_name => "UiObjects::TextField"
+  many :drop_downs, :class_name => "UiObjects::DropDown"
+  many :checkboxes, :class_name => "UiObjects::CheckBox"
+  one :object_reference_drop_down, :class_name => "UiObjects::ObjectReferenceDropDown"
+  many :relatable_category_drop_downs, :class_name => "UiObjects::RelatableCategoryDropDown"  
+  many :hidden_fields, :class_name => "UiObjects::HiddenField"  
+  many :children, :class_name => 'UiGroup', :foreign_key => 'parent_id'
+  one :relatable_category_filter, :class_name => "RelatableCategoryFilter"
+  
+  # thats right only ever one object_reference in a ui_group
+  # its a constraint we just need
+  one :object_reference_drop_down, :class_name => "UiObjects::ObjectReferenceDropDown"
+
+  # == hooks
+  before_save :set_parents
+  
+  def self.attributes_for_api
+    %w(id name label question_id relatable_category_filter ui_objects ui_attributes default_styles css_classes)
+  end
+  
+  # this should go into the mustache view basically
+  def default_styles
+    default_styles = ""
+    self.ui_attributes.each_pair do |key, value|
+      if key.to_s == "visible" && value == false
+        default_styles << "display:none;visibility:hidden;"
+      end
+    end
+    default_styles
+  end
+  
+  def css_classes
+    read_attribute(:css_classes).join(" ")
+  end
+  
+  protected
+  def set_parents
+    self.parent_ids = (parent.parent_ids || []) << parent_id if parent?
+  end
+end

data/lib/question_chain/models/ui_object.rb

@@ -0,0 +1,92 @@
+require "observer"
+class UiObject
+  include ::Observable
+  include MongoMapper::Document
+  include MongoMapper::Serialize
+
+  # == Keys
+  key :_type, String
+  key :name, String
+  key :label, String
+  key :description, String
+  key :default_value, String
+  key :ui_attributes, Hash
+  key :ui_group_id, ObjectId
+  key :position, Integer
+  key :extra_info, String
+  key :per_page, Integer, :default => 50
+  key :css_classes, Array, :default => ["single"]
+  timestamps!
+  
+  # == Indexes
+  ensure_index :label
+  ensure_index "rules.name"
+  
+  # == Attrs
+  attr_accessor :value
+  class_inheritable_accessor :default_values
+  
+  # Class set values  
+  self.default_values = {:visible => true, :enabled => true}
+
+  # == Validations
+  validates_presence_of :ui_group_id
+  validates_presence_of :label
+  validates_presence_of :ui_attributes
+  validates_true_for :ui_attributes, :logic => Proc.new{
+    !ui_attributes.empty?
+  }
+  validates_associated :rules
+  
+  # == Associations
+  belongs_to :ui_group
+  many :rules
+  
+  # == Hooks
+  before_save :add_rule_observers!
+  before_validation_on_create :set_default_attributes
+  
+  def self.attributes_for_api
+    %w(id name _type label description default_value ui_attributes ui_group_id rules extra_info css_classes)
+  end
+  
+  # == need as added a little late in the day basically
+  def per_page
+    read_attribute(:per_page) || 50
+  end
+    
+  def initialize(*args)
+    super
+    add_rule_observers!
+  end
+ 
+  # fires the rules that are attached the ui object
+  def change_value!(ui_objects = [])
+    if ui_object = ui_objects.detect{|ui| ui["id"] == self.id.to_s}
+      value = ui_object["ui_attributes"] && ui_object["ui_attributes"]["value"] || ""
+      @observer_state = true
+      notify_observers(value, ui_objects)
+    end
+  end
+      
+  def visible?
+    ui_attributes[:visible]
+  end
+  
+  def enabled?
+    ui_attributes[:enabled]
+  end
+
+  protected  
+  def set_default_attributes
+    self.ui_attributes = self.class.default_values.merge(:value => self.default_value || "").merge(self.ui_attributes || {})
+  end
+  
+  # Adding the obervers so we can fire rules
+  def add_rule_observers!
+    rules.each do |rule|
+      self.add_observer(rule, :fire!)
+    end
+  end
+
+end

data/lib/question_chain/models/ui_object_answer.rb

@@ -0,0 +1,17 @@
+class UiObjectAnswer  
+  
+  # @todo refactor make not as ugly as a bulldog eating a wasp
+  # @param [String] json
+  # @return [String] json formatted String manipulate from ui changes
+  def self.update_answers!(answer_json = "")
+    @answer_hash = JSON.parse(answer_json)
+    if  @ui_objects = @answer_hash.delete("ui_objects")
+        uis = UiObject.find(ui_object_ids)
+        uis.each do |ui_object|
+          ui_object.change_value!(@ui_objects)
+        end
+    end    
+    @answer_hash["ui_objects"] = @ui_objects
+    answer_json = @answer_hash.to_json
+  end
+end

data/lib/question_chain/models/ui_objects/check_box.rb

@@ -0,0 +1,8 @@
+module UiObjects
+  class CheckBox < UiObject
+    
+    # == Added defaults
+    self.default_values = self.default_values.merge!(:checked => false)
+    
+  end
+end

data/lib/question_chain/models/ui_objects/drop_down.rb

@@ -0,0 +1,17 @@
+module UiObjects
+  class DropDown < UiObject
+    
+    # == keys
+    key :options, Array
+    key :prompt, String
+    key :max_options, Integer, :default => 20
+    key :populate, Boolean, :default => true
+    key :order, String
+    key :filter, Set
+
+    def self.attributes_for_api
+      %w(id name _type populate label order filter description default_value ui_attributes options prompt max_options rules extra_info css_classes)
+    end
+
+  end
+end

data/lib/question_chain/models/ui_objects/hidden_field.rb

@@ -0,0 +1,5 @@
+module UiObjects
+  class HiddenField < UiObject
+    key :name, String, :default => "computation_id"
+  end
+end

data/lib/question_chain/models/ui_objects/object_reference_drop_down.rb

@@ -0,0 +1,67 @@
+module UiObjects
+  class ObjectReferenceDropDown < UiObject
+    
+    # == Keys
+    key :prompt, String
+    key :max_options, Integer, :default => 20
+    
+    # :id => :attribute_name # not quite sure about the option trackers
+    key :object_name, String
+    key :filters, Set # filters
+    key :filter_attribute, String
+    key :filter_value, String
+    key :order, String
+    key :drop_down_target_id, ObjectId
+    key :drop_down_target_options_filters, Array # == Array of filters for formula inputs
+    key :populate, Boolean, :default => true
+    key :relatable_options, Boolean, :default => false
+    key :attribute_for_value, String, :default => "id"
+    key :attribute_for_display, String, :default => "identifier"
+    key :external, Boolean, :default => true
+    
+    # == Indexes
+    ensure_index :object_name
+    
+    # == Validations
+    validates_presence_of :object_name
+        
+    def options
+      return [] if !populate
+      @options ||= get_options(object_name, filters || [])
+    end
+    
+    def self.attributes_for_api
+      %w(id name _type label description rules default_value ui_attributes options prompt max_options object_name drop_down_target_id  extra_info css_classes)
+    end
+    
+    # object_reference drop down can only target its formula units basically
+    # only 1 object in this instance
+    def get_target_drop_down_options(object_ids = [])
+      if object_id = object_ids.first
+        formula_inputs = QuestionChain.calculated_session.formula_inputs_for_generic_object(object_id.to_s)
+        if respond_to?(:drop_down_target_options_filters) && !drop_down_target_options_filters.empty?
+          selected_formula_inputs = formula_inputs.select{|f| drop_down_target_options_filters.map(&:downcase).include?(f.name.downcase)}
+          selected_formula_inputs.inject({}){|var, fi| var.merge!({fi.name => fi.label_input_units}); var}
+        else
+          formula_inputs.inject({}){|var, fi| var.merge!({fi.name => fi.label_input_units}); var}
+        end
+      end
+    end
+    
+    protected
+    # Based on the fact we dont know what co2_platform 
+    # we are using how can the options be found!
+    # 
+    # @return [Array<Array<String, String>>] tuples [value, display]
+    def get_options(name, filters = [])
+      options = {:per_page => per_page}
+      options.merge!(:filter_attribute => self.filter_attribute, :filter_value => self.filter_value) if self.filter_attribute && self.filter_value
+      response = QuestionChain.calculated_session.generic_objects_for_object_template(name, options)
+      options = response.generic_objects.select{|obj| (filters.empty? || (!filters.empty? && filters.include?(obj.id.to_s)))}.map do |obj|      
+        {:value => obj.send(self.attribute_for_value), :name => obj.send(self.attribute_for_display)}
+      end
+      options.sort_by{|obj| obj[:name]}
+    end
+        
+  end
+end

data/lib/question_chain/models/ui_objects/object_search.rb

@@ -0,0 +1,44 @@
+module UiObjects
+  class ObjectSearch < UiObject
+    
+    # == keys
+    key :object_name, String
+    key :max_options, Integer, :default => 20
+    key :prompt, String
+    key :attribute_for_value, String, :default => "id"
+    key :attribute_for_display, String, :default => "identifier"
+    
+    # == Validations
+    validates_presence_of :object_name
+    
+    # == Hooks
+    after_create :add_default_rule
+    
+    # == Attrs
+    attr_accessor_with_default :default_rule, true
+    
+    def self.attributes_for_api
+      %w(id name _type label position description rules ui_attributes prompt max_options object_name extra_info css_classes)
+    end
+    
+    def options(filter, relatable_category_names = [])
+      @options ||= get_options(object_name, filter || "", relatable_category_names)
+    end
+    
+    protected
+    def get_options(object_name, filter, relatable_category_names)
+      response = QuestionChain::calculated_session.generic_objects_for_object_template_with_filter(object_name, filter, :relatable_category_values => relatable_category_names, :per_page => per_page)
+      response.generic_objects.map do |obj| 
+        {:value => obj.send(self.attribute_for_value), :name => obj.identifier}
+      end
+    end
+    
+    def add_default_rule
+      if default_rule
+        self.rules << Rules::Search.new
+        self.save
+      end
+    end
+
+  end
+end

data/lib/question_chain/models/ui_objects/radio_button.rb

@@ -0,0 +1,5 @@
+module UiObjects
+  class RadioButton < UiObject
+    
+  end
+end

data/lib/question_chain/models/ui_objects/radio_button_group.rb

@@ -0,0 +1,5 @@
+module UiObjects
+  class RadioGroup < UiObject
+    
+  end
+end

data/lib/question_chain/models/ui_objects/relatable_category_drop_down.rb

@@ -0,0 +1,70 @@
+module UiObjects
+  class RelatableCategoryDropDown < UiObject
+    
+    # == Keys
+    key :related_attribute, String
+    key :object_name, String
+    key :filters, Set
+    key :order, String
+    key :prompt, String
+    key :max_options, Integer, :default => 20
+    key :drop_down_target_id, ObjectId
+    key :drop_down_target_is_relatable, Boolean, :default => false
+    key :populate, Boolean, :default => true
+    key :attribute_for_value, String, :default => "id"
+    key :attribute_for_display, String, :default => "label"
+    key :external, Boolean, :default => true
+    
+    # == Indexes
+    ensure_index :filters
+    ensure_index :object_name
+    ensure_index :related_attribute
+    
+    # == Validations
+    validates_presence_of :related_attribute
+    validates_presence_of :object_name
+    
+    # == Associations
+    belongs_to :drop_down_target, :class_name => "UiObject", :foreign_key => "drop_down_target_id"
+        
+    # == Hooks
+    after_create :add_default_rule
+    
+    # == Attrs
+    attr_accessor_with_default :default_rule, true
+    
+    def options
+      return [] if !populate
+      @options ||= relatable_categories.select{|obj| (filters.empty? || (!filters.empty? && filters.include?(obj.id.to_s)))}.map do |obj|
+        {:value => obj.id, :name => obj.name}
+      end.sort_by{|option| option[:name]}
+    end
+    
+    def get_target_drop_down_options(relatable_category_ids = [])
+      if drop_down_target_is_relatable
+        id = relatable_category_ids.shift
+        QuestionChain.calculated_session.related_categories_from_relatable_category(id.to_s, drop_down_target.related_attribute, {:relatable_category_ids => relatable_category_ids, :per_page => per_page})
+      else
+        QuestionChain.calculated_session.related_objects_from_relatable_categories(self.object_name, relatable_category_ids, :per_page => per_page)
+      end
+    end
+    
+    def self.attributes_for_api
+      %w(id name _type label populate drop_down_target_is_relatable related_attribute order rules filters description drop_down_target_id default_value ui_attributes options prompt max_options object_name order  extra_info css_classes)
+    end
+    
+    protected
+    def relatable_categories(related_attribute = self.related_attribute)
+      @relatable_categories ||= QuestionChain.calculated_session.relatable_categories_for_object_template(object_name, related_attribute, :per_page => per_page).relatable_categories
+    end
+    
+    # @todo move to after save; check for existing
+    def add_default_rule
+      if default_rule
+        self.rules << Rules::PopulateDropDown.new
+        self.save
+      end
+    end
+        
+  end
+end