OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ColinDKelley merged 2 commits into from
Jul 1, 2026
+75 −2
Merged

OCTO-892: Document the field macro in the README #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6095094
OCTO-892: Document the field macro in the README
ColinDKelley Jul 1, 2026
cd83ef5
Bump version to 4.0.3
ColinDKelley Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
declare_schema (4.0.2)
declare_schema (4.0.3)
rails (>= 7.0)

GEM
Expand Down
69 changes: 69 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
t.field :company_name, :string, null: false, limit: 100
...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
[[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
field name, type, **options
end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
string :title, :required, limit: 255
string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
field :title, :string, :required, limit: 255
field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
extend ActiveSupport::Concern

included do
declare_schema { }
declare_field :title, :string, :required, limit: 255
declare_field :slug, :string, :unique, limit: 255
end
end
```
which is equivalent to:
```ruby
module SoftDeletable
extend ActiveSupport::Concern

included do
declare_schema do
field :title, :string, :required, limit: 255
field :slug, :string, :unique, limit: 255
end
end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down
2 changes: 1 addition & 1 deletion lib/declare_schema/version.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
VERSION = "4.0.2"
VERSION = "4.0.3"
end
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
OCTO-892: Document the field macro in the README#187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ColinDKelley
merged 2 commits into

from

Jul 1, 2026

+75

−2

 Merged


OCTO-892: Document the field macro in the README
#187
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
6095094

OCTO-892: Document the field macro in the README


ColinDKelley Jul 1, 2026
cd83ef5

Bump version to 4.0.3


ColinDKelley Jul 1, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [4.0.3] - 2026-07-01
### Changed
- Documented the `field` DSL macro and the underlying `declare_field` class method.

## [4.0.2] - 2026-05-29
### Fixed
- Fixed Rails 7.2 compatibility for the `serialize:` field option. Rails 7.2 changed
Expand Down

2 changes: 1 addition & 1 deletion
Gemfile.lock

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
PATH
 remote: .
 specs:
 declare_schema (4.0.2)
 declare_schema (4.0.3)
 rails (>= 7.0)

GEM
Expand Down

69 changes: 69 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,6 +89,75 @@ create_table :companies, id: :bigint do |t|
 ...
end
```
### The `field` Macro
Every `t.<type> :<column_name>, <options>` declaration shown above is syntactic sugar for calling the `field` macro directly:
```ruby
create_table :companies, id: :bigint do |t|
 t.field :company_name, :string, null: false, limit: 100
 ...
end
```
`field(name, type, *flags, **options)` is the primitive method underlying every typed shorthand (`t.string`, `t.integer`, etc.), as well as the `timestamps` and `optimistic_lock` helpers. A call like `t.string :company_name, limit: 100` is dispatched (via `method_missing`) to `t.field :company_name, :string, limit: 100`.

`field` only exists inside the `declare_schema do ... end` block, but within it, it can be called either with an explicit `t.` receiver (`t.field ...`) or bare (`field ...`), since the block is `instance_eval`'d against the DSL object -- both forms are equivalent. `field` cannot be called outside of the `declare_schema do ... end` block.

Calling `field` directly is useful when you need to dynamically declare field(s) based on meta-data that is available at runtime:
```ruby
declare_schema do
 [[:company_name, :string, { limit: 100 }], [:employee_count, :integer, {}]].each do |name, type, options|
 field name, type, **options
 end
end
```

#### `:required` and `:unique` Flags
In addition to keyword options, `field` (and by extension, `t.<type>`) accepts optional positional flags placed immediately after the column name:
- `:required` - adds `validates_presence_of :<column_name>` to the model.
- `:unique` - adds `validates_uniqueness_of :<column_name>, allow_nil: <true unless :required is also given>` to the model.

For example:
```ruby
declare_schema do
 string :title, :required, limit: 255
 string :slug, :unique, limit: 255
end
```
is equivalent to:
```ruby
declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
end
```

#### Calling `declare_field` outside the block
`field` is DSL sugar that simply calls the model's `declare_field` class method: `field(name, type, *flags, **options)` calls `declare_field(name, type, *flags, **options)`. Unlike `field`, `declare_field` is a regular class method, so it can be called directly on the model outside of a `declare_schema do ... end` block, e.g. from a shared concern that adds a field to any model that includes it:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema { }
 declare_field :title, :string, :required, limit: 255
 declare_field :slug, :string, :unique, limit: 255
 end
end
```
which is equivalent to:
```ruby
module SoftDeletable
 extend ActiveSupport::Concern

 included do
 declare_schema do
 field :title, :string, :required, limit: 255
 field :slug, :string, :unique, limit: 255
 end
 end
end
```
**Note:** `declare_field` is only defined once `declare_schema` has been called at least once on the model (even with no block, e.g. bare `declare_schema`), since that's what mixes in the `DeclareSchema` class methods.

### Field (Column) Types
All of the ActiveRecord field types are supported, as returned by the database driver in use at the time.
These typically include:
Expand Down

2 changes: 1 addition & 1 deletion
lib/declare_schema/version.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module DeclareSchema
 VERSION = "4.0.2"
 VERSION = "4.0.3"
end
Loading