address_concern 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de8b741d8cd001b4e7f4a8e12895aa623bccaabfa98dbdb41886bc25ab74e8bf
-  data.tar.gz: 96b1e6fb186f3941ab8db185b79ad6a56be99868b9950b21742869211b4e2530
+  metadata.gz: 205541c7ef9aedeb7e807bb946274c5a379edc7162592bbb2b1fd1015ce681b5
+  data.tar.gz: 2dacfdb3da70d8ef88989ea2966e407179af9d536b8e3ae5df0826abe7ab1571
 SHA512:
-  metadata.gz: 6a5ca29908ad512f492e510c90a1fc5c1e4ce38a3d193a9156551415da85f503bced92538edf6306615c1884bfadcae9eacffd1bb15204d4aae6cc1e1fc444c4
-  data.tar.gz: 833b6c049415afab41e1ba8fb44cf73e69cd9392b6a9b70a0410a68f203f749f4dfd18011c6b52b711e56e3db209365be88d5e7b87d5c69c677485698e721c7f
+  metadata.gz: 15f9277026adf1a62dff7561386dae79d021f11eeb3f3b4c3c13ff76bb991c7893861402ad120ec7ff8a4e714fd389cb644580a1a7f2a2fedc4c273018b77c38
+  data.tar.gz: a5ab51814edaee41313de51bf2fc7fa75b683b79d490dc26af1401b3770c292c4ffd49b0452b3a7f02b1fd49b1d48fa2e052087d8b8e9ae43126dfa6b6fc5fe6

data/Readme.md

@@ -6,20 +6,52 @@ A reusable polymorphic `Address` model concern for your Rails apps.
 
 Add `address_concern` to your `Gemfile`:
 
-    gem 'address_concern'
+```ruby
+gem 'address_concern'
+```
 
-Include the `AddressConcern::Address` concern in your model:
+Include the `AddressConcern::Address` concern in your app's `Address` model by adding the
+`acts_as_address` macro to it:
 
 ```ruby
 class Address < ApplicationRecord
-  include AddressConcern::Address
+  acts_as_address
 end
 ```
 
 Then run the generator to create your addresses table:
 
     rails generate address_concern:install
-    rake db:migrate
+    rails db:migrate
+
+You can modify the migration and add any other fields you may wish to include.
+
+For country and state/providence, you may choose to store both the code and name or just code or
+just name. Remove from the migration the columns you don't need.
+
+By default, it will store country name in `country_name` or `country` if one of those columns exist,
+and store country code in `country_code` or `country` if one of those columns exist. If _only_ a
+`country` column exists, it will be used to store the name attribute by default.
+
+By default, it will store state name in `state_name` or `state` if one of those columns exist,
+and store state code in `state_code` or `state` if one of those columns exist. If _only_ a
+`state` column exists, it will be used to store the name attribute by default.
+
+These column names can be configured. For example, to store country code in `country` and state code
+in `state`, you could do:
+
+```ruby
+class Address < ApplicationRecord
+  acts_as_address(
+    country: {
+      code_attribute: :country,
+    },
+    state: {
+      code_attribute: :state,
+    },
+  )
+end
+```
 
 # Usage
 
@@ -111,10 +143,19 @@ address = company.build_address(address: '...')
 ```
 
 This also adds a polymorphic `addressable` association on the Address model (not available if you're
-using `belongs_to :address` on your addressable models):
+using `belongs_to_address` on your addressable models instead of `has_address`):
+
+```ruby
+  belongs_to :addressable, polymorphic: true, touch: true, optional: true
+```
 
+If you wish to customize that `belongs_to`, you can pass in any options you like:
 ```ruby
-belongs_to :addressable, :polymorphic => true
+class Address < ApplicationRecord
+  include AddressConcern::Address
+
+  belongs_to_addressable options…
+end
 ```
 
 ## `has_addresses`
@@ -152,6 +193,32 @@ vacation_address = user.addresses.build(address: 'Vacation', :address_type => 'V
 user.addresses # => [shipping_address, vacation_address]
 ```
 
+## Street address
+
+You are free to either store the street address in a single column like this:
+
+```ruby
+  create_table :addresses do |t|
+    …
+    t.text     :address
+    …
+```
+
+or in separate columns like this:
+
+```ruby
+  create_table :addresses do |t|
+    …
+    t.string   :address_1
+    t.string   :address_2
+    t.string   :address_3
+    …
+```
+
+If you store it in a single column of type text, then it will support multi-line addresses stored in
+that single column. Calling `address.address_lines`, for example, will return an array of address
+lines — however many lines the user entered (you may add validations to limit this as you wish).
+
 # Country/state database
 
 Country/state data comes from the [`carmen`](https://github.com/carmen-ruby/carmen) gem.

data/address_concern.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |s|
   s.add_dependency "activerecord", ">= 4.0"
   s.add_dependency "activesupport", ">= 4.0"
   s.add_dependency "carmen", '>= 1.1.1'
-  s.add_dependency "attribute_normalizer"
-  s.add_dependency "active_record_ignored_attributes"
-  s.add_dependency "facets"
+  #s.add_dependency "attribute_normalizer"
 
+  s.add_development_dependency 'active_record_ignored_attributes' # for be_same_as
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'sqlite3'
   #s.add_development_dependency 'mysql2', '~>0.2.11'