structure 0.22.0 → 0.22.1

data/lib/structure.rb

@@ -7,7 +7,6 @@
 #    end
 #
 class Structure
-  # Summon a Basic Object.
   unless defined? BasicObject
     if defined? BlankSlate
       BasicObject = BlankSlate
@@ -22,12 +21,12 @@ class Structure
 
   # A wrapper for lazy-evaluating undeclared classes
   #
-  # @note Borrowed from the same-named class in Ohm
+  # @note Somewhat borrowed from the same-named class in Ohm
   class Wrapper < BasicObject
     # Wraps specified class in a wrapper if it is not already wrapped
     #
-    # @param [Class] klass
-    # @return [Wrapper]
+    # @param [Class] klass a class, which may already be wrapped
+    # @return [Wrapper] the wrapped class
     def self.wrap(klass)
       klass.class == self ? klass : new(klass.to_s)
     end
@@ -53,8 +52,6 @@ class Structure
       end
     end
 
-    private
-
     def method_missing(mth, *args, &block)
       @unwrapped ? super : @unwrapped = true
       ::Kernel.const_get(@name).send(mth, *args, &block)
@@ -71,7 +68,7 @@ class Structure
     # @param [Object] default an optional default value
     def initialize(type, default = nil)
       @wrapper = Wrapper.wrap(type)
-      @default = default
+      @default = typecast(default)
     end
 
     # @return the default value for the key
@@ -88,7 +85,9 @@ class Structure
     # @raise [TypeError] value isn't a type
     # @return [Object] a typecast value
     def typecast(val)
-      if val.nil? || val.is_a?(type)
+      if val.nil?
+        nil
+      elsif val.is_a?(type)
         val.dup rescue val
       elsif Kernel.respond_to?(type.to_s)
         Kernel.send(type.to_s, val)
@@ -113,32 +112,17 @@ class Structure
     # @param [Object] default an optional default value
     # @raise [NameError] name is already taken
     def key(name, type = String, default = nil)
-      name = name.to_sym
-
-      if method_defined?(name)
+      if method_defined?(name = name.to_sym)
         raise NameError, "#{name} is taken"
       end
 
-       if default && !default.is_a?(type)
-        raise TypeError, "#{default} isn't a #{type}"
-      end
-
-      # Add key to blueprint.
       blueprint[name] = Definition.new(type, default)
-
-      # Define getter.
-      define_method(name) do
-        @attributes[name]
-      end
-
-      # Define setter.
+      define_method(name) { @attributes[name] }
       define_method("#{name}=") do |val|
-        @attributes[name] = self.class.blueprint[name].typecast(val)
+        modifiable[name] = blueprint[name].typecast(val)
       end
     end
 
-    private
-
     def const_missing(name)
       Wrapper.new(name)
     end
@@ -158,18 +142,19 @@ class Structure
 
   # @return [Hash] a hash representation of the structure
   def to_hash
-    @attributes.inject({}) do |a, (k, v)|
-      a[k] = if v.respond_to?(:to_hash)
-               v.to_hash
-             elsif v.is_a?(Array)
-               v.map { |e| e.respond_to?(:to_hash) ? e.to_hash : e }
-             else
-               v
-             end
+    @attributes.inject({}) { |a, (k, v)| a.merge k => hashify(v) }
+  end
 
-      a
+  def hashify(obj)
+    if obj.respond_to? :to_hash
+      obj.to_hash
+    elsif obj.is_a? Array
+      obj.map { |e| hashify(e) }
+    else
+      obj
     end
   end
+  private :hashify
 
   # Compares this object with another object for equality
   #
@@ -182,9 +167,23 @@ class Structure
     other.is_a?(self.class) && attributes == other.attributes
   end
 
-  private
-
   def blueprint
     self.class.blueprint
   end
+  private :blueprint
+
+  # Used internally to check if the structure is frozen or not before
+  # updating a value
+  #
+  # @note Borrowed from OpenStruct
+  def modifiable
+    begin
+      @modifiable = true
+    rescue
+      raise TypeError, "can't modify frozen #{self.class}", caller(3)
+    end
+
+    @attributes
+  end
+  private :modifiable
 end

data/lib/structure/json.rb

@@ -5,6 +5,27 @@ rescue NameError
 end
 
 class Structure
+  # JSON methods for a structure
+  #
+  # Include this in your structure if you need to cast it to JSON and
+  # vice versa.
+  #
+  # @example
+  #   class Point < Structure
+  #     include JSON
+  #
+  #     key :x, Integer
+  #     key :y, Integer
+  #   end
+  #
+  # Alternatively, include it in the parent class if you have more than
+  # one structure.
+  #
+  # @example
+  #   class Structure
+  #     include JSON
+  #   end
+  #
   module JSON
     def self.included(base)
       base.extend ClassMethods
@@ -46,7 +67,7 @@ class Structure
     module ClassMethods
       # Builds a structure out of its JSON representation
       #
-      # @param [Hash] hsh a hashified JSON
+      # @param [Hash] hsh a hash representation of a JSON
       # @return [Structure] a structure
       def json_create(hsh)
         hsh.delete('json_class')

data/lib/structure/version.rb

@@ -1,3 +1,3 @@
 class Structure
-  VERSION = '0.22.0'
+  VERSION = '0.22.1'
 end

data/test/structure_test.rb

@@ -70,13 +70,24 @@ class TestStructure < MiniTest::Unit::TestCase
     assert_equal 'John', other.friends.first.name
   end
 
+  def test_cant_change_sex_when_frozen
+    person = Person.new(:name => 'John')
+    person.freeze
+    assert_raises(TypeError) { person.name = 'Jane' }
+  end
+
   def test_to_hash
     person = Person.new(:name => 'John')
-    person.friends << Person.new(:name => 'Jane')
-    hash = person.to_hash
+    friend = Person.new(:name => 'Jane')
+    person.friends << friend
+    hsh = person.to_hash
+
+    assert_equal person.name, hsh[:name]
+    assert_equal friend.name, hsh[:friends].first[:name]
 
-    assert_equal 'John', hash[:name]
-    assert_equal 'Jane', hash[:friends].first[:name]
+    person.friends = [[friend]]
+    hsh = person.to_hash
+    assert_equal friend.name, hsh[:friends].first.first[:name]
   end
 
   def test_json

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structure
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.22.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000 Z
+date: 2011-10-27 00:00:00.000000000 Z
 dependencies: []
 description: Structure is a typed key/value container.
 email:
@@ -41,18 +41,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2031698207987898845
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2031698207987898845
 requirements: []
 rubyforge_project: structure
 rubygems_version: 1.8.10