automobile 0.0.0

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 @@
+= automobile
+
+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 = "automobile"
+    gem.summary = %Q{A carbon model}
+    gem.description = %Q{A software model in Ruby for the greenhouse gas emissions of an automobile}
+    gem.email = "andy@rossmeissl.net"
+    gem.homepage = "http://github.com/brighterplanet/automobile"
+    gem.authors = ["Andy Rossmeissl", "Seamus Abshere", "Ian Hough", "Matt Kling"]
+    gem.add_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 = "automobile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/automobile.rb

@@ -0,0 +1,202 @@
+module BrighterPlanet
+  module Automobile
+    def self.included(base)
+      base.extend ::Leap::Subject
+      base.decide :emission, :with => :characteristics do
+        committee :emission do # returns kg CO2
+          quorum 'from fuel', :needs => [:fuel_consumed, :emission_factor], :appreciates => :fuel_type do |characteristics|
+            if characteristics[:fuel_type].andand.code == AutomobileFuelType::CODES[:electricity]
+              0.0 # FIXME waiting for fuel_efficiency values in kilometres per kWh from fuel_efficiency
+            else
+              characteristics[:fuel_consumed] * characteristics[:emission_factor]
+            end
+          end
+          
+          quorum 'default' do
+            raise "The emission committee's default quorum should never be called"
+          end
+        end
+    
+        committee :emission_factor do # returns kilograms CO2 per litre **OR** kilograms CO2 per litre
+          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
+            characteristics[:fuel_type].emission_factor
+          end
+    
+          quorum 'default' do
+            AutomobileFuelType.fallback.emission_factor
+          end
+        end
+        
+        committee :fuel_consumed do # returns litres
+          quorum 'from adjusted fuel_efficiency and distance', :needs => [:adjusted_fuel_efficiency, :distance] do |characteristics|
+            characteristics[:distance] / characteristics[:adjusted_fuel_efficiency]
+          end
+        end
+        
+        committee :distance do # returns kilometres
+          quorum 'from annual distance', :needs => [:annual_distance, :active_subtimeframe] do |characteristics, timeframe|
+            characteristics[:annual_distance] * (characteristics[:active_subtimeframe] / timeframe.year)
+          end
+        end
+        
+        committee :annual_distance do # returns kilometres
+          quorum 'from annual distance estimate', :needs => :annual_distance_estimate do |characteristics|
+            characteristics[:annual_distance_estimate]
+          end
+    
+          quorum 'from weekly distance estimate', :needs => :weekly_distance_estimate do |characteristics, timeframe|
+            (characteristics[:weekly_distance_estimate] / 7 ) * timeframe.year.days
+          end
+          
+          quorum 'from daily distance', :needs => :daily_distance do |characteristics, timeframe|
+            characteristics[:daily_distance] * timeframe.year.days
+          end
+          
+          quorum 'from size class', :needs => :size_class do |characteristics|
+            characteristics[:size_class].annual_distance
+          end
+    
+          quorum 'from fuel type', :needs => :fuel_type do |characteristics|
+            characteristics[:fuel_type].annual_distance
+          end
+          
+          quorum 'default' do
+            ::Automobile.fallback.annual_distance_estimate
+          end
+        end
+        
+        committee :daily_distance do # returns kilometres
+          quorum 'from daily distance estimate', :needs => :daily_distance_estimate do |characteristics|
+            characteristics[:daily_distance_estimate]
+          end
+          
+          quorum 'from daily duration', :needs => [:daily_duration, :speed] do |characteristics|
+            characteristics[:daily_duration] * characteristics[:speed]
+          end
+        end
+        
+        committee :adjusted_fuel_efficiency do # returns kilometres per litre
+          quorum 'from fuel efficiency', :needs => :fuel_efficiency do |characteristics|
+            characteristics[:fuel_efficiency]
+          end
+    
+          quorum 'from variant', :needs => [:variant, :urbanity] do |characteristics|
+            fuel_efficiencies = characteristics[:variant].attributes.symbolize_keys.slice(:fuel_efficiency_city, :fuel_efficiency_highway)
+            urbanity = characteristics[:urbanity]
+            1.0 / ((urbanity / fuel_efficiencies[:fuel_efficiency_city].to_f) + ((1.0 - urbanity) / fuel_efficiencies[:fuel_efficiency_highway].to_f))
+          end
+          
+          quorum 'from nominal fuel efficiency and multiplier', :needs => [:nominal_fuel_efficiency, :fuel_efficiency_multiplier] do |characteristics|
+            characteristics[:nominal_fuel_efficiency] * characteristics[:fuel_efficiency_multiplier]
+          end
+        end
+        
+        committee :fuel_efficiency_multiplier do # returns coefficient
+          quorum 'from_size_class_and_hybridity', :needs => [:size_class, :hybridity, :urbanity] do |characteristics|
+            drivetrain = characteristics[:hybridity] ? :hybrid : :conventional
+            urbanity = characteristics[:urbanity]
+            size_class = characteristics[:size_class]
+            fuel_efficiency_multipliers = {
+              :city => size_class.send(:"#{drivetrain}_fuel_efficiency_city_multiplier"),
+              :highway => size_class.send(:"#{drivetrain}_fuel_efficiency_highway_multiplier")
+            }
+            if fuel_efficiency_multipliers.values.any?(&:nil?)
+              nil
+            else
+              1.0 / ((urbanity / fuel_efficiency_multipliers[:city]) + ((1.0 - urbanity) / fuel_efficiency_multipliers[:highway]))
+            end
+          end
+          
+          quorum 'from hybridity', :needs => [:hybridity, :urbanity] do |characteristics|
+            drivetrain = characteristics[:hybridity] ? :hybrid : :conventional
+            urbanity = characteristics[:urbanity]
+            fuel_efficiency_multipliers = {
+              :city => AutomobileSizeClass.fallback.send(:"#{drivetrain}_fuel_efficiency_city_multiplier"),
+              :highway => AutomobileSizeClass.fallback.send(:"#{drivetrain}_fuel_efficiency_highway_multiplier")
+            }
+            1.0 / ((urbanity / fuel_efficiency_multipliers[:city]) + ((1.0 - urbanity) / fuel_efficiency_multipliers[:highway]))
+          end
+          
+          quorum 'default' do
+            1.0
+          end
+        end
+        
+        committee :nominal_fuel_efficiency do # returns kilometres per litre **OR** (FIXME) kilometres per kWh
+          quorum 'from model', :needs => [:model, :urbanity] do |characteristics|
+            fuel_efficiency_city = characteristics[:model].fuel_efficiency_city.to_f
+            fuel_efficiency_highway = characteristics[:model].fuel_efficiency_highway.to_f
+            urbanity = characteristics[:urbanity]
+            1.0 / ((urbanity / fuel_efficiency_city) + ((1.0 - urbanity) / fuel_efficiency_highway))
+          end
+    
+          quorum 'from make and model year', :needs => [:model_year] do |characteristics|
+            characteristics[:model_year].make_year.andand.fuel_efficiency
+          end
+    
+          quorum 'from size class', :needs => [:size_class, :urbanity] do |characteristics|
+            fuel_efficiencies = characteristics[:size_class].attributes.symbolize_keys.slice(:fuel_efficiency_city, :fuel_efficiency_highway)
+            urbanity = characteristics[:urbanity]
+            1.0 / ((urbanity / fuel_efficiencies[:fuel_efficiency_city].to_f) + ((1.0 - urbanity) / fuel_efficiencies[:fuel_efficiency_highway].to_f))
+          end
+    
+          quorum 'from model year', :needs => :model_year do |characteristics|
+            characteristics[:model_year].fuel_efficiency
+          end
+         
+          quorum 'from make', :needs => :make do |characteristics|
+            characteristics[:make].fuel_efficiency
+          end
+         
+          quorum 'default' do
+            ::Automobile.fallback.fuel_efficiency
+          end
+        end
+        
+        committee :speed do # returns kilometres per hour
+          quorum 'from urbanity', :needs => :urbanity do |characteristics|
+            1 / (characteristics[:urbanity] / ::Automobile::RESEARCH[:city_speed] + (1 - characteristics[:urbanity]) / ::Automobile::RESEARCH[:highway_speed]) 
+          end
+        end
+        
+        committee :urbanity do
+          quorum 'default' do
+            ::Automobile.fallback.urbanity
+          end
+        end
+        
+        committee :fuel_type do
+          quorum 'from variant', :needs => :variant do |characteristics|
+            characteristics[:variant].fuel_type
+          end
+    
+          quorum 'default' do
+            ::Automobile.fallback.fuel_type
+          end
+        end
+        
+        committee :active_subtimeframe do
+          quorum 'from acquisition and retirement', :needs => [:acquisition, :retirement] do |characteristics, timeframe|
+            Timeframe.constrained_new characteristics[:acquisition].to_date, characteristics[:retirement].to_date, timeframe
+          end
+        end
+        
+        committee :acquisition do
+          quorum 'from model year or year', :appreciates => [:model_year, :year] do |characteristics|
+            !characteristics.empty? && Date.new((characteristics[:model_year].andand.year || characteristics[:year]).to_i - 1, 1, 1)
+          end
+          quorum 'from retirement', :appreciates => :retirement do |characteristics, timeframe|
+            [ timeframe.from, characteristics[:retirement] ].compact.min
+          end
+        end
+        
+        committee :retirement do
+          quorum 'from acquisition', :appreciates => :acquisition do |characteristics, timeframe|
+            [ timeframe.to, characteristics[:acquisition] ].compact.max
+          end
+        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 'automobile'
+
+class Test::Unit::TestCase
+end

data/test/test_automobile.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestAutomobile < 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: automobile
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Andy Rossmeissl
+- Seamus Abshere
+- Ian Hough
+- Matt Kling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-10 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: :runtime
+  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 an automobile
+email: andy@rossmeissl.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/automobile.rb
+- test/helper.rb
+- test/test_automobile.rb
+has_rdoc: true
+homepage: http://github.com/brighterplanet/automobile
+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_automobile.rb