quantify-amee 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@quantify-amee

data/CHANGELOG.txt

@@ -0,0 +1 @@
+= Changelog

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "quantify", "~> 3.1"
+
+# 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', '~> 2.6.0'
+  gem 'rcov'
+  gem 'rdoc'
+end

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2012 by Andrew Berkeley (andrew.berkeley.is@googlemail.com)
+
+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.

data/README.md

@@ -0,0 +1,31 @@
+Quantify-ruby
+========
+
+This gem represents an installation of the Quantify gem specifically for use with the AMEE platform.
+
+Licensed under the MIT license (See LICENSE.txt for details)
+
+Authors: Andrew Berkeley
+
+Copyright: Copyright (c) Andrew Berkeley
+
+Homepage: https://github.com/spatchcock/quantify-amee
+
+
+Installation
+------------
+
+Just include the gem somewhere appropriate.
+
+
+Requirements
+------------
+
+ * Quantify > 3.1
+
+Usage
+-----
+
+Simply require 'quantify-amee'. This pulls in the Quantify gem and configures the system of units for use with the AMEE platform. This involves removing units which are not valid for use in AMEE, as well as some appropriate name and symbol changes.
+
+See https://github.com/spatchcock/quantify for details on the core Quantify gem.

data/Rakefile

@@ -0,0 +1,51 @@
+# 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 'rspec'
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "quantify-amee"
+  gem.homepage = "https://github.com/spatchcock/quantify-amee"
+  gem.license = "MIT"
+  gem.summary = %Q{Quantify extension which configures units for use with the AMEE platform}
+  gem.description = %Q{Quantify extension which configures units for use with the AMEE platform}
+  gem.email = "andrew.berkeley.is@googlemail.com"
+  gem.authors = ["Andrew Berkeley"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rcov/rcovtask'
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rd|
+  rd.title = "Quantify-AMEE"
+  rd.rdoc_dir = 'doc'
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/quantify-amee.rb

@@ -0,0 +1,143 @@
+require 'quantify'
+
+Quantify::Unit.configure do
+
+  # Remove from the system of known units, the units which are not used or not
+  # anticipated to be useful for interacting with AMEE. These either represent
+  # physical quantities which are not typically represented in emissions
+  # calculations (e.g. redioactivity, thermal resistance) or units which do
+  # represent appropriate physical quantities but are relatively obscure or
+  # inappropriate (e.g angstrom, calorie, cup, light year).
+  #
+  # Note: although AMEE supports 8 types of British thermal unit, only one is
+  # made available since it is unlikely that users would like to choose between
+  # each of the alternatives.
+
+  required_units = [ "1",
+                     "Hz",
+                     "Ohm",
+                     "V",
+                     "m/s",
+                     "m/s²",
+                     "A",
+                     "K",
+                     "m",
+                     "mol",
+                     "s",
+                     "kg",
+                     "g",
+                     "km",
+                     "m³",
+                     "J",
+                     "N",
+                     "W",
+                     "Pa",
+                     "m²",
+                     "atm",
+                     "bar",
+                     "ha",
+                     "L",
+                     "bbl",
+                     "oz_fl_uk",
+                     "gal_uk",
+                     "gallon_dry_us",
+                     "oz_fl",
+                     "bbl_fl_us",
+                     "gal",
+                     "kWh",
+                     "°C",
+                     "°F",
+                     "°R",
+                     "ft",
+                     "h",
+                     "in",
+                     "mi",
+                     "min",
+                     "month",
+                     "nmi",
+                     "oz",
+                     "lb",
+                     "t",
+                     "week",
+                     "yd",
+                     "year",
+                     "BTU_FiftyNineF",
+                     "ton_us",
+                     "ton_uk",
+                     "d",
+                     "lbmol"]
+
+  uneeded_units = []
+
+  # Determine units which are not required
+  units.each do |unit|
+    uneeded_units << unit.label unless required_units.include?(unit.label)
+  end
+
+  # Unload all unrequired units
+  unload(uneeded_units)
+
+end
+
+Quantify::Unit::SI.configure do
+
+  # Load the commonly used SI unit/prefix combinations which are used in AMEE
+  prefix_and_load [:mega,:giga], :gram
+  prefix_and_load [:mega,:giga,:tera], :joule
+  prefix_and_load [:kilo,:mega], :watt
+
+end
+
+Quantify::Unit::NonSI.configure do
+
+  # Give the remaining (default) British thermal unit version a humanised name
+  # and symbol
+  Unit.BTU_FiftyNineF.configure_as_canonical do |unit|
+    unit.name = 'british thermal unit'
+    unit.symbol = 'BTU'
+  end
+
+  # Differentiate long and short ton symbols
+  Unit.ton_us.configure_as_canonical do |unit|
+    unit.symbol = 'ton (US)'
+  end
+
+  Unit.ton_uk.configure_as_canonical do |unit|
+    unit.symbol = 'ton (UK)'
+  end
+
+  # Differentiate gallon symbols
+  Unit.gal.configure_as_canonical do |unit|
+    unit.symbol = 'gal (US)'
+  end
+
+  Unit.gallon_dry_us.configure_as_canonical do |unit|
+    unit.symbol = 'gal (US dry)'
+  end
+
+  Unit.gal_uk.configure_as_canonical do |unit|
+    unit.symbol = 'gal (UK)'
+  end
+
+  # Differentiate fluid ounce symbols
+  Unit.oz_fl.configure_as_canonical do |unit|
+    unit.symbol = 'fl oz (US)'
+  end
+
+  Unit.oz_fl_uk.configure_as_canonical do |unit|
+    unit.symbol = 'fl oz (UK)'
+  end
+
+  # AMEE uses 'day' rather than 'd' as the label for the time period, day
+  Unit.day.canonical_label = 'day'
+
+  # Load prefixed version of British thermal unit, which is used in AMEE
+  prefix_and_load :M, :BTU_FiftyNineF
+
+  # Define and load the megawatt hour, an energy unit used in AMEE
+  construct_and_load(megawatt*hour) do |unit|
+    unit.symbol = 'MWh'
+    unit.label = 'MWh'
+  end
+  
+end

data/spec/quantify_amee_spec.rb

@@ -0,0 +1,85 @@
+require 'quantify-amee'
+
+describe "AMEE units" do
+  
+  include Quantify
+
+  it "should include commonly used SI units" do
+    Unit.metre.should be_loaded
+    Unit.second.should be_loaded
+    Unit.kg.should be_loaded
+  end
+
+  it "should include commonly used non SI units" do
+    Unit.foot.should be_loaded
+    Unit.pound.should be_loaded
+    Unit.month.should be_loaded
+  end
+
+  it "should exclude uncommonly used SI units" do
+    Unit.micrometre.should_not be_loaded
+    lambda{Unit.galileo}.should raise_error
+    lambda{Unit.inverse_centimetre}.should raise_error
+  end
+
+  it "should exclude uncommonly used non SI units" do
+    lambda{Unit.astronomical_unit}.should raise_error
+    lambda{Unit.dyne_centimetre}.should raise_error
+    lambda{Unit.maxwell}.should raise_error
+  end
+
+  it "should include commonly used SI units and prefixes" do
+    Unit.terajoule.should be_loaded
+    Unit.gigagram.should be_loaded
+    Unit.megawatt.should be_loaded
+  end
+
+  it "should include commonly used Non SI units and prefixes" do
+    Unit.MBTU.should be_loaded
+  end
+
+  it "should exclude uncommonly used SI units and prefixes" do
+    Unit.microjoule.should_not be_loaded
+    Unit.nanogram.should_not be_loaded
+    Unit.picowatt.should_not be_loaded
+  end
+
+  it "should represent the BTU with the 59F version" do
+    Unit.BTU.label.should eql "BTU_FiftyNineF"
+  end
+
+  it "should label the unit for 'day' as 'day'" do
+    Unit.day.label.should eql 'day'
+  end
+
+  it "should recognise the unit for megawatt_hour as 'MWh'" do
+    Unit.megawatt_hour.label.should eql 'MWh'
+    Unit.megawatt_hour.symbol.should eql 'MWh'
+  end
+
+  it "should use the correct symbol for a US ton" do
+    Unit.ton_us.symbol.should eql 'ton (US)'
+  end
+
+  it "should use the correct symbol for a UK ton" do
+    Unit.ton_uk.symbol.should eql 'ton (UK)'
+  end
+
+  it "should use the correct symbol for a US gallon" do
+    Unit.gal.symbol.should eql 'gal (US)'
+  end
+
+  it "should use the correct symbol for a US dry gallon" do
+    Unit.gallon_dry_us.symbol.should eql 'gal (US dry)'
+  end
+
+  it "should use the correct symbol for a UK gallon" do
+    Unit.gal_uk.symbol.should eql 'gal (UK)'
+  end
+
+  it "should use the correct symbol for a US ton" do
+    Unit.oz_fl.symbol.should eql 'fl oz (US)'
+  end
+
+end
+

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: quantify-amee
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrew Berkeley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-11 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: quantify
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  prerelease: false
+  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
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id006
+description: Quantify extension which configures units for use with the AMEE platform
+email: andrew.berkeley.is@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .rvmrc
+- CHANGELOG.txt
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/quantify-amee.rb
+- spec/quantify_amee_spec.rb
+has_rdoc: true
+homepage: https://github.com/spatchcock/quantify-amee
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Quantify extension which configures units for use with the AMEE platform
+test_files: []
+