amee-data-persistence 1.2.0 → 2.0.0

data/.rvmrc

@@ -1 +1 @@
-rvm 1.8.7@amee-data-persistence-rails2
+rvm 1.8.7@amee-data-persistence

data/CHANGELOG.txt

@@ -1,7 +1,4 @@
 = Changelog
 
-== 1.2.0
-  * Update for supporting the new handling of Calculation Sets in amee-data-abstraction
-
 == 1.0.0
   * Initial public release

data/Gemfile

@@ -1,17 +1,14 @@
 source "http://rubygems.org"
 
-# Dependencies
-gem "amee-data-abstraction","~> 1.3"
+gem "amee-data-abstraction", "~> 2.0"
+gem 'activerecord', '~> 3.0.10'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
-  gem 'rspec', '1.3.0'
-  gem 'rcov'
-  gem 'rspec_spinner', '1.1.3'
+  gem 'rspec', '2.6.0'
   gem 'flexmock', '> 0.8.6'
-  gem 'activerecord', '~> 2.3.5'
+  gem 'rcov'
+  gem 'rdoc'
   gem 'sqlite3'
-end
+end

data/Gemfile.lock

@@ -1,50 +1,66 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activerecord (2.3.12)
-      activesupport (= 2.3.12)
-    activesupport (2.3.12)
-    amee (3.1.2)
-      activesupport (~> 2.3.5)
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.10)
+    amee (3.0.1)
+      activesupport (~> 3.0.10)
       json
       log4r
       nokogiri (~> 1.4.3.1)
-    amee-data-abstraction (1.3.0)
-      amee (~> 3.1)
-      quantify (= 1.2.2)
+    amee-data-abstraction (2.0.0)
+      amee (~> 3.0)
+      quantify (~> 2.0.0)
       uuidtools (= 2.1.2)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
     flexmock (0.9.0)
     git (1.2.5)
-    i18n (0.6.0)
+    i18n (0.5.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.5.3)
+    json (1.5.4)
     log4r (1.1.9)
     nokogiri (1.4.3.1)
-    quantify (1.2.2)
-      activesupport
+    quantify (2.0.0)
+      activesupport (~> 3.0.10)
       i18n
     rake (0.9.2)
     rcov (0.9.10)
-    rspec (1.3.0)
-    rspec_spinner (1.1.3)
-      rtui
-    rtui (0.2.2)
+    rdoc (3.9.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     sqlite3 (1.3.4)
+    tzinfo (0.3.29)
     uuidtools (2.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 2.3.5)
-  amee-data-abstraction (~> 1.3)
+  activerecord (~> 3.0.10)
+  amee-data-abstraction (~> 2.0)
   bundler (~> 1.0.0)
   flexmock (> 0.8.6)
   jeweler (~> 1.6.4)
   rcov
-  rspec (= 1.3.0)
-  rspec_spinner (= 1.1.3)
+  rdoc
+  rspec (= 2.6.0)
   sqlite3

data/README.txt

@@ -47,11 +47,11 @@ and metadata only.
 The global persistence storage level and migrations for the database tables
 (under /db/migrate) can be generated using the command line generator command:
 
-  $ script/generate persistence <storage_level>
+  $ rails generate persistence <storage_level>
 
 where <storage_level> can be either 'everything', 'outputs' or 'metadata', e.g.,
 
-  $ script/generate persistence everything
+  $ rails generate persistence everything
 
 
 === Example usage
@@ -86,7 +86,4 @@ where <storage_level> can be either 'everything', 'outputs' or 'metadata', e.g.,
 
   my_calculation.save            #=> true
 
-  my_calculation.delete          #=> nil
-
-In order to use the persistence library, prototype calculations must be held within
-instances of the AMEE::DataAbstraction::CalculationSet class
+  my_calculation.delete          #=> nil

data/Rakefile

@@ -13,16 +13,14 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-require 'spec'
-require 'spec/rake/spectask'
+require 'rspec'
+require 'rspec/core/rake_task'
 
 task :default => [:spec]
 
-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*,/*gems*']
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
 end
 
 require 'jeweler'
@@ -74,29 +72,17 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
 require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
 end
 
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "amee-data-persistence #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'rdoc/task'
+RDoc::Task.new do |rd|
+  rd.title = "AMEE Data Persistence"
+  rd.rdoc_dir = 'doc'
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
 end

data/VERSION

@@ -1 +1 @@
-1.2.0
+2.0.0

data/amee-data-persistence.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee-data-persistence}
-  s.version = "1.2.0"
+  s.version = "2.0.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-10-18}
+  s.date = %q{2011-09-28}
   s.description = %q{Part of the AMEEappkit, this gem provides storage and retrival of data provided by the amee-data-abstraction gem}
   s.email = %q{help@amee.com}
   s.extra_rdoc_files = [
@@ -27,25 +27,21 @@ Gem::Specification.new do |s|
     "VERSION",
     "amee-data-persistence.gemspec",
     "amee-data-persistence.tmproj",
-    "generators/persistence/persistence_generator.rb",
-    "generators/persistence/templates/config/persistence.yml.erb",
-    "generators/persistence/templates/db/migrate/001_create_persistence_tables.rb",
-    "generators/persistence/templates/db/migrate/002_add_unit_columns.rb",
-    "generators/persistence/templates/db/migrate/003_add_value_types.rb",
-    "init.rb",
     "lib/amee-data-persistence.rb",
     "lib/amee/data_abstraction/calculation_collection.rb",
-    "lib/amee/data_abstraction/ongoing_calculation_persistence_support.rb",
+    "lib/amee/data_abstraction/persistence_support.rb",
     "lib/amee/db/calculation.rb",
     "lib/amee/db/config.rb",
     "lib/amee/db/term.rb",
-    "rails/init.rb",
+    "lib/generators/persistence/persistence_generator.rb",
+    "lib/generators/persistence/templates/config/persistence.yml.erb",
+    "lib/generators/persistence/templates/db/migrate/001_create_persistence_tables.rb",
+    "lib/generators/persistence/templates/db/migrate/002_add_unit_columns.rb",
+    "lib/generators/persistence/templates/db/migrate/003_add_value_types.rb",
     "spec/amee/db/calculation_spec.rb",
     "spec/amee/db/config_spec.rb",
-    "spec/amee/db/ongoing_calculation_persistence_support_spec.rb",
+    "spec/amee/db/persistence_support_spec.rb",
     "spec/amee/db/term_spec.rb",
-    "spec/amee/fixtures/config/calculations/electricity.lock.rb",
-    "spec/amee/fixtures/config/calculations/electricity.rb",
     "spec/database.yml",
     "spec/spec.opts",
     "spec/spec_helper.rb"
@@ -53,42 +49,42 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/AMEE/amee-data-persistence}
   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{Persistent storage of calculations performed against the AMEE API}
 
   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.3"])
+      s.add_runtime_dependency(%q<amee-data-abstraction>, ["~> 2.0"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.10"])
       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"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_development_dependency(%q<rspec>, ["= 2.6.0"])
       s.add_development_dependency(%q<flexmock>, ["> 0.8.6"])
-      s.add_development_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
     else
-      s.add_dependency(%q<amee-data-abstraction>, ["~> 1.3"])
+      s.add_dependency(%q<amee-data-abstraction>, ["~> 2.0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.10"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rspec>, ["= 1.3.0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_dependency(%q<rspec>, ["= 2.6.0"])
       s.add_dependency(%q<flexmock>, ["> 0.8.6"])
-      s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
     end
   else
-    s.add_dependency(%q<amee-data-abstraction>, ["~> 1.3"])
+    s.add_dependency(%q<amee-data-abstraction>, ["~> 2.0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.10"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rspec>, ["= 1.3.0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+    s.add_dependency(%q<rspec>, ["= 2.6.0"])
     s.add_dependency(%q<flexmock>, ["> 0.8.6"])
-    s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
   end
 end

data/lib/amee-data-persistence.rb

@@ -2,12 +2,14 @@
 # Released as Open Source Software under the BSD 3-Clause license. See LICENSE.txt for details.
 
 require 'rubygems'
-gem 'activerecord', "~> 2.3.9"
 require 'active_record'
 require 'quantify'
+require 'amee-data-abstraction'
 
 require 'amee/data_abstraction/calculation_collection'
-require 'amee/data_abstraction/ongoing_calculation_persistence_support'
+require 'amee/data_abstraction/persistence_support'
 require 'amee/db/calculation'
 require 'amee/db/term'
 require 'amee/db/config'
+
+::AMEE::DataAbstraction::OngoingCalculation.send :include,  ::AMEE::DataAbstraction::PersistenceSupport

data/lib/amee/data_abstraction/{ongoing_calculation_persistence_support.rb → persistence_support.rb}

@@ -223,7 +223,7 @@ module AMEE
           unless record.is_a? AMEE::Db::Calculation
             raise ArgumentError.new("Argument is not of class AMEE::Db::Calculation")
           end
-          calc = AMEE::DataAbstraction::CalculationSet.find_prototype_calculation(record.type).begin_calculation
+          calc = Calculations.calculations[record.type].begin_calculation
           calc.db_calculation = record
           # Means that validation needs to occur before calcs are saved
     		  calc.choose_without_validation!(record.to_hash)

data/lib/amee/db/calculation.rb

@@ -22,9 +22,9 @@ module AMEE
     class Calculation < ActiveRecord::Base
 
       has_many              :terms, :class_name => "AMEE::Db::Term", :dependent => :destroy
-      validates_presence_of :calculation_type
-      validates_format_of   :profile_item_uid, :with => /\A([A-Z0-9]{12})\z/, :allow_nil => true, :allow_blank => true
-      validates_format_of   :profile_uid, :with => /\A([A-Z0-9]{12})\z/, :allow_nil => true, :allow_blank => true
+      validates             :calculation_type, :presence => true
+      validates             :profile_item_uid, :format => {:with => /\A([A-Z0-9]{12})\z/, :allow_nil => true, :allow_blank => true}
+      validates             :profile_uid, :format => {:with => /\A([A-Z0-9]{12})\z/, :allow_nil => true, :allow_blank => true}
       before_save           :validate_calculation_type
 
       # Standardize the <tt>calculation_type</tt> attribute to <i>String</i>

data/lib/amee/db/config.rb

@@ -39,7 +39,7 @@ module AMEE
       private
       
       def load_storage_method
-        m = YAML.load_file("#{::Rails.root}/config/persistence.yml")['method'].to_sym rescue nil
+        m = YAML.load_file("#{RAILS_ROOT}/config/persistence.yml")['method'].to_sym rescue nil
         raise "amee-data-persistence: Invalid storage method" unless [:metadata, :outputs, :everything].include? m
         m
       end

data/lib/amee/db/term.rb

@@ -20,7 +20,8 @@ module AMEE
     class Term < ActiveRecord::Base
 
       belongs_to :calculation, :class_name => "AMEE::Db::Calculation"
-      validates_presence_of :calculation_id, :label
+      validates :calculation_id, :presence => true
+      validates :label,          :presence => true
       before_save :initialize_units
       before_save :initialize_value
 

data/lib/generators/persistence/persistence_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class PersistenceGenerator < Rails::Generators::Base
+
+  include Rails::Generators::Migration
+
+  desc "Generates a migration for the AMEE Organisation models"
+  def self.source_root
+    @source_root ||= File.dirname(__FILE__) + '/templates'
+  end
+
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  def generate_migration
+    migration_template 'db/migrate/001_create_persistence_tables.rb', 'db/migrate/create_persistence_tables'
+    migration_template 'db/migrate/002_add_unit_columns.rb', 'db/migrate/add_unit_columns'
+    migration_template 'db/migrate/003_add_value_types.rb', 'db/migrate/add_value_types'
+  end
+
+  def manifest
+    record do |m|
+      
+      ########################################
+      # persistence level configuration file #
+      ########################################
+
+      # Get method from command line - default is metadata
+      method = args[0] || 'metadata'
+      # Make sure there is a config directory
+      m.directory File.join("config")
+      # Create persistence.yml file
+      m.template File.join("config","persistence.yml.erb"),
+                 File.join("config","persistence.yml"),
+                 :assigns => {:method => method}
+
+    end
+  end
+end

data/spec/amee/db/calculation_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'spec_helper'
 
 include AMEE::Db
 

data/spec/amee/db/config_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require 'spec_helper'
 
 describe AMEE::Db::Config do
   

data/spec/amee/db/{ongoing_calculation_persistence_support_spec.rb → persistence_support_spec.rb}

@@ -1,24 +1,24 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'spec_helper'
 
 describe AMEE::DataAbstraction::OngoingCalculation do
 
-  before(:all) do
+  before(:each) do
     populate_db
-    AMEE::DataAbstraction::CalculationSet.find("electricity")
+    initialize_calculation_set
   end
 
-  after(:all) do
+  after(:each) do
     AMEE::Db::Calculation.delete_all
   end
 
   describe "find" do
-
+  
     before(:each) do
       choose_mock
       yaml_load_mock(:everything)
       @reference = AMEE::Db::Calculation.find(:first).id
     end
-
+  
     it "should create new ongoing calculation from db record" do
       @db_calculation = AMEE::Db::Calculation.find :first
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.initialize_from_db_record @db_calculation
@@ -33,7 +33,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       hash[:profile_item_uid].should == "J38DY57SK591"
       hash[:profile_uid].should be_nil
     end
-
+  
     it "should create new ongoing calculation from db record with find" do
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find :first
       @ongoing_calculation.is_a?(AMEE::DataAbstraction::OngoingCalculation).should be_true
@@ -61,7 +61,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       hash[:profile_item_uid].should == "J38DY57SK591"
       hash[:profile_uid].should be_nil
     end
-
+  
     it "should create new ongoing calculation from db record with find and profile item uid" do
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find :first, :conditions => {:profile_item_uid => "K588DH47SMN5"}
       @ongoing_calculation.label.should == :electricity
@@ -89,7 +89,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
         hash[:usage][:value].should_not be_nil
       end
     end
-
+  
     it "should create new ongoing calculation from db record with #find_by_type" do
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find_by_type :first, :electricity
       @ongoing_calculation.label.should == :electricity
@@ -103,7 +103,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       hash[:profile_item_uid].should == "J38DY57SK591"
       hash[:profile_uid].should == nil
     end
-
+  
     it "should create multiple new ongoing calculations from db record with #find_by_type" do
       @ongoing_calculations = AMEE::DataAbstraction::OngoingCalculation.find_by_type :all, :electricity
       @ongoing_calculations.class.should == AMEE::DataAbstraction::CalculationCollection
@@ -117,7 +117,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
         hash[:usage][:value].should_not be_nil
       end
     end
-
+  
     it "should instantiate record at ongoing calc #db_calculation attribute" do
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find :first
       @ongoing_calculation.label.should == :electricity
@@ -125,51 +125,51 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       @ongoing_calculation.db_calculation.is_a?(AMEE::Db::Calculation).should be_true
       @ongoing_calculation.db_calculation.id.should == @reference
     end
-
+  
     it "should find assocaited db instance by id" do
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find @reference
       @ongoing_calculation.id.should == @reference
     end
-
-
+  
+  
     it "should give nil id, if not saved" do
-      AMEE::DataAbstraction::CalculationSet.find("electricity")[:electricity].begin_calculation.db_calculation.should be_nil
-      AMEE::DataAbstraction::CalculationSet.find("electricity")[:electricity].begin_calculation.id.should be_nil
+      Calculations[:electricity].begin_calculation.db_calculation.should be_nil
+      Calculations[:electricity].begin_calculation.id.should be_nil
     end
   end
-
+  
   describe "when storage method is :everything" do
-
+  
     before(:each) do
       choose_mock
       yaml_load_mock(:everything)
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find :first
     end
-
+  
     it "should find storage method" do
       AMEE::DataAbstraction::OngoingCalculation.storage_method.should == :everything
     end
-
+  
     it "should start off dirty" do
       @ongoing_calculation.should be_dirty
     end
-
+  
     it "should establish whether inputs to be stored" do
       AMEE::DataAbstraction::OngoingCalculation.store_inputs?.should be_true
     end
-
+  
     it "should establish whether outputs to be stored" do
       AMEE::DataAbstraction::OngoingCalculation.store_outputs?.should be_true
     end
-
+  
     it "should establish whether metadata to be stored" do
       AMEE::DataAbstraction::OngoingCalculation.store_metadata?.should be_true
     end
-
+  
     it "should return array of terms for storing which includes all terms" do
       @ongoing_calculation.stored_terms.should == @ongoing_calculation.terms
     end
-
+  
     it "should return hash with all terms" do
       hash = @ongoing_calculation.to_hash
       hash.is_a?(Hash).should be_true
@@ -177,7 +177,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       hash.keys.map!(&:to_s).sort!.should == [:profile_item_uid, :profile_uid, :calculation_type,
                                               :co2, :usage, :country ].map!(&:to_s).sort!
     end
-
+  
     it "should save all terms" do
       record = @ongoing_calculation.db_calculation
       # show that db record has values
@@ -197,41 +197,41 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       record.to_hash[:co2][:value].should == 1200
       record.to_hash[:usage][:value].should == 6000
     end
-
+  
   end
-
+  
   describe "when storage method is :metadata" do
-
+  
     before(:each) do
       choose_mock
       yaml_load_mock(:metadata)
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find :first
     end
-
+  
     it "should find storage method" do
       AMEE::DataAbstraction::OngoingCalculation.storage_method.should == :metadata
     end
-
+  
     it "should establish whether inputs to be stored" do
       AMEE::DataAbstraction::OngoingCalculation.store_inputs?.should be_false
     end
-
+  
     it "should establish whether outputs to be stored" do
       AMEE::DataAbstraction::OngoingCalculation.store_outputs?.should be_false
     end
-
+  
     it "should establish whether metadata to be stored" do
       AMEE::DataAbstraction::OngoingCalculation.store_metadata?.should be_true
     end
-
+  
     it "should start off dirty" do
       @ongoing_calculation.should be_dirty
     end
-
+  
     it "should return array of terms for storing which includes only metadata" do
       @ongoing_calculation.stored_terms.should_not == @ongoing_calculation.terms
     end
-
+  
     it "should return hash with only metadata terms" do
       hash = @ongoing_calculation.to_hash
       hash.is_a?(Hash).should be_true
@@ -239,7 +239,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       hash.keys.map!(&:to_s).sort!.should == [:profile_item_uid, :profile_uid,
                                               :calculation_type ].map!(&:to_s).sort!
     end
-
+  
     it "should save only metadata terms" do
       record = @ongoing_calculation.db_calculation
       # show that db record has values
@@ -254,7 +254,7 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       record.to_hash[:co2].should == nil
       record.to_hash[:usage].should == nil
     end
-
+  
   end
 
   describe "when storage method is :outputs" do
@@ -311,7 +311,6 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       record.to_hash[:co2][:value].should == 1200
       record.to_hash[:usage].should == nil
     end
-
   end
 
   describe "saving" do
@@ -332,12 +331,11 @@ describe AMEE::DataAbstraction::OngoingCalculation do
       # Saving should now return false, propogating errors from AR::Base
       @ongoing_calculation.save.should eql false
     end
-    
   end
 
   describe "deleting calculation" do
 
-    before(:all) do
+    before(:each) do
       choose_mock
       delete_mock
       @ongoing_calculation = AMEE::DataAbstraction::OngoingCalculation.find :first

data/spec/amee/db/term_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'spec_helper'
 
 include AMEE::Db
 

data/spec/spec_helper.rb

@@ -1,34 +1,22 @@
 require 'rubygems'
-require 'spec'
-require 'rspec_spinner'
+require 'rspec'
 require 'yaml'
 require 'logger'
-gem 'amee-data-abstraction'
-require 'amee-data-abstraction'
-
-DB_CONFIG = YAML.load_file(File.dirname(__FILE__) + '/database.yml')
-DB_MIGRATION = File.join(File.dirname(__FILE__), '..','generators','persistence','templates','db','migrate')
+require 'amee-data-persistence'
 
-class Rails
-  def self.root
-    File.dirname(__FILE__) + '/amee/fixtures'
-  end
+RSpec.configure do |config|
+  config.mock_with :flexmock
 end
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'amee-data-persistence'
-require 'amee/data_abstraction/ongoing_calculation_persistence_support'
+RAILS_ROOT = '.'
 
-ActiveRecord::Base.logger = Logger.new(File.open('database.log', 'a'))
-AMEE::DataAbstraction::OngoingCalculation.class_eval { include AMEE::DataAbstraction::PersistenceSupport }
+DB_CONFIG = YAML.load_file(File.dirname(__FILE__) + '/database.yml')
+DB_MIGRATION = File.join(File.dirname(__FILE__), '..','generators','persistence','templates','db','migrate')
 
+ActiveRecord::Base.logger = Logger.new(File.open('database.log', 'a'))
 ActiveRecord::Base.establish_connection(DB_CONFIG)
 ActiveRecord::Migrator.up(DB_MIGRATION)
 
-Spec::Runner.configure do |config|
-  config.mock_with :flexmock
-end
-
 def yaml_load_mock(method)
   flexmock(YAML) do |mock|
     mock.should_receive(:load_file).and_return('method' => method.to_s)
@@ -70,3 +58,28 @@ def populate_db
     AMEE::Db::Calculation.new { |calc| calc.update_calculation! attr }
   end
 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'
+        }
+        output {
+          label :co2
+          name 'Carbon Dioxide'
+          path :default
+        }
+      }
+    }"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee-data-persistence
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 15
   prerelease: 
   segments: 
-  - 1
   - 2
   - 0
-  version: 1.2.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - James Hetherington
@@ -18,27 +18,45 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 +01:00
+date: 2011-09-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: amee-data-abstraction
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 3
         segments: 
-        - 1
-        - 3
-        version: "1.3"
+        - 2
+        - 0
+        version: "2.0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: activerecord
   type: :runtime
-  requirement: *id001
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 0
+        - 10
+        version: 3.0.10
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,12 +67,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  prerelease: false
-  type: :development
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,58 +83,28 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  prerelease: false
-  type: :development
-  requirement: *id003
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
   prerelease: false
+  name: rspec
   type: :development
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
+        - 2
+        - 6
         - 0
-        version: "0"
-  prerelease: false
-  type: :development
+        version: 2.6.0
   requirement: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec_spinner
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 1
-        - 3
-        version: 1.1.3
   prerelease: false
-  type: :development
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
   name: flexmock
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">"
@@ -127,27 +115,39 @@ dependencies:
         - 8
         - 6
         version: 0.8.6
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
   prerelease: false
+  name: rcov
   type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   requirement: *id007
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  prerelease: false
+  name: rdoc
+  type: :development
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 3
         segments: 
-        - 2
-        - 3
-        - 5
-        version: 2.3.5
-  prerelease: false
-  type: :development
+        - 0
+        version: "0"
   requirement: *id008
 - !ruby/object:Gem::Dependency 
+  prerelease: false
   name: sqlite3
+  type: :development
   version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -157,8 +157,6 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  type: :development
   requirement: *id009
 description: Part of the AMEEappkit, this gem provides storage and retrival of data provided by the amee-data-abstraction gem
 email: help@amee.com
@@ -180,25 +178,21 @@ files:
 - VERSION
 - amee-data-persistence.gemspec
 - amee-data-persistence.tmproj
-- generators/persistence/persistence_generator.rb
-- generators/persistence/templates/config/persistence.yml.erb
-- generators/persistence/templates/db/migrate/001_create_persistence_tables.rb
-- generators/persistence/templates/db/migrate/002_add_unit_columns.rb
-- generators/persistence/templates/db/migrate/003_add_value_types.rb
-- init.rb
 - lib/amee-data-persistence.rb
 - lib/amee/data_abstraction/calculation_collection.rb
-- lib/amee/data_abstraction/ongoing_calculation_persistence_support.rb
+- lib/amee/data_abstraction/persistence_support.rb
 - lib/amee/db/calculation.rb
 - lib/amee/db/config.rb
 - lib/amee/db/term.rb
-- rails/init.rb
+- lib/generators/persistence/persistence_generator.rb
+- lib/generators/persistence/templates/config/persistence.yml.erb
+- lib/generators/persistence/templates/db/migrate/001_create_persistence_tables.rb
+- lib/generators/persistence/templates/db/migrate/002_add_unit_columns.rb
+- lib/generators/persistence/templates/db/migrate/003_add_value_types.rb
 - spec/amee/db/calculation_spec.rb
 - spec/amee/db/config_spec.rb
-- spec/amee/db/ongoing_calculation_persistence_support_spec.rb
+- spec/amee/db/persistence_support_spec.rb
 - spec/amee/db/term_spec.rb
-- spec/amee/fixtures/config/calculations/electricity.lock.rb
-- spec/amee/fixtures/config/calculations/electricity.rb
 - spec/database.yml
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -232,7 +226,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: Persistent storage of calculations performed against the AMEE API

data/generators/persistence/persistence_generator.rb

@@ -1,97 +0,0 @@
-# Copyright (C) 2011 AMEE UK Ltd. - http://www.amee.com
-# Released as Open Source Software under the BSD 3-Clause license. See LICENSE.txt for details.
-
-# :title: Class: PersistenceGenerator
-
-# The global persistence storage level and migrations for the database tables can be
-# generated the <i>PersistenceGenerator</i> class.
-#
-# The level of data storage for <i>AMEE::Db</i> can be configured to three
-# distinct levels, representing the range of calculation terms which are
-# persisted: all; outputs and metadata only; and metadata only.
-#
-# To set the global persistence level and generate migration files in /db/migrate,
-# execute the following command line generator command:
-#
-#  $ script/generate persistence <storage_level>
-#
-# where <storage_level> can be either 'everything', 'outputs' or 'metadata', e.g.,
-#
-#  $ script/generate persistence everything
-#
-class PersistenceGenerator < Rails::Generator::Base
-
-  # Need to explicitly define the paths to both the templates directory and the
-  # standard application migrations directory. These are equivalent when using
-  # the #template method it is assumed therein that there is a mapping to the
-  # /templates directory for the generator templates (and from there the sub-
-  # paths are the same). This assumption is not valid when accessing the
-  # templates and the existing application migrations otherwise.
-  #
-  DEFAULT_MIGRATION_PATH = File.join("db/migrate")
-  TEMPLATE_MIGRATION_PATH = File.join(File.dirname(__FILE__),"templates",DEFAULT_MIGRATION_PATH)
-
-  def manifest
-    record do |m|
-      
-      ########################################
-      # persistence level configuration file #
-      ########################################
-
-      # Get method from command line - default is metadata
-      method = args[0] || 'metadata'
-      # Make sure there is a config directory
-      m.directory File.join("config")
-      # Create persistence.yml file
-      m.template File.join("config","persistence.yml.erb"),
-                 File.join("config","persistence.yml"),
-                 :assigns => {:method => method}
-
-
-
-      #######################
-      # database migrations #
-      #######################
-
-      # Check db/migrate exists
-      m.directory DEFAULT_MIGRATION_PATH
-      # Create migrations if not already represented
-      migration_template_files.each_with_index do |file_name,index|
-        unless migration_exists? file_name
-          template_path = File.join(DEFAULT_MIGRATION_PATH,file_name)
-          # increment timestamp to differentiate files generated within same second
-          destination_file_name = file_name.gsub(/\d{3}/,"#{Time.now.strftime("%Y%m%d%I%M%S").to_i+index}")
-          destination_path = File.join(DEFAULT_MIGRATION_PATH,destination_file_name)
-          
-          m.template template_path, destination_path
-        else
-          # print to stdout in standard migration reporting format
-          puts "      exists  migration content in template: #{file_name}"
-        end
-      end
-
-    end
-  end
-
-  # Get names of all migration template files and sort them by version number
-  def migration_template_files
-    Dir.new(TEMPLATE_MIGRATION_PATH).entries.reject { |entry| File.directory? entry }.sort
-  end
-
-  # Check whether a migration already exists, by comparing the content of the
-  # migration template with any migrations which already exist in the
-  # applicaition's db/migrate directory. This is preferable to using file names
-  # since file names (1) have a time stamp and are therefore not consistent
-  # between separate instances of a file generation and (2) migration names may
-  # be changed in the future.
-  #
-  def migration_exists?(template)
-    template_content = File.read(File.join(TEMPLATE_MIGRATION_PATH,template))
-
-    Dir.new(DEFAULT_MIGRATION_PATH).entries.any? do |file|
-      next if File.directory?(file)
-      File.read(File.join(DEFAULT_MIGRATION_PATH,file)) == template_content
-    end
-  end
-
-end

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + "/rails/init"

data/rails/init.rb

@@ -1,31 +0,0 @@
-
-# Authors::   James Hetherington, James Smith, Andrew Berkeley, George Palmer
-# Copyright:: Copyright (c) 2011 AMEE UK Ltd
-# License::   Permission is hereby granted, free of charge, to any person obtaining
-#             a copy of this software and associated documentation files (the
-#             "Software"), to deal in the Software without restriction, including
-#             without limitation the rights to use, copy, modify, merge, publish,
-#             distribute, sublicense, and/or sell copies of the Software, and to
-#             permit persons to whom the Software is furnished to do so, subject
-#             to the following conditions:
-#
-#             The above copyright notice and this permission notice shall be included
-#             in all copies or substantial portions of the Software.
-#
-#             THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-#             EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-#             MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-#             IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-#             CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-#             TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-#             SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-
-require 'amee-data-abstraction'
-require 'amee-data-persistence'
-
-# include the <i>AMEE::DataAbstraction::PersistenceSupport</i> module within the
-# <i>AMEE::DataAbstraction::OngoingCalculation</i> class providing interface
-# methods for managing persistence of calculations.
-#
-::AMEE::DataAbstraction::OngoingCalculation.class_eval { include ::AMEE::DataAbstraction::PersistenceSupport }

data/spec/amee/fixtures/config/calculations/electricity.lock.rb

@@ -1,30 +0,0 @@
-calculation {
-
-  name "Electricity"
-  label :electricity
-  path "/business/energy/electricity/grid"
-
-  drill {
-    name "Country"
-    label :country
-    path "country"
-    value "Argentina"
-    fixed "Argentina"
-    interface :drop_down
-  }
-
-  profile {
-    name "Electricity Used"
-    label :usage
-    path "energyPerTime"
-    interface :text_box
-  }
-
-  output {
-    name "Carbon Dioxide"
-    label :co2
-    path "default"
-  }
-
-}
-

data/spec/amee/fixtures/config/calculations/electricity.rb

@@ -1,20 +0,0 @@
-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'
-   }
-   output {
-     label :co2
-     name 'Carbon Dioxide'
-     path 'default'
-   }
- }