amee-data-abstraction 2.1.0 → 2.1.1

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "amee", "~> 4.0"
+gem "amee", "~> 4.1.5"
 gem 'uuidtools', '2.1.2'
 gem 'quantify', '~> 2.0.0'
 

data/Gemfile.lock

@@ -2,11 +2,11 @@ GEM
   remote: http://rubygems.org/
   specs:
     activesupport (3.0.10)
-    amee (4.0.0)
+    amee (4.1.5)
       activesupport (~> 3.0.10)
       json
       log4r
-      nokogiri (~> 1.4.3.1)
+      nokogiri (~> 1.4.4)
     builder (3.0.0)
     diff-lcs (1.1.3)
     flexmock (0.9.0)
@@ -16,9 +16,9 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.5.4)
+    json (1.6.1)
     log4r (1.1.9)
-    nokogiri (1.4.3.1)
+    nokogiri (1.4.7)
     quantify (2.0.0)
       activesupport (~> 3.0.10)
       i18n
@@ -39,7 +39,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  amee (~> 4.0)
+  amee (~> 4.1.5)
   builder
   bundler (~> 1.0.0)
   flexmock (> 0.8.6)

data/README.txt

@@ -166,8 +166,8 @@ From this global calculation set, initialize a new calculation
 
 The AMEE::DataAbstraction module uses the 'amee' ruby gem to interact with AMEE.
 The standard method for configuring and instantiating a connection to the AMEE
-API is to provide authentication credentials in the /config/amee.yml file,
-structured thus:
+API is to provide authentication credentials in the /config/amee.yml file.  It is
+recommended to use one of the caching options in order to reduce API calls:
 
   ---
   production:

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.1.1

data/amee-data-abstraction.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee-data-abstraction}
-  s.version = "2.1.0"
+  s.version = "2.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Hetherington", "Andrew Berkeley", "James Smith", "George Palmer"]
-  s.date = %q{2011-10-10}
+  s.date = %q{2011-10-12}
   s.description = %q{Part of the AMEEappkit this gem provides a data abstraction layer, decreasing the amount and detail of development required}
   s.email = %q{help@amee.com}
   s.extra_rdoc_files = [
@@ -71,14 +71,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/AMEE/amee-data-abstraction}
   s.licenses = ["BSD 3-Clause"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.3}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{Calculation and form building tool hiding details of AMEEconnect}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<amee>, ["~> 4.0"])
+      s.add_runtime_dependency(%q<amee>, ["~> 4.1.5"])
       s.add_runtime_dependency(%q<uuidtools>, ["= 2.1.2"])
       s.add_runtime_dependency(%q<quantify>, ["~> 2.0.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -88,7 +88,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
     else
-      s.add_dependency(%q<amee>, ["~> 4.0"])
+      s.add_dependency(%q<amee>, ["~> 4.1.5"])
       s.add_dependency(%q<uuidtools>, ["= 2.1.2"])
       s.add_dependency(%q<quantify>, ["~> 2.0.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -99,7 +99,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rdoc>, [">= 0"])
     end
   else
-    s.add_dependency(%q<amee>, ["~> 4.0"])
+    s.add_dependency(%q<amee>, ["~> 4.1.5"])
     s.add_dependency(%q<uuidtools>, ["= 2.1.2"])
     s.add_dependency(%q<quantify>, ["~> 2.0.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/lib/amee-data-abstraction/drill.rb

@@ -42,8 +42,14 @@ module AMEE
       def choices(*args)
         if args.empty?
           if @choices.blank?
-            c=parent.amee_drill(:before=>label).choices
-            c.length==1 ? [value] : c
+            drill_down = parent.amee_drill(:before=>label)
+            if single_choice = drill_down.selections[path]
+              disable!
+              [single_choice]
+            else
+              enable!
+              drill_down.choices
+            end
           else
             @choices
           end

data/lib/amee-data-abstraction/input.rb

@@ -11,6 +11,8 @@ module AMEE
     #
     class Input < Term
 
+      attr_accessor :dirty
+
       # Returns the valid choices for this input
       # (Abstract, implemented only for subclasses of input.)
       def choices
@@ -29,6 +31,7 @@ module AMEE
         @validation = nil
         validation_message {"#{name} is invalid."}
         super
+        @dirty = false
       end
 
       # Configures the value of <tt>self</tt> to be fixed to <tt>val</tt>, i.e.
@@ -66,7 +69,7 @@ module AMEE
         unless args.empty?
           if args.first.to_s != @value.to_s
             raise Exceptions::FixedValueInterference if fixed?
-            parent.dirty! if parent and parent.is_a? OngoingCalculation
+            mark_as_dirty
           end
         end
         super
@@ -184,6 +187,10 @@ module AMEE
       def disabled?
         super || fixed?
       end
+      
+      def dirty?
+        @dirty
+      end
 
       protected
       # Returns <tt>true</tt> if the value set for <tt>self</tt> is either blank
@@ -192,6 +199,11 @@ module AMEE
       def valid?
         validation.blank? || validation === @value_before_cast
       end
+      
+      def mark_as_dirty
+        @dirty = true
+        parent.dirty! if parent and parent.is_a? OngoingCalculation
+      end
     end
   end
 end

data/lib/amee-data-abstraction/ongoing_calculation.rb

@@ -235,6 +235,10 @@ module AMEE
         reset_invalidity_messages
       end
 
+      def clear_outputs
+        outputs.each {|output| output.value nil }
+      end
+
       def ==(other_calc)
         !terms.inject(false) do |boolean,term|
           boolean || term != other_calc[term.label]
@@ -283,7 +287,7 @@ module AMEE
       # and units for any unset <i>Profile</i> terms (profile item values) from
       # the AMEE platform
       #
-      def load_profile_item_values  
+      def load_profile_item_values
         return unless profile_item
         profiles.unset.each do |term|
           ameeval=profile_item.values.find { |value| value[:path] == term.path }
@@ -305,6 +309,7 @@ module AMEE
       def load_drills
         return unless profile_item
         drills.each do |term|
+          next unless term.value.nil? || term.dirty?
           ameeval=data_item.value(term.path)
           raise Exceptions::Syncronization if term.set? && ameeval!=term.value
           term.value ameeval
@@ -325,6 +330,7 @@ module AMEE
           load_drills
         rescue Exceptions::Syncronization
           delete_profile_item
+          clear_outputs
         end
         load_metadata
         # We could create an unsatisfied PI, and just check drilled? here
@@ -451,10 +457,8 @@ module AMEE
       # <i>Profile</i> term values and attributes
       #
       def set_profile_item_values
-        AMEE::Profile::Item.update(connection,profile_item_path, 
-          profile_options.merge(:get_item=>false))
-        #Clear the memoised profile item, to reload with updated values
-        @profile_item=nil
+        @profile_item = AMEE::Profile::Item.update(connection,profile_item_path, 
+          profile_options.merge(:get_item=>true))
       end
 
       # Delete the profile item which is associated with <tt>self</tt> from the
@@ -463,7 +467,7 @@ module AMEE
       #
       def delete_profile_item
         AMEE::Profile::Item.delete(connection,profile_item_path)
-        self.profile_item_uid=false
+        self.profile_item_uid=nil
         @profile_item=nil
       end
 
@@ -509,6 +513,8 @@ module AMEE
         @profile_category||=AMEE::Profile::Category.get(connection, profile_category_path)
       end
 
+      public
+      
       # Automatically set the value of a drill term if there is only one choice
       def autodrill
         
@@ -529,8 +535,6 @@ module AMEE
         end
       end
 
-      public
-
       # Instantiate an <tt>AMEE::Data::DrillDown</tt> object representing the
       # drill down sequence defined by the drill terms associated with
       # <tt>self</tt>. As with <tt>#drill_options</tt>, An optional hash argument

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

@@ -1,11 +1,13 @@
 require File.dirname(File.dirname(__FILE__)) + '/spec_helper.rb'
 describe Drill do
+
   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']
   end
+
   it 'knows its options when it is a later choice' do
     AMEEMocker.new(self,:path=>'transport/car/generic',
       :selections=>[['fuel','diesel']],
@@ -14,6 +16,7 @@ describe Drill do
     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
     t[:fuel].enabled?.should be_true
@@ -25,6 +28,7 @@ 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
     AMEEMocker.new(self,:path=>'transport/car/generic',
       :selections=>[],
@@ -35,4 +39,21 @@ describe Drill do
     t[:fuel].value 'banana'
     t[:fuel].send(:valid?).should be_false
   end
+
+  it "should set and get custom choices" do
+    t=Transport.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=Transport.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/ongoing_calculation_spec.rb

@@ -24,6 +24,14 @@ describe OngoingCalculation do
     d.outputs.set.labels.should eql [:co2]
     d.outputs.unset.labels.should eql []
   end
+  it 'can clear outputs' do
+    d=Electricity.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']],

data/spec/spec_helper.rb

@@ -77,6 +77,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.
@@ -247,7 +262,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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee-data-abstraction
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 2
   - 1
-  - 0
-  version: 2.1.0
+  - 1
+  version: 2.1.1
 platform: ruby
 authors: 
 - James Hetherington
@@ -18,26 +18,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-10 00:00:00 +01:00
+date: 2011-10-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: amee
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 49
         segments: 
         - 4
-        - 0
-        version: "4.0"
-  prerelease: false
-  type: :runtime
+        - 1
+        - 5
+        version: 4.1.5
   requirement: *id001
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: uuidtools
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -49,11 +52,11 @@ dependencies:
         - 1
         - 2
         version: 2.1.2
-  prerelease: false
-  type: :runtime
   requirement: *id002
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: quantify
+  type: :runtime
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -65,11 +68,11 @@ dependencies:
         - 0
         - 0
         version: 2.0.0
-  prerelease: false
-  type: :runtime
   requirement: *id003
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: bundler
+  type: :development
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -81,11 +84,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  prerelease: false
-  type: :development
   requirement: *id004
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: jeweler
+  type: :development
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -97,11 +100,11 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  prerelease: false
-  type: :development
   requirement: *id005
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: rspec
+  type: :development
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -113,11 +116,11 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
-  prerelease: false
-  type: :development
   requirement: *id006
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: flexmock
+  type: :development
   version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -129,11 +132,11 @@ dependencies:
         - 8
         - 6
         version: 0.8.6
-  prerelease: false
-  type: :development
   requirement: *id007
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: rcov
+  type: :development
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -143,11 +146,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  type: :development
   requirement: *id008
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: rdoc
+  type: :development
   version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -157,8 +160,6 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  type: :development
   requirement: *id009
 description: Part of the AMEEappkit this gem provides a data abstraction layer, decreasing the amount and detail of development required
 email: help@amee.com
@@ -250,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Calculation and form building tool hiding details of AMEEconnect