decay 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rubocop.yml +58 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +104 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/rake +18 -0
- data/bin/rubocop +18 -0
- data/bin/setup +8 -0
- data/decay.gemspec +32 -0
- data/lib/decay.rb +6 -0
- data/lib/decay/active_enum.rb +28 -0
- data/lib/decay/active_enum_attribute.rb +32 -0
- data/lib/decay/case.rb +53 -0
- data/lib/decay/enum.rb +27 -0
- data/lib/decay/enumerated_type.rb +107 -0
- data/lib/decay/error.rb +18 -0
- data/lib/decay/metaprogramming.rb +141 -0
- data/lib/decay/rails.rb +6 -0
- data/lib/decay/version.rb +3 -0
- metadata +178 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: a5f6a2bdd3149cda45df31d9846b64a15756c282
|
|
4
|
+
data.tar.gz: 87b696ec77bebb8510fdc2c9655a16f58710b19e
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: d3ed804ccc0caada77cfd96598a26617a66c426f7997d42667ef19082cd9edf3bf53984bcd5991a705b725d5d6503c132d0b7b34eff1dfe2a63e5b8cfe61873e
|
|
7
|
+
data.tar.gz: b5f82fd863632146f0ee1a99cba413fe63f74edeb4eef9d60d01ef4a926f3f389e5b559d180becb53cb439e22d779f0e3f743fb76b6c87a4e54598ef5d6d4fbc
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
AllCops:
|
|
2
|
+
DisplayCopNames: true
|
|
3
|
+
|
|
4
|
+
Bundler/OrderedGems:
|
|
5
|
+
Enabled: false
|
|
6
|
+
|
|
7
|
+
Layout/AlignParameters:
|
|
8
|
+
EnforcedStyle: with_fixed_indentation
|
|
9
|
+
|
|
10
|
+
Layout/ExtraSpacing:
|
|
11
|
+
AllowForAlignment: false
|
|
12
|
+
|
|
13
|
+
Layout/MultilineMethodCallIndentation:
|
|
14
|
+
EnforcedStyle: indented_relative_to_receiver
|
|
15
|
+
|
|
16
|
+
Layout/SpaceInLambdaLiteral:
|
|
17
|
+
EnforcedStyle: require_space
|
|
18
|
+
|
|
19
|
+
Metrics/LineLength:
|
|
20
|
+
IgnoredPatterns:
|
|
21
|
+
- !ruby/regexp /^\s*#/
|
|
22
|
+
|
|
23
|
+
Metrics/MethodLength:
|
|
24
|
+
Exclude:
|
|
25
|
+
- test/**/*_test.rb
|
|
26
|
+
|
|
27
|
+
Style/AsciiComments:
|
|
28
|
+
Enabled: false
|
|
29
|
+
|
|
30
|
+
Style/CaseEquality:
|
|
31
|
+
Enabled: false
|
|
32
|
+
|
|
33
|
+
Style/Documentation:
|
|
34
|
+
Enabled: false
|
|
35
|
+
|
|
36
|
+
Style/EmptyMethod:
|
|
37
|
+
Enabled: false
|
|
38
|
+
|
|
39
|
+
Style/FrozenStringLiteralComment:
|
|
40
|
+
Enabled: false
|
|
41
|
+
|
|
42
|
+
Style/GuardClause:
|
|
43
|
+
Enabled: false
|
|
44
|
+
|
|
45
|
+
Style/IfUnlessModifier:
|
|
46
|
+
Enabled: false
|
|
47
|
+
|
|
48
|
+
Style/NegatedIf:
|
|
49
|
+
Enabled: false
|
|
50
|
+
|
|
51
|
+
Style/StringLiterals:
|
|
52
|
+
EnforcedStyle: double_quotes
|
|
53
|
+
|
|
54
|
+
Style/StringLiteralsInInterpolation:
|
|
55
|
+
Enabled: false
|
|
56
|
+
|
|
57
|
+
Style/TrailingCommaInLiteral:
|
|
58
|
+
EnforcedStyleForMultiline: comma
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2017 Zach Ahn
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Decay
|
|
2
|
+
|
|
3
|
+
Decay is an enum library that makes sure that each case is handled.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
```ruby
|
|
10
|
+
gem "decay"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
And then execute:
|
|
14
|
+
|
|
15
|
+
$ bundle
|
|
16
|
+
|
|
17
|
+
Or install it yourself as:
|
|
18
|
+
|
|
19
|
+
$ gem install decay
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
### ActiveRecord / ActiveModel
|
|
24
|
+
|
|
25
|
+
This is only compatible with Rails versions 5.0 and up since it uses the
|
|
26
|
+
Attributes API.
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require "decay/rails"
|
|
30
|
+
|
|
31
|
+
class Order < ActiveRecord::Base
|
|
32
|
+
extend Decay::ActiveEnum
|
|
33
|
+
|
|
34
|
+
active_enum payment: %i[fully_paid void refund]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
order = Order.new
|
|
38
|
+
|
|
39
|
+
order.fully_paid!
|
|
40
|
+
order.payment # => #<Order::PAYMENT:0x007fd9c59329d8 @value=:fully_paid>
|
|
41
|
+
order.payment = Order::PAYMENT[:void]
|
|
42
|
+
order.payment = :refund
|
|
43
|
+
|
|
44
|
+
order.payment
|
|
45
|
+
.case
|
|
46
|
+
.when(:fully_paid) { do_something }
|
|
47
|
+
.when(:void) { do_something_else }
|
|
48
|
+
.when(:refund) { do_something_else_else }
|
|
49
|
+
.result
|
|
50
|
+
|
|
51
|
+
order.payment
|
|
52
|
+
.case
|
|
53
|
+
.when(:fully_paid) { do_something }
|
|
54
|
+
.result # => Raises error since there are unhandled cases
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Plain Ruby objects
|
|
58
|
+
|
|
59
|
+
```ruby
|
|
60
|
+
require "decay"
|
|
61
|
+
|
|
62
|
+
class GreenEggsAndHam
|
|
63
|
+
extend Decay::Enum
|
|
64
|
+
|
|
65
|
+
enum with: %i[mouse fox goat]
|
|
66
|
+
enum where: %i[here there house box car tree train boat]
|
|
67
|
+
enum environment: %i[dark rain]
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
guy = GreenEggsAndHam.new
|
|
71
|
+
|
|
72
|
+
guy.with = GreenEggsAndHam::WITH[:mouse]
|
|
73
|
+
guy.with.value # => :mouse
|
|
74
|
+
|
|
75
|
+
guy.where = :here
|
|
76
|
+
|
|
77
|
+
guy.where
|
|
78
|
+
.case
|
|
79
|
+
.when(:here) {}
|
|
80
|
+
# ...
|
|
81
|
+
.result
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Development
|
|
85
|
+
|
|
86
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run
|
|
87
|
+
`rake test` to run the tests. You can also run `bin/console` for an interactive
|
|
88
|
+
prompt that will allow you to experiment.
|
|
89
|
+
|
|
90
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To
|
|
91
|
+
release a new version, update the version number in `version.rb`, and then run
|
|
92
|
+
`bundle exec rake release`, which will create a git tag for the version, push
|
|
93
|
+
git commits and tags, and push the `.gem` file to
|
|
94
|
+
[rubygems.org](https://rubygems.org).
|
|
95
|
+
|
|
96
|
+
## Contributing
|
|
97
|
+
|
|
98
|
+
Bug reports and pull requests are welcome on GitHub at
|
|
99
|
+
https://github.com/zachahn/decay.
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
The gem is available as open source under the terms of the
|
|
104
|
+
[MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
require "bundler/setup"
|
|
4
|
+
require "decay"
|
|
5
|
+
|
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
|
8
|
+
|
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
|
10
|
+
# require "pry"
|
|
11
|
+
# Pry.start
|
|
12
|
+
|
|
13
|
+
require "irb"
|
|
14
|
+
IRB.start(__FILE__)
|
data/bin/rake
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
#
|
|
5
|
+
# This file was generated by Bundler.
|
|
6
|
+
#
|
|
7
|
+
# The application 'rake' is installed as part of a gem, and
|
|
8
|
+
# this file is here to facilitate running it.
|
|
9
|
+
#
|
|
10
|
+
|
|
11
|
+
require "pathname"
|
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
|
|
13
|
+
Pathname.new(__FILE__).realpath)
|
|
14
|
+
|
|
15
|
+
require "rubygems"
|
|
16
|
+
require "bundler/setup"
|
|
17
|
+
|
|
18
|
+
load Gem.bin_path("rake", "rake")
|
data/bin/rubocop
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
#
|
|
5
|
+
# This file was generated by Bundler.
|
|
6
|
+
#
|
|
7
|
+
# The application 'rubocop' is installed as part of a gem, and
|
|
8
|
+
# this file is here to facilitate running it.
|
|
9
|
+
#
|
|
10
|
+
|
|
11
|
+
require "pathname"
|
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
|
|
13
|
+
Pathname.new(__FILE__).realpath)
|
|
14
|
+
|
|
15
|
+
require "rubygems"
|
|
16
|
+
require "bundler/setup"
|
|
17
|
+
|
|
18
|
+
load Gem.bin_path("rubocop", "rubocop")
|
data/bin/setup
ADDED
data/decay.gemspec
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
lib = File.expand_path("../lib", __FILE__)
|
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
5
|
+
require "decay/version"
|
|
6
|
+
|
|
7
|
+
Gem::Specification.new do |spec|
|
|
8
|
+
spec.name = "decay"
|
|
9
|
+
spec.version = Decay::VERSION
|
|
10
|
+
spec.authors = ["Zach Ahn"]
|
|
11
|
+
spec.email = ["engineering@zachahn.com"]
|
|
12
|
+
|
|
13
|
+
spec.summary = "Safe enums, inspired by Rust"
|
|
14
|
+
spec.description = "Ensure that all values in an enum are covered"
|
|
15
|
+
spec.license = "MIT"
|
|
16
|
+
|
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
|
19
|
+
end
|
|
20
|
+
spec.bindir = "exe"
|
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
|
22
|
+
spec.require_paths = ["lib"]
|
|
23
|
+
|
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.15"
|
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
|
26
|
+
spec.add_development_dependency "minitest", "~> 5.0"
|
|
27
|
+
spec.add_development_dependency "rubocop"
|
|
28
|
+
spec.add_development_dependency "pry-byebug"
|
|
29
|
+
spec.add_development_dependency "activerecord"
|
|
30
|
+
spec.add_development_dependency "activemodel"
|
|
31
|
+
spec.add_development_dependency "sqlite3"
|
|
32
|
+
end
|
data/lib/decay.rb
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
module ActiveEnum
|
|
3
|
+
def active_enum(**rules)
|
|
4
|
+
rules.each do |enum_name, enum_values|
|
|
5
|
+
enumerated_type_class =
|
|
6
|
+
if enum_values.is_a?(Hash)
|
|
7
|
+
::Decay::EnumeratedType.create(nil, **enum_values)
|
|
8
|
+
else
|
|
9
|
+
::Decay::EnumeratedType.create(nil, *enum_values)
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
meta = Decay::Metaprogramming.new(
|
|
13
|
+
class: self,
|
|
14
|
+
enumerated_type: enumerated_type_class,
|
|
15
|
+
enumerated_type_name: enum_name
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
meta.define_enumerated_type
|
|
19
|
+
|
|
20
|
+
meta.define_active_record_attribute
|
|
21
|
+
meta.define_active_record_bang_setters
|
|
22
|
+
meta.define_active_record_question_getters
|
|
23
|
+
|
|
24
|
+
meta.define_active_record_scopes
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
class ActiveEnumAttribute < ::ActiveModel::Type::Value
|
|
3
|
+
def initialize(enum:)
|
|
4
|
+
@enum = enum
|
|
5
|
+
end
|
|
6
|
+
|
|
7
|
+
# User input
|
|
8
|
+
def cast(value)
|
|
9
|
+
if value.is_a?(Decay::EnumeratedType)
|
|
10
|
+
value
|
|
11
|
+
elsif value.respond_to?(:to_sym)
|
|
12
|
+
@enum[value.to_sym]
|
|
13
|
+
else
|
|
14
|
+
@enum[value]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
# Ruby => Database
|
|
19
|
+
def serialize(value)
|
|
20
|
+
if value.respond_to?(:value)
|
|
21
|
+
value.value
|
|
22
|
+
else
|
|
23
|
+
value
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Database => Ruby
|
|
28
|
+
def deserialize(value)
|
|
29
|
+
@enum[@enum.key_for(value)]
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
data/lib/decay/case.rb
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
class Case
|
|
3
|
+
def initialize(enum_class, member)
|
|
4
|
+
@enum_class = enum_class
|
|
5
|
+
@member = member
|
|
6
|
+
@whens = {}
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
def when(key, &block)
|
|
10
|
+
if @enum_class.keys.include?(key)
|
|
11
|
+
@whens[key] = block
|
|
12
|
+
else
|
|
13
|
+
raise_unknown_key
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
self
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def else(&block)
|
|
20
|
+
@enum_class.keys.each do |key|
|
|
21
|
+
if !@whens.key?(key)
|
|
22
|
+
@whens[key] = block
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
self
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def result
|
|
30
|
+
if @whens.keys.size != @enum_class.keys.size
|
|
31
|
+
undefined_cases =
|
|
32
|
+
(@whens.keys - @enum_class.keys)
|
|
33
|
+
.map(&:inspect).map { |str| "`#{str}'" }
|
|
34
|
+
|
|
35
|
+
raise Error::UndefinedCase,
|
|
36
|
+
"Some cases aren't yet covered: #{undefined_cases.join(", ")}"
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
if @whens.key?(@member.key)
|
|
40
|
+
@whens[@member.key].call(@member)
|
|
41
|
+
else
|
|
42
|
+
raise_unknown_key
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
def raise_unknown_key
|
|
47
|
+
valid_keys = @enum_class.keys.map(&:inspect).map { |str| "`#{str}'" }
|
|
48
|
+
raise Error::UnknownKey,
|
|
49
|
+
"Attempted to search for unknown key `#{@member.value.inspect}'. " \
|
|
50
|
+
"Valid options are #{valid_keys.join(", ")}"
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
data/lib/decay/enum.rb
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
module Enum
|
|
3
|
+
# rubocop:disable Metrics/MethodLength
|
|
4
|
+
def enum(**rules)
|
|
5
|
+
rules.each do |enum_name, enum_values|
|
|
6
|
+
enumerated_type_class =
|
|
7
|
+
if enum_values.is_a?(Hash)
|
|
8
|
+
::Decay::EnumeratedType.create(**enum_values)
|
|
9
|
+
else
|
|
10
|
+
::Decay::EnumeratedType.create(*enum_values)
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
meta = Metaprogramming.new(
|
|
14
|
+
class: self,
|
|
15
|
+
enumerated_type: enumerated_type_class,
|
|
16
|
+
enumerated_type_name: enum_name
|
|
17
|
+
)
|
|
18
|
+
|
|
19
|
+
meta.define_enumerated_type
|
|
20
|
+
|
|
21
|
+
meta.define_getter
|
|
22
|
+
meta.define_setter
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
# rubocop:enable Metrics/MethodLength
|
|
26
|
+
end
|
|
27
|
+
end
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
class EnumeratedType
|
|
3
|
+
class << self
|
|
4
|
+
def create(*definitions)
|
|
5
|
+
type = Class.new(self)
|
|
6
|
+
|
|
7
|
+
definitions.each do |definition|
|
|
8
|
+
if definition.respond_to?(:keys)
|
|
9
|
+
definition.each do |key, value|
|
|
10
|
+
type[normalized(key)] = value
|
|
11
|
+
end
|
|
12
|
+
elsif definition.respond_to?(:each)
|
|
13
|
+
definition.each do |key|
|
|
14
|
+
type[normalized(key)] = normalized(key)
|
|
15
|
+
end
|
|
16
|
+
else
|
|
17
|
+
type[normalized(definition)] = normalized(definition)
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
type.freeze
|
|
22
|
+
|
|
23
|
+
type
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def []=(key, value)
|
|
27
|
+
if registry.frozen?
|
|
28
|
+
raise Error::CantDefineEnumAtRuntime, \
|
|
29
|
+
"New values can only be created on Enum creation"
|
|
30
|
+
elsif registry.key?(key)
|
|
31
|
+
raise Error::DuplicateEnum, "Attempted to re-define `#{key.inspect}'"
|
|
32
|
+
else
|
|
33
|
+
registry[key] = new(key, value)
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def [](key)
|
|
38
|
+
if registry.key?(key)
|
|
39
|
+
registry[key]
|
|
40
|
+
else
|
|
41
|
+
valid_keys = registry.keys.map(&:inspect).map { |str| "`#{str}'" }
|
|
42
|
+
raise Error::UnknownKey,
|
|
43
|
+
"Attempted to search for unknown key `#{key.inspect}'. " \
|
|
44
|
+
"Valid options are #{valid_keys.join(", ")}"
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def keys
|
|
49
|
+
registry.keys
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
def key_for(value)
|
|
53
|
+
if value.is_a?(EnumeratedType)
|
|
54
|
+
registry.invert[value]
|
|
55
|
+
else
|
|
56
|
+
raw_value = registry.map { |k, v| [k, v.value] }.to_h
|
|
57
|
+
raw_value.invert[value]
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
def members
|
|
62
|
+
registry.values
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
def freeze
|
|
66
|
+
registry.freeze
|
|
67
|
+
super
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
def each
|
|
71
|
+
if !block_given?
|
|
72
|
+
return enum_for(:each)
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
registry.each do |key, value|
|
|
76
|
+
yield key, value
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
private
|
|
81
|
+
|
|
82
|
+
def registry
|
|
83
|
+
@registry ||= {}
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
def normalized(value)
|
|
87
|
+
if value.respond_to?(:to_sym)
|
|
88
|
+
value.to_sym
|
|
89
|
+
else
|
|
90
|
+
value
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
def initialize(key, value)
|
|
96
|
+
@key = key
|
|
97
|
+
@value = value
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
attr_reader :key
|
|
101
|
+
attr_reader :value
|
|
102
|
+
|
|
103
|
+
def case
|
|
104
|
+
Case.new(self.class, self)
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
end
|
data/lib/decay/error.rb
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
class Error < StandardError
|
|
3
|
+
class UnknownKey < Error
|
|
4
|
+
end
|
|
5
|
+
|
|
6
|
+
class UndefinedCase < Error
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
class CantDefineEnumAtRuntime < Error
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
class EnumConflict < Error
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
class DuplicateEnum < Error
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
module Decay
|
|
2
|
+
class Metaprogramming
|
|
3
|
+
def initialize(class:, enumerated_type:, enumerated_type_name:)
|
|
4
|
+
@klass = binding.local_variable_get(:class)
|
|
5
|
+
@enumerated_type = enumerated_type
|
|
6
|
+
@enumerated_type_name = enumerated_type_name
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
def define_enumerated_type
|
|
10
|
+
@klass.const_set(@enumerated_type_name.to_s.upcase, @enumerated_type)
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
def define_getter
|
|
14
|
+
enumerated_type_name = @enumerated_type_name
|
|
15
|
+
|
|
16
|
+
assert_instance_conflict_free(enumerated_type_name)
|
|
17
|
+
@klass.send(:define_method, enumerated_type_name) do
|
|
18
|
+
instance_variable_get("@#{enumerated_type_name}")
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
def define_setter
|
|
23
|
+
enumerated_type = @enumerated_type
|
|
24
|
+
enumerated_type_name = @enumerated_type_name
|
|
25
|
+
|
|
26
|
+
assert_instance_conflict_free("#{enumerated_type_name}=")
|
|
27
|
+
@klass.send(:define_method, "#{enumerated_type_name}=") do |new_value|
|
|
28
|
+
value =
|
|
29
|
+
if new_value.respond_to?(:to_sym)
|
|
30
|
+
new_value.to_sym
|
|
31
|
+
else
|
|
32
|
+
new_value
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
enum = enumerated_type[value]
|
|
36
|
+
|
|
37
|
+
instance_variable_set("@#{enumerated_type_name}", enum)
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
def define_bang_setters
|
|
42
|
+
enumerated_type_name = @enumerated_type_name
|
|
43
|
+
|
|
44
|
+
@enumerated_type.each do |key, value|
|
|
45
|
+
if key.nil?
|
|
46
|
+
next
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
assert_instance_conflict_free("#{key}!")
|
|
50
|
+
@klass.send(:define_method, "#{key}!") do
|
|
51
|
+
instance_variable_set("@#{enumerated_type_name}", value)
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
def define_question_getters
|
|
57
|
+
enumerated_type_name = @enumerated_type_name
|
|
58
|
+
|
|
59
|
+
@enumerated_type.each do |key, value|
|
|
60
|
+
if key.nil?
|
|
61
|
+
next
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
assert_instance_conflict_free("#{key}?")
|
|
65
|
+
@klass.send(:define_method, "#{key}?") do
|
|
66
|
+
instance_variable_get("@#{enumerated_type_name}") == value
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def define_active_record_attribute
|
|
72
|
+
@klass.attribute @enumerated_type_name, \
|
|
73
|
+
Decay::ActiveEnumAttribute.new(enum: @enumerated_type)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
def define_active_record_bang_setters
|
|
77
|
+
enumerated_type_name = @enumerated_type_name
|
|
78
|
+
|
|
79
|
+
@enumerated_type.each do |key, _value|
|
|
80
|
+
if key.nil?
|
|
81
|
+
next
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
assert_instance_conflict_free("#{key}!")
|
|
85
|
+
@klass.send(:define_method, "#{key}!") do
|
|
86
|
+
send("#{enumerated_type_name}=", key)
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
def define_active_record_question_getters
|
|
92
|
+
enumerated_type_name = @enumerated_type_name
|
|
93
|
+
|
|
94
|
+
@enumerated_type.each do |key, value|
|
|
95
|
+
if key.nil?
|
|
96
|
+
next
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
assert_instance_conflict_free("#{key}?")
|
|
100
|
+
@klass.send(:define_method, "#{key}?") do
|
|
101
|
+
send(enumerated_type_name) == value
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
def define_active_record_scopes
|
|
107
|
+
enumerated_type_name = @enumerated_type_name
|
|
108
|
+
|
|
109
|
+
@enumerated_type.each do |key, value|
|
|
110
|
+
if key
|
|
111
|
+
assert_scope_conflict_free(key)
|
|
112
|
+
@klass.scope key, -> { where(enumerated_type_name => value.value) }
|
|
113
|
+
end
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
private
|
|
118
|
+
|
|
119
|
+
def assert_instance_conflict_free(method_name)
|
|
120
|
+
if @klass.instance_methods.include?(method_name.to_sym)
|
|
121
|
+
previously_defined_method = @klass.instance_method(method_name)
|
|
122
|
+
filename, lineno = previously_defined_method.source_location
|
|
123
|
+
|
|
124
|
+
raise Error::EnumConflict, \
|
|
125
|
+
"Instance method `#{method_name}` was previously defined " \
|
|
126
|
+
"in #{filename}:#{lineno}"
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
def assert_scope_conflict_free(method_name)
|
|
131
|
+
if @klass.methods.include?(method_name.to_sym)
|
|
132
|
+
previously_defined_method = @klass.method(method_name)
|
|
133
|
+
filename, lineno = previously_defined_method.source_location
|
|
134
|
+
|
|
135
|
+
raise Error::EnumConflict, \
|
|
136
|
+
"Scope `#{method_name}` was previously defined " \
|
|
137
|
+
"in #{filename}:#{lineno}"
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
data/lib/decay/rails.rb
ADDED
metadata
ADDED
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: decay
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.3.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Zach Ahn
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: exe
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2017-06-08 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: bundler
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '1.15'
|
|
20
|
+
type: :development
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '1.15'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: rake
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '10.0'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '10.0'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: minitest
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '5.0'
|
|
48
|
+
type: :development
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '5.0'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: rubocop
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - ">="
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '0'
|
|
62
|
+
type: :development
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - ">="
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '0'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: pry-byebug
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - ">="
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '0'
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - ">="
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '0'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: activerecord
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - ">="
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '0'
|
|
90
|
+
type: :development
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - ">="
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '0'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: activemodel
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - ">="
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '0'
|
|
104
|
+
type: :development
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - ">="
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: '0'
|
|
111
|
+
- !ruby/object:Gem::Dependency
|
|
112
|
+
name: sqlite3
|
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
|
114
|
+
requirements:
|
|
115
|
+
- - ">="
|
|
116
|
+
- !ruby/object:Gem::Version
|
|
117
|
+
version: '0'
|
|
118
|
+
type: :development
|
|
119
|
+
prerelease: false
|
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - ">="
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: '0'
|
|
125
|
+
description: Ensure that all values in an enum are covered
|
|
126
|
+
email:
|
|
127
|
+
- engineering@zachahn.com
|
|
128
|
+
executables: []
|
|
129
|
+
extensions: []
|
|
130
|
+
extra_rdoc_files: []
|
|
131
|
+
files:
|
|
132
|
+
- ".gitignore"
|
|
133
|
+
- ".rubocop.yml"
|
|
134
|
+
- ".travis.yml"
|
|
135
|
+
- Gemfile
|
|
136
|
+
- LICENSE.txt
|
|
137
|
+
- README.md
|
|
138
|
+
- Rakefile
|
|
139
|
+
- bin/console
|
|
140
|
+
- bin/rake
|
|
141
|
+
- bin/rubocop
|
|
142
|
+
- bin/setup
|
|
143
|
+
- decay.gemspec
|
|
144
|
+
- lib/decay.rb
|
|
145
|
+
- lib/decay/active_enum.rb
|
|
146
|
+
- lib/decay/active_enum_attribute.rb
|
|
147
|
+
- lib/decay/case.rb
|
|
148
|
+
- lib/decay/enum.rb
|
|
149
|
+
- lib/decay/enumerated_type.rb
|
|
150
|
+
- lib/decay/error.rb
|
|
151
|
+
- lib/decay/metaprogramming.rb
|
|
152
|
+
- lib/decay/rails.rb
|
|
153
|
+
- lib/decay/version.rb
|
|
154
|
+
homepage:
|
|
155
|
+
licenses:
|
|
156
|
+
- MIT
|
|
157
|
+
metadata: {}
|
|
158
|
+
post_install_message:
|
|
159
|
+
rdoc_options: []
|
|
160
|
+
require_paths:
|
|
161
|
+
- lib
|
|
162
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
163
|
+
requirements:
|
|
164
|
+
- - ">="
|
|
165
|
+
- !ruby/object:Gem::Version
|
|
166
|
+
version: '0'
|
|
167
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
168
|
+
requirements:
|
|
169
|
+
- - ">="
|
|
170
|
+
- !ruby/object:Gem::Version
|
|
171
|
+
version: '0'
|
|
172
|
+
requirements: []
|
|
173
|
+
rubyforge_project:
|
|
174
|
+
rubygems_version: 2.6.8
|
|
175
|
+
signing_key:
|
|
176
|
+
specification_version: 4
|
|
177
|
+
summary: Safe enums, inspired by Rust
|
|
178
|
+
test_files: []
|