horcrux 0.0.1 → 0.0.2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :dev do
+  gem 'rake'
+  gem 'msgpack'
+end
+

data/horcrux.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'horcrux'
-  s.version           = '0.0.1'
-  s.date              = '2012-01-01'
+  s.version           = '0.0.2'
+  s.date              = '2012-01-03'
   s.rubyforge_project = 'horcrux'
 
   ## Make sure your summary is short. The description may be as long
@@ -40,12 +40,19 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
+    Gemfile
     LICENSE.md
     README.md
     Rakefile
     horcrux.gemspec
     lib/horcrux.rb
+    lib/horcrux/entity.rb
+    lib/horcrux/serializers/gzip_serializer.rb
+    lib/horcrux/serializers/message_pack_serializer.rb
+    test/entity_test.rb
+    test/helper.rb
     test/memory_test.rb
+    test/serializer_test.rb
   ]
   # = MANIFEST =
 

data/lib/horcrux/entity.rb

@@ -0,0 +1,179 @@
+require File.expand_path('../../horcrux', __FILE__)
+require 'set'
+require 'time'
+
+module Horcrux
+  module Entity
+    def self.included(base)
+      class << base
+        attr_accessor :attributes, :writable_attributes, :default_attribute
+      end
+
+      base.attributes = Set.new
+      base.writable_attributes = Set.new
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Public
+      def attr(type, *keys)
+        method = "build_#{type}_attr"
+        if respond_to?(method)
+          send method, keys, false
+        else
+          raise TypeError, "Type #{type.inspect} not recognized."
+        end
+      end
+
+      # Public
+      def readonly(type, *keys)
+        method = "build_#{type}_attr"
+        if respond_to?(method)
+          send method, keys, true
+        else
+          raise TypeError, "Type #{type.inspect} not recognized."
+        end
+      end
+
+      # Public
+      def from(hash = {})
+        hash.respond_to?(@default_attribute) ? hash : new(hash)
+      end
+
+      def build_string_attr(keys, is_readonly)
+        attr_reader *keys
+
+        build_attrs(keys, is_readonly) do |key_s|
+          ivar_key = "@#{key_s}"
+          define_method "#{key_s}=" do |value|
+            instance_variable_set ivar_key, value
+          end
+        end
+      end
+
+      def build_bool_attr(keys, is_readonly)
+        attr_reader *keys
+
+        build_attrs(keys, is_readonly) do |key_s|
+          ivar_key = "@#{key_s}"
+
+          define_method "#{key_s}?" do
+            !!instance_variable_get(ivar_key)
+          end
+
+          define_method "#{key_s}=" do |value|
+            instance_variable_set ivar_key, case value
+              when Fixnum  then value > 0
+              when /t|f/i  then value =~ /t/i ? true : false
+              else !!value
+            end
+          end
+        end
+      end
+
+      def build_array_attr(keys, is_readonly)
+        build_class_attr(Array, keys, is_readonly)
+      end
+
+      def build_hash_attr(keys, is_readonly)
+        build_class_attr(Hash, keys, is_readonly)
+      end
+
+      def build_time_attr(keys, is_readonly)
+        attr_reader *keys
+
+        build_attrs(keys, is_readonly) do |key_s|
+          ivar_key = "@#{key_s}"
+          define_method "#{key_s}=" do |value|
+            instance_variable_set ivar_key,
+              value.respond_to?(:utc) ? 
+                value :
+                Time.at(value.to_i).utc
+          end
+        end
+      end
+
+      def build_class_attr(klass, keys, is_readonly)
+        build_attrs(keys, is_readonly) do |key_s|
+          ivar_key = "@#{key_s}"
+          define_method key_s do
+            instance_variable_get(ivar_key) ||
+              instance_variable_set(ivar_key, klass.new)
+          end
+
+          define_method "#{key_s}=" do |value|
+            unless value.is_a?(klass)
+              raise TypeError, "#{key_s} should be a #{klass}: #{value.inspect}"
+            end
+            instance_variable_set(ivar_key, value)
+          end
+        end
+      end
+
+      def build_attrs(keys, is_readonly)
+        keys.each do |key|
+          key_s = key.to_s
+          @default_attribute ||= key_s
+          @attributes << key_s
+          @writable_attributes << key_s unless is_readonly
+          yield key_s
+        end
+      end
+    end
+
+    # Public
+    def initialize(hash = {})
+      update_attrs(hash, all = true)
+    end
+
+    # Public: Updates multiple attributes.
+    #
+    # hash - A Hash containing valid attributes.
+    #
+    # Returns this Entity.
+    def update_attrs(hash, all = false)
+      attr = all ? self.class.attributes : self.class.writable_attributes
+      hash.each do |key, value|
+        key_s = key.to_s
+        
+        if !attr.include?(key_s)
+          raise ArgumentError, "Invalid property: #{key.inspect}"
+        end
+
+        send "#{key_s}=", value
+      end
+
+      self
+    end
+
+    # Public
+    def each_attr(writable_only = false)
+      attr_method = writable_only ? :writable_attributes : :attributes
+      self.class.send(attr_method).each do |key|
+        if value = send(key)
+          yield key, value
+        end
+      end
+      self
+    end
+
+    # Public
+    def ==(other)
+      default_attr = self.class.default_attribute
+      other.class == self.class && other.send(default_attr) == send(default_attr)
+    end
+
+    # Public: Converts the valid attributes into a Hash of Symbol key and Object
+    # value.
+    #
+    # Returns a Hash.
+    def to_hash(writable_only = false)
+      hash = {}
+      each_attr(writable_only) do |key, value|
+        hash[key.to_sym] = value
+      end
+      hash
+    end
+  end
+end
+

data/lib/horcrux/serializers/gzip_serializer.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../../../horcrux', __FILE__)
+require 'zlib'
+require 'stringio'
+
+module Horcrux
+  class GzipSerializer
+    def initialize(serializer)
+      @serializer = serializer
+    end
+
+    def dump(value)
+      s = StringIO.new
+      z = Zlib::GzipWriter.new(s)
+      z.write @serializer.dump(value)
+      s.string
+    ensure
+      z.close if z
+    end
+
+    def load(value)
+      s = StringIO.new(value)
+      z = Zlib::GzipReader.new(s)
+      @serializer.load(z.read)
+    ensure
+      z.close if z
+    end
+  end
+end
+

data/lib/horcrux/serializers/message_pack_serializer.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../../horcrux', __FILE__)
+require 'msgpack'
+
+module Horcrux
+  module MessagePackSerializer
+    extend self
+
+    def dump(value)
+      value.to_msgpack
+    end
+
+    def load(str)
+      MessagePack.unpack(str)
+    end
+  end
+end
+
+if Time.now.respond_to?(:to_msgpack)
+  raise LoadError, "Time#to_msgpack should not exist"
+else
+  class Time
+    def to_msgpack(*args)
+      to_i.to_msgpack(*args)
+    end
+  end
+end
+

data/lib/horcrux.rb

@@ -1,6 +1,6 @@
 # See the README.md
 module Horcrux
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
   # Implements the optional methods of a Horcrux adapter.
   module Methods

data/test/entity_test.rb

@@ -0,0 +1,138 @@
+require File.expand_path('../helper', __FILE__)
+
+module Horcrux
+  class EntityTest < Test::Unit::TestCase
+    class Entity
+      include Horcrux::Entity
+
+      attr :string, :name
+      attr :bool, :admin
+      attr :array, :roles
+      attr :time, :updated_at
+
+      readonly :string, :type
+      readonly :hash, :codes
+      readonly :time, :created_at
+      
+      def initialize(hash)
+        super(hash)
+        @created_at ||= Time.now.utc
+      end
+
+      def type
+        @type ||= 'default'
+      end
+    end
+
+    def test_accesses_attributes
+      ent = entity
+      assert_equal 'bob', ent.name
+      assert_equal 'person', ent.type
+      assert_equal true, ent.admin
+      assert ent.admin?
+
+      ent.name = 'bobby'
+      assert_equal 'bobby', ent.name
+
+      ent.admin = 0
+      assert !ent.admin?
+      
+      ent.admin = 'true'
+      assert ent.admin?
+
+      ent.admin = false
+      assert !ent.admin?
+
+      ent.roles = %w(c)
+      assert_equal %w(c), ent.roles
+
+      assert_equal 2000, ent.created_at.year
+      assert_equal 2012, ent.updated_at.year
+
+      ent.updated_at = Time.utc 2010
+      assert_equal 2010, ent.updated_at.year
+
+      assert_raises ArgumentError do
+        ent.update_attrs :type => 'troll'
+      end
+
+      assert_raises ArgumentError do
+        ent.update_attrs :codes => 'troll'
+      end
+
+      assert_raises ArgumentError do
+        ent.update_attrs :created_at => Time.now
+      end
+
+      assert_raises TypeError do
+        ent.roles = 1
+      end
+    end
+
+    def test_initializes_with_default_value
+      ent = entity(:created_at => nil)
+      assert_equal Time.now.utc.year, ent.created_at.year
+    end
+
+    def test_dumps_entity_to_hash
+      hash = entity.to_hash
+      assert_equal 'bob', hash[:name]
+      assert_equal 'person', hash[:type]
+      assert_equal true, hash[:admin]
+      assert_equal %w(a b), hash[:roles]
+      assert_equal({"a" => 1, "b" => 2}, hash[:codes])
+      assert_equal 2000, hash[:created_at].year
+      assert_equal 2012, hash[:updated_at].year
+    end
+
+    def test_tracks_attributes
+      assert Entity.attributes.include?('name')
+      assert Entity.attributes.include?('admin')
+      assert Entity.attributes.include?('type')
+      assert Entity.attributes.include?('roles')
+      assert Entity.attributes.include?('codes')
+      assert Entity.attributes.include?('created_at')
+      assert Entity.attributes.include?('updated_at')
+    end
+
+    def test_tracks_writable_attributes
+      assert Entity.writable_attributes.include?('name')
+      assert Entity.writable_attributes.include?('admin')
+      assert Entity.writable_attributes.include?('roles')
+      assert Entity.writable_attributes.include?('updated_at')
+      assert !Entity.writable_attributes.include?('codes')
+      assert !Entity.writable_attributes.include?('type')
+      assert !Entity.writable_attributes.include?('created_at')
+    end
+
+    def test_tracks_default_attribute
+      assert_equal 'name', Entity.default_attribute
+    end
+
+    def test_convert_hash_to_entity
+      data = entity_data :name => "fred"
+      ent = entity :name => 'fred'
+      assert_equal ent, Entity.from(data)
+      assert_equal ent, Entity.from(ent)
+    end
+
+    def entity(options = {})
+      Entity.new(entity_data(options))
+    end
+
+    def entity_data(options = {})
+      hash = {:name => 'bob', :type => 'person', :admin => 't',
+        :created_at => Time.utc(2000), :updated_at => 1325619163,
+        :roles => %w(a b), :codes => {'a' => 1, 'b' => 2}}
+      options.each do |key, value|
+        if value.nil?
+          hash.delete key
+        else
+          hash[key] = value
+        end
+      end
+      hash
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require File.expand_path('../../lib/horcrux', __FILE__)
+require File.expand_path('../../lib/horcrux/serializers/gzip_serializer', __FILE__)
+require File.expand_path('../../lib/horcrux/entity', __FILE__)
+

data/test/memory_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require File.expand_path('../../lib/horcrux', __FILE__)
+require File.expand_path('../helper', __FILE__)
 
 module Horcrux
   class MemoryTest < Test::Unit::TestCase
@@ -62,3 +61,4 @@ module Horcrux
     end
   end
 end
+

data/test/serializer_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../helper', __FILE__)
+
+module Horcrux
+  class SerializerTest < Test::Unit::TestCase
+    def test_null_serializer
+      assert_equal 1, NullSerializer.dump(1)
+      assert_equal 1, NullSerializer.load(1)
+    end
+
+    def test_string_serializer
+      assert_equal '1', StringSerializer.dump(1)
+      assert_equal '1', StringSerializer.load('1')
+    end
+
+    def test_gzip_serializer
+      data = '0' * 500
+      gzip = GzipSerializer.new(NullSerializer)
+      zipped = gzip.dump(data)
+      assert zipped.size < data.size
+      assert_equal data, gzip.load(zipped)
+    end
+
+    begin
+      require File.expand_path("../../lib/horcrux/serializers/message_pack_serializer", __FILE__)
+
+      def test_msgpack_serializer
+        hash = {:a => 1, :b => {:a => 'a'}, :c => Time.utc(2000)}
+
+        data = MessagePackSerializer.dump(hash)
+        loaded = MessagePackSerializer.load(data)
+        assert_equal 1, loaded['a']
+        assert_equal({"a" => "a"}, loaded["b"])
+        assert_equal 946684800, loaded['c']
+      end
+    rescue LoadError
+      puts "Skipping MessagePack test.  run 'gem install msgpack'"
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: horcrux
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-01 00:00:00.000000000 Z
+date: 2012-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70345353049180 !ruby/object:Gem::Requirement
+  requirement: &70123004569960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345353049180
+  version_requirements: *70123004569960
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &70345353048680 !ruby/object:Gem::Requirement
+  requirement: &70123004569280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,19 +32,26 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345353048680
+  version_requirements: *70123004569280
 description: Simple key/value adapter library.
 email: technoweenie@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - horcrux.gemspec
 - lib/horcrux.rb
+- lib/horcrux/entity.rb
+- lib/horcrux/serializers/gzip_serializer.rb
+- lib/horcrux/serializers/message_pack_serializer.rb
+- test/entity_test.rb
+- test/helper.rb
 - test/memory_test.rb
+- test/serializer_test.rb
 homepage: http://github.com/technoweenie/horcrux
 licenses: []
 post_install_message: 
@@ -70,4 +77,7 @@ signing_key:
 specification_version: 2
 summary: Simple key/value adapter library.
 test_files:
+- test/entity_test.rb
+- test/helper.rb
 - test/memory_test.rb
+- test/serializer_test.rb