godfat-dm-is-reflective 0.8.0

data/CHANGES

@@ -0,0 +1,188 @@
+= dm-mapper changes history
+
+=== dm-is-reflective 0.8.0,
+* require dm-core 0.10.0 and above now
+* Serial would map to Serial not Integer now
+* no more type_map now
+
+=== 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/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,30 @@
+= notice and thanks
+
+* dm-is-reflective is a plugin of DataMapper
+    > sudo 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
+
+* Rubygems the great package management
+    http://rubygems.org
+
+* 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

@@ -0,0 +1,122 @@
+= dm-is-reflective 0.8.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]
+
+== 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
+   mapping /.*/  # 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
+
+   # mapping for field name 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
+
+ # 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, {:nullable => true}],
+       [:email,       String,   {:nullable => true, :size => 255,
+                                 :default => 'nospam@nospam.tw'}],
+       [:id,          Integer,  {:nullable => false, :serial => true,
+                                 :key => true}],
+       [:salt_first,  String,   {:nullable => true, :size => 50}],
+       [:salt_second, String,   {:nullable => true, :size => 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,          Integer,  {:nullable => false,
+                                             :serial => true,
+                                             :key => true}],
+                   [:email,       String,   {:nullable => true,
+                                             :default => 'nospam@nospam.tw'}],
+                   [:created_at,  DateTime, {:nullable => true}],
+                   [:salt_first,  String,   {:nullable => true, :size => 50}],
+                   [:salt_second, String,   {:nullable => true, :size => 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 0.10.0 or later
+* at least one do_* adapter
+
+== INSTALL:
+
+> sudo gem install dm-is-reflective
+
+== LICENSE:
+
+  Apache License 2.0
+
+  Copyright (c) 2008, 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.