dm-is-reflective 0.8.0 → 0.9.0

data/CHANGES

@@ -1,4 +1,8 @@
-= dm-mapper changes history
+= dm-is-reflective changes history
+
+=== dm-is-reflective 0.9.0, 2010-07-05
+* adapted to dm-core 1.0.0
+* reanmed AbstractAdapter to DataObjectsAdapter
 
 === dm-is-reflective 0.8.0, 2009-09-16
 * require dm-core 0.10.0 and above now

data/NOTICE

@@ -1,16 +1,12 @@
 = notice and thanks
 
 * dm-is-reflective is a plugin of DataMapper
-    > sudo gem install dm-core
+    > gem install dm-core
     http://datamapper.org
 
 * this project skeleton is built through Mr Bones
     http://codeforpeople.rubyforge.org/bones/
 
-* thanks to Rails team with ActiveRecord, it's inspiring.
-  and some SQL snippets are borrowed from it.
-    http://rubyonrails.org
-
 * Ruby the great language
     http://www.ruby-lang.org
 
@@ -20,11 +16,5 @@
 * Rake the great task automation
     http://rake.rubyforge.org
 
-* Facets the great ruby library collection
-    http://facets.rubyforge.org/
-
-* Rubyforge for distributing ruby gems
-    http://rubyforge.org
-
 * Github for hosting git
     http://github.com

data/README

@@ -1,12 +1,12 @@
-= dm-is-reflective 0.8.0
+= dm-is-reflective 0.9.0
 by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
   godfat (XD) godfat.org
 
 == LINKS:
 
-* rdoc[http://ludy.rubyforge.org/dm-is-reflective]
-* github-project[http://github.com/godfat/dm-is-reflective]
-* rubyforge-project[http://rubyforge.org/projects/ludy]
+* {github}[http://github.com/godfat/dm-is-reflective]
+* {rubygems}[http://rubygems.org/gems/dm-is-reflective]
+* {rdoc}[http://rdoc.info/projects/godfat/dm-is-reflective]
 
 == DESCRIPTION:
 
@@ -23,25 +23,25 @@ by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
    is :reflective
 
    # mapping all, returns an array of properties indicating fields it mapped
-   mapping /.*/  # e.g. => [#<Property:#<Class:0x18f89b8>:id>,
+   reflect /.*/  # e.g. => [#<Property:#<Class:0x18f89b8>:id>,
                  #          #<Property:#<Class:0x18f89b8>:title>,
                  #          #<Property:#<Class:0x18f89b8>:body>,
                  #          #<Property:#<Class:0x18f89b8>:user_id>]
 
    # mapping all (with no argument at all)
-   mapping
+   reflect
 
    # mapping for field name ended with _at, and started with salt_
-   mapping /_at$/, /^salt_/
+   reflect /_at$/, /^salt_/
 
    # mapping id and email
-   mapping :id, :email
+   reflect :id, :email
 
    # mapping all fields with type String, and id
-   mapping String, :id
+   reflect String, :id
 
    # mapping login, and all fields with type Integer
-   mapping :login, Integer
+   reflect :login, Integer
  end
 
  # there's no guarantee of the order in storages array
@@ -50,27 +50,27 @@ by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
 
  # there's no guarantee of the order in fields array
  User.fields
- # => [[:created_at,  DateTime, {:nullable => true}],
-       [:email,       String,   {:nullable => true, :length => 255,
+ # => [[:created_at,  DateTime, {:required => false}],
+       [:email,       String,   {:required => false, :length => 255,
                                  :default => 'nospam@nospam.tw'}],
-       [:id,          Serial,   {:nullable => false, :serial => true,
+       [:id,          Serial,   {:required => true, :serial => true,
                                  :key => true}],
-       [:salt_first,  String,   {:nullable => true, :length => 50}],
-       [:salt_second, String,   {:nullable => true, :length => 50}]]
+       [:salt_first,  String,   {:required => false, :length => 50}],
+       [:salt_second, String,   {:required => false, :length => 50}]]
 
  dm.fields('users').sort_by{ |field| field.first.to_s } ==
         User.fields.sort_by{ |field| field.first.to_s }
  # => true
 
  dm.storages_and_fields
- # => {'users' => [[:id,          Serial,   {:nullable => false,
+ # => {'users' => [[:id,          Serial,   {:required => true,
                                              :serial => true,
                                              :key => true}],
-                   [:email,       String,   {:nullable => true,
+                   [:email,       String,   {:required => false,
                                              :default => 'nospam@nospam.tw'}],
-                   [:created_at,  DateTime, {:nullable => true}],
-                   [:salt_first,  String,   {:nullable => true, :length => 50}],
-                   [:salt_second, String,   {:nullable => true, :length => 50}]]}
+                   [:created_at,  DateTime, {:required => false}],
+                   [:salt_first,  String,   {:required => false, :length => 50}],
+                   [:salt_second, String,   {:required => false, :length => 50}]]}
 
  # there's no guarantee of the order in returned array
  dm.auto_genclass!
@@ -96,18 +96,18 @@ by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
 
 == REQUIREMENTS:
 
-* dm-core 0.10.0 or later
-* at least one do_* adapter
+* dm-core 1.0.0 or later
+* at least one dm-*-adapter
 
 == INSTALL:
 
-> sudo gem install dm-is-reflective
+> gem install dm-is-reflective
 
 == LICENSE:
 
   Apache License 2.0
 
-  Copyright (c) 2008, Lin Jen-Shin (aka godfat 真常)
+  Copyright (c) 2008-2010, Lin Jen-Shin (aka godfat 真常)
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

data/README.rdoc

@@ -0,0 +1,122 @@
+= dm-is-reflective 0.9.0
+by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
+  godfat (XD) godfat.org
+
+== LINKS:
+
+* {github}[http://github.com/godfat/dm-is-reflective]
+* {rubygems}[http://rubygems.org/gems/dm-is-reflective]
+* {rdoc}[http://rdoc.info/projects/godfat/dm-is-reflective]
+
+== DESCRIPTION:
+
+ DataMapper plugin that helps you manipulate an existing database.
+ It creates mappings between existing columns and model's properties.
+
+== SYNOPSIS:
+
+ require 'dm-is-reflective' # this would require 'dm-core'
+ dm = DataMapper.setup :default, 'sqlite3:db/development.sqlite3'
+
+ class User
+   include DataMapper::Resource
+   is :reflective
+
+   # mapping all, returns an array of properties indicating fields it mapped
+   reflect /.*/  # e.g. => [#<Property:#<Class:0x18f89b8>:id>,
+                 #          #<Property:#<Class:0x18f89b8>:title>,
+                 #          #<Property:#<Class:0x18f89b8>:body>,
+                 #          #<Property:#<Class:0x18f89b8>:user_id>]
+
+   # mapping all (with no argument at all)
+   reflect
+
+   # mapping for field name ended with _at, and started with salt_
+   reflect /_at$/, /^salt_/
+
+   # mapping id and email
+   reflect :id, :email
+
+   # mapping all fields with type String, and id
+   reflect String, :id
+
+   # mapping login, and all fields with type Integer
+   reflect :login, Integer
+ end
+
+ # there's no guarantee of the order in storages array
+ dm.storages
+ # => ['users']
+
+ # there's no guarantee of the order in fields array
+ User.fields
+ # => [[:created_at,  DateTime, {:required => false}],
+       [:email,       String,   {:required => false, :length => 255,
+                                 :default => 'nospam@nospam.tw'}],
+       [:id,          Serial,   {:required => true, :serial => true,
+                                 :key => true}],
+       [:salt_first,  String,   {:required => false, :length => 50}],
+       [:salt_second, String,   {:required => false, :length => 50}]]
+
+ dm.fields('users').sort_by{ |field| field.first.to_s } ==
+        User.fields.sort_by{ |field| field.first.to_s }
+ # => true
+
+ dm.storages_and_fields
+ # => {'users' => [[:id,          Serial,   {:required => true,
+                                             :serial => true,
+                                             :key => true}],
+                   [:email,       String,   {:required => false,
+                                             :default => 'nospam@nospam.tw'}],
+                   [:created_at,  DateTime, {:required => false}],
+                   [:salt_first,  String,   {:required => false, :length => 50}],
+                   [:salt_second, String,   {:required => false, :length => 50}]]}
+
+ # there's no guarantee of the order in returned array
+ dm.auto_genclass!
+ # => [DataMapper::Is::Reflective::User,
+       DataMapper::Is::Reflective::SchemaInfo,
+       DataMapper::Is::Reflective::Session]
+
+ # you can change the scope of generated models:
+ dm.auto_genclass! :scope => Object
+ # => [User, SchemaInfo, Session]
+
+ # you can generate classes for tables you specified only:
+ dm.auto_genclass! :scope => Object, :storages => /^phpbb_/
+ # => [PhpbbUser, PhpbbPost, PhpbbConfig]
+
+ # you can generate classes with String too:
+ dm.auto_genclass! :storages => ['users', 'config'], :scope => Object
+ # => [User, Config]
+
+ # you can generate a class only:
+ dm.auto_genclass! :storages => 'users'
+ # => [DataMapper::Is::Reflective::User]
+
+== REQUIREMENTS:
+
+* dm-core 1.0.0 or later
+* at least one dm-*-adapter
+
+== INSTALL:
+
+> gem install dm-is-reflective
+
+== LICENSE:
+
+  Apache License 2.0
+
+  Copyright (c) 2008-2010, Lin Jen-Shin (aka 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
+
+     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.

data/Rakefile

@@ -1,41 +1,37 @@
 # encoding: utf-8
 
-require 'bones'
-Bones.setup
-
-PROJ.name = 'dm-is-reflective'
-PROJ.authors = 'Lin Jen-Shin (aka godfat 真常)'
-PROJ.email = 'godfat (XD) godfat.org'
-PROJ.url = "http://github.com/godfat/#{PROJ.name}"
-PROJ.rubyforge.name = 'ludy'
-
-PROJ.gem.dependencies << ['dm-core', '>=0.10.0'] << ['extlib', '>=0.9.13']
-# PROJ.gem.development_dependencies << ['minitest', '>=1.3.0']
-# PROJ.gem.executables = ["bin/#{PROJ.name}"]
-
-PROJ.ruby_opts.delete '-w' # too many warnings in addressable, dm-core, extlib...
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
 
-PROJ.description = PROJ.summary = paragraphs_of('README', 'description').join("\n\n")
-PROJ.changes = paragraphs_of('CHANGES', 0..1).join("\n\n")
-PROJ.version = File.read("lib/#{PROJ.name}/version.rb").gsub(/.*VERSION = '(.*)'.*/m, '\1')
+ensure_in_path 'lib'
+proj = 'dm-is-reflective'
+require "#{proj}/version"
 
-PROJ.exclude += ['^tmp', 'tmp$', '^pkg', '^\.gitignore$',
-                 '^ann-', '\.sqlite3$', '\.db$']
+Bones{
+  version DataMapper::Is::Reflective::VERSION
 
-PROJ.rdoc.remote_dir = PROJ.name
+  ruby_opts [''] # silence warning, too many in addressable and/or dm-core
+  depend_on 'dm-core'      , :version => '>=1.0.0'
+  depend_on 'dm-do-adapter', :version => '>=1.0.0'
 
-PROJ.readme_file = 'README'
-PROJ.rdoc.main = 'README'
-PROJ.rdoc.exclude += ['Rakefile', '^tasks', '^test']
-PROJ.rdoc.include << '\w+'
-# PROJ.rdoc.opts << '--diagram' if !Rake::WIN32 and `which dot` =~ %r/\/dot/
-PROJ.rdoc.opts += ['--charset=utf-8', '--inline-source',
-                   '--line-numbers', '--promiscuous']
+  %w[dm-migrations    dm-sqlite-adapter
+     dm-mysql-adapter dm-postgres-adapter].each{ |lib|
+       depend_on lib, :development => true, :version => '>=1.0.0'
+     }
 
-PROJ.spec.opts << '--color'
+  name    proj
+  url     "http://github.com/godfat/#{proj}"
+  authors 'Lin Jen-Shin (aka godfat 真常)'
+  email   'godfat (XD) godfat.org'
 
-PROJ.ann.file = "ann-#{PROJ.name}-#{PROJ.version}"
-PROJ.ann.paragraphs.concat %w[LINKS SYNOPSIS REQUIREMENTS INSTALL LICENSE]
+  history_file   'CHANGES'
+   readme_file   'README'
+   ignore_file   '.gitignore'
+  rdoc.include   ['\w+']
+}
 
 CLEAN.include Dir['**/*.rbc']
 

data/TODO

@@ -1,5 +1,9 @@
 = dm-is-reflective todo list
 
+* use extlib to type check args, sorry that i want to sleep right now
+* deal with require order problem
+* extract some types to data_objects_adapter
+
 * test Model#fields with different repo
 
 * better doc...

data/dm-is-reflective.gemspec

@@ -2,40 +2,49 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-is-reflective}
-  s.version = "0.8.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Lin Jen-Shin (aka godfat \347\234\237\345\270\270)"]
-  s.date = %q{2009-06-21}
+  s.authors = ["Lin Jen-Shin (aka godfat 真常)"]
+  s.date = %q{2010-07-05}
   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{godfat (XD) godfat.org}
-  s.extra_rdoc_files = ["CHANGES", "LICENSE", "NOTICE", "README", "TODO"]
-  s.files = ["CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "lib/dm-is-reflective.rb", "lib/dm-is-reflective/is/adapters/abstract_adapter.rb", "lib/dm-is-reflective/is/adapters/mysql_adapter.rb", "lib/dm-is-reflective/is/adapters/postgres_adapter.rb", "lib/dm-is-reflective/is/adapters/sqlite3_adapter.rb", "lib/dm-is-reflective/is/reflective.rb", "lib/dm-is-reflective/is/version.rb", "lib/dm-is-reflective/version.rb", "test/abstract.rb", "test/test_dm-is-reflexible.rb"]
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "dm-is-reflective.gemspec", "test/setup_db.sh"]
+  s.files = ["CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "dm-is-reflective.gemspec", "lib/dm-is-reflective.rb", "lib/dm-is-reflective/is/adapters/abstract_adapter.rb", "lib/dm-is-reflective/is/adapters/data_objects_adapter.rb", "lib/dm-is-reflective/is/adapters/mysql_adapter.rb", "lib/dm-is-reflective/is/adapters/postgres_adapter.rb", "lib/dm-is-reflective/is/adapters/sqlite_adapter.rb", "lib/dm-is-reflective/is/reflective.rb", "lib/dm-is-reflective/is/version.rb", "lib/dm-is-reflective/version.rb", "test/abstract.rb", "test/setup_db.sh", "test/test_dm-is-reflective.rb"]
   s.homepage = %q{http://github.com/godfat/dm-is-reflective}
-  s.rdoc_options = ["--charset=utf-8", "--inline-source", "--line-numbers", "--promiscuous", "--main", "README"]
+  s.rdoc_options = ["--main", "README"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{ludy}
-  s.rubygems_version = %q{1.3.4}
-  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-is-reflexible.rb"]
+  s.rubyforge_project = %q{dm-is-reflective}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{DataMapper plugin that helps you manipulate an existing database}
+  s.test_files = ["test/test_dm-is-reflective.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.0"])
-      s.add_runtime_dependency(%q<extlib>, [">= 0.9.13"])
-      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 1.0.0"])
+      s.add_development_dependency(%q<dm-migrations>, [">= 1.0.0"])
+      s.add_development_dependency(%q<dm-sqlite-adapter>, [">= 1.0.0"])
+      s.add_development_dependency(%q<dm-mysql-adapter>, [">= 1.0.0"])
+      s.add_development_dependency(%q<dm-postgres-adapter>, [">= 1.0.0"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.7"])
     else
-      s.add_dependency(%q<dm-core>, [">= 0.10.0"])
-      s.add_dependency(%q<extlib>, [">= 0.9.13"])
-      s.add_dependency(%q<bones>, [">= 2.5.1"])
+      s.add_dependency(%q<dm-core>, [">= 1.0.0"])
+      s.add_dependency(%q<dm-migrations>, [">= 1.0.0"])
+      s.add_dependency(%q<dm-sqlite-adapter>, [">= 1.0.0"])
+      s.add_dependency(%q<dm-mysql-adapter>, [">= 1.0.0"])
+      s.add_dependency(%q<dm-postgres-adapter>, [">= 1.0.0"])
+      s.add_dependency(%q<bones>, [">= 3.4.7"])
     end
   else
-    s.add_dependency(%q<dm-core>, [">= 0.10.0"])
-    s.add_dependency(%q<extlib>, [">= 0.9.13"])
-    s.add_dependency(%q<bones>, [">= 2.5.1"])
+    s.add_dependency(%q<dm-core>, [">= 1.0.0"])
+    s.add_dependency(%q<dm-migrations>, [">= 1.0.0"])
+    s.add_dependency(%q<dm-sqlite-adapter>, [">= 1.0.0"])
+    s.add_dependency(%q<dm-mysql-adapter>, [">= 1.0.0"])
+    s.add_dependency(%q<dm-postgres-adapter>, [">= 1.0.0"])
+    s.add_dependency(%q<bones>, [">= 3.4.7"])
   end
 end

data/lib/dm-is-reflective.rb

@@ -1,10 +1,12 @@
 
-gem 'dm-core', '>=0.10.0'
+gem 'dm-core', '>=1.0.0'
 require 'dm-core'
+require 'dm-do-adapter'
 
 require 'dm-is-reflective/is/reflective'
+require 'dm-is-reflective/is/adapters/data_objects_adapter'
+
 DataMapper::Model.append_extensions(DataMapper::Is::Reflective)
 
-require 'dm-is-reflective/is/adapters/abstract_adapter'
-DataMapper::Adapters::AbstractAdapter.__send__(:include,
-  DataMapper::Is::Reflective::AbstractAdapter)
+DataMapper::Adapters::DataObjectsAdapter.__send__(:include,
+  DataMapper::Is::Reflective::DataObjectsAdapter)

data/lib/dm-is-reflective/is/adapters/{abstract_adapter.rb → data_objects_adapter.rb}

@@ -1,7 +1,7 @@
 
 module DataMapper
   module Is::Reflective
-    module AbstractAdapter
+    module DataObjectsAdapter
       # returns all tables' name in the repository.
       #  e.g.
       #       ['comments', 'users']
@@ -12,19 +12,19 @@ module DataMapper
 
       # returns all fields, with format [[name, type, attrs]]
       #  e.g.
-      #       [[:created_at,  DateTime, {:nullable => true}],
-      #        [:email,       String,   {:nullable => true, :size => 255,
+      #       [[:created_at,  DateTime, {:required => false}],
+      #        [:email,       String,   {:required => false, :size => 255,
       #                                  :default => 'nospam@nospam.tw'}],
-      #        [:id, DataMapper::Types::Serial,  {:nullable => false, :serial => true,
+      #        [:id, DataMapper::Property::Serial,  {:required => true, :serial => true,
       #                                  :key => true}],
-      #        [:salt_first,  String,   {:nullable => true, :size => 50}],
-      #        [:salt_second, String,   {:nullable => true, :size => 50}]]
+      #        [:salt_first,  String,   {:required => false, :size => 50}],
+      #        [:salt_second, String,   {:required => false, :size => 50}]]
       def fields storage
         reflective_query_storage(storage).map{ |field|
           primitive = reflective_primitive(field)
 
           type = self.class.type_map.find{ |klass, attrs|
-                   next false if [DataMapper::Types::Object, Time].include?(klass)
+                   next false if [Object, Time].include?(klass)
                    attrs[:primitive] == primitive
                  }
           type = type ? type.first : reflective_lookup_primitive(primitive)
@@ -32,10 +32,10 @@ module DataMapper
           attrs = reflective_attributes(field)
 
           type = if attrs[:serial] && type == Integer
-                   DataMapper::Types::Serial
+                   DataMapper::Property::Serial
 
                  elsif type == TrueClass
-                   DataMapper::Types::Boolean
+                   DataMapper::Property::Boolean
 
                  else
                     type
@@ -47,15 +47,15 @@ module DataMapper
 
       # returns a hash with storage names in keys and
       # corresponded fields in values. e.g.
-      #   {'users' => [[:id,          Integer,  {:nullable => false,
+      #   {'users' => [[:id,          Integer,  {:required => true,
       #                                          :serial => true,
       #                                          :key => true}],
-      #                [:email,       String,   {:nullable => true,
+      #                [:email,       String,   {:required => false,
       #                                          :default => 'nospam@nospam.tw'}],
-      #                [:created_at,  DateTime, {:nullable => true}],
-      #                [:salt_first,  String,   {:nullable => true, :size => 50}],
-      #                [:salt_second, String,   {:nullable => true, :size => 50}]]}
-      # see Migration#storages and Migration#fields for detail
+      #                [:created_at,  DateTime, {:required => false}],
+      #                [:salt_first,  String,   {:required => false, :size => 50}],
+      #                [:salt_second, String,   {:required => false, :size => 50}]]}
+      # see AbstractAdapter#storages and AbstractAdapter#fields for detail
       def storages_and_fields
         storages.inject({}){ |result, storage|
           result[storage] = fields(storage)