hobofields 0.8.10 → 0.9.0

data/Rakefile

@@ -2,6 +2,9 @@ require 'rubygems'
 require 'activerecord'
 ActiveRecord::ActiveRecordError # hack for https://rails.lighthouseapp.com/projects/8994/tickets/2577-when-using-activerecordassociations-outside-of-rails-a-nameerror-is-thrown
 
+RUBY = ENV['RUBY'] || (defined?(JRUBY_VERSION) ? 'jruby' : 'ruby')
+RUBYDOCTEST = ENV['RUBYDOCTEST'] || "#{RUBY} `which rubydoctest`"
+
 $:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '/../hobofields/lib')
 $:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '/../hobosupport/lib')
 require 'hobosupport'
@@ -10,13 +13,13 @@ require 'hobofields'
 namespace "test" do
   desc "Run the doctests"
   task :doctest do |t|
-    exit(1) if !system("rubydoctest test/*.rdoctest")
+    exit(1) if !system("#{RUBYDOCTEST} test/*.rdoctest")
   end
 
   desc "Run the unit tests"
   task :unit do |t|
     Dir["test/test_*.rb"].each do |f|
-      exit(1) if !system("ruby #{f}")
+      exit(1) if !system("#{RUBY} #{f}")
     end
   end
 end
@@ -30,7 +33,7 @@ begin
     gemspec.summary      = "Rich field types and migration generator for Rails"
     gemspec.homepage     = "http://hobocentral.net/"
     gemspec.authors      = ["Tom Locke"]
-    gemspec.rubyforge_project = "hobofields"
+    gemspec.rubyforge_project = "hobo"
     gemspec.add_dependency("rails", [">= 2.2.2"])
     gemspec.add_dependency("hobosupport", ["= #{HoboFields::VERSION}"])    
   end

data/lib/hobo_fields/email_address.rb

@@ -5,7 +5,7 @@ module HoboFields
     COLUMN_TYPE = :string
 
     def validate
-      "is not valid" unless valid? || blank?
+      I18n.t("activerecord.errors.messages.invalid") unless valid? || blank?
     end
 
     def valid?

data/lib/hobo_fields/enum_string.rb

@@ -28,6 +28,7 @@ module HoboFields
         c = Class.new(EnumString) do
           values.each do |v|
             const_name = v.upcase.gsub(/[^a-z0-9_]/i, '_').gsub(/_+/, '_')
+            const_name = "V" + const_name if const_name =~ /^[0-9_]/
             const_set(const_name, self.new(v)) unless const_defined?(const_name)
 
             method_name = "is_#{v.underscore}?"

data/lib/hobo_fields/field_spec.rb

@@ -17,6 +17,18 @@ module HoboFields
     
     TYPE_SYNONYMS = [[:timestamp, :datetime]]
 
+    begin
+      MYSQL_COLUMN_CLASS = ActiveRecord::ConnectionAdapters::MysqlColumn
+    rescue NameError
+      MYSQL_COLUMN_CLASS = NilClass
+    end
+
+    begin
+      SQLITE_COLUMN_CLASS = ActiveRecord::ConnectionAdapters::SQLiteColumn
+    rescue NameError
+      SQLITE_COLUMN_CLASS = NilClass
+    end
+
     def sql_type
       options[:sql_type] or begin
                               if native_type?(type)
@@ -55,7 +67,7 @@ module HoboFields
           return col_spec.type.in?(synonyms)
         end
       end
-      t = col_spec.type
+      t == col_spec.type
     end
       
 
@@ -63,9 +75,16 @@ module HoboFields
       !same_type?(col_spec) ||
         begin
           check_attributes = [:null, :default]
-          check_attributes += [:precision, :scale] if sql_type == :decimal
+          check_attributes += [:precision, :scale] if sql_type == :decimal && !col_spec.is_a?(SQLITE_COLUMN_CLASS)  # remove when rails fixes https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2872
+          check_attributes -= [:default] if sql_type == :text && col_spec.is_a?(MYSQL_COLUMN_CLASS)
           check_attributes << :limit if sql_type.in?([:string, :text, :binary, :integer])
-          check_attributes.any? { |k| col_spec.send(k) != self.send(k) }
+          check_attributes.any? do |k|
+            if k==:default && sql_type==:datetime
+              col_spec.default.try.to_datetime != default.try.to_datetime
+            else
+              col_spec.send(k) != self.send(k)
+            end
+          end
         end
     end
 

data/lib/hobo_fields/index_spec.rb

@@ -0,0 +1,45 @@
+module HoboFields
+
+  class IndexSpec
+
+    def initialize(model, fields, options={})
+      @model = model
+      self.table = options.delete(:table_name) || model.table_name
+      self.fields = Array.wrap(fields).*.to_s
+      self.name = options.delete(:name) || model.connection.index_name(self.table, :column => self.fields)
+      self.unique = options.delete(:unique) || false
+    end
+
+    attr_accessor :table, :fields, :name, :unique
+
+    # extract IndexSpecs from an existing table
+    def self.for_model(model, old_table_name=nil)
+      t = old_table_name || model.table_name
+      model.connection.indexes(t).map do |i|
+        self.new(model, i.columns, :name => i.name, :unique => i.unique, :table_name => old_table_name)
+      end
+    end
+
+    def default_name?
+      name == @model.connection.index_name(table, :column => fields)
+    end
+
+    def to_add_statement(new_table_name)
+      r = "add_index :#{new_table_name}, #{fields.*.to_sym.inspect}"
+      r += ", :unique => true" if unique
+      r += ", :name => '#{name}'" unless default_name?
+      r
+    end
+
+    def hash
+      [table, fields, name, unique].hash
+    end
+
+    def ==(v)
+      v.hash == hash
+    end
+    alias_method :eql?, :==
+
+  end
+
+end

data/lib/hobo_fields/migration_generator.rb

@@ -8,7 +8,7 @@ module HoboFields
     @ignore_tables = []
 
     class << self
-      attr_accessor :ignore_models, :ignore_tables
+      attr_accessor :ignore_models, :ignore_tables, :disable_indexing
     end
 
     def self.run(renames={})
@@ -63,13 +63,22 @@ module HoboFields
     end
     def native_types; self.class.native_types; end
 
+    # list habtm join tables
+    def habtm_tables
+      ActiveRecord::Base.send(:subclasses).map do |c|
+        c.reflect_on_all_associations(:has_and_belongs_to_many).map { |a| a.options[:join_table] }
+      end.flatten.compact.*.to_s
+    end
+
     # Returns an array of model classes and an array of table names
     # that generation needs to take into account
     def models_and_tables
       ignore_model_names = MigrationGenerator.ignore_models.map &it.to_s.underscore
-      models = table_model_classes.select { |m| m < HoboFields::ModelExtensions && m.name.underscore.not_in?(ignore_model_names) }
-      db_tables = connection.tables - MigrationGenerator.ignore_tables.*.to_s
-      [models, db_tables]
+      all_models = table_model_classes
+      hobo_models = all_models.select { |m| m < HoboFields::ModelExtensions && m.name.underscore.not_in?(ignore_model_names) }
+      non_hobo_models = all_models - hobo_models
+      db_tables = connection.tables - MigrationGenerator.ignore_tables.*.to_s - non_hobo_models.*.table_name - habtm_tables
+      [hobo_models, db_tables]
     end
 
 
@@ -128,6 +137,7 @@ module HoboFields
     
     
     def always_ignore_tables
+      # TODO: figure out how to do this in a sane way and be compatible with 2.2 and 2.3 - class has moved
       sessions_table = CGI::Session::ActiveRecordStore::Session.table_name if
         defined?(CGI::Session::ActiveRecordStore::Session) &&
         defined?(ActionController::Base) &&
@@ -200,7 +210,11 @@ module HoboFields
       primary_key_option = ", :primary_key => :#{model.primary_key}" if model.primary_key != "id"
       (["create_table :#{model.table_name}#{primary_key_option} do |t|"] +
        model.field_specs.values.sort_by{|f| f.position}.map {|f| create_field(f, longest_field_name)} +
-       ["end"]) * "\n"
+       ["end"] + (MigrationGenerator.disable_indexing ? [] : create_indexes(model))) * "\n"
+    end
+
+    def create_indexes(model)
+      model.index_specs.map { |i| i.to_add_statement(model.table_name) }
     end
 
     def create_field(field_spec, field_name_width)
@@ -276,10 +290,36 @@ module HoboFields
         end
       end.compact
 
-      [(renames + adds + removes + changes) * "\n",
-       (undo_renames + undo_adds + undo_removes + undo_changes) * "\n"]
+      index_changes, undo_index_changes = change_indexes(model, current_table_name)
+
+      [(renames + adds + removes + changes + index_changes) * "\n",
+       (undo_renames + undo_adds + undo_removes + undo_changes + undo_index_changes) * "\n"]
     end
 
+    def change_indexes(model, old_table_name)
+      return [[],[]] if MigrationGenerator.disable_indexing
+      new_table_name = model.table_name
+      existing_indexes = IndexSpec.for_model(model, old_table_name)
+      model_indexes = model.index_specs
+      add_indexes = model_indexes - existing_indexes
+      drop_indexes = existing_indexes - model_indexes
+      undo_add_indexes = []
+      undo_drop_indexes = []
+      add_indexes.map! do |i|
+        undo_add_indexes << drop_index(old_table_name, i.name)
+        i.to_add_statement(new_table_name)
+      end
+      drop_indexes.map! do |i|
+        undo_drop_indexes << i.to_add_statement(old_table_name)
+        drop_index(new_table_name, i.name)
+      end
+      # the order is important here - adding a :unique, for instance needs to remove then add
+      [drop_indexes + add_indexes, undo_add_indexes + undo_drop_indexes]
+    end
+
+    def drop_index(table, name)
+      "remove_index :#{table}, :name => :#{name}"
+    end
 
     def format_options(options, type, changing=false)
       options.map do |k, v|

data/lib/hobo_fields/model_extensions.rb

@@ -15,16 +15,19 @@ module HoboFields
     # and speeds things up a little.
     inheriting_cattr_reader :field_specs => HashWithIndifferentAccess.new
 
+    # index_specs holds IndexSpec objects for all the declared indexes.
+    inheriting_cattr_reader :index_specs => []
+
     def self.inherited(klass)
       fields do |f|
         f.field(inheritance_column, :string)
       end
+      index(inheritance_column) unless index_specs.*.fields.include?([inheritance_column])
       super
     end
 
-
-    def self.field_specs
-      @field_specs ||= HashWithIndifferentAccess.new
+    def self.index(fields, options = {})
+      index_specs << IndexSpec.new(self, fields, options)
     end
 
 
@@ -52,8 +55,9 @@ module HoboFields
         type = HoboFields.to_class(type)
         attrs.each do |attr|
           declare_attr_type attr, type, options
+          type_wrapper = attr_type(attr)
           define_method "#{attr}=" do |val|
-            if !val.is_a?(type) && HoboFields.can_wrap?(type, val)
+            if type_wrapper.not_in?(HoboFields::PLAIN_TYPES.values) && !val.is_a?(type) && HoboFields.can_wrap?(type, val)
               val = type.new(val.to_s)
             end
             instance_variable_set("@#{attr}", val)
@@ -68,11 +72,19 @@ module HoboFields
       column_options = {}
       column_options[:null] = options.delete(:null) if options.has_key?(:null)
 
+      index_options = {}
+      index_options[:name] = options.delete(:index) if options.has_key?(:index)
+
       returning belongs_to_without_field_declarations(name, options, &block) do
         refl = reflections[name.to_sym]
         fkey = refl.primary_key_name
         declare_field(fkey.to_sym, :integer, column_options)
-        declare_polymorphic_type_field(name, column_options) if refl.options[:polymorphic]
+        if refl.options[:polymorphic]
+          declare_polymorphic_type_field(name, column_options)
+          index(["#{name}_type", fkey], index_options) if index_options[:name]!=false
+        else
+          index(fkey, index_options) if index_options[:name]!=false
+        end
       end
     end
     class << self
@@ -110,6 +122,7 @@ module HoboFields
       try.field_added(name, type, args, options)
       add_formatting_for_field(name, type, args)
       add_validations_for_field(name, type, args)
+      add_index_for_field(name, args, options)
       declare_attr_type(name, type, options) unless HoboFields.plain_type?(type)
       field_specs[name] = FieldSpec.new(self, name, type, options)
       attr_order << name unless name.in?(attr_order)
@@ -120,7 +133,7 @@ module HoboFields
     # field declaration
     def self.add_validations_for_field(name, type, args)
       validates_presence_of   name if :required.in?(args)
-      validates_uniqueness_of name if :unique.in?(args)
+      validates_uniqueness_of name, :allow_nil => !:required.in?(args) if :unique.in?(args)
 
       type_class = HoboFields.to_class(type)
       if type_class && "validate".in?(type_class.public_instance_methods)
@@ -131,7 +144,6 @@ module HoboFields
       end
     end
 
-
     def self.add_formatting_for_field(name, type, args)
       type_class = HoboFields.to_class(type)
       if type_class && "format".in?(type_class.instance_methods)
@@ -141,6 +153,16 @@ module HoboFields
       end
     end
 
+    def self.add_index_for_field(name, args, options)
+      to_name = options.delete(:index)
+      return unless to_name
+      index_opts = {}
+      index_opts[:unique] = :unique.in?(args) || options.delete(:unique)
+      # support :index => true declaration
+      index_opts[:name] = to_name unless to_name == true
+      index(name, index_opts)
+    end
+
 
     # Extended version of the acts_as_list declaration that
     # automatically delcares the 'position' field

data/lib/hobo_fields.rb

@@ -9,7 +9,7 @@ end
 
 module HoboFields
 
-  VERSION = "0.8.10"
+  VERSION = "0.9.0"
 
   extend self
 
@@ -32,7 +32,9 @@ module HoboFields
   # Provide a lookup for these rather than loading them all preemptively
   
   STANDARD_TYPES = {
+    :raw_html      => "RawHtmlString",
     :html          => "HtmlString",
+    :raw_markdown  => "RawMarkdownString",
     :markdown      => "MarkdownString",
     :textile       => "TextileString",
     :password      => "PasswordString",

data/rails_generators/hobo_migration/USAGE

@@ -0,0 +1,47 @@
+Description:
+
+        This generator compares your existing schema against the
+        schema declared inside your fields declarations in your
+        models.
+
+        If the generator finds differences, it will display the
+        migration it has created, and ask you if you wish to
+        [g]enerate migration, generate and [m]igrate now or [c]ancel?
+        Enter "g" to just generate the migration but do not run it.
+        Enter "m" to generate the migration and run it, or press "c"
+        to do nothing.
+
+        The generator will then prompt you for the generator name,
+        supplying a numbered default name.
+
+        The generator is conservative and will prompt you to resolve
+        any ambiguities.
+
+Examples:
+
+        $ ./script/generate hobo_migration
+
+        ---------- Up Migration ----------
+        create_table :foos do |t|
+          t.datetime :created_at
+          t.datetime :updated_at
+        end
+        ----------------------------------
+
+        ---------- Down Migration --------
+        drop_table :foos
+        ----------------------------------
+        What now: [g]enerate migration, generate and [m]igrate now or [c]ancel? m
+
+        Migration filename:
+        (you can type spaces instead of '_' -- every little helps)
+        Filename [hobo_migration_2]: create_foo
+              exists  db/migrate
+              create  db/migrate/20091023183838_create_foo.rb
+        (in /work/foo)
+        ==  CreateFoo: migrating ======================================================
+        -- create_table(:yos)
+           -> 0.0856s
+        ==  CreateFoo: migrated (0.0858s) =============================================
+
+

data/rails_generators/hobo_migration/hobo_migration_generator.rb

@@ -133,8 +133,8 @@ class HoboMigrationGenerator < Rails::Generator::Base
       
       opt.on("--force-drop",   "Don't prompt with 'drop or rename' - just drop everything") { |v| options[:force_drop] = true }
       opt.on("--default-name", "Dont' prompt for a migration name - just pick one")         { |v| options[:default_name] = true }
-      opt.on("--generate",     "Dont' prompt for action - generate the migration")          { |v| options[:action] = 'g' }
-      opt.on("--migrate",      "Dont' prompt for action - generate and migrate")            { |v| options[:action] = 'm' }
+      opt.on("--generate",     "Don't prompt for action - generate the migration")          { |v| options[:action] = 'g' }
+      opt.on("--migrate",      "Don't prompt for action - generate and migrate")            { |v| options[:action] = 'm' }
     end
   
 

data/rails_generators/hobofield_model/hobofield_model_generator.rb

@@ -33,6 +33,6 @@ class HobofieldModelGenerator < Rails::Generator::NamedBase
       opt.on("--skip-timestamps",
              "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
       opt.on("--skip-fixture",
-             "Don't generation a fixture file for this model") { |v| options[:skip_fixture] = v}
+             "Don't generate a fixture file for this model") { |v| options[:skip_fixture] = v}
     end
 end

data/test/hobofields.rdoctest

@@ -30,7 +30,7 @@ Now edit your model as follows:
 
 Then, simply run
 
-        $ ./script/genearte hobo_migration
+        $ ./script/generate hobo_migration
 
 And voila
 

data/test/hobofields_api.rdoctest

@@ -16,12 +16,17 @@ Our test requires rails:
 We need a database connection for this test:
 {.hidden}
 
+    >> mysql_adapter = defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'
+    >> mysql_user = 'root'; mysql_password = ''
+    >> mysql_login = "-u #{mysql_user} --password='#{mysql_password}'"
     >> mysql_database = "hobofields_doctest"
-    >> system "mysqladmin --force drop #{mysql_database} 2> /dev/null"
-    >> system("mysqladmin create #{mysql_database}") or raise "could not create database"
-    >> ActiveRecord::Base.establish_connection(:adapter => "mysql",
+    >> system "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
+    >> system("mysqladmin #{mysql_login} create #{mysql_database}") or raise "could not create database"
+    >> ActiveRecord::Base.establish_connection(:adapter => mysql_adapter,
                                                :database => mysql_database,
-                                               :host => "localhost")
+                                               :host => "localhost", 
+                                               :username => mysql_user, 
+                                               :password => mysql_password)
 {.hidden}
 
 Some load path manipulation you shouldn't need:
@@ -225,14 +230,14 @@ Rich types can define there own validations by a `#validate` method. It should r
         >> a.contact_address.class
         => HoboFields::EmailAddress
         >> a.contact_address.validate
-        => "is not valid"
+        => "is invalid"
 
 But normally that method would be called for us during validation:
 
         >> a.valid?
         => false
         >> a.errors.full_messages
-        => ["Contact address is not valid"]
+        => ["Contact address is invalid"]
         >> a.contact_address = "me@me.com"
         >> a.valid?
         => true
@@ -266,5 +271,5 @@ To have them validated use `validate_virtual_field`:
 Cleanup
 {.hidden}
 
-    >> system  "mysqladmin --force drop #{mysql_database} 2> /dev/null"
+    >> system  "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
 {.hidden}

data/test/migration_generator.rdoctest

@@ -14,12 +14,17 @@ Firstly, in order to test the migration generator outside of a full Rails stack,
 We also need to get ActiveRecord set up with a database connection
 {.hidden}
 
+    >> mysql_adapter = defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'
+    >> mysql_user = 'root'; mysql_password = ''
+    >> mysql_login = "-u #{mysql_user} --password='#{mysql_password}'"
     >> mysql_database = "hobofields_doctest"
-    >> system "mysqladmin --force drop #{mysql_database} 2> /dev/null"
-    >> system("mysqladmin create #{mysql_database}") or raise "could not create database"
-    >> ActiveRecord::Base.establish_connection(:adapter => "mysql",
+    >> system "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
+    >> system("mysqladmin #{mysql_login} create #{mysql_database}") or raise "could not create database"
+    >> ActiveRecord::Base.establish_connection(:adapter => mysql_adapter,
                                                :database => mysql_database,
-                                               :host => "localhost")
+                                               :host => "localhost", 
+                                               :username => mysql_user, 
+                                               :password => mysql_password)
 {.hidden}
 
 Some load path manipulation you shouldn't need:
@@ -242,13 +247,16 @@ Note that limit on a decimal column is ignored (use :scale and :precision)
     => "add_column :adverts, :price, :decimal"
 
 Cleanup
+{.hidden}
 
     >> Advert.field_specs.delete :price
+{.hidden}
     
 
 ### Foreign Keys
 
-HoboFields extends the `belongs_to` macro so that it also declares the foreign-key field.
+HoboFields extends the `belongs_to` macro so that it also declares the
+foreign-key field.  It also generates an index on the field.
 
         >>
          class Advert
@@ -256,13 +264,20 @@ HoboFields extends the `belongs_to` macro so that it also declares the foreign-k
          end
         >> up, down = HoboFields::MigrationGenerator.run
         >> up
-        => 'add_column :adverts, :category_id, :integer'
+        => 
+         "add_column :adverts, :category_id, :integer
+         add_index :adverts, [:category_id]"
         >> down
-        => 'remove_column :adverts, :category_id'
+        => 
+         "remove_column :adverts, :category_id
+         remove_index :adverts, :name => :index_adverts_on_category_id"
 
 Cleanup:
+{.hidden}
 
         >> Advert.field_specs.delete(:category_id)
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["category_id"]}
+{.hidden}
 
 If you specify a custom foreign key, the migration generator observes that:
 
@@ -272,14 +287,52 @@ If you specify a custom foreign key, the migration generator observes that:
          end
         >> up, down = HoboFields::MigrationGenerator.run
         >> up
-        => 'add_column :adverts, :c_id, :integer'
-        >> down
-        => 'remove_column :adverts, :c_id'
+        => 
+         "add_column :adverts, :c_id, :integer
+         add_index :adverts, [:c_id]"
 
 Cleanup:
+{.hidden}
 
         >> Advert.field_specs.delete(:c_id)
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["c_id"]}
+{.hidden}
+
+You can avoid generating the index by specifying `:index => false`
+
+        >>
+         class Advert
+           belongs_to :category, :index => false
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up
+        => "add_column :adverts, :category_id, :integer"
+
+Cleanup:
+{.hidden}
+
+        >> Advert.field_specs.delete(:category_id)
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["category_id"]}
+{.hidden}
 
+You can specify the index name with :index
+
+        >>
+         class Advert
+           belongs_to :category, :index => 'my_index'
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up
+        => 
+         "add_column :adverts, :category_id, :integer
+         add_index :adverts, [:category_id], :name => 'my_index'"
+
+Cleanup:
+{.hidden}
+
+        >> Advert.field_specs.delete(:category_id)
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["category_id"]}
+{.hidden}
 
 ### Timestamps
 
@@ -303,10 +356,115 @@ Cleanup:
         >>
 
 Cleanup:
+{.hidden}
 
         >> Advert.field_specs.delete(:updated_at)
         >> Advert.field_specs.delete(:created_at)
+{.hidden}
+
+### Indices
+
+You can add an index to a field definition
+
+        >>
+         class Advert
+           fields do
+             title :string, :index => true
+           end
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up.split("\n")[1]
+        => 'add_index :adverts, [:title]'
+
+Cleanup:
+{.hidden}
+
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["title"]}
+{.hidden}
+
+You can ask for a unique index
+
+        >>
+         class Advert
+           fields do
+             title :string, :index => true, :unique => true
+           end
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up.split("\n")[1]
+        => 'add_index :adverts, [:title], :unique => true'
+
+Cleanup:
+{.hidden}
+
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["title"]}
+{.hidden}
+
+You can specify the name for the index
+
+        >>
+         class Advert
+           fields do
+             title :string, :index => 'my_index'
+           end
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up.split("\n")[1]
+        => "add_index :adverts, [:title], :name => 'my_index'"
+
+Cleanup:
+{.hidden}
+
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["title"]}
+{.hidden}
+
+You can ask for an index outside of the fields block
+
+        >>
+         class Advert
+           index :title
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up.split("\n")[1]
+        => "add_index :adverts, [:title]"
+
+Cleanup:
+{.hidden}
+
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["title"]}
+{.hidden}
+
+The available options for the index function are `:unique` and `:name`
+
+        >>
+         class Advert
+           index :title, :unique => true, :name => 'my_index'
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up.split("\n")[1]
+        => "add_index :adverts, [:title], :unique => true, :name => 'my_index'"
+
+Cleanup:
+{.hidden}
+
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["title"]}
+{.hidden}
+
+You can create an index on more than one field
+
+        >>
+         class Advert
+           index [:title, :category_id]
+         end
+        >> up, down = HoboFields::MigrationGenerator.run
+        >> up.split("\n")[1]
+        => "add_index :adverts, [:title, :category_id]"
+
+Cleanup:
+{.hidden}
 
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["title", "category_id"]}
+{.hidden}
 
 ### Rename a table
 
@@ -332,27 +490,18 @@ Set the table name back to what it should be and confirm we're in sync:
     >> HoboFields::MigrationGenerator.run
     => ["", ""]
 
-### Drop a table
-
-If you delete a model, the migration generator will create a `drop_table` migration. Unfortunately there's no way to fully remove the Advert class we've defined from the doctest session, but we can tell the migration generator to ignore it.
-
-    >> HoboFields::MigrationGenerator.ignore_models = [ :advert ]
-
-Dropping tables is where the automatic down-migration really comes in handy:
-
-    >> up, down = HoboFields::MigrationGenerator.run
-    >> up
-    => "drop_table :adverts"
-    >> down
-    =>
-     "create_table "adverts", :force => true do |t|
-       t.text   "body"
-       t.string "title", :default => "Untitled"
-     end"
-
 ### Rename a table
 
-As with renaming columns, we have to tell the migration generator about the rename. Here we create a new class 'Advertisement'. Remember 'Advert' is being ignored so it's as if we renamed the definition in our models directory.
+As with renaming columns, we have to tell the migration generator about the rename. Here we create a new class 'Advertisement', and tell ActiveRecord to forget about the Advert class. This requires code that shouldn't be shown to impressionable children.
+{.hidden}
+
+    >>
+     def nuke_model_class(klass)
+      ActiveRecord::Base.instance_eval { class_variable_get('@@subclasses')[klass.superclass].delete(klass) }
+      Object.instance_eval { remove_const klass.name.to_sym }
+     end
+    >> nuke_model_class(Advert)
+{.hidden}
 
     >>
      class Advertisement < ActiveRecord::Base
@@ -367,9 +516,24 @@ As with renaming columns, we have to tell the migration generator about the rena
     >> down
     => "rename_table :advertisements, :adverts"
 
-Now that we've seen the renaming we'll switch the 'ignore' setting to ignore that 'Advertisements' class.
+### Drop a table
+
+    >> nuke_model_class(Advertisement)
+{.hidden}
+
+If you delete a model, the migration generator will create a `drop_table` migration.
 
-    >> HoboFields::MigrationGenerator.ignore_models = [ :advertisement ]
+Dropping tables is where the automatic down-migration really comes in handy:
+
+    >> up, down = HoboFields::MigrationGenerator.run
+    >> up
+    => "drop_table :adverts"
+    >> down
+    =>
+     "create_table "adverts", :force => true do |t|
+       t.text   "body"
+       t.string "title", :default => "Untitled"
+     end"
 
 ## STI
 
@@ -378,19 +542,34 @@ Now that we've seen the renaming we'll switch the 'ignore' setting to ignore tha
 Adding a subclass or two should introduce the 'type' column and no other changes
 
         >>
+         class Advert < ActiveRecord::Base
+           fields do
+             body :text
+             title :string, :default => "Untitled"
+           end
+         end
          class FancyAdvert < Advert
          end
          class SuperFancyAdvert < FancyAdvert
          end
         >> up, down = HoboFields::MigrationGenerator.run
         >> up
-        => "add_column :adverts, :type, :string"
+        =>
+         "add_column :adverts, :type, :string
+         add_index :adverts, [:type]"
         >> down
-        => "remove_column :adverts, :type"
+        => 
+         "remove_column :adverts, :type
+         remove_index :adverts, :name => :index_adverts_on_type"
 
 Cleanup
+{.hidden}
 
         >> Advert.field_specs.delete(:type)
+        >> nuke_model_class(SuperFancyAdvert)
+        >> nuke_model_class(FancyAdvert)
+        >> Advert.index_specs.delete_if {|spec| spec.fields==["type"]}
+{.hidden}
 
 
 ## Coping with multiple changes
@@ -430,7 +609,9 @@ First let's confirm we're in a known state. One model, 'Advert', with a string '
 
 ### Rename a table and add a column
 
-    >> HoboFields::MigrationGenerator.ignore_models += [:advert, :fancy_advert, :super_fancy_advert]
+    >> nuke_model_class(Advert)
+{.hidden}
+
     >>
      class Ad < ActiveRecord::Base
        fields do
@@ -445,7 +626,15 @@ First let's confirm we're in a known state. One model, 'Advert', with a string '
      "rename_table :adverts, :ads
 
      add_column :ads, :created_at, :datetime"
+
     >>
+     class Advert < ActiveRecord::Base
+       fields do
+         body :text
+         title :string, :default => "Untitled"
+       end
+     end
+{.hidden}
 
 ## Legacy Keys
 
@@ -468,5 +657,5 @@ HoboFields has some support for legacy keys.
 Cleanup
 {.hidden}
 
-    >> system  "mysqladmin --force drop #{mysql_database} 2> /dev/null"
+    >> system  "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
 {.hidden}

data/test/migration_generator_primary_key.rdoctest

@@ -12,12 +12,17 @@ Firstly, in order to test the migration generator outside of a full Rails stack,
 
 We also need to get ActiveRecord set up with a database connection
 
+    >> mysql_adapter = defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'
+    >> mysql_user = 'root'; mysql_password = ''
+    >> mysql_login = "-u #{mysql_user} --password='#{mysql_password}'"
     >> mysql_database = "hobofields_doctest"
-    >> system "mysqladmin --force drop #{mysql_database} 2> /dev/null"
-    >> system("mysqladmin create #{mysql_database}") or raise "could not create database"
-    >> ActiveRecord::Base.establish_connection(:adapter => "mysql",
+    >> system "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
+    >> system("mysqladmin #{mysql_login} create #{mysql_database}") or raise "could not create database"
+    >> ActiveRecord::Base.establish_connection(:adapter => mysql_adapter,
                                                :database => mysql_database,
-                                               :host => "localhost")
+                                               :host => "localhost", 
+                                               :username => mysql_user, 
+                                               :password => mysql_password)
 
 Some load path manipulation you shouldn't need:
 
@@ -91,4 +96,4 @@ We'll define a method to make that easier next time
 
 ## Cleanup
 
-   >> system  "mysqladmin --force drop #{mysql_database} 2> /dev/null"
+   >> system  "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"

data/test/rich_types.rdoctest

@@ -17,12 +17,15 @@ ActiveRecord 2.3.2 doesn't work very well without a connection, even
 though we don't need it for this test:
 {.hidden}
 
+        >> mysql_adapter = defined?(JRUBY_VERSION) ? 'jdbcmysql' : 'mysql'
+        >> mysql_user = 'root'; mysql_password = ''
+        >> mysql_login = "-u #{mysql_user} --password='#{mysql_password}'"
         >> mysql_database = "hobofields_doctest"
-        >> system "mysqladmin --force drop #{mysql_database} 2> /dev/null"
-        >> system("mysqladmin create #{mysql_database}") or raise "could not create database"
+        >> system "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
+        >> system("mysqladmin #{mysql_login} create #{mysql_database}") or raise "could not create database"
         >> ActiveRecord::Base.establish_connection(:adapter => "mysql",
-                                                   :database => mysql_database,
-                                                   :host => "localhost")
+                                               :database => mysql_database,
+                                               :host => "localhost", :user => mysql_user, :password => mysql_password)
 {.hidden}
 
 Some load path manipulation you shouldn't need:
@@ -100,7 +103,7 @@ Provides validation of correct email address format.
         >> !!bad.valid?
         => false
         >> bad.validate
-        => "is not valid"
+        => "is invalid"
 
 ### `HoboFields::HtmlString`
 
@@ -234,23 +237,6 @@ Sometimes it's nice to have a proper type name. Here's one way you might go abou
 ## Cleanup
 {.hidden}
 
-        >> system "mysqladmin --force drop #{mysql_database} 2> /dev/null"
+        >> system "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
 {.hidden}
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

data/test/test_hobofield_model_generator.rb

@@ -1,6 +1,9 @@
 require 'rubygems'
 require 'rails_generator'
 
+# we get a SystemStackError on JRuby
+exit(0) if defined? JRUBY_VERSION
+
 require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
 
 class TestHobofieldModelGenerator < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hobofields
 version: !ruby/object:Gem::Version 
-  version: 0.8.10
+  version: 0.9.0
 platform: ruby
 authors: 
 - Tom Locke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 +01:00
+date: 2009-11-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.8.10
+        version: 0.9.0
     version: 
 description: 
 email: tom@tomlocke.com
@@ -54,6 +54,7 @@ files:
 - lib/hobo_fields/field_spec.rb
 - lib/hobo_fields/fields_declaration.rb
 - lib/hobo_fields/html_string.rb
+- lib/hobo_fields/index_spec.rb
 - lib/hobo_fields/markdown_string.rb
 - lib/hobo_fields/migration_generator.rb
 - lib/hobo_fields/model_extensions.rb
@@ -65,6 +66,7 @@ files:
 - lib/hobo_fields/text.rb
 - lib/hobo_fields/textile_string.rb
 - lib/hobofields.rb
+- rails_generators/hobo_migration/USAGE
 - rails_generators/hobo_migration/hobo_migration_generator.rb
 - rails_generators/hobo_migration/templates/migration.rb
 - rails_generators/hobofield_model/USAGE
@@ -104,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: hobofields
+rubyforge_project: hobo
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3