active_record_schema 0.3.5 → 0.4.0

data/README.md

@@ -1,9 +1,29 @@
 # ActiveRecordSchema
 
-**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.
+**ActiveRecordSchema** is an `ActiveRecord` extension that allows you to define fields 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.
 
+_ex._
+
+```
+rails g model Post title:string body:text --timestamps
+```
+
+``` rb
+class Post < ActiveRecord::Base
+    field :title, :string
+    field :body, :text
+    
+    attr_accessible :date, :name
+    timestamps
+end
+```
+
+```
+rails g migration create_posts --from Post
+```
+
 ## Features
 
 * Defining columns and indexes directly in model
@@ -196,7 +216,7 @@ class InitContents < ActiveRecord::Migration
   def change
     add_column :contents, :type, :string
     add_column :contents, :title, :string
-    add_column :contents, :author_id, :integer
+    add_column :contents, :author_id, :string
     add_column :contents, :body, :text
     add_column :contents, :url, :string
 
@@ -312,6 +332,26 @@ end
     ```
 
 
+## Generators
+
+### `rails g model`
+
+``` 
+      [--inheritable]          # Add 'inheritable' to the generated model
+      [--timestamps]           # Add 'timestamps' to the generated model
+      [--scope=SCOPE]          # The subpath of app/models in which model file will be created
+      [--parent=PARENT]        # The parent class for the generated model
+  -t, [--test-framework=NAME]  # Test framework to be invoked
+                               # Default: test_unit
+```
+
+### `rails g migration`
+
+```
+  [--from=FROM]  # calculates the changes to be applied on model table from the schema defined inside the model itself
+  [--id=N]       # The id to be used in this migration
+```
+
 ## 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.

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.0

data/active_record_schema.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{active_record_schema}
-  s.version = "0.3.5"
+  s.name = "active_record_schema"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{mcasimir}]
-  s.date = %q{2012-05-11}
-  s.description = %q{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.}
-  s.email = %q{maurizio.cas@gmail.com}
+  s.authors = ["mcasimir"]
+  s.date = "2012-05-18"
+  s.description = "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."
+  s.email = "maurizio.cas@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -37,13 +37,15 @@ Gem::Specification.new do |s|
     "lib/generators/active_record_schema/migration/migration_generator.rb",
     "lib/generators/active_record_schema/migration/templates/migration.rb",
     "lib/generators/active_record_schema/migration/templates/migration_from_model.rb.erb",
-    "lib/generators/active_record_schema/model/model_generator.rb"
+    "lib/generators/active_record_schema/model/model_generator.rb",
+    "lib/generators/active_record_schema/model/templates/model.rb",
+    "lib/generators/active_record_schema/model/templates/module.rb"
   ]
-  s.homepage = %q{http://github.com/mcasimir/active_record_schema}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{ActiveRecord extension allowing to write schema in models and to generate migrations from models}
+  s.homepage = "http://github.com/mcasimir/active_record_schema"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "ActiveRecord extension allowing to write schema in models and to generate migrations from models"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/active_record_schema/dsl.rb

@@ -33,7 +33,7 @@ module ActiveRecordSchema
          skip_index = options.delete(:index) == false
       
          foreign_key  = options[:foreign_key] || "#{name}_id"
-         field :"#{foreign_key}", :integer
+         field :"#{foreign_key}"
       
          if options[:polymorphic]
            foreign_type = options[:foreign_type] || "#{name}_type"

data/lib/active_record_schema/schema_diff.rb

@@ -15,6 +15,10 @@ module  ActiveRecordSchema
       _table_exists?
     end
     
+    def prefixed_table_name
+      _table
+    end
+    
     def _diff_fields_add
       model.schema.fields.values.delete_if {|field| _column_names.include?(field.name.to_s) }
     end
@@ -32,6 +36,7 @@ module  ActiveRecordSchema
     end
     
     def _table
+      # prefix = model.parents.find {|p| p.respond_to?(:table_name_prefix)}.try(:table_name_prefix)
       model.table_name
     end
     

data/lib/generators/active_record_schema/migration/migration_generator.rb

@@ -15,11 +15,7 @@ module ActiveRecordSchema
            ActiveRecordSchema.autoload_paths.each do |p|
              load(p)
            end
-           if model.schema.nothing_to_do?
-             say "Nothing to do for '#{options[:from]}'"
-           else
-             migration_template "migration_from_model.rb.erb", "db/migrate/#{file_name}.rb"          
-           end
+           migration_template "migration_from_model.rb.erb", "db/migrate/#{file_name}.rb"          
          else
            migration_template "migration.rb", "db/migrate/#{file_name}.rb"
          end

data/lib/generators/active_record_schema/migration/templates/migration_from_model.rb.erb

@@ -1,15 +1,15 @@
 class <%= migration_class_name %> < ActiveRecord::Migration
   def change
 <%- if !model.schema.table_exists? -%>
-    create_table :<%= model.table_name %>
+    create_table :<%= model.schema.prefixed_table_name %>
 
 <%- end -%>
 <%- model.schema.diff(:fields, :add).each do |field| -%>
-    add_column :<%= model.table_name %>, <%= field.name.inspect %>, <%= field.type.inspect %><%= ", #{field.options.inspect}" if !field.options.blank? %>
+    add_column :<%= model.schema.prefixed_table_name %>, <%= field.name.inspect %>, <%= field.type.inspect %><%= ", #{field.options.inspect}" if !field.options.blank? %>
 <%- end -%>
 
 <%- model.schema.diff(:indexes, :add).each do |index| -%>
-    add_index :<%= model.table_name %>, <%= index.name.inspect %><%= ", #{index.options.inspect}" if !index.options.blank? %>
+    add_index :<%= model.schema.prefixed_table_name %>, <%= index.name.inspect %><%= ", #{index.options.inspect}" if !index.options.blank? %>
 <%- end -%>
 
 <%- model.schema.diff(:joins, :add).each do |join| -%>

data/lib/generators/active_record_schema/model/model_generator.rb

@@ -3,30 +3,47 @@ require 'generators/active_record_schema'
 module ActiveRecordSchema
   module Generators
     class ModelGenerator < Base
-      class_option :in, :type => :string
-      class_option :inherit, :type => :string, :default => 'ActiveRecord::Base'
-      class_option :from
+
+      argument :attributes, :type => :array, :default => [], :banner => "field[:type][:index] field[:type][:index]"
+
+      check_class_collision
+
+      class_option :inheritable, :type => :boolean, :desc => "Add 'inheritable' to the generated model"
+      class_option :timestamps,  :type => :boolean, :desc => "Add 'timestamps' to the generated model"
+      class_option :scope,       :type => :string,  :desc => "The subpath of app/models in which model file will be created"
+      class_option :parent,      :type => :string,  :desc => "The parent class for the generated model"
 
       def create_model_file
-        create_file ["app", "models", subdir, "#{file_name}.rb"].compact.join('/'), <<-FILE
-    class #{class_name} < #{ inherit }
-    end
-        FILE
+        template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        scope_path = ["app", "models", subdir].compact.join('/')
+        template 'module.rb', File.join(scope_path, "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      def attributes_with_index
+        attributes.select { |a| a.has_index? || (a.reference? && options[:indexes]) }
       end
-  
-      private
+
+      def accessible_attributes
+        attributes.reject(&:reference?)
+      end
+
+      hook_for :test_framework
+
+      protected
 
       def subdir
         in_opt = "#{options[:in]}".strip
         in_opt.empty? || in_opt.match(/\//) ? nil : in_opt
       end
-  
-      def inherit
-        options[:inherit]
+
+      def parent_class_name
+        options[:parent] || "ActiveRecord::Base"
       end
-      
-      
+
     end
   end
-end
-
+end

data/lib/generators/active_record_schema/model/templates/model.rb

@@ -0,0 +1,26 @@
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% if options[:inheritable]-%>
+  inheritable
+<% end %>
+<% attributes.each do |attribute| -%>
+  field :<%= attribute.name %>, :<%= attribute.type %><%= attribute.inject_options %>
+<% end -%>
+<% if options[:timestamps] %>
+  timestamps
+<% end -%>
+<% attributes.select {|attr| attr.reference? }.each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+<% if !accessible_attributes.empty? -%>
+  attr_accessible <%= accessible_attributes.map {|a| ":#{a.name}" }.sort.join(', ') %>
+<% else -%>
+  # attr_accessible :title, :body
+<% end -%>
+end
+<% end -%>
+
+
+
+
+

data/lib/generators/active_record_schema/model/templates/module.rb

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+  def self.table_name_prefix
+    '<%= class_path.join('_') %>_'
+  end
+end
+<% end -%>

metadata

@@ -1,49 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: active_record_schema
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  version: 0.3.5
 platform: ruby
-authors: 
+authors:
 - mcasimir
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *id002
-description: 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.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: 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.
 email: maurizio.cas@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -65,35 +74,35 @@ files:
 - lib/generators/active_record_schema/migration/templates/migration.rb
 - lib/generators/active_record_schema/migration/templates/migration_from_model.rb.erb
 - lib/generators/active_record_schema/model/model_generator.rb
+- lib/generators/active_record_schema/model/templates/model.rb
+- lib/generators/active_record_schema/model/templates/module.rb
 homepage: http://github.com/mcasimir/active_record_schema
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 401825820335667031
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2966481555422020030
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ActiveRecord extension allowing to write schema in models and to generate migrations from models
+summary: ActiveRecord extension allowing to write schema in models and to generate
+  migrations from models
 test_files: []
-