mini_record 0.2.0 → 0.2.1

data/README.md

@@ -31,32 +31,21 @@ Remember that inside properties you can use all migrations methods,
 see [documentation](http://api.rubyonrails.org/classes/ActiveRecord/Migration.html)
 
 ``` rb
-class Person < ActiveRecord::Base
-  schema do |s|
-    s.string  :name
-    s.integer :address_id
-  end
-  add_index :address_id
-
-  belongs_to :address
-end
-Person.auto_upgrade!
-
-# you can use also this SEXY way
 class Post < ActiveRecord::Base
-  key :title
-  key :permalink, :index => true, :limit => 50
-  key :comments_count, :as => :integer
-  key :category, :as => :references, :index => true
+  col :title_en, :title_jp
+  col :description_en, :description_jp, :as => :text
+  col :permalink, :index => true, :limit => 50
+  col :comments_count, :as => :integer
+  col :category, :as => :references, :index => true
 end
 Post.auto_upgrade!
 ```
 
-If you don't like `key` there are also few aliases: `col, field, property`
+If you don't like `col` there are also few aliases: `key, field, property, attribute`
 
 Instead of `:as => :my_type` you can use `:type => :my_type`
 
-Option `:as` or `:type` if not provided are `:string`, you can use all ActiveRecord types:
+Option `:as` or `:type` if not provided is `:string` by default, you can use all ActiveRecord types:
 
 ``` rb
 :primary_key, :string, :text, :integer, :float, :decimal, :datetime, :timestamp, :time, :date, :binary, :boolean
@@ -70,8 +59,8 @@ You can provide others ActiveRecord options like:
 
 # example
 class Foo < ActiveRecord::Base
-  key :title, :default => "MyTitle" # :as => :string is by default
-  key :price, :as => :decimal, :scale => 8, :precision => 2
+  col :title, :default => "MyTitle" # :as => :string is by default
+  col :price, :as => :decimal, :scale => 8, :precision => 2
 end
 ```
 
@@ -81,28 +70,21 @@ for more details.
 Finally, when you execute `MyModel.auto_upgrade!`, missing columns, indexes and tables will be created on the fly.
 Indexes and columns present in the db but **not** in your model schema will be **deleted*** also in your db.
 
+### Single Table Inheritance
+
+MiniRecord as ActiveRecord support STI plus some goodness, see our specs for more details.
+
 ### Adding a new column
 
 Super easy, open your model and just add it:
 
 ``` rb
-class Person < ActiveRecord::Base
-  schema do |s|
-    s.string  :name
-    s.string  :surname # <<- this
-    s.integer :address_id
-  end
-  belongs_to :address
-end
-Person.auto_upgrade!
-
-# or you can use a more interesting way
 class Post < ActiveRecord::Base
-  key :title
-  key :body, :as => :text # <<- this
-  key :permalink, :index => true
-  key :comments_count, :as => :integer
-  key :category, :as => :references, :index => true
+  col :title
+  col :body, :as => :text # <<- this
+  col :permalink, :index => true
+  col :comments_count, :as => :integer
+  col :category, :as => :references, :index => true
 end
 Post.auto_upgrade!
 ```
@@ -133,10 +115,10 @@ Note that writing it in DSL way you have same options as `add_index` so you are
 
 ``` rb
 class Fox < ActiveRecord::Base
-  key :foo, :index => true
-  key :foo, :index => :custom_name
-  key :foo, :index => [:foo, :bar]
-  key :foo, :index => { :column => [:branch_id, :party_id], :unique => true, :name => 'by_branch_party' }
+  col :foo, :index => true
+  col :foo, :index => :custom_name
+  col :foo, :index => [:foo, :bar]
+  col :foo, :index => { :column => [:branch_id, :party_id], :unique => true, :name => 'by_branch_party' }
 end
 ```
 
@@ -144,7 +126,7 @@ That is the same of:
 
 ``` rb
 class Fox < ActiveRecord::Base
-  key :foo
+  col :foo
   add_index :foo
   add_index :custom_name
   add_index [:foo, :bar]

data/lib/mini_record/auto_schema.rb

@@ -5,40 +5,60 @@ module MiniRecord
     end
 
     module ClassMethods
+
       def table_definition
+        return superclass.table_definition unless superclass == ActiveRecord::Base
+
         @_table_definition ||= begin
           tb = ActiveRecord::ConnectionAdapters::TableDefinition.new(connection)
           tb.primary_key(primary_key)
+          tb
         end
       end
 
-      def col(column_name, options={})
+      def indexes
+        return superclass.indexes unless superclass == ActiveRecord::Base
+
+        @_indexes ||= {}
+      end
+
+      def col(*args)
+        return unless connection?
+
+        options = args.extract_options!
         type = options.delete(:as) || options.delete(:type) || :string
-        table_definition.send(type, column_name, options)
-        column_name = table_definition.columns[-1].name
-        case index_name = options.delete(:index)
-        when Hash
-          add_index(options.delete(:column) || column_name, index_name)
-        when TrueClass
-          add_index(column_name)
-        when String, Symbol, Array
-          add_index(index_name)
+        args.each do |column_name|
+          table_definition.send(type, column_name, options)
+          column_name = table_definition.columns[-1].name
+          case index_name = options.delete(:index)
+            when Hash
+              add_index(options.delete(:column) || column_name, index_name)
+            when TrueClass
+              add_index(column_name)
+            when String, Symbol, Array
+              add_index(index_name)
+          end
         end
       end
       alias :key :col
       alias :property :col
       alias :field :col
+      alias :attribute :col
 
       def reset_table_definition!
         @_table_definition = nil
       end
+      alias :reset_schema! :reset_table_definition!
 
       def schema
         reset_table_definition!
         yield table_definition
+        table_definition
       end
       alias :keys :schema
       alias :properties :schema
+      alias :fields :schema
+      alias :attributes :schema
 
       def add_index(column_name, options={})
         index_name = connection.index_name(table_name, :column => column_name)
@@ -47,11 +67,16 @@ module MiniRecord
       end
       alias :index :add_index
 
-      def indexes
-        @_indexes ||= {}
+      def connection?
+        !!connection
+      rescue Exception => e
+        puts "\e[31m%s\e[0m" % e.message.strip
+        false
       end
 
       def auto_upgrade!
+        return unless connection?
+
         # Table doesn't exist, create it
         unless connection.tables.include?(table_name)
           # TODO: Add to create_table options
@@ -73,6 +98,12 @@ module MiniRecord
           hash
         end
 
+        # Add to schema inheritance column if necessary
+        if descendants.present? && !fields_in_schema.include?(inheritance_column.to_s)
+          table_definition.column inheritance_column, :string
+        end
+
+
         # Remove fields from db no longer in schema
         (fields_in_db.keys - fields_in_schema.keys & fields_in_db.keys).each do |field|
           column = fields_in_db[field]

data/lib/mini_record/version.rb

@@ -1,3 +1,3 @@
 module MiniRecord
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/mini_record_spec.rb

@@ -55,7 +55,7 @@ describe MiniRecord do
     person.name.must_equal 'foo'
   end
 
-  it 'has #key,col,property inside model' do
+  it 'has #key,col,property,attribute inside model' do
     ActiveRecord::Base.connection.table_exists?(Post.table_name).must_equal false
     ActiveRecord::Base.connection.table_exists?(Category.table_name).must_equal false
     Post.auto_upgrade!; Category.auto_upgrade!
@@ -74,8 +74,8 @@ describe MiniRecord do
     # Remove a column
     Post.reset_table_definition!
     Post.class_eval do
-      key :name
-      key :category, :as => :references
+      col :name
+      col :category, :as => :references
     end
     Post.auto_upgrade!
     post = Post.first
@@ -100,10 +100,80 @@ describe MiniRecord do
 
     # Add a new index
     Animal.class_eval do
-      key :category, :as => :references, :index => true
+      col :category, :as => :references, :index => true
     end
     Animal.auto_upgrade!
     Animal.db_columns.must_include "category_id"
     Animal.db_indexes.must_equal((indexes_was << "index_animals_on_category_id").sort)
   end
+
+  it 'works with STI' do
+    class Dog < Pet; end
+    class Cat < Pet; end
+    Pet.auto_upgrade!
+
+    # Check inheritance column
+    Pet.db_columns.wont_include "type"
+    Dog.auto_upgrade!
+    Pet.db_columns.must_include "type"
+
+    # Now, let's we know if STI is working
+    Pet.create(:name => "foo")
+    Dog.create(:name => "bar")
+    Dog.count.must_equal 1
+    Dog.first.name.must_equal "bar"
+    Pet.count.must_equal 2
+    Pet.all.map(&:name).must_equal ["foo", "bar"]
+
+    # Check that this doesn't break things
+    Cat.auto_upgrade!
+    Dog.first.name.must_equal "bar"
+
+    # What's happen if we change schema?
+    Dog.table_definition.must_equal Pet.table_definition
+    Dog.indexes.must_equal Pet.indexes
+    Dog.class_eval do
+      col :bau
+    end
+    Dog.auto_upgrade!
+    Pet.db_columns.must_include "bau"
+    Dog.new.must_respond_to :bau
+    Cat.new.must_respond_to :bau
+  end
+
+  it 'works with custom inheritance column' do
+    class User < ActiveRecord::Base
+      col :name
+      col :surname
+      col :role
+      set_inheritance_column :role
+    end
+    class Administrator < User; end
+    class Customer < User; end
+
+    User.auto_upgrade!
+    Administrator.create(:name => "Davide", :surname => "D'Agostino")
+    Customer.create(:name => "Foo", :surname => "Bar")
+    Administrator.count.must_equal 1
+    Administrator.first.name.must_equal "Davide"
+    Customer.count.must_equal 1
+    Customer.first.name.must_equal "Foo"
+    User.count.must_equal 2
+    User.first.role.must_equal "Administrator"
+    User.last.role.must_equal "Customer"
+  end
+
+  it 'allow multiple columns definitions' do
+    class Fake < ActiveRecord::Base
+      col :name, :surname
+      col :category, :group, :as => :references
+    end
+    Fake.auto_upgrade!
+    Fake.create(:name => 'foo', :surname => 'bar', :category_id => 1, :group_id => 2)
+    fake = Fake.first
+    fake.name.must_equal 'foo'
+    fake.surname.must_equal 'bar'
+    fake.category_id.must_equal 1
+    fake.group_id.must_equal 2
+  end
 end

data/spec/models.rb

@@ -52,3 +52,9 @@ class Animal < ActiveRecord::Base
   key :name, :index => true
   index :id
 end
+
+class Pet < ActiveRecord::Base
+  include SpecHelper
+
+  key :name, :index => true
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mini_record
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Davide D'Agostino
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-10 00:00:00 +02:00
+date: 2011-09-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency