bit_attrs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7d85843c13d88c15526fb49ef6d0f0d307c68a9
+  data.tar.gz: ed93ad2f246627878e1fc67203008018ef080570
+SHA512:
+  metadata.gz: 56aba610ed322a64ba3c69d50460109f9db12e9b4d2fd63b00200c3c124274f69d66cbee7a7580c1b62775f25bd8904c1b411ce1f2d4f94fdd7f34b478b6394b
+  data.tar.gz: e8455c613270708003cccbe13e6a2a48e1ed07b3d53589ade12a6f7cd3bebd44bcd20ec95e2e0f50b74dae49b6ce490454239edb2a936b5b02a613efa632d083

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.sublime-*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rsamoilov@yandex.ua. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Roman Samoilov
+
+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,119 @@
+# BitAttrs
+
+BitAttrs allows to store a set of boolean values in one field.
+
+* Simple and easy to use
+* Has no additional dependencies, like ActiveRecord
+* Works well with ActiveRecord, DataMapper, Virtus or POROs
+* Has convenient search scopes for ActiveRecord and DataMapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bit_attrs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bit_attrs
+
+## Usage
+
+BitAttrs has similar to Rails 4 enums syntax:
+
+````ruby
+class User < ActiveRecord::Base
+  include BitAttrs
+  bitset roles: [:admin, :user, :guest]
+end
+```
+
+In this case, BitAttrs will expect ```roles_mask``` field to actually save roles in:
+
+```ruby
+#<User id: 1, name: 'test user', email: "test@gmail.com", roles_mask: 2>
+```
+
+You can freely add new attributes to the end of the list without changing already existing records:
+
+````ruby
+class User < ActiveRecord::Base
+  include BitAttrs
+  bitset roles: [:admin, :user, :guest, :developer]
+end
+```
+
+Similarly to Rails enums, if you want to delete some of the attributes, you might want to use hash syntax, where keys are attribute names and values are indexes:
+
+````ruby
+class User < ActiveRecord::Base
+  include BitAttrs
+  bitset roles: { admin: 0, user: 1, developer: 3 }
+end
+```
+
+Attributes can be accessed on the instance level or through the ```roles``` method:
+
+```ruby
+> user
+=> #<User id: 1, name: 'test user', email: "test@gmail.com", roles_mask: 2>
+
+> user.user?
+=> true
+
+> user.roles
+=> { admin: false, user: true, guest: false }
+```
+
+Update all attributes (with overwriting):
+
+```ruby
+> user.roles
+=> { admin: false, user: true, guest: false }
+
+> user.update(roles: { guest: true }) && user.roles
+=> { admin: false, user: false, guest: true }
+```
+
+Update single attribute:
+
+```ruby
+> user.roles
+=> { admin: false, user: true, guest: false }
+
+> user.admin = true
+=> { admin: true, user: true, guest: false }
+```
+
+### Scopes
+
+Considering the example above, BitAttrs will create following search scopes:
+
+```
+* User.with_roles
+* User.without_roles
+```
+
+Example:
+
+```ruby
+> User.with_roles(:user)
+=> all users which have role :user set to true
+> User.with_roles(:admin, :user).without_roles(:developer)
+=> all users which have following roles set: { admin: true, user: true, developer: false }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rsamoilov/bit_attrs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bit_attrs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bit_attrs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bit_attrs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bit_attrs"
+  spec.version       = BitAttrs::VERSION
+  spec.authors       = ["Roman Samoilov"]
+  spec.email         = ["rsamoilov@yandex.ua"]
+
+  spec.summary       = %q{Store a set of boolean values in one field. Works well with ActiveRecord, DataMapper, Virtus or POROs.}
+  spec.homepage      = "https://github.com/rsamoilov/bit_attrs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.1"
+end

data/lib/bit_attrs.rb

@@ -0,0 +1,62 @@
+require "bit_attrs/bitset"
+require "bit_attrs/version"
+require "bit_attrs/bindings"
+
+module BitAttrs
+
+  def self.included(klass)
+    klass.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    attr_reader :bit_attrs
+
+    # bitset roles: [:admin, :user, :guest]
+    # bitset access_levels: [read: 0, write: 1, delete: 2, api: 3]
+    def bitset(flags_map)
+      @bit_attrs ||= {}
+
+      flags_map.each do |attr_name, flags_list|
+        @bit_attrs[attr_name] = check_flags_list(flags_list)
+        define_alias_methods(attr_name, @bit_attrs[attr_name])
+        Bindings.create(self, attr_name)
+      end
+    end
+
+    private
+
+    def check_flags_list(flags_list)
+      return flags_list if flags_list.is_a?(Hash)
+
+      flags_list.each_with_index.inject({}) do |memo, (flag, i)|
+        memo.merge!(flag => i)
+      end
+    end
+
+    def define_alias_methods(attr_name, flags_map)
+      define_method attr_name do
+        Bitset.new(flags_map, self.send("#{attr_name}_mask"))
+      end
+
+      define_method "#{attr_name}=" do |flags_map|
+        bitset = self.class.new.send(attr_name)
+        flags_map.each { |flag, bool| bitset[flag] = bool }
+        self.send("#{attr_name}_mask=", bitset.to_i)
+      end
+
+      flags_map.each do |flag, _i|
+        define_method(flag) { self.send(attr_name)[flag] }
+        define_method("#{flag}?") { self.send(flag) }
+
+        define_method("#{flag}=") do |bool|
+          bitset = self.send(attr_name)
+          bitset[flag] = bool
+          self.send("#{attr_name}_mask=", bitset.to_i)
+        end
+      end
+    end
+  end
+
+end

data/lib/bit_attrs/bindings.rb

@@ -0,0 +1,30 @@
+require "bit_attrs/bindings/active_record_binding"
+require "bit_attrs/bindings/data_mapper_binding"
+
+module BitAttrs
+
+  class Bindings
+    ORM_BINDINGS = [ActiveRecordBinding, DataMapperBinding]
+
+    def self.create(klass, attr_name)
+      ORM_BINDINGS.each do |orm_binding|
+        next unless orm_binding.should_be_created?(klass)
+
+        klass.define_singleton_method "with_#{attr_name}" do |*flags_list|
+          bitset = self.new.send(attr_name)
+          flags_list.each { |flag| bitset[flag] = true }
+
+          orm_binding.with(klass, attr_name, bitset)
+        end
+
+        klass.define_singleton_method "without_#{attr_name}" do |*flags_list|
+          bitset = self.new.send(attr_name)
+          flags_list.each { |flag| bitset[flag] = true }
+
+          orm_binding.without(klass, attr_name, bitset)
+        end
+      end
+    end
+  end
+
+end

data/lib/bit_attrs/bindings/active_record_binding.rb

@@ -0,0 +1,20 @@
+module BitAttrs
+
+  class ActiveRecordBinding
+    def self.should_be_created?(klass)
+      return false unless defined?(ActiveRecord)
+      return false unless klass.ancestors.include?(ActiveRecord::Base)
+
+      true
+    end
+
+    def self.with(klass, attr_name, bitset)
+      klass.where("#{attr_name}_mask & ? = ?", bitset.to_i, bitset.to_i)
+    end
+
+    def self.without(klass, attr_name, bitset)
+      klass.where("#{attr_name}_mask IS NULL OR #{attr_name}_mask & ? = ?", bitset.to_i, 0)
+    end
+  end
+
+end

data/lib/bit_attrs/bindings/data_mapper_binding.rb

@@ -0,0 +1,20 @@
+module BitAttrs
+
+  class DataMapperBinding
+    def self.should_be_created?(klass)
+      return false unless defined?(DataMapper::Resource)
+      return false unless klass.included_modules.include?(DataMapper::Resource)
+
+      true
+    end
+
+    def self.with(klass, attr_name, bitset)
+      klass.all(conditions: ["#{attr_name}_mask & ? = ?", bitset.to_i, bitset.to_i])
+    end
+
+    def self.without(klass, attr_name, bitset)
+      klass.all(conditions: ["#{attr_name}_mask IS NULL OR #{attr_name}_mask & ? = ?", bitset.to_i, 0])
+    end
+  end
+
+end

data/lib/bit_attrs/bitset.rb

@@ -0,0 +1,51 @@
+module BitAttrs
+
+  class Bitset
+    def initialize(flags_map, mask = 0)
+      @flags_map = flags_map
+      @mask = mask.to_i
+    end
+
+    def to_h
+      @flags_map.inject({}) do |memo, (flag, _i)|
+        memo.merge! flag => self[flag]
+      end
+    end
+
+    def [](flag)
+      i = @flags_map[flag.to_sym]
+      bit = (@mask >> i) & 1
+
+      bit == 1
+    end
+
+    def []=(flag, value)
+      i = @flags_map[flag.to_sym]
+
+      if truthy?(value)
+        @mask |= 1 << i
+      else
+        @mask &= ~(1 << i)
+      end
+    end
+
+    def each(&block)
+      self.to_h.each &block
+    end
+
+    def inspect
+      to_h.inspect
+    end
+
+    def to_i
+      @mask
+    end
+
+    private
+
+    def truthy?(value)
+      value == true || value == 'true' || value == '1'
+    end
+  end
+
+end

data/lib/bit_attrs/version.rb

@@ -0,0 +1,3 @@
+module BitAttrs
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: bit_attrs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roman Samoilov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- rsamoilov@yandex.ua
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bit_attrs.gemspec
+- lib/bit_attrs.rb
+- lib/bit_attrs/bindings.rb
+- lib/bit_attrs/bindings/active_record_binding.rb
+- lib/bit_attrs/bindings/data_mapper_binding.rb
+- lib/bit_attrs/bitset.rb
+- lib/bit_attrs/version.rb
+homepage: https://github.com/rsamoilov/bit_attrs
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Store a set of boolean values in one field. Works well with ActiveRecord,
+  DataMapper, Virtus or POROs.
+test_files: []