koeppen_geiger 0.0.1 → 0.0.2

data/Manifest

@@ -15,7 +15,3 @@ lib/koeppen_geiger/utils.rb
 lib/locales/de.yml
 lib/locales/en.yml
 lib/tasks/koeppen_geiger.rake
-test/test_helper.rb
-test/unit/climate_classification_test.rb
-test/unit/pg_climate_classification_test.rb
-test/unit/utils_test.rb

data/README.rdoc

@@ -1,6 +1,9 @@
 = KoeppenGeiger
 
-This gem adds a climate classification parameter to a location object based upon observed or predicted climate data
+This gem adds a climate classification parameter to a location object based upon observed or predicted climate data.
+
+Read more about the Köppen-Geiger climate classification system at:
+http://en.wikipedia.org/wiki/K%C3%B6ppen_climate_classification
 
 == Installation
 
@@ -40,10 +43,10 @@ http://www.postgis.org/documentation/manual-1.5/ch02.html#id2630392
   location = Location.find(1)
   location.classify
 	
-  location.classified(:observed,1901,1925)
+  location.classified(:observed,1901)
   => "Am"
   
-  location.classified(:observed,1901,1925).to_words
+  location.classified("a2",2015).to_words
   => "Equatorial monsoon"
 
 == Data

data/Rakefile

@@ -2,15 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('koeppen_geiger', '0.0.1') do |p|
+Echoe.new('koeppen_geiger', '0.0.2') do |p|
   p.summary        = "A Climate Classification Gem for ActiveRecord"
   p.description    = "A gem that adds a climate classification parameter based upon the Koeppen-Geiger climate classification system to a point location"
   p.url            = "http://github.com/tpunkt/koeppen_geiger"
   p.author         = "Tobias Weiss"
   p.email          = "tobias.weiss@gmail.com"
-  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.ignore_pattern = FileList[".gitignore"]
   p.development_dependencies = []
-end
-
-# Load rake files used with this gem
-# Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }
+  p.test_pattern    = []
+end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/koeppen_geiger.gemspec

@@ -2,25 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{koeppen_geiger}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Weiss"]
-  s.date = %q{2011-03-23}
+  s.date = %q{2011-04-08}
   s.description = %q{A gem that adds a climate classification parameter based upon the Koeppen-Geiger climate classification system to a point location}
   s.email = %q{tobias.weiss@gmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/koeppen_geiger.rb", "lib/koeppen_geiger/climate_classification.rb", "lib/koeppen_geiger/has_climate_classification.rb", "lib/koeppen_geiger/pg_climate_classification.rb", "lib/koeppen_geiger/utils.rb", "lib/locales/de.yml", "lib/locales/en.yml", "lib/tasks/koeppen_geiger.rake"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "VERSION", "data/koeppen-geiger.zip", "generators/koeppen_geiger_generator.rb", "generators/templates/migration.rb", "lib/koeppen_geiger.rb", "lib/koeppen_geiger/climate_classification.rb", "lib/koeppen_geiger/has_climate_classification.rb", "lib/koeppen_geiger/pg_climate_classification.rb", "lib/koeppen_geiger/utils.rb", "lib/locales/de.yml", "lib/locales/en.yml", "lib/tasks/koeppen_geiger.rake", "test/test_helper.rb", "test/unit/climate_classification_test.rb", "test/unit/pg_climate_classification_test.rb", "test/unit/utils_test.rb", "koeppen_geiger.gemspec"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "VERSION", "data/koeppen-geiger.zip", "generators/koeppen_geiger_generator.rb", "generators/templates/migration.rb", "lib/koeppen_geiger.rb", "lib/koeppen_geiger/climate_classification.rb", "lib/koeppen_geiger/has_climate_classification.rb", "lib/koeppen_geiger/pg_climate_classification.rb", "lib/koeppen_geiger/utils.rb", "lib/locales/de.yml", "lib/locales/en.yml", "lib/tasks/koeppen_geiger.rake", "koeppen_geiger.gemspec"]
   s.homepage = %q{http://github.com/tpunkt/koeppen_geiger}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Koeppen_geiger", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{koeppen_geiger}
   s.rubygems_version = %q{1.6.2}
   s.summary = %q{A Climate Classification Gem for ActiveRecord}
-  s.test_files = ["test/test_helper.rb", "test/unit/climate_classification_test.rb", "test/unit/pg_climate_classification_test.rb", "test/unit/utils_test.rb"]
-  s.signing_key = '/Users/tweiss/Documents/#private_keys/gem-private_key.pem'
-  s.cert_chain  = ['gem-public_cert.pem']
-  
+
   if s.respond_to? :specification_version then
     s.specification_version = 3
 

data/lib/koeppen_geiger/climate_classification.rb

@@ -1,11 +1,5 @@
 module KoeppenGeiger
   
-  # 1. Has a table in the RDBMS of the Rails App
-  # 2. Copy migration from lib/migrate/template.rb to RAILS_ROOT/db/migrate
-  # 3. Create table via rake db:migrate
-  # 5. Defines a method thats grabs climate classifications from PostgreSQL and store it in RDBMS after creation
-  # 6. Defines methods to get climate classification for a "scenario" and "time period"
-  
   class ClimateClassification < ActiveRecord::Base
     
     CLIMATE_ZONES = {"11" => "Af","12" => "Am","13" => "As","14" => "Aw",
@@ -17,6 +11,15 @@ module KoeppenGeiger
                      "48" => "Dsd","49" => "Dwa","50" => "Dwb","51" => "Dwc",
                      "52" => "Dwd","61" => "EF","62" => "ET" }
                      
+    TIME_RANGES = { "observed" => [1901..1925,1926..1950,1951..1975,1976..2000],
+                    "a1f1" => [2001..2025,2026..2050,2051..2075,2076..2100],
+                    "a2" => [2001..2025,2026..2050,2051..2075,2076..2100], 
+                    "b1" => [2001..2025,2026..2050,2051..2075,2076..2100],
+                    "b2" => [2001..2025,2026..2050,2051..2075,2076..2100]}
+    
+    SCENARIOS = ["observed","a1f1","a2","b1","b2"]
+    
+    
     def self.create_column_name(*args)
       args.join("_")
     end
@@ -24,6 +27,20 @@ module KoeppenGeiger
     def self.climate_zone_to_words(str)
       I18n.t(str.downcase.to_sym, :scope => [:climate_zones])
     end
+    
+    def self.determine_time_range(scenario,year)
+      return nil unless KoeppenGeiger::ClimateClassification.valid_scenario?(scenario)
+      
+      TIME_RANGES[scenario].each do |timerange|
+        return timerange if timerange.member?(year.to_i)
+      end
+      
+      nil
+    end
+    
+    def self.valid_scenario?(scenario)
+      SCENARIOS.include?(scenario)
+    end
   
   end
 

data/lib/koeppen_geiger/has_climate_classification.rb

@@ -1,6 +1,6 @@
 module KoeppenGeiger
   
-  # Can be mixed into any ActiveRecord class that has lat/lng columns
+  # Can be mixed into a ActiveRecord class that has lat/lng columns
   # 
   # Example:
   #   class Location < ActiveRecord::Base
@@ -9,9 +9,9 @@ module KoeppenGeiger
   #   end
   #
   # location = Location.find(1)
-  # location.climate_classification("observed",1901,1925)
+  # location.climate_classification("observed",1901)
   # => "Cfa"
-  # location.climate_classification("observed",1901,1925).to_words
+  # location.climate_classification("a2",2025).to_words
   # => "Equatorial climate, fully humid, hot summer"
   #
   # Declares a 1:1 association to the model when embedding has_climate_classification
@@ -23,8 +23,11 @@ module KoeppenGeiger
       @@options = options
       
       class_eval do
-        has_one :climate_classification, :class_name => "KoeppenGeiger::ClimateClassification", :foreign_key => "classified_id"
+        has_one :climate_classification, :class_name => "KoeppenGeiger::ClimateClassification", :foreign_key => "classified_id", :dependent => :destroy
         
+        #
+        # Adds available climate classifications to a location
+        #
         def classify
           unless @@options[:lat_column_name].nil? || @@options[:lng_column_name].nil?
             self[:lat] = self[@@options[:lat_column_name].to_sym] || self[:lat]
@@ -34,15 +37,32 @@ module KoeppenGeiger
           if self.has_coordinates?
             self.climate_classification = KoeppenGeiger::ClimateClassification.new if self.climate_classification.nil?
             pg_cc = KoeppenGeiger::PgClimateClassification.new
-            self.climate_classification.attributes = pg_cc.get_climate_zones(self[:lat],self[:lng])
+            gridcodes = pg_cc.get_climate_zones(self[:lat],self[:lng])
+            
+            # Delete instance to reconnect to former rails db
+            pg_cc.delete
+            
+            self.climate_classification.attributes = gridcodes
             self.climate_classification.save
           else
-            "Object cannot be classified. Please specify correct column names and make sure your location has correct coordinates."
+            puts "Object cannot be classified. Please specify correct column names and make sure your location has correct coordinates."
           end
         end
         
-        def classified(scenario,from,to)
-          self.climate_classification[KoeppenGeiger::ClimateClassification.create_column_name(scenario,from,to).to_sym] || "Scenario and/or time period not found"
+        # Returns a classification code for a certain scenario and year
+        # 
+        # Example:
+        # location.classified("observed",1905)
+        #
+        def classified(scenario,year)
+          timerange = KoeppenGeiger::ClimateClassification.determine_time_range(scenario,year)
+          
+          unless timerange.nil?
+            column_name = KoeppenGeiger::ClimateClassification.create_column_name(scenario,timerange.first.to_s,timerange.last.to_s).to_sym
+            return self.climate_classification[column_name] || "No value found"
+          else
+            return "No data found within the year #{year} in the scenario #{scenario}"
+          end
         end
         
         def has_coordinates?

data/lib/koeppen_geiger/pg_climate_classification.rb

@@ -7,8 +7,7 @@ module KoeppenGeiger
   # http://snipplr.com/view/1849/tableless-model/
   
   class PgClimateClassification < ActiveRecord::Base
-    establish_connection "koeppen_geiger"
-    
+          
     def self.columns 
       @columns ||= []
     end
@@ -20,6 +19,14 @@ module KoeppenGeiger
     ##########################
     
     def initialize
+      begin
+        ActiveRecord::Base.establish_connection "koeppen_geiger"
+      rescue ActiveRecord::ConnectionNotEstablished
+        puts "Connection could not be established"
+      rescue ActiveRecord::AdapterNotSpecified
+        puts "Oops! Adapter not specified. This is okay when running rake:test"
+      end
+      
       get_scenario_tables
     end
     
@@ -27,17 +34,18 @@ module KoeppenGeiger
     # Get all tables from database to see how many different scenarios and timeperiods
     # have been imported
     #
-    # Each shapefile imported into the database should create a new table
+    # Each shapefile imported into the database creates a new table
     #
     def get_scenario_tables
       res = self.connection.execute(  "SELECT table_name FROM information_schema.tables 
-                                                    WHERE table_schema = 'public' 
-                                                    AND table_name != 'geometry_columns'
-                                                    AND table_name != 'spatial_ref_sys'")
+                                      WHERE table_schema = 'public' 
+                                      AND table_name != 'geometry_columns'
+                                      AND table_name != 'spatial_ref_sys'")
       @scenarios = []
       if res.num_tuples >= 1
         res.each do |tuple|
-          @scenarios << tuple["table_name"]
+          # The unless statement is only needed for testing purposes
+          @scenarios << tuple["table_name"] unless tuple["table_name"].eql?("locations")
         end
       else
         puts "No data imported yet. Please run rake koeppen_geiger:db:import_data"
@@ -52,10 +60,18 @@ module KoeppenGeiger
           gridcodes[scenario] = KoeppenGeiger::ClimateClassification::CLIMATE_ZONES[res.getvalue(0,0).to_s]
         end
       end
-        
+      
       return gridcodes
     end
     
+    #
+    # Reconnect to former database when instance is deleted
+    # otherwise the rails app starts operating on the wrong db
+    #
+    def delete
+      ActiveRecord::Base.establish_connection RAILS_ENV
+    end
+    
   end
   
 end

data/lib/koeppen_geiger/utils.rb

@@ -4,20 +4,6 @@ module KoeppenGeiger
   require 'zip/zip'
   require 'fileutils'
   
-  # Steps
-  #
-  # 1. Add default configuration for koeppen_geiger to database.yml
-  #
-  # 2. Copy migration to create climate classifications table
-  #
-  # 3. run rake db:migrate [RAILS_ENV]
-  #
-  # 4. Create a spatially-enabled database in PostgreSQL
-  # http://postgis.org/documentation/manual-1.5/ch02.html#id2630392
-  #
-  # 5. Load GIS data via shp2pgsql into PostgreSQL database
-  # http://postgis.org/documentation/manual-1.5/ch04.html#shp2pgsql_usage
-  
   class Utils
     
     @@rails_root = defined?(RAILS_ROOT) ? RAILS_ROOT : ""
@@ -45,26 +31,26 @@ module KoeppenGeiger
       
       # Open database.yml and add config lines
       def configure_db
-        yaml = Utils.get_db_config
-        yaml = Hash.new unless yaml
+        begin
+          yaml = Utils.get_db_config
+          yaml = Hash.new unless yaml
 
-        unless yaml.has_key?("koeppen_geiger")
-          yaml.update(KoeppenGeiger::Utils::DEFAULT_CONFIG)
-          File.open(KoeppenGeiger::Utils::DB_CONFIG, 'w') do |out|
-            YAML::dump(yaml,out)
+          unless yaml.has_key?("koeppen_geiger")
+            yaml.update(KoeppenGeiger::Utils::DEFAULT_CONFIG)
+            File.open(KoeppenGeiger::Utils::DB_CONFIG, 'w') do |out|
+              YAML::dump(yaml,out)
+            end
+            puts ">> Updated database.yml. Please enter correct username/password combination."
+          else
+            puts ">> Your database.yml has already been updated"
           end
-          puts ">> Updated database.yml. Please enter correct username/password combination."
-        else
-          puts ">> Your database.yml has already been updated"
+        rescue Errno::ENOENT
+          raise StandardError, "Could not find database configuration file"
         end
       end
 
       def get_db_config
-        begin
-          YAML::load_file(KoeppenGeiger::Utils::DB_CONFIG)
-        rescue IOError
-          puts "Could not find database configuration file"
-        end          
+        YAML::load_file(KoeppenGeiger::Utils::DB_CONFIG)         
       end
 
       ########
@@ -98,6 +84,7 @@ module KoeppenGeiger
         filehash
       end
       
+      # Extract compressed ziop data
       def extract_gis_data
         if File.exists?(KoeppenGeiger::Utils::ARCHIVE)  
           begin

data/lib/koeppen_geiger.rb

@@ -1,3 +1,26 @@
+# encoding: utf-8
+#--
+# Copyright (c) 2011 Tobias Weiss <tobias.weiss@gmail.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.
+#++
+
 require 'rubygems'
 require 'active_record'
 require 'active_support'

metadata

@@ -1,42 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: koeppen_geiger
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Tobias Weiss
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDOjCCAiKgAwIBAgIBADANBgkqhkiG9w0BAQUFADBDMRUwEwYDVQQDDAx0b2Jp
-  YXMud2Vpc3MxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
-  A2NvbTAeFw0xMTAzMjMxMzQ1NDZaFw0xMjAzMjIxMzQ1NDZaMEMxFTATBgNVBAMM
-  DHRvYmlhcy53ZWlzczEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
-  LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAl5YA7OBO
-  /oeOJIdLoGig5D/O2o9vaqizuVisG0W0Br88A5zLCoSC1KAZ6Wdtl3NqqN4CBJ2J
-  zeA82X1b25FjkxHMFBTGhcqBz9ubInX37myHsTq+BzejLakkYlxnpSyAvtYCYJBv
-  nk897vzgNugJUSpQK7p0NfsDA9Utku7ZyuOZ/sQJhZju2GhkNN4h5xMLYiaVdSPu
-  gRPv3d7U/T8ynK01TihhmSMPVjJJXBwxTkgm2pnN4Vt27OgI3qYSNa1LWSMMkste
-  VFKv0vbZmMT1P4WHAGLyIueyMPISwG0RBV2ki3zLd2PkO/8HVKb4MEuZ6ow6GTqf
-  aIgGM+zMvQtpfQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
-  HQ4EFgQUglZplVwHjFDAGwgV1sNwgZvE1sAwDQYJKoZIhvcNAQEFBQADggEBAH/X
-  p6YgH9u+hI5Y6GP4apDwp6/5mTDrHi32URkK4DR+EYev9+7B5UhJirkRr+HwJkZq
-  s2t7bbeCP2Da6Q2fLIzHyapMSpxHXVsiEADDSOZu7a7IwWNie76+8A0bJLoglrI6
-  X5Z0+aLxpj9qLKvhseewhJ8ckUVWViLdIkw56Xco5BSPxI6SEtA9OkEY7hw/Tp7B
-  jzmvl/O54R4hAX2l/2+6TnBNKqk30Rcv4x6bHooTjF0/vs4qvuo9UwVxa+ZQ/xu1
-  RReLEXx35Rm+lRHb5X6nUkC80H2Y3FUBiykkPyJdURmVas5wQ0EwW1l/KEyXDoNY
-  ZHSsbf0Us43IP9I3KVo=
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2011-03-23 00:00:00 +01:00
+date: 2011-04-08 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -76,10 +55,6 @@ files:
 - lib/locales/de.yml
 - lib/locales/en.yml
 - lib/tasks/koeppen_geiger.rake
-- test/test_helper.rb
-- test/unit/climate_classification_test.rb
-- test/unit/pg_climate_classification_test.rb
-- test/unit/utils_test.rb
 - koeppen_geiger.gemspec
 has_rdoc: true
 homepage: http://github.com/tpunkt/koeppen_geiger
@@ -121,8 +96,5 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A Climate Classification Gem for ActiveRecord
-test_files: 
-- test/test_helper.rb
-- test/unit/climate_classification_test.rb
-- test/unit/pg_climate_classification_test.rb
-- test/unit/utils_test.rb
+test_files: []
+

data/test/test_helper.rb

@@ -1,5 +0,0 @@
-require 'rubygems'
-require 'yaml'
-require 'active_record'
-require 'shoulda'
-require 'lib/koeppen_geiger'

data/test/unit/climate_classification_test.rb

@@ -1,5 +0,0 @@
-require 'test/test_helper'
-
-class ClimateClassificationTest < Test::Unit::TestCase
-  
-end

data/test/unit/pg_climate_classification_test.rb

@@ -1,5 +0,0 @@
-require 'test/test_helper'
-
-class PgClimateClassificationTest < Test::Unit::TestCase
-  
-end

data/test/unit/utils_test.rb

@@ -1,5 +0,0 @@
-require 'test/test_helper'
-
-class UtilsTest < Test::Unit::TestCase
-  
-end

data.tar.gz.sig

@@ -1,2 +0,0 @@
-Qc���:�9k��ܰ��RQ��s�W
-O$��ծ �gG������ˎB
r�|!�8��ŭ�d�f�5��b[)��8���,l���풛bDNJ�_�ͧ�s��-�$	%

metadata.gz.sig

@@ -1 +0,0 @@
-s��n