dm-maker 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+DM_VERSION = "1.2.0"
+
+gem "dm-core", DM_VERSION
+gem "active_support"
+gem "i18n"
+
+group :test do
+  gem "test-unit"
+  gem "rake"
+  gem "dm-migrations", DM_VERSION
+  gem "dm-transactions", DM_VERSION
+  gem "dm-sqlite-adapter", DM_VERSION
+end

data/README

@@ -0,0 +1,55 @@
+dm-maker
+
+DataMapper extension to generate instances from YAML
+
+
+Examples
+========
+
+(extracted from tests, which provide a more comprehensive overview)
+
+    Person:
+    -
+      name: John Doe
+      age: 11
+    -
+      name: Jane Doe
+      age: 13
+
+associations:
+
+    Person:
+      name: John
+      cars:
+      -
+        name: Herbie
+        manufacturer:
+          name: VW
+      -
+        name: KITT
+        manufacturer:
+          name: Knight Industries
+
+ERB expansion:
+
+    Person:
+    <% 2.times do |i| %>
+    -
+      name: Johnny <%= i + 5 %>
+      age: <%= i %>
+    <% end %>
+
+references:
+
+    Family:
+    -
+      $id: f1
+      name: Doe
+
+    Person:
+    -
+      name: John
+      family: { $ref: f1 }
+    -
+      name: Jane
+      family: { $ref: f1 }

data/README.md

@@ -0,0 +1,55 @@
+dm-maker
+
+DataMapper extension to generate instances from YAML
+
+
+Examples
+========
+
+(extracted from tests, which provide a more comprehensive overview)
+
+    Person:
+    -
+      name: John Doe
+      age: 11
+    -
+      name: Jane Doe
+      age: 13
+
+associations:
+
+    Person:
+      name: John
+      cars:
+      -
+        name: Herbie
+        manufacturer:
+          name: VW
+      -
+        name: KITT
+        manufacturer:
+          name: Knight Industries
+
+ERB expansion:
+
+    Person:
+    <% 2.times do |i| %>
+    -
+      name: Johnny <%= i + 5 %>
+      age: <%= i %>
+    <% end %>
+
+references:
+
+    Family:
+    -
+      $id: f1
+      name: Doe
+
+    Person:
+    -
+      name: John
+      family: { $ref: f1 }
+    -
+      name: Jane
+      family: { $ref: f1 }

data/Rakefile

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+end
+
+desc "Run tests"
+task :default => :test

data/dm-maker.gemspec

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "dm-maker/version"
+
+DM_VERSION = "1.2.0"
+
+Gem::Specification.new do |s|
+  s.name        = "dm-maker"
+  s.version     = DataMapper::Maker::VERSION
+  s.authors     = ["FND"]
+  s.summary     = "DataMapper extension to generate instances from YAML"
+  s.description = "initializes resources from YAML data"
+
+  s.rubyforge_project = "dm-maker"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/test_*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "dm-core", DM_VERSION
+  s.add_dependency "active_support"
+  s.add_dependency "i18n"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "dm-migrations", DM_VERSION
+  s.add_development_dependency "dm-transactions", DM_VERSION
+  s.add_development_dependency "dm-sqlite-adapter", DM_VERSION
+end

data/lib/dm-maker.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+require "yaml"
+require "erb"
+require "active_support"
+require "active_support/core_ext"
+require "active_support/inflector"
+
+require "dm-maker/version"
+
+module DataMapper
+  module Maker
+
+    REL_TYPES = {
+      :to_one => [DataMapper::Associations::ManyToOne::Relationship,
+          DataMapper::Associations::OneToOne::Relationship],
+      :to_many => [DataMapper::Associations::ManyToMany::Relationship,
+          DataMapper::Associations::OneToMany::Relationship]
+    }
+
+    def self.make(data)
+      data = load_yaml(data) if data.class == String
+
+      cache = {}
+      return data.each_with_object({}) do |(class_name, instances), hsh|
+        klass = class_name.constantize
+        hsh[class_name] = instances.map { |instance_data|
+          create_instance(klass, instance_data, cache)
+        }
+      end
+    end
+
+    def self.create_instance(klass, data, cache={}) # TODO: document $id / $ref
+      if ref = data.delete("$ref")
+        raise ArgumentError if data.length > 0
+        return cache[ref]
+      end
+      id = data.delete("$id")
+
+      data.each { |key, value|
+        rel_name = key.to_sym
+        if rel = klass.relationships[rel_name]
+          if REL_TYPES[:to_many].include? rel.class
+            assoc_class = klass.new. # XXX: hacky
+                send(rel_name).relationship.child_model
+            value = value.map { |d|
+              if custom_class = d.delete("class") # TODO: document
+                assoc_class = custom_class.constantize
+              end
+              create_instance(assoc_class, d, cache)
+            }
+          elsif REL_TYPES[:to_one].include? rel.class
+            assoc_class = (rel.child_model == klass or klass < rel.child_model) ?
+                rel.parent_model : rel.child_model
+            value = create_instance(assoc_class, value, cache)
+          end
+        end
+        data[key] = value # XXX: dangerous while iterating over that same hash!?
+      }
+
+      instance = klass.new(data)
+      begin
+        instance.save
+      rescue DataMapper::SaveFailureError
+        # rely on parent saving -- FIXME: hacky!?
+      end
+
+      cache[id] = instance if id
+      return instance
+    end
+
+    def self.load_yaml(yaml)
+      yaml = ERB.new(yaml).result # TODO: document
+      # hack to retain order in Ruby 1.8
+      # TODO: document expectations/constraints (only required for $id / $ref)
+      yaml.split("\n\n").each_with_object(ActiveSupport::OrderedHash.new) { |yml, hsh|
+        hsh.merge! YAML.load(yml)
+      }
+    end
+
+  end
+end

data/lib/dm-maker/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module DataMapper
+  module Maker
+    VERSION = "1.0.0"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+require "dm-core"
+require "dm-transactions"
+require "dm-migrations"
+require "test/unit"
+
+require "models"
+require "dm-maker"
+
+DataMapper.setup(:default, "sqlite::memory:")
+DataMapper.finalize
+DataMapper.auto_migrate!
+DataMapper::Model.raise_on_save_failure = true
+
+def reset_database
+  models = DataMapper::Model.descendants
+  models.first.transaction do
+    models.each(&:destroy!)
+  end
+end

data/test/models.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+class Person
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+  property :age, Integer
+
+  belongs_to :family, :required => false
+  has n, :cars
+
+end
+
+class Family
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+
+  has n, :members, "Person"
+
+end
+
+class Car
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+
+  belongs_to :manufacturer, "Company"
+
+end
+
+class Company
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+
+end

data/test/test_associations.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+
+require "helper"
+
+class AssociationsTest < Test::Unit::TestCase
+
+  def setup
+    reset_database
+  end
+
+  def test_supports_to_one_associations
+    yaml = <<-EOF
+      Person:
+      -
+        name: John
+        family:
+          name: Doe
+    EOF
+    data = DataMapper::Maker.make(yaml)
+
+    assert_equal 1, Person.count
+    assert_equal 1, Family.count
+    assert_equal "John", data["Person"][0].name
+    assert_equal "Doe", data["Person"][0].family.name
+  end
+
+  def test_supports_to_many_associations
+    yaml = <<-EOF
+      Family:
+      -
+        name: Doe
+        members:
+        -
+          name: John
+        -
+          name: Jane
+    EOF
+    data = DataMapper::Maker.make(yaml)
+
+    assert_equal 1, Family.count
+    assert_equal 2, Person.count
+    assert_equal "Doe", data["Family"][0].name
+    assert_equal "John", data["Family"][0].members[0].name
+    assert_equal "Jane", data["Family"][0].members[1].name
+  end
+
+  def test_supports_nested_associations
+    yaml = <<-EOF
+      Family:
+      -
+        name: Doe
+        members:
+        -
+          name: John
+          cars:
+          -
+            name: Herbie
+            manufacturer:
+              name: VW
+          -
+            name: KITT
+            manufacturer:
+              name: Knight Industries
+    EOF
+    data = DataMapper::Maker.make(yaml)
+
+    assert_equal 1, Family.count
+    assert_equal 1, Person.count
+    assert_equal 2, Car.count
+    assert_equal "Herbie", Car.first.name
+    assert_equal "KITT", Car.last.name
+    assert_equal "VW", Company.first.name
+    assert_equal "Knight Industries", Company.last.name
+    assert_equal "VW", Family.first.members.first.cars.first.manufacturer.name
+  end
+
+end

data/test/test_basics.rb

@@ -0,0 +1,94 @@
+# encoding: UTF-8
+
+require "helper"
+
+class BasicsTest < Test::Unit::TestCase
+
+  def setup
+    reset_database
+  end
+
+  def test_accepts_yaml
+    yaml = <<-EOF
+      Person:
+      -
+        name: John Doe
+        age: 11
+      -
+        name: Jane Doe
+        age: 13
+    EOF
+    DataMapper::Maker.make(yaml)
+
+    assert_equal 2, Person.count
+    assert_equal "John Doe", Person.first.name
+    assert_equal 11, Person.first.age
+    assert_equal "Jane Doe", Person.last.name
+    assert_equal 13, Person.last.age
+  end
+
+  def test_accepts_plain_objects
+    DataMapper::Maker.make({
+      "Person" => [
+        {
+          "name" => "John Doe",
+          :age => 11
+        }, {
+          :name => "Jane Doe",
+          :age => 13
+        }
+      ]
+    })
+
+    assert_equal 2, Person.count
+    assert_equal "John Doe", Person.first.name
+    assert_equal 11, Person.first.age
+    assert_equal "Jane Doe", Person.last.name
+    assert_equal 13, Person.last.age
+  end
+
+  def test_returns_instances
+    yaml = <<-EOF
+      Person:
+      -
+        name: John
+        age: 11
+      -
+        name: Jane
+        age: 13
+
+      Family:
+      -
+        name: Doe
+    EOF
+    data = DataMapper::Maker.make(yaml)
+
+    assert_equal 2, data.length
+    assert_equal 2, data["Person"].length
+    assert_equal "John", data["Person"][0].name
+    assert_equal 11, data["Person"][0].age
+    assert_equal "Jane", data["Person"][1].name
+    assert_equal 13, data["Person"][1].age
+    assert_equal 1, data["Family"].length
+    assert_equal "Doe", data["Family"][0].name
+  end
+
+  def test_supports_ERB_expansion
+    yaml = <<-EOF
+      Person:
+      <% 2.times do |i| %>
+      -
+        name: Johnny <%= i + 5 %>
+        age: <%= i %>
+      <% end %>
+    EOF
+
+    data = DataMapper::Maker.make(yaml)
+    assert_equal 2, data["Person"].length
+    assert_equal "Johnny 5", data["Person"].first.name
+    assert_equal 0, data["Person"].first.age
+    assert_equal "Johnny 6", data["Person"].last.name
+    assert_equal 1, data["Person"].last.age
+  end
+
+end

data/test/test_references.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+require "helper"
+
+class ReferencesTest < Test::Unit::TestCase
+
+  def setup
+    reset_database
+  end
+
+  def test_supports_internal_references
+    yaml = <<-EOF
+      Family:
+      -
+        $id: f1
+        name: Doe
+
+      Person:
+      -
+        name: John
+        family: { $ref: f1 }
+      -
+        name: Jane
+        family: { $ref: f1 }
+    EOF
+    data = DataMapper::Maker.make(yaml)
+
+    assert_equal 1, Family.count
+    assert_equal 2, Person.count
+    assert_equal Person.first.family, Person.last.family
+    assert_equal "Doe", Person.first.family.name
+  end
+
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification 
+name: dm-maker
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- FND
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: dm-migrations
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: dm-transactions
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: dm-sqlite-adapter
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  type: :development
+  version_requirements: *id008
+description: initializes resources from YAML data
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- README.md
+- Rakefile
+- dm-maker.gemspec
+- lib/dm-maker.rb
+- lib/dm-maker/version.rb
+- test/helper.rb
+- test/models.rb
+- test/test_associations.rb
+- test/test_basics.rb
+- test/test_references.rb
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: dm-maker
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: DataMapper extension to generate instances from YAML
+test_files: 
+- test/test_associations.rb
+- test/test_basics.rb
+- test/test_references.rb