structure 0.6.0 → 0.7.0

data/README.md

@@ -1,9 +1,11 @@
 Structure
 =========
 
-Structure is a better Struct.
+Structure is a Struct-like key/value container for modeling ephemeral data in
+Ruby.
 
-It works great when modeling ephemeral data fed in from an API.
+Structure typecasts, uses basic association idioms, and converts to and from
+JSON seamlessly.
 
     #_                                                                       d
     ##_                                                                     d#
@@ -48,13 +50,13 @@ Conjure an object:
 
     p1 = Person.new :name => 'Gilles'
 
-Typecast values:
+Typecast:
 
     p1.age = '28'
     p1.age
     => 28
 
-Use ORM-esque association idioms:
+Use AR-like association idioms:
 
     p2 = Person.new
     p1.friends << p2
@@ -66,14 +68,13 @@ Dump well-structured JSON:
     json = p1.to_json
     => {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":null,"age":null,"friends":[]}],"partner":null}
 
-Load the JSON elsewhere into Ruby seamlessly, provided you have the same
-models set up:
+Load the JSON seamlessly back into Ruby:
 
     person = JSON.parse(json)
     person.friends.first
     => #<Person:0x0000010107d030 @attributes={:name=>nil, :age=>nil, :friends=>[], :partner=>nil}, @modifiable=true>
 
-Throw in some Active Model modules...
+Throw in some Active Model modules:
 
     require 'active_model'
 
@@ -108,3 +109,4 @@ Structure supports the following types:
 * Integer
 * String
 * Structure
+* URI

data/lib/structure.rb

@@ -1,4 +1,4 @@
-# A better Ruby Struct.
+# A Struct-like data container.
 class Structure
   include Enumerable
 
@@ -9,87 +9,94 @@ class Structure
     class ::FalseClass; include Boolean; end
   end
 
-  TYPES = [Array, Boolean, Float, Hash, Integer, String, Structure]
+  TYPES = [Array, Boolean, Float, Hash, Integer, String, Structure, URI]
 
-  # A shortcut to define an attribute that corresponds to an array of other
-  # objects, possibly Structures.
-  def self.has_many(name)
-    key name, :type => Array, :default => []
-  end
-
-  # A shortcut to define an attribute that corresponds to another Structure.
-  def self.has_one(name)
-    key name, :type => Structure
-  end
+  class << self
 
-  # Defines an attribute key.
-  #
-  # Takes a name and an optional hash of options. Available options are:
-  #
-  # * :type, which can be Array, Boolean, Float, Hash, Integer, String, or
-  # Structure. If not specified, type defaults to String.
-  # * :default, which sets the default value for the attribute.
-  #
-  #    class Book
-  #      key :title,   :type => String
-  #      key :authors, :type => Array, :default => []
-  #    end
-  #
-  def self.key(name, options={})
-    name = name.to_sym
-    if method_defined?(name)
-      raise NameError, "#{name} is already defined"
+    # A shortcut to define an attribute that represents an array of other
+    # objects, possibly structures.
+    def has_many(name)
+      key name, :type => Array, :default => []
     end
 
-    type = options[:type] || String
-    unless TYPES.include? type
-      raise TypeError, "#{type} is not a valid type"
+    # A shortcut to define an attribute that represents another structure.
+    def has_one(name)
+      key name, :type => Structure
     end
 
-    default = options[:default]
-    unless default.nil? || default.is_a?(type)
-      raise TypeError, "#{default} is not #{%w{AEIOU}.include?(type.to_s[0]) ? 'an' : 'a'} #{type}"
-    end
+    # Defines an attribute key.
+    #
+    # Takes a name and an optional hash of options. Available options are:
+    #
+    # * :type, which can be Array, Boolean, Float, Hash, Integer, String,
+    # Structure, or URI. If not specified, type defaults to String.
+    # * :default, which sets the default value for the attribute.
+    #
+    #    class Book
+    #      key :title,   :type => String
+    #      key :authors, :type => Array, :default => []
+    #    end
+    def key(name, options={})
+      name = name.to_sym
+      if method_defined?(name)
+        raise NameError, "#{name} is already defined"
+      end
 
-    default_attributes[name] = default
-
-    module_eval do
-
-      # Define a proc to typecast value.
-      typecast =
-        if type == Boolean
-          lambda do |value|
-            case value
-            when String
-             value =~ /1|true/i
-            when Integer
-              value != 0
-            else
-             !!value
-            end
-          end
-        elsif [Hash, Structure].include? type
+      type = options[:type] || String
+      unless TYPES.include? type
+        raise TypeError, "#{type} is not a valid type"
+      end
 
-          # Raise an exception rather than typecast if type is Hash or
-          # Structure.
-          lambda do |value|
-            unless value.is_a? type
-              raise TypeError, "#{value} is not a #{type}"
+      default = options[:default]
+      unless default.nil? || default.is_a?(type)
+        raise TypeError, "#{default} is not #{%w{AEIOU}.include?(type.to_s[0]) ? 'an' : 'a'} #{type}"
+      end
+
+      default_attributes[name] = default
+
+      module_eval do
+
+        # Define a proc to typecast value.
+        typecast =
+          if type == Boolean
+            lambda do |value|
+              case value
+              when String
+               value =~ /1|true/i
+              when Integer
+                value != 0
+              else
+               !!value
+              end
+            end
+          elsif [Hash, Structure].include? type
+
+            # Raise an exception rather than typecast if type is Hash or
+            # Structure.
+            lambda do |value|
+              unless value.is_a? type
+                raise TypeError, "#{value} is not a #{type}"
+              end
+              value
             end
-            value
+          else
+            lambda { |value| Kernel.send(type.to_s, value) }
           end
-        else
-          lambda { |value| Kernel.send(type.to_s, value) }
-        end
 
-      # Define a getter.
-      define_method(name) { @attributes[name] }
+        # Define a getter.
+        define_method(name) { @attributes[name] }
 
-      # Define a setter.
-      define_method("#{name}=") do |value|
-        @attributes[name] = value.nil? ? nil : typecast.call(value)
+        # Define a setter.
+        define_method("#{name}=") do |value|
+          @attributes[name] = value.nil? ? nil : typecast.call(value)
+        end
       end
     end
+
+    # Returns a hash of all attributes with default values.
+    def default_attributes
+      @default_attributes ||= {}
+    end
   end
 
   # Creates a new structure.
@@ -126,15 +133,10 @@ class Structure
 
   private
 
-  def self.default_attributes
-    @default_attributes ||= {}
-  end
-
-  def initialize_attributes
-    @attributes =
-      self.class.default_attributes.inject({}) do |attributes, (key, value)|
-        attributes[key] = value.is_a?(Array) ? value.dup : value
-        attributes
+    def initialize_attributes
+      @attributes = {}
+      self.class.default_attributes.each do |key, value|
+        @attributes[key] = value.is_a?(Array) ? value.dup : value
       end
-  end
+    end
 end

data/lib/structure/version.rb

@@ -1,3 +1,3 @@
 class Structure
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/spec/models/person.rb

@@ -1,5 +1,6 @@
 class Person < Structure
   key :name
   key :age, :type => Integer
+  key :website, :type => URI
   has_many :friends
 end

data/spec/structure/json_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe Structure do
   context "when `structure/json' is required" do
-    let(:person) { Person.new(:name => 'Joe', :age => 28) }
-    let(:json) { '{"json_class":"Person","name":"Joe","age":28,"friends":[]}' }
+    let(:person) { Person.new(:name => 'Joe', :age => 28, :website => 'http://example.com') }
+    let(:json) { '{"json_class":"Person","name":"Joe","age":28,"website":"http://example.com","friends":[]}' }
 
     before do
       require 'structure/json'

data/spec/structure_spec.rb

@@ -41,6 +41,7 @@ describe Structure do
     it "returns the default attributes for the structure" do
       Person.send(:default_attributes).should == { :name    => nil,
                                                    :age     => nil,
+                                                   :website => nil,
                                                    :friends => [] }
       Book.send(:default_attributes).should == { :title   => nil,
                                                  :authors => nil }

data/structure.gemspec

@@ -9,12 +9,10 @@ Gem::Specification.new do |s|
   s.authors     = ["Paper Cavalier"]
   s.email       = ["code@papercavalier.com"]
   s.homepage    = "http://rubygems.com/gems/structure"
-  s.summary     = "A better Struct"
+  s.summary     = "Struct-like key/value container in Ruby"
   s.description = <<-END_OF_DESCRIPTION.strip
-    Structure is a better Struct and does wonders when modeling ephemeral data
-    fed in from an API. It typecasts values, works with ORM-esque association
-    idioms, dumps good-looking JSON, and loads the same JSON seamlessly back
-    into Ruby.
+    Structure is a Struct-like key/value container for modeling ephemeral data
+    in Ruby.
     END_OF_DESCRIPTION
 
   s.rubyforge_project = "structure"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 +01:00
+date: 2011-05-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,10 +48,8 @@ dependencies:
   type: :development
   version_requirements: *id002
 description: |-
-  Structure is a better Struct and does wonders when modeling ephemeral data
-      fed in from an API. It typecasts values, works with ORM-esque association
-      idioms, dumps good-looking JSON, and loads the same JSON seamlessly back
-      into Ruby.
+  Structure is a Struct-like key/value container for modeling ephemeral data
+      in Ruby.
 email: 
 - code@papercavalier.com
 executables: []
@@ -106,7 +104,7 @@ rubyforge_project: structure
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A better Struct
+summary: Struct-like key/value container in Ruby
 test_files: 
 - spec/models/book.rb
 - spec/models/person.rb