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.

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 8 commits into from
May 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions db/migrations/20200324211956_create_issue.cr
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
14 changes: 14 additions & 0 deletions spec/support/boxes/issue_box.cr
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)
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
Issue.new(
id: 123_i64,
status: 0,
role: 0
)
end
end
23 changes: 23 additions & 0 deletions spec/support/issue.cr
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
28 changes: 28 additions & 0 deletions spec/type_extensions/enum_spec.cr
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
61 changes: 61 additions & 0 deletions src/avram/charms/enum_extensions.cr
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