cereal_eyes 0.0.1

data/lib/cereal_eyes.rb

@@ -0,0 +1,7 @@
+module CerealEyes
+
+  autoload :Document, File.dirname(__FILE__) + '/cereal_eyes/document'
+
+  autoload :AttributeError, File.dirname(__FILE__) + '/cereal_eyes/attribute_error'
+
+end

data/lib/cereal_eyes/attribute_error.rb

@@ -0,0 +1,8 @@
+module CerealEyes
+
+  # An error class representing an error in an attribute configuration
+  # message gives more details on what the cause is
+  class AttributeError < StandardError
+  end
+
+end

data/lib/cereal_eyes/document.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/attribute_error'
+
+module CerealEyes
+
+  module Document
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+
+      # Details of the serialized attributes on this class
+      # @return Array the serialized attributes
+      def serialized_attributes
+        @serialized_attributes ||= []
+      end
+
+      # Define an attribute on this model
+      # @param name [String] - the name of this field
+      # @option options [Object] :default - A default value for this attribute if it not given
+      # @option options [Boolean] :deserialize - Whether or not to deserialize this field (default: true)
+      # @option options [Boolean] :serialize - Whether or not to serialize this field (default: true)
+      # @option options [String|Symbol] :name - An alternate name for the serialized form of this field
+      # @option options [Class] :type - A nested type for this segment
+      # @option options [Boolean] :squash_nil - Whether or not to output nil values (default: true)
+      def attribute(field, options = {})
+        # set defaults 
+        options[:deserialize] = true unless options.has_key?(:deserialize)
+        options[:serialize] = true unless options.has_key?(:serialize)
+        options[:squash_nil] = true unless options.has_key?(:squash_nil)
+        options[:name] ||= field
+        options[:name] = options[:name].to_sym unless Symbol === options[:name]
+        options[:field] = field
+        # make sure we're not breaking the serialization rule
+        if serialized_attributes.any? { |o| o[:serialize] && options[:serialize] && o[:name] == options[:name] }
+          raise CerealEyes::AttributeError.new "Unable to set duplicate attribute for serialization with name: #{options[:name]}"
+        end
+        if serialized_attributes.any? { |o| o[:deserialize] && options[:deserialize] && o[:field] == options[:field] }
+          raise CerealEyes::AttributeError.new "Unable to set duplicate attribute for deserialization on field: #{options[:field]}"
+        end
+        # add to hash
+        key = options[:name].is_a?(Symbol) ? options[:name] : options[:name].to_sym
+        serialized_attributes << options
+        # create the reader if deserializable
+        attr_reader(field) if options[:deserialize]
+        attr_writer(field) if options[:serialize]
+        nil
+      end
+
+      # Perform the deserialization on a hash, returning the resultant object
+      def deserialize(data)
+        return nil if data.nil?
+        obj = new
+        # go through what we have and use it
+        serialized_attributes.each do |options|
+          next unless options[:deserialize]
+          name = options[:name]
+          value = data[name]
+          value ||= data[name.to_s] unless String === name
+          if value && options[:type] # nesting
+            if value.is_a?(Array)
+              value = value.map { |v| puts v.inspect; options[:type].deserialize(v) }
+            else
+              value = options[:type].deserialize(value)
+            end
+          end
+          obj.instance_variable_set(:"@#{options[:field]}", value || options[:default])
+        end
+        obj
+      end
+
+    end
+
+    module InstanceMethods
+
+      # Serialize the given document
+      # @return Hash representing the serialized format of the document
+      def serialize
+        data = {}
+        self.class.serialized_attributes.each do |options|
+          next unless options[:serialize]
+          value = instance_variable_get(:"@#{options[:field]}") || options[:default]
+          if value && options[:type]
+            if value.kind_of?(CerealEyes::Document)
+              value = value.serialize
+            elsif value.is_a?(Array)
+              value = value.map(&:serialize)
+            else
+              raise ArgumentError.new("Don't know how to serialize type: #{options[:type]}")
+            end
+          end
+          value = value.serialize if value.kind_of?(CerealEyes::Document)
+          data[options[:name]] = value if value || !options[:squash_nil]
+        end
+        data
+      end
+
+    end
+
+  end
+
+end

data/lib/cereal_eyes/version.rb

@@ -0,0 +1,5 @@
+module CerealEyes
+
+  VERSION = '0.0.1'
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/cereal_eyes'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: cereal_eyes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Crepezzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70342542869680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70342542869680
+description: a proof of concept serialization format based on GSON
+email: john.crepezzi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cereal_eyes/attribute_error.rb
+- lib/cereal_eyes/document.rb
+- lib/cereal_eyes/version.rb
+- lib/cereal_eyes.rb
+- spec/spec_helper.rb
+homepage: http://seejohnrun.github.com/cereal_eyes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: GSON-like Serialization
+test_files:
+- spec/spec_helper.rb