Skip to content

Commit e4ec690

Browse files
committed
Update breaking changes in CHANGELOG
1 parent ba1a966 commit e4ec690

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

CHANGELOG.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
1-
# 1.0.0 (unreleased)
2-
3-
* 1.0.0 will introduce breaking changes, including removing support for symbols. To update, change snake-case symbols to their correct column names (for example, `record["First Name"]` instead of `record[:first_name]`)
4-
* Implement associations as instance methods, e.g.
5-
```ruby
6-
tea.brews #=> [<Brew>, <Brew>] returns associated models
7-
tea["Brews"] #=> ["rec456", "rec789"] returns a raw Airtable field
8-
```
1+
# 1.0.0
2+
3+
* 1.0.0 introduces breaking changes, including removing support for symbols and
4+
implementing associations as instance methods. To upgrade:
5+
1. Change snake-case symbols to their correct column names:
6+
`record["First Name"]` instead of `record[:first_name]`)
7+
2. Change your association calls to use instance methods instead of `[]`:
8+
```ruby
9+
class Tea < Airrecord::Table
10+
has_many :brews, class: "Brew", column: "Brews"
11+
end
12+
tea[:brews] #=> Error, no longer supported
13+
tea.brews #=> [<Brew>, <Brew>] returns associated Brew instances
14+
tea["Brews"] #=> ["rec456", "rec789"] returns a raw Airtable field
15+
```
16+
3. Dates that are formed `\d{4}-\d{2}-\d{2}` are no longer auto-parsed. Define a helper instead.
917
* Automatically throttle client calls to Airtable's API limit of 5 requests per second.
1018
* Fix sorting by multiple fields
1119
* Report `User-Agent` as `Airrecord`.
12-
* Dates that are formed `\d{4}-\d{2}-\d{2}` are no longer auto-parsed. Define a helper instead.
1320
1421
# 0.2.5
1522

0 commit comments

Comments
 (0)