structure 0.11.0 → 0.12.0

data/CHANGELOG.md

@@ -15,3 +15,7 @@
 # 0.11
 
 * .key now emulates the DataMapper.property method.
+
+# 0.12
+
+* Add basic support for static models.

data/README.md

@@ -79,7 +79,7 @@ Talk JSON:
 require 'structure/json'
 
 json = p1.to_json
-=> {"json_class":"Person","name":"John","age":28,"friends":[{"json_class":"Person","name":"John Doe","age":null,"friends":[]}],"partner":null}
+=> {"json_class":"Person","name":"Gilles","age":28,"friends":[{"json_class":"Person","name":"John Doe","age":null,"friends":[]}],"partner":null}
 
 person = JSON.parse(json)
 person.friends.first

data/lib/structure/static.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+
+class Structure
+
+  # An enumurable static structure, sourced from a yaml file.
+  module Static
+    def self.included(base)
+      base.key(:id, Integer)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include Enumerable
+
+      attr_accessor :data_path
+
+      def all
+        @all ||= data.map do |record|
+          record["id"] ||= increment_id
+          new(record)
+        end
+      end
+
+      def each(&block)
+        all.each { |record| block.call(record) }
+      end
+
+      def find(id)
+        detect { |record| record.id == id }
+      end
+
+      def set_data_path(data_path)
+        @data_path = data_path
+      end
+
+      private
+
+      def data
+        YAML.load_file(data_path)
+      end
+
+      # Overwrite this method with an opiniated location to dry if necessary.
+      def data_path
+        @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.11.0'
+  VERSION = '0.12.0'
 end

data/spec/fixtures/cities.yml

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

data/spec/fixtures/cities_without_id.yml

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

data/spec/models/city.rb

@@ -0,0 +1,9 @@
+require 'structure/static'
+
+class City < Structure
+  include Static
+
+  set_data_path File.expand_path("../../fixtures/cities.yml", __FILE__)
+
+  key :name
+end

data/spec/structure/static_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+class Structure
+  describe "A static structure" do
+    it "is enumerable" do
+      City.should be_an Enumerable
+    end
+
+    describe ".all" do
+      it "returns all records" do
+        City.all.should have(2).cities
+      end
+    end
+
+    describe ".find" do
+      it "finds a record by its id" do
+        City.find(1).should be_a City
+      end
+
+      it "returns nil if the record does not exist" do
+        City.find(4).should be_nil
+      end
+    end
+
+    describe ".set_data_path" do
+      it "sets the data path" do
+        City.set_data_path("foo")
+        City.send(:data_path).should eql "foo"
+      end
+    end
+
+    context "when sourced data does not include ids" do
+      before(:all) do
+        City.instance_variable_set(:@all, nil)
+        fixture = File.expand_path("../../fixtures/cities_without_id.yml", __FILE__) 
+        City.set_data_path(fixture)
+      end
+
+      it "should auto-increment the ids of loaded records" do
+        City.map(&:id).should =~ [1, 2, 3]
+      end
+
+      describe ".increment_id" do
+        before do
+          City.instance_variable_set(:@increment_id, nil)
+        end
+
+        it "starts from 1" do
+          City.send(:increment_id).should eql 1
+        end
+
+        it "auto-increments" do
+          City.send(:increment_id)
+          City.send(:increment_id).should eql 2
+        end
+      end
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 11
+  - 12
   - 0
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors: 
 - Paper Cavalier
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 +01:00
+date: 2011-07-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,11 +80,16 @@ files:
 - benchmark.rb
 - lib/structure.rb
 - lib/structure/json.rb
+- lib/structure/static.rb
 - lib/structure/version.rb
+- spec/fixtures/cities.yml
+- spec/fixtures/cities_without_id.yml
 - spec/models/book.rb
+- spec/models/city.rb
 - spec/models/person.rb
 - spec/spec_helper.rb
 - spec/structure/json_spec.rb
+- spec/structure/static_spec.rb
 - spec/structure_spec.rb
 - structure.gemspec
 has_rdoc: true
@@ -120,8 +125,12 @@ signing_key:
 specification_version: 3
 summary: A key/value container for modeling ephemeral data
 test_files: 
+- spec/fixtures/cities.yml
+- spec/fixtures/cities_without_id.yml
 - spec/models/book.rb
+- spec/models/city.rb
 - spec/models/person.rb
 - spec/spec_helper.rb
 - spec/structure/json_spec.rb
+- spec/structure/static_spec.rb
 - spec/structure_spec.rb