amee-analytics 1.0.1 → 1.1.0

data/Gemfile

@@ -1,8 +1,8 @@
 source "http://rubygems.org"
 
 # Dependencies
-gem "amee-data-abstraction","~> 1.1"
-gem "amee-data-persistence","~> 1.1"
+gem "amee-data-abstraction","~> 1.3"
+gem "amee-data-persistence","~> 1.2"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/amee-analytics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee-analytics}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   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-08-31}
+  s.date = %q{2011-10-18}
   s.description = %q{Part of the AMEE AppKit, this gem provides the ability to do mathmatical operations over a set of calculations}
   s.email = %q{help@amee.com}
   s.extra_rdoc_files = [
@@ -35,21 +35,22 @@ Gem::Specification.new do |s|
     "spec/amee/analytics/calculation_collection_spec.rb",
     "spec/amee/analytics/term_spec.rb",
     "spec/amee/analytics/terms_list_spec.rb",
+    "spec/fixtures/config/calculations/calcs.rb",
     "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/AMEE/amee-analytics}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.5.3}
   s.summary = %q{Analytics module for use with AMEE AppKit}
 
   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-data-abstraction>, ["~> 1.1"])
-      s.add_runtime_dependency(%q<amee-data-persistence>, ["~> 1.1"])
+      s.add_runtime_dependency(%q<amee-data-abstraction>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<amee-data-persistence>, ["~> 1.2"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
@@ -57,8 +58,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<flexmock>, ["> 0.8.6"])
       s.add_development_dependency(%q<activerecord>, ["~> 2.3.5"])
     else
-      s.add_dependency(%q<amee-data-abstraction>, ["~> 1.1"])
-      s.add_dependency(%q<amee-data-persistence>, ["~> 1.1"])
+      s.add_dependency(%q<amee-data-abstraction>, ["~> 1.3"])
+      s.add_dependency(%q<amee-data-persistence>, ["~> 1.2"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rspec>, ["= 1.3.0"])
       s.add_dependency(%q<rcov>, [">= 0"])
@@ -67,8 +68,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
     end
   else
-    s.add_dependency(%q<amee-data-abstraction>, ["~> 1.1"])
-    s.add_dependency(%q<amee-data-persistence>, ["~> 1.1"])
+    s.add_dependency(%q<amee-data-abstraction>, ["~> 1.3"])
+    s.add_dependency(%q<amee-data-persistence>, ["~> 1.2"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rspec>, ["= 1.3.0"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/lib/amee/data_abstraction/terms_list_analytics_support.rb

@@ -250,6 +250,28 @@ module AMEE
         Result.new { label label; value value; unit unit; per_unit per_unit }
       end
 
+      # Move an individual term to a specified location (index) within the list.
+      # The specific term is selected on the basis of one of it's attributes values,
+      # with the attribute to use (e.g. :value, :unit) given by <tt>attr</attr>
+      # and value by <tt>value</tt>. The location within the list to move the term
+      # is given as an index integer value as the final argument.
+      #
+      def move_by(attr,value,index)
+        if attr == :unit || attr == :per_unit
+          value = Unit.for value
+        end
+        term = find {|t| t.send(attr) == value }
+        return if term.nil?
+        delete(term)
+        insert(index, term)
+      end
+
+      # Rotate the list terms by one element - shifts the first-placed term to the
+      # end of the list, advancing all terms forward by one place.
+      def rotate
+        push(self.shift)
+      end
+
       # Sorts the terms list in place according to the term attribute indiated by
       # <tt>attr</tt>, returning <tt>self</tt>.
       #
@@ -263,18 +285,36 @@ module AMEE
 
       # Similar to <tt>#sort_by!</tt> but returns a new instance of
       # <i>TermsList</i> arranged according to the values on the
-      # attribute <tt>attr</tt>. E.g.
+      # attribute <tt>attr</tt>.
       #
-      #   my_terms_list.sort_by :value
       #
-      #                   #=> <AMEE::DataAbstraction::TermsList ... >
+      # If differences in units exist between terms, sorting occur based on the
+      # absolute quantities implied.
+      #
+      # E.g.
+      #
+      # my_terms_list.sort_by :value
+      #
+      # #=> <AMEE::DataAbstraction::TermsList ... >
       #
       def sort_by(attr)
-        # Remove unset terms before sort and append at end
-        unset_terms = select { |term| term.unset? }
-        set_terms = select { |term| term.set? }
-        set_terms.sort! { |term,other_term| term.send(attr) <=> other_term.send(attr) }
-        TermsList.new(set_terms + unset_terms)
+        # 1. Remove unset terms before sort and append at end
+        #
+        # 2. Establish set terms
+        #
+        # 3. Zip together with corresponding standardized units list creating a
+        # list of Term pairs
+        #
+        # 4. Sort list according to standardized Terms
+        #
+        # 5. Return map of original (now sorted) Terms
+
+        unset_terms, set_terms = self.partition { |term| term.unset? || term.value.nil? }
+        standardized_set_terms = TermsList.new(set_terms).standardize_units
+        ordered_set_terms = set_terms.zip(standardized_set_terms).sort! do |term,other_term|
+          term[1].send(attr) <=> other_term[1].send(attr)
+        end.map {|term_array| term_array[0]}
+        TermsList.new(ordered_set_terms + unset_terms)
       end
 
       # Return an instance of <i>TermsList</i> containing only terms labelled

data/spec/amee/analytics/calculation_collection_spec.rb

@@ -5,7 +5,6 @@ include AMEE::DataAbstraction
 describe CalculationCollection do
 
   before(:each) do
-    initialize_calculation_set
     @calcs = []
     @calcs << add_elec_calc(500,240)
     @calcs << add_elec_calc(1000,480)
@@ -48,7 +47,7 @@ describe CalculationCollection do
     terms.all? {|term| term.is_a? AMEE::DataAbstraction::Output }.should be_true
   end
 
-  it "should sum term values with homegeneous calcs" do
+  it "should sum term values with homogeneous calcs" do
     @coll.co2.sum.to_s.should eql "1320.0 t"
     @coll.co2.mean.to_s.should eql "440.0 t"
     @coll.usage.sum.to_s.should eql "2734.0 kWh"
@@ -122,6 +121,23 @@ describe CalculationCollection do
     coll.last['co2'].value.should eql 600
   end
 
+  it "should sort calcs considering differences in units" do
+    @coll.first['usage'].value.should eql 500
+    @coll.first['usage'].unit.label.should eql 'kWh'
+    @coll[1]['usage'].value.should eql 1000
+    @coll[1]['usage'].unit.label.should eql 'kWh'
+    @coll.last['usage'].unit 'J'
+    @coll.last['usage'].value.should eql 1234
+    @coll.last['usage'].unit.label.should eql 'J'
+    @coll.sort_by_usage!
+    @coll.first['usage'].value.should eql 1234
+    @coll.first['usage'].unit.label.should eql 'J'
+    @coll[1]['usage'].value.should eql 500
+    @coll[1]['usage'].unit.label.should eql 'kWh'
+    @coll.last['usage'].value.should eql 1000
+    @coll.last['usage'].unit.label.should eql 'kWh'
+  end
+
   it "should standardize units in place" do
     @coll.first['usage'].unit 'J'
     @coll.first['usage'].value.should eql 500

data/spec/amee/analytics/terms_list_spec.rb

@@ -5,7 +5,6 @@ include AMEE::DataAbstraction
 describe TermsList do
 
   before(:each) do
-    initialize_calculation_set
     calcs = []
     calcs << add_elec_calc(500,240)
     calcs << add_elec_calc(1000,480)
@@ -335,6 +334,90 @@ describe TermsList do
     @list.last.value.should eql nil
   end
 
+  it "should return a sorted terms list considering differences in units" do
+    @list=@list.co2
+    @list.first.unit 't'
+    @list[1].unit 'lb'
+    @list.last.unit 'kg'
+    @list.first.to_s.should eql "240.0 t"
+    @list[1].to_s.should eql "480.0 lb"
+    @list.last.to_s.should eql "600.0 kg"
+    @list.reverse!
+    @list.first.to_s.should_not eql "240.0 t"
+    @list.last.to_s.should_not eql "600.0 kg"
+    list = @list.sort_by_value
+    list.first.to_s.should eql "480.0 lb"
+    list[1].to_s.should eql "600.0 kg"
+    list.last.to_s.should eql "240.0 t"
+  end
+
+  it "should sort on non-numeric values" do
+    @list=@list.country
+    @list.first.value 'Zambia'
+    @list[1].value 'Bulgaria'
+    @list.last.value 'Mauritania'
+    @list.first.to_s.should eql 'Zambia'
+    @list[1].to_s.should eql 'Bulgaria'
+    @list.last.to_s.should eql 'Mauritania'
+    @list.reverse!
+    @list.first.to_s.should_not eql 'Zambia'
+    @list.last.to_s.should_not eql 'Mauritania'
+    list = @list.sort_by_value
+    list.first.to_s.should eql 'Bulgaria'
+    list[1].to_s.should eql 'Mauritania'
+    list.last.to_s.should eql'Zambia'
+  end
+
+  it "should move a term on the basis of value" do
+    @list=@list.co2
+    @list.first.to_s.should eql "240.0 t"
+    @list[1].to_s.should eql "480.0 t"
+    @list.last.to_s.should eql "600.0 t"
+    @list.move_by(:value, 600.0,0)
+    @list.first.to_s.should eql "600.0 t"
+    @list[1].to_s.should eql "240.0 t"
+    @list.last.to_s.should eql "480.0 t"
+  end
+
+  it "should move a term on the basis of unit object" do
+    @list=@list.co2
+    @list.first.unit 't'
+    @list[1].unit 'lb'
+    @list.last.unit 'kg'
+    @list.first.to_s.should eql "240.0 t"
+    @list[1].to_s.should eql "480.0 lb"
+    @list.last.to_s.should eql "600.0 kg"
+    @list.move_by(:unit, Unit.kg,1)
+    @list.first.to_s.should eql "240.0 t"
+    @list[1].to_s.should eql "600.0 kg"
+    @list.last.to_s.should eql "480.0 lb"
+  end
+
+  it "should move a term on the basis of unit label" do
+    @list=@list.co2
+    @list.first.unit 't'
+    @list[1].unit 'lb'
+    @list.last.unit 'kg'
+    @list.first.to_s.should eql "240.0 t"
+    @list[1].to_s.should eql "480.0 lb"
+    @list.last.to_s.should eql "600.0 kg"
+    @list.move_by(:unit, :t,-1)
+    @list.first.to_s.should eql "480.0 lb"
+    @list[1].to_s.should eql "600.0 kg"
+    @list.last.to_s.should eql "240.0 t"
+  end
+
+  it "should rotate terms" do
+    @list=@list.co2
+    @list.first.to_s.should eql "240.0 t"
+    @list[1].to_s.should eql "480.0 t"
+    @list.last.to_s.should eql "600.0 t"
+    @list.rotate
+    @list.first.to_s.should eql "480.0 t"
+    @list[1].to_s.should eql "600.0 t"
+    @list.last.to_s.should eql "240.0 t"
+  end
+
   it "should return a new TermList for numeric only terms" do
     @list=@list.co2.numeric_terms.should be_a TermsList
   end

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

@@ -0,0 +1,55 @@
+calculation{
+  name 'Electricity'
+  label :electricity
+  path '/business/energy/electricity/grid'
+  drill {
+    label :country
+    path 'country'
+    value 'Argentina'
+  }
+  profile {
+    label :usage
+    name 'Electricity Used'
+    path 'energyPerTime'
+    default_unit :kWh
+  }
+  output {
+    label :co2
+    name 'Carbon Dioxide'
+    path 'default'
+    default_unit :t
+  }
+}
+
+calculation{
+  name 'Transport'
+  label :transport
+  path '/transport/defra/vehicle'
+  drill {
+    label :type
+    path 'type'
+    name 'Type'
+  }
+  drill {
+    label :size
+    path 'size'
+    name 'Size'
+  }
+  drill {
+    label :fuel
+    path 'fuel'
+    name 'Fuel'
+  }
+  profile {
+    label :distance
+    name 'distance'
+    path 'distance'
+    default_unit :km
+  }
+  output {
+    label :co2
+    name 'Carbon Dioxide'
+    path 'default'
+    default_unit :t
+  }
+}

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'spec'
 
 require 'amee-analytics'
 require 'amee-data-persistence'
-require 'amee/data_abstraction/persistence_support.rb'
+require 'amee/data_abstraction/ongoing_calculation_persistence_support.rb'
 require 'amee/data_abstraction/calculation_collection_analytics_support'
 require 'amee/data_abstraction/terms_list_analytics_support'
 require 'amee/data_abstraction/term_analytics_support'
@@ -15,80 +15,31 @@ AMEE::DataAbstraction::CalculationCollection.class_eval { include AMEE::DataAbst
 AMEE::DataAbstraction::TermsList.class_eval { include AMEE::DataAbstraction::TermsListAnalyticsSupport }
 AMEE::DataAbstraction::Term.class_eval { include AMEE::DataAbstraction::TermAnalyticsSupport }
 
-RAILS_ROOT = '.'
+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
-end
-
-def initialize_calculation_set
-  eval "Calculations = AMEE::DataAbstraction::CalculationSet.new {
-      calculation{
-        name 'Electricity'
-        label :electricity
-        path '/business/energy/electricity/grid'
-        drill {
-          label :country
-          path 'country'
-          fixed 'Argentina'
-        }
-        profile {
-          label :usage
-          name 'Electricity Used'
-          path 'energyPerTime'
-          default_unit :kWh
-        }
-        output {
-          label :co2
-          name 'Carbon Dioxide'
-          path :default
-          default_unit :t
-        }
-      }
-      calculation{
-        name 'Transport'
-        label :transport
-        path '/transport/defra/vehicle'
-        drill {
-          label :type
-          path 'type'
-          name 'Type'
-        }
-        drill {
-          label :size
-          path 'size'
-          name 'Size'
-        }
-        drill {
-          label :fuel
-          path 'fuel'
-          name 'Fuel'
-        }
-        profile {
-          label :distance
-          name 'distance'
-          path 'distance'
-          default_unit :km
-        }
-        output {
-          label :co2
-          name 'Carbon Dioxide'
-          path :default
-          default_unit :t
-        }
-      }
-    }"
+  config.before(:all) do
+    CalculationSet.find("calcs")
+  end
 end
 
 def add_elec_calc(act,res)
-  calc = Calculations[:electricity].begin_calculation
+  calc = CalculationSet.find("calcs")[:electricity].begin_calculation
   calc['usage'].value act
   calc['co2'].value res
   return calc
 end
 
 def add_transport_calc(act,res)
-  calc = Calculations[:transport].begin_calculation
+  calc = CalculationSet.find("calcs")[:transport].begin_calculation
   calc['distance'].value act
   calc['co2'].value res
   return calc

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee-analytics
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Hetherington
@@ -18,43 +18,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-31 00:00:00 +01:00
+date: 2011-10-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: amee-data-abstraction
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 9
         segments: 
         - 1
-        - 1
-        version: "1.1"
-  name: amee-data-abstraction
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+        - 3
+        version: "1.3"
   prerelease: false
   type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: amee-data-persistence
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 11
         segments: 
         - 1
-        - 1
-        version: "1.1"
-  name: amee-data-persistence
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+        - 2
+        version: "1.2"
   prerelease: false
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,12 +64,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  name: jeweler
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -81,12 +80,12 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
-  name: rspec
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,12 +94,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rcov
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec_spinner
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -111,12 +110,12 @@ dependencies:
         - 1
         - 3
         version: 1.1.3
-  name: rspec_spinner
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">"
@@ -127,12 +126,12 @@ dependencies:
         - 8
         - 6
         version: 0.8.6
-  name: flexmock
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -143,8 +142,9 @@ dependencies:
         - 3
         - 5
         version: 2.3.5
-  name: activerecord
-  version_requirements: *id008
+  prerelease: false
+  type: :development
+  requirement: *id008
 description: Part of the AMEE AppKit, this gem provides the ability to do mathmatical operations over a set of calculations
 email: help@amee.com
 executables: []
@@ -173,6 +173,7 @@ files:
 - spec/amee/analytics/calculation_collection_spec.rb
 - spec/amee/analytics/term_spec.rb
 - spec/amee/analytics/terms_list_spec.rb
+- spec/fixtures/config/calculations/calcs.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -205,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Analytics module for use with AMEE AppKit