question_chain 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,19 +2,123 @@
 
 == 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; 
 
-There will be guides on how to use this http://guides.carboncalculated.com
+This Rails3 Engine allows you to create a forms for Carbon Calculations in like 2 sometimes 3 minutes depending on typing speed.
 
-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
+== Dependencies 
 
-This Gem allows you to create a forms for Carbon Calculations in like 2 sometimes 3 minutes depending on typing speed
+MongoMapper 0.9.0
 
-At the minute this has dependencies on MongoMapper currently thinking about moving to more ORM agnostic approach
+Mongoid 2.0.0 (mongoid branch)
+
+Note you will have to go through a few hoops to get this working currently however once you have UI for carbon calculations 
+can be generated very very quickly!
+
+If you really want to dive in then please look at this example application using question chain; 
+
+https://github.com/carboncalculated/example-question-chain-application
 
 == Getting started
 
+Firstly You will need to be using creating a Rails3 Application;
+
+add question_chain to your Gemfile
+
+    gem "question_chain"
+
+you will also need the QuestionChainJS https://github.com/carboncalculated/QuestionChainJS
+
+This is currently Mootools dependent;
+
+== Setup
+
+You will need to create a method (calculated_session) on your Rails Application Module; as question_chain 
+will look for a calculated session here when it talks to the carbon calculated API
+
+    module YourApplication
+      def self.calculated_session
+        @session ||= Calculated::Session.create(:api_key => ENV[:api_key])
+      end
+    end
+
+=== Background Information
+
+With quesition_chain you are given a Rails3 Engine; this engine provides you with the following;
+
+* Controller Module: (QuestionChain::Answers) For creating editing models that emit carbon (ie Journey; Material; Waste; Car)
+
+* Model Module: (QuestionChain::Answerable) Helper Methods for any model that emits carbon.
+
+* ChainTemplate: Defines context of where in your application your emitting models are located and what if any parent resources 
+it has; example 
+
+* Question: You build a "Question" its this quesition id (4babb5fef78b124341000002) that is then rendered for calculations in the UI
+
+Please look at the example application that uses this Gem; before you go any further
+
+=== Questions
+
+This is where you can build up your UI for the question you wish to ask to calculated emissions;
+
+*  "What was your origin airport and destination airport?"
+*  "How many miles did you travel in your car?"
+*  "What material and how many tones of it do you use?"
+
+Each question will relate to the CarbonCalcualated API! therefore a question will need either a 
+computation_id or a calculator_id
+  
+At the minute there is no UI for creating these question however there are example rake tasks that can be
+seen in the example application
+
+=== ChainTemplate
+
+This where you can define "calculation contexts"; what does that mean? this is where you can say what resource
+emits and its association with another resource; Example below is basically saying for user class it has 
+many flights these flights are to seen as a QuestionChain Question; Its the flight that emits Carbon!
+    
+    ChainTemplate.create!(
+    :for_resource => "user",
+    :context => {
+      "flights" => ["4babb5fef78b124341000002"]
+    })
+    
+=== Controllers
+
+=== Routing
+
+There is currently not a helper for the routing however this is an example structure to get an application working 
+where the context is a calculation model
+
+    # == Have yet to create a Routing helper from question Chain
+    # Hence manua here and this is about is obvious well its just not
+    match '/answers/fire_object_search' => 'answers#fire_object_search'
+    match '/answers/fire_populate_drop_down' => 'answers#fire_populate_drop_down'
+
+    chain_template_routes = lambda do
+      scope "/:context(/:question_id)" do
+        resources :answers, :only => [:new, :create, :index] do
+          collection do
+             post :fire_populate_drop_down
+             post :fire_object_search
+           end
+        end
+      end
+
+      scope "/:context" do
+        resources :answers, :only => [:edit, :update, :show] do
+          collection do
+             post :fire_populate_drop_down
+             post :fire_object_search
+           end
+        end
+      end
+    end
+
+    resource :users do
+      chain_template_routes.call
+    end
+
 == UiObjects
 
 === Drop Downs
@@ -30,5 +134,3 @@ At the minute this has dependencies on MongoMapper currently thinking about movi
 ===  Markup
 
 === CSS
-
-=== Bundling

data/lib/question_chain/answerable.rb

@@ -2,6 +2,7 @@ module QuestionChain
   module Answerable
     extend ActiveSupport::Concern
     include MongoMapper::Serialize
+    
   
     included do
       key :question_id, ObjectId
@@ -22,7 +23,7 @@ module QuestionChain
       before_save :cache_attributes
       
       # == Search
-      plugin Hunt
+      include Hunt
       searches :reference, :created_by, :stored_variable_input, :stored_identifier, :_extra_keywords
       ensure_index :'searches.default'
       
@@ -35,8 +36,9 @@ module QuestionChain
       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
+      validates_presence_of :user
+      validate :valid_answer_params
+      validate :valid_result
       
       # == Associations
       belongs_to :user
@@ -45,25 +47,7 @@ module QuestionChain
       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?
@@ -134,9 +118,18 @@ module QuestionChain
       end
       
       def cache_attributes
-        write_attribute(:created_by, user.full_name)
+        write_attribute(:created_by, user.full_name) if user && user.respond_to?(:full_name)
         write_attribute(:stored_variable_input, variable_input)
       end
+      
+      def valid_answer_params
+        errors.add(:answer_params, "") if answer_params.empty?
+      end
+      
+      def valid_result
+        errors.add(:result, "") if result.empty?
+      end
     end
+    
   end
 end

data/lib/question_chain/models/chain_template.rb

@@ -29,7 +29,7 @@ class ChainTemplate
   # == Validations
   validates_presence_of :for_resource
   validates_presence_of :context
-  validates_true_for :context, :logic => Proc.new{ !context.empty?}
+  validate :valid_context
   
   def self.attributes_for_api
     %w(id name for_resource account_id parent_resource)
@@ -40,4 +40,8 @@ class ChainTemplate
     self.active_at = Time.now
     self.save!
   end
+  
+  def valid_context
+    errors.add(:context, "") if context.empty?
+  end
 end

data/lib/question_chain/models/ui_object.rb

@@ -33,9 +33,7 @@ class UiObject
   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?
-  }
+  validate :valid_ui_attributes
   validates_associated :rules
   
   # == Associations
@@ -44,7 +42,7 @@ class UiObject
   
   # == Hooks
   before_save :add_rule_observers!
-  before_validation_on_create :set_default_attributes
+  before_validation :set_default_attributes, :on => :create
   
   def self.attributes_for_api
     %w(id name _type label description default_value ui_attributes ui_group_id rules extra_info css_classes)
@@ -88,5 +86,9 @@ class UiObject
       self.add_observer(rule, :fire!)
     end
   end
+  
+  def valid_ui_attributes
+    errors.add(:ui_attributes, "") if ui_attributes.empty?
+  end
 
 end

data/lib/question_chain/state_machine.rb

@@ -5,7 +5,7 @@ module MongoMapper
     included do
       include ::Transitions
       key :model_state, String
-      before_validation_on_create :set_initial_state
+      before_validation :set_initial_state, :on => :create
       validates_presence_of :model_state
     end
     

data/lib/question_chain/version.rb

@@ -1,3 +1,3 @@
 module QuestionChain
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/question_chain.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |s|
   s.authors     = ["Richard Hooker"]
   s.email       = ["richard.hooker@carboncalculated.com"]
   s.homepage    = ""
-  s.summary     = %q{Rails3 Gem to Generate Carbon Calculated Application}
-  s.description = %q{Rails3 Gem to Generate Carbon Calculated Application}
+  s.summary     = %q{Rails3 Gem to Generate Carbon Calculated Applications}
+  s.description = %q{Rails3 Gem to Generate Carbon Calculated Applications}
 
   s.rubyforge_project = "question_chain"
   
   s.add_dependency 'mustache',         '>= 0.98.0'
-  s.add_dependency 'mongo_mapper',     '>= 0.8.1'
+  s.add_dependency 'mongo_mapper',     '~> 0.9.0'
   s.add_dependency 'mustache',         '>= 0.98.0'
   s.add_dependency 'hashie',           ">= 0.2.1"
   s.add_dependency 'crack',            ">= 0.1.8"

data/test_app/Gemfile

@@ -1,12 +1,12 @@
 source 'http://rubygems.org'
 
 ## Bundle the gems you use:
-gem "rails", "3.0.5"
+gem "rails", "3.0.7"
 
-gem "bson_ext", "1.2.4"
+gem "bson_ext", "1.3.0"
 gem "inherited_resources"
-gem "mongo_mapper", "0.8.6"
-gem "hunt"
+gem "mongo_mapper", "~> 0.9.0"
+gem "hunt", :git => "git://github.com/hookercookerman/hunt.git"
 gem "transitions"
 gem "question_chain", :path =>File.expand_path("../../", __FILE__), :require => "question_chain"
 gem "yard"

data/test_app/environments/test.rb

@@ -26,5 +26,5 @@ TestApp::Application.configure do
   config.action_mailer.delivery_method = :test
   
   # Print deprecation notices to the stderr
-  config.active_support.deprecation to :stderr
+  config.active_support.deprecation = :stderr
 end

data/test_app/spec/factories.rb

@@ -15,11 +15,17 @@ Factory.sequence :related_attribute do |n|
   "related_attribute_#{n}"
 end
 
+Factory.define :user do |f|
+  f.first_name {"Egg"}
+  f.last_name {"Beans"}
+end
+
 Factory.define :flight do |f|
   f.question_id {BSON::ObjectId.new}
   f.result{ {"co2"=> "45.5", "object_references" => {"123" => {"identifier" => "beans"}}}}
   f.answer_params {{"flight" => "123"}}
   f.reference {Factory.next(:name)}
+  f.association :user
 end
 
 Factory.define :chain_template do |f|

data/test_app/spec/models/flight_spec.rb

@@ -8,14 +8,14 @@ describe "Flight (Test Model)" do
       end
 
       it "should have answerable keys" do
-        @flight.keys.should include(:question_id)
-        @flight.keys.should include(:result)
-        @flight.keys.should include(:answer_params)
-        @flight.keys.should include(:answer_json)
-        @flight.keys.should include(:user_id)
-        @flight.keys.should include(:reference)
-        @flight.keys.should include(:stored_identifier)
-        @flight.keys.should include(:_extra_keywords)
+        @flight.keys.should include("question_id")
+        @flight.keys.should include("result")
+        @flight.keys.should include("answer_params")
+        @flight.keys.should include("answer_json")
+        @flight.keys.should include("user_id")
+        @flight.keys.should include("reference")
+        @flight.keys.should include("stored_identifier")
+        @flight.keys.should include("_extra_keywords")
       end
       
       it "Should have access to _extra_keyword class method" do
@@ -63,8 +63,8 @@ describe "Flight (Test Model)" do
         flights.first.should == @flight
       end
       
-      it "should not be found on a silly search like eggs" do
-        flights = Flight.search "eggs"
+      it "should not be found on a silly search like crumpets" do
+        flights = Flight.search "crumpets"
         flights.should be_empty
       end
     end

data/test_app/spec/models/ui_group_spec.rb

@@ -32,7 +32,7 @@ describe "UiGroup" do
       @ui_group = Factory.build(:ui_group)
       @text_field = @ui_group.text_fields.create!(Factory.attributes_for(:text_field))
       @relatable_category_drop_down = @ui_group.relatable_category_drop_downs.create!(Factory.attributes_for(:relatable_category_drop_down))
-      @object_referenece_drop_down = @ui_group.object_reference_drop_down.create!(Factory.attributes_for(:object_reference_drop_down))
+      @object_referenece_drop_down = @ui_group.create_object_reference_drop_down(Factory.attributes_for(:object_reference_drop_down))
     end
     
     it "should have 3 ui_objects" do

data/test_app/spec/spec_helper.rb

@@ -4,6 +4,19 @@ require 'rspec/rails'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
+class User
+  include MongoMapper::Document
+  
+  # == Keys
+  key :first_name, String
+  key :last_name, String
+  
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+end
+
+
 require File.expand_path("../factories", __FILE__)
 
 require "database_cleaner"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Richard Hooker
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 +01:00
+date: 2011-04-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,13 +38,13 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 8
-        - 1
-        version: 0.8.1
+        - 9
+        - 0
+        version: 0.9.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -152,7 +152,7 @@ dependencies:
         version: 0.3.0
   type: :runtime
   version_requirements: *id009
-description: Rails3 Gem to Generate Carbon Calculated Application
+description: Rails3 Gem to Generate Carbon Calculated Applications
 email: 
 - richard.hooker@carboncalculated.com
 executables: []
@@ -244,7 +244,6 @@ files:
 - test_app/lib/tasks/yard.rake
 - test_app/public/.gitkeep
 - test_app/script/rails
-- test_app/spec/acceptance/new_spec
 - test_app/spec/factories.rb
 - test_app/spec/models/chain_template_spec.rb
 - test_app/spec/models/flight_spec.rb
@@ -286,7 +285,7 @@ rubyforge_project: question_chain
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Rails3 Gem to Generate Carbon Calculated Application
+summary: Rails3 Gem to Generate Carbon Calculated Applications
 test_files: 
 - test_app/Gemfile
 - test_app/Rakefile
@@ -312,7 +311,6 @@ test_files:
 - test_app/lib/tasks/yard.rake
 - test_app/public/.gitkeep
 - test_app/script/rails
-- test_app/spec/acceptance/new_spec
 - test_app/spec/factories.rb
 - test_app/spec/models/chain_template_spec.rb
 - test_app/spec/models/flight_spec.rb

data/test_app/spec/acceptance/new_spec

@@ -1,30 +0,0 @@
-# Todo For Acceptance Specs
-
-# Feature: New Answer (for a Flight)
-#   In order add a new answer for a resource that can have a co2 computation
-#   As an application user
-#   I want to be able create a new answer
-#   
-#   Scenario: New Answer for a flight resource (Question wants a distance and a flight)
-#     Given a flight context exists with a valid question 
-#     When go to the new flight answers page
-#   
-#     Then show me the page 
-#     And I should see "Flight Calculator" within "#question"
-#     And I should see "Please enter flight details" within "#question"
-#     And I should see "Distance" within "#ui_objects"
-#     And I should see "Flight" within "#ui_objects"
-#     And I should see "flight1" within ".ui-objects-object_reference-drop-down-template"
-#     And I should see "flight2" within ".ui-objects-object_reference-drop-down-template"
-#     
-# Feature: Edit Answer (for a Flight)
-#   In order to change the the details of the resource for a carbon calculation so calculations are correct
-#   As an application user
-#   I want to be able create a edit a carbon calculated resource (Flight)
-#   
-#   Scenario: View the edit page for the flight resource
-#     Given a flight context exists with a valid question 
-#     And a flight exists with the id: "3458234509854309534", distance: "12", :flight => "23432234234"
-#     When go to the edit flight answer page
-#     
-