amee-data-abstraction 1.0.0

data/.rvmrc

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

data/CHANGELOG.txt

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

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem "amee", "~> 3.0"
+gem 'uuidtools', '2.1.2'
+gem 'quantify', '1.1.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'
+end

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.12)
+    amee (3.0.1)
+      activesupport (~> 2.3.5)
+      json
+      log4r
+      nokogiri (~> 1.4.3.1)
+    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)
+    uuidtools (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amee (~> 3.0)
+  bundler (~> 1.0.0)
+  flexmock (> 0.8.6)
+  jeweler (~> 1.6.4)
+  quantify (= 1.1.0)
+  rcov
+  rspec (= 1.3.0)
+  rspec_spinner (= 1.1.3)
+  uuidtools (= 2.1.2)

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,188 @@
+== amee-data-abstraction
+
+The amee-data-abstraction gem provides an easy-to-use, highly configurable interface
+for providing AMEE-driven calculations to Rails applications.
+
+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-abstraction
+
+Documentation: http://rubydoc.info/gems/amee-data-abstraction
+
+== INSTALLATION
+
+ gem install amee-data-abstraction
+
+== 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 ~> 3.0
+ * uuidtools = 2.1.2
+ * quantify = 1.1.0
+ 
+== USAGE
+
+The library provides several useful functions:
+
+1. Abstracts away most of the details for making API calls into an elegant DSL-style
+configuration.
+
+2. Provides a host of macro-style helper methods for rapidly generating
+calcualtion templates
+
+3. Models each type of AMEE calculation as a fully configurable Ruby object.
+
+4. Enables the configuring of which inputs (drills and profile item values) and
+outputs (return values) to handle and display for each calculation type.
+
+5. Enables configuration of default interfaces (select lists, text fields, etc.)
+for calculation components.
+
+6. Enables customised, human-readable names and other descriptors to be associated
+with calculations or calculation components (inputs, outputs, etc.).
+
+7. Enables arbitrary metadata to be associated with calculations.
+
+8. Provides support for handling alternative units, including full configurability.
+
+
+=== Brief introduction
+
+The calculations provided by AMEE categories are represented by instances of the
+class AMEE::DataAbstraction::Calculation.
+
+This class has two subclasses, (1) PrototypeCalculation, which is used to
+represent a blank calculation template for a particular type of calculation; and
+(2) OngoingCalculation, instances of which represent actual individual calculations
+which are made.
+
+Calculation objects contain instances of the AMEE::DataAbstraction::Term class.
+The Term class, and its subclasses Input, Drill, Profile, Metadatum, Usage, and
+Output, represent components of a calculation such as inputs, outputs (i.e.
+caluclated values) and arbitrary metadatum.
+
+Prototype calculations can be contained within an instance of the class
+AMEE::DataAbstraction::CalculationSet, in order to provide rapid access to any
+defined calculation templates and instantiating of a new instance of a real
+calcualtion.
+
+=== Example usage
+
+Configure a calculation
+
+  include AMEE::DataAbstraction
+
+  my_template_calculation = PrototypeCalculation.new {
+
+    label :electricity                         # Custom unique label
+    name "Grid electricity supply"             # Custom name
+    path "/some/path/in/the/amee/platform"     # AMEE platform category path
+    terms_from_amee                            # helper for initializing and
+                                                 configuring all calculation
+                                                 terms based on AMEE platform
+  }
+
+                          #=> <AMEE::DataAbstraction::PrototypeCalculation ... >
+
+Create a new calculation instance
+
+  my_calculation = my_template_calculation.begin_calculation
+
+                          #=> <AMEE::DataAbstraction::OngoingCalculation ... >
+
+Set the calculation inputs
+
+  params = { :country => 'Sweden',
+             :consumption => { :value => 6000, :unit => 'kWh' }}
+
+  my_calculation.choose! params
+
+Submit to AMEE for calculation
+
+  my_calculation.calculate!
+
+  my_calculation[:co2].to_s     #=> "2456 kg"
+
+
+=== Configuring mutliple application calculation prototypes
+
+Typical practice is initialize the calculation prototypes required for an
+application via a configuration file which creates the required calculation
+templates within an instance of CalculationSet. If the calculation set is assigned
+to a global variable or constant, the set of prototypes is available for
+initializing new calculations and templating view structures (e.g. tables, forms)
+from anywhere in the application.
+
+Adding a configuration to /config or /config/initializers may be appropriate
+
+  # e.g. /config/initializers/calculations.rb
+
+   Calculations = AMEE::DataAbstraction::CalculationSet {
+
+    calculation {
+      label :electricity
+      name "Grid Electricity Supply"
+      path "/some/electricity/associated/path/in/amee"
+      terms_from_amee
+    }
+
+    calculation {
+      label :transport
+      name "Employee Commuting"
+      path "/some/transport/associated/path/in/amee"
+      terms_from_amee
+    }
+
+    calculation {
+      label :fuel
+      name "Fuel Consumption"
+      path "/some/fuel/associated/path/in/amee"
+      terms_from_amee
+    }
+  }
+
+                          #=> <AMEE::DataAbstraction::CalculationSet ... >
+
+From this global calculation set, initialize a new calculation
+
+  my_fuel_calculation = Calculations[:fuel].begin_calculation
+
+                          #=> <AMEE::DataAbstraction::OngoingCalculation ... >
+
+  a_different_transport_calculation = Calculations[:transport].begin_calculation
+
+                          #=> <AMEE::DataAbstraction::OngoingCalculation ... >
+
+=== Configuring a connection to AMEE
+
+The AMEE::DataAbstraction module uses the 'amee' ruby gem to interact with AMEE.
+The standard method for configuring and instantiating a connection to the AMEE
+API is to provide authentication credentials in the /config/amee.yml file,
+structured thus:
+
+  ---
+  production:
+    server: live.amee.com
+    username: <some user name>
+    password: <some password>
+    cache: rails
+
+  development:
+    server: stage.amee.com
+    username: <some user name>
+    password: <some password>
+    cache: rails
+
+  test:
+    server: stage.amee.com
+    username: <some user name>
+    password: <some password>

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-abstraction"
+  gem.homepage = "http://github.com/AMEE/amee-data-abstraction"
+  gem.license = "BSD 3-Clause"
+  gem.summary = %Q{Calculation and form building tool hiding details of AMEEconnect}
+  gem.description = %Q{Part of the AMEEappkit this gem provides a data abstraction layer, decreasing the amount and detail of development required}
+  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-abstraction #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/amee-data-abstraction.gemspec

@@ -0,0 +1,115 @@
+# 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-abstraction}
+  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 a data abstraction layer, decreasing the amount and detail of development required}
+  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-abstraction.gemspec",
+    "examples/_calculator_form.erb",
+    "examples/calculation_controller.rb",
+    "init.rb",
+    "lib/amee-data-abstraction.rb",
+    "lib/amee-data-abstraction/calculation.rb",
+    "lib/amee-data-abstraction/calculation_set.rb",
+    "lib/amee-data-abstraction/drill.rb",
+    "lib/amee-data-abstraction/exceptions.rb",
+    "lib/amee-data-abstraction/input.rb",
+    "lib/amee-data-abstraction/metadatum.rb",
+    "lib/amee-data-abstraction/ongoing_calculation.rb",
+    "lib/amee-data-abstraction/output.rb",
+    "lib/amee-data-abstraction/profile.rb",
+    "lib/amee-data-abstraction/prototype_calculation.rb",
+    "lib/amee-data-abstraction/term.rb",
+    "lib/amee-data-abstraction/terms_list.rb",
+    "lib/amee-data-abstraction/usage.rb",
+    "lib/config/amee_units.rb",
+    "lib/core-extensions/class.rb",
+    "lib/core-extensions/hash.rb",
+    "lib/core-extensions/ordered_hash.rb",
+    "lib/core-extensions/proc.rb",
+    "rails/init.rb",
+    "spec/amee-data-abstraction/calculation_set_spec.rb",
+    "spec/amee-data-abstraction/calculation_spec.rb",
+    "spec/amee-data-abstraction/drill_spec.rb",
+    "spec/amee-data-abstraction/input_spec.rb",
+    "spec/amee-data-abstraction/metadatum_spec.rb",
+    "spec/amee-data-abstraction/ongoing_calculation_spec.rb",
+    "spec/amee-data-abstraction/profile_spec.rb",
+    "spec/amee-data-abstraction/prototype_calculation_spec.rb",
+    "spec/amee-data-abstraction/term_spec.rb",
+    "spec/amee-data-abstraction/terms_list_spec.rb",
+    "spec/config/amee_units_spec.rb",
+    "spec/core-extensions/class_spec.rb",
+    "spec/core-extensions/hash_spec.rb",
+    "spec/core-extensions/ordered_hash_spec.rb",
+    "spec/core-extensions/proc_spec.rb",
+    "spec/fixtures/electricity.rb",
+    "spec/fixtures/electricity_and_transport.rb",
+    "spec/fixtures/transport.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/AMEE/amee-data-abstraction}
+  s.licenses = ["BSD 3-Clause"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Calculation and form building tool hiding details of AMEEconnect}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<amee>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<uuidtools>, ["= 2.1.2"])
+      s.add_runtime_dependency(%q<quantify>, ["= 1.1.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"])
+    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<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"])
+    end
+  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<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"])
+  end
+end
+