godfat-dm-mapping 0.3.0 → 0.4.0

data/.gitignore

@@ -1,2 +1,3 @@
 tmp*
 pkg
+doc

data/CHANGES

@@ -1,13 +1,11 @@
 = dm-mapper changes history
 
-== dm-mapping 0.4.0, 2008-08-04
-
-* added Migration#auto_genclass.
+=== dm-mapping 0.4.0, 2008-08-04
+* added Migration#auto_genclass!.
 * updated README.
 * added more rdoc.
 
-== dm-mapping 0.3.0, 2008-08-04
-
+=== dm-mapping 0.3.0, 2008-08-04
 * added support of mapping Integer, DateTime, etc.
 * renamed some internals.
 * changed the way requiring adapter. no more setup first.
@@ -18,14 +16,12 @@
 * added support of multiple arguments.
 * removed Mapping::All, use /.*/ instead.
 
-== dm-mapping 0.2.1, 2008-08-03
-
+=== dm-mapping 0.2.1, 2008-08-03
 * fixed a bug that type map should lookup for parent.
 * fixed a bug that sql type could be lower case.
   fixed by calling upcase.
 
-== dm-mapping 0.2.0, 2008-08-02
-
+=== dm-mapping 0.2.0, 2008-08-02
 * added Sqlite3Adapter::Migration#fields
 * added DataMapper::Model#mapping
 * added DataMapper::Model#fields
@@ -33,8 +29,7 @@
   mapping SQL type back to Ruby type.
 * added corresponded test.
 
-== dm-mapping 0.1.0, 2008-07-27
-
+=== dm-mapping 0.1.0, 2008-07-27
 * birthday!
 * added DataMapper.repository.storages for sqlite3.
 * please refer:

data/README

@@ -1,7 +1,10 @@
 = dm-mapping 0.4.0
 by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
-  strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org
+  godfat (XD) godfat.org
 
+== LINKS:
+
+* rdoc[http://ludy.rubyforge.org/dm-mapping]
 * github-project[http://github.com/godfat/dm-mapping]
 * rubyforge-project[http://rubyforge.org/projects/ludy]
 
@@ -59,13 +62,13 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
                    ['salt_second', String,   {}]]}
 
  # there's no guarantee of the order in returned array
- dm.auto_genclass
+ dm.auto_genclass!
  # => [DataMapper::Mapping::User,
        DataMapper::Mapping::SchemaInfo,
        DataMapper::Mapping::Session]
 
  # you can change the scope of generated models:
- dm.auto_genclass Object
+ dm.auto_genclass! Object
  # => [User, SchemaInfo, Session]
 
 == REQUIREMENTS:
@@ -78,18 +81,18 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
 
 == LICENSE:
 
-Apache License 2.0
+  Apache License 2.0
 
-Copyright (c) 2008, Lin Jen-Shin (a.k.a. godfat 真常)
+  Copyright (c) 2008, Lin Jen-Shin (a.k.a. godfat 真常)
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
 
-   http://www.apache.org/licenses/LICENSE-2.0
+     http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

data/Rakefile

@@ -33,26 +33,31 @@ 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'
+PROJ.email = 'godfat (XD) godfat.org'
 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.gem.dependencies << ['dm-core', '>=0.9.3']
+PROJ.gem.dependencies << ['dm-core', '>=0.9.3'] << ['extlib', '>=0.9.3']
 # PROJ.gem.executables = []
 # PROJ.gem.files = []
 
 PROJ.manifest_file = 'Manifest'
-PROJ.exclude << 'Manifest' << '^tmp'
+PROJ.exclude << 'Manifest' << '^tmp' << 'tmp$' << '^pkg'
 
+PROJ.readme_file = 'README'
 PROJ.rdoc.main = 'README'
-PROJ.rdoc.exclude << 'Manifest' << 'Rakefile' << 'tmp$' << '^tmp'
+PROJ.rdoc.remote_dir = 'dm-mapping'
+PROJ.rdoc.exclude << 'Rakefile' << '^tasks' << '^test'
 PROJ.rdoc.include << '\w+'
 PROJ.rdoc.opts << '--diagram' if !WIN32 and `which dot` =~ %r/\/dot/
 PROJ.rdoc.opts << '--charset=utf-8' << '--inline-source' << '--line-numbers' << '--promiscuous'
 
 PROJ.spec.opts << '--color'
 
+PROJ.ann.file = "ann-dm-mapping-#{PROJ.version}"
+PROJ.ann.paragraphs.concat %w[LINKS SYNOPSIS REQUIREMENTS INSTALL LICENSE]
+
 # EOF

data/dm-mapping.gemspec

@@ -1,15 +1,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-mapping}
-  s.version = "0.3.0"
+  s.version = "0.4.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-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/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.email = %q{godfat (XD) godfat.org}
+  s.extra_rdoc_files = [".gitignore", "CHANGES", "LICENSE", "NOTICE", "README", "TODO", "dm-mapping.gemspec"]
+  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_sqlite3.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"]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{ludy}
   s.rubygems_version = %q{1.2.0}
   s.summary = %q{DataMapper plugin that helps you manipulate an existing database. It creates mappings between existing columns and model's properties.}
-  s.test_files = ["test/test_dm-mapping.rb"]
+  s.test_files = ["test/test_sqlite3.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -25,10 +25,13 @@ Gem::Specification.new do |s|
 
     if current_version >= 3 then
       s.add_runtime_dependency(%q<dm-core>, [">= 0.9.3"])
+      s.add_runtime_dependency(%q<extlib>, [">= 0.9.3"])
     else
       s.add_dependency(%q<dm-core>, [">= 0.9.3"])
+      s.add_dependency(%q<extlib>, [">= 0.9.3"])
     end
   else
     s.add_dependency(%q<dm-core>, [">= 0.9.3"])
+    s.add_dependency(%q<extlib>, [">= 0.9.3"])
   end
 end

data/lib/dm-mapping.rb

@@ -4,6 +4,7 @@ require 'dm-core'
 
 module DataMapper
 
+  # default scope for Migration#auto_genclass!.
   module Mapping # namespace
   end
 
@@ -17,6 +18,8 @@ module DataMapper
     # dirty hack that hook requirement after setup.
     alias_method :__setup_alias_by_dm_mapping__, :setup
     private :__setup_alias_by_dm_mapping__
+    # dirty hack that hook requirement after setup.
+    # usage is the same as original setup.
     def setup name, uri_or_options
       adapter = __setup_alias_by_dm_mapping__ name, uri_or_options
       ensure_required_dm_mapping_adapter

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

@@ -3,16 +3,32 @@ module DataMapper
   module Adapters
     class AbstractAdapter
       module Migration
-        # returns all tables in the repository.
-        # e.g. ['comments', 'posts']
+        # returns all tables' name in the repository.
+        #  e.g.
+        #       ['comments', 'users']
         def storages
           raise NotImplementedError
         end
 
+        # returns all fields, with format [[name, type, attrs]]
+        #  e.g.
+        #       [['created_at',  DateTime, {}],
+        #        ['email',       String,   {:default => 'nospam@nospam.tw'}],
+        #        ['id',          Integer,  {:serial => true}],
+        #        ['salt_first',  String,   {}],
+        #        ['salt_second', String,   {}]]
         def fields storage
           raise NotImplementedError
         end
 
+        # returns a hash with storage names in keys and
+        # corresponded fields in values. e.g.
+        #   {'users' => [['id',          Integer,  {:serial => true}],
+        #                ['email',       String,   {:default => 'nospam@nospam.tw'}],
+        #                ['created_at',  DateTime, {}],
+        #                ['salt_first',  String,   {}],
+        #                ['salt_second', String,   {}]]}
+        # see Migration#storages and Migration#fields for detail
         def storages_and_fields
           storages.inject({}){ |result, storage|
             result[storage] = fields(storage)
@@ -20,7 +36,19 @@ module DataMapper
           }
         end
 
-        def auto_genclass scope = DataMapper::Mapping
+        # automaticly generate all model classes and mapping
+        # all fields with mapping /.*/ for you.
+        #  e.g.
+        #       dm.auto_genclass!
+        #       # => [DataMapper::Mapping::User,
+        #       #     DataMapper::Mapping::SchemaInfo,
+        #       #     DataMapper::Mapping::Session]
+        #
+        # you can change the scope of generated models:
+        #  e.g.
+        #       dm.auto_genclass! Object
+        #       # => [User, SchemaInfo, Session]
+        def auto_genclass! scope = DataMapper::Mapping
           require 'extlib'
           storages_and_fields.map{ |storage, fields|
             model = Class.new

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

@@ -4,7 +4,7 @@ require 'dm-mapping/type_map'
 
 module DataMapper
   module Adapters
-    class Sqlite3Adapter < DataObjectsAdapter
+    class Sqlite3Adapter < DataObjectsAdapter #:nodoc: all
       module Migration
         def storages
 # activerecord-2.1.0/lib/active_record/connection_adapters/sqlite_adapter.rb: 177

data/lib/dm-mapping/model.rb

@@ -1,13 +1,39 @@
 
 module DataMapper
   module Model
-    # returing all fields, with format [[name, type, attrs]]
+    # it simply calls Migration#fields(self.storage_name)
+    #  e.g.
+    #       DataMapper.repository.adapter.fields storage_name
     def fields
       DataMapper.ensure_required_dm_mapping_adapter
       DataMapper.repository.adapter.fields storage_name
     end
 
     protected
+    # it automaticly creates mappings from storage fields to properties.
+    # i.e. you don't have to specify any property if you are connecting
+    # to an existing database.
+    # you can pass it Regexp to map any field it matched, or just
+    # the field name in Symbol or String, or a Class telling it
+    # map any field which type equals to the Class.
+    #  e.g.
+    #       class User
+    #         include DataMapper::Resource
+    #         # maping all
+    #         mapping /.*/
+    #
+    #         # mapping for ended with _at, and started with salt_
+    #         mapping /_at$/, /^salt_/
+    #
+    #         # 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
     def mapping *targets
       DataMapper.ensure_required_dm_mapping_adapter
       targets << /.*/ if targets.empty?

data/lib/dm-mapping/type_map.rb

@@ -1,6 +1,10 @@
 
 module DataMapper
   class TypeMap
+    # reversed lookup for primitive type to ruby type.
+    #  e.g.
+    #       lookup_primitive('DATETIME')
+    #       # => { DateTime => {:auto_validation => true} }
     def lookup_primitive primitive, type_map = self
       type_map.chains.find{ |type, chain|
         primitive == chain.primitive

data/test/{test_dm-mapping.rb → test_sqlite3.rb}

@@ -25,17 +25,26 @@ class DMMTest < Test::Unit::TestCase
     property :body,  Text
   end
 
+
+  # override it to test with another adapter
+  # NOTE:
+  #   please provide an clean database because it is a destructive test!!
+  def setup_data_mapper
+    DataMapper.setup(:default, 'sqlite3:tmp.db')
+  end
+
+
   class Model; end
 
   def create_fake_model
-    [Model.dup.__send__(:include, DataMapper::Resource),
-     DataMapper.setup(:default, 'sqlite3:tmp.db')]
+    [ Model.dup.__send__(:include, DataMapper::Resource),
+      setup_data_mapper ]
   end
 
-  @@dm = DataMapper.setup :default, 'sqlite3:tmp.db'
-  def dm; @@dm; end
-
+  attr_reader :dm
   def setup
+    @dm = setup_data_mapper
+    # this is significant faster than DataMapper.auto_migrate!
     User.auto_migrate!
     Comment.auto_migrate!
   end
@@ -134,4 +143,25 @@ class DMMTest < Test::Unit::TestCase
     }
   end
 
+  def test_auto_genclass
+    for_test_auto_genclass
+    for_test_auto_genclass Object
+  end
+
+  def for_test_auto_genclass scope = DataMapper::Mapping
+    assert_equal ["#{scope == Object ? '' : "#{scope}::"}DmmTestComment",
+                  "#{scope == Object ? '' : "#{scope}::"}DmmTestUser"],
+                 dm.auto_genclass!(scope).map(&:to_s).sort
+
+    comment = scope.const_get('DmmTestComment')
+
+    assert_equal comment_fields, comment.fields.sort
+
+    test_create_comment
+
+    assert_equal 'XD', comment.first.title
+    comment.create(:title => 'orz', :body => 'dm-mapping')
+    assert_equal 'dm-mapping', comment.get(2).body
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: godfat-dm-mapping
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Lin Jen-Shin (a.k.a. godfat \xE7\x9C\x9F\xE5\xB8\xB8)"
@@ -21,8 +21,17 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.3
     version: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        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"
+email: godfat (XD) godfat.org
 executables: []
 
 extensions: []
@@ -35,18 +44,6 @@ extra_rdoc_files:
 - 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
 files: 
 - .gitignore
 - CHANGES
@@ -75,7 +72,7 @@ files:
 - tasks/spec.rake
 - tasks/svn.rake
 - tasks/test.rake
-- test/test_dm-mapping.rb
+- test/test_sqlite3.rb
 has_rdoc: true
 homepage: http://github.com/godfat/dm-mapping
 post_install_message: 
@@ -109,4 +106,4 @@ signing_key:
 specification_version: 2
 summary: DataMapper plugin that helps you manipulate an existing database. It creates mappings between existing columns and model's properties.
 test_files: 
-- test/test_dm-mapping.rb
+- test/test_sqlite3.rb