dm-is-reflective 1.0.1.rc → 1.0.1

data/CHANGES.md

@@ -0,0 +1,226 @@
+# CHANGES
+
+## dm-is-reflective 1.0.1, 2012-05-16
+
+* allow_nil is more close to db's semantics, not required. Thanks miaout17.
+  `:allow_nil` allows empty value, but `:required` does not. So here we
+  always use `:allow_nil` to match db's semantics.
+
+## dm-is-reflective 1.0.0, 2011-06-16
+
+* updated against dm-core 1.1.0
+
+## 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
+* Serial would map to Serial not Integer now
+* no more type_map now
+* no more Extlib::Hook to load adapter
+
+## dm-mapping 0.7.1, never released as a gem
+
+don't open module Migration and edit it, instead, use include, more see:
+
+* added DataMapper::Mapping::AbstractAdapter
+* added DataMapper::Mapping::Sqlite3Adapter
+* added DataMapper::Mapping::MysqlAdapter
+* added DataMapper::Mapping::PostgresAdapter
+* each adapter was included in related adapter in DataMapper.
+* Model#fields now accept repository name as argument
+
+there's differences between adapters,
+Sqlite3 added default => 'UL' in Boolean type,
+Mysql can't tell whether it's a Boolean or Tinyint,
+and Postgres is fine. see test/abstract.rb: super_user_fields for detail.
+
+## dm-mapping 0.7.0, 2008-09-01
+
+* feature added
+
+  - added postgres support.
+
+* bug fixed
+
+  - fixed key mapping in mysql adapter. PRI and MUL are all keys.
+  - use DM::Text.size as default text size in sqlite3.
+
+## dm-mapping 0.6.2, 2008-08-30
+
+* mapping more data types for mysql.
+* don't map TINYINT to TrueClass with mysql, skip it in type_map.
+
+## dm-mapping 0.6.1, 2008-08-22
+
+* gem 'dm-core', '>=0.9.3' instead of '=0.9.3'
+
+## dm-mapping 0.6.0, 2008-08-16
+
+* mapping returns an array of properties indicating fields it mapped.
+* performance boosted by refactored mapping implementation.
+* changed the way using auto_genclass!, now accepts args like mapping!
+* changed fields to return field name with Symbol instead of String.
+  this would make it be more consistent with DataMapper.
+* storage names remain String.
+* added more mysql data type to map
+* use Extlib::Hook to setup dm-mapping instead of stupid alias_method.
+* removed ensure_require in model. always setup DataMapper before define model.
+
+## dm-mapping 0.5.0, 2008-08-14
+
+* feature added
+
+  - added mysql support.
+  - reflect size 65535 in TEXT for sqlite3.
+
+* bug fixed
+
+  - reflect VARCHAR(size) instead of default size in sqlite3.
+
+* misc
+
+  - renamed sqlite3adapter to sqlite3_adapter.
+
+## dm-mapping 0.4.1, 2008-08-14
+
+* removed type hack, replaced with rejecting special type to lookup.
+
+## 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
+
+* 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.
+* fixed a bug that sql type could be lower case.
+  fixed by calling upcase.
+
+## dm-mapping 0.2.0, 2008-08-02
+
+* added Sqlite3Adapter::Migration#fields
+* added DataMapper::Model#mapping
+* added DataMapper::Model#fields
+* added DataMapper::TypeMap#find_primitive for reversed lookup.
+  mapping SQL type back to Ruby type.
+* added corresponded test.
+
+## dm-mapping 0.1.0, 2008-07-27
+
+* birthday!
+* added DataMapper.repository.storages for sqlite3.
+* please refer:
+  <http://groups.google.com/group/datamapper/browse_thread/thread/b9ca41120c5c9389>
+
+original message:
+
+    from Lin Jen-Shin
+    to DataMapper
+    cc godfat
+    date	Sun, Jul 27, 2008 at 5:40 PM
+    subject Manipulate an existing database.
+    mailed-by gmail.com
+
+    Greetings,
+
+    DataMapper looks very promising for me, so I am thinking of
+    using it in the near future. I hate separate my domain objects into
+    two parts in Rails, writing migration and switching to ActiveRecord,
+    vice versa, is very annoying to me.
+
+    But there's a very convenient feature to me in ActiveRecord,
+    that is ActiveRecord automatically mapping all fields in a table.
+    It makes me easily control an existing database without any domain object.
+
+    For example,
+
+      require 'active_record'
+
+      ActiveRecord::Base.establish_connection(
+        :adapter => 'sqlite3',
+        :database => 'db/development.sqlite3'
+      )
+
+      clsas User < ActiveRecord::Base
+      end
+
+      User.find 1
+      => #<User id: 1, account: "admin", created_at: "2008-05-18 20:08:37", etc.>
+
+    Some people would use database admin such as phpMyAdmin to
+    accomplish this kind of task, but I prefer anything in Ruby,
+    calling Ruby function, manipulating data without SQL and
+    any domain object. (i.e. I didn't have to load up entire environment.)
+
+    In DataMapper, I didn't find an easy way to accomplish this.
+    I am sorry if there's one but I didn't find it, please point out,
+    many thanks. In short, I would like to do this in DataMapper:
+
+      class User
+        include DataMapper::Resource
+        mapping :account, :created_at
+      end
+
+    or
+
+      class User
+        include DataMapper::Resource
+        mapping All
+      end
+
+      class User
+        include DataMapper::ResourceAll
+      end
+
+    or
+
+      class User
+        include DataMapper::Resource
+        mapping *storage_fields
+      end
+
+    The above User.storage_fields should return an Array,
+    telling all the fields in the table, e.g. [:account, :created_at, :etc]
+    or a Hash includes data type, e.g. {:account => String,
+                                        :created_at => DateTime}
+    then mapping *storage_fields should change to:
+
+      mapping *storage_fields.each_key.to_a
+
+    If it's possible, a feature returning the database schema as well:
+
+      DataMapper.repository.storages
+      # => [:users, :posts, :etc]
+
+      DataMapper.repository.storages_and_fields
+      # => {:users => {:account => String},
+            :posts => {:title => String, :content => Text}}
+
+    or returning DataObject::Field, DataObject::Storage, etc.
+
+      DataMapper.repository.storage
+      # => [#<DataObject::Storage @name='users' @fields=
+             [#<DataObject::Field @name='account' @type=String>]>]
+
+    If you feel this kind of feature is indeed needed or not bad for
+    adding it, I could try to provide a patch for it. Though I didn't
+    read the source code deeply, not knowning it's easy or not.
+
+    sincerely,

data/README.md

@@ -0,0 +1,132 @@
+# dm-is-reflective
+
+by Lin Jen-Shin ([godfat](http://godfat.org))
+
+## LINKS:
+
+* [github](https://github.com/godfat/dm-is-reflective)
+* [rubygems](https://rubygems.org/gems/dm-is-reflective)
+* [rdoc](http://rdoc.info/github/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:
+
+``` ruby
+    require 'dm-is-reflective' # this would require 'dm-core'
+    dm = DataMapper.setup :default, 'sqlite:db/dev.sqlite3'
+
+    class User
+      include DataMapper::Resource
+      is :reflective
+
+      # map all, returning 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>]
+
+      # map 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
+* dm-do-adapter
+* choose one: dm-sqlite-adapter, dm-postgres-adapter, dm-mysql-adapter
+
+## INSTALL:
+
+    gem install dm-is-reflective
+
+## CONTRIBUTORS:
+
+* Lin Jen-Shin (@godfat)
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2008-2012, Lin Jen-Shin (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

@@ -11,7 +11,6 @@ task 'gem:spec' do
     require     'dm-is-reflective/version'
     s.name    = 'dm-is-reflective'
     s.version = DataMapper::Is::Reflective::VERSION
-    # s.executables = [s.name]
 
     %w[dm-core dm-do-adapter].each{ |g| s.add_runtime_dependency(g) }
     %w[dm-migrations

data/{TODO → TODO.md}

@@ -1,4 +1,4 @@
-= dm-is-reflective todo list
+# TODO
 
 * use extlib to type check args, sorry that i want to sleep right now
 * deal with require order problem

data/dm-is-reflective.gemspec

@@ -1,52 +1,41 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{dm-is-reflective}
-  s.version = "1.0.1.rc"
+  s.name = "dm-is-reflective"
+  s.version = "1.0.1"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Lin Jen-Shin (godfat)}]
-  s.date = %q{2011-07-19}
-  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 = [
-  %q{CHANGES},
-  %q{CONTRIBUTORS},
-  %q{LICENSE},
-  %q{TODO}]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lin Jen-Shin (godfat)"]
+  s.date = "2012-05-16"
+  s.description = "DataMapper plugin that helps you manipulate an existing database.\nIt creates mappings between existing columns and model's properties."
+  s.email = ["godfat (XD) godfat.org"]
   s.files = [
-  %q{.gitignore},
-  %q{.gitmodules},
-  %q{CHANGES},
-  %q{CONTRIBUTORS},
-  %q{Gemfile},
-  %q{LICENSE},
-  %q{NOTICE},
-  %q{README},
-  %q{README.rdoc},
-  %q{Rakefile},
-  %q{TODO},
-  %q{dm-is-reflective.gemspec},
-  %q{lib/dm-is-reflective.rb},
-  %q{lib/dm-is-reflective/is/adapters/data_objects_adapter.rb},
-  %q{lib/dm-is-reflective/is/adapters/mysql_adapter.rb},
-  %q{lib/dm-is-reflective/is/adapters/postgres_adapter.rb},
-  %q{lib/dm-is-reflective/is/adapters/sqlite_adapter.rb},
-  %q{lib/dm-is-reflective/is/reflective.rb},
-  %q{lib/dm-is-reflective/is/version.rb},
-  %q{lib/dm-is-reflective/version.rb},
-  %q{task/gemgem.rb},
-  %q{test/abstract.rb},
-  %q{test/setup_db.sh},
-  %q{test/test_dm-is-reflective.rb}]
-  s.homepage = %q{https://github.com/godfat/dm-is-reflective}
-  s.rdoc_options = [
-  %q{--main},
-  %q{README}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  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 = [%q{test/test_dm-is-reflective.rb}]
+  ".gitignore",
+  ".gitmodules",
+  "CHANGES.md",
+  "Gemfile",
+  "LICENSE",
+  "README.md",
+  "Rakefile",
+  "TODO.md",
+  "dm-is-reflective.gemspec",
+  "lib/dm-is-reflective.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/version.rb",
+  "task/.gitignore",
+  "task/gemgem.rb",
+  "test/abstract.rb",
+  "test/setup_db.sh",
+  "test/test_dm-is-reflective.rb"]
+  s.homepage = "https://github.com/godfat/dm-is-reflective"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "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
     s.specification_version = 3