active_record_schema 0.2.1 → 0.2.2

data/README.md

@@ -1,66 +1,86 @@
 # ActiveRecordSchema
 
-*ActiveRecordSchema* is an ActiveRecord extension that allows you to write the database schema for a model within the model itself and to generate migrations directly from models.
+**ActiveRecordSchema** is an `ActiveRecord` extension that allows you to write database schema for a model within the model itself and to generate migrations directly from models.
 
 Unlike other libraries (eg. mini_record) ActiveRecordSchema is not an alternative to Rails migrations, but rather a tool to simplify their use.
 
-Install
+## Features
+
+* Defining columns and indexes directly in model
+* Generation of migration from the model taking into account the current state of the database
+* Automatically add code to migrate associations:
+   * Foreign key for `belongs_to`
+   * Join table for `has_and_belongs_to_many`
+  
+* Automatic indexing of foreign keys for both `belongs_to` and `has_and_belongs_to_many` (configurable)
+
+## Installation
+
+Put this in your Gemfile
 
     gem 'active_record_schema'
     
-Update your bundle
+and update your bundle
   
     bundle install
+    
+**NOTE:** ActiveRecordSchema depends on `rails ~> 3.0` and not only `ActiveRecord`
 
 ## Usage
 
-Create a model
-    
-    class Post < ActiveRecord::Base
-        field :title
-        field :body, :as => :text
-        belongs_to :author, :class_name => "User"
-    end
+Create a model and use the class method `#field` to define columns
 
-Run a migration generator each time you want to commit changes to database
+``` rb    
+class Post < ActiveRecord::Base
+    field :title
+    field :body, :as => :text
+    belongs_to :author, :class_name => "User"
+end
+```
+
+Now run `rails g migration` with `--from` option
 
     rails g migration init_posts_schema --from Post
   
-Will generate the following migration
-
-    class InitPostsSchema < ActiveRecord::Migration
-      def change
-        add_column :posts, :title, :string
-        add_column :posts, :body, :text
-
-        add_column :author_id, :integer
-        index :author_id
-      end
-    end
-
-Now you can migrate the database.
-
-Later in the life cycle of the project... add a new field to `Post`
+and the following migration will be generated
+
+``` rb    
+class InitPostsSchema < ActiveRecord::Migration
+  def change
+    add_column :posts, :title, :string
+    add_column :posts, :body, :text
+
+    add_column :author_id, :integer
+    index :author_id
+  end
+end
+```
+
+Generating a migration for new columns is the same, lets add a new field to `Post` (eg. `pubdate`):
+
+``` rb    
+class Post < ActiveRecord::Base
+    field :title
+    field :body, :as => :text
+    belongs_to :author, :class_name => "User"
     
-    class Post < ActiveRecord::Base
-        field :title
-        field :body, :as => :text
-        belongs_to :author, :class_name => "User"
-        field :pubdate, :as => :datetime
-    end
+    field :pubdate, :as => :datetime
+end
+```
 
-Generate easily a new migration for the change:
+Now run
 
     rails g migration add_pubdate_to_posts --from Post
 
-Will generate:
-
-    class AddPubdateToPosts < ActiveRecord::Migration
-      def change
-        add_column :posts, :pubdate, :datetime
-      end
-    end
+that will generate:
 
+``` rb
+class AddPubdateToPosts < ActiveRecord::Migration
+  def change
+    add_column :posts, :pubdate, :datetime
+  end
+end
+```
 
 ## Has and Belongs To Many (HBTM) associations
 
@@ -68,23 +88,26 @@ Lets try to add a HBTM association to our `Post` model
 
 _ex._
 
-    # content.rb
-    class Post < ActiveRecord::Base
-      field :title
-      field :body, :as => :text
-      belongs_to :author, :class_name => "User"
-      field :pubdate, :as => :datetime
+``` rb
+# content.rb
+class Post < ActiveRecord::Base
+  field :title
+  field :body, :as => :text
+  belongs_to :author, :class_name => "User"
+  field :pubdate, :as => :datetime
 
-      has_and_belongs_to_many :voters, :class_name => "User"
-    end
+  has_and_belongs_to_many :voters, :class_name => "User"
+end
+```
 
 
 Now running
 
     rails g migration add_voters_to_posts --from Post
 
-Will generate:
+will generate:
 
+``` rb
     class AddVotersToPosts < ActiveRecord::Migration
       def change
         create_table :contents_users, :id => false do |t|
@@ -95,38 +118,41 @@ Will generate:
         add_index :contents_users, "user_id"
       end
     end
+```
 
 ## Single Table Inheritance (STI)
 
-Call `#inheritable` inside the base class of your hierarchy to add the `type` column required by Single Table Inheritance.
+Call `#inheritable` inside the base class of your hierarchy to add the inheritance column required by Single Table Inheritance.
 
 _ex._
 
-    # content.rb
-    class Content < ActiveRecord::Base
-      inheritable
+``` rb
+# content.rb
+class Content < ActiveRecord::Base
+  inheritable
   
-      field :title
+  field :title
   
-      has_and_belongs_to_many :voters, :class_name => "User"
-      belongs_to              :author, :class_name => "User"
+  has_and_belongs_to_many :voters, :class_name => "User"
+  belongs_to              :author, :class_name => "User"
     
-      timestamps
-    end
+  timestamps
+end
     
   
-    # article.rb
-    class Article < Content
-      field :body, :as => :text
-    end
+# article.rb
+class Article < Content
+  field :body, :as => :text
+end
     
   
-    # video.rb
-    class Video < Content
-      field :url
-    end
+# video.rb
+class Video < Content
+  field :url
+end
+```
 
-run
+Running
     
     rails g migration init_contents --from Content
 
@@ -138,27 +164,128 @@ same as
 
     rails g migration init_contents --from Video
     
-Will generate the following migration 
+will generate the following migration 
+
+``` rb
+class InitContents < ActiveRecord::Migration
+  def change
+    add_column :contents, :type, :string
+    add_column :contents, :title, :string
+    add_column :contents, :author_id, :string
+    add_column :contents, :body, :text
+    add_column :contents, :url, :string
+
+    add_index :contents, :author_id
+
+    create_table :contents_users, :id => false do |t|
+      t.integer  "content_id"
+      t.integer  "user_id"
+    end
+    add_index :contents_users, "content_id"
+    add_index :contents_users, "user_id"
+  end  
+end
+```
 
-    class InitContents < ActiveRecord::Migration
-      def change
-        add_column :contents, :type, :string
-        add_column :contents, :title, :string
-        add_column :contents, :author_id, :string
-        add_column :contents, :body, :text
-        add_column :contents, :url, :string
 
-        add_index :contents, :author_id
+## Mixins
 
-        create_table :contents_users, :id => false do |t|
-          t.integer  "content_id"
-          t.integer  "user_id"
-        end
-        add_index :contents_users, "content_id"
-        add_index :contents_users, "user_id"
-      end  
-    end
+Probably one of the most significant advantage given by ActiveRecordSchema is to allow the definition of fields in modules and reuse them through mixin
+
+_ex._
 
+``` rb
+module Profile
+  extend ActiveSupport::Concern
+  included do
+    field :name
+    field :age, :as => :integer
+      
+  end
+end
+    
+class User < ActiveRecord::Base
+  include Profile
+  
+end
+    
+class Player < ActiveRecord::Base
+  include Profile
+      
+end
+```
+
+
+## DSL (Domain Specific Language) reference
+
+  * ### `field(name, *args)`
+
+    Adds a new column with name `name` to the schema. The type of column can be passed either as second argument or as option, if not specified is intended to be `:string`
+
+    #### options  
+
+    * **:as _or_ :type** : Specify the type of the column. The value can be a `String`, a `Symbol` or a `Class`, default to `:string`
+    * **:index** : Specify wether or not the field should be indexed, default to `false`
+
+    #### examples
+
+    ``` rb
+    field :name
+
+    field :name, :string
+    field :name, "string"
+    field :name, String
+
+    field :name, :as => :string
+    field :name, :as => "string"
+    field :name, :as => String
+
+    field :name, :type => :string
+    field :name, :type => "string"
+    field :name, :type => String
+
+    field :age, :as => :integer, :index => true
+    ```
+
+
+  * ### `belongs_to(name, options = {})`
+
+    Adds a new foreign key column for the association to the schema and then delegates to `ActiveRecord::Base.belongs_to`. If the association is polimorphic a column for foreign type is also generated.
+
+    #### options  
+
+    * **:index** : Specify wether or not the foreing key column should be indexed, default to `true`. If the association is polimorphic creates an index on both foreign key and foreing type
+
+
+  * ### `has_and_belongs_to_many(name, options = {}, &extension)`
+
+    Adds a new join table for the association to the schema and then delegates to `ActiveRecord::Base.has_and_belongs_to_many`
+
+  * ### `index(column_name, options = {})`
+
+    Adds a new index for `column_name` column to the schema
+
+  * ### `timestamps`
+
+    Same as
+
+    ``` rb
+    field :created_at, :datetime
+    field :updated_at, :datetime
+    ```
+
+  * ### `inheritable`
+  
+    Same as
+
+    ``` rb
+    field :"#{inheritance_column}"
+    ```
+
+
+## Why do not also generate irreversible changes (change/remove columns or indexes)?
+
+ActiveRecordSchema does not take into account the removal of columns and indexes or changes in the types of columns. The reason for this is that these changes are not reversible, so it's a better idea to introduce them by hand rather than let them be generated automatically. Anyway the need to resort to harsh measures such as irreversible changes is limited to non-routine situations.
 
 
 ## Contributing to active_record_schema
@@ -171,7 +298,6 @@ Will generate the following migration
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-
 ---
 
 Copyright (c) 2012 mcasimir

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/active_record_schema.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "active_record_schema"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mcasimir"]

data/lib/active_record_schema/dsl.rb

@@ -17,7 +17,7 @@ module ActiveRecordSchema
        # field :name, :string, :default => "Joe"      
        def field(name, *args)
          options    = args.extract_options!
-         type       =  options.delete(:as) || options.delete(:type) || args.first || :string
+         type       = options.delete(:as) || options.delete(:type) || args.first || :string
          type       = type.name.underscore.to_sym if (type.class == Class) 
          index      = options.delete(:index)
   
@@ -27,9 +27,6 @@ module ActiveRecordSchema
            schema.add_index(name)
          end       
        end
-       alias :key       :field
-       alias :property  :field
-       alias :col       :field
     
        def belongs_to(name, options = {})
          options.symbolize_keys!
@@ -64,21 +61,18 @@ module ActiveRecordSchema
          super(name, options, &extension)
        end
             
-       def add_index(column_name, options = {})
+       def index(column_name, options = {})
          schema.add_index(column_name, options)
        end
-       alias :index :add_index
       
-       def timestamps!
+       def timestamps
          field :created_at, :datetime
          field :updated_at, :datetime
        end
-       alias :timestamps :timestamps!
      
-       def inheritable!
+       def inheritable
          field :"#{inheritance_column}"
        end
-       alias :inheritable :inheritable!
      
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -757246031215524947
+      hash: -4255216891486240966
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: