acts_as_bytefield 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 848f6a19764646e0ee5abe9fcd0c1e6d46e55e4c
-  data.tar.gz: 2bfa63187e24543c38a94cc7028e3cb3e2f63e86
+  metadata.gz: 8e48d9cf8999f76fa2798a417ed76fb856875354
+  data.tar.gz: 83f53488ab4d6bb57538e957f2d57c1e73cf1ae0
 SHA512:
-  metadata.gz: f1d08bebbedb75d03e3b4551cb8f517af1774332f22f97081dbe131c114a44023debf7ffcc1a2f9274d41c4ffb2ab74ebf94d445e988105c31dc0b43cc9c6ea8
-  data.tar.gz: d3908f861357f87d5313897b273eaf5ab3fa5008d9479516e2285736c6375c9bf8be55a943a66b009d252f1e935d7d2e2fdc46348e2cbb6ce78f4430c0ddb971
+  metadata.gz: 2fa05ffdcd6936052c4cbb47229963109dccc9f50b2e543e4c7d4e97058ecf716d44e63869049e593ba069ea4c36224bcd94a1a48488ee288373e6efa2e9acfa
+  data.tar.gz: 7b96cb09d299caacf418c7fb16c5cca7fdece528d408dccac6cd839bc31d1863c861279a68fdc10aba920104465f28d9a357ad4b50bb078fb2d071c0aa9724fc

data/.travis.yml

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

data/CHANGELOG

@@ -0,0 +1,6 @@
+*0.1.1* (April 09, 2016)
+
+* Use absolute value of integers passed in.
+* Refactor some code and specs.
+* Update README with more detailed usage info.
+* Add ruby 2.0.0 to the travis-ci build

data/README.md

@@ -1,6 +1,8 @@
 # ActsAsBytefield
 
-**Version: 0.1.0**
+[![Build Status](https://travis-ci.org/cblackburn/acts_as_bytefield.svg?branch=master)](https://travis-ci.org/cblackburn/acts_as_bytefield)
+
+**Version: 0.1.1**
 
 Use a string column as a bytefield on an ActiveRecord model.
 
@@ -14,19 +16,37 @@ class User < ActiveRecord::Base
   acts_as_bytefield :game_data, keys: [:health, :mana, :ammo]
 end
 
-user = User.new(health: 100, mana: 100, ammo: 200)
+user = User.create(health: 100, mana: 100, ammo: 200)
 user.game_data #=> "dd\xC8"
-
+user.health     #=> 'd'
+user.health.ord #=> 100
+user.mana       #=> 'd'
+user.mana.ord   #=> 100
+user.ammo       #=> "\xC8"
+user.ammo.ord   #=> 200
+
+# Set integers
 user.health = 50
 user.save
 user.game_data #=> "2d\xC8"
-
+user.health     #=> '2'
+user.health.ord #=> 50
+user.mana       #=> 'd'
+user.mana.ord   #=> 100
+user.ammo       #=> "\xC8"
+user.ammo.ord   #=> 200
+
+# Set the original column directly
 user.game_data = 'ABC'
-user.health #=> 65
-user.mana   #=> 66
-user.ammo   #=> 67
-
-user.update_attribute(ammo: 0)
+user.health     #=> 'A'
+user.health.ord #=> 65
+user.mana       #=> 'B'
+user.mana.ord   #=> 66
+user.ammo       #=> 'C'
+user.ammo.ord   #=> 67
+
+# Store zero/null
+user.update_attributes(ammo: 0)
 user.ammo   #=> "\x00"
 ```
 
@@ -57,6 +77,46 @@ 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`.
 
+You can still use the string column as a regular string column.
+
+```ruby
+user.game_data = 'this is a test'
+
+user.health #=> 't'
+user.mana   #=> 'h'
+user.ammo   #=> 'i'
+```
+
+#### Using Integers
+
+When setting a field to an integer it will convert that integer to a byte with that ordinal value.
+
+If the value is negative it will use the absolute value.
+
+```ruby
+user = User.create(health: -100, mana: -100, ammo: -200)
+user.game_data #=> "dd\xC8"
+user.health     #=> 'd'
+user.health.ord #=> 100
+user.mana       #=> 'd'
+user.mana.ord   #=> 100
+user.ammo       #=> "\xC8"
+user.ammo.ord   #=> 200
+```
+
+Depending on your database encoding, values greater than 255 may raise an encoding error. Sqlite3 seems to have this restriction regardless of the encoding. Your mileage may vary.  However, PostgreSQL with `unicode` encoding will allow values up to 1114111 `"\u{10FFFF}"` for each byte field.
+
+```ruby
+user = User.create(health: 1114111, mana: 229, ammo: 51)
+user.game_data #=> "\u{10FFFF}å3"
+user.health     #=> "\u{10FFFF}"
+user.health.ord #=> 1114111
+user.mana       #=> "å"
+user.mana.ord   #=> 229
+user.ammo       #=> "3"
+user.ammo.ord   #=> 51
+```
+
 ### Indexing
 
 You don't need to do anything special. Indexing works as expected.
@@ -65,10 +125,12 @@ You don't need to do anything special. Indexing works as expected.
 
 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
+## Contributing and Support
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cblackburn/acts_as_bytefield.
 
+I'm fairly responsive. So don't be shy if you have a problem.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/acts_as_bytefield.rb

@@ -13,34 +13,36 @@ module ActsAsBytefield
         "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
-
+      declare_class_accessors
       column = column.to_sym
       bytefields[column] = create_field_hash(options[:keys])
-      bytefields[column].keys.each do |key|
-        define_bytefield_methods(column, key)
-      end
+      define_bytefield_methods(column)
 
       include ActsAsBytefield::InstanceMethods
     end
 
     private
 
+    def declare_class_accessors
+      return nil if respond_to?(:bytefields)
+      class_eval { cattr_accessor :bytefields }
+      self.bytefields = {}
+    end
+
     def create_field_hash(fields)
       attrs = {}
-      fields.inject(0) do |n, f|
-        attrs[f] = n
-        n += 1
+      fields.inject(0) do |index, key|
+        attrs[key] = index
+        index += 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) }
+    def define_bytefield_methods(column)
+      bytefields[column].keys.each do |key|
+        define_method(key) { bytefield_value(column, key) }
+        define_method("#{key}=") { |value| set_bytefield_value(column, key, value) }
+      end
     end
   end
 
@@ -73,7 +75,7 @@ module ActsAsBytefield
       if value.is_a?(String)
         value.first
       elsif value.is_a?(Fixnum)
-        value.chr
+        value.abs.chr
       else
         fail "#{value} must be a Fixnum or String"
       end

data/lib/acts_as_bytefield/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_bytefield
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Blackburn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md