enum_set 0.0.1

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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 85f894002f4a10378eeb69ff3307fd5c80414ba7
4
+ data.tar.gz: 98146508dc10a69f77e68ed56e3da0252e2e5529
5
+ SHA512:
6
+ metadata.gz: d5cd14abb906d62108260ec2bb91438c19e809745020953a5b3c3be98048beebd16496aff483d3a046c783f3aaa0a1cd4d957c3885f56e3a9499839944ff5676
7
+ data.tar.gz: bc772f63b1ad9e934f9abbae2b1003a5ce6882cd2a3c8ac066e46124e79c0756680dd109cecda4f9a381a607201ff286d23e12e15421cf03aca660849f55699f
data/.gitignore ADDED
@@ -0,0 +1,22 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ *.bundle
19
+ *.so
20
+ *.o
21
+ *.a
22
+ mkmf.log
data/.travis.yml ADDED
@@ -0,0 +1,6 @@
1
+ cache: bundler
2
+ language: ruby
3
+ rvm:
4
+ - 2.1.2
5
+ script:
6
+ - bundle exec rspec --format progress
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in enum_set.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Bree Stanwyck
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,42 @@
1
+ [![Build Status](https://travis-ci.org/breestanwyck/enum_set.svg?branch=master)](https://travis-ci.org/breestanwyck/enum_set)
2
+
3
+ # EnumSet
4
+
5
+ `enum_set` is a gem for treating integer columns as a compact set of boolean
6
+ fields. It defines boolean getter methods similar to the standard `enum` method
7
+ as well as an array setter.
8
+
9
+ ## Installation
10
+
11
+ * With bundler:
12
+
13
+ $ gem 'enum_set'
14
+
15
+ * Without bundler:
16
+
17
+ $ gem install enum_set
18
+
19
+ ## Usage
20
+
21
+ ```ruby
22
+ # user.rb
23
+ class User < ActiveRecord::Base
24
+ include EnumSet
25
+ enum_set roles: [:admin, :super_user, :kaiser]
26
+ end
27
+
28
+ # elsewhere.rb
29
+ user = User.create(roles: [:super_user))
30
+
31
+ user.super_user? # => true
32
+ user.admin? # => false
33
+
34
+ super_users = User.super_user.all # will include `user`
35
+
36
+ user.roles <<= :kaiser # Adds `:kaiser` role to `user`
37
+ user.roles # => [:super_user, :kaiser]
38
+ ```
39
+
40
+ ## Notes
41
+
42
+ The gem currently requires ActiveRecord due to scope creation.
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
data/enum_set.gemspec ADDED
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'enum_set/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "enum_set"
8
+ spec.version = EnumSet::VERSION
9
+ spec.authors = ["Bree Stanwyck"]
10
+ spec.email = ["bree@bignerdranch.com"]
11
+ spec.summary = %q{Allows using a single integer column as a set of booleans, with bitfield-style storage.}
12
+ spec.description = ""
13
+ spec.homepage = "https://github.com/breestanwyck/enum_set"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.6"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "sqlite3"
24
+ spec.add_development_dependency "activerecord"
25
+ spec.add_development_dependency "rspec"
26
+ spec.add_development_dependency "pry"
27
+ end
@@ -0,0 +1,3 @@
1
+ module EnumSet
2
+ VERSION = "0.0.1"
3
+ end
data/lib/enum_set.rb ADDED
@@ -0,0 +1,44 @@
1
+ require "enum_set/version"
2
+
3
+ module EnumSet
4
+ def self.included(base)
5
+ base.extend ClassMethods
6
+ end
7
+
8
+ module ClassMethods
9
+ def enum_set(enums)
10
+ enums.each do |column, names|
11
+ names.map!(&:to_sym)
12
+ names_with_bits = names.each_with_index.map { |name, i| [name, 1 << i] }
13
+
14
+ define_method :"#{column}_bitfield" do
15
+ self[column] || 0
16
+ end
17
+
18
+ names_with_bits.each do |name, bit|
19
+ define_method :"#{name}?" do
20
+ (bit & send("#{column}_bitfield")) != 0
21
+ end
22
+
23
+ scope :"#{name}", -> {
24
+ where("#{column} & ? <> 0", bit)
25
+ }
26
+ end
27
+
28
+ define_method :"#{column}=" do |array|
29
+ array.each do |val|
30
+ bit = names_with_bits.find { |name,_| name == val.to_sym }.last
31
+ new_value = send("#{column}_bitfield") | bit
32
+ self[column] = new_value
33
+ end
34
+
35
+ send(column)
36
+ end
37
+
38
+ define_method column do
39
+ names.select { |name| send(:"#{name}?") }
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
data/spec/database.rb ADDED
@@ -0,0 +1,15 @@
1
+ require 'active_record'
2
+
3
+ # connect
4
+ ActiveRecord::Base.establish_connection(
5
+ :adapter => "sqlite3",
6
+ :database => ":memory:"
7
+ )
8
+
9
+ # create tables
10
+ ActiveRecord::Schema.verbose = false
11
+ ActiveRecord::Schema.define(:version => 1) do
12
+ create_table :users do |t|
13
+ t.integer :roles
14
+ end
15
+ end
@@ -0,0 +1,32 @@
1
+ require 'database'
2
+ require 'enum_set'
3
+
4
+ describe EnumSet do
5
+ class User < ActiveRecord::Base
6
+ include EnumSet
7
+
8
+ enum_set roles: [:admin, :super_user, :basic_user]
9
+ end
10
+
11
+ let!(:user) { User.create!(:roles => [:super_user]) }
12
+
13
+ it 'defines a boolean method for each value' do
14
+ expect(user).to be_super_user
15
+ expect(user).to_not be_admin
16
+ end
17
+
18
+ it 'retrieves applicable enum values' do
19
+ expect(user.roles).to eq [:super_user]
20
+ end
21
+
22
+ it 'lets enum values be set' do
23
+ user.roles <<= :admin
24
+ user.save!
25
+ expect(user.reload).to be_admin
26
+ end
27
+
28
+ it 'scopes by enum value' do
29
+ expect(User.super_user).to include user
30
+ expect(User.admin).to_not include user
31
+ end
32
+ end
metadata ADDED
@@ -0,0 +1,142 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: enum_set
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Bree Stanwyck
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-09-06 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.6'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: sqlite3
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: activerecord
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: rspec
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: pry
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
+ description: ''
98
+ email:
99
+ - bree@bignerdranch.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".travis.yml"
106
+ - Gemfile
107
+ - LICENSE.txt
108
+ - README.md
109
+ - Rakefile
110
+ - enum_set.gemspec
111
+ - lib/enum_set.rb
112
+ - lib/enum_set/version.rb
113
+ - spec/database.rb
114
+ - spec/enum_many_spec.rb
115
+ homepage: https://github.com/breestanwyck/enum_set
116
+ licenses:
117
+ - MIT
118
+ metadata: {}
119
+ post_install_message:
120
+ rdoc_options: []
121
+ require_paths:
122
+ - lib
123
+ required_ruby_version: !ruby/object:Gem::Requirement
124
+ requirements:
125
+ - - ">="
126
+ - !ruby/object:Gem::Version
127
+ version: '0'
128
+ required_rubygems_version: !ruby/object:Gem::Requirement
129
+ requirements:
130
+ - - ">="
131
+ - !ruby/object:Gem::Version
132
+ version: '0'
133
+ requirements: []
134
+ rubyforge_project:
135
+ rubygems_version: 2.2.2
136
+ signing_key:
137
+ specification_version: 4
138
+ summary: Allows using a single integer column as a set of booleans, with bitfield-style
139
+ storage.
140
+ test_files:
141
+ - spec/database.rb
142
+ - spec/enum_many_spec.rb