mini_record 0.1.0 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 MiniRecord is a micro extension for our `ActiveRecord` gem.
-With it you can add the ability to create columns outside the default schema, directly
-in your **model** in a similar way that you just know in others projects
-like  DataMapper or  MongoMapper.
+With MiniRecord you can add the ability to create columns outside the default `schema.rb`, directly
+in your **model** in a similar way that should know in others projects
+like  DataMapper, MongoMapper or MongoID.
 
 My inspiration come from this handy [project](https://github.com/pjhyett/auto_migrations).
 
@@ -14,8 +14,8 @@ My inspiration come from this handy [project](https://github.com/pjhyett/auto_mi
 
 ## Instructions
 
-What you need is to move/remove `db/migrations` and `db/schema.rb`.
-It's no more necessary and it avoid conflicts.
+What you need is to move/remove your `db/schema.rb`.
+This avoid conflicts.
 
 Add to your `Gemfile`:
 
@@ -36,38 +36,50 @@ class Person < ActiveRecord::Base
     s.string  :name
     s.integer :address_id
   end
+  add_index :address_id
+
   belongs_to :address
 end
 Person.auto_upgrade!
 
-# you can use also this way
-class Address < ActiveRecord::Base
-  key.string  :city
-  key.string  :state
-  key.integer :number
-  has_many :people
+# 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
 end
+Post.auto_upgrade!
+```
 
-# or this
-class Address < ActiveRecord::Base
-  col.string  :city
-  col.string  :state
-  col.integer :number
-  has_many :people
-end
+If you don't like `key` there are also few aliases: `col, field, property`
 
-# or this
-class Address < ActiveRecord::Base
-  property.string  :city
-  property.string  :state
-  property.integer :number
-  has_many :people
-end
+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:
+
+``` rb
+:primary_key, :string, :text, :integer, :float, :decimal, :datetime, :timestamp, :time, :date, :binary, :boolean
+:references, :belongs_to, :primary_key, :timestamp
+```
 
-Address.auto_upgrade!
+You can provide others ActiveRecord options like:
+
+``` rb
+:limit, :default, :null, :precision, :scale
+
+# example
+class Foo < ActiveRecord::Base
+  key :title, :default => "MyTitle" # :as => :string is by default
+  key :price, :as => :decimal, :scale => 8, :precision => 2
+end
 ```
 
-Once you bootstrap your **app**, missing columns and tables will be created on the fly.
+See [ActiveRecord::TableDefinition](http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/TableDefinition.html) 
+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.
 
 ### Adding a new column
 
@@ -82,17 +94,20 @@ class Person < ActiveRecord::Base
   end
   belongs_to :address
 end
+Person.auto_upgrade!
 
-# or if you use others ways
-class Person < ActiveRecord::Base
-  col.string  :name
-  col.string  :surname # <<- this
-  col.integer :address_id
-  belongs_to :address
+# 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
 end
+Post.auto_upgrade!
 ```
 
-So now when you start your **webserver** you can see an `ALTER TABLE` statement, this mean that your existing
+So now when you invoke `MyModel.auto_upgrade!` you should see a SQL query like `ALTER TABLE` that mean that your existing
 records are happy and safe.
 
 ### Removing a column
@@ -104,12 +119,44 @@ It's exactly the same, but the column will be _really_ deleted without affect ot
 It's not possible for us know when/what column you have renamed, but we can know if you changed the `type` so
 if you change `t.string :name` to `t.text :name` we are be able to perform an `ALTER TABLE`
 
+### Add/Remove indexes
+
+In the same ways we manage columns MiniRecord will detect new indexes and indexes that needs to be removed.
+So when you perform `MyModel.auto_upgrade!` a SQL command like:
+
+``` SQL
+PRAGMA index_info('index_people_on_name')
+CREATE INDEX "index_people_on_surname" ON "people" ("surname")
+```
+
+Note that writing it in DSL way you have same options as `add_index` so you are be able to write:
+
+``` 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' }
+end
+```
+
+That is the same of:
+
+``` rb
+class Fox < ActiveRecord::Base
+  key :foo
+  add_index :foo
+  add_index :custom_name
+  add_index [:foo, :bar]
+  add_index [:branch_id, :party_id], :unique => true, :name => 'by_branch_party'
+end
+```
+
 ## Warnings
 
 This software is not yet tested in a production project, now is only heavy development and if you can
 pleas fork it, find bug add a spec and then come back with a pull request. Thanks!
 
-
 ## Author
 
 DAddYE, you can follow me on twitter [@daddye](http://twitter.com/daddye) or take a look at my site [daddye.it](http://www.daddye.it)

data/lib/mini_record/auto_schema.rb

@@ -11,9 +11,23 @@ module MiniRecord
           tb.primary_key(primary_key)
         end
       end
-      alias :col :table_definition
-      alias :key :table_definition
-      alias :property :table_definition
+
+      def col(column_name, 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)
+        end
+      end
+      alias :key :col
+      alias :property :col
+      alias :field :col
 
       def reset_table_definition!
         @_table_definition = nil
@@ -26,6 +40,17 @@ module MiniRecord
       alias :keys :schema
       alias :properties :schema
 
+      def add_index(column_name, options={})
+        index_name = connection.index_name(table_name, :column => column_name)
+        indexes[index_name] = options.merge(:column => column_name)
+        index_name
+      end
+      alias :index :add_index
+
+      def indexes
+        @_indexes ||= {}
+      end
+
       def auto_upgrade!
         # Table doesn't exist, create it
         unless connection.tables.include?(table_name)
@@ -95,6 +120,20 @@ module MiniRecord
           end
         end
 
+        # Remove old index
+        indexes_in_db = connection.indexes(table_name).map(&:name)
+        (indexes_in_db - indexes.keys).each do |name|
+          connection.remove_index(table_name, :name => name)
+        end
+
+        # Add indexes
+        indexes.each do |name, options|
+          options = options.dup
+          unless connection.indexes(table_name).detect { |i| i.name == name }
+            connection.add_index(table_name, options.delete(:column), options)
+          end
+        end
+
         # Reload column information
         reset_column_information
       end

data/lib/mini_record/version.rb

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

data/spec/mini_record_spec.rb

@@ -59,8 +59,8 @@ describe MiniRecord 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!
-    Post.column_names.must_equal Post.db_columns
-    Category.column_names.must_equal Category.schema_columns
+    Post.column_names.sort.must_equal Post.db_columns
+    Category.column_names.sort.must_equal Category.schema_columns
 
     # Check default properties
     category = Category.create(:title => 'category')
@@ -70,15 +70,40 @@ describe MiniRecord do
     post.body.must_equal 'bar'
     post.category.must_equal category
 
+
     # Remove a column
     Post.reset_table_definition!
     Post.class_eval do
-      key.string :name
-      key.references :category
+      key :name
+      key :category, :as => :references
     end
     Post.auto_upgrade!
     post = Post.first
     post.name.must_be_nil
     post.category.must_equal category
+    post.wont_respond_to :title
+  end
+
+  it 'has indexes inside model' do
+    # Check indexes
+    Animal.auto_upgrade!
+    Animal.db_indexes.size.must_be :>, 0
+    Animal.db_indexes.must_equal Animal.indexes.keys.sort
+
+    indexes_was = Animal.db_indexes
+
+    # Remove an index
+    Animal.indexes.delete(indexes_was.pop)
+    Animal.auto_upgrade!
+    Animal.indexes.keys.sort.must_equal indexes_was
+    Animal.db_indexes.must_equal indexes_was
+
+    # Add a new index
+    Animal.class_eval do
+      key :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
 end

data/spec/models.rb

@@ -1,8 +1,7 @@
 require 'logger'
 
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-# ActiveRecord::Base.connection.tables.each { |t| ActiveRecord::Base.connection.drop_table(t) }
-# ActiveRecord::Base.logger = Logger.new($stdout)
+# ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new($stdout)
 
 module SpecHelper
   def self.included(base)
@@ -11,11 +10,15 @@ module SpecHelper
 
   module ClassMethods
     def db_columns
-      connection.columns(table_name).map(&:name)
+      connection.columns(table_name).map(&:name).sort
+    end
+
+    def db_indexes
+      connection.indexes(table_name).map(&:name).sort
     end
 
     def schema_columns
-      table_definition.columns.map { |c| c.name.to_s }
+      table_definition.columns.map { |c| c.name.to_s }.sort
     end
   end
 end
@@ -30,15 +33,22 @@ end
 class Post < ActiveRecord::Base
   include SpecHelper
 
-  key.string :title
-  key.string :body
-  key.references :category
+  key :title
+  key :body
+  key :category, :as => :references
   belongs_to :category
 end
 
 class Category < ActiveRecord::Base
   include SpecHelper
 
-  key.string :title
+  key :title
   has_many :posts
 end
+
+class Animal < ActiveRecord::Base
+  include SpecHelper
+
+  key :name, :index => true
+  index :id
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mini_record
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Davide D'Agostino
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-06 00:00:00 +02:00
+date: 2011-09-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,6 @@ files:
 - lib/mini_record/auto_schema.rb
 - lib/mini_record/version.rb
 - mini_record.gemspec
-- rakefile.compiled.rbc
 - spec/mini_record_spec.rb
 - spec/models.rb
 - spec/spec_helper.rb

data/rakefile.compiled.rbc

@@ -1,309 +0,0 @@
-!RBIX
-16846133056282117387
-x
-M
-1
-n
-n
-x
-10
-__script__
-i
-86
-5
-7
-0
-64
-47
-49
-1
-1
-15
-5
-7
-2
-64
-47
-49
-1
-1
-15
-5
-7
-3
-64
-47
-49
-1
-1
-15
-45
-4
-5
-43
-6
-7
-7
-56
-8
-50
-9
-1
-15
-5
-44
-43
-10
-79
-49
-11
-1
-13
-7
-12
-7
-7
-49
-13
-2
-15
-47
-49
-14
-1
-15
-5
-44
-43
-10
-79
-49
-11
-1
-13
-7
-15
-7
-7
-49
-13
-2
-15
-47
-49
-14
-1
-15
-2
-11
-I
-5
-I
-0
-I
-0
-I
-0
-n
-p
-16
-s
-17
-bundler/gem_tasks
-x
-7
-require
-s
-4
-rake
-s
-13
-rake/testtask
-x
-4
-Rake
-n
-x
-8
-TestTask
-x
-4
-test
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-9
-__block__
-i
-46
-57
-19
-0
-15
-20
-0
-49
-0
-0
-7
-1
-64
-49
-2
-1
-15
-20
-0
-45
-3
-4
-7
-5
-64
-49
-6
-1
-13
-18
-2
-49
-7
-1
-15
-15
-20
-0
-2
-13
-18
-2
-49
-8
-1
-15
-11
-I
-5
-I
-1
-I
-1
-I
-1
-n
-p
-9
-x
-4
-libs
-s
-4
-spec
-x
-2
-<<
-x
-3
-Dir
-n
-s
-17
-spec/**/*_spec.rb
-x
-2
-[]
-x
-11
-test_files=
-x
-8
-verbose=
-p
-9
-I
-0
-I
-5
-I
-4
-I
-6
-I
-10
-I
-7
-I
-23
-I
-8
-I
-2e
-x
-42
-/Developer/src/Extras/mini_record/rakefile
-p
-1
-x
-4
-test
-x
-3
-new
-x
-4
-Hash
-x
-16
-new_from_literal
-x
-7
-default
-x
-3
-[]=
-x
-4
-task
-x
-4
-spec
-p
-13
-I
-0
-I
-1
-I
-9
-I
-2
-I
-12
-I
-3
-I
-1b
-I
-5
-I
-28
-I
-b
-I
-3e
-I
-c
-I
-56
-x
-42
-/Developer/src/Extras/mini_record/rakefile
-p
-0