-
Notifications
You must be signed in to change notification settings - Fork 64
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.
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
added enum support #339
Merged
Merged
added enum support #339
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3cf7614
added enum support
confact 4c713b5
added first tests
confact 3f461da
cleaned format
confact 1ac10fe
cleaned the tests
confact 16d0947
fixed status without integers
confact 6e455fe
cleaned up the api
confact f5be3f4
cleaned up the test
confact 571ab47
show that enum methods work on wrapper class
confact File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
class CreateIssue::V20200324211956 < Avram::Migrator::Migration::V1 | ||
def migrate | ||
create table_for(Issue) do | ||
primary_key id : Int64 | ||
add status : Int32 | ||
add role : Int32 | ||
add_timestamps | ||
end | ||
end | ||
|
||
def rollback | ||
drop table_for(Issue) | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
class IssueBox < BaseBox | ||
def initialize | ||
status Issue::Status.new(:opened) | ||
role Issue::Role.new(:issue) | ||
end | ||
|
||
def build_model | ||
Issue.new( | ||
id: 123_i64, | ||
status: 0, | ||
role: 0 | ||
) | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
class Issue < BaseModel | ||
COLUMN_SQL = "issues.id, issues.status, issues.role" | ||
|
||
avram_enum Status do | ||
Opened | ||
Closed | ||
Duplicated | ||
end | ||
|
||
avram_enum Role do | ||
Issue = 1 | ||
Bug = 2 | ||
Critical = 3 | ||
end | ||
|
||
table do | ||
column status : Issue::Status | ||
column role : Issue::Role | ||
end | ||
end | ||
|
||
class IssueQuery < Issue::BaseQuery | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
require "../spec_helper" | ||
|
||
include LazyLoadHelpers | ||
|
||
describe "Enum" do | ||
it "check enum" do | ||
issue = IssueBox.create | ||
|
||
issue.status.enum.should eq(Issue::AvramStatus::Opened) | ||
issue.role.enum.should eq(Issue::AvramRole::Issue) | ||
end | ||
|
||
it "update enum" do | ||
issue = IssueBox.create | ||
|
||
updated_issue = Issue::SaveOperation.update!(issue, status: Issue::Status.new(:closed)) | ||
|
||
updated_issue.status.enum.should eq(Issue::AvramStatus::Closed) | ||
updated_issue.role.enum.should eq(Issue::AvramRole::Issue) | ||
end | ||
|
||
it "access enum methods" do | ||
issue = IssueBox.create | ||
|
||
issue.status.opened?.should eq(true) | ||
issue.status.value.should eq(0) | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
macro avram_enum(enum_name, &block) | ||
enum Avram{{ enum_name }} | ||
{{ block.body }} | ||
end | ||
|
||
class {{ enum_name }} | ||
def self.adapter | ||
Lucky | ||
end | ||
|
||
getter :enum | ||
|
||
# You may need to prefix with {{ @type }} | ||
# | ||
# {{ @type }}::{{enum_name}} | ||
def initialize(@enum : Avram{{ enum_name }}) | ||
end | ||
|
||
def initialize(enum_value : Int32) | ||
@enum = Avram{{ enum_name }}.from_value(enum_value) | ||
end | ||
|
||
def initialize(enum_value : String) | ||
@enum = Avram{{ enum_name }}.from_value(enum_value.to_i) | ||
end | ||
|
||
forward_missing_to @enum | ||
|
||
module Lucky | ||
alias ColumnType = Int32 | ||
include Avram::Type | ||
|
||
def from_db!(value : Int32) | ||
{{ enum_name }}.new(value) | ||
end | ||
|
||
def parse(value : Avram{{ enum_name }}) | ||
SuccessfulCast({{ enum_name }}).new(value) | ||
end | ||
|
||
def parse(value : String) | ||
SuccessfulCast({{ enum_name }}).new({{ enum_name }}.new(value.to_i)) | ||
end | ||
|
||
def parse(value : Int32) | ||
SuccessfulCast({{ enum_name }}).new({{ enum_name }}.new(value)) | ||
end | ||
|
||
def to_db(value : Int32) | ||
value.to_s | ||
end | ||
|
||
def to_db(value : {{ enum_name }}) | ||
value.value.to_s | ||
end | ||
|
||
class Criteria(T, V) < Int32::Lucky::Criteria(T, V) | ||
end | ||
end | ||
end | ||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could this be
Issue::Role::Issue
? This is totally fine as is Just curious if it is possible to do that with boxesThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sadly no, as the constants are inside the enum, this is the wrapper. I haven't found a way to directly use enums.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would
Issue::AvramRole::Issue
work?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thinking about this, I don't think it would work. It would end up throwing an undefined method
parse
for that enum constant. I think my only hangup was that I wasn't too keen on the interface; however, I do see why it's like this.We can probably just roll with this as is, and always change it up later if we come up with a new idea. Like
Issue::Status[:closed]
for example... This is a pretty decent start and definitely provides a lot more than what we have now. 👍