location 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f41922279600670cf0eda74410ac5c15252ef970
-  data.tar.gz: 9090ba682f5b4f59662fa9f6380d265bf881fcbc
+  metadata.gz: 5ec5da426070f00af7462e481cc7a3875b20d04b
+  data.tar.gz: 8db38ffe3f9756df01c3c2a936d97435d8fd44dc
 SHA512:
-  metadata.gz: a7214776f86d06f7b71a0beafba8bfb53ae758e95e23441921b657af8e5a01513f11fe8a62bf921c0f16ea461e8b39bdd206212f8ca3935dd9224303c3a4f5eb
-  data.tar.gz: 00e312c8dbb1fa5a20049887b0250e6c2de7e23dc579d65409a18bb3e321179a756dff9e36d245a207469c1fc2ee12c81e609647fe238677b5c744c1ee320f0a
+  metadata.gz: 03e96a958095e5839bfda023f814848958b33eee8f05820751b43f5b8313a781e713b1c47b092be8ad8baccad636b93218dcd474f0d85dba42bd75fb0b44e035
+  data.tar.gz: 0efbafdc4015d8ed4778b09ab10cf5b17c55f172f5b829f8add24e82f393f6a20a0696ae6caf0fff9f3e3221ba29b395a7c84c7915dfa7d93b89482a69842f16

data/app/models/concerns/find_or_create.rb

@@ -0,0 +1,20 @@
+module Location
+  module FindOrCreate
+    def find_or_save!(attributes)
+      attributes = self.attributes.select { |k| k =~ /_id$/ }
+        .merge(attributes)
+
+      if attributes[:normalized]
+        object = self.class.find_by(attributes)
+      end
+
+      if object
+        object
+      else
+        self.attributes = attributes
+        save!
+        self
+      end
+    end
+  end
+end

data/app/models/location/address.rb

@@ -7,18 +7,13 @@ module Location
 
     before_save :format_postal_code
 
-    validates :address, length: { maximum: 150 }
-    validates :number, length: { maximum: 20 }
-    validates :complement, length: { maximum: 40 }
-    validates :latitude, :longitude, numericality: true, allow_blank: true
-
     scope :full, ->{ eager_load(:district).eager_load(:city).eager_load(:state) }
     default_scope { full }
 
     def to_hash
       {
         postal_code: self.postal_code,
-        address:     self.address,
+        street:      self.street,
         number:      self.number,
         complement:  self.complement,
         district:    self.district.try(:name),

data/app/models/location/address_attributable.rb

@@ -0,0 +1,21 @@
+module Location
+  module AddressAttributable
+    fields = %i{postal_code street number complement
+                district city state latitude longitude}
+
+    fields.each do |field|
+      attr_writer field
+
+      define_method field do
+        instance_value = instance_variable_get("@#{field}")
+
+        if instance_value.nil? && respond_to?(:address) && !address.nil?
+          value = address.send(field)
+          value.respond_to?(:name) ? value.name : value
+        else
+          instance_value
+        end
+      end
+    end
+  end
+end

data/app/models/location/address_form.rb

@@ -1,19 +1,20 @@
 require 'super_form'
+require 'location/address_validatable'
+require 'location/address_normalizable'
+require 'location/address_persister'
 
 module Location
   class AddressForm
     include SuperForm
-
-    def self.normalizable_attributes
-      %i{state city district}
-    end
+    include AddressValidatable
+    include AddressNormalizable
 
     def self.default_presence_attributes
-      %i{postal_code address district}
+      %i{postal_code street district}
     end
 
     def self.string_attributes
-      %i{postal_code address number complement district city state}
+      %i{postal_code street number complement district city state}
     end
 
     def self.float_attributes
@@ -27,44 +28,15 @@ module Location
       validates attr, presence: true, if: ->(a){ a.presence[attr] }
     end
 
-    before_validation :build_finder
-    validate          :ensure_find_address
-    before_save       :normalize_attributes!
-
-    attr_accessor :model
+    attr_accessor :address
 
     def presence
       @presence || validate_presence_of(AddressForm.default_presence_attributes)
     end
 
-    def address_attributes
-      attributes = %w{postal_code address number complement latitude longitude}
-      values_for_attributes(attributes)
-    end
-
-    def normalized_attributes=(attributes)
-      @normalized_attributes = Array(attributes)
-      ensure_valid_normalized_attributes!
-    end
-
-    def normalized_attributes
-      @normalized_attributes ||= Location.configuration.normalized_fields
-      ensure_valid_normalized_attributes!
-      @normalized_attributes
-    end
-
-    def ensure_valid_normalized_attributes!
-      unless valid_normalized_attributes?
-        raise ::StandardError.new, "Invalid normalizable attributes"
-      end
-    end
-
-    def attribute_normalized?(attr)
-      normalized_attributes.include?(attr)
-    end
-
     def validate_presence_of(attributes)
       attributes = Array(attributes)
+
       @presence = self.attributes.keys.inject({}) do |hash, attr|
         hash[attr] = attributes.include?(attr)
         hash
@@ -73,76 +45,8 @@ module Location
 
     private
 
-    def valid_normalized_attributes?
-      valid = self.class.normalizable_attributes.slice(0, @normalized_attributes.count)
-      valid == @normalized_attributes || valid.reverse == @normalized_attributes
-    end
-
     def persist!
-      State.transaction(requires_new: true) do
-        if @model.try(:persisted?)
-          update
-        else
-          create
-        end
-      end
-    end
-
-    def create
-      state    = create_attribute(:state, State)
-      city     = create_attribute(:city, state.cities)
-      district = create_attribute(:district, city.districts)
-
-      @model = district.addresses.create!(address_attributes)
-    end
-
-    def update
-      @model.update(address_attributes)
-
-      district = update_attribute(@model, :district)
-      city     = update_attribute(district, :city)
-
-      update_attribute(city, :state)
-    end
-
-    def update_attribute(parent, attr)
-      child = parent.send(attr) || parent.send("build_#{attr.to_s}")
-      child.update(attributes_for(attr))
-      child
-    end
-
-    def attributes_for(attr)
-      { name: send(attr), normalized: attribute_normalized?(attr) }
-    end
-
-    def create_attribute(attr, klass)
-      attrs  = attributes_for(attr)
-      method = attrs[:normalized] ? "first_or_create!" : "create!"
-      klass.send(method, attrs)
-    end
-
-    def build_finder
-      @finder = Finder.build(postal_code)
-    end
-
-    def ensure_find_address
-      @finder.find do |f|
-        unless f.successful?
-          errors.add :postal_code, %{Can't find address for #{postal_code}}
-        end
-      end
-    end
-
-    def normalize_attributes!
-      normalized_attributes.each do |f|
-        send("#{f}=", @finder.address.send(f))
-      end
-    end
-
-    def values_for_attributes(attributes)
-      attributes.each_with_object({}) do |attr, hash|
-        hash[attr] = send(attr)
-      end
+      AddressPersister.new(address_normalizer, address).persist!
     end
   end
 end

data/app/models/location/address_normalizable.rb

@@ -0,0 +1,29 @@
+require 'active_support/concern'
+require 'location/address_normalizer'
+
+module Location
+  module AddressNormalizable
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :normalize_attributes!
+    end
+
+    def normalizable_address_attributes=(attributes)
+      address_normalizer.normalizable = attributes
+    end
+
+    def address_normalizer
+      (@normalizers ||= {})[postal_code] ||= Location::AddressNormalizer.new(self)
+    end
+
+    private
+
+    def normalize_attributes!
+      unless address_normalizer.normalize!
+        errors.add :postal_code, %{Can't find address for #{postal_code}}
+        false
+      end
+    end
+  end
+end

data/app/models/location/address_persistable.rb

@@ -0,0 +1,28 @@
+require 'active_support/concern'
+require 'location/address_attributable'
+require 'location/address_validatable'
+require 'location/address_normalizable'
+
+module Location
+  module AddressPersistable
+    extend ActiveSupport::Concern
+
+    attr_writer :address_persister
+
+    included do
+      include Location::AddressAttributable
+      include Location::AddressValidatable
+      include Location::AddressNormalizable
+
+      before_save :persist_address!
+    end
+
+    def address_persister
+      @address_persister ||= AddressPersister.new(address_normalizer, address)
+    end
+
+    def persist_address!
+      address_persister.persist!
+    end
+  end
+end

data/app/models/location/address_persister.rb

@@ -0,0 +1,52 @@
+module Location
+  class AddressPersister
+    attr_reader :normalizer, :address
+
+    def initialize(normalizer, address)
+      @normalizer = normalizer
+      @address = address
+    end
+
+    def persist!
+      State.transaction(requires_new: true) do
+        if @address && @address.persisted?
+          update
+        else
+          create
+        end
+      end
+    end
+
+    private
+
+    def create
+      state    = create_attribute(:state, State.new)
+      city     = create_attribute(:city, state.cities.build)
+      district = create_attribute(:district, city.districts.build)
+
+      @address = district.addresses.create!(@normalizer.attributes)
+      @normalizer.address = @address
+    end
+
+    def create_attribute(attribute, object)
+      attributes = @normalizer.parameterize_attribute(attribute)
+      object.find_or_save!(attributes)
+    end
+
+    def update
+      @address.update(@normalizer.attributes)
+
+      district = update_attribute(@address, :district)
+      city     = update_attribute(district, :city)
+
+      update_attribute(city, :state)
+    end
+
+    def update_attribute(parent, attr)
+      child = parent.send(attr) || parent.send("build_#{attr.to_s}")
+      attributes = @normalizer.parameterize_attribute(attr)
+      child.update(attributes)
+      child
+    end
+  end
+end

data/app/models/location/address_validatable.rb

@@ -0,0 +1,17 @@
+require 'active_support/concern'
+
+module Location
+  module AddressValidatable
+    extend ActiveSupport::Concern
+
+    included do
+      validates :street, length: { maximum: 150 }
+      validates :number, length: { maximum: 20 }
+      validates :complement, length: { maximum: 40 }
+      validates :latitude, :longitude, numericality: true, allow_blank: true
+      validates :district, length: { maximum: 150 }
+      validates :city, length: { maximum: 150 }
+      validates :state, length: { maximum: 150 }
+    end
+  end
+end

data/app/models/location/city.rb

@@ -1,8 +1,10 @@
+require 'concerns/find_or_create'
+
 module Location
   class City < ActiveRecord::Base
+    include FindOrCreate
+
     has_many :districts
     belongs_to :state, dependent: :destroy
-
-    validates :name, length: { maximum: 150 }
   end
 end

data/app/models/location/district.rb

@@ -1,8 +1,10 @@
+require 'concerns/find_or_create'
+
 module Location
   class District < ActiveRecord::Base
+    include FindOrCreate
+
     has_many :addresses
     belongs_to :city
-
-    validates :name, length: { maximum: 150 }
   end
 end

data/app/models/location/normalizable_address.rb

@@ -0,0 +1,23 @@
+module Location
+  class NormalizableAddress < Address
+    include Location::AddressValidatable
+    include Location::AddressNormalizable
+
+    attr_accessor :district_name, :city_name, :state_name
+
+    before_create :persist_address!
+    after_update :persist_address!
+
+    def address_persister
+      @address_persister ||= AddressPersister.new(address_normalizer, self, true)
+    end
+
+    def persist_address!
+      address_persister.persist!
+    end
+
+    def self.inheritance_column
+      nil
+    end
+  end
+end

data/app/models/location/state.rb

@@ -1,9 +1,11 @@
+require 'concerns/find_or_create'
+
 module Location
   class State < ActiveRecord::Base
+    include FindOrCreate
+
     has_many :cities, dependent: :destroy
     has_many :districts, through: :cities
     has_many :addresses, through: :districts
-
-    validates :name, length: { maximum: 150 }
   end
 end

data/db/migrate/20140223034809_rename_address_to_street.rb

@@ -0,0 +1,5 @@
+class RenameAddressToStreet < ActiveRecord::Migration
+  def change
+    rename_column :location_addresses, :address, :street
+  end
+end

data/lib/location.rb

@@ -19,14 +19,14 @@ module Location
   class Configuration
     attr_accessor :default_service
     attr_accessor :service_options
-    attr_accessor :concat_type_to_address
-    attr_accessor :normalized_fields
+    attr_accessor :concat_type_to_street
+    attr_accessor :normalizable_attributes
 
     def initialize
       @default_service = Services::Republica
       @service_options = {}
-      @concat_type_to_address = false
-      @normalized_fields = %i{state city}
+      @concat_type_to_street = false
+      @normalizable_attributes = %i{state city}
     end
   end
 end

data/lib/location/address_normalizer.rb

@@ -0,0 +1,78 @@
+require 'delegate'
+require 'location/finder'
+
+module Location
+  class AddressNormalizer
+    extend Forwardable
+
+    def self.allowed_for_normalization
+      %i{state city district}
+    end
+
+    def self.default_normalizable
+      Location.configuration.normalizable_attributes
+    end
+
+    attr_reader :model
+    def_delegators :model, :address, :address=
+
+    def initialize(model)
+      @model = model
+    end
+
+    def normalize!
+      Finder.find(@model.postal_code) do |finder|
+        return false unless finder.successful?
+
+        normalizable.each do |a|
+          value = finder.address.send(a)
+          @model.send("#{a}=", value) unless value.nil?
+        end
+      end
+    end
+
+    def normalizable=(attributes)
+      @normalizable = Array(attributes)
+      ensure_valid_normalizable!
+    end
+
+    def normalizable
+      @normalizable ||= self.class.default_normalizable
+      ensure_valid_normalizable!
+
+      @normalizable
+    end
+
+    def normalizable?(attribute)
+      normalizable.include?(attribute)
+    end
+
+    def attributes
+      attributes = %w{postal_code street number complement latitude longitude}
+
+      attributes.each_with_object({}) do |attr, hash|
+        hash[attr] = @model.send(attr)
+      end
+    end
+
+    def parameterize_attribute(attribute)
+      {
+        name: @model.send(attribute),
+        normalized: normalizable?(attribute)
+      }
+    end
+
+    private
+
+    def ensure_valid_normalizable!
+      unless valid_normalizable?
+        raise ::StandardError.new, "Invalid normalizable attributes"
+      end
+    end
+
+    def valid_normalizable?
+      valid = self.class.allowed_for_normalization.slice(0, @normalizable.count)
+      valid == @normalizable || valid.reverse == @normalizable
+    end
+  end
+end

data/lib/location/finder.rb

@@ -13,8 +13,8 @@ module Location
 
     def initialize(postal_code, service)
       @postal_code = postal_code
-      @service     = service
-      @address     = Address.new
+      @service = service
+      @address = Address.new
     end
 
     def find
@@ -34,17 +34,17 @@ module Location
 
     class Address
       attr_accessor :type, :postal_code
-      attr_accessor :address, :number, :complement
+      attr_accessor :street, :number, :complement
       attr_accessor :district, :city, :state
 
       def type=(type)
         @type = type
-        concat_type_to_address
+        concat_type_to_street
       end
 
-      def address=(address)
-        @address = address
-        concat_type_to_address
+      def street=(street)
+        @street = street
+        concat_type_to_street
       end
 
       def to_hash(options = {})
@@ -61,17 +61,17 @@ module Location
 
       private
 
-      def concat_type_to_address
-        concat_type_to_address! if concat_type_to_address?
+      def concat_type_to_street
+        concat_type_to_street! if concat_type_to_street?
       end
 
-      def concat_type_to_address?
-        Location.configuration.concat_type_to_address && 
-          !type.nil? && !address.nil?
+      def concat_type_to_street?
+        Location.configuration.concat_type_to_street &&
+          !type.nil? && !street.nil?
       end
 
-      def concat_type_to_address!
-        @address = "#{type} #{address}"
+      def concat_type_to_street!
+        @street = "#{type} #{street}"
       end
     end
   end

data/lib/location/services/stubbed_service.rb

@@ -1,23 +1,20 @@
 module Location
   module Services
     class StubbedService
-      class << self
-        attr_writer :attributes
+      def self.attributes
+        @attributes ||= {}
       end
 
-      def self.attributes
-        @attributes || {
-          address:    'R. Barata Ribeiro',
-          number:     '1981',
-          complement: '',
-          district:   'Copacabana',
-          city:       'Rio de Janeiro',
-          state:      'RJ'
-        }
+      def self.set_result(postal_code, attributes)
+        self.attributes[postal_code] ||= attributes
+      end
+
+      def self.attributes_for(postal_code)
+        self.attributes[postal_code] || {}
       end
 
       def fetch(postal_code, address)
-        StubbedService.attributes.each do |k, v|
+        self.class.attributes_for(postal_code).each do |k, v|
           address.send("#{k}=", v)
         end
       end

data/lib/location/services/uni5.rb

@@ -15,7 +15,7 @@ module Location
           address.city     = res['cidade']
           address.district = res['bairro']
           address.type     = res['tipo_logradouro']
-          address.address  = res['logradouro']
+          address.street   = res['logradouro']
         end
       end
 
@@ -38,7 +38,7 @@ module Location
         end
 
         yield eval_result(response.body)
-      rescue Net::HTTPBadResponse => e
+      rescue Net::HTTPBadResponse
         raise Error.new, 'Got a bad response'
       rescue SocketError
         raise Error.new, 'Got a socket error'

data/lib/location/version.rb

@@ -1,3 +1,3 @@
 module Location
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: location
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thiago A. Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,37 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ">="
+- !ruby/object:Gem::Dependency
+  name: super_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.8
-  type: :development
+        version: 1.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: super_form
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.3.8
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -142,20 +164,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.16.1
-- !ruby/object:Gem::Dependency
-  name: virtus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +206,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: Polymorphic address models, address normalization, address web services,
   address autocomplete, maps
 email:
@@ -213,11 +235,17 @@ files:
 - app/controllers/location/application_controller.rb
 - app/controllers/location/finder_controller.rb
 - app/helpers/location/application_helper.rb
+- app/models/concerns/find_or_create.rb
 - app/models/location/address.rb
+- app/models/location/address_attributable.rb
 - app/models/location/address_form.rb
+- app/models/location/address_normalizable.rb
+- app/models/location/address_persistable.rb
+- app/models/location/address_persister.rb
+- app/models/location/address_validatable.rb
 - app/models/location/city.rb
 - app/models/location/district.rb
-- app/models/location/form.rb
+- app/models/location/normalizable_address.rb
 - app/models/location/state.rb
 - app/views/layouts/location/application.html.erb
 - app/views/location/finder/show.js.coffee
@@ -233,7 +261,9 @@ files:
 - db/migrate/20140129154554_add_normalized_to_states.rb
 - db/migrate/20140129154726_add_normalized_to_cities.rb
 - db/migrate/20140129154734_add_normalized_to_districts.rb
+- db/migrate/20140223034809_rename_address_to_street.rb
 - lib/location.rb
+- lib/location/address_normalizer.rb
 - lib/location/engine.rb
 - lib/location/finder.rb
 - lib/location/services/errors.rb
@@ -264,9 +294,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Location and address related utilities
 test_files: []
-has_rdoc: 

data/app/models/location/form.rb

@@ -1,55 +0,0 @@
-require 'virtus'
-
-module Location
-  module Form
-    def self.included(klass)
-      virtus = @virtus_options ? 
-        Virtus.model(@virtus_options) : 
-        Virtus.model
-
-      klass.include virtus
-      klass.include ActiveModel::Conversion
-      klass.include ActiveModel::Validations
-      klass.extend  ActiveModel::Naming
-      klass.extend  ActiveModel::Callbacks
-
-      add_callbacks(klass)
-
-      @virtus_options = nil
-    end
-
-    def self.add_callbacks(klass)
-      klass.class_eval do
-        alias_method :ar_valid?, :valid?
-
-        def valid?
-          run_callbacks :validation do
-            ar_valid?
-          end
-        end
-
-        define_model_callbacks :validation, :save
-      end
-    end
-
-    def self.base(virtus_options = {})
-      @virtus_options = virtus_options
-      Form
-    end
-
-    def persisted?
-      false
-    end
-
-    def save
-      if valid?
-        run_callbacks :save do
-          persist!
-        end
-        true
-      else
-        false
-      end
-    end
-  end
-end