attr_enum_accessor 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/Guardfile +10 -0
- data/LICENSE.txt +22 -0
- data/README.md +65 -0
- data/Rakefile +29 -0
- data/attr_enum_accessor.gemspec +28 -0
- data/lib/attr_enum_accessor.rb +63 -0
- data/lib/attr_enum_accessor/version.rb +3 -0
- data/test/attr_enum_accessor_test.rb +46 -0
- data/test/test_base_model.rb +23 -0
- data/test/test_helper.rb +11 -0
- metadata +145 -0
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Guardfile
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# A sample Guardfile
|
2
|
+
# More info at https://github.com/guard/guard#readme
|
3
|
+
|
4
|
+
guard :test do
|
5
|
+
watch(%r{^test/.+_test\.rb$})
|
6
|
+
watch('test/test_helper.rb') { "test" }
|
7
|
+
|
8
|
+
watch(%r{^app/models/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
|
9
|
+
watch(%r{^app/validators/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
|
10
|
+
end
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Venture Media Labs Inc.
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
# AttrEnumAccessor
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/gshaw/attr_enum_accessor.png?branch=master)](https://travis-ci.org/gshaw/attr_enum_accessor)
|
4
|
+
[![Gem Version](https://badge.fury.io/rb/attr_enum_accessor.png)](http://badge.fury.io/rb/attr_enum_accessor)
|
5
|
+
|
6
|
+
Store enumerated attributes in your database as integers while using type
|
7
|
+
checked symbols in code.
|
8
|
+
|
9
|
+
[RubyDoc Documentation](http://rubydoc.info/github/gshaw/attr_enum_accessor/master/frames)
|
10
|
+
|
11
|
+
## Usage
|
12
|
+
|
13
|
+
Create integer columsn with `_value` suffix to store enumerated attribute values.
|
14
|
+
|
15
|
+
class CreateUsers < ActiveRecord::Migration
|
16
|
+
def change
|
17
|
+
create_table :users do |t|
|
18
|
+
t.string :email, null: false
|
19
|
+
t.string :password_digest
|
20
|
+
t.integer :role_value, null: false, default: 0
|
21
|
+
t.timestamps
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
Create a hash in your model to map symbols to enumerated attribute values.
|
27
|
+
|
28
|
+
class User < ActiveRecord::Base
|
29
|
+
ROLE = {
|
30
|
+
user: 0,
|
31
|
+
admin: 1,
|
32
|
+
}
|
33
|
+
|
34
|
+
include AttrEnumAccessor
|
35
|
+
attr_enum_accessor :role, with: ROLE
|
36
|
+
end
|
37
|
+
|
38
|
+
Access your enumerated values using symbols.
|
39
|
+
|
40
|
+
u = User.new
|
41
|
+
u.role = :admin
|
42
|
+
puts u.role_value
|
43
|
+
|
44
|
+
# throws exception
|
45
|
+
u.role = :unknown_role
|
46
|
+
|
47
|
+
puts User.where_role(:admin).count
|
48
|
+
|
49
|
+
## Installation
|
50
|
+
|
51
|
+
Add this line to your application's Gemfile:
|
52
|
+
|
53
|
+
gem 'attr_enum_accessor'
|
54
|
+
|
55
|
+
And then execute:
|
56
|
+
|
57
|
+
$ bundle
|
58
|
+
|
59
|
+
## Contributing
|
60
|
+
|
61
|
+
1. Fork it
|
62
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
63
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
64
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
65
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
begin
|
3
|
+
require 'bundler/setup'
|
4
|
+
require 'bundler/gem_tasks'
|
5
|
+
rescue LoadError
|
6
|
+
raise 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
7
|
+
end
|
8
|
+
|
9
|
+
require 'rdoc/task'
|
10
|
+
|
11
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
12
|
+
rdoc.rdoc_dir = 'rdoc'
|
13
|
+
rdoc.title = 'AttrEnumAccessor'
|
14
|
+
rdoc.options << '--line-numbers'
|
15
|
+
rdoc_main = 'README.md'
|
16
|
+
rdoc.rdoc_files.include('README.md')
|
17
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
18
|
+
end
|
19
|
+
|
20
|
+
require 'rake/testtask'
|
21
|
+
|
22
|
+
Rake::TestTask.new(:test) do |t|
|
23
|
+
t.libs << 'lib'
|
24
|
+
t.libs << 'test'
|
25
|
+
t.pattern = 'test/**/*_test.rb'
|
26
|
+
t.verbose = false
|
27
|
+
end
|
28
|
+
|
29
|
+
task :default => :test
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'attr_enum_accessor/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "attr_enum_accessor"
|
8
|
+
spec.version = AttrEnumAccessor::VERSION
|
9
|
+
spec.authors = ["Gerry Shaw"]
|
10
|
+
spec.email = ["gshaw@reinvent.com"]
|
11
|
+
spec.summary = %q{Enumerated fields stored using integers}
|
12
|
+
spec.homepage = "https://github.com/gshaw/attr_enum_accessor"
|
13
|
+
spec.license = "MIT"
|
14
|
+
|
15
|
+
spec.files = `git ls-files`.split($/)
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.required_ruby_version = ">= 1.9"
|
21
|
+
|
22
|
+
spec.add_dependency "activesupport", "~> 3.2"
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
25
|
+
spec.add_development_dependency "rake"
|
26
|
+
spec.add_development_dependency "test-unit"
|
27
|
+
spec.add_development_dependency "guard-test"
|
28
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# Provides a method to allow models to access enumerated values
|
2
|
+
module AttrEnumAccessor
|
3
|
+
extend ActiveSupport::Concern
|
4
|
+
|
5
|
+
module ClassMethods
|
6
|
+
# Provides easy accessors for enumerated fields stored as integers in database.
|
7
|
+
#
|
8
|
+
# Requires a column in the model to have :name_value (override with `:value_column` option)
|
9
|
+
#
|
10
|
+
# Example:
|
11
|
+
#
|
12
|
+
# class User < ActiveRecord::Base
|
13
|
+
# ROLE = {
|
14
|
+
# user: 1,
|
15
|
+
# editor: 2,
|
16
|
+
# admin: 3
|
17
|
+
# }
|
18
|
+
#
|
19
|
+
# include AttrEnumAccessor
|
20
|
+
# attr_enum_accessor :role, with: ROLE
|
21
|
+
# attr_enum_accessor :status, with: STATUS, value_column: :status_number, exclude_scope: true
|
22
|
+
#
|
23
|
+
# end
|
24
|
+
#
|
25
|
+
# u = User.new
|
26
|
+
# u.role = :admin
|
27
|
+
# u.role # => :admin
|
28
|
+
# u.role_value # => 3
|
29
|
+
#
|
30
|
+
# User.where_role(:admin).count # all admins
|
31
|
+
# User.where_role([:editor, :admin]).count # all editors and admins
|
32
|
+
# User.where_role(ROLE.keys - [:admin]).count # all except admins
|
33
|
+
#
|
34
|
+
# User.role_to_value(:admin) # => 3
|
35
|
+
# User.role_to_value([:editor, :admin]) # => [2, 3]
|
36
|
+
#
|
37
|
+
def attr_enum_accessor(enum_attribute, options = {})
|
38
|
+
enum_values = options[:with]
|
39
|
+
value_column = options[:value_column] || :"#{enum_attribute}_value"
|
40
|
+
raise ArgumentError.new("Required option `with` must be a Hash") unless enum_values.kind_of?(Hash)
|
41
|
+
|
42
|
+
define_singleton_method(:"#{enum_attribute}_to_value") do |value|
|
43
|
+
values = Array(value).flatten.map do |value|
|
44
|
+
enum_values[value.to_sym] or raise ArgumentError.new("Invalid #{enum_attribute} `#{value}`")
|
45
|
+
end
|
46
|
+
values.count == 1 ? values.first : values
|
47
|
+
end
|
48
|
+
|
49
|
+
define_singleton_method(:"where_#{enum_attribute}") do |value|
|
50
|
+
values = send(:"#{enum_attribute}_to_value", value)
|
51
|
+
where(value_column => values)
|
52
|
+
end unless options[:exclude_scope]
|
53
|
+
|
54
|
+
define_method(enum_attribute) do
|
55
|
+
enum_values.key(read_attribute(value_column))
|
56
|
+
end
|
57
|
+
|
58
|
+
define_method(:"#{enum_attribute}=") do |value|
|
59
|
+
write_attribute(value_column, self.class.send(:"#{enum_attribute}_to_value", value))
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
class User < TestBaseModel
|
4
|
+
ROLE = {
|
5
|
+
user: 1,
|
6
|
+
admin: 2,
|
7
|
+
}
|
8
|
+
|
9
|
+
include AttrEnumAccessor
|
10
|
+
attr_enum_accessor :role, with: ROLE
|
11
|
+
end
|
12
|
+
|
13
|
+
class AttrEnumAccessorTest < ActiveSupport::TestCase
|
14
|
+
test "role_to_value" do
|
15
|
+
assert_equal 1, User.role_to_value(:user)
|
16
|
+
assert_equal 2, User.role_to_value(:admin)
|
17
|
+
end
|
18
|
+
|
19
|
+
test "accessors" do
|
20
|
+
u = User.new
|
21
|
+
u.role = :admin
|
22
|
+
assert_equal :admin, u.role
|
23
|
+
assert_equal 2, u.read_attribute(:role_value)
|
24
|
+
|
25
|
+
u.write_attribute(:role_value, 1)
|
26
|
+
assert_equal :user, u.role
|
27
|
+
end
|
28
|
+
|
29
|
+
test "raise error on invalid value" do
|
30
|
+
begin
|
31
|
+
u = User.new
|
32
|
+
u.role = :unknown
|
33
|
+
assert false, "should have thrown error"
|
34
|
+
rescue ArgumentError => ex
|
35
|
+
assert_equal "Invalid role `unknown`", ex.to_s
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
test "where helper" do
|
40
|
+
User.where_role(:admin)
|
41
|
+
assert_equal User.where_options, { role_value: 2 }
|
42
|
+
|
43
|
+
User.where_role([:user, :admin])
|
44
|
+
assert_equal User.where_options, { role_value: [1, 2] }
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
class TestBaseModel
|
2
|
+
attr_accessor :column_values
|
3
|
+
|
4
|
+
def initialize
|
5
|
+
@column_values = {}
|
6
|
+
end
|
7
|
+
|
8
|
+
def read_attribute(column_name)
|
9
|
+
@column_values[column_name.to_sym]
|
10
|
+
end
|
11
|
+
|
12
|
+
def write_attribute(column_name, value)
|
13
|
+
@column_values[column_name.to_sym] = value
|
14
|
+
end
|
15
|
+
|
16
|
+
def self.where(options = {})
|
17
|
+
@@where_options = options
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.where_options
|
21
|
+
@@where_options
|
22
|
+
end
|
23
|
+
end
|
data/test/test_helper.rb
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# Configure Rails Environment
|
2
|
+
ENV["RAILS_ENV"] = "test"
|
3
|
+
|
4
|
+
require 'test/unit'
|
5
|
+
require 'active_support'
|
6
|
+
require 'test_base_model'
|
7
|
+
|
8
|
+
require 'attr_enum_accessor'
|
9
|
+
|
10
|
+
# Load support files
|
11
|
+
Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
|
metadata
ADDED
@@ -0,0 +1,145 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: attr_enum_accessor
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Gerry Shaw
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-07-25 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: activesupport
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '3.2'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '3.2'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: bundler
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ~>
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '1.3'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '1.3'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: rake
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: test-unit
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ! '>='
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
type: :development
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ! '>='
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
- !ruby/object:Gem::Dependency
|
79
|
+
name: guard-test
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
81
|
+
none: false
|
82
|
+
requirements:
|
83
|
+
- - ! '>='
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
type: :development
|
87
|
+
prerelease: false
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ! '>='
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '0'
|
94
|
+
description:
|
95
|
+
email:
|
96
|
+
- gshaw@reinvent.com
|
97
|
+
executables: []
|
98
|
+
extensions: []
|
99
|
+
extra_rdoc_files: []
|
100
|
+
files:
|
101
|
+
- .gitignore
|
102
|
+
- .travis.yml
|
103
|
+
- Gemfile
|
104
|
+
- Guardfile
|
105
|
+
- LICENSE.txt
|
106
|
+
- README.md
|
107
|
+
- Rakefile
|
108
|
+
- attr_enum_accessor.gemspec
|
109
|
+
- lib/attr_enum_accessor.rb
|
110
|
+
- lib/attr_enum_accessor/version.rb
|
111
|
+
- test/attr_enum_accessor_test.rb
|
112
|
+
- test/test_base_model.rb
|
113
|
+
- test/test_helper.rb
|
114
|
+
homepage: https://github.com/gshaw/attr_enum_accessor
|
115
|
+
licenses:
|
116
|
+
- MIT
|
117
|
+
post_install_message:
|
118
|
+
rdoc_options: []
|
119
|
+
require_paths:
|
120
|
+
- lib
|
121
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
122
|
+
none: false
|
123
|
+
requirements:
|
124
|
+
- - ! '>='
|
125
|
+
- !ruby/object:Gem::Version
|
126
|
+
version: '1.9'
|
127
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
128
|
+
none: false
|
129
|
+
requirements:
|
130
|
+
- - ! '>='
|
131
|
+
- !ruby/object:Gem::Version
|
132
|
+
version: '0'
|
133
|
+
segments:
|
134
|
+
- 0
|
135
|
+
hash: 1587781763028525838
|
136
|
+
requirements: []
|
137
|
+
rubyforge_project:
|
138
|
+
rubygems_version: 1.8.23
|
139
|
+
signing_key:
|
140
|
+
specification_version: 3
|
141
|
+
summary: Enumerated fields stored using integers
|
142
|
+
test_files:
|
143
|
+
- test/attr_enum_accessor_test.rb
|
144
|
+
- test/test_base_model.rb
|
145
|
+
- test/test_helper.rb
|