address_concern 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54db12d5f83e9438e61c47552eba316511be4cbc69200bee3e51568a10c2c41e
-  data.tar.gz: 73a84002eeafb49d0536d2bf5de94391410b3b4d873633ba62f2fd3e42df8ab5
+  metadata.gz: fd8e4df80024c5fc3a3bc5984003e412615c3d6345d8408d17859e088183e7f2
+  data.tar.gz: eda7df98ac44d1ecc07c7e5a0f3c4afe3c93baa53378b31cdeab6d93a19d6d34
 SHA512:
-  metadata.gz: ac7f541ac00b56b64c9a6e8f6cc7a49ee423cce621c90a13173ddc7e4c852883d5f5a2ad14bca967b2d7c7fcc9678a7b8062bb580c30baa43bb656e681b7fed9
-  data.tar.gz: 305160aabeca32990a9aa74aa2519b6b58b54c7354985ccbb1677fc1ec370b5c0f104319541834c33865f86079f10d4f45b31342be2d2656e90ade6eb42a85fa
+  metadata.gz: a09d2db18101b7b407e52481559cefd69ae17b06384e448e92b160c939d785045725e3c768156a264af182087f1a11a77f1ddc0f5b9e3a9f3202b6cfdce8d719
+  data.tar.gz: 7ba89fd64d9f910fe77e5b807f335c6923ca80289549a6c43afe435ed4cbad699196c75f2415f8479b474e63f86943764e881b475e1e7cb2a76fcbbd5f88ec40

data/Readme.md

@@ -6,25 +6,55 @@ 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 app's `Address` model by adding the
+`acts_as_address` macro to it:
+
+```ruby
+class Address < ApplicationRecord
+  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 now have an `Address` model that you can use in your app just as if it were in your `app/models` directory.
+You can modify the migration and add any other fields you may wish to include.
 
-# Usage
+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.
 
-## Base usage
+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
-  include AddressConcern::Address
+  acts_as_address(
+    country: {
+      code_attribute: :country,
+    },
+    state: {
+      code_attribute: :state,
+    },
+  )
 end
 ```
 
+# Usage
+
 ## `belongs_to_address`
 
 `AddressConcern::AddressAssociations` is automatically included into `ActiveRecord::Base` and
@@ -113,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
+  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
+class Address < ApplicationRecord
+  include AddressConcern::Address
+
+  belongs_to_addressable options…
+end
 ```
 
 ## `has_addresses`
@@ -154,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

@@ -13,15 +13,14 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
 
   s.add_dependency "rake"
-  s.add_dependency "cucumber"
   s.add_dependency "rails", ">= 4.0"
   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_dependency "zeitwerk"
 
+  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'

data/config/address_concern.rb

@@ -0,0 +1,3 @@
+#AddressConcern.setup do |config|
+  # ...
+#end