my_zipcode_gem 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70c300c19c90f28c2ac614a2795c600bfb3f0d4d
-  data.tar.gz: 671303664dee6662adbd54f57ab3b8d9f3046f41
+  metadata.gz: fa3086991a379075e85a57c7165f3435dd2b193c
+  data.tar.gz: 73ca08c0d39a99b4da16cde40c2772d1a6098e7e
 SHA512:
-  metadata.gz: 1a36d6a90fea133bbd531fc0e9d7faa98c9e5f12a0e534b1babd12fa1a8aa317aff7b8d8781771c8e468e426c3119b22fc931f7557ce08a08cf1622c7d7a0215
-  data.tar.gz: 704517c8c1140868b71af6203cacb6ad77e3f96d9125a24d6d83b8c0249bba85362f6b3b9c1bd8308c7e6fb963ca31ec463cf0c1379c9ee00bfcb4e36366e00c
+  metadata.gz: 744078d00f5ae40c44241ac57784dbf1602a372532a125a5af6998ebb3a5b36b07d0796f7b62cc9a30db29fc19666d3482c8badb89542fab3387af7b2d78ff82
+  data.tar.gz: b77952605f4e0ed337ec44ee920e061b513334dd488f282ff41344e1fe6573f93cf56e05b1bad5cfd42ad07ba2634446206589c7c8270a5cdb588836d32b68f1

data/{README.textile → README.md}

@@ -1,44 +1,54 @@
-h1. My Zipcode Gem
+# My Zipcode Gem
 
-!https://img.shields.io/github/license/midwire/my_zipcode_gem.svg!:https://github.com/midwire/my_zipcode_gem/blob/master/MIT-LICENSE
+[![MIT-LICENSE](https://img.shields.io/github/license/midwire/my_zipcode_gem.svg)](https://github.com/midwire/my_zipcode_gem/blob/master/MIT-LICENSE)
 
-Simple gem to handle zipcode lookups and related functionality.  @rake zipcodes:update@ will automatically download and update your local zipcode database.  Generates three models for extended zipcode functionality.
+Simple gem to handle zipcode lookups and related functionality.  `rake zipcodes:update` will automatically download and update your local zipcode database.  Generates three models for extended zipcode functionality.
 
-h2. Installation
+## Versions
+
+* 0.1.x is for Rails versions less than 4.x
+* 0.2.x is for Rails 4 and above
+
+## Installation
 
 Add the following line to your Gemfile:
 
-bc. gem 'my_zipcode_gem'
+    gem 'my_zipcode_gem'
 
 Run:
 
-bc. rake bundle install
+    rake bundle install
 
 Generate the models and populate the data:
 
-bc. rails g my_zipcode_gem:models
+```
+rails g my_zipcode_gem:models
 rake db:migrate
 rake zipcodes:update
+```
 
 You should now have three new tables and three new models, Zipcode, State, County.
 
-h2. Usage
+## Usage
 
-bc. zipcode = Zipcode.find_by_code '66206'
+```
+zipcode = Zipcode.find_by_code '66206'
 zipcode.state.abbr    # => 'KS'
 zipcode.city          # => 'Shawnee Mission'
 zipcode.county.name   # => 'Johnson'
 zipcode.lat.to_s      # => '38.959356', it is actually a BigDecimal object converted to_s for documentation.
 zipcode.lon.to_s      # => '-94.716155', ditto
-zipcode.is_geocoded?  # => true, most if not all should be pre-geocoded.
+zipcode.geocoded?  # => true, most if not all should be pre-geocoded.
+```
 
 You can also look for a zipcode from a city and state:
 
-bc. Zipcode.find_by_city_state "Shawnee Mission", "KS"
+    Zipcode.find_by_city_state "Shawnee Mission", "KS"
 
 You can use State and County objects as follows:
 
-bc. state = State.find_by_abbr "MO"
+```
+state = State.find_by_abbr "MO"
 state.cities.count    # => 963
 state.cities          # gives you a sorted array of all cities for the state
 state.zipcodes.count  # => 1195
@@ -47,45 +57,48 @@ county = state.counties.first
 county.cities.count   # => 5
 county.cities         # gives you a sorted array of all cities for the county
 county.zipcodes.count # => 5
+```
 
-h3. Automatic JQuery/AJAX lookup
+### Automatic JQuery/AJAX lookup
 
 You can have a user enter a zipcode and automatically lookup their city, state and county.
 
 Put something like this in your view:
 
-bc. f.text_field :zip, :size => 5, :maxlength => 5, :class => 'zipcode_interactive'
+```
+f.text_field :zip, :size => 5, :maxlength => 5, :class => 'zipcode_interactive'
 f.text_field :city, :size => 20, :maxlength => 60, :readonly => true
 f.text_field(:state, :size => 2, :maxlength => 2, :readonly => true)
 f.text_field(:county, :size => 20, :maxlength => 60, :readonly => true)
-
-Then add this to your application.js, but remember to replace [mycontrollername] with your own controller.
-
-bc.    $(document).ready(function() {
-        // Interactive Zipcodes
-        $('input.zipcode_interactive').blur(function(data) {
-            var elem_id = $(this).attr("id");
-            var base_id = elem_id.substring(0, elem_id.lastIndexOf("_"));
-            $.get("/mycontrollername/get_zip_data/" + this.value, {},
-            function(data) {
-                var zipcode = $.parseJSON(data);
-                var city = $('#' + base_id + '_city');
-                var state = $('#' + base_id + '_state');
-                var county = $('#' + base_id + '_county');
-                if (zipcode.err) {
-                    alert(zipcode.err);
-                } else {
-                    city.val(zipcode.city);
-                    state.val(zipcode.state)
-                    county.val(zipcode.county)
-                }
-            })
-        });
+```
+
+Then add this to your application.js, but remember to replace `mycontrollername` with your own controller.
+
+    $(document).ready(function() {
+      // Interactive Zipcodes
+      $('input.zipcode_interactive').blur(function(data) {
+        var elem_id = $(this).attr("id");
+        var base_id = elem_id.substring(0, elem_id.lastIndexOf("_"));
+        $.get("/mycontrollername/get_zip_data/" + this.value, {},
+        function(data) {
+          var zipcode = $.parseJSON(data);
+          var city = $('#' + base_id + '_city');
+          var state = $('#' + base_id + '_state');
+          var county = $('#' + base_id + '_county');
+          if (zipcode.err) {
+            alert(zipcode.err);
+          } else {
+            city.val(zipcode.city);
+            state.val(zipcode.state)
+            county.val(zipcode.county)
+          }
+        })
+      });
     });
 
 You will also need a controller method similar to this, which will return the data to your form:
 
-bc.    def get_zip_data
+    def get_zip_data
       @zipcode = Zipcode.find_by_code(params[:code], :include => [:county, :state])
       if @zipcode
         @counties = County.find(:all, :conditions => [ "state_id = ?", @zipcode.county.state_id ])
@@ -115,14 +128,14 @@ bc.    def get_zip_data
 
 And define a route for the AJAX function in routes.rb:
 
-bc. get 'mycontrollername/get_zip_data/:code', :controller => 'mycontrollername', :action => 'get_zip_data'
+    get 'mycontrollername/get_zip_data/:code', :controller => 'mycontrollername', :action => 'get_zip_data'
 
 That's about it.
 
-Let me know if there are any errors.  I cut and pasted the code above from a working application, but there may be some gotchas that I missed.
+Please report any errors or [issues](https://github.com/midwire/my_zipcode_gem/issues).
 
-h2. LOG
+## LOG
 
-h3. 05/03/2011:
+### 05/03/2011:
 
 Initial Release

data/lib/generators/my_zipcode_gem/models_generator.rb

@@ -41,6 +41,5 @@ module MyZipcodeGem
     def create_rakefile
       template 'zipcodes.rake', "lib/tasks/zipcodes.rake"
     end
-
   end
 end

data/lib/generators/my_zipcode_gem/templates/county_model.rb

@@ -1,16 +1,16 @@
 require 'memoist'
+
 class County < ActiveRecord::Base
   extend Memoist
-  attr_accessible :state_id, :region_id, :abbr, :name, :count_seat
-
   belongs_to :state
   has_many :zipcodes
-  
-  validates :name, :uniqueness => {:scope => :state_id, :case_sensitive => false}, :presence => true
-  
-  scope :without_zipcodes, joins("LEFT JOIN zipcodes ON zipcodes.county_id = counties.id").where("zipcodes.county_id IS NULL")
-  scope :without_state, where("state_id IS NULL")
-  
+
+  validates :name, uniqueness: { scope: :state_id, case_sensitive: false },
+                   presence: true
+
+  scope :without_zipcodes, -> { joins("LEFT JOIN zipcodes ON zipcodes.county_id = counties.id").where("zipcodes.county_id IS NULL") }
+  scope :without_state, -> { where("state_id IS NULL") }
+
   def cities
     zipcodes.map(&:city).sort.uniq
   end

data/lib/generators/my_zipcode_gem/templates/state_model.rb

@@ -1,14 +1,13 @@
 require 'memoist'
+
 class State < ActiveRecord::Base
   extend Memoist
-  attr_accessible :abbr, :name
-
   has_many :zipcodes
   has_many :counties
 
-  validates :abbr, :uniqueness => { :case_sensitive => false }, :presence => true
-  validates :name, :uniqueness => { :case_sensitive => false }, :presence => true
-  
+  validates :abbr, uniqueness: { case_sensitive: false }, presence: true
+  validates :name, uniqueness: { case_sensitive: false }, presence: true
+
   def cities
     zipcodes.map(&:city).sort.uniq
   end

data/lib/generators/my_zipcode_gem/templates/zipcode_model.rb

@@ -1,19 +1,19 @@
 class Zipcode < ActiveRecord::Base
-  attr_accessible :code, :city, :state_id, :county_id, :lat, :lon
-  
   belongs_to :county
   belongs_to :state
-  
-  validates :code, :uniqueness => true, :presence => true
-  validates :state_id, :county_id, :city, :presence => true
-  
+
+  validates :code, uniqueness: true, presence: true
+  validates :state_id, :county_id, :city, presence: true
+
   scope :without_county, -> { where("county_id IS NULL") }
   scope :without_state, -> { where("state_id IS NULL") }
   scope :ungeocoded, -> { where("lat IS NULL OR lon IS NULL") }
 
   class << self
     def find_by_city_state(city, state)
-      includes(:county => :state).where("city like '#{city}%' AND states.abbr like '%#{state}%'").first
+      includes(county: :state)
+        .where("city like ? AND states.abbr like ?", "#{city}%", "%#{state}%")
+        .first
     end
   end
 
@@ -21,7 +21,7 @@ class Zipcode < ActiveRecord::Base
     [lat, lon]
   end
 
-  def is_geocoded?
+  def geocoded?
     (!lat.nil? && !lon.nil?)
   end
 end

data/lib/generators/my_zipcode_gem/templates/zipcodes.rake

@@ -1,5 +1,6 @@
 require 'open-uri'
 require 'csv'
+
 namespace :zipcodes do
 
   desc "Update states table"

data/lib/generators/my_zipcode_gem/version.rb

@@ -1,3 +1,3 @@
 module MyZipcodeGem
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: my_zipcode_gem
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Chris Blackburn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,7 +51,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
 - features/step_definitions/common_steps.rb
 - features/step_definitions/rails_setup_steps.rb