amee-data-abstraction 1.2.0 → 1.3.0

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

@@ -1,4 +1,4 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 describe Profile do
  it 'defaults to be a text-box' do
@@ -10,7 +10,7 @@ describe Profile do
     mocker.item_value_definitions.
       item_definition.data_category.
     item_value_definition('distance',['someusage'],['someotherusage'])
-    t=Transport.clone
+    t=CalculationSet.find("transport")[:transport].clone
     t[:distance].compulsory?('someusage').should eql true
     t[:distance].compulsory?('someotherusage').should eql false
     t[:distance].optional?('someotherusage').should eql true

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

@@ -1,4 +1,4 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 class PrototypeCalculation
   def call_me
@@ -8,8 +8,12 @@ class PrototypeCalculation
   cattr_accessor :called
 end
 describe PrototypeCalculation do
+  before :all do
+    @calc = CalculationSet.find("transport")[:transport]
+  end
+  
   it 'can create an instance' do
-    Transport.should be_a PrototypeCalculation
+    @calc.should be_a PrototypeCalculation
   end
   it 'can be initialized with a DSL block' do
     PrototypeCalculation.new {call_me}
@@ -38,17 +42,17 @@ describe PrototypeCalculation do
     pc[:alpha].should be_a Output
   end
   it 'can construct an ongoing calculation' do
-    Transport.begin_calculation.should be_a OngoingCalculation
+    @calc.begin_calculation.should be_a OngoingCalculation
   end
   it 'should make the terms of the ongoing calculation be their own instances' do
-    oc=Transport.begin_calculation
+    oc=@calc.begin_calculation
     oc[:distance].value :somevalue
     oc[:distance].value.should eql :somevalue
-    Transport[:distance].value.should be_nil
+    @calc[:distance].value.should be_nil
   end
   it 'should copy name, path, label when cloning ongoing' do
     [:path,:name,:label].each do |property|
-      Transport.begin_calculation.send(property).should eql Transport.send(property)
+      @calc.begin_calculation.send(property).should eql @calc.send(property)
     end
   end
   it 'can autogenerate drill terms for itself, based on talking to amee' do
@@ -227,7 +231,7 @@ describe PrototypeCalculation do
     pc.terms.default_per_units.compact.map(&:name).should include 'hour'
   end
   it 'transfers memoised amee information to constructed ongoing calculations' do
-    t=Transport.clone
+    t=@calc.clone
     flexmock(AMEE::Data::Category).should_receive(:get).
       with(AMEE::DataAbstraction.connection,'/data/transport/car/generic').
       once.and_return(true)
@@ -235,7 +239,7 @@ describe PrototypeCalculation do
     t.begin_calculation.send(:amee_data_category)
   end
   it 'can auto-create start and end date metadata' do
-    t=Transport.clone
+    t=@calc.clone
     t.instance_eval{
       start_and_end_dates
     }

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

@@ -1,4 +1,4 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 class Term
   def call_me
@@ -9,6 +9,10 @@ class Term
 end
 
 describe Term do
+  before :all do
+    @calc = CalculationSet.find("transport")[:transport]
+  end
+  
   it 'can be initialized via DSL block' do
     Term.new {call_me}
     Term.called.should be_true
@@ -30,8 +34,13 @@ describe Term do
     Term.new {note 'hello'}.note.should eql 'hello'
   end
 
+  it "has note with no '\"' character" do
+     Term.new {note 'hello "some quote"'}.note.should eql "hello 'some quote'"
+  end
+
+
   it 'has parent' do
-    Transport[:distance].parent.should eql Transport
+    @calc[:distance].parent.should eql @calc
   end
   it "has name defaulting to label" do
     Term.new {label :hello}.name.should eql 'Hello'
@@ -85,17 +94,18 @@ describe Term do
     t.hidden?.should be_false
   end
   it 'knows which terms come before or after it' do
-    Transport.terms.
+    @calc.terms.
       select{|x|x.before?(:distance)}.map(&:label).
       should eql [:fuel,:size]
-    Transport.terms.
+    @calc.terms.
       select{|x|x.after?(:distance)}.map(&:label).
       should eql [:co2]
   end
 
   it "should respond to unit methods" do
     Term.new.methods.should include "unit","per_unit","default_unit","default_per_unit",
-                                    "alternative_units","alternative_per_units"
+                                    "alternative_units","alternative_per_units", "unit_choices",
+                                    "per_unit_choices"
   end
 
   it "has no default unit if none declared" do
@@ -131,14 +141,48 @@ describe Term do
     term = Term.new {path :hello; default_unit :kg; default_per_unit :kWh}
     units = term.alternative_units.map(&:name)
     units.should include "gigagram", "pound", "tonne"
+    units.should_not include "kilogram", "kelvin"
     per_units = term.alternative_per_units.map(&:name)
     per_units.should include "joule", "british thermal unit", "megawatt hour"
+    per_units.should_not include "kilowatt hour"
+  end
+
+  it "has unit choices which include default and alternative" do
+    term = Term.new {path :hello; default_unit :kg; default_per_unit :kWh}
+    units = term.alternative_units.map(&:name)
+    units.should include "gigagram", "pound", "tonne"
+    units.should_not include "kilogram", "kelvin"
+
+    units = term.unit_choices.map(&:name)
+    units.first.should eql "kilogram"
+    units.should include "kilogram", "gigagram", "pound", "tonne"
+    units.should_not include "kelvin"
+
+    per_units = term.alternative_per_units.map(&:name)
+    per_units.should include "joule", "british thermal unit", "megawatt hour"
+    per_units.should_not include "kilowatt hour"
+
+    per_units = term.per_unit_choices.map(&:name)
+    per_units.first.should eql "kilowatt hour"
+    per_units.should include "kilowatt hour", "joule", "british thermal unit", "megawatt hour"
   end
 
   it "has limited set of alternative units if specified" do
     term = Term.new {path :hello; default_unit :kg; alternative_units :t, :ton_us, :lb}
     units = term.alternative_units.map(&:name)
     units.should include "tonne", "pound", "short ton"
+    units.should_not include "kilogram", "gigagram", "ounce", "gram"
+  end
+
+  it "has unit choices which include default and alternative with limited set of alternative units" do
+    term = Term.new {path :hello; default_unit :kg; alternative_units :t, :ton_us, :lb}
+    units = term.alternative_units.map(&:name)
+    units.should include "tonne", "pound", "short ton"
+    units.should_not include "kilogram", "gigagram", "ounce", "gram"
+
+    units = term.unit_choices.map(&:name)
+    units.first.should eql "kilogram"
+    units.should include "kilogram", "tonne", "pound", "short ton"
     units.should_not include "gigagram", "ounce", "gram"
   end
 

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

@@ -1,27 +1,31 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 describe TermsList do
+  before :all do
+    @calc = CalculationSet.find("transport")[:transport]
+  end
+  
   it 'should be returned from calculations' do
-    Transport.terms.should be_a TermsList
+    @calc.terms.should be_a TermsList
   end
   it 'should give properties' do
-    Transport.terms.labels.should eql [:fuel,:size,:distance,:co2]
-    Transport.terms.paths.should eql ['fuel','size','distance',:default]
-    Transport.terms.names.should eql ['Fuel Type','Vehicle Size','Distance Driven','Carbon Dioxide']
+    @calc.terms.labels.should eql [:fuel,:size,:distance,:co2]
+    @calc.terms.paths.should eql ['fuel','size','distance','default']
+    @calc.terms.names.should eql ['Fuel Type','Vehicle Size','Distance Driven','Carbon Dioxide']
   end
   it 'should select by class' do
-    Transport.terms.drills.labels.should eql [:fuel,:size]
-    Transport.terms.profiles.labels.should eql [:distance]
-    Transport.terms.outputs.labels.should eql [:co2]
+    @calc.terms.drills.labels.should eql [:fuel,:size]
+    @calc.terms.profiles.labels.should eql [:distance]
+    @calc.terms.outputs.labels.should eql [:co2]
   end
   it 'should select by property' do
-    t=Transport.begin_calculation
+    t=@calc.begin_calculation
     t[:distance].value 5
     t.terms.set.labels.should eql [:distance]
     t.terms.unset.labels.should eql [:fuel,:size,:co2]
   end
   it 'should select by chain' do
-    t=Transport.begin_calculation
+    t=@calc.begin_calculation
     t[:fuel].value 'diesel'
     t.terms.drills.set.labels.should eql [:fuel]
     t.terms.drills.unset.labels.should eql [:size]
@@ -29,7 +33,7 @@ describe TermsList do
     t.terms.unset.drills.labels.should eql [:size]
   end
   it 'should select by order' do
-    t=Transport.clone
+    t=@calc.clone
     t.terms.before(:distance).labels.
       should eql [:fuel,:size]
     t.terms.after(:distance).labels.
@@ -40,7 +44,7 @@ describe TermsList do
     mocker.item_value_definitions.
       item_definition.data_category.
       item_value_definition('distance',['usage1'],['usage2'],['usage3'])
-    t=Transport.clone
+    t=@calc.clone
     t.profiles.compulsory('usage1').labels.should eql [:distance]
     t.profiles.optional('usage2').labels.should eql [:distance]
     t.profiles.compulsory('usage2').labels.should be_empty

data/spec/config/amee_units_spec.rb

@@ -1,5 +1,4 @@
-
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe "AMEE units" do
   

data/spec/core-extensions/class_spec.rb

@@ -1,25 +1,25 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
- class Myclass
-     attr_property :prop
-   end
+class Myclass
+  attr_property :prop
+end
 
 describe Class do
   before :all do
     @it=Myclass.new
   end
- it 'can have a property defined' do
-  @it.prop 5
-  @it.prop.should eql 5
- end
- it 'can have a prop unset' do
-   @it.prop 5
-   @it.prop nil
-   @it.prop.should be_nil
- end
- it 'does not unset by query' do
-   @it.prop 5
-   @it.prop
-   @it.prop.should_not be_nil
- end
+  it 'can have a property defined' do
+    @it.prop 5
+    @it.prop.should eql 5
+  end
+  it 'can have a prop unset' do
+    @it.prop 5
+    @it.prop nil
+    @it.prop.should be_nil
+  end
+  it 'does not unset by query' do
+    @it.prop 5
+    @it.prop
+    @it.prop.should_not be_nil
+  end
 end

data/spec/core-extensions/hash_spec.rb

@@ -1,5 +1,4 @@
-
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Hash do
   before(:each) do

data/spec/core-extensions/ordered_hash_spec.rb

@@ -1,5 +1,4 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
-
+require 'spec_helper'
 
 describe ActiveSupport::OrderedHash do
   it 'Can insert at start' do

data/spec/core-extensions/proc_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
+require 'spec_helper'
 
 describe Proc do
   before :all do

data/spec/fixtures/{electricity.rb → config/calculations/electricity.rb}

@@ -1,4 +1,4 @@
-Electricity=AMEE::DataAbstraction::PrototypeCalculation.new { # The application has support for an electricity calculation. :electricity is the internal label used to refer to it
+calculation { # The application has support for an electricity calculation. :electricity is the internal label used to refer to it
   label :electricity
   name "Electricity Consumption"
   path '/business/energy/electricity/grid'
@@ -28,7 +28,7 @@ Electricity=AMEE::DataAbstraction::PrototypeCalculation.new { # The application
 
   output { #A marv output value
     label :co2
-    path :default #It's not a marv, use the default output
+    path 'default' #It's not a marv, use the default output
     name "Carbon Dioxide"
   }
 }

data/spec/fixtures/config/calculations/electricity_and_transport.rb

@@ -0,0 +1,53 @@
+all_calculations {
+  metadatum {
+    label :department
+    choices %w{stuff things more_stuff meta_things}
+  }
+}
+
+calculation{
+  name 'electricity'
+  label :electricity
+  path '/business/energy/electricity/grid'
+  profile {
+    label :usage
+    name 'Electricity Used'
+    path 'energyPerTime'
+  }
+  drill {
+    label :country
+    path 'country'
+    fixed 'Argentina'
+  }
+  output {
+    label :co2
+    path 'default'
+  }
+}
+
+calculation {
+  name 'transport'
+  label :transport
+  path '/transport/car/generic'
+
+  drill {
+    path 'fuel'
+    label :fuel
+    name 'Fuel Type'
+  }
+  drill {
+    path 'size'
+    label :size
+    name 'Vehicle Size'
+  }
+  profile {
+    path 'distance'
+    label :distance
+    name 'Distance Driven'
+  }
+  output {
+    label :co2
+    path 'default'
+    name 'Carbon Dioxide'
+  }
+}

data/spec/fixtures/{transport.rb → config/calculations/transport.rb}

@@ -1,4 +1,4 @@
-Transport=AMEE::DataAbstraction::PrototypeCalculation.new{
+calculation {
   name 'transport'
   label :transport
   path '/transport/car/generic'
@@ -20,7 +20,7 @@ Transport=AMEE::DataAbstraction::PrototypeCalculation.new{
   }
   output {
     label :co2
-    path :default
+    path 'default'
     name 'Carbon Dioxide'
   }
 }

data/spec/fixtures/config/electricity.rb

@@ -0,0 +1,35 @@
+calculation { # The application has support for an electricity calculation. :electricity is the internal label used to refer to it
+  label :electricity
+  name "Electricity Consumption"
+  path '/business/energy/electricity/grid'
+  
+  drill {
+    fixed 'argentina' #Not to be unset, value pre-given
+    label :country  #Name will default to label.humanize if not given
+    path 'country' #Some of the fields on the form are drill-downs, but the application doesn't need to display these differently
+    #type :autocompleting_text_box #default for a drill with entries is probably a dropdown
+  }
+
+  profile {
+    label :energy_used
+    # Symbol provided here is used in generating html ids for elements etc
+    path 'energyPerTime' #The amee profile item value corresponding to the field
+    name "Energy Used" #The display name used on the form
+    unit "kWh" #Default unit choice
+    interface :text_box #Probably not needed, as likely to be the default for profile item value unsets
+    validation lambda{|x|x.is_a? Float} #Probably not needed, as default can be deduced from PIV TYPE in API. Here as illustrative.
+    alternative_units :MWh, :MBTU, :BTU # If these are explcitly specified then the alternatives are limited to only these units. Otherwise all dimensionally equivalent units are available as alternatives by default
+  }
+  
+  # Alternatively, the drill might be fixed
+  #permanent :country {
+  #   drill_path 'country'
+  #   value 'Argentina'
+
+  output { #A marv output value
+    label :co2
+    path 'default' #It's not a marv, use the default output
+    name "Carbon Dioxide"
+  }
+}
+

data/spec/spec_helper.rb

@@ -2,20 +2,37 @@ require 'rubygems'
 require 'spec'
 require 'rspec_spinner'
 require 'flexmock'
-$:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'amee'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'amee-data-abstraction'
 
+# Fake up Rails.root to be fixtures directory
+class Rails
+  def self.root
+    File.dirname(__FILE__) + '/fixtures'
+  end
+  def self.logger
+    nil
+  end
+end
+
 Spec::Runner.configure do |config|
   config.mock_with :flexmock
+  config.after(:each) do
+    delete_lock_files
+  end
 end
 
-AMEE::DataAbstraction.connection=FlexMock.new('connection') #Global connection mock, shouldn't receive anything, as we mock the individual amee-ruby calls in the tests
-
-Dir.glob(File.dirname(__FILE__) + '/fixtures/*') do |filename|
-  require filename
+def delete_lock_files
+  config_dir = Dir.new("#{Rails.root}/config/calculations")
+  config_dir.each do |file|
+    File.delete("#{config_dir.path}/#{file}") if file =~ /lock/
+  end
 end
 
+AMEE::DataAbstraction.connection=FlexMock.new('connection') #Global connection mock, shouldn't receive anything, as we mock the individual amee-ruby calls in the tests
+
 include AMEE::DataAbstraction
 
 class AMEEMocker
@@ -81,6 +98,21 @@ class AMEEMocker
     return self
   end
 
+  # This represents the skipping of drill choices which occur on an AMEE drill
+  # down when only one choice exists for a given drill - it skips to the next,
+  # offering the next set of choices or a uid. In these cases, the skipped drill
+  # is set as an automatic selection
+  def drill_with_skip(skipped_selections=[])
+    test.flexmock(AMEE::Data::DrillDown).
+      should_receive(:get).
+      with(connection,
+      "/data/#{path}/drill?#{selections.map{|k,v|"#{k}=#{v}"}.join('&')}").
+      at_least.once.
+      and_return(test.flexmock(:choices=>choices,:selections=>Hash[selections].merge(skipped_selections),
+        :data_item_uid=>dataitemuid))
+    return self
+  end
+
   def profile_list
     test.flexmock(AMEE::Profile::ProfileList).should_receive(:new).
       with(connection).at_least.once.
@@ -251,7 +283,7 @@ class AMEEMocker
   def update
     test.flexmock(AMEE::Profile::Item).should_receive(:update).
       with(connection,pipath,
-      {:get_item=>false}.merge(existing).merge(params)).
+      {:get_item=>true}.merge(existing).merge(params)).
       at_least.once
     return self
   end