structure 0.14.1 → 0.15.0

data/CHANGELOG.md

@@ -1,34 +1,37 @@
 # CHANGELOG
 
-## 0.14.1
+## 0.15.0
+* bring back static module
+
+## 0.14.0
 * rename .attribute back to .key
 * shorten .embeds_many and .embeds_one to .many and .one
 * remove presence methods
 * add options to .many
 
-## 0.13.1
+## 0.13.0
 
 * remove static module
 * rename .key to .attribute
 
-# 0.12.1
+# 0.12.0
 
 * add static module
 
-# 0.11.1
+# 0.11.0
 
 * .key now emulates DataMapper.property
 
-# 0.10.1
+# 0.10.0
 
 * rename .has_one and .has_many to .embeds_one and .embeds_many to make room
   for associations
 
-# 0.9
+# 0.9.0
 
 * add presence method
 
-# 0.8
+# 0.8.0
 
 * make JSON patch compatible with Active Support
 * remove URI from list of types

data/Gemfile

@@ -1,6 +1,5 @@
 source :rubygems
 
 gem 'activesupport', '>= 3.0'
-gem 'json',          :platform => [:mri_18, :jruby]
+gem 'json',          :platform => [:mri_18, :jruby, :rbx]
 gem 'rake'
-gem 'ruby-debug19',  :platform => :mri_19, :require => 'ruby-debug'

data/README.md

@@ -1,12 +1,10 @@
 # Structure
 
-Structure is a Struct-like key/value container.
+[![travis](https://secure.travis-ci.org/hakanensari/structure.png)](http://travis-ci.org/hakanensari/structure)
 
-[![travis](https://secure.travis-ci.org/papercavalier/structure.png)](http://travis-ci.org/papercavalier/structure)
+Structure is a Struct-like key/value container .
 
-## Usage
-
-Set up a model:
+It will shine in the ephemeral landscape of API-backed data.
 
     require 'structure'
 
@@ -15,14 +13,6 @@ Set up a model:
       many :friends
     end
 
-Do things with it:
-
-    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":[]}]}
-
 Please see [the project page] [1] for more detailed info.
 
 [1]: http://code.papercavalier.com/structure/

data/lib/structure/static.rb

@@ -0,0 +1,61 @@
+# When included in a structure, this module turns it into a static
+# model, the data of which is sourced from a yaml file.
+#
+# This is a basic implementation and does not handle nested structures.
+# See test.
+class Structure
+  module Static
+    def self.included(base)
+      base.key(:id, Integer)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include Enumerable
+
+      # The path for the data file.
+      #
+      # This file should contain a YAML representation of the records.
+      #
+      # Overwrite this reader with an opiniated location to dry.
+      attr :data_path
+
+      # Returns all records.
+      def all
+        @records ||= data.map do |record|
+          record["id"] ||= increment_id
+          new(record)
+        end
+      end
+
+      # Yields each record to given block.
+      #
+      # Other enumerators will be made available by the Enumerable
+      # module.
+      def each(&block)
+        all.each { |record| block.call(record) }
+      end
+
+      # Finds a record by its ID.
+      def find(id)
+        detect { |record| record.id == id }
+      end
+
+      # Sets the path for the data file.
+      def set_data_path(data_path)
+        @data_path = data_path
+      end
+
+      private
+
+      def data
+        YAML.load_file(@data_path)
+      end
+
+
+      def increment_id
+        @increment_id = @increment_id.to_i + 1
+      end
+    end
+  end
+end

data/lib/structure/version.rb

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

data/lib/structure.rb

@@ -15,18 +15,16 @@ end
 # Structure is a Struct-like key/value container.
 #
 #    class Person < Structure
-#      key :name
-#      key :age, Integer
+#      key  :name
+#      many :friends
 #    end
 #
-#    person = Person.new(:name => "John")
-#    person.name
-#    => "John"
-#
 class Structure
   include Enumerable
 
-  # Structure supports the following types.
+  autoload :Static, 'structure/static'
+
+  # Available data type.
   TYPES = [Array, Boolean, Float, Hash, Integer, String, Structure]
 
   class << self
@@ -50,9 +48,9 @@ class Structure
     #
     # Takes a name, an optional type, and an optional hash of options.
     #
-    # The type can be +Array+, +Boolean+, +Float+, +Hash+, +Integer+, +String+,
-    # a +Structure+, or a subclass thereof. If none is specified, this defaults
-    # to +String+.
+    # The type can be +Array+, +Boolean+, +Float+, +Hash+, +Integer+,
+    # +String+, a +Structure+, or a subclass thereof. If none is
+    # specified, this defaults to +String+.
     #
     # Available options are:
     #
@@ -74,15 +72,26 @@ class Structure
       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}"
+        msg = "#{default} isn't a#{'n' if type.name.match(/^[AI]/)} #{type}"
         raise TypeError, msg
       end
 
       module_eval do
-        # Typecast value based on type.
-        typecast =
-          if type == Boolean
-            lambda do |value|
+        # A proc that typecasts value based on type.
+        typecaster =
+          case type.name
+          when 'Boolean'
+            lambda { |value|
+              # This should take care of the different representations
+              # of truth we might be feeding into the model.
+              #
+              # Any string other than "0" or "false" will evaluate to
+              # true.
+              #
+              # Any integer other than 0 will evaluate to true.
+              #
+              # Otherwise, we do the double-bang trick to non-boolean
+              # values.
               case value
               when Boolean
                 value
@@ -93,14 +102,17 @@ class Structure
               else
                 !!value
               end
-            end
-          elsif [Hash, Structure].include? type
-            lambda do |value|
+            }
+          when /Hash|Structure/
+            # We could possibly check if the value responds to #to_hash
+            # and cast to hash if it does, but I don't see any use case
+            # for this right now.
+            lambda { |value|
               unless value.is_a? type
                 raise TypeError, "#{value} is not a #{type}"
               end
               value
-            end
+            }
           else
             lambda { |value| Kernel.send(type.to_s, value) }
           end
@@ -109,7 +121,7 @@ class Structure
         define_method(name) { @attributes[name] }
 
         define_method("#{name}=") do |value|
-          @attributes[name] = value.nil? ? nil : typecast.call(value)
+          @attributes[name] = value.nil? ? nil : typecaster.call(value)
         end
       end
     end
@@ -168,9 +180,9 @@ class Structure
       to_json(*args)
   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.
+  # 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.
   def ==(other)
     other.is_a?(self.class) && @attributes == other.attributes
   end

data/test/fixtures/cities.yml

@@ -0,0 +1,5 @@
+---
+- id: 1
+  name: New York
+- id: 2
+  name: Tokyo

data/test/fixtures/cities_with_neighborhoods.yml

@@ -0,0 +1,7 @@
+---
+- id: 1
+  name: New York
+  neighborhoods:
+  - name: Manhattan
+  - name: Brooklyn
+  - name: Queens

data/test/fixtures/cities_without_ids.yml

@@ -0,0 +1,4 @@
+---
+- name: New York
+- name: Tokyo
+- name: Paris

data/test/helper.rb

@@ -0,0 +1,12 @@
+$:.push File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+require 'structure'
+require 'test/unit'

data/test/static_test.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../helper.rb', __FILE__)
+
+class City < Structure
+  include Static
+
+  key  :name
+  many :neighborhoods
+end
+
+class Neighborhood < Structure
+  key :name
+end
+
+class Dummy < Structure
+  include Static
+
+  key :name
+end
+
+class TestStatic < Test::Unit::TestCase
+  def fixture(klass, path)
+    klass.instance_variable_set(:@records, nil)
+    klass.instance_variable_set(:@increment_id, nil)
+    fixture = File.expand_path("../fixtures/#{path}.yml", __FILE__)
+    klass.set_data_path(fixture)
+  end
+
+  def test_class_enumeration
+    assert_respond_to City, :map
+  end
+
+  def test_all
+    fixture City, 'cities'
+    cities = City.all
+    assert_kind_of City, cities.first
+    assert_equal 2, cities.size
+  end
+
+  def test_find
+    fixture City, 'cities'
+    assert 'New York', City.find(1).name
+    assert_nil City.find(4)
+  end
+
+  def test_data_without_ids
+    fixture City, 'cities_without_ids'
+    assert_equal 'New York', City.find(1).name
+    assert_equal 'Paris', City.find(3).name
+  end
+
+  def test_auto_increment
+    fixture City, 'cities_without_ids'
+    fixture Dummy, 'cities_without_ids'
+    assert_equal 'New York', City.find(1).name
+    assert_equal 'New York', Dummy.find(1).name
+  end
+
+  def test_nesting
+    fixture City, 'cities_with_neighborhoods'
+    # assert_kind_of Neighborhood, City.first.neighborhoods.first
+  end
+end

data/test/structure_test.rb

@@ -1,15 +1,4 @@
-$:.push File.expand_path('../../lib', __FILE__)
-
-require 'rubygems'
-require 'bundler/setup'
-
-begin
-  require 'ruby-debug'
-rescue LoadError
-end
-
-require 'structure'
-require 'test/unit'
+require File.expand_path('../helper.rb', __FILE__)
 
 class Book < Structure
   key  :title
@@ -21,6 +10,7 @@ class Person < Structure
   key  :name
   one  :partner
   many :friends
+  many :parents, :default => 2.times.map { Person.new }
 end
 
 class TestStructure < Test::Unit::TestCase
@@ -103,6 +93,11 @@ class TestStructure < Test::Unit::TestCase
     assert_equal 0, friend.friends.count
   end
 
+  def test_many
+    person = Person.new
+    assert_equal 2, person.parents.size
+  end
+
   def test_json
     book = Book.new(:title => 'Foo')
     json = book.to_json

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structure
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000Z
+date: 2011-08-12 00:00:00.000000000Z
 dependencies: []
 description: Structure is a Struct-like key/value container.
 email:
@@ -26,8 +26,14 @@ files:
 - README.md
 - Rakefile
 - lib/structure.rb
+- lib/structure/static.rb
 - lib/structure/version.rb
 - structure.gemspec
+- test/fixtures/cities.yml
+- test/fixtures/cities_with_neighborhoods.yml
+- test/fixtures/cities_without_ids.yml
+- test/helper.rb
+- test/static_test.rb
 - test/structure_test.rb
 homepage: http://code.papercavalier.com/structure
 licenses: []
@@ -43,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3339689548870644271
+      hash: -1085682960934054294
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -57,4 +63,9 @@ signing_key:
 specification_version: 3
 summary: A Struct-like key/value container
 test_files:
+- test/fixtures/cities.yml
+- test/fixtures/cities_with_neighborhoods.yml
+- test/fixtures/cities_without_ids.yml
+- test/helper.rb
+- test/static_test.rb
 - test/structure_test.rb