acts_as_bytefield 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 848f6a19764646e0ee5abe9fcd0c1e6d46e55e4c
+  data.tar.gz: 2bfa63187e24543c38a94cc7028e3cb3e2f63e86
+SHA512:
+  metadata.gz: f1d08bebbedb75d03e3b4551cb8f517af1774332f22f97081dbe131c114a44023debf7ffcc1a2f9274d41c4ffb2ab74ebf94d445e988105c31dc0b43cc9c6ea8
+  data.tar.gz: d3908f861357f87d5313897b273eaf5ab3fa5008d9479516e2285736c6375c9bf8be55a943a66b009d252f1e935d7d2e2fdc46348e2cbb6ce78f4430c0ddb971

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,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Blackburn
+
+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,74 @@
+# ActsAsBytefield
+
+**Version: 0.1.0**
+
+Use a string column as a bytefield on an ActiveRecord model.
+
+Requires Rails 4.x. Untested with other versions.
+
+## Example
+
+```ruby
+class User < ActiveRecord::Base
+  include ActsAsBytefield
+  acts_as_bytefield :game_data, keys: [:health, :mana, :ammo]
+end
+
+user = User.new(health: 100, mana: 100, ammo: 200)
+user.game_data #=> "dd\xC8"
+
+user.health = 50
+user.save
+user.game_data #=> "2d\xC8"
+
+user.game_data = 'ABC'
+user.health #=> 65
+user.mana   #=> 66
+user.ammo   #=> 67
+
+user.update_attribute(ammo: 0)
+user.ammo   #=> "\x00"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_bytefield'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Model
+
+Include the ActsAsBytefield module, and pass the column name to `acts_as_bytefield` along with the keys you want to use.
+
+```ruby
+class User < ActiveRecord::Base
+  include ActsAsBytefield
+  acts_as_bytefield :game_data, keys: [:health, :mana, :ammo]
+end
+```
+
+The order of the keys matches the byte order of the string column. So, in the above example `game_data` with contain 3 bytes, from left to right representing `health`, `mana` and `ammo`.
+
+### Indexing
+
+You don't need to do anything special. Indexing works as expected.
+
+### Database Issues
+
+It has been tested with `sqlite3` and `postgres`. Make sure you pay attention to the encoding as things can change depending on how you set that up.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cblackburn/acts_as_bytefield.
+
+## 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,13 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+begin
+  require 'midwire_common/rake_tasks'
+rescue StandardError => e
+  puts(">>> Can't load midwire_common/rake_tasks.")
+  puts(">>> Did you 'bundle exec'?: #{e.message}")
+  exit
+end

data/acts_as_bytefield.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_bytefield/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_bytefield'
+  spec.version       = ActsAsBytefield::VERSION
+  spec.authors       = ['Chris Blackburn']
+  spec.email         = ['87a1779b@opayq.com']
+
+  spec.summary       = 'Change an ActiveRecord string column into a byte field.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/cblackburn/acts_as_bytefield'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'midwire_common', '~> 1.1.1'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.11'
+
+  spec.add_dependency 'activerecord', '~> 4.0'
+end

data/bin/console

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

@@ -0,0 +1,3 @@
+module ActsAsBytefield
+  VERSION = '0.1.0'.freeze
+end

data/lib/acts_as_bytefield.rb

@@ -0,0 +1,85 @@
+require 'acts_as_bytefield/version'
+require 'active_record'
+
+module ActsAsBytefield
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def acts_as_bytefield(column, options = {})
+      fail(
+        ArgumentError,
+        "Hash expected, got #{options.class.name}"
+      ) unless options.is_a?(Hash) || options.empty?
+
+      unless respond_to?(:bytefields)
+        class_eval { cattr_accessor :bytefields }
+        self.bytefields = {}
+      end
+
+      column = column.to_sym
+      bytefields[column] = create_field_hash(options[:keys])
+      bytefields[column].keys.each do |key|
+        define_bytefield_methods(column, key)
+      end
+
+      include ActsAsBytefield::InstanceMethods
+    end
+
+    private
+
+    def create_field_hash(fields)
+      attrs = {}
+      fields.inject(0) do |n, f|
+        attrs[f] = n
+        n += 1
+      end
+      attrs
+    end
+
+    def define_bytefield_methods(column, field)
+      define_method(field) { bytefield_value(column, field) }
+      define_method("#{field}=") { |value| set_bytefield_value(column, field, value) }
+    end
+  end
+
+  module InstanceMethods
+    def bytefield_value(column, field)
+      self[column][byte_index(column, field)]
+    end
+
+    def set_bytefield_value(column, field, value)
+      self[column] ||= ''
+      null_pad(column)
+      self[column][byte_index(column, field)] = guarded_value(value)
+    end
+
+    private
+
+    def null_pad(column)
+      self[column] << "\0" * (column_length(column) - self[column].length)
+    end
+
+    def column_length(column)
+      bytefields[column].keys.count
+    end
+
+    def byte_index(column, field)
+      bytefields[column][field]
+    end
+
+    def guarded_value(value)
+      if value.is_a?(String)
+        value.first
+      elsif value.is_a?(Fixnum)
+        value.chr
+      else
+        fail "#{value} must be a Fixnum or String"
+      end
+    end
+  end
+end
+
+# Add class methods
+ActiveRecord::Base.send(:extend, ActsAsBytefield)

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_bytefield
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Blackburn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-08 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: 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: midwire_common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Change an ActiveRecord string column into a byte field.
+email:
+- 87a1779b@opayq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_bytefield.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_bytefield.rb
+- lib/acts_as_bytefield/version.rb
+homepage: https://github.com/cblackburn/acts_as_bytefield
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Change an ActiveRecord string column into a byte field.
+test_files: []