amee-data-persistence 1.0.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@amee-data-persistence

data/CHANGELOG.txt

@@ -0,0 +1,4 @@
+= Changelog
+
+== 1.0.0
+  * Initial public release

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Dependencies
+gem "amee-data-abstraction","~> 1.0.0"
+
+# 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 'flexmock', '> 0.8.6'
+  gem 'activerecord', '~> 2.3.5'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.12)
+      activesupport (= 2.3.12)
+    activesupport (2.3.12)
+    amee (3.0.1)
+      activesupport (~> 2.3.5)
+      json
+      log4r
+      nokogiri (~> 1.4.3.1)
+    amee-data-abstraction (1.0.0)
+      amee (~> 3.0)
+      quantify (= 1.1.0)
+      uuidtools (= 2.1.2)
+    flexmock (0.9.0)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.3)
+    log4r (1.1.9)
+    nokogiri (1.4.3.1)
+    quantify (1.1.0)
+      activesupport
+    rake (0.9.2)
+    rcov (0.9.10)
+    rspec (1.3.0)
+    rspec_spinner (1.1.3)
+      rtui
+    rtui (0.2.2)
+    sqlite3 (1.3.4)
+    uuidtools (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3.5)
+  amee-data-abstraction (~> 1.0.0)
+  bundler (~> 1.0.0)
+  flexmock (> 0.8.6)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (= 1.3.0)
+  rspec_spinner (= 1.1.3)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2011, AMEE UK Ltd.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+    Redistributions of source code must retain the above copyright notice, 
+    this list of conditions and the following disclaimer.
+    
+    Redistributions in binary form must reproduce the above copyright notice, 
+    this list of conditions and the following disclaimer in the documentation 
+    and/or other materials provided with the distribution.
+    
+    Neither the name of AMEE UK Ltd nor the names of its contributors may be 
+    used to endorse or promote products derived from this software without 
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.txt

@@ -0,0 +1,89 @@
+== amee-data-persistence
+
+The amee-data-persistence gem provides database support for use in conjunction
+with the amee-data-abstraction gem.
+
+Licensed under the BSD 3-Clause license (See LICENSE.txt for details)
+
+Authors: James Hetherington, James Smith, Andrew Berkeley, George Palmer
+
+Copyright: Copyright (c) 2011 AMEE UK Ltd
+
+Homepage: http://github.com/AMEE/amee-data-persistence
+
+Documentation: http://rubydoc.info/gems/amee-data-persistence
+== INSTALLATION
+
+ gem install amee-data-persistence
+ 
+== REQUIREMENTS
+
+ * ruby 1.8.7
+ * rubygems >= 1.5
+
+ All gem requirements should be installed as part of the rubygems installation process 
+ above, but are listed here for completeness.
+
+ * amee-data-abstraction ~> 1.0.0
+ 
+== USAGE
+
+The library repesents calculations as
+database records using two classes (<i>AMEE::Db::Calculation</i> and
+<i>AMEE::Db::Term</i>) both of which inherit <i>ActiveRecord::Base</i>.
+
+The library also defines the <i>AMEE::DataAbstraction::PersistenceSupport</i>
+module which is mixed into the <i>AMEE::DataAbstraction::OngoingCalculation</i>
+class by default when the library is required. The module provides a number of
+class and instance methods which provide an interface between the
+<i>AMEE::DataAbstraction::OngoingCalculation</i> class (and its instances) and
+the database. It is via these methods that the persistence functionality
+provided by the <i>AMEE::Db</i> classes is principally used.
+
+The level of data storage can be configured to three distinct levels, representing
+the range of calculation terms which are persisted: all; outputs and metadata only;
+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>
+
+where <storage_level> can be either 'everything', 'outputs' or 'metadata', e.g.,
+
+  $ script/generate persistence everything
+
+
+=== Example usage
+
+  my_calculation = OngoingCalculation.find(:first)
+
+                                 #=> <AMEE::DataAbstraction::OngoingCalculation ... >
+
+  my_calculation = OngoingCalculation.find(28)
+
+                                 #=> <AMEE::DataAbstraction::OngoingCalculation ... >
+
+  my_calculation = OngoingCalculation.find(:all)
+
+                                 #=> <AMEE::DataAbstraction::CalculationCollection ... >
+
+  my_calculation = OngoingCalculation.find_by_type(:all, :electricity)
+
+                                 #=> <AMEE::DataAbstraction::CalculationCollection ... >
+
+  my_calculation.id              #= 28
+
+  my_calculation.db_calculation  #=> <AMEE::Db::Calculation ... >
+
+  my_calculation.to_hash         #=> { :profile_uid => "EYR758EY36WY",
+                                       :profile_item_uid => "W83URT48DY3W",
+                                       :type => { :value => 'car' },
+                                       :distance => { :value => 1600,
+                                                      :unit => <Quantify::Unit::SI> },
+                                       :co2 => { :value => 234.1,
+                                                 :unit => <Quantify::Unit::NonSI> }}
+
+  my_calculation.save            #=> true
+
+  my_calculation.delete          #=> nil

data/Rakefile

@@ -0,0 +1,102 @@
+# 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.
+
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'spec'
+require 'spec/rake/spectask'
+
+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*,']
+end
+
+require 'jeweler'
+# Fix for Jeweler to use stable branch
+class Jeweler
+  module Commands
+    class ReleaseToGit
+      def run
+        unless clean_staging_area?
+          system "git status"
+          raise "Unclean staging area! Be sure to commit or .gitignore everything first. See `git status` above."
+        end
+        repo.checkout('stable')
+        repo.push('origin', 'stable')
+        if release_not_tagged?
+          output.puts "Tagging #{release_tag}"
+          repo.add_tag(release_tag)
+          output.puts "Pushing #{release_tag} to origin"
+          repo.push('origin', release_tag)
+        end
+      end
+    end
+    class ReleaseGemspec
+      def run
+        unless clean_staging_area?
+          system "git status"
+          raise "Unclean staging area! Be sure to commit or .gitignore everything first. See `git status` above."
+        end
+        repo.checkout('stable')
+        regenerate_gemspec!
+        commit_gemspec! if gemspec_changed?
+        output.puts "Pushing stable to origin"
+        repo.push('origin', 'stable')
+      end
+    end
+  end
+end
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "amee-data-persistence"
+  gem.homepage = "http://github.com/AMEE/amee-data-persistence"
+  gem.license = "BSD 3-Clause"
+  gem.summary = %Q{Persistent storage of calculations performed against the AMEE API}
+  gem.description = %Q{Part of the AMEEappkit, this gem provides storage and retrival of data provided by the amee-data-abstraction gem}
+  gem.email = "help@amee.com"
+  gem.authors = ["James Hetherington", "Andrew Berkeley", "James Smith", "George Palmer"]
+  # dependencies defined in Gemfile
+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/*"'
+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')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/amee-data-persistence.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amee-data-persistence}
+  s.version = "1.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-08-11}
+  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 = [
+    "LICENSE.txt",
+    "README.txt"
+  ]
+  s.files = [
+    ".rvmrc",
+    "CHANGELOG.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.txt",
+    "Rakefile",
+    "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/persistence_support.rb",
+    "lib/amee/db/calculation.rb",
+    "lib/amee/db/config.rb",
+    "lib/amee/db/term.rb",
+    "rails/init.rb",
+    "spec/amee/db/calculation_spec.rb",
+    "spec/amee/db/config_spec.rb",
+    "spec/amee/db/persistence_support_spec.rb",
+    "spec/amee/db/term_spec.rb",
+    "spec/database.yml",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/AMEE/amee-data-persistence}
+  s.licenses = ["BSD 3-Clause"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.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.0.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"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_development_dependency(%q<flexmock>, ["> 0.8.6"])
+      s.add_development_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<amee-data-abstraction>, ["~> 1.0.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"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_dependency(%q<flexmock>, ["> 0.8.6"])
+      s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<amee-data-abstraction>, ["~> 1.0.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"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+    s.add_dependency(%q<flexmock>, ["> 0.8.6"])
+    s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
+end
+

data/amee-data-persistence.tmproj

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>amee-data-persistence</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string></string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>200</integer>
+	<key>metaData</key>
+	<dict/>
+	<key>showFileHierarchyDrawer</key>
+	<true/>
+	<key>windowFrame</key>
+	<string>{{193, 217}, {1390, 940}}</string>
+</dict>
+</plist>

data/generators/persistence/persistence_generator.rb

@@ -0,0 +1,97 @@
+# 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