amee-data-abstraction 1.2.0 → 1.3.0

data/spec/amee-data-abstraction/drill_spec.rb

@@ -1,21 +1,30 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
+
 describe Drill do
+  
+  
+  before :all do
+    @calc = CalculationSet.find("transport")[:transport]
+  end
+  
   it 'knows its options when it is the first choice' do
     AMEEMocker.new(self,:path=>'transport/car/generic',
       :selections=>[],
       :choices=>['diesel','petrol']).drill
-    Transport.begin_calculation[:fuel].send(:choices).should eql ['diesel','petrol']
+    @calc.begin_calculation[:fuel].send(:choices).should eql ['diesel','petrol']
   end
+
   it 'knows its options when it is a later choice' do
     AMEEMocker.new(self,:path=>'transport/car/generic',
       :selections=>[['fuel','diesel']],
       :choices=>['large','small']).drill
-    t=Transport.begin_calculation
+    t=@calc.begin_calculation
     t[:fuel].value 'diesel'
     t[:size].send(:choices).should eql ['large','small']
   end
-  it 'is enabled iff it is the next choice or has been chosen' do
-    t=Transport.begin_calculation
+
+  it 'is enabled if it is the next choice or has been chosen' do
+    t=@calc.begin_calculation
     t[:fuel].enabled?.should be_true
     t[:size].enabled?.should be_false
     t[:fuel].value 'diesel'
@@ -25,14 +34,32 @@ describe Drill do
     t[:fuel].enabled?.should be_true
     t[:size].enabled?.should be_true
   end
-  it 'is valid iff assigned a choice in the choices' do
+
+  it 'is valid if assigned a choice in the choices' do
     AMEEMocker.new(self,:path=>'transport/car/generic',
       :selections=>[],
       :choices=>['diesel','petrol']).drill
-    t=Transport.begin_calculation
+    t=@calc.begin_calculation
     t[:fuel].value 'diesel'
     t[:fuel].send(:valid?).should be_true
     t[:fuel].value 'banana'
     t[:fuel].send(:valid?).should be_false
   end
+
+  it "should set and get custom choices" do
+    t=@calc.begin_calculation
+    t[:fuel].choices 'anthracite', 'lignite'
+    t[:fuel].choices.should eql ['anthracite', 'lignite']
+  end
+
+  it 'is sets correct single choice if AMEE skips during drill' do
+    mocker = AMEEMocker.new(self,:path=>'transport/car/generic',
+      :selections=>[['fuel','diesel']])
+    mocker.drill_with_skip('size'=>'small')
+    t=@calc.begin_calculation
+    t[:fuel].value 'diesel'
+    t[:fuel].should_not be_disabled
+    t[:size].choices.should eql ['small']
+    t[:size].should be_disabled
+  end
 end

data/spec/amee-data-abstraction/input_spec.rb

@@ -1,77 +1,117 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 describe Input do
- it 'can be given a fixed value' do
-   i=Input.new{fixed 6}
-   i.value.should eql 6
-   i.fixed?.should be_true
-   lambda{i.value 7}.should raise_error Exceptions::FixedValueInterference
- end
- it 'raises exception when invalid' do
-   i=Input.new{validation /bark/}
-   i.value 'barking'
-   lambda{i.validate!}.should_not raise_error
-   i.value.should eql 'barking'
-   i.value 'marking'
-   lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
-   j=Input.new{}
-   j.value 'marking'
-   j.value.should eql 'marking'
- end
- it "can accept a numeric symbol validation" do
-   i=Input.new{validation :numeric}
-   i.value 3
-   lambda{i.validate!}.should_not raise_error
-   i.value '3'
-   lambda{i.validate!}.should_not raise_error
-   i.value 'e'
-   lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
- end
- it "can accept a date symbol validation" do
-   i=Input.new{validation :date}
-   i.value Date.today
-   lambda{i.validate!}.should_not raise_error
-   i.value '2011-01-01'
-   lambda{i.validate!}.should_not raise_error
-   i.value 'e'
-   lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
- end
+  
+  it 'can be given a fixed value' do
+    i=Input.new{fixed 6}
+    i.value.should eql 6
+    i.fixed?.should be_true
+    lambda{i.value 7}.should raise_error Exceptions::FixedValueInterference
+  end
 
- it "can accept a time symbol validation" do
-   i=Input.new{validation :datetime}
-   i.value DateTime.now
-   lambda{i.validate!}.should_not raise_error
-   i.value '2011-01-01 09:00:00'
-   lambda{i.validate!}.should_not raise_error
-   i.value 'e'
-   lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
- end
- it 'can have custom validation message' do
-   i=Input.new{label :woof; validation /bark/; validation_message {"#{value} does not match pattern /bark/"}}
-   i.value 'marking'
-   lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation,"marking does not match pattern /bark/"
-   j=Input.new{}
-   j.value 'marking'
-   j.value.should eql 'marking'
- end
- it 'can have default validation message' do
-   i=Input.new{label :woof; validation /bark/}
-   i.value 'barking'
-   lambda{i.validate!}.should_not raise_error
-   i.value.should eql 'barking'
-   i.value 'marking'
-   lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation,"Woof is invalid."
-   j=Input.new{}
-   j.value 'marking'
-   j.value.should eql 'marking'
- end
- it 'is always valid if it is fixed' do
-   i=Input.new{fixed 5; validation /7/}
-   lambda{i.validate!}.should_not raise_error
-   i.value.should eql 5
- end
- it 'is always disabled if it is fixed' do
-   i=Input.new{fixed 5}
-   i.disabled?.should eql true
- end
+  it "can be made optional" do
+    i=Input.new{label :mass; value 6}
+    i.should_not be_optional
+    i.should be_compulsory
+    i.optional!
+    i.should be_optional
+    i.should_not be_compulsory
+  end
+
+  it "can be made compulsory" do
+    i=Input.new{label :mass; value 6}
+    i.should_not be_optional
+    i.optional!
+    i.should be_optional
+    i.should_not be_compulsory
+    i.compulsory!
+    i.should_not be_optional
+    i.should be_compulsory
+  end
+
+  it 'raises exception when invalid' do
+    i=Input.new{validation /bark/}
+    i.value 'barking'
+    lambda{i.validate!}.should_not raise_error
+    i.value.should eql 'barking'
+    i.value 'marking'
+    lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
+    j=Input.new{}
+    j.value 'marking'
+    j.value.should eql 'marking'
+  end
+
+  it "can accept a numeric symbol validation" do
+    i=Input.new{validation :numeric}
+    i.value 3
+    lambda{i.validate!}.should_not raise_error
+    i.value '3'
+    lambda{i.validate!}.should_not raise_error
+    i.value 'e'
+    lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
+  end
+
+  it "can accept a date symbol validation" do
+    i=Input.new{validation :date}
+    i.value Date.today
+    lambda{i.validate!}.should_not raise_error
+    i.value '2011-01-01'
+    lambda{i.validate!}.should_not raise_error
+    i.value 'e'
+    lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
+  end
+
+  it "can accept a time symbol validation" do
+    i=Input.new{validation :datetime}
+    i.value DateTime.now
+    lambda{i.validate!}.should_not raise_error
+    i.value '2011-01-01 09:00:00'
+    lambda{i.validate!}.should_not raise_error
+    i.value 'e'
+    lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation
+  end
+
+  it "should start with dirty set as false" do
+    i=Input.new{fixed 5}
+    i.dirty?.should eql false
+  end
+
+  it "should be dirty when the value is changed" do
+    i=Input.new
+    i.value 5
+    i.dirty?.should eql true
+  end
+
+  it 'can have custom validation message' do
+    i=Input.new{label :woof; validation /bark/; validation_message {"#{value} does not match pattern /bark/"}}
+    i.value 'marking'
+    lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation,"marking does not match pattern /bark/"
+    j=Input.new{}
+    j.value 'marking'
+    j.value.should eql 'marking'
+  end
+
+  it 'can have default validation message' do
+    i=Input.new{label :woof; validation /bark/}
+    i.value 'barking'
+    lambda{i.validate!}.should_not raise_error
+    i.value.should eql 'barking'
+    i.value 'marking'
+    lambda{i.validate!}.should raise_error Exceptions::ChoiceValidation,"Woof is invalid."
+    j=Input.new{}
+    j.value 'marking'
+    j.value.should eql 'marking'
+  end
+
+  it 'is always valid if it is fixed' do
+    i=Input.new{fixed 5; validation /7/}
+    lambda{i.validate!}.should_not raise_error
+    i.value.should eql 5
+  end
+
+  it 'is always disabled if it is fixed' do
+    i=Input.new{fixed 5}
+    i.disabled?.should eql true
+  end
+  
 end

data/spec/amee-data-abstraction/metadatum_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 describe Metadatum do
  it 'defaults to be a drop-down' do

data/spec/amee-data-abstraction/ongoing_calculation_spec.rb

@@ -1,7 +1,15 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
+
 describe OngoingCalculation do
+
+  before :all do
+    @elec = CalculationSet.find("electricity")[:electricity]
+    @transport = CalculationSet.find("transport")[:transport]
+    @elec_and_transport = CalculationSet.find("electricity_and_transport")
+  end
+
   it 'can return set and unset inputs' do
-    d=Electricity.begin_calculation
+    d=@elec.begin_calculation
     d.inputs.set.labels.should eql [:country]
     d.inputs.unset.labels.should eql [:energy_used]
     d[:energy_used].value :somevalue
@@ -9,7 +17,7 @@ describe OngoingCalculation do
     d.inputs.unset.labels.should eql []
   end
   it 'can return set and unset terms' do
-    d=Electricity.begin_calculation
+    d=@elec.begin_calculation
     d.set.labels.should eql [:country]
     d.unset.labels.should eql [:energy_used,:co2]
     d[:energy_used].value :somevalue
@@ -17,19 +25,27 @@ describe OngoingCalculation do
     d.unset.labels.should eql [:co2]
   end
   it 'can return set and unset outputs' do
-    d=Electricity.begin_calculation
+    d=@elec.begin_calculation
     d.outputs.set.labels.should eql []
     d.outputs.unset.labels.should eql [:co2]
     d[:co2].value 5
     d.outputs.set.labels.should eql [:co2]
     d.outputs.unset.labels.should eql []
   end
+  it 'can clear outputs' do
+    d=@elec.begin_calculation
+    d.outputs.unset.labels.should eql [:co2]
+    d[:co2].value 5
+    d[:co2].value.should eql 5
+    d.clear_outputs
+    d[:co2].value.should be_nil
+  end
   it 'can have values chosen' do
     AMEEMocker.new(self,:path=>'business/energy/electricity/grid',
       :selections=>[['country','argentina']],
       :choices=>[]).drill
 
-    d=Electricity.begin_calculation
+    d=@elec.begin_calculation
 
     d.inputs.set.values.should eql ['argentina']
     d.inputs.unset.values.should eql [nil]
@@ -43,7 +59,7 @@ describe OngoingCalculation do
     AMEEMocker.new(self,:path=>'business/energy/electricity/grid',
       :selections=>[['country','argentina']],
       :choices=>[]).drill
-    d=Electricity.begin_calculation
+    d=@elec.begin_calculation
     d.satisfied?.should be_false
     d.choose!(:energy_used=>5.0)
     d.satisfied?.should be_true
@@ -58,7 +74,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    t=Transport.begin_calculation
+    t=@transport.begin_calculation
     t.terms.labels.should eql [:fuel,:size,:distance,:co2]
     t.satisfied?.should be_false
 
@@ -67,13 +83,13 @@ describe OngoingCalculation do
     t.inputs.unset.labels.should eql [:size,:distance]
     t.satisfied?.should be_false
 
-    t2=Transport.begin_calculation
+    t2=@transport.begin_calculation
     t2.choose!('fuel'=>'diesel','size'=>'large')
     t2.inputs.set.labels.should eql [:fuel,:size]
     t2.inputs.unset.labels.should eql [:distance]
     t2.satisfied?.should be_false
 
-    t3=Transport.begin_calculation
+    t3=@transport.begin_calculation
     t3.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     t3.inputs.set.labels.should eql [:fuel,:size,:distance]
     t3.inputs.unset.labels.should eql []
@@ -92,7 +108,7 @@ describe OngoingCalculation do
     mocker.choices=[]
     mocker.drill
     mocker.profile_list.profile_category.timestamp.create_and_get
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
     mycalc.outputs.first.value.should eql :somenumber
@@ -110,7 +126,7 @@ describe OngoingCalculation do
     mocker.choices=[]
     mocker.drill
     mocker.profile_list.profile_category.timestamp.create_and_get
-    mycalc=ElectricityAndTransport[:transport].begin_calculation
+    mycalc=@elec_and_transport[:transport].begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5,'department'=>'stuff')
     mycalc.calculate!
     mycalc.outputs.first.value.should eql :somenumber
@@ -134,7 +150,7 @@ describe OngoingCalculation do
   #end
 
   it 'can be supplied just a UID, and recover PIVs and drill values from AMEE' do
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mocker=AMEEMocker.new(self,:path=>'transport/car/generic',
       :result=>:somenumber,
       :existing=>{'distance'=>5},:choices=>['petrol','diesel'])
@@ -151,7 +167,7 @@ describe OngoingCalculation do
   end
 
   it 'refuses to load values from AMEE which conflict with local drill values' do
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mocker=AMEEMocker.new(self,:path=>'transport/car/generic',
       :result=>:somenumber,
       :existing=>{'distance'=>7},
@@ -187,7 +203,7 @@ describe OngoingCalculation do
     mocker.choices=[]
     mocker.drill
     mocker.profile_list.update.get(true)
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose!(:profile_item_uid=>mocker.uid,'fuel'=>'diesel','size'=>'large','distance'=>9)
     mycalc.calculate!
     mycalc[:distance].value.should eql 9
@@ -211,7 +227,7 @@ describe OngoingCalculation do
     mocker.params={'distance'=>9}
     mocker.update.get(true)
 
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>9)
@@ -236,7 +252,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'small')
     mocker.drill.create_and_get
     
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
     mycalc.choose!('fuel'=>'diesel','size'=>'small')
@@ -245,7 +261,7 @@ describe OngoingCalculation do
   end
 
   it 'memoizes profile information, but not across a pass' do
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mocker=AMEEMocker.new(self,:path=>'transport/car/generic',
       :result=>:somenumber,
       :existing=>{'distance'=>5},:choices=>['petrol','diesel'])
@@ -277,7 +293,7 @@ describe OngoingCalculation do
     mocker.choices=[]
     mocker.drill
     mocker.profile_list.profile_category.timestamp.create_and_get
-    myproto=Transport.clone
+    myproto=@transport.clone
     myproto.instance_eval{
       start_and_end_dates
     }
@@ -300,7 +316,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    myproto=Transport.clone
+    myproto=@transport.clone
     myproto.instance_eval{
       start_and_end_dates
     }
@@ -310,7 +326,7 @@ describe OngoingCalculation do
   end
 
   it 'starts off dirty' do  
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.should be_dirty
   end
 
@@ -327,7 +343,7 @@ describe OngoingCalculation do
     mocker.choices=[]
     mocker.drill
     mocker.profile_list.profile_category.timestamp.create_and_get
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.should be_dirty
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
@@ -349,7 +365,7 @@ describe OngoingCalculation do
     mocker.choices=[]
     mocker.drill
     mocker.profile_list.profile_category.timestamp.create_and_get
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.should be_dirty
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
@@ -372,7 +388,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'marge')
     mocker.choices=[]
     mocker.drill
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     lambda{mycalc.choose!('fuel'=>'diesel','size'=>'marge','distance'=>5)}.should raise_error Exceptions::ChoiceValidation
     mycalc.invalidity_messages.keys.should eql [:size]
   end
@@ -389,7 +405,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'marge')
     mocker.choices=[]
     mocker.drill
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose('fuel'=>'diesel','size'=>'marge','distance'=>5).should be_false
     mycalc.invalidity_messages.keys.should eql [:size]
   end
@@ -406,12 +422,12 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose('fuel'=>'diesel','size'=>'large','distance'=>5).should be_true
   end
 
   it 'can blank individual term attributes with empty string' do
-    myproto=Transport.clone
+    myproto=@transport.clone
     mycalc=myproto.begin_calculation
     mycalc.choose_without_validation!('fuel'=>'diesel','size'=>'large','distance'=>{:value =>5, :unit=> Unit.km})
     mycalc['fuel'].value.should eql 'diesel'
@@ -426,7 +442,7 @@ describe OngoingCalculation do
   end
 
   it 'can blank individual term attributes with nil' do
-    myproto=Transport.clone
+    myproto=@transport.clone
     mycalc=myproto.begin_calculation
     mycalc.choose_without_validation!('fuel'=>'diesel','size'=>'large','distance'=>{:value =>5, :unit=> Unit.km})
     mycalc['fuel'].value.should eql 'diesel'
@@ -441,7 +457,7 @@ describe OngoingCalculation do
   end
 
     it 'can update individual term attributes without nullifying others' do
-    myproto=Transport.clone
+    myproto=@transport.clone
     mycalc=myproto.begin_calculation
     mycalc.choose_without_validation!('fuel'=>'diesel','size'=>'large','distance'=>{:value =>5, :unit=> Unit.km})
     mycalc['fuel'].value.should eql 'diesel'
@@ -482,7 +498,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'marge')
     mocker.choices=[]
     mocker.drill
-    mycalc=Transport.begin_calculation
+    mycalc=@transport.begin_calculation
     mycalc.choose('fuel'=>'diesel','size'=>'marge','distance'=>5).should be_false
     mycalc.invalidity_messages.keys.should eql [:size]
     mycalc[:size].value.should eql 'marge'