bit_field_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6dbe1b014b6f209f67b3e54a61e279d7c4ebae3f
+  data.tar.gz: ce80d770cc911615518db816bf1fa045035d7905
+SHA512:
+  metadata.gz: f17a39697874f392e80ffcb0155ba1537de33d187624a9b303a3fee8f01ef2637e222fd65df3b41bfe579d7e4ae28d32552b06dd2e0fe36bd59423f8aa201930
+  data.tar.gz: f0146ea5c1e75a1d2ada1e6d6270d3717cd596927ae6201663860f1b15f371e3bed1bc4be820b3b0752ec5bc62cd8bd13874b6c3c9298f670f805b3689626d6c

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Scrimmage
+
+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,29 @@
+# BitFieldSerializer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bit_field_serializer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bit_field_serializer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bit_field_serializer.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bit_field_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bit_field_serializer"
+  spec.version       = BitFieldSerializer::VERSION
+  spec.authors       = ["Nick DeLuca"]
+  spec.email         = ["nick@wescrimmage.com"]
+  spec.description   = %q{Handles conversion of enum arrays to and from a bit field}
+  spec.summary   = %q{Handles conversion of enum arrays to and from a bit field}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/bit_field_serializer.rb

@@ -0,0 +1,11 @@
+require "bit_field_serializer/version"
+
+module BitFieldSerializer
+  def enum_array_to_integer(array)
+    array.compact.reduce(0) { |bit_field, t| bit_field |= t.to_i; bit_field }
+  end
+
+  def integer_to_enum_array(collection, integer)
+    collection.values.collect { |t| t if (integer & t == t) }.compact
+  end
+end

data/lib/bit_field_serializer/version.rb

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

data/test/bit_field_serializer_test.rb

@@ -0,0 +1,75 @@
+require_relative './test_helper'
+
+class TestBitFieldSerializer < MiniTest::Test
+
+  def setup
+    @serializer = Class.new
+    @serializer.extend(BitFieldSerializer)
+  end
+
+  def collection
+    { 'enum1' => 0, 'enum2' => 1, 'enum3' => 2, 'enum4' => 4, 'enum5' => 8, 'enum6' => 16 }
+  end
+
+  def test_converts_enum_array_to_integer
+    integer = @serializer.enum_array_to_integer([ 0, 1, 2, 4, 8, 16 ])
+    assert_equal(31, integer)
+  end
+
+  def test_conversion_ignores_nil_values
+    integer = @serializer.enum_array_to_integer([ nil, 1, 2, nil, 4, 8, 16, nil ])
+    assert_equal(31, integer)
+  end
+
+  def test_integer_to_enum_array_with_31
+    result = @serializer.integer_to_enum_array(collection, 31)
+
+    assert_equal([0, 1, 2, 4, 8, 16], result)
+  end
+
+  def test_integer_to_enum_array_missing_power_in_enum
+    collection = { 'enum1' => 0, 'enum2' => 1, 'enum3' => 2, 'enum5' => 8, 'enum6' => 16 }
+
+    result = @serializer.integer_to_enum_array(collection, 31)
+
+    assert_equal([0, 1, 2, 8, 16], result)
+  end
+
+  def test_integer_to_enum_array_with_16
+    result = @serializer.integer_to_enum_array(collection, 16)
+
+    assert_equal([0, 16], result)
+  end
+
+  def test_integer_to_enum_array_with_2
+    result = @serializer.integer_to_enum_array(collection, 2)
+
+    assert_equal([0, 2], result)
+  end
+
+  def test_integer_to_enum_array_with_22
+    result = @serializer.integer_to_enum_array(collection, 22)
+
+    assert_equal([0, 2, 4, 16], result)
+  end
+
+  def test_conversion_and_deconversion_with_2
+    result = @serializer.integer_to_enum_array(collection, 2)
+
+    assert_equal([0, 2], result)
+
+    integer = @serializer.enum_array_to_integer(result)
+
+    assert_equal(2, integer)
+  end
+
+  def test_conversion_and_deconversion_with_12
+    result = @serializer.integer_to_enum_array(collection, 12)
+
+    assert_equal([0, 4, 8], result)
+
+    integer = @serializer.enum_array_to_integer(result)
+
+    assert_equal(12, integer)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+
+require 'bit_field_serializer'
+#require File.expand_path('../lib/bit_field_serializer.rb', __FILE__)

data/test/version_test.rb

@@ -0,0 +1,8 @@
+require_relative './test_helper'
+
+class TestBitFieldSerializer < MiniTest::Test
+
+  def test_version_is_correct
+    assert_equal BitFieldSerializer::VERSION, '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: bit_field_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick DeLuca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+description: Handles conversion of enum arrays to and from a bit field
+email:
+- nick@wescrimmage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bit_field_serializer.gemspec
+- lib/bit_field_serializer.rb
+- lib/bit_field_serializer/version.rb
+- test/bit_field_serializer_test.rb
+- test/test_helper.rb
+- test/version_test.rb
+homepage: 
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Handles conversion of enum arrays to and from a bit field
+test_files:
+- test/bit_field_serializer_test.rb
+- test/test_helper.rb
+- test/version_test.rb