rare_map 1.3.2 → 2.0.0

data/README.rdoc

@@ -1,11 +1,9 @@
-= rare_map >= 1.0.0
+= rare_map >= 2.0.0
 
 Relational db to ActiveREcord models MAPper
 
 RareMap can be used for BOTH standalone application & Rails
 
-WARN: rare_map >= 1.0.0 is totally not compatible with 0.9.x
-
 * Installation:
 
    gem install rare_map
@@ -13,63 +11,58 @@ WARN: rare_map >= 1.0.0 is totally not compatible with 0.9.x
 == Basic RareMap use
 
 ==== Standalone:
-Create a new database.yml with following lines in the root of your application
+Create a new rare_map.yml with following lines in the root of your application
 
 ====  Rails:
-Add following lines to config/database.yml of rails
+Create a new config/rare_map.yml with following lines in rails
 
-*  database.yml
+*  rare_map.yml
 
-    rare_map:
-      legacy_db1:
-        adapter: sqlite3
-        database: db/db1.sqlite3
+    legacy:
+      adapter: sqlite3
+      database: db/db1.sqlite3
 
-      legacy_db2:
-        adapter: mysql2
-        host: localhost
-        database: db_name
-        port: 3306
-        username: user
-        password: pw
+    old_db:
+      adapter: mysql2
+      host: localhost
+      database: db_name
+      port: 3306
+      username: user
+      password: pw
 
 * Run following command in the root of your application or rails
 
    $ raremap
 
-* Standalone: A demo.rb example is generated for you in the root of your applicaiton
-
-* Rails: Add following line to your config/application.rb
-   config.autoload_paths += Dir[Rails.root.join('app', 'models', '{**}')]
+* Standalone: A demo.rb example is generated for you in the root of your application
 
 == Advanced RareMap use
 
-==== Seperate databases to groups(highly recommended)
+==== Seperate databases into groups (highly recommended)
    
-    rare_map:
-      her_group:
-        -
-          db1:
-            adapter: sqlite3
-            database: db/db1.sqlite3
-        -
-          db2:
-            adapter: sqlite3
-            database: db/db1.sqlite3
-
-      his_group:
-        -
-          db1:
-            adapter: sqlite3
-            database: db/db3.sqlite3
-        -
-          db2:
-            adapter: sqlite3
-            database: db/db4.sqlite3
+    her_group:
+      -
+        db1:
+          adapter: sqlite3
+          database: db/db1.sqlite3
+      -
+        db2:
+          adapter: sqlite3
+          database: db/db1.sqlite3
+
+    his_group:
+      -
+        db1:
+          adapter: sqlite3
+          database: db/db3.sqlite3
+      -
+        db2:
+          adapter: sqlite3
+          database: db/db4.sqlite3
 
 There are benefits by separating databases into groups
 1. Associations are built between databases within a group
-2. Model name is prepended with group name
+2. Group name is treated as a module namespace
 3. Models of a group are organized within a folder
 
 If all your data reside in several legacy databases, it is important to build back those associations across databases
@@ -97,92 +90,24 @@ If there are tons of tables, it is better to organize them well
 
 You can place rare_map options in 3 ways
 
- rare_map:
-   rare_map_opts:             # Global options
-     ...
-   group1:
-     -
-       rare_map_opts:         # Group options
-         ...
-     -
-       db1:
-         ...
-   legacy_db:
-     adapter: sqlite3
-     database: db/db.sqlite3
-     rare_map_opts:           # DB options
+ rare_map_opts:             # Global options
+   ...
+ group1:
+   -
+     rare_map_opts:         # Group options
+       ...
+   -
+     db1:
        ...
+ legacy_db:
+   adapter: sqlite3
+   database: db/db.sqlite3
+   rare_map_opts:           # DB options
+     ...
 
 * Precedence: DB > Group > Global
 
 
-= rare_map ~> 0.9.x(deprecated)
-
-Relational DB to ActiveRecord models Mapper
-
-* Installation:
-
-   gem install rare_map
-
-== Basic RareMap use
-
-Set up your legacay db under your Rails applicaiton
-
-*  database.yml
-
-    mylegacy_db1:
-      adapter: sqlite3
-      database: db/db1.sqlite3
-
-    mylegacy_db2:
-      adapter: sqlite3
-      database: db/db2/sqlite3
-
-    hislegacy_db1:
-      adapter: sqlite3
-      database: db/db1.sqlite3
-
-"mylegacy" is treated as a group name.
-
-You MUST give all your legacy databases a group name.
-
-The associations of databases with the same group name will be built together.
-
-
-* Create a {RAILS_ROOT}/demo.rb file with following content under your Rails application
-
-   RareMap.mapping
-
-* Under terminal
-
-   ruby demo.rb
-
-* Add following line to your config/application.rb
-
-   config.autoload_paths += Dir[Rails.root.join('app', 'models', '{**}')]
-
-== Advanced RareMap use
-
-If the foreign key of your legacy db is not end with '_id', you can change it manually.
-
-  foreign_keys = { :mylegacy => 'id', :hislegacy => 'id' }
-
-If the foreign key is not started with regular table names, you can create aliases for them.
-
-  aliases = { :mylegacy => { :pclid => :protocol, personid => people }, :hislegacy => { :measid => measurement } }
-
-Some of the databases like Oracle won't show the primary key on the dump of schema. If your primary key of a table is not 'id' and it didn't show the schema either. You can specify your special primary key beside 'id' if you want.
-
-  primary_keys = { :mylegacy => { :table1 => 'table1id' }, :hislegacy => { :table2 => 'table2id' } }
-
-When you using the RareMap
-
-  info = RareMap.mapping(:foreign_key => foreign_keys, :alias => aliases, :primary_key => primary_keys)
-
-[info]
-It contains all details of your tables.
-
-
 == Contributing to rare_map
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/rare_map/config_loader.rb

@@ -1,12 +1,14 @@
 require 'yaml'
+require 'rare_map/errors'
 
 module RareMap
   module ConfigLoader
     OPTS_KEY = 'rare_map_opts'
     
-    def load_config(path, file_name = 'database.yml')
+    def load_config(path, file_name = 'rare_map.yml')
+      raise ConfigNotFoundError unless File.exist? "#{path}#{file_name}"
       config = YAML.load_file "#{path}#{file_name}"
-      organize_config_properties config['rare_map'] || {}
+      organize_config_properties config['rare_map'] || config || {}
     end
     
     private

data/lib/rare_map/errors.rb

@@ -0,0 +1,4 @@
+module RareMap
+  class ConfigNotFoundError < Exception
+  end
+end

data/lib/rare_map/model_builder.rb

@@ -99,11 +99,7 @@ module RareMap
     end
     
     def classify
-      if group?
-        "#{group}_#{table.name}".pluralize.classify
-      else
-        "#{table.name}".pluralize.classify
-      end
+      "#{table.name}".pluralize.classify
     end
   end
   

data/lib/rare_map/model_generator.rb

@@ -13,44 +13,46 @@ module RareMap
       models.each do |model|
         output = ''
         output <<
-        "class #{model.classify} < #{group_db2conn[[model.group, model.db_name]]}\n" <<
-        "  self.table_name = '#{model.table.name}'\n" <<
-        "  self.inheritance_column = 'ruby_type'\n" <<
-        "  #{ "self.primary_key = '#{model.table.primary_key}'\n" if model.table.primary_key }\n" <<
-        "  attr_accessible #{model.table.columns.map { |col| ":#{col.name}" }.join(', ')}\n\n"
+        "module #{model.group.camelize}\n" <<
+        "  class #{model.classify} < #{group_db2conn[[model.group, model.db_name]]}\n" <<
+        "    self.table_name = '#{model.table.name}'\n" <<
+        "    self.inheritance_column = 'ruby_type'\n" <<
+        "    #{ "self.primary_key = '#{model.table.primary_key}'\n" if model.table.primary_key }\n" <<
+        "    attr_accessible #{model.table.columns.map { |col| ":#{col.name}" }.join(', ')}\n\n"
         
         belongs_to = model.relations.select { |rel| rel.type == :belongs_to }
         unless belongs_to.empty?
           output << belongs_to.
-            map { |rel| "  belongs_to :#{rel.table.pluralize.singularize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
+            map { |rel| "    belongs_to :#{rel.table.pluralize.singularize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
             join("\n") << "\n"
         end
         
         has_one = model.relations.select { |rel| rel.type == :has_one }
         unless has_one.empty?
           output << has_one.
-            map { |rel| "  has_one :#{rel.table.pluralize.singularize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
+            map { |rel| "    has_one :#{rel.table.pluralize.singularize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
             join("\n") << "\n"
         end
         
         has_many = model.relations.select { |rel| rel.type == :has_many }
         unless has_many.empty?
           output << has_many.
-            map { |rel| "  has_many :#{rel.table.pluralize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
+            map { |rel| "    has_many :#{rel.table.pluralize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
             join("\n") << "\n"
         end
         
         has_many_through = model.relations.select { |rel| rel.type == :has_many_through }
         unless has_many_through.empty?
           output << has_many_through.
-            map { |rel| "  has_many :#{rel.table.pluralize}#{"_by_#{rel.through}, :source => :#{rel.table.pluralize.singularize}" if has_many_through.count { |hmt| hmt.table == rel.table } > 1 || has_many.count { |hm| hm.table == rel.table } > 0 }, :through => :#{rel.through.pluralize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
+            map { |rel| "    has_many :#{rel.table.pluralize}#{"_by_#{rel.through}, :source => :#{rel.table.pluralize.singularize}" if has_many_through.count { |hmt| hmt.table == rel.table } > 1 || has_many.count { |hm| hm.table == rel.table } > 0 }, :through => :#{rel.through.pluralize}, :foreign_key => '#{rel.foreign_key}', :class_name => '#{classify_by_table(rel.table, model, models)}'" }.
             join("\n") << "\n"
         end
         
+        output << "  end\n"
         output << 'end'
         
-        Dir.mkdir path + "#{model.group}" unless Dir.exist? path + "#{model.group}"
-        f = File.new(path + "#{model.group}/#{model.classify.underscore}.rb", 'w')
+        Dir.mkdir path + "#{model.group.underscore}" unless Dir.exist? path + "#{model.group}"
+        f = File.new(path + "#{model.group.underscore}/#{model.classify.underscore}.rb", 'w')
         f.write output
         f.close
       end
@@ -71,18 +73,20 @@ module RareMap
       
       group2connection = Hash[models.map { |model| [[model.group, model.db_name], [model.connection, model.table.name]] }]
       group2connection.each do |(group, db_name), (connection, table_name)|
-        model = "#{group}_#{db_name}".camelize + 'Base'
+        model = "#{db_name}".camelize + 'Base'
         
         output = ''
         output <<
-        "class #{model} < ActiveRecord::Base\n" <<
-        "  establish_connection #{connection.map { |k, v| ":#{k} => #{v.inspect}" }.join(', ')}\n" <<
-        "  self.table_name = '#{table_name}'\n" <<
+        "module #{group.camelize}\n" <<
+        "  class #{model} < ActiveRecord::Base\n" <<
+        "    establish_connection #{connection.map { |k, v| ":#{k} => #{v.inspect}" }.join(', ')}\n" <<
+        "    self.table_name = '#{table_name}'\n" <<
+        "  end\n" <<
         'end'
         
         
-        Dir.mkdir path + "#{group}" unless Dir.exist? path + "#{group}"
-        f = File.new(path + "#{group}/#{model.underscore}.rb", 'w')
+        Dir.mkdir path + "#{group.underscore}" unless Dir.exist? path + "#{group}"
+        f = File.new(path + "#{group.underscore}/#{model.underscore}.rb", 'w')
         f.write output
         f.close
         

data/lib/rare_map/version.rb

@@ -1,7 +1,7 @@
 module RareMap
-  MAJOR = 1
-  MINOR = 3
-  PATCH = 2
+  MAJOR = 2
+  MINOR = 0
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
 end

data/lib/rare_map.rb

@@ -1,5 +1,3 @@
-# $:.unshift File.dirname(__FILE__)
-
 require 'rare_map/rails_locator'
 require 'rare_map/config_loader'
 require 'rare_map/schema_reader'
@@ -28,17 +26,19 @@ module RareMap
       @models = build_models @db_profiles
       generate_models @models, @rails_root
       if @rails_root
-        puts '*****************************************************************************'
-        puts '  A rare_map.rb initializer has been created in config/initializers'
-        puts '*****************************************************************************'
-        create_initializer
+        puts '*****************************************************************'
+        puts '  Activerecord models are generated. Enjoy it!'
+        puts '*****************************************************************'
       else
-        puts '*****************************************************************************'
-        puts '  A demo.rb is generated'
-        puts '*****************************************************************************'
+        puts '*****************************************************************'
+        puts '  A demo.rb is generated.'
+        puts '*****************************************************************'
         generate_demo unless File.exist?('demo.rb')
       end
       @models
+      
+      rescue ConfigNotFoundError => e
+        puts "Please put your database config in `#{'config/' if @rails_root}rare_map.yml`."
     end
     
     private
@@ -50,21 +50,6 @@ module RareMap
       f.write "Dir[File.dirname(__FILE__) + '/app/models/**/*.rb'].each { |file| require file }\n"
       f.close
     end
-    
-    def create_initializer
-      f = File.new(@rails_root + 'config/initializers/rare_map.rb', 'w')
-      f.write "bases = []; models = []\n"
-      f.write "Dir[Rails.root + 'app/models/**/*.rb'].each do |file|\n"
-      f.write "  if file =~ /models\\/[^\\/]+\\/[^\\/]+_base.rb$/\n"
-      f.write "    bases << file\n"
-      f.write "  elsif file =~ /models\\/[^\\/]+\\/[^\\/]+.rb$/\n"
-      f.write "    models << file\n"
-      f.write "  end\n"
-      f.write "end\n"
-      f.write "bases.map { |b| require b }\n"
-      f.write "models.map { |m| require m }\n"
-      f.close
-    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rare_map
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -16,39 +16,39 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.3.2
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 3.3.2
 - !ruby/object:Gem::Dependency
@@ -64,7 +64,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
@@ -72,7 +72,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
@@ -80,33 +80,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '0'
 description: Relational db to ActiveREcord models MAPper
 email: wnameless@gmail.com
 executables:
@@ -115,6 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rare_map/config_loader.rb
+- lib/rare_map/errors.rb
 - lib/rare_map/model_builder.rb
 - lib/rare_map/model_generator.rb
 - lib/rare_map/rails_locator.rb
@@ -138,27 +139,27 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: 3149047131199349365
+      hash: 2598832910408143833
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: 3149047131199349365
+      hash: 2598832910408143833
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: rare_map-1.3.2
+summary: rare_map-2.0.0
 test_files:
 - test/helper.rb
 - test/test_rare_map.rb