question_chain 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gemspec
+
+# Will automatically pull in this gem and all its
+# dependencies specified in the gemspec
+gem "question_chain", :path => File.expand_path("..", __FILE__)
+gem "yard"
+
+# These are development dependencies 
+group :test do
+  gem "rake"
+  gem "rspec", "2.5.0"
+  gem 'vcr',                '~> 1.5', :require => false
+  gem 'webmock',            '~> 1.6', :require => false
+  gem "autotest"
+end
+

data/Licence.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2010 Richard Hooker - richard.hookere@carboncalculated.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.rdoc

@@ -0,0 +1,34 @@
+= QuestionChain
+
+== What Am I?
+
+This is not to be used currently! Work in Progress; Extracting not quite complete and SPECS
+
+There will be guides on how to use this http://guides.carboncalculated.com
+
+This is a Rails3 Gem to be used in conjunction with the soon to be released QuestionChainJS library
+to be used with the CarbonCalculated API http://carboncalculated.com
+
+This Gem allows you to create a forms for Carbon Calculations in like 2 sometimes 3 minutes depending on typing speed
+
+At the minute this has dependencies on MongoMapper currently thinking about moving to more ORM agnostic approach
+
+== Getting started
+
+== UiObjects
+
+=== Drop Downs
+
+===  Object Reference Drop Downs
+
+===  Rules
+
+===  Attribute Change
+
+===  Search
+
+===  Markup
+
+=== CSS
+
+=== Bundling

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/config/initializers/mustache.rb

@@ -0,0 +1,2 @@
+# == make sure we defined answers modules
+ActionView::Template.register_template_handler(:mustache, MustacheHandler)

data/lib/question_chain/answerable.rb

@@ -0,0 +1,142 @@
+module QuestionChain
+  module Answerable
+    extend ActiveSupport::Concern
+    include MongoMapper::Serialize
+  
+    included do
+      key :question_id, ObjectId
+      key :result, Hash
+      key :answer_params, Hash
+      key :answer_json, String
+      key :user_id, ObjectId
+      key :reference, String
+      key :stored_identifier, String
+      key :stored_variable_input, String
+      key :created_by, String
+      key :_extra_keywords, Array
+      timestamps!
+    
+      cattr_accessor :_extra_keyword_methods
+      before_save :add_stored_identifier
+      before_save :add_extra_keywords
+      before_save :cache_attributes
+      
+      # == Search
+      plugin Hunt
+      searches :reference, :created_by, :stored_variable_input, :stored_identifier, :_extra_keywords
+      ensure_index :'searches.default'
+      
+      # == Indexes
+      ensure_index :reference
+      ensure_index :stored_identifier
+      ensure_index :stored_variable_input
+      
+      # == Validations
+      validates_presence_of :question_id
+      validates_presence_of :answer_params
+      validates_presence_of :result
+      validates_true_for :answer, :logic => Proc.new {!answer_params.empty?}, :message => nil
+      validates_true_for :result, :logic => Proc.new {!result.empty?}, :message => nil
+      
+      # == Associations
+      belongs_to :user
+      
+      # == attr Protected
+      attr_protected :user_id
+      
+    end
+    
+    module ClassMethods
+      require "csv" #ruby19
+      def self.to_csv(options = {}) 
+        @csv_string ||= FasterCSV.generate do |csv|          
+          # header row
+          csv << self.attributes_for_api
+           
+          # data rows
+          self.all(options).each do |resource|
+            attributes = self.attributes_for_api.map do |key|
+              resource.send(key)
+            end
+            csv << attributes
+          end
+        end
+      end
+    end
+    
+    module InstanceMethods
+      def add_extra_keywords
+        unless (self.class._extra_keyword_methods || []).empty?
+          self.class._extra_keyword_methods.each do |method|
+           self._extra_keywords << self.send(method)
+          end
+        end
+      end
+          
+      def object_reference_characteristics(object_reference = self.object_reference)
+        object_reference["characteristics"]
+      end
+      
+      def object_references
+        result["object_references"]
+      end
+
+      def object_reference(object_reference_id = self.object_reference_id)
+        result["object_references"] && result["object_references"][object_reference_id]
+      end
+
+      def object_reference_id(object_reference_name = self.object_reference_name)
+        answer_params[object_reference_name]
+      end
+      
+      def object_reference_name
+        # should be set in the answerable if want to use
+      end
+      
+      def variable_input
+        # should be set in the answerable if you want to use this
+      end
+      
+      # you should set this to be what stored identifier you 
+      # wish to have if you use more then 1 object in 
+      # your calculation
+      def _identifier
+        idents = []
+        object_references.each_pair do |key, value|
+          idents << value["identifier"]
+        end
+        idents.join(" ")
+      end
+    
+      def identifier
+        _identifier == read_attribute(:stored_identifier) ? read_attribute(:stored_identifier) : _identifier
+      end
+    
+      def co2
+        (result["calculations"]["co2"]["value"] || 0).to_f
+      end
+    
+      def ch4
+        (result["calculations"]["ch4"]["value"] || 0).to_f
+      end
+    
+      def n2o
+        (result["calculations"]["n2o"]["value"]|| 0).to_f
+      end
+      
+      def co2e
+        (result["calculations"]["co2e"]["value"] || 0).to_f
+      end
+          
+      private
+      def add_stored_identifier
+        self.stored_identifier = self.identifier
+      end
+      
+      def cache_attributes
+        write_attribute(:created_by, user.full_name)
+        write_attribute(:stored_variable_input, variable_input)
+      end
+    end
+  end
+end

data/lib/question_chain/answers.rb

@@ -0,0 +1,290 @@
+module QuestionChain
+  module Answers
+    extend ActiveSupport::Concern 
+    
+    included do
+      before_filter :get_context
+      before_filter :load_contexts, :except => [:fire_object_search, :fire_populate_drop_down]
+      respond_to :json, :only => [:fire_object_search, :fire_populate_drop_down]
+      helper_method :question_chain_update_answer_path, :question_chain_answer_path, :collection_path
+    end
+    
+    module InstanceMethods
+      def new
+        @answer = build_resource
+        enforce_permission
+        @question = question_from_context
+        new!
+      end
+
+      def edit
+        @answer = resource
+        enforce_permission
+        @question = Question.find!(resource.question_id).to_hash
+        @answer_params = @answer.answer_params # used for mustache templates
+        set_answer_values_on_question!(@question, @answer_params)
+        edit!
+      end
+
+      def update
+        @answer = resource
+        enforce_permission
+        @answer.user_id = current_user.id
+        @answer.answer_params = params[:answer]
+        @answer_params = params[:answer] # used for mustache templates
+        @question = Question.find!(resource.question_id).to_hash
+        @answer.result = get_answer(@question, @answer_params)
+        set_answer_values_on_question!(@question, @answer_params)
+        build_answer_errors! 
+        update! do |success, failure|
+          success.html do 
+             flash[:notice] = update_success_flash_message
+            @contexts << @answer
+            redirect_to update_success_path
+          end
+        end
+      end
+
+      def create
+        @answer = build_resource
+        enforce_permission
+        @answer.user_id = current_user.id
+        @answer.answer_params = params[:answer]
+        @answer_params = params[:answer] # used for mustache templates
+        @question = question_from_context
+        @answer.question_id = @question.id
+        @answer.result = get_answer(@question, @answer_params)
+        set_answer_values_on_question!(@question, @answer_params)
+        build_answer_errors!
+        create! do |success, failure|
+          success.html do
+            flash[:notice] = create_success_flash_message
+            @contexts << @answer
+            redirect_to create_success_path
+          end      
+        end
+      end
+
+      # == Rule firing for drop down
+      def fire_populate_drop_down
+        if ui_object = UiObject.find(params[:ui_object_id])
+          if rule = ui_object.rules.find(params[:rule_id])
+            return render :json => {"options" => rule.get_options(params[:object_ids])}.to_json
+          end
+        end
+        render :json => {:error => "Could not find rule"}.to_json
+      end
+
+      # == Rule firing for search
+      def fire_object_search
+        if ui_object = UiObject.find(params[:ui_object_id])
+          if rule = ui_object.rules.find(params[:rule_id])
+            return render :json => {"options" => rule.get_options(params[:q], params[:relatable_category_values])}.to_json
+          end
+        end
+        render :json => {:error => "Could not find rule"}.to_json
+      end
+
+      # seems strange but its true allows
+      # for pagination link to work inside list view
+      # when editing
+      def show
+        end_of_association_chain
+        redirect_to edit_from_context_path
+      end
+
+      # seems strange but its true
+      # allows for pagination link to work
+      # when creating a new answer
+      def index
+        end_of_association_chain
+        redirect_to new_from_context_path
+      end
+      
+      def enforce_permission
+        # override to force permission on the answer object
+      end
+    
+      protected
+      def create_success_flash_message
+        "Your co2 was #{@answer.result["calculations"]["co2"]["value"]} #{@answer.result["calculations"]["co2"]["units"]}"
+      end
+      
+      def update_success_flash_message
+        "Your co2 was updated to #{@answer.result["calculations"]["co2"]["value"]} #{@answer.result["calculations"]["co2"]["units"]}"
+      end
+      
+      def question_chain_answer_path
+        contexts = @contexts.dup
+        contexts << :answers
+        self.send(path_method_from_contexts(contexts), {:context => @context, :question_id => @question.id})
+      end
+ 
+      def question_chain_update_answer_path
+        contexts = @contexts.dup
+        contexts << :answer
+        self.send(path_method_from_contexts(contexts), {:context => @context, :question_id => @question.id, :id => resource.id})
+      end
+
+      # allows the ui to know what values have been set 
+      # and therefore sets the ui_objects values
+      #
+      # @param [Hash] question hash representation of the question
+      # @param [Hash] answer_params
+      def set_answer_values_on_question!(question_hash, answer)
+        answer.each_pair do |key, value| 
+          question_hash.ui_groups.map{|group| group.ui_objects}.flatten.each do |ui_object|
+            if ui_object.name == key.to_s
+              ui_object.value = value
+            end
+          end
+        end
+      end
+
+      # @param [Question] calculator_id
+      # @param [Hash] answer_params
+      # @return [Hash] the result from the co2 computation
+      #   which many container errors
+      def get_answer(question, answer_params)
+        if computation_id = answer_params[:computation_id].blank? ? question.computation_id : answer_params[:computation_id]
+          QuestionChain.calculated_session.answer_for_computation(computation_id, answer_params)
+        elsif calculator_id = question.calculator_id
+          QuestionChain.calculated_session.answer_for_calculator(calculator_id, answer_params)
+        end
+      end
+
+      # we false the generation of any normal errors
+      # on the answer and merge in the carboncalculated 
+      # errors as well
+      #
+      # base errors are in the form of an array
+      # errors that have fields are in the form of a hash
+      def build_answer_errors!
+        if @answer.result[:errors]
+          @answer.valid?
+          if @answer.result[:errors].is_a?(Hash)
+            @answer.errors.merge!(@answer.result[:errors])
+          else
+            @answer.errors.merge!({:base => @answer.result[:errors]})
+          end
+          @answer.errors.each_pair{|key, value| value.respond_to?(:flatten!) ? value.flatten! : value}
+          @answer.instance_exec(@answer) do |answer| 
+            def answer.valid?
+              false
+            end
+            # we dont want this to update any attributes if its invalid!
+            # this results in a very strange BUG! if not applied
+            def answer.update_attributes(attributes)
+              false
+            end
+          end
+        end
+      end
+
+      def find_question_ids
+        if template = get_chain_template_for_resource(parent_type.to_s)
+          template["context"][params[:context]]
+        else
+          # render not found or something
+        end
+      end
+
+      def question_from_context
+        if question_id = params[:question_id]
+           Question.find!(question_id).to_hash
+        else
+           ids = find_question_ids
+           Question.find!(ids.first).to_hash
+        end
+      end
+
+      def resource_collection_name
+        @context
+      end
+
+      # handle single resource case scenerio via singularize
+      def resource
+        if resource_collection_name.singularize == resource_collection_name
+          get_resource_ivar || set_resource_ivar(end_of_association_chain)
+        else
+          get_resource_ivar || set_resource_ivar(end_of_association_chain.find(params[:id]))
+        end
+      end
+
+      def collection
+         get_collection_ivar || set_collection_ivar(end_of_association_chain.paginate(:page => params[:page], :per_page => 25, :order => :created_at.desc))
+      end
+
+      def get_context
+        @context = params[:context]
+      end
+
+      # Loads the contexts and any parent resources
+      # to allow easy generation of urls back to 
+      # the context enclosing resources
+      def load_contexts(enclosed_parent = nil)
+        end_of_association_chain
+        @contexts = [] if @contexts.nil?
+        enclosed_parent = enclosed_parent.nil? ? self.parent : enclosed_parent
+        unless @contexts.include?(enclosed_parent)
+          @contexts << enclosed_parent
+          if chain_template = get_chain_template_for_resource(parent.class.name.downcase)
+            if parent_resource = chain_template.parent_resource
+              resource = parent.send(parent_resource)
+              instance_variable_set("@#{parent_resource}", resource)
+              load_contexts(resource)
+            end
+          end
+        end
+        @contexts.reverse!
+      end
+
+      def new_from_context_path
+        new_polymorphic_path(@contexts)
+      end
+
+      def edit_from_context_path
+        new_polymorphic_path(@contexts)
+      end
+
+      # if a method matching the context and action that will be called
+      # otherwise the polymorphic path is used
+      def create_success_path
+        if self.respond_to?(path_method_from_contexts(@contexts, "create_success_"))
+          self.send(path_method_from_contexts(@contexts, "create_success_"))
+        else
+          polymorphic_path(@contexts)  
+        end
+      end
+
+      # builds a url method from the contexts and a given action
+      # @param [String] action
+      #
+      # @return [String] url method call
+      def path_method_from_contexts(contexts, action = "")
+        url_method = contexts.inject("#{action}") do |string, parent|
+          segment = (parent.is_a?(Symbol)) ? parent.to_s : ActiveModel::Naming.singular(parent)
+          string << segment
+          string << "_"
+        end
+        url_method << "path"
+        url_method
+      end
+
+      # if a method has been decleared of a specific update that is called
+      # otherwise the default polymophic path is used
+      def update_success_path
+        if self.respond_to?(path_method_from_contexts(@contexts, "update_success_"))
+          self.send(path_method_from_contexts(@contexts, "update_success_"))
+        else
+          polymorphic_path(@contexts)  
+        end
+      end
+
+      def get_chain_template_for_resource(for_resource)
+        ChainTemplate.first(:model_state => "active", :for_resource => for_resource, :account_id => @account.try(:id)) ||
+        ChainTemplate.first(:model_state => "active", :for_resource => for_resource)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Answers
+  class QuestionView < MustacheRails
+    
+    def name
+      question.name
+    end
+    
+    def label
+      question.label
+    end
+    
+    def description
+      question.description
+    end
+    
+    private
+    def question
+      @question ||= context[:_question]
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module Answers
+  class UiObjectView < MustacheRails
+    
+    def dom_id
+      "ui_object_#{ui_object.id}"
+    end
+    
+    def input_id
+      "ui_input_#{ui_object.id}"
+    end
+    
+    def extra_info
+      ui_object.try(:extra_info)
+    end
+    
+    def css_classes
+      ui_object.css_classes.join(" ")
+    end
+    
+    def has_extra_info
+      !extra_info.blank?
+    end
+    
+    def label
+      ui_object.label
+    end
+    
+    def value
+      answer_params[ui_object_name] if answer_params
+    end
+    
+    def ui_object_name
+      ui_object.name
+    end
+    
+    def name
+      "answer[#{ui_object.name}]"
+    end
+    
+    def default_value
+      ui_object.default_value
+    end
+    
+    def default_styles
+      default_styles = ""
+      ui_object.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 disabled
+      ui_object.ui_attributes["disable"] == "true"
+    end
+    
+    protected
+    def ui_object
+      @ui_object ||= context[:_ui_object]
+    end
+    
+    def answer_params
+      @answer_params ||= context[:_answer_params]
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Answers
+  class UiObjectsCheckBoxView < Answers::UiObjectView
+    
+    def value
+      super || default_value
+    end
+    
+    def checked
+      if value 
+        !value.nil?
+      else 
+        ui_object.ui_attributes[:checked]
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,16 @@
+module Answers
+  class UiObjectsDropDownView < Answers::UiObjectView
+    
+    def prompt
+      ui_object.prompt
+    end
+        
+    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_hidden_field_view.rb

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

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

@@ -0,0 +1,18 @@
+module Answers
+  class UiObjectsObjectReferenceDropDownView < 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_object_search_view.rb

@@ -0,0 +1,22 @@
+module Answers
+  class UiObjectsObjectSearchView < Answers::UiObjectView
+    
+    def search_name
+      "answer[search_#{name}]"
+    end
+    
+    def search_id
+      "search_#{dom_id()}"
+    end
+    
+    def search_value
+      if answer_params
+        answer_params["search_answer"][ui_object_name]
+      end
+    end
+    
+    def value
+      super || default_value
+    end   
+  end
+end