RubyGems - geographer - Versions diffs - 1.0.0 → 1.1.0 - Mend

geographer 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

data/README.rdoc +14 -11
data/VERSION +1 -1
data/geographer.gemspec +1 -1
data/lib/geographer/us/states.rb +97 -91
data/lib/geographer.rb +1 -1
data/test/geographer/us/states_test.rb +6 -0
metadata +1 -1

data/README.rdoc CHANGED Viewed

@@ -29,42 +29,45 @@ Add to environment file:
   config.gem "geographer", :version => '1.0.0', :source => 'http://gemcutter.org'
-You may also want to create an initializer at config/initilaizer/geographer.rb:
+You will need to create classes and include modules in order to use geographer.  You can do this in the lib directory,
+an initializer, etc.:
-  $STATES = Geographer::Us::States
-This will allow you to use $STATES as opposed to Geographer::Us::States when using geographer within your application.
+  class States
+    include Geographer::Us::States
+  end
 == USAGE
+The examples are based on the States class created above.
 For a list (array) of state abbreviations:
-  Geographer::Us::States.abbreviations
+  States.abbreviations
 For a list (array) of state names:
-  Geographer::Us::States.names
+  States.names
 For a list (array) of state abbreviations with US territories:
-  Geographer::Us::States.abbreviations_with_territories
+  States.abbreviations_with_territories
 For a list (array) of state names with US territories:
-  Geographer::Us::States.names_with_territories
+  States.names_with_territories
 For a list (array) of territory abbreviations:
-  Geographer::Us::States.territories_abbreviations
+  States.territories_abbreviations
 For a list (array) of territory names:
-  Geographer::Us::States.territories_names
+  States.territories_names
 To look up the full name from the abbreviation:
-  Geographer::Us::States.abbreviations_name_map['AL'] # returns 'Alabama'
+  States.abbreviations_name_map['AL'] # returns 'Alabama'
 == LICENSE

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 1.0.0
1	+ 1.1.0

data/geographer.gemspec CHANGED Viewed

@@ -5,7 +5,7 @@
 Gem::Specification.new do |s|
   s.name = %q{geographer}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["C. Jason Harrelson (midas)"]

data/lib/geographer/us/states.rb CHANGED Viewed

@@ -4,105 +4,111 @@ module Geographer
     # Provides a list of US States abbreviations (with and without territories), names and a map of
     # abbreviations to names.
     #
-    class States
+    module States
-      # A list of abbreviatons of US States and territories.
-      #
-      def self.abbreviations
-        self.abbreviations_with_territories - self.territories_abbreviations
+      def self.included( base )
+        base.extend( ClassMethods )
       end
+      module ClassMethods
+        # A list of abbreviatons of US States and territories.
+        #
+        def abbreviations
+          self.abbreviations_with_territories - self.territories_abbreviations
+        end
-      # A list of names of US States only (no territories).
-      #
-      def self.names
-        self.names_with_territories - self.territories_names
-      end
+        # A list of names of US States only (no territories).
+        #
+        def names
+          self.names_with_territories - self.territories_names
+        end
-      # A list of abbreviatons of US States and territories.
-      #
-      def self.abbreviations_with_territories
-        self.abbreviations_name_map.keys.sort
-      end
+        # A list of abbreviatons of US States and territories.
+        #
+        def abbreviations_with_territories
+          self.abbreviations_name_map.keys.sort
+        end
-      # A list of names of US States and territories.
-      #
-      def self.names_with_territories
-        self.abbreviations_name_map.values.sort
-      end
+        # A list of names of US States and territories.
+        #
+        def names_with_territories
+          self.abbreviations_name_map.values.sort
+        end
-      # A list of abbreviatons of US territories.
-      #
-      def self.territories_abbreviations
-        %w( AS FM GU MH PW PR VI )
-      end
+        # A list of abbreviatons of US territories.
+        #
+        def territories_abbreviations
+          %w( AS FM GU MH PW PR VI )
+        end
-      def self.territories_names
-        [ "American Samoa", "Guam", "Islands", "Micronesia", "Palau", "Puerto Rico", "Virgin Island" ]
-      end
+        def territories_names
+          [ "American Samoa", "Guam", "Islands", "Micronesia", "Palau", "Puerto Rico", "Virgin Island" ]
+        end
-      # An index (map) of US States and territories abbreviations and full names.
-      #
-      def self.abbreviations_name_map
-        {
-        'AL' => 'Alabama',
-        'AK' => 'Alaska',
-        'AS' => 'American Samoa',
-        'AZ' => 'Arizona',
-        'AR' => 'Arkansas',
-        'CA' => 'California',
-        'CO' => 'Colorado',
-        'CT' => 'Connecticut',
-        'DE' => 'Delaware',
-        'DC' => 'District of Columbia',
-        'FM' => 'Micronesia',
-        'FL' => 'Florida',
-        'GA' => 'Georgia',
-        'GU' => 'Guam',
-        'HI' => 'Hawaii',
-        'ID' => 'Idaho',
-        'IL' => 'Illinois',
-        'IN' => 'Indiana',
-        'IA' => 'Iowa',
-        'KS' => 'Kansas',
-        'KY' => 'Kentucky',
-        'LA' => 'Louisiana',
-        'ME' => 'Maine',
-        'MH' => 'Islands',
-        'MD' => 'Maryland',
-        'MA' => 'Massachusetts',
-        'MI' => 'Michigan',
-        'MN' => 'Minnesota',
-        'MS' => 'Mississippi',
-        'MO' => 'Missouri',
-        'MT' => 'Montana',
-        'NE' => 'Nebraska',
-        'NV' => 'Nevada',
-        'NH' => 'New Hampshire',
-        'NJ' => 'New Jersey',
-        'NM' => 'New Mexico',
-        'NY' => 'New York',
-        'NC' => 'North Carolina',
-        'ND' => 'North Dakota',
-        'OH' => 'Ohio',
-        'OK' => 'Oklahoma',
-        'OR' => 'Oregon',
-        'PW' => 'Palau',
-        'PA' => 'Pennsylvania',
-        'PR' => 'Puerto Rico',
-        'RI' => 'Rhode Island',
-        'SC' => 'South Carolina',
-        'SD' => 'South Dakota',
-        'TN' => 'Tennessee',
-        'TX' => 'Texas',
-        'UT' => 'Utah',
-        'VT' => 'Vermont',
-        'VI' => 'Virgin Island',
-        'VA' => 'Virginia',
-        'WA' => 'Washington',
-        'WV' => 'West Virginia',
-        'WI' => 'Wisconsin',
-        'WY' => 'Wyoming'
-        }
+        # An index (map) of US States and territories abbreviations and full names.
+        #
+        def abbreviations_name_map
+          {
+          'AL' => 'Alabama',
+          'AK' => 'Alaska',
+          'AS' => 'American Samoa',
+          'AZ' => 'Arizona',
+          'AR' => 'Arkansas',
+          'CA' => 'California',
+          'CO' => 'Colorado',
+          'CT' => 'Connecticut',
+          'DE' => 'Delaware',
+          'DC' => 'District of Columbia',
+          'FM' => 'Micronesia',
+          'FL' => 'Florida',
+          'GA' => 'Georgia',
+          'GU' => 'Guam',
+          'HI' => 'Hawaii',
+          'ID' => 'Idaho',
+          'IL' => 'Illinois',
+          'IN' => 'Indiana',
+          'IA' => 'Iowa',
+          'KS' => 'Kansas',
+          'KY' => 'Kentucky',
+          'LA' => 'Louisiana',
+          'ME' => 'Maine',
+          'MH' => 'Islands',
+          'MD' => 'Maryland',
+          'MA' => 'Massachusetts',
+          'MI' => 'Michigan',
+          'MN' => 'Minnesota',
+          'MS' => 'Mississippi',
+          'MO' => 'Missouri',
+          'MT' => 'Montana',
+          'NE' => 'Nebraska',
+          'NV' => 'Nevada',
+          'NH' => 'New Hampshire',
+          'NJ' => 'New Jersey',
+          'NM' => 'New Mexico',
+          'NY' => 'New York',
+          'NC' => 'North Carolina',
+          'ND' => 'North Dakota',
+          'OH' => 'Ohio',
+          'OK' => 'Oklahoma',
+          'OR' => 'Oregon',
+          'PW' => 'Palau',
+          'PA' => 'Pennsylvania',
+          'PR' => 'Puerto Rico',
+          'RI' => 'Rhode Island',
+          'SC' => 'South Carolina',
+          'SD' => 'South Dakota',
+          'TN' => 'Tennessee',
+          'TX' => 'Texas',
+          'UT' => 'Utah',
+          'VT' => 'Vermont',
+          'VI' => 'Virgin Island',
+          'VA' => 'Virginia',
+          'WA' => 'Washington',
+          'WV' => 'West Virginia',
+          'WI' => 'Wisconsin',
+          'WY' => 'Wyoming'
+          }
+        end
       end
     end
   end

data/lib/geographer.rb CHANGED Viewed

@@ -4,5 +4,5 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'geographer/us/states'
 module Geographer
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/geographer/us/states_test.rb CHANGED Viewed

@@ -2,6 +2,12 @@ require 'test_helper'
 class StatesTest < Test::Unit::TestCase
   context "states" do
+    setup do
+      class States
+        include Geographer::Us::States
+      end
+    end
     context "abbreviations" do
       setup do
         @states = %w( AK AL AR AZ CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geographer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - C. Jason Harrelson (midas)