fuel_purchase 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Rossmeissl
+
+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.rdoc

@@ -0,0 +1,17 @@
+= fuel_purchase
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Andy Rossmeissl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fuel_purchase"
+    gem.summary = %Q{A carbon model}
+    gem.description = %Q{A software model in Ruby for the greenhouse gas emissions of a fuel purchase}
+    gem.email = "andy@rossmeissl.net"
+    gem.homepage = "http://github.com/brighterplanet/fuel_purchase"
+    gem.authors = ["Andy Rossmeissl", "Ian Hough", "Seamus Abshere", "Matt Kling"]
+    gem.add_development_dependency "leap"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fuel_purchase #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/fuel_purchase.rb

@@ -0,0 +1,85 @@
+module BrighterPlanet
+  module FuelPurchase
+    def self.included(base)
+      base.extend ::Leap::Subject
+      base.decide :emission, :with => :characteristics do
+        committee :emission do
+          quorum 'from volume and emission factor', :needs => [:volume, :emission_factor] do |characteristics|
+            #     variable units                variable units          FIXME TODO should we make volumes energy contents to avoid unit mismatches?
+            characteristics[:volume] * characteristics[:emission_factor]
+          end
+          
+          quorum 'default' do
+            raise "The fuel purchase's default emission quorum should never be called"
+          end
+        end
+        
+        committee :emission_factor do # FIXME TODO add date-based lookup once we have timeseries of emission factors
+          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
+            characteristics[:fuel_type].emission_factor
+          end
+          
+          quorum 'default' do
+            ::FuelType.fallback.emission_factor
+          end
+        end
+        
+        committee :volume do
+          quorum 'from cost and price', :needs => [:cost, :price] do |characteristics|
+            #       dollars          dollars / variable unit          FIXME TODO should we make prices $ / kJ to avoid unit mismatches?
+            characteristics[:cost] * characteristics[:price]
+          end
+          
+          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
+            #      variable units
+            characteristics[:fuel_type].average_purchase_volume
+          end
+          
+          quorum 'default' do # FIXME TODO get rid of this if we ever make a fallback fuel_type
+            #      variable units
+            FuelType.fallback.average_purchase_volume
+          end
+        end
+        
+        committee :price do
+          # FIXME TODO fill in location- and date-based quorums
+          # quorum :from_fuel_type_and_state_and_date, :needs => [:fuel_type, :state, :date] do |characteristics, timeframe|
+          # end
+          # 
+          # quorum :from_fuel_type_and_petroleum_administration_for_defense_district_and_date, :needs => [:fuel_type, :petroleum_administration_for_defense_district, :date] do |characteristics, timeframe|
+          # end
+          # 
+          # quorum :from_fuel_type_and_state, :needs => [:fuel_type, :state] do |characteristics, timeframe|
+          # end
+          # 
+          # quorum :from_fuel_type_and_petroleum_administration_for_defense_district, :needs => [:fuel_type, :petroleum_administration_for_defense_district] do |characteristics, timeframe|
+          # end
+          # 
+          # quorum :from_fuel_type_and_date, :needs [:fuel_type, :date] do |characteristics, timeframe|
+          # end
+          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
+            #    dollars / variable unit
+            characteristics[:fuel_type].price
+          end
+        end
+        
+        committee :petroleum_administration_for_defense_district do
+          quorum 'from state', :needs => :state do |characteristics|
+            characteristics[:state].petroleum_administration_for_defense_district
+          end
+        end
+        
+        committee :state do
+          quorum 'from zip code', :needs => :zip_code do |characteristics|
+            characteristics[:zip_code].state
+          end
+        end
+        
+        # FIXME TODO should this be only user-supplied, or should we specify a fallback?
+        # committee :fuel_type do |characteristics, timeframe|
+        #   FuelType.fallback.fuel_type
+        # end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fuel_purchase'
+
+class Test::Unit::TestCase
+end

data/test/test_fuel_purchase.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFuelPurchase < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: fuel_purchase
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andy Rossmeissl
+- Ian Hough
+- Seamus Abshere
+- Matt Kling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: leap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A software model in Ruby for the greenhouse gas emissions of a fuel purchase
+email: andy@rossmeissl.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fuel_purchase.rb
+- test/helper.rb
+- test/test_fuel_purchase.rb
+has_rdoc: true
+homepage: http://github.com/brighterplanet/fuel_purchase
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A carbon model
+test_files: 
+- test/helper.rb
+- test/test_fuel_purchase.rb