amee-data-abstraction 1.0.0 → 1.1.0

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 
 gem "amee", "~> 3.0"
 gem 'uuidtools', '2.1.2'
-gem 'quantify', '1.1.0'
+gem 'quantify', '1.2.0'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       nokogiri (~> 1.4.3.1)
     flexmock (0.9.0)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -16,8 +17,9 @@ GEM
     json (1.5.3)
     log4r (1.1.9)
     nokogiri (1.4.3.1)
-    quantify (1.1.0)
+    quantify (1.2.0)
       activesupport
+      i18n
     rake (0.9.2)
     rcov (0.9.10)
     rspec (1.3.0)
@@ -34,7 +36,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   flexmock (> 0.8.6)
   jeweler (~> 1.6.4)
-  quantify (= 1.1.0)
+  quantify (= 1.2.0)
   rcov
   rspec (= 1.3.0)
   rspec_spinner (= 1.1.3)

data/Rakefile

@@ -22,7 +22,7 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/**/*_spec.rb']
   t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,/*ruby*,']
+  t.rcov_opts = ['--exclude', 'spec,/*ruby*,/*gems*']
 end
 
 require 'jeweler'
@@ -99,4 +99,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "amee-data-abstraction #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/amee-data-abstraction.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee-data-abstraction}
-  s.version = "1.0.0"
+  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-11}
+  s.date = %q{2011-08-30}
   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 = [
@@ -82,7 +82,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<amee>, ["~> 3.0"])
       s.add_runtime_dependency(%q<uuidtools>, ["= 2.1.2"])
-      s.add_runtime_dependency(%q<quantify>, ["= 1.1.0"])
+      s.add_runtime_dependency(%q<quantify>, ["= 1.2.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
@@ -92,7 +92,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<amee>, ["~> 3.0"])
       s.add_dependency(%q<uuidtools>, ["= 2.1.2"])
-      s.add_dependency(%q<quantify>, ["= 1.1.0"])
+      s.add_dependency(%q<quantify>, ["= 1.2.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rspec>, ["= 1.3.0"])
@@ -103,7 +103,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<amee>, ["~> 3.0"])
     s.add_dependency(%q<uuidtools>, ["= 2.1.2"])
-    s.add_dependency(%q<quantify>, ["= 1.1.0"])
+    s.add_dependency(%q<quantify>, ["= 1.2.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rspec>, ["= 1.3.0"])

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

@@ -127,8 +127,13 @@ module AMEE
       # Return a string representing the AMEE Explorer URL which is assocaited
       # with <tt>self</tt>
       #
+      def discover_url
+         "http://discover.amee.com/categories#{path}"
+      end
+
       def explorer_url
-         "http://explorer.amee.com/categories#{path}"
+         Rails.logger.info "#explorer_url method deprecated. Use #discover_url" if defined? Rails
+         discover_url
       end
        
       protected

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

@@ -235,6 +235,12 @@ module AMEE
         reset_invalidity_messages
       end
 
+      def ==(other_calc)
+        !terms.inject(false) do |boolean,term|
+          boolean || term != other_calc[term.label]
+        end && label == other_calc.label
+      end
+
       private
 
       # Empty the hash of error messages for term choices.
@@ -416,12 +422,9 @@ module AMEE
       #
       def create_profile_item
         raise Exceptions::AlreadyHaveProfileItem unless profile_item_uid.blank?
-        location = AMEE::Profile::Item.create(profile_category,
-          # call <tt>#data_item_uid</tt> on drill object rather than <tt>self</tt> 
-          # since there exists no profile item value yet
-          amee_drill.data_item_uid,
-          profile_options.merge(:get_item=>false,:name=>amee_name))
-        self.profile_item_uid=location.split('/').last
+        @profile_item = AMEE::Profile::Item.create(profile_category,amee_drill.data_item_uid,
+          profile_options.merge(:get_item => true, :name => amee_name))
+        self.profile_item_uid = @profile_item.uid
       end
 
       # Methods which should be memoized once per interaction with AMEE to minimise

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

@@ -341,6 +341,12 @@ module AMEE
         @visible=true
       end
 
+      def ==(other_term)
+        !TermsList::TermProperties.inject(false) do |boolean,prop|
+          boolean || self.send(prop) != other_term.send(prop)
+        end
+      end
+
       # Returns <tt>true</tt> if <tt>self</tt> has a numeric value. That is, can 
       # it have statistics applied? This method permits handling of term summing,
       #  averaging, etc. Otherwise, returns <tt>false</tt>.
@@ -462,15 +468,11 @@ module AMEE
       #   my_term.to_s :label               #=> "12345 ton_us"
       #
       def to_s(format=:symbol)
-        string = "#{value}"
-        if unit and per_unit
-          string += " #{(unit/per_unit).send(format)}"
-        elsif unit
-          string += " #{unit.send(format)}"
-        elsif per_unit
-          string += " #{(1/per_unit).send(format)}"
+        if has_numeric_value? && (unit || per_unit)
+          self.to_quantity.to_s(format)
+        else
+          "#{value}"
         end
-        return string
       end
 
       # Checks that the units included in <tt>units</tt> are dimensionally

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

@@ -20,8 +20,11 @@ describe Calculation do
   it 'should return the outputs' do
     Transport.outputs.labels.should  eql [:co2]
   end
-  it 'should generate an explorer URL' do
-    Transport.explorer_url.should eql 'http://explorer.amee.com/categories/transport/car/generic'
+  it 'should generate an discover URL' do
+    Transport.discover_url.should eql 'http://discover.amee.com/categories/transport/car/generic'
+  end
+  it 'should redirect to discover URL' do
+    Transport.explorer_url.should eql 'http://discover.amee.com/categories/transport/car/generic'
   end
   it 'can return a term via []' do
     Transport[:co2].label.should eql :co2

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

@@ -91,7 +91,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create.get
+    mocker.profile_list.profile_category.timestamp.create_and_get
     mycalc=Transport.begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
@@ -109,7 +109,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create.get
+    mocker.profile_list.profile_category.timestamp.create_and_get
     mycalc=ElectricityAndTransport[:transport].begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5,'department'=>'stuff')
     mycalc.calculate!
@@ -166,7 +166,7 @@ describe OngoingCalculation do
     mocker.profile_list.get(true,true).delete
     existing_uid=mocker.uid
     mocker.select('size'=>'small')
-    mocker.drill.profile_category.timestamp.create.get
+    mocker.drill.profile_category.timestamp.create_and_get
     mycalc.choose!(:profile_item_uid=>existing_uid,'fuel'=>'diesel','size'=>'small','distance'=>7)
     mycalc.calculate!
     mycalc.outputs.first.value.should eql :somenumber
@@ -205,7 +205,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create
+    mocker.profile_list.profile_category.timestamp.create_and_get
 
     mocker.existing={'distance'=>5}
     mocker.params={'distance'=>9}
@@ -231,11 +231,11 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create.get(true,true).delete
+    mocker.profile_list.profile_category.timestamp.create_and_get.get(true,true).delete
 
     mocker.select('size'=>'small')
-    mocker.drill.create.get
-
+    mocker.drill.create_and_get
+    
     mycalc=Transport.begin_calculation
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
     mycalc.calculate!
@@ -276,7 +276,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create.get
+    mocker.profile_list.profile_category.timestamp.create_and_get
     myproto=Transport.clone
     myproto.instance_eval{
       start_and_end_dates
@@ -326,7 +326,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create.get
+    mocker.profile_list.profile_category.timestamp.create_and_get
     mycalc=Transport.begin_calculation
     mycalc.should be_dirty
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
@@ -348,7 +348,7 @@ describe OngoingCalculation do
     mocker.select('size'=>'large')
     mocker.choices=[]
     mocker.drill
-    mocker.profile_list.profile_category.timestamp.create.get
+    mocker.profile_list.profile_category.timestamp.create_and_get
     mycalc=Transport.begin_calculation
     mycalc.should be_dirty
     mycalc.choose!('fuel'=>'diesel','size'=>'large','distance'=>5)
@@ -490,5 +490,6 @@ describe OngoingCalculation do
     mycalc.invalidity_messages.keys.should be_empty
     mycalc[:size].value.should be_nil
   end
+
 end
 

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

@@ -161,27 +161,35 @@ describe Term do
   end
 
   it "should represent term as string with unit symbol if no argument provided" do
-    Term.new {path :hello; value 12; default_unit :kg}.to_s.should == '12 kg'
-    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s.should == '12 kg h^-1'
-    Term.new {path :hello; value 12; per_unit :h}.to_s.should == '12 h^-1'
+    Term.new {path :hello; value 12; default_unit :kg}.to_s.should == '12.0 kg'
+    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s.should == '12.0 kg/h'
+    Term.new {path :hello; value 12; per_unit :h}.to_s.should == '12.0 h^-1'
   end
 
   it "should represent term as string with unit label" do
-    Term.new {path :hello; value 12; default_unit :kg}.to_s(:label).should == '12 kg'
-    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s(:label).should == '12 kg/h'
-    Term.new {path :hello; value 12; per_unit :h}.to_s(:label).should == '12 h^-1'
+    Term.new {path :hello; value 12; default_unit :kg}.to_s(:label).should == '12.0 kg'
+    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s(:label).should == '12.0 kg/h'
+    Term.new {path :hello; value 12; per_unit :h}.to_s(:label).should == '12.0 h^-1'
   end
 
   it "should represent term as string with unit name" do
-    Term.new {path :hello; value 12; default_unit :kg}.to_s(:name).should == '12 kilogram'
-    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s(:name).should == '12 kilogram per hour'
-    Term.new {path :hello; value 12; per_unit :h}.to_s(:name).should == '12 per hour'
+    Term.new {path :hello; value 12; default_unit :kg}.to_s(:name).should == '12.0 kilograms'
+    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s(:name).should == '12.0 kilograms per hour'
+    Term.new {path :hello; value 12; per_unit :h}.to_s(:name).should == '12.0 per hour'
   end
 
   it "should represent term as string with unit pluralized name" do
-    Term.new {path :hello; value 12; default_unit :kg}.to_s(:pluralized_name).should == '12 kilograms'
-    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s(:pluralized_name).should == '12 kilograms per hour'
-    Term.new {path :hello; value 12; per_unit :h}.to_s(:pluralized_name).should == '12 per hour'
+    Term.new {path :hello; value 12; default_unit :kg}.to_s(:pluralized_name).should == '12.0 kilograms'
+    Term.new {path :hello; value 12; default_unit :kg; per_unit :h}.to_s(:pluralized_name).should == '12.0 kilograms per hour'
+    Term.new {path :hello; value 12; per_unit :h}.to_s(:pluralized_name).should == '12.0 per hour'
+  end
+
+  it "should represent term as string with no units" do
+    Term.new {path :hello; value 12}.to_s(:pluralized_name).should == '12'
+    Term.new {path :hello; value 12}.to_s(:name).should == '12'
+    Term.new {path :hello; value 12}.to_s(:symbol).should == '12'
+    Term.new {path :hello; value 12}.to_s(:label).should == '12'
+    Term.new {path :hello; value 12}.to_s.should == '12'
   end
 
   it "should be recognised as numeric" do
@@ -345,9 +353,9 @@ describe Term do
       @term = Term.new { value 20; unit :kg; per_unit :h }
       quantity = @term.to_quantity
       quantity.unit.name.should eql "kilogram per hour"
-      quantity.unit.symbol.should eql "kg h^-1"
+      quantity.unit.symbol.should eql "kg/h"
       quantity.value.should eql 20.0
-      quantity.to_s.should eql "20.0 kg h^-1"
+      quantity.to_s.should eql "20.0 kg/h"
     end
 
     it "should return nil with no unit or per unit" do
@@ -381,5 +389,17 @@ describe Term do
       quantity.to_s.should eql "20.0 h^-1"
     end
   end
+
+  it "should recognise similar terms" do
+    @term1 = Term.new { value 20; per_unit :h }
+    @term2 = Term.new { value 20; per_unit :h }
+    (@term1 == @term2).should be_true
+  end
+
+  it "should recognise dissimilar terms" do
+    @term1 = Term.new { value 20; per_unit :h }
+    @term2 = Term.new { value 40; per_unit :h }
+    (@term1 == @term2).should be_false
+  end
   
 end

data/spec/spec_helper.rb

@@ -176,6 +176,20 @@ class AMEEMocker
     return self
   end
 
+  def create_and_get
+    mock_pi=test.flexmock(
+      :amounts=>test.flexmock(:find=>{:value=>result}),
+      :data_item_uid=>dataitemuid,
+      :uid=>uid
+    )
+    test.flexmock(AMEE::Profile::Item).should_receive(:create).
+      with(catuid,dataitemuid,
+      {:get_item=>true,:name=>:sometimestamp}.merge(params)).
+      at_least.once.
+      and_return(mock_pi)
+    return self
+  end
+
   def create
     test.flexmock(AMEE::Profile::Item).should_receive(:create).
       with(catuid,dataitemuid,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee-data-abstraction
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Hetherington
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-11 00:00:00 +01:00
+date: 2011-08-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,12 +60,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 31
         segments: 
         - 1
-        - 1
+        - 2
         - 0
-        version: 1.1.0
+        version: 1.2.0
   name: quantify
   version_requirements: *id003
 - !ruby/object:Gem::Dependency