Skip to content
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

Jump to bottom

added enum support #339

Merged
merged 8 commits into from
May 11, 2020
Merged

added enum support #339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3cf7614
added enum support
confact Mar 24, 2020
4c713b5
added first tests
confact Mar 24, 2020
3f461da
cleaned format
confact Mar 24, 2020
1ac10fe
cleaned the tests
confact Mar 25, 2020
16d0947
fixed status without integers
confact Mar 25, 2020
6e455fe
cleaned up the api
confact May 7, 2020
f5be3f4
cleaned up the test
confact May 7, 2020
571ab47
show that enum methods work on wrapper class
confact May 8, 2020
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: 2 additions & 2 deletions spec/support/boxes/issue_box.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
class IssueBox < BaseBox
def initialize
status Issue::AvramStatus.new(:opened)
role Issue::AvramRole.new(:issue)
status Issue::Status.new(:opened)
role Issue::Role.new(:issue)
Copy link
Member

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 boxes

Copy link
Contributor Author

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.

Copy link
Member

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?

Copy link
Member

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. 👍

end

def build_model
Expand Down
4 changes: 2 additions & 2 deletions spec/support/issue.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ class Issue < BaseModel
end

table do
column status : Issue::AvramStatus
column role : Issue::AvramRole
column status : Issue::Status
column role : Issue::Role
end
end

Expand Down
10 changes: 5 additions & 5 deletions spec/type_extensions/enum_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ describe "Enum" do
it "check enum" do
issue = IssueBox.create

issue.status.value.should eq(Issue::Status::Opened)
issue.role.value.should eq(Issue::Role::Issue)
issue.status.value.should eq(Issue::AvramStatus::Opened)
issue.role.value.should eq(Issue::AvramRole::Issue)
end

it "update enum" do
issue = IssueBox.create

updated_issue = Issue::SaveOperation.update!(issue, status: Issue::AvramStatus.new(:closed))
updated_issue = Issue::SaveOperation.update!(issue, status: Issue::Status.new(:closed))

updated_issue.status.value.should eq(Issue::Status::Closed)
updated_issue.role.value.should eq(Issue::Role::Issue)
updated_issue.status.value.should eq(Issue::AvramStatus::Closed)
updated_issue.role.value.should eq(Issue::AvramRole::Issue)
end
end
34 changes: 12 additions & 22 deletions src/avram/charms/enum.cr → src/avram/charms/enum_extensions.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,55 @@
macro avram_enum(enum_name, &block)
enum {{ enum_name }}
enum Avram{{ enum_name }}
{{ block.body }}
end

class Avram{{ enum_name }}
class {{ enum_name }}
def self.adapter
Lucky
end

# You may need to prefix with {{ @type }}
#
# {{ @type }}::{{enum_name}}
def initialize(@enum : {{ enum_name }})
def initialize(@enum : Avram{{ enum_name }})
end

def initialize(enum_value : Int32)
@enum = {{ enum_name }}.from_value(enum_value)
@enum = Avram{{ enum_name }}.from_value(enum_value)
end

def initialize(enum_value : String)
@enum = {{ enum_name }}.from_value(enum_value.to_i)
@enum = Avram{{ enum_name }}.from_value(enum_value.to_i)
end

def to_s
@enum.to_s
end

def value
@enum
end

def blank?
@enum.nil?
end
forward_missing_to @enum

module Lucky
alias ColumnType = Int32
include Avram::Type

def from_db!(value : Int32)
Avram{{ enum_name }}.new(value)
{{ enum_name }}.new(value)
end

def parse(value : Avram{{ enum_name }})
SuccessfulCast(Avram{{ enum_name }}).new(value)
SuccessfulCast({{ enum_name }}).new(value)
end

def parse(value : String)
SuccessfulCast(Avram{{ enum_name }}).new(Avram{{ enum_name }}.new(value.to_i))
SuccessfulCast({{ enum_name }}).new({{ enum_name }}.new(value.to_i))
end

def parse(value : Int32)
SuccessfulCast(Avram{{ enum_name }}).new(Avram{{ enum_name }}.new(value))
SuccessfulCast({{ enum_name }}).new({{ enum_name }}.new(value))
end

def to_db(value : Int32)
value.to_s
end

def to_db(value : Avram{{ enum_name }})
value.value.value.to_s
def to_db(value : {{ enum_name }})
value.value.to_s
end

class Criteria(T, V) < Int32::Lucky::Criteria(T, V)
Expand Down