database_introspection 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd6b1e340f5f576df0fdc03f994f376069ace956
-  data.tar.gz: 0401ddeac82d36e2a54c214cea8cf9c303db3322
+  metadata.gz: 25c5d7a4888eafde894853b452a714f634b652ae
+  data.tar.gz: eb2e2cedbe5a5ff900049ba10fd485a1ed70e9bb
 SHA512:
-  metadata.gz: 7452dd3c478d085d73c1ad3245fd75e5440814be8c8b0d464e182ee63afadebbe31626ed3e3cd080c74c5fd12a74d4d3a189abf4490ff28218c991b622e0938f
-  data.tar.gz: 4292876722bf17e645aaefc7fafd33021a7ecc6ceb239248a1449b78c8f0b504ea69200c274663e3a3baabd66f6aae1dc92060abdea8bf7972e8329f4889233b
+  metadata.gz: 76cee6c4b5202dceb394f5efd85f67928d173b73ab52aa7d6bfd2eb2be6c6adb6fb131cd822f9655b977efddc2d303ea8ebe55c42648db9921a29015b7c5086b
+  data.tar.gz: 69824f5c5e775c980fe1081f48c83a02c3f88a4ca812c5643ea9ba25221f5eee1152e606a350816316607775b2ff1d908c885b3ab3c7710a6bd14be845dee8cd

data/README.md

@@ -1,6 +1,6 @@
 # Database Introspection
 
-This gem will introspect the database and create __dynamically__ ActiveRecord::Base descendants that can be used by your application, including some Rails associations helper methods.
+[This gem][gemref] will introspect the database and create __dynamically__ ActiveRecord::Base descendants that can be used by your application, including some Rails associations helper methods.
 
 It is intended to be primarily used within rails applications but nothing prevents you to use standalone, provided the fact you are already connected to a database.
 This gem does a bit the reverse action of what you do with Rails generator, when you want to generate the database from you migrations.
@@ -20,6 +20,8 @@ Or install it yourself as:
 
     $ gem install database_introspection
 
+Classes documentation is available [here](http://rubydoc.info/gems/database_introspection/0.1.0/frames)
+
 ## Usage
 
 ### Basic database introspection
@@ -86,7 +88,7 @@ DynamicModel::ManagedDomains::AnotherDomain
 
 The classes generated will actually have some behaviour added by extending the module `DynamicModel::ActiveRecordExtension` to basically be aware of the domain they belong to.
 
-### Database relationships
+### Table relationships
 
 Provided you follow the standard rails rules for ids, for example:
 
@@ -105,3 +107,6 @@ if `user_defined_table1` contains `user_defined_table2_id` or simply `table2_id`
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+[gemref]: https://rubygems.org/gems/database_introspection "Rails Database Introspection gem"

data/lib/database_introspection/dynamic_model.rb

@@ -2,29 +2,62 @@ require 'active_record'
 
 module DynamicModel
 
+  @domain_analyser ||= {}
+
   # Creates ActiveRecord::Base descendants from the database.
   # ActiveRecord descendant classes are dynamically created from database introspection in their own namespace
   # (DynamicModel::<NameSpace>::) The name of the module NameSpace is derived from table_prefix.
   def self.introspect_database(table_prefix = :user_defined, base_class = ActiveRecord::Base)
+    if table_prefix.class == Array
+      table_prefix.each {|p| self.introspect_database p, base_class}
+      return
+    end
     table_prefix = table_prefix.to_s
-    @domain_analyser ||= {}
-
-    # Confines Activerecord classes into a module named from table_prefix
-    @domain_analyser[table_prefix] ||= DynamicModel::TablesAnalyser.new table_prefix, base_class
-    klasses = @domain_analyser[table_prefix].scan_database
-    relation_analyser = RelationsAnalyser.new klasses
-    relation_analyser.run
+    analyse_domain table_prefix, base_class
   end
 
   # Creates a new table with auto numbered id in the database with the name prefix provided
   # by creating a live migration.
   # If block is provided it will behave like create_table method for migrations, allowing
   # to create any other column.
-  def self.add_table(scoped_table_name, table_prefix: :user_defined, &block)
+  def self.add_table(scoped_table_name, table_prefix: :user_defined, base_class: ActiveRecord::Base, &block)
+    for_action_on_table(scoped_table_name, table_prefix) do |table_prefix, real_table_name|
+      Migration::create_for "#{table_prefix}_#{real_table_name}", &block
+    end
+  ensure
+    analyse_domain table_prefix, base_class
+  end
+
+
+  # Modifies a table in the database with the name prefix provided by creating a live migration.
+  # If block is provided it will behave like create_table method for migrations, allowing
+  # to create any other column.
+  def self.alter_table(scoped_table_name, table_prefix: :user_defined, base_class: ActiveRecord::Base, &block)
+    raise "Missing block parameter" unless block_given?
+    for_action_on_table(scoped_table_name, table_prefix) do |table_prefix, real_table_name|
+      Migration::update_for "#{table_prefix}_#{real_table_name}", &block
+    end
+  ensure
+    analyse_domain table_prefix, base_class
+  end
+
+  private
+
+  def self.for_action_on_table(scoped_table_name, table_prefix)
+    raise "Missing block parameter" unless block_given?
     scoped_table_name = scoped_table_name.to_s
     table_prefix = table_prefix.to_s
     real_table_name = scoped_table_name.underscore.pluralize
-    Migration::create_with "#{table_prefix}_#{real_table_name}", &block
+    yield table_prefix, real_table_name
+  end
+
+  def self.analyse_domain(table_prefix, base_class)
+    # Confines Activerecord classes into a module named from table_prefix
+    @domain_analyser[table_prefix] ||= DynamicModel::TablesAnalyser.new table_prefix, base_class
+    raise "You cannot change the base class for a domain" unless @domain_analyser[table_prefix].base_class == base_class
+    klasses = @domain_analyser[table_prefix].scan_database
+    relation_analyser = RelationsAnalyser.new klasses
+    relation_analyser.run
   end
 
 

data/lib/database_introspection/dynamic_model/active_record_extension.rb

@@ -25,13 +25,17 @@ module DynamicModel::ActiveRecordExtension
     end
 
     def name_space
-      self.name.gsub( /DynamicModel::ManagedDomains::([^:]+)::.*$/, "\\1") .underscore
+      self.name.gsub(/DynamicModel::ManagedDomains::([^:]+)::.*$/, "\\1") .underscore
     end
 
     def list_name
       self.name.gsub( /^.*::([^:]+)$/, "\\1") .underscore.pluralize
     end
 
+    def alter(&block)
+      self.domain.alter_table(self.list_name, &block)
+    end
+
   end
 
   include InstanceMethods

data/lib/database_introspection/dynamic_model/domain_extension.rb

@@ -22,6 +22,10 @@ module DynamicModel::DomainExtension
     DynamicModel.add_table scoped_table_name, table_prefix: prefix, &block
   end
 
+  def alter_table(scoped_table_name, &block)
+    DynamicModel.alter_table scoped_table_name, table_prefix: prefix, &block
+  end
+
   def model_class(scoped_table_name)
     Hash[scoped_table_names.zip model_classes][scoped_table_name]
   end

data/lib/database_introspection/dynamic_model/migration.rb

@@ -1,6 +1,6 @@
 require 'active_record'
 class DynamicModel::Migration < ActiveRecord::Migration
-  def self.create_with(name, &block)
+  def self.create_for(name, &block)
     create_table name.to_sym do |t|
       block.call(t) if block_given?
       begin
@@ -10,4 +10,11 @@ class DynamicModel::Migration < ActiveRecord::Migration
       end
     end
   end
+
+  def self.update_for(name, &block)
+    change_table name.to_sym do |t|
+      block.call(t) if block_given?
+    end
+  end
+
 end

data/lib/database_introspection/dynamic_model/tables_analyser.rb

@@ -2,7 +2,7 @@ require 'active_record'
 
 class DynamicModel::TablesAnalyser
 
-  attr_reader :domain, :klasses_analysed
+  attr_reader :domain, :base_class, :klasses_analysed
 
   def initialize(domain, base_class = ActiveRecord::Base)
     @domain = domain
@@ -28,13 +28,15 @@ class DynamicModel::TablesAnalyser
     if @domain_module.constants.include? short_model_name.to_sym
       klass = @domain_module.const_get short_model_name
       puts "Found #{klass.name} that already handles #{table_name}"
+      klass.reset_column_information
     else
       klass = @domain_module.const_set short_model_name, Class.new(@base_class)
       puts "Created #{klass.name} to handle #{table_name}"
       # Adds some class methods
       klass.send :include, DynamicModel::ActiveRecordExtension
     end
-
+    # Disables STI
+    klass.inheritance_column = nil
     # Maps the class to the correct table
     klass.table_name = table_name
     # Adds attributes accessible for mass assign

data/lib/database_introspection/version.rb

@@ -1,3 +1,3 @@
 module DatabaseIntrospection
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_introspection
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
+date: 2013-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler