neighborhood 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5521f45371fbe97cdd678246ab45140c92d783ee
-  data.tar.gz: 047178750e1096218bc0cf34ab1abb5254343877
+  metadata.gz: a9d37b2adbaa206a5d585a5e05e2754cca94ab66
+  data.tar.gz: 6c1047694cd6649fa98d6682ed78f429a46edcd2
 SHA512:
-  metadata.gz: d90308a091e8882ac1c4aeeb2a3e7316d1d476868ba27d5290b34e3830767bc48c1d066bc705c17e82a9f6db6f5f65d034b8d139cc46edd304277b553479adec
-  data.tar.gz: c6619cebc897f075e925c8409eb92bd94b2ea3c727dc990eac00f47e8717e47688587249d118fab52804706131b59ea7deb555b98592e3553bcf6b90d3c72257
+  metadata.gz: bb33500ab95e932430dbab64c1d43a1325ecf15c5ae5220c47cf6fda823a5c583ade44bfa0485314f3a1860747792d172fa0b35b13ae8a7fcb94f8b0448b9d2d
+  data.tar.gz: db438c434e5e967b9924d559d18d2ebe02dcc0c22213486d2c0b231091575cc97386b1c822d9166c32aabc2ee31bd9b08b64a214c5da7c3d9dacacbdfaf2940c

data/README.md

@@ -1,28 +1,92 @@
-# Neighborhood
+Neighborhood
+==========
 
-TODO: Write a gem description
+Neighborhood helps you easily add address fields and geocoding to your Rails
+models.
 
-## Installation
+It makes use of the [Geocoder gem](https://github.com/alexreisner/geocoder) for
+all geocoding, although it handles some logic behind-the-scenes.
 
-Add this line to your application's Gemfile:
+Installation
+----------
+
+This gem is meant to work with Ruby on Rails projects. I recommend you add it
+to your project's Gemfile:
 
 ```ruby
-gem 'neighborhood'
+gem 'neighborhood', '~> 0.1.0'
+```
+
+> **WARNING: Neighborhood will likely undergo major changes as I add more
+> features over time. I highly recommend you limit the version in your
+> `Gemfile` when installing Neighborhood (as shown above).**
+
+Then install your bundle:
+
+```text
+$ bundle
+```
+
+Usage
+----------
+
+### Adding Fields to a Model
+
+To add address fields to your model, run the generator:
+
+```text
+$ bundle exec rails g neighborhood [Model]
 ```
 
-And then execute:
+This adds the following fields:
+
+* `street_address`
+* `suite_apt`
+* `city`
+* `state`
+* `zip`
+* `country`
+* `phone`
+* `lat`
+* `lng`
+* `full_address`
+
+Then migrate your database:
+
+```text
+$ bundle exec rake db:migrate
+```
 
-    $ bundle
+### Add Auto-Geocoding
+
+To add automatic geocoding, add the `in_the_neighborhood` method to the model
+to which you added the fields. For example, if you added these fields to a
+`User` model, it might look like this:
+
+```ruby
+class User < ActiveRecord::Base
+  in_the_neighborhood
+end
+```
 
-Or install it yourself as:
+> **WARNING: Neighborhood's `in_the_neighborhood` is tightly wound to the
+> address fields. You need to make sure you've run the generator (and migrated)
+> before you can mess with this method.
 
-    $ gem install neighborhood
+This method add an `after_validation` callback that will geocode the *address*
+on the model. `address` is an instance method made available to you which
+combines the individual address fields into one field.
 
-## Usage
+When geocoding, Neighborhood automatically sets `lat`, `lng`, `full_address`
+and `country`. Of course, you can still set country automatically, it just may
+be overwritten.
 
-TODO: Write usage instructions here
+> *Note: I know there's a lot missing here. I'm simply adding features and
+> options as I need them. Feel free to contribute if you see something missing
+> that you need.*
 
-## Contributing
+Contributing
+----------
 
 1. Fork it ( https://github.com/[my-github-username]/neighborhood/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/generators/neighborhood_generator.rb

@@ -0,0 +1,49 @@
+require 'rake'
+require 'rails/generators'
+
+class NeighborhoodGenerator < Rails::Generators::Base
+  desc "Add address fields and geocoding to a model"
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :model, :type => :string
+
+  def confirm_model
+    @model = model.constantize
+  rescue
+    puts "Can't find the model: #{model}"
+    exit
+  end
+
+  def set_references
+    @model_pl = @model.to_s.humanize.downcase.pluralize
+  end
+
+  def generate_migration
+    migration_name = "add_neighborhood_fields_to_#{@model_pl}"
+    generate "migration #{migration_name} #{database_fields}"
+    insert_into_file(
+      Dir.glob("#{Rails.root}/db/migrate/*.rb").last,
+      ", :precision => 7, :scale => 5",
+      :after => /\:l(at|ng), \:decimal/
+    )
+  end
+
+  private
+
+    def database_fields
+      [
+        'street_address',
+        'suite_apt',
+        'city',
+        'state',
+        'zip',
+        'country',
+        'phone',
+        'lat:decimal',
+        'lng:decimal',
+        'full_address:text',
+      ].join(' ')
+    end
+
+end

data/lib/neighborhood.rb

@@ -1,5 +1,9 @@
+# neighborhood files
 require "neighborhood/version"
+require "neighborhood/in_the_neighborhood"
+
+# require dependencies
+require 'geocoder'
 
 module Neighborhood
-  # Your code goes here...
 end

data/lib/neighborhood/in_the_neighborhood.rb

@@ -0,0 +1,36 @@
+require 'geocoder'
+
+class << ActiveRecord::Base
+
+  def in_the_neighborhood
+    geocoded_by :address, :latitude  => :lat, :longitude => :lng
+
+    after_validation :geocode_if_address
+
+    define_method "address" do
+      [street_address, suite_apt, city, state, zip, country].compact.join(', ')
+    end
+
+    define_method "geocode_if_address" do
+      if address.present?
+        geo = Geocoder.search(address)
+        if geo.size > 0
+          geo = geo.first.data
+          # set basic geo
+          attrs = {
+            :lat => geo['geometry']['location']['lat'],
+            :lng => geo['geometry']['location']['lng'],
+            :full_address => geo['formatted_address'],
+          }
+          # set country if necessary
+          country = geo['address_components']
+            .select { |a| a['types'].include?('country') }.first['long_name']
+          attrs[:country] = country if country.present?
+          # save attributes
+          update_columns(attrs)
+        end
+      end
+    end
+  end
+
+end

data/lib/neighborhood/version.rb

@@ -1,3 +1,3 @@
 module Neighborhood
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/neighborhood.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'geocoder'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neighborhood
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean C Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-27 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - scdavis41@gmail.com
@@ -50,7 +64,10 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- lib/generators/neighborhood_generator.rb
+- lib/generators/templates/.keep
 - lib/neighborhood.rb
+- lib/neighborhood/in_the_neighborhood.rb
 - lib/neighborhood/version.rb
 - neighborhood.gemspec
 homepage: ''