dm-mapping 0.2.1 → 0.3.0

data/CHANGES

@@ -1,5 +1,17 @@
 = dm-mapper changes history
 
+== dm-mapping 0.3.0,
+
+* added support of mapping Integer, DateTime, etc.
+* renamed some internals.
+* changed the way requiring adapter. no more setup first.
+* added Migration#storages_and_fields
+* added mapping :serial => true for primary key.
+* added mapping :default, and :nullable.
+* added support of mapping name. (through passing symbol or string)
+* added support of multiple arguments.
+* removed Mapping::All, use /.*/ instead.
+
 == dm-mapping 0.2.1, 2008-08-03
 
 * fixed a bug that type map should lookup for parent.

data/README

@@ -1,4 +1,4 @@
-= dm-mapping 0.2.1
+= dm-mapping 0.3.0
 by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
   strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org
 
@@ -9,10 +9,6 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
  DataMapper plugin that helps you manipulate an existing database.
  It creates mappings between existing columns and model's properties.
 
-== FEATURES:
-
-placeholder
-
 == SYNOPSIS:
 
  require 'dm-core'
@@ -24,36 +20,45 @@ placeholder
 
  class User
    include DataMapper::Resource
+   # maping all
    mapping /.*/
-   mapping DataMapper::Mapping::All
+
+   # mapping for ended with _at, and started with salt_
    mapping /_at$/, /^salt_/
-   mapping :account, :email
-   mapping *storage_fields
+
+   # mapping id and email
+   mapping :id, :email
+
+   # mapping all fields with type String, and id
+   mapping String, :id
+
+   # mapping login, and all fields with type Integer
+   mapping :login, Integer
  end
 
  DataMapper.repository.adapter.storages
  # => ['users']
 
  User.fields
- # => [['account',     String,   {}],
-       ['email',       String,   {}],
+ # => [['id',          Integer,  {:serial => true}],
+       ['email',       String,   {:default => 'nospam@nospam.tw'}],
        ['created_at',  DateTime, {}],
        ['salt_first',  String,   {}],
        ['salt_second', String,   {}]]
 
  DataMapper.repository.adapter.fields('users')
- # => [['account',     String,   {}],
-       ['email',       String,   {}],
+ # => [['id',          Integer,  {:serial => true}],
+       ['email',       String,   {:default => 'nospam@nospam.tw'}],
        ['created_at',  DateTime, {}],
        ['salt_first',  String,   {}],
        ['salt_second', String,   {}]]
 
  DataMapper.repository.adapter.storages_and_fields
- # => {'users' => [['account',     String,   {}],
-                   ['email',       String,   {}],
+ # => {'users' => [['id',          Integer,  {:serial => true}],
+                   ['email',       String,   {:default => 'nospam@nospam.tw'}],
                    ['created_at',  DateTime, {}],
                    ['salt_first',  String,   {}],
-                   ['salt_second', String,   {}]] }
+                   ['salt_second', String,   {}]]}
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -28,6 +28,9 @@ namespace :git do
   end
 end
 
+# supress warnings, there's too many warnings in dm-core
+PROJ.ruby_opts.delete '-w'
+
 PROJ.name = 'dm-mapping'
 PROJ.authors = 'Lin Jen-Shin (a.k.a. godfat 真常)'
 PROJ.email = 'strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org'
@@ -35,9 +38,9 @@ PROJ.url = 'http://github.com/godfat/dm-mapping'
 PROJ.description = PROJ.summary = paragraphs_of('README', 'description').join("\n\n")
 PROJ.changes = paragraphs_of('CHANGES', 0..1).join("\n\n")
 PROJ.rubyforge.name = 'ludy'
-PROJ.version = File.open('lib/dm-mapping/version.rb', 0){ |f| f.read.gsub(/.*VERSION = "(.*)".*/m, '\1') }
+PROJ.version = File.open('lib/dm-mapping/version.rb', 0){ |f| f.read.gsub(/.*VERSION = '(.*)'.*/m, '\1') }
 
-PROJ.gem.dependencies << 'dm-core'
+PROJ.gem.dependencies << ['dm-core', '>=0.9.3']
 # PROJ.gem.executables = []
 # PROJ.gem.files = []
 

data/TODO

@@ -1,9 +1,4 @@
 = dm-mapping todo list
 
-* o DataMapper::Resource#mapping
-* o DataMapper::Resource#storage_fields
-* x DataMapper.repository.storages_and_fields
-
-* o Mapping::All
-*   Mapping::String
-*   Mapping::Integer
+* postgresql adapter
+* mysql adapter

data/dm-mapping.gemspec

@@ -1,15 +1,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-mapping}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lin Jen-Shin (a.k.a. godfat \347\234\237\345\270\270)"]
-  s.date = %q{2008-08-03}
+  s.date = %q{2008-08-04}
   s.description = %q{DataMapper plugin that helps you manipulate an existing database. It creates mappings between existing columns and model's properties.}
   s.email = %q{strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org}
   s.extra_rdoc_files = [".gitignore", "CHANGES", "LICENSE", "NOTICE", "README", "TODO", "dm-mapping.gemspec", "tasks/ann.rake", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake"]
-  s.files = [".gitignore", "CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "dm-mapping.gemspec", "lib/dm-mapping.rb", "lib/dm-mapping/adapters/sqlite3adapter.rb", "lib/dm-mapping/model.rb", "lib/dm-mapping/type_map.rb", "lib/dm-mapping/version.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "test/test_dm-mapping.rb"]
+  s.files = [".gitignore", "CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "dm-mapping.gemspec", "lib/dm-mapping.rb", "lib/dm-mapping/adapters/abstract_adapter.rb", "lib/dm-mapping/adapters/sqlite3adapter.rb", "lib/dm-mapping/model.rb", "lib/dm-mapping/type_map.rb", "lib/dm-mapping/version.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "test/test_dm-mapping.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/godfat/dm-mapping}
   s.rdoc_options = ["--diagram", "--charset=utf-8", "--inline-source", "--line-numbers", "--promiscuous", "--main", "README"]
@@ -24,11 +24,11 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if current_version >= 3 then
-      s.add_runtime_dependency(%q<dm-core>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.9.3"])
     else
-      s.add_dependency(%q<dm-core>, [">= 0"])
+      s.add_dependency(%q<dm-core>, [">= 0.9.3"])
     end
   else
-    s.add_dependency(%q<dm-core>, [">= 0"])
+    s.add_dependency(%q<dm-core>, [">= 0.9.3"])
   end
 end

data/lib/dm-mapping.rb

@@ -3,27 +3,24 @@ gem 'dm-core', '=0.9.3'
 require 'dm-core'
 
 module DataMapper
-  module Mapping
-    All = /.*/
-  end
-end
 
-module DataMapper
-  module Adapters
-    class AbstractAdapter
-      module Migration
-        # returns all tables in the repository.
-        # e.g. ['comments', 'posts']
-        def storages
-          raise NotImplementedError
-        end
+  class << self
+    # ensure the using adapter is extended by dm-mapping
+    def ensure_required_dm_mapping_adapter
+      adapter_name = repository.adapter.class.to_s.split('::').last.downcase
+      require "dm-mapping/adapters/#{adapter_name}"
+    end
 
-        def fields storage
-          raise NotImplementedError
-        end
-      end
+    # dirty hack that hook requirement after setup.
+    alias_method :__setup_alias_by_dm_mapping__, :setup
+    private :__setup_alias_by_dm_mapping__
+    def setup name, uri_or_options
+      adapter = __setup_alias_by_dm_mapping__ name, uri_or_options
+      ensure_required_dm_mapping_adapter
+      adapter
     end
   end
+
 end
 
-require "dm-mapping/adapters/#{DataMapper.repository.adapter.class.to_s.split('::').last.downcase}"
+require 'dm-mapping/model'

data/lib/dm-mapping/adapters/abstract_adapter.rb

@@ -0,0 +1,25 @@
+
+module DataMapper
+  module Adapters
+    class AbstractAdapter
+      module Migration
+        # returns all tables in the repository.
+        # e.g. ['comments', 'posts']
+        def storages
+          raise NotImplementedError
+        end
+
+        def fields storage
+          raise NotImplementedError
+        end
+
+        def storages_and_fields
+          storages.inject({}){ |result, storage|
+            result[storage] = fields(storage)
+            result
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dm-mapping/adapters/sqlite3adapter.rb

@@ -1,7 +1,6 @@
 
-require 'dm-mapping'
+require 'dm-mapping/adapters/abstract_adapter'
 require 'dm-mapping/type_map'
-require 'dm-mapping/model'
 
 module DataMapper
   module Adapters
@@ -22,12 +21,17 @@ module DataMapper
         def fields table
           query_table(table).map{ |field|
             type, chain = self.class.type_map.
-              find_primitive(field.type.gsub(/\(\d+\)/, '').upcase)
+              lookup_primitive(field.type.gsub(/\(\d+\)/, '').upcase)
 
             # stupid hack
             type = String if type == Class
 
-            [field.name, type, chain.attributes]
+            attrs = {}
+            attrs[:serial] = true if field.pk != 0
+            attrs[:nullable] = true if field.notnull != 0 && !attrs[:serial]
+            attrs[:default] = field.dflt_value[1..-2] if field.dflt_value
+
+            [field.name, type, attrs.merge(chain.attributes)]
           }
         end
       end

data/lib/dm-mapping/model.rb

@@ -1,14 +1,36 @@
 
 module DataMapper
   module Model
-    def mapping regexp = /.*/
+    # returing all fields, with format [[name, type, attrs]]
+    def fields
+      DataMapper.ensure_required_dm_mapping_adapter
+      DataMapper.repository.adapter.fields storage_name
+    end
+
+    protected
+    def mapping *targets
+      DataMapper.ensure_required_dm_mapping_adapter
+      targets << /.*/ if targets.empty?
+
       fields.map{ |field|
         name, type, attrs = field
-        property name.to_sym, type, attrs if name =~ regexp
+
+        targets.each{ |target|
+          case target
+            when Regexp;
+              property name.to_sym, type, attrs if name =~ target
+
+            when Symbol, String;
+              property name.to_sym, type, attrs if name == target.to_s
+
+            when Class;
+              property name.to_sym, type, attrs if type == target
+
+            else
+              raise ArgumentError.new("invalid argument: #{target.inspect}")
+          end
+        }
       }
     end
-    def fields
-      DataMapper.repository.adapter.fields storage_name
-    end
   end
 end

data/lib/dm-mapping/type_map.rb

@@ -1,10 +1,10 @@
 
 module DataMapper
   class TypeMap
-    def find_primitive primitive, type_map = self
+    def lookup_primitive primitive, type_map = self
       type_map.chains.find{ |type, chain|
         primitive == chain.primitive
-      } or find_primitive(primitive, type_map.parent)
+      } or lookup_primitive(primitive, type_map.parent)
     end
   end
 end

data/lib/dm-mapping/version.rb

@@ -1,5 +1,5 @@
 module DataMapper
   module Mapping
-    VERSION = "0.2.1" unless defined?(DataMapper::Mapping::VERSION)
+    VERSION = '0.3.0' unless defined?(DataMapper::Mapping::VERSION)
   end
 end

data/test/test_dm-mapping.rb

@@ -3,6 +3,7 @@ require 'test/unit'
 
 require 'rubygems'
 require 'data_mapper'
+require 'dm-mapping'
 
 class DMMTest < Test::Unit::TestCase
   class User
@@ -20,43 +21,117 @@ class DMMTest < Test::Unit::TestCase
     belongs_to :user
 
     property :id,    Integer, :serial => true
-    property :title, String
+    property :title, String,  :default => 'default title'
     property :body,  Text
   end
 
-  class Tmp; end
+  class Model; end
 
-  def test_storages
-    @dm = DataMapper.setup :default, 'sqlite3:tmp.db'
-    require 'dm-mapping'
-    DataMapper.auto_migrate!
+  def create_fake_model
+    [Model.dup.__send__(:include, DataMapper::Resource),
+     DataMapper.setup(:default, 'sqlite3:tmp.db')]
+  end
+
+  @@dm = DataMapper.setup :default, 'sqlite3:tmp.db'
+  def dm; @@dm; end
+
+  def setup
+    User.auto_migrate!
+    Comment.auto_migrate!
+  end
+
+  def user_fields
+    [['created_at', DateTime,                {}],
+     ['id',         Integer,                 {:serial => true}],
+     ['login',      String,                  {}],
+     ['sig',        DataMapper::Types::Text, {}]]
+  end
 
-    assert_equal ['dmm_test_comments', 'dmm_test_users'], @dm.storages.sort
-    comment_fields = [["body", DataMapper::Types::Text, {}],
-                      ["id", Integer, {}],
-                      ["title", String, {}],
-                      ["user_id", Integer, {}]]
+  def comment_fields
+    [['body',    DataMapper::Types::Text, {}],
+     ['id',      Integer                , {:serial => true}],
+     ['title',   String                 , {:default => 'default title'}],
+     ['user_id', Integer                , {}]]
+  end
 
-    assert_equal comment_fields, @dm.fields('dmm_test_comments').sort
+  def test_storages
+    assert_equal ['dmm_test_comments', 'dmm_test_users'], dm.storages.sort
+    assert_equal comment_fields, dm.fields('dmm_test_comments').sort
+  end
 
+  def test_create_comment
     Comment.create(:title => 'XD')
     assert_equal 1, Comment.first.id
     assert_equal 'XD', Comment.first.title
+  end
+
+  def test_mapping_all
+    test_create_comment # for fixtures
+    model, local_dm = create_fake_model
+    model.storage_names[:default] = 'dmm_test_comments'
+
+    assert_equal ['dmm_test_comments', 'dmm_test_users'], local_dm.storages.sort
+    assert_equal 'dmm_test_comments', model.storage_name
+
+    assert_equal 1, model.count
+    assert_equal comment_fields, model.fields.sort
 
-    #
+    model.send :mapping
+    assert_equal 'XD', model.first.title
+    assert_equal 1, model.first.id
+  end
+
+  def test_mapping_and_create
+    model, local_dm = create_fake_model
+    model.storage_names[:default] = 'dmm_test_comments'
+    model.send :mapping
+
+    model.create(:title => 'orz')
+    assert_equal 'orz', model.first.title
+    assert_equal 1, model.first.id
+
+    model.create
+    assert_equal 'default title', model.get(2).title
+  end
+
+  def test_storages_and_fields
+    assert_equal user_fields, dm.fields('dmm_test_users').sort
+    assert_equal( {'dmm_test_users' => user_fields, 'dmm_test_comments' => comment_fields},
+                  dm.storages_and_fields.inject({}){ |r, i|
+                    key, value = i
+                    r[key] = value.sort
+                    r
+                  } )
+  end
 
-    Tmp.send :include, DataMapper::Resource
-    @dm = DataMapper.setup :default, 'sqlite3:tmp.db'
-    assert_equal ['dmm_test_comments', 'dmm_test_users'], @dm.storages.sort
+  def test_mapping_type
+    model, local_dm = create_fake_model
+    model.storage_names[:default] = 'dmm_test_comments'
+    model.send :mapping, Integer
 
-    Tmp.storage_names[:default] = 'dmm_test_comments'
-    assert_equal 'dmm_test_comments', Tmp.storage_name
+    assert_equal ['id', 'user_id'], model.properties.map(&:name).map(&:to_s).sort
+  end
+
+  def test_mapping_multiple
+    model, local_dm = create_fake_model
+    model.storage_names[:default] = 'dmm_test_users'
+    model.send :mapping, :login, Integer
+
+    assert_equal ['id', 'login'], model.properties.map(&:name).map(&:to_s).sort
+  end
 
-    assert_equal 1, Tmp.count
-    assert_equal comment_fields, Tmp.fields.sort
+  def test_mapping_regexp
+    model, local_dm = create_fake_model
+    model.storage_names[:default] = 'dmm_test_comments'
+    model.send :mapping, /id$/
 
-    Tmp.mapping
-    assert_equal 'XD', Tmp.first.title
-    assert_equal 1, Tmp.first.id
+    assert_equal ['id', 'user_id'], model.properties.map(&:name).map(&:to_s).sort
   end
+
+  def test_invalid_argument
+    assert_raise(ArgumentError){
+      User.send :mapping, 29
+    }
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-mapping
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Lin Jen-Shin (a.k.a. godfat \xE7\x9C\x9F\xE5\xB8\xB8)"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-03 00:00:00 +08:00
+date: 2008-08-04 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.9.3
     version: 
 description: DataMapper plugin that helps you manipulate an existing database. It creates mappings between existing columns and model's properties.
 email: "strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org"
@@ -58,6 +58,7 @@ files:
 - TODO
 - dm-mapping.gemspec
 - lib/dm-mapping.rb
+- lib/dm-mapping/adapters/abstract_adapter.rb
 - lib/dm-mapping/adapters/sqlite3adapter.rb
 - lib/dm-mapping/model.rb
 - lib/dm-mapping/type_map.rb