emitter 0.11.2 → 0.12.1

data/Gemfile

@@ -2,14 +2,6 @@ source :rubygems
 
 gemspec
 
-gem 'sniff', :path => ENV['LOCAL_SNIFF'] if ENV['LOCAL_SNIFF']
-gem 'data_miner', :path => ENV['LOCAL_DATA_MINER'] if ENV['LOCAL_DATA_MINER']
-gem 'earth', :path => ENV['LOCAL_EARTH'] if ENV['LOCAL_EARTH']
-
-gem 'activerecord', '~>3'
-gem 'bueller'
-gem 'sniff', '>=0.11.0' unless ENV['LOCAL_SNIFF']
-
 if RUBY_VERSION < "1.9"
   gem 'fastercsv'
 end

data/README.markdown

@@ -0,0 +1,50 @@
+# emitter
+
+Base module for Brighter Planet's emitters. See the [Brighter Planet developer page](http://brighterplanet.github.com) for details on Brighter Planet's development environment.
+
+## Installation
+
+    $ gem install emitter
+
+## Usage
+
+    # my_emitter.rb
+    require 'emitter'
+    
+    class MyEmitter
+      include BrighterPlanet::Emitter
+    end
+
+### Required modules
+
+Your emitter must define some modules under `lib/my_emitter/`, they are:
+* `lib/my_emitter/impact_model.rb` - `module MyEmitter::ImpactModel` - defines the [Leap](http://rubygems.org/gems/leap) decisions that calculate an impact.
+* `lib/my_emitter/characterization.rb` - `module MyEmitter::Characterization` - defines the [Characteristics](http://rubygems.org/gems/charisma) that describe the model's inputs.
+* `lib/my_emitter/data.rb` - `module MyEmitter::Data` - defines the [schema](http://rubygems.org/gems/mini\_record) definitions for the emitter and [DataMiner](http://rubygems.org/gems/data\_miner) processes that fetch and store data for the emitter.
+* `lib/my_emitter/relationships.rb` - `module MyEmitter::Relationships` - defines the ActiveRecord relationships between the emitter and other [Earth](http://rubygems.org/gems/earth) models.
+* `lib/my_emitter/summarization.rb` - `moduel MyEmitter::Summarization` - defines phrases that describe various attributes ([SummaryJudgement descriptors](http://rubygems.org/gems/summary\_judgement)) about an emitter that are displayed on CM1's methodology pages.
+
+## Tools
+
+You can use the [bp gem](http://github.com/brighterplanet/bp) to generate the skeleton for a new emitter.
+
+## Magic
+
+Emitter, once included, will perform a couple tasks automatically:
+
+1. It converts committees into characterizations that are not already characterized.
+1. It adds `auto_upgrade!` and `run_data_miner_on_parent_associations!` tasks to DataMiner so that a call to `MyEmitter.run_data_miner!` will update the emitter's schema and run DataMiner tasks on any belongs\_to associations.
+
+## 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 2010, 2011 Brighter Planet, Inc. See LICENSE and LICENSE-PREAMBLE for details.

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 
 require 'bueller'

data/emitter.gemspec

@@ -15,14 +15,17 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency 'active_record_inline_schema'
   s.add_dependency 'activesupport', '>=2.3.10'
   s.add_dependency 'charisma'
   s.add_dependency 'data_miner', '>=2' unless ENV['LOCAL_DATA_MINER']
-  s.add_dependency 'earth', '>=0.5.1' unless ENV['LOCAL_EARTH']
   s.add_dependency 'falls_back_on'
   s.add_dependency 'leap', '>=0.5.4'
   s.add_dependency 'summary_judgement'
   s.add_dependency 'timeframe'
   s.add_dependency 'weighted_average'
-  s.add_dependency 'active_record_inline_schema'
+
+  s.add_development_dependency 'activerecord', '~>3'
+  s.add_development_dependency 'bueller'
+  s.add_development_dependency 'sniff'
 end

data/lib/emitter.rb

@@ -1,11 +1,10 @@
+require 'active_record_inline_schema'
 require 'active_support'
 require 'active_support/core_ext'
-require 'leap'
 require 'charisma'
-require 'data_miner'
-require 'summary_judgement'
 require 'falls_back_on'
-require 'active_record_inline_schema'
+require 'leap'
+require 'summary_judgement'
 
 require 'emitter/measurement'
 
@@ -18,6 +17,13 @@ module BrighterPlanet
       relationships
       summarization
     }
+
+    def self.extended(target)
+      common_name = target.name.demodulize.underscore
+      REQUIRED_COMPONENTS.each do |component|
+        require "#{common_name}/#{component}"
+      end
+    end
     
     # "included" not "self.included"
     # why?
@@ -31,10 +37,6 @@ module BrighterPlanet
       # here self is the emitter module
       common_name = self.name.demodulize.underscore
       common_camel = common_name.camelcase
-
-      REQUIRED_COMPONENTS.each do |component|
-        require "#{common_name}/#{component}"
-      end
       
       base.instance_variable_set :@impact_scope, @impact_scope if @impact_scope
       
@@ -82,6 +84,10 @@ module BrighterPlanet
       def impact_scope
         @impact_scope
       end
+
+      def emitter
+        name.demodulize
+      end
     end
   end
 end

data/lib/emitter/version.rb

@@ -1,3 +1,3 @@
 module Emitter
-  VERSION = "0.11.2"
+  VERSION = "0.12.1"
 end

data/spec/emitter_spec.rb

@@ -29,12 +29,16 @@ describe BrighterPlanet::Emitter do
       expect do
         require 'biplane'
         Aircraft.send :include, BrighterPlanet::Biplane
-      end.should_not raise_error
+      end.not_to raise_error
     end
     
     it 'should state its own scope' do
       Airship.impact_scope.should == 'Anthropogenic impacts resulting from the inflation, launching, and acceleration of dirigibles'
     end
+
+    it 'should state its emitter name' do
+      Airship.emitter.should == 'Airship'
+    end
     
     it 'should have extra data_miner steps' do
       Airship.data_miner_script.steps[0].description.should == :auto_upgrade!

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
-require 'rubygems'
 require 'bundler/setup'
 require 'sniff'
-Sniff.init File.join(File.dirname(__FILE__), '..', '..')
+Sniff.init File.expand_path('../..', __FILE__)
 
 require 'emitter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emitter
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,27 +13,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-08-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  name: active_record_inline_schema
+  requirement: &2166533340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.10
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *2166533340
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2166532720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *2166532720
 - !ruby/object:Gem::Dependency
   name: charisma
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166532140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -41,15 +47,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2166532140
 - !ruby/object:Gem::Dependency
   name: data_miner
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166531300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,31 +58,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: earth
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.1
+  version_requirements: *2166531300
 - !ruby/object:Gem::Dependency
   name: falls_back_on
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166530760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,15 +69,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2166530760
 - !ruby/object:Gem::Dependency
   name: leap
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166530020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -105,15 +80,10 @@ dependencies:
         version: 0.5.4
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.5.4
+  version_requirements: *2166530020
 - !ruby/object:Gem::Dependency
   name: summary_judgement
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166529420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,15 +91,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2166529420
 - !ruby/object:Gem::Dependency
   name: timeframe
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166528860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -137,15 +102,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2166528860
 - !ruby/object:Gem::Dependency
   name: weighted_average
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2166528240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,28 +113,40 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *2166528240
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2166527600 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: *2166527600
 - !ruby/object:Gem::Dependency
-  name: active_record_inline_schema
-  requirement: !ruby/object:Gem::Requirement
+  name: bueller
+  requirement: &2166527140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *2166527140
+- !ruby/object:Gem::Dependency
+  name: sniff
+  requirement: &2166526400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2166526400
 description: A framework for modelling the impact of real-world entities.
 email:
 - andy@rossmeissl.net
@@ -191,7 +163,7 @@ files:
 - Gemfile
 - LICENSE
 - LICENSE-PREAMBLE
-- README.rdoc
+- README.markdown
 - Rakefile
 - emitter.gemspec
 - lib/emitter.rb
@@ -224,15 +196,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4363865138047719689
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4363865138047719689
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A framework for modelling the impact of real-world entities.
@@ -252,4 +230,3 @@ test_files:
 - spec/fixtures/dirigible/lib/dirigible/relationships.rb
 - spec/fixtures/dirigible/lib/dirigible/summarization.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/README.rdoc

@@ -1,17 +0,0 @@
-= emitter
-
-Software framework for Brighter Planet's impact modeling libraries. See http://carbon.brighterplanet.com
-
-== 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 2010, 2011 Brighter Planet, Inc. See LICENSE and LICENSE-PREAMBLE for details.