has_blob_bit_field 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a4b7e6ba65aac5f80f706712c97b16456023f06
+  data.tar.gz: 2f52dae5f3e2fe587bf3dbb1509f8cce48204cd2
+SHA512:
+  metadata.gz: f9aaf3bb20548a3148d0e92d8f1a0039e75a304516ab8222d000c408fec5021d63cc159f81ea8e239bd8fd66ab633e4389ea22a9449974291516d10d846ef4ea
+  data.tar.gz: 203935e84e9f56f9485c0fc325380c283dbbee70fe1de92aeed93a907f2da8c435238e875553b58b1baa994c1816eb658a38468dfdc6a495700bd81f4cc99d7b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marc-Andre Lafortune
+
+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,69 @@
+# HasBlobBitField
+
+A Rails extension to treat a binary column (blob) as a sequence of `true`/`false` flags (bits)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_blob_bit_field'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_blob_bit_field
+
+## Example Usage
+
+```
+# Migration:
+def change
+	add_column :whatevers, :many_flags_blob, :binary
+end
+
+# Model:
+
+class YourModel < ActiveRecord::Base
+	has_blob_field :many_flags
+end
+
+# Usage:
+
+o = YourModel.new
+o.many_flags.size # => 0
+o.many_flags.size = 666 # Can be as big as 8 times the binary limit of your column
+o.many_flags[42] # => false
+o.many_flags[42] = true
+o.many_flags[700] # => IndexError
+```
+
+## Notes:
+
+* The convention is that your column has the same name as your accessing method with a `'_blob'` suffix, but you can specify the column to use when calling `has_blob_field`.
+
+* The first flag is stored using the highest bit of the first byte.
+
+* The size is always rounded up to a multiple of 8.
+
+* Accessing out of bounds indices raises an `IndexError`, but code could be adapted easily to return `nil` instead.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcandre/has_blob_bit_field.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "has_blob_bit_field"
+
+# 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/has_blob_bit_field.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_blob_bit_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_blob_bit_field"
+  spec.version       = HasBlobBitField::VERSION
+  spec.authors       = ["Marc-Andre Lafortune"]
+  spec.email         = ["github@marc-andre.ca"]
+
+  spec.summary       = %q{Acces a binary column as a sequence of true/false flags}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/marcandre/has_blob_bit_field"
+  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_dependency 'activemodel'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "pry"
+end

data/lib/has_blob_bit_field.rb

@@ -0,0 +1,8 @@
+require "active_model"
+require_relative "has_blob_bit_field/version"
+require_relative "has_blob_bit_field/accessor"
+require_relative "has_blob_bit_field/extension"
+
+module HasBlobBitField
+  ActiveModel::Dirty.include HasBlobBitField::Extension
+end

data/lib/has_blob_bit_field/accessor.rb

@@ -0,0 +1,76 @@
+module HasBlobBitField
+  class Accessor
+    attr_reader :record, :column
+
+    def initialize record, column
+      @record = record
+      @column = column
+    end
+
+    def [](index)
+      val = byte(index)
+      val & flag(index) != 0
+    end
+
+    def []=(index, set)
+      set = !!set # force to true/false
+      val = byte(index)
+      mask = flag(index)
+      if (val & mask != 0) != set
+        notify_of_mutation
+        raw_value.setbyte(index >> 3, val ^ mask)
+      end
+      set
+    end
+
+    def size
+      raw_value.size << 3
+    end
+
+    def size=(size_in_bits)
+      raise IndexError unless size_in_bits >= 0
+      size_in_bytes = (size_in_bits + 7) >> 3
+      s = raw_value(init_nil: true)
+
+      if s.size != size_in_bytes
+        notify_of_mutation
+        if s.size > size_in_bytes
+          s[size_in_bytes..s.size] = ''
+        else
+          s << Array.new(size_in_bytes - s.size, 0).pack('C*')
+        end
+      end
+      size_in_bits
+    end
+
+    alias_method :length, :size
+    alias_method :length=, :size=
+
+    def raw_value(init_nil: false)
+      @record.public_send(@column) ||
+        (init_nil && notify_of_mutation && @record.public_send(:"#{@column}=", ''.b)) ||
+        ''.b
+    end
+
+
+  private
+    def notify_of_mutation
+      @record.public_send :"#{@column}_will_change!"
+      self
+    end
+
+    def flag(index)
+      0b1000_0000 >> (index & 0b111)
+    end
+
+    def byte(index)
+      out_of_bound(index) unless index >= 0
+      raw_value.getbyte(index >> 3) || out_of_bound(index)
+    end
+
+    def out_of_bound(index)
+      raise IndexError, "#{index} is our of range for #{@column} which has size #{size}. Record: #{@record.inspect}}"
+    end
+  end
+end
+

data/lib/has_blob_bit_field/extension.rb

@@ -0,0 +1,22 @@
+require 'active_support'
+
+module HasBlobBitField
+  module Extension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_blob_bit_field field, column: :"#{field}_blob"
+        class_eval <<-EVAL, __FILE__, __LINE__
+          def #{field}
+            Accessor.new self, :#{column}
+          end
+
+          def #{field}=
+            raise "Don't set the pseudo field #{field} directly, use []= on it"
+          end
+        EVAL
+      end
+    end
+
+  end
+end

data/lib/has_blob_bit_field/version.rb

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: has_blob_bit_field
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marc-Andre Lafortune
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: Acces a binary column as a sequence of true/false flags
+email:
+- github@marc-andre.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_blob_bit_field.gemspec
+- lib/has_blob_bit_field.rb
+- lib/has_blob_bit_field/accessor.rb
+- lib/has_blob_bit_field/extension.rb
+- lib/has_blob_bit_field/version.rb
+homepage: https://github.com/marcandre/has_blob_bit_field
+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: Acces a binary column as a sequence of true/false flags
+test_files: []