enum_set 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85f894002f4a10378eeb69ff3307fd5c80414ba7
+  data.tar.gz: 98146508dc10a69f77e68ed56e3da0252e2e5529
+SHA512:
+  metadata.gz: d5cd14abb906d62108260ec2bb91438c19e809745020953a5b3c3be98048beebd16496aff483d3a046c783f3aaa0a1cd4d957c3885f56e3a9499839944ff5676
+  data.tar.gz: bc772f63b1ad9e934f9abbae2b1003a5ce6882cd2a3c8ac066e46124e79c0756680dd109cecda4f9a381a607201ff286d23e12e15421cf03aca660849f55699f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,6 @@
+cache: bundler
+language: ruby
+rvm:
+  - 2.1.2
+script:
+  - bundle exec rspec --format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum_set.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bree Stanwyck
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+[![Build Status](https://travis-ci.org/breestanwyck/enum_set.svg?branch=master)](https://travis-ci.org/breestanwyck/enum_set)
+
+# EnumSet
+
+`enum_set` is a gem for treating integer columns as a compact set of boolean
+fields. It defines boolean getter methods similar to the standard `enum` method
+as well as an array setter.
+
+## Installation
+
+* With bundler:
+
+      $ gem 'enum_set'
+
+* Without bundler:
+
+      $ gem install enum_set
+
+## Usage
+
+```ruby
+# user.rb
+class User < ActiveRecord::Base
+  include EnumSet
+  enum_set roles: [:admin, :super_user, :kaiser]
+end
+
+# elsewhere.rb
+user = User.create(roles: [:super_user))
+
+user.super_user? # => true
+user.admin? # => false
+
+super_users = User.super_user.all # will include `user`
+
+user.roles <<= :kaiser # Adds `:kaiser` role to `user`
+user.roles # => [:super_user, :kaiser]
+```
+
+## Notes
+
+The gem currently requires ActiveRecord due to scope creation.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/enum_set.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum_set/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enum_set"
+  spec.version       = EnumSet::VERSION
+  spec.authors       = ["Bree Stanwyck"]
+  spec.email         = ["bree@bignerdranch.com"]
+  spec.summary       = %q{Allows using a single integer column as a set of booleans, with bitfield-style storage.}
+  spec.description   = ""
+  spec.homepage      = "https://github.com/breestanwyck/enum_set"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/enum_set/version.rb

@@ -0,0 +1,3 @@
+module EnumSet
+  VERSION = "0.0.1"
+end

data/lib/enum_set.rb

@@ -0,0 +1,44 @@
+require "enum_set/version"
+
+module EnumSet
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def enum_set(enums)
+      enums.each do |column, names|
+        names.map!(&:to_sym)
+        names_with_bits = names.each_with_index.map { |name, i| [name, 1 << i] }
+
+        define_method :"#{column}_bitfield" do
+          self[column] || 0
+        end
+
+        names_with_bits.each do |name, bit|
+          define_method :"#{name}?" do
+            (bit & send("#{column}_bitfield")) != 0
+          end
+
+          scope :"#{name}", -> {
+            where("#{column} & ? <> 0", bit)
+          }
+        end
+
+        define_method :"#{column}=" do |array|
+          array.each do |val|
+            bit = names_with_bits.find { |name,_| name == val.to_sym }.last
+            new_value = send("#{column}_bitfield") | bit
+            self[column] = new_value
+          end
+
+          send(column)
+        end
+
+        define_method column do
+          names.select { |name| send(:"#{name}?") }
+        end
+      end
+    end
+  end
+end

data/spec/database.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+
+# connect
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+# create tables
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.integer :roles
+  end
+end

data/spec/enum_many_spec.rb

@@ -0,0 +1,32 @@
+require 'database'
+require 'enum_set'
+
+describe EnumSet do
+  class User < ActiveRecord::Base
+    include EnumSet
+
+    enum_set roles: [:admin, :super_user, :basic_user]
+  end
+
+  let!(:user) { User.create!(:roles => [:super_user]) }
+
+  it 'defines a boolean method for each value' do
+    expect(user).to be_super_user
+    expect(user).to_not be_admin
+  end
+
+  it 'retrieves applicable enum values' do
+    expect(user.roles).to eq [:super_user]
+  end
+
+  it 'lets enum values be set' do
+    user.roles <<= :admin
+    user.save!
+    expect(user.reload).to be_admin
+  end
+
+  it 'scopes by enum value' do
+    expect(User.super_user).to include user
+    expect(User.admin).to_not include user
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: enum_set
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bree Stanwyck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- bree@bignerdranch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enum_set.gemspec
+- lib/enum_set.rb
+- lib/enum_set/version.rb
+- spec/database.rb
+- spec/enum_many_spec.rb
+homepage: https://github.com/breestanwyck/enum_set
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows using a single integer column as a set of booleans, with bitfield-style
+  storage.
+test_files:
+- spec/database.rb
+- spec/enum_many_spec.rb