structure 0.13.1 → 0.14.1

data/.travis.yml

@@ -1,5 +1,8 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
   - jruby
   - rbx
+  - rbx-2.0
+  - ree

data/CHANGELOG.md

@@ -1,26 +1,36 @@
-# 0.13
+# CHANGELOG
 
-* Remove static module.
-* Rename .key to .attribute.
+## 0.14.1
+* rename .attribute back to .key
+* shorten .embeds_many and .embeds_one to .many and .one
+* remove presence methods
+* add options to .many
 
-# 0.12
+## 0.13.1
 
-* Add static module.
+* remove static module
+* rename .key to .attribute
 
-# 0.11
+# 0.12.1
 
-* .key now emulates DataMapper.property.
+* add static module
 
-# 0.10
+# 0.11.1
 
-* Rename .has_one and .has_many to .embeds_one and .embeds_many to make room
-  for associations.
+* .key now emulates DataMapper.property
+
+# 0.10.1
+
+* rename .has_one and .has_many to .embeds_one and .embeds_many to make room
+  for associations
 
 # 0.9
 
-* Add presence method.
+* add presence method
 
 # 0.8
 
-* Make JSON patch compatible with Active Support.
-* Remove URI from list of types.
+* make JSON patch compatible with Active Support
+* remove URI from list of types
+
+The rest is history.

data/Gemfile

@@ -2,4 +2,5 @@ source :rubygems
 
 gem 'activesupport', '>= 3.0'
 gem 'json',          :platform => [:mri_18, :jruby]
-gem 'rake',          '~> 0.9'
+gem 'rake'
+gem 'ruby-debug19',  :platform => :mri_19, :require => 'ruby-debug'

data/README.md

@@ -1,75 +1,28 @@
 # Structure
 
-[![travis](https://secure.travis-ci.org/papercavalier/structure.png)](http://travis-ci.org/papercavalier/structure)
+Structure is a Struct-like key/value container.
 
-Structure is Ruby module that turns a class into a key/value container.
+[![travis](https://secure.travis-ci.org/papercavalier/structure.png)](http://travis-ci.org/papercavalier/structure)
 
 ## Usage
 
-Set up models.
-
-```ruby
-require 'structure'
-
-class Book
-  include Structure
-
-  attribute   :title
-  attribute   :binding, :default => "Hardcover"
-  attribute   :year_published, Integer
-  embeds_many :authors
-end
-
-class Author
-  include Structure
-
-  attribute :name
-  attribute :role
-end
-```
-
-Create some objects.
-
-```ruby
-book = Book.new :title => "A Thousand Plateaus"
-author = Author.new :name => "Gilles Deleuze"
-book.authors << author
-```
-
-Attributes in structures are typecasted.
-
-```ruby
-book.year_published = "1985"
-puts book.year_published
-=> 1985
-```
-
-Translate to JSON and back into Ruby.
-
-```ruby
-json = book.to_json
-puts json
-=> {"json_class":"Book","title":"A Thousand Plateaus","binding":"Hardcover,"year_published":1985,"authors":[{"json_class":"Author","name":"Gilles Deleuze","role":null}]}
+Set up a model:
 
-book = JSON.parse(json)
-puts book.authors.first.name
-=> "Gilles Deleuze"
-```
+    require 'structure'
 
-Mix in Active Model modules.
+    class Person < Structure
+      key  :name
+      many :friends
+    end
 
-```ruby
-require 'active_model'
+Do things with it:
 
-class Book
-  include ActiveModel::Validations
+    person = Person.new
+    friend = Person.new
+    person.friends << friend
+    puts person.to_json
+    => {"json_class":"Person","name":null,"friends":[{"json_class":"Person","name":null,"friends":[]}]}
 
-  validates_presence_of :title
-end
+Please see [the project page] [1] for more detailed info.
 
-book = Book.new
-book.valid?
-=> false
-book.errors
-=> {:title=>["can't be blank"]}
-```
+[1]: http://code.papercavalier.com/structure/

data/lib/structure/version.rb

@@ -1,3 +1,3 @@
-module Structure
-  VERSION = '0.13.1'
+class Structure
+  VERSION = '0.14.1'
 end

data/lib/structure.rb

@@ -1,5 +1,5 @@
 begin
-  ::JSON::JSON_LOADED
+  JSON::JSON_LOADED
 rescue NameError
   require 'json'
 end
@@ -10,35 +10,34 @@ unless defined? Boolean
   [TrueClass, FalseClass].each { |klass| klass.send :include, Boolean }
 end
 
-# Structure is a Ruby module that turns a class into a key/value container.
+# = Structure
 #
-#    class Person
-#      include Structure
+# Structure is a Struct-like key/value container.
 #
-#      attribute :name
-#      attribute :age, Integer
+#    class Person < Structure
+#      key :name
+#      key :age, Integer
 #    end
 #
 #    person = Person.new(:name => "John")
 #    person.name
 #    => "John"
 #
-module Structure
+class Structure
   include Enumerable
 
   # Structure supports the following types.
   TYPES = [Array, Boolean, Float, Hash, Integer, String, Structure]
 
-  module ClassMethods
-    # Defines an attribute that represents an array of objects, possibly
-    # structures.
-    def embeds_many(key)
-      attribute key, Array, :default => []
+  class << self
+    # Defines an attribute that represents an array of objects.
+    def many(name, options = {})
+      key name, Array, { :default => [] }.merge(options)
     end
 
     # Defines an attribute that represents another structure.
-    def embeds_one(key)
-      attribute key, Structure
+    def one(name)
+      key name, Structure
     end
 
     # Builds a structure out of its JSON representation.
@@ -49,33 +48,38 @@ module Structure
 
     # Defines an attribute.
     #
-    # Takes a key, an optional type, and an optional hash of options.
+    # Takes a name, an optional type, and an optional hash of options.
     #
     # The type can be +Array+, +Boolean+, +Float+, +Hash+, +Integer+, +String+,
-    # or +Structure+. If none is specified, this defaults to String.
+    # a +Structure+, or a subclass thereof. If none is specified, this defaults
+    # to +String+.
     #
     # Available options are:
     #
     # * +:default+, which sets the default value for the attribute.
-    def attribute(key, *args)
-      key     = key.to_sym
+    def key(name, *args)
+      name    = name.to_sym
       options = args.last.is_a?(Hash) ?  args.pop : {}
       type    = args.shift || String
       default = options[:default]
 
-      if method_defined? key
-        raise NameError, "#{key} is already defined"
+      if method_defined? name
+        raise NameError, "#{name} is already defined"
       end
 
-      if TYPES.include?(type) && (default.nil? || default.is_a?(type))
-        default_attributes[key] = default
+      if (type.ancestors & TYPES).empty?
+        raise TypeError, "#{type} is not a valid type"
+      end
+
+      if default.nil? || default.is_a?(type)
+        default_attributes[name] = default
       else
         msg = "#{default} is not a#{'n' if type.to_s.match(/^[AI]/)} #{type}"
         raise TypeError, msg
       end
 
       module_eval do
-        # Define a closure that typecasts value.
+        # Typecast value based on type.
         typecast =
           if type == Boolean
             lambda do |value|
@@ -91,8 +95,6 @@ module Structure
               end
             end
           elsif [Hash, Structure].include? type
-            # Don't bother with typecasting attributes of type +Hash+ or
-            # +Structure+.
             lambda do |value|
               unless value.is_a? type
                 raise TypeError, "#{value} is not a #{type}"
@@ -104,15 +106,10 @@ module Structure
           end
 
         # Define attribute accessors.
-        define_method(key) { @attributes[key] }
+        define_method(name) { @attributes[name] }
 
-        define_method("#{key}=") do |value|
-          @attributes[key] = value.nil? ? nil : typecast.call(value)
-        end
-
-        # Define a method to check for presence.
-        unless type == Array
-          define_method("#{key}?") { !!@attributes[key] }
+        define_method("#{name}=") do |value|
+          @attributes[name] = value.nil? ? nil : typecast.call(value)
         end
       end
     end
@@ -123,10 +120,6 @@ module Structure
     end
   end
 
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
   # Creates a new structure.
   #
   # A hash, if provided, will seed its attributes.
@@ -140,7 +133,7 @@ module Structure
   end
 
   # A hash that stores the attributes of the structure.
-  attr_reader :attributes
+  attr :attributes
 
   # Returns a Rails-friendly JSON representation of the structure.
   def as_json(options = nil)
@@ -167,11 +160,6 @@ module Structure
     @attributes.each { |value| block.call(value) }
   end
 
-  # Returns an array populated with the attribute keys.
-  def keys
-    @attributes.keys
-  end
-
   # Returns a JSON representation of the structure.
   def to_json(*args)
     klass = self.class.name
@@ -180,11 +168,6 @@ module Structure
       to_json(*args)
   end
 
-  # Returns an array populated with the attribute values.
-  def values
-    @attributes.values
-  end
-
   # Compares this object with another object for equality. A Structure is equal
   # to the other object when latter is of the same class and the two objects'
   # attributes are the same.

data/structure.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name        = "structure"
   s.version     = Structure::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Paper Cavalier"]
+  s.authors     = ["Hakan Ensari"]
   s.email       = ["code@papercavalier.com"]
   s.homepage    = "http://code.papercavalier.com/structure"
-  s.summary     = "Turns a class into a key/value container"
-  s.description = "Structure turns a class into a key/value container."
+  s.summary     = "A Struct-like key/value container"
+  s.description = "Structure is a Struct-like key/value container."
 
   s.rubyforge_project = "structure"
 

data/test/structure_test.rb

@@ -1,134 +1,129 @@
+$:.push File.expand_path('../../lib', __FILE__)
+
 require 'rubygems'
 require 'bundler/setup'
-require 'test/unit'
 
-require File.expand_path("../../lib/structure", __FILE__)
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+require 'structure'
+require 'test/unit'
 
-class Person
-  include Structure
+class Book < Structure
+  key  :title
+  key  :published, Boolean, :default => true
+  key  :pages,     Integer
+end
 
-  attribute   :name
-  attribute   :age, Integer
-  attribute   :married, Boolean, :default => false
-  embeds_one  :spouse 
-  embeds_many :children
+class Person < Structure
+  key  :name
+  one  :partner
+  many :friends
 end
 
 class TestStructure < Test::Unit::TestCase
   def test_enumeration
-    person = Person.new
-    assert_respond_to(person, :map)
+    assert_respond_to Book.new, :map
   end
 
-  def test_method_generation
-    person = Person.new
-    assert_respond_to(person, :name)
-    assert_respond_to(person, :name=)
-    assert_respond_to(person, :name?)
+  def test_accessors
+    book = Book.new
+    assert_respond_to book, :title
+    assert_respond_to book, :title=
   end
 
-  def test_attribute_errors
-    assert_raise(NameError) { Person.attribute :class }
-    assert_raise(TypeError) { Person.attribute :foo, Object }
-    assert_raise(TypeError) { Person.attribute :foo, :default => 1 }
+  def test_key_errors
+    assert_raise(NameError) { Book.key :class }
+    assert_raise(TypeError) { Book.key :foo, Object }
+    assert_raise(TypeError) { Book.key :foo, :default => 1 }
   end
 
   def test_default_attributes
-    assert_equal({ :name => nil, :age => nil, :married => false, :spouse => nil, :children => [] }, Person.default_attributes)
+    exp = { :title     => nil,
+            :published => true,
+            :pages => nil }
+    assert_equal exp, Book.default_attributes
   end
 
   def test_initialization
-    person = Person.new(:name => 'John', :age => 28)
-    assert_equal('John', person.name)
-    assert_equal(28, person.age)
+    book = Book.new(:title => 'Foo', :pages => 100)
+    assert_equal 'Foo', book.title
+    assert_equal 100, book.pages
   end
 
   def test_typecasting
-    person = Person.new
+    book = Book.new
 
-    person.age = "28"
-    assert_equal(28, person.age)
+    book.pages = "100"
+    assert_equal 100, book.pages
 
-    person.age = nil
-    assert_nil(person.age)
-  end
+    book.pages = nil
+    assert_nil book.pages
 
-  def test_presence
-    person = Person.new
-
-    person.married = nil
-    assert(!person.married?)
-
-    person.married = false
-    assert(!person.married?)
-
-    person.married = true
-    assert(person.married?)
-  end
-
-  def test_default_type
-    person = Person.new
-    person.name = 1
-    assert(person.name.is_a? String)
+    book.title = 1
+    book.title = '1'
   end
 
   def test_boolean_typecasting
-    person = Person.new
+    book = Book.new
 
-    person.married = 'false'
-    assert(person.married == false)
+    book.published = 'false'
+    assert book.published == false
 
-    person.married = 'FALSE'
-    assert(person.married == false)
+    book.published = 'FALSE'
+    assert book.published == false
 
-    person.married = '0'
-    assert(person.married == false)
+    book.published = '0'
+    assert book.published == false
 
-    person.married = 'foo'
-    assert(person.married == true)
+    book.published = 'foo'
+    assert book.published == true
 
-    person.married = 0
-    assert(person.married == false)
+    book.published = 0
+    assert book.published == false
 
-    person.married = 10
-    assert(person.married == true)
+    book.published = 10
+    assert book.published == true
   end
 
   def test_defaults
-    person = Person.new
-    assert_equal(false, person.married)
-    assert_equal(nil, person.name)
-    assert_equal(nil, person.spouse)
-    assert_equal([], person.children)
+    assert_equal nil, Book.new.title
+    assert_equal true, Book.new.published
+    assert_equal nil, Person.new.partner
+    assert_equal [], Person.new.friends
   end
 
   def test_array
     person = Person.new
-    child = Person.new
-    person.children << child
-    assert_equal(1, person.children.count)
-    assert_equal(0, child.children.count)
+    friend = Person.new
+    person.friends << person
+    assert_equal 1, person.friends.count
+    assert_equal 0, friend.friends.count
   end
 
   def test_json
-    person = Person.new(:name => 'Joe')
-    json = person.to_json
-    assert_equal(person, JSON.parse(json))
+    book = Book.new(:title => 'Foo')
+    json = book.to_json
+    assert_equal book, JSON.parse(json)
   end
 
   def test_json_with_nested_structures
     person = Person.new
-    person.children << Person.new
+    person.friends << Person.new
+    person.partner = Person.new
     json = person.to_json
-    assert(JSON.parse(json).children.first.is_a? Person)
+    assert JSON.parse(json).friends.first.is_a? Person
+    assert JSON.parse(json).partner.is_a? Person
   end
 
   def test_json_with_active_support
     require 'active_support/ordered_hash'
     require 'active_support/json'
 
-    person = Person.new
-    assert(person.as_json(:only => :name).has_key?(:name))
-    assert(!person.as_json(:except => :name).has_key?(:name))
+    book = Book.new
+    assert book.as_json(:only => :title).has_key?(:title)
+    assert !book.as_json(:except => :title).has_key?(:title)
   end
 end

metadata

@@ -1,35 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: structure
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 13
-  - 1
-  version: 0.13.1
+version: !ruby/object:Gem::Version
+  version: 0.14.1
+  prerelease: 
 platform: ruby
-authors: 
-- Paper Cavalier
+authors:
+- Hakan Ensari
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-26 00:00:00 +01:00
-default_executable: 
+date: 2011-08-11 00:00:00.000000000Z
 dependencies: []
-
-description: Structure turns a class into a key/value container.
-email: 
+description: Structure is a Struct-like key/value container.
+email:
 - code@papercavalier.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
-- .rvmrc
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -39,41 +28,33 @@ files:
 - lib/structure.rb
 - lib/structure/version.rb
 - structure.gemspec
-- test/models.rb
 - test/structure_test.rb
-has_rdoc: true
 homepage: http://code.papercavalier.com/structure
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -2785152293474576694
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3339689548870644271
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: structure
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Turns a class into a key/value container
-test_files: 
-- test/models.rb
+summary: A Struct-like key/value container
+test_files:
 - test/structure_test.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm --create use 1.9.2@structure

data/test/models.rb

@@ -1,8 +0,0 @@
-class Book
-  include Structure
-
-  key :title
-  key :authors, Array, :value => []
-end
-
-