structure 0.1.0 → 0.2.0

data/.gitignore

@@ -1,5 +1,4 @@
 pkg/*
 *.gem
 .bundle
-.rvmrc
 Gemfile.lock

data/README.md

@@ -1,25 +1,62 @@
 Structure
 =========
 
-Structure is a nested OpenStruct implementation. Or, recursively put, Structure is a truly OpenStruct OpenStruct.
+Structure is a better struct.
+
+
+    #_                                                                       d
+    ##_                                                                     d#
+    NN#p                                                                  j0NN
+    40NNh_                                                              _gN#B0
+    4JF@NNp_                                                          _g0WNNL@
+    JLE5@WRNp_                                                      _g@NNNF3_L
+    _F`@q4WBN@Np_                                                _gNN@ZL#p"Fj_
+    "0^#-LJ_9"NNNMp__                                         _gN#@#"R_#g@q^9"
+    a0,3_j_j_9FN@N@0NMp__                                __ggNZNrNM"P_f_f_E,0a
+    j  L 6 9""Q"#^q@NDNNNMpg____                ____gggNNW#W4p^p@jF"P"]"j  F
+    rNrr4r*pr4r@grNr@q@Ng@q@N0@N#@NNMpmggggmqgNN@NN@#@4p*@M@p4qp@w@m@Mq@r#rq@r
+     F Jp 9__b__M,Juw*w*^#^9#""EED*dP_@EZ@^E@*#EjP"5M"gM@p*Ww&,jL_J__f  F j
+    -r#^^0""E" 6  q  q__hg-@4""*,_Z*q_"^pwr""p*C__@""0N-qdL_p" p  J" 3""5^^0r-
+     t  J  __,Jb--N""",  *_s0M`""q_a@NW__JP^u_p"""p4a,p" _F""V--wL,_F_ F  #
+    _,Jp*^#""9   L  5_a*N"""q__INr" "q_e^"*,p^""qME_ y"""p6u,f  j'  f "N^--LL_
+      L  ]   k,w@#"""_  "_a*^E   ba-" ^qj-""^pe"  J^-u_f  _f "q@w,j   f  jL
+      #_,J@^""p  `_ _jp-""q  _Dw^" ^cj*""*,j^  "p#_  y""^wE_ _F   F"^qN,_j
+    w*^0   4   9__sAF" `L  _Dr"  m__m""q__a^"m__*  "qA_  j" ""Au__f   J   0^--
+      ]   J_,x-E   3_  jN^" `u _w^*_  _RR_  _J^w_ j"  "pL_  f   7^-L_F   #
+      jLs*^6   `_  _&*"  q  _,NF   "wp"  "*g"   _NL_  p  "-d_   F   ]"*u_F
+    ,x-"F   ]    Ax^" q    hp"  `u jM""u  a^ ^, j"  "*g_   p  ^mg_   D.H. 1992
+
+
+Usage
+-----
+
+Structure, like Struct, is great for defining ephemeral models.
 
     require 'structure'
-    
-    source = {
-      :title => 'Mille Plateaux',
-      :authors => [
-        {
-          :name => "Deleuze",
-        }
-      ],
-      :publisher => {
-        :name => "Minuit",
-    }
-    
-    book = Structure.new(source)
-    
-    puts book.authors.first.name
-    => "Gilles Deleuze"
-    
-    puts book.publisher.name
-    => "Minuit"
+
+    class Person < Structure
+      key :name
+      key :age,     :type => Integer
+      key :friends, :type => Array
+    end
+
+    john = Person.new(:name => "John",
+                      :age  => 28)
+
+    jane = Person.new(:name => "Jane",
+                      :age  => 24)
+
+    john.friends = [jane]
+
+When it comes to dumping JSON, Structure is more aesthetically-minded.
+
+    require 'structure/json'
+
+    json = john.to_json
+    => {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":"Jane","age":24,"friends":null}]}
+
+    person = JSON.parse(json)
+    person.friends.first.name
+    => "Jane"
+    person.friends.first.age
+    => 24

data/Rakefile

@@ -1,2 +1,13 @@
 require 'bundler'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
 Bundler::GemHelper.install_tasks
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = %w(-fd -c)
+end
+
+task :default => [:spec]

data/lib/structure.rb

@@ -1,44 +1,96 @@
-require 'ostruct'
-
-#
-# Structure is a nested OpenStruct implementation.
-#
-class Structure < OpenStruct
-  def initialize(source = {})
-    @table = {}
-    source.each do |k, v|
-      @table[k.to_sym] = structure(v)
-      new_ostruct_member(k)
+require 'json'
+
+# A better struct.
+class Structure
+
+  # Mix in the Enumerable module.
+  include Enumerable
+
+  @@keys = []
+
+  # Defines an attribute key.
+  #
+  # Takes a name and an optional hash of options. Available options are:
+  #
+  # * :type, which can be Integer, Float, String, and Array.
+  #
+  #    class Book
+  #      key :title,   :type => String
+  #      key :authors, :type => Array
+  #    end
+  #
+  def self.key(name, options={})
+    if method_defined?(name)
+      raise NameError, "#{name} is already defined"
     end
-  end
 
-  def method_missing(mid, *args) # :nodoc:
-    mname = mid.id2name
-    len = args.length
-    if mname.chomp!('=')
-      if len != 1
-        raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+    name = name.to_sym
+    type = options[:type]
+    @@keys << name
+
+    module_eval do
+
+      # Define a getter.
+      define_method(name) { @attributes[name] }
+
+      # Define a setter. The setter will optionally typecast.
+      define_method("#{name}=") do |value|
+        modifiable[name] =
+          if type && value
+            Kernel.send(type.to_s, value)
+          else
+            value
+          end
       end
-      modifiable[new_ostruct_member(mname)] = structure(args[0])
-    elsif len == 0
-      @table[mid]
-    else
-      raise NoMethodError, "undefined method `#{mname}' for #{self}", caller(1)
     end
   end
 
-  alias :to_hash :marshal_dump
+  # Creates a new structure.
+  #
+  # Optionally, populates the structure with a hash of attributes. Otherwise,
+  # all values default to nil.
+  def initialize(seed = {})
+    @attributes =
+      @@keys.inject({}) do |attributes, name|
+        attributes[name] = nil
+        attributes
+      end
+
+    seed.each { |key, value| self.send("#{key}=", value) }
+  end
+
+  # A hash of attributes.
+  attr_reader :attributes
+
+  def each(&block)
+    @attributes.each { |value| block.call(value) }
+  end
+
+  # Returns an array populated with the attribute keys.
+  def keys
+    @attributes.keys
+  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 also a Structure and the two objects'
+  # attributes are equal.
+  def ==(other)
+    other.is_a?(Structure) && @attributes == other.attributes
+  end
 
   private
 
-  def structure(o)
-    case o
-    when Hash
-      self.class.new(o)
-    when Array
-      o.map { |o| structure(o) }
-    else
-      o
+  def modifiable
+    begin
+      @modifiable = true
+    rescue
+      raise TypeError, "can't modify frozen #{self.class}", caller(3)
     end
+    @attributes
   end
 end

data/lib/structure/json.rb

@@ -0,0 +1,18 @@
+unless Object.const_defined?(:JSON) and ::JSON.const_defined?(:JSON_LOADED) and
+  ::JSON::JSON_LOADED
+  require 'json'
+end
+
+class Structure
+  def self.json_create(object)
+    object.delete('json_class')
+    new(object)
+  end
+
+  def to_json(*args)
+    klass = self.class.name
+    { JSON.create_id => klass }.
+      merge(@attributes).
+      to_json(*args)
+  end
+end

data/lib/structure/version.rb

@@ -0,0 +1,3 @@
+class Sucker
+  VERSION = '0.2.0'
+end

data/spec/models/person.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+require "rspec"
+
+require_relative "../lib/structure"
+
+Dir["#{File.dirname(__FILE__)}/models/**/*.rb"].each { |f| require f }

data/spec/structure/json_spec.rb

@@ -0,0 +1,31 @@
+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":null}' }
+
+    before do
+      require 'structure/json'
+    end
+
+    it "dumps to JSON" do
+      person.to_json.should eql json
+    end
+
+    it "loads from JSON" do
+      JSON.parse(json).should == person
+    end
+
+    context "when nesting other structures" do
+      before do
+        person.friends = [Person.new(:name => 'Jane')]
+      end
+
+      it "loads nested structures from JSON" do
+        json = person.to_json
+        JSON.parse(json).friends.first.name.should eql 'Jane'
+      end
+    end
+  end
+end

data/spec/structure_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Structure do
+  let(:person) { Person.new }
+
+  it "is enumerable" do
+    person.name ="Joe"
+    person.map { |key, value| value }.should include "Joe"
+  end
+
+  context "when object is frozen" do
+    before do
+      person.freeze
+    end
+
+    it "raises an error" do
+      expect do
+        person.name = 'Joe'
+      end.to raise_error TypeError
+    end
+  end
+
+  describe ".key" do
+    it "defines accessors" do
+      %w{name name=}.each { |method| person.should respond_to method }
+    end
+
+    context "when name clashes with an existing method" do
+      it "raises an error" do
+        expect do
+          Person.key :name
+        end.to raise_error NameError
+      end
+    end
+
+    context "when a type is specified" do
+      context "when setting the attribute to a non-nil value" do
+        it "casts the value" do
+          person.age = "28"
+          person.age.should eql 28
+        end
+      end
+
+      context "when setting the attribute to nil" do
+        it "does not set the value" do
+          person.age = nil
+          person.age.should be_nil
+        end
+      end
+    end
+  end
+
+  describe ".new" do
+    context "when attributes are specified" do
+      it "initializes the object with those attributes" do
+        jane = Person.new(:name => 'Jane', :age => "29")
+        jane.name.should eql 'Jane'
+        jane.age.should eql 29
+      end
+    end
+  end
+end

data/structure.gemspec

@@ -1,16 +1,31 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'structure/version'
+
 Gem::Specification.new do |s|
   s.name        = "structure"
-  s.version     = "0.1.0"
+  s.version     = Sucker::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Paper Cavalier"]
   s.email       = ["code@papercavalier.com"]
-  s.homepage    = ""
-  s.summary     = %q{Structure is a nested OpenStruct implementation.}
-  s.description = %q{A nested OpenStruct implementation}
+  s.homepage    = "http://rubygems.com/gems/structure"
+  s.summary     = "Structure is a better Struct."
+  s.description = <<-END_OF_DESCRIPTION.strip
+    Structure is a better Struct.
+
+    Like Struct, it is great for setting up ephemeral models. It also handles
+    typecasting and, unlike Struct, dumps nicely-formatted JSON.
+    END_OF_DESCRIPTION
 
   s.rubyforge_project = "structure"
 
+  {
+    'rspec'         => '~> 2.6.0',
+    'ruby-debug19'  => '~> 0.11.6'
+  }.each do |lib, version|
+    s.add_development_dependency lib, version
+  end
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: structure
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -10,11 +14,44 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +00:00
+date: 2011-05-26 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
-description: A nested OpenStruct implementation
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        - 6
+        version: 0.11.6
+  type: :development
+  version_requirements: *id002
+description: |-
+  Structure is a better Struct.
+  
+      Like Struct, it is great for setting up ephemeral models. It also handles
+      typecasting and, unlike Struct, dumps nicely-formatted JSON.
 email: 
 - code@papercavalier.com
 executables: []
@@ -29,10 +66,15 @@ files:
 - README.md
 - Rakefile
 - lib/structure.rb
+- lib/structure/json.rb
+- lib/structure/version.rb
+- spec/models/person.rb
+- spec/spec_helper.rb
+- spec/structure/json_spec.rb
+- spec/structure_spec.rb
 - structure.gemspec
-- test/structure_test.rb
 has_rdoc: true
-homepage: ""
+homepage: http://rubygems.com/gems/structure
 licenses: []
 
 post_install_message: 
@@ -45,19 +87,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: structure
-rubygems_version: 1.5.0
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Structure is a nested OpenStruct implementation.
+summary: Structure is a better Struct.
 test_files: 
-- test/structure_test.rb
+- spec/models/person.rb
+- spec/spec_helper.rb
+- spec/structure/json_spec.rb
+- spec/structure_spec.rb

data/test/structure_test.rb

@@ -1,46 +0,0 @@
-require 'minitest/spec'
-require File.expand_path('../../lib/structure', __FILE__)
-
-MiniTest::Unit.autorun
-
-describe Structure do
-  before do
-    @hash = {
-      :name     => "John",
-      :children => [ { :name => "Jim" } ],
-      :location => { :city => { :name => "London" } }
-    }
-  end
-
-  describe ".new" do
-    before do
-      @person = Structure.new(@hash)
-    end
-
-    it "structures nested hashes" do
-      @person.location.city.name.must_equal "London"
-    end
-
-    it "structures hashes in arrays" do
-      @person.children.must_be_instance_of Array
-      @person.children.first.name.must_equal "Jim"
-    end
-  end
-
-  describe "#=" do
-    before do
-      @person = Structure.new
-    end
-
-    it "structures nested hashes" do
-      @person.location = { :city => { :name => "London" } }
-      @person.location.city.name.must_equal "London"
-    end
-
-    it "structures hashes in arrays" do
-      @person.children = [ { :name => "Jim" } ]
-      @person.children.must_be_instance_of Array
-      @person.children.first.name.must_equal "Jim"
-    end
-  end
-end