hobofields 0.8.5 → 0.8.6

data/Rakefile

@@ -1,5 +1,19 @@
 require 'echoe'
 
+namespace "test" do
+  desc "Run the doctests"
+  task :doctest do |t|
+    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}")
+    end
+  end
+end
+
 Echoe.new('hobofields') do |p|
   p.author  = "Tom Locke"
   p.email   = "tom@tomlocke.com"
@@ -8,8 +22,9 @@ Echoe.new('hobofields') do |p|
   p.project = "hobo"
 
   p.changelog = "CHANGES.txt"
-  p.version   = "0.8.5"
+  p.version   = "0.8.6"
 
-  p.dependencies = ['hobosupport =0.8.5', 'rails >=2.2.2']
+  p.dependencies = ['hobosupport =0.8.6', 'rails >=2.2.2']
   p.development_dependencies = []
 end
+

data/hobofields.gemspec

@@ -1,138 +1,38 @@
+# -*- encoding: utf-8 -*-
 
-# Gem::Specification for Hobofields-0.8.5
-# Originally generated by Echoe
+Gem::Specification.new do |s|
+  s.name = %q{hobofields}
+  s.version = "0.8.6"
 
---- !ruby/object:Gem::Specification 
-name: hobofields
-version: !ruby/object:Gem::Version 
-  version: 0.8.5
-platform: ruby
-authors: 
-- Tom Locke
-autorequire: 
-bindir: bin
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Locke"]
+  s.date = %q{2009-05-14}
+  s.description = %q{Rich field types and migration generator for Rails}
+  s.email = %q{tom@tomlocke.com}
+  s.extra_rdoc_files = ["lib/hobo_fields/email_address.rb", "lib/hobo_fields/enum_string.rb", "lib/hobo_fields/field_declaration_dsl.rb", "lib/hobo_fields/field_spec.rb", "lib/hobo_fields/fields_declaration.rb", "lib/hobo_fields/html_string.rb", "lib/hobo_fields/markdown_string.rb", "lib/hobo_fields/migration_generator.rb", "lib/hobo_fields/model_extensions.rb", "lib/hobo_fields/password_string.rb", "lib/hobo_fields/raw_html_string.rb", "lib/hobo_fields/raw_markdown_string.rb", "lib/hobo_fields/sanitize_html.rb", "lib/hobo_fields/serialized_object.rb", "lib/hobo_fields/text.rb", "lib/hobo_fields/textile_string.rb", "lib/hobo_fields.rb", "lib/hobofields.rb", "LICENSE.txt", "README.txt"]
+  s.files = ["CHANGES.txt", "init.rb", "lib/hobo_fields/email_address.rb", "lib/hobo_fields/enum_string.rb", "lib/hobo_fields/field_declaration_dsl.rb", "lib/hobo_fields/field_spec.rb", "lib/hobo_fields/fields_declaration.rb", "lib/hobo_fields/html_string.rb", "lib/hobo_fields/markdown_string.rb", "lib/hobo_fields/migration_generator.rb", "lib/hobo_fields/model_extensions.rb", "lib/hobo_fields/password_string.rb", "lib/hobo_fields/raw_html_string.rb", "lib/hobo_fields/raw_markdown_string.rb", "lib/hobo_fields/sanitize_html.rb", "lib/hobo_fields/serialized_object.rb", "lib/hobo_fields/text.rb", "lib/hobo_fields/textile_string.rb", "lib/hobo_fields.rb", "lib/hobofields.rb", "LICENSE.txt", "Manifest", "rails_generators/hobo_migration/hobo_migration_generator.rb", "rails_generators/hobo_migration/templates/migration.rb", "rails_generators/hobofield_model/hobofield_model_generator.rb", "rails_generators/hobofield_model/templates/fixtures.yml.erb", "rails_generators/hobofield_model/templates/model.rb.erb", "rails_generators/hobofield_model/templates/test.rb.erb", "rails_generators/hobofield_model/USAGE", "Rakefile", "README.txt", "script/destroy", "script/generate", "test/hobofields.rdoctest", "test/hobofields_api.rdoctest", "test/migration_generator.rdoctest", "test/rich_types.rdoctest", "test/test_generator_helper.rb", "test/test_hobofield_model_generator.rb", "hobofields.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://hobocentral.net/hobofields}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Hobofields", "--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{hobo}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Rich field types and migration generator for Rails}
+  s.test_files = ["test/test_generator_helper.rb", "test/test_hobofield_model_generator.rb"]
 
-date: 2008-12-09 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hobosupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 0.8.5
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rails
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.2.2
-    version: 
-description: Rich field types and migration generator for Rails
-email: tom@tomlocke.com
-executables: []
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
 
-extensions: []
-
-extra_rdoc_files: 
-- lib/hobo_fields/email_address.rb
-- lib/hobo_fields/enum_string.rb
-- lib/hobo_fields/field_declaration_dsl.rb
-- lib/hobo_fields/field_spec.rb
-- lib/hobo_fields/fields_declaration.rb
-- lib/hobo_fields/html_string.rb
-- lib/hobo_fields/markdown_string.rb
-- lib/hobo_fields/migration_generator.rb
-- lib/hobo_fields/model_extensions.rb
-- lib/hobo_fields/password_string.rb
-- lib/hobo_fields/raw_html_string.rb
-- lib/hobo_fields/raw_markdown_string.rb
-- lib/hobo_fields/sanitize_html.rb
-- lib/hobo_fields/serialized_object.rb
-- lib/hobo_fields/text.rb
-- lib/hobo_fields/textile_string.rb
-- lib/hobo_fields.rb
-- lib/hobofields.rb
-- LICENSE.txt
-- README.txt
-files: 
-- CHANGES.txt
-- init.rb
-- lib/hobo_fields/email_address.rb
-- lib/hobo_fields/enum_string.rb
-- lib/hobo_fields/field_declaration_dsl.rb
-- lib/hobo_fields/field_spec.rb
-- lib/hobo_fields/fields_declaration.rb
-- lib/hobo_fields/html_string.rb
-- lib/hobo_fields/markdown_string.rb
-- lib/hobo_fields/migration_generator.rb
-- lib/hobo_fields/model_extensions.rb
-- lib/hobo_fields/password_string.rb
-- lib/hobo_fields/raw_html_string.rb
-- lib/hobo_fields/raw_markdown_string.rb
-- lib/hobo_fields/sanitize_html.rb
-- lib/hobo_fields/serialized_object.rb
-- lib/hobo_fields/text.rb
-- lib/hobo_fields/textile_string.rb
-- lib/hobo_fields.rb
-- lib/hobofields.rb
-- LICENSE.txt
-- Manifest
-- rails_generators/hobo_migration/hobo_migration_generator.rb
-- rails_generators/hobo_migration/templates/migration.rb
-- rails_generators/hobofield_model/hobofield_model_generator.rb
-- rails_generators/hobofield_model/templates/fixtures.yml.erb
-- rails_generators/hobofield_model/templates/model.rb.erb
-- rails_generators/hobofield_model/templates/test.rb.erb
-- rails_generators/hobofield_model/USAGE
-- Rakefile
-- README.txt
-- script/destroy
-- script/generate
-- test/hobofields.rdoctest
-- test/hobofields_api.rdoctest
-- test/migration_generator.rdoctest
-- test/rich_types.rdoctest
-- test/test_generator_helper.rb
-- test/test_hobofield_model_generator.rb
-- hobofields.gemspec
-has_rdoc: true
-homepage: http://hobocentral.net/hobofields
-post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Hobofields
-- --main
-- README.txt
-require_paths: 
-- lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.2"
-  version: 
-requirements: []
-
-rubyforge_project: hobo
-rubygems_version: 1.3.1
-specification_version: 2
-summary: Rich field types and migration generator for Rails
-test_files: 
-- test/test_generator_helper.rb
-- test/test_hobofield_model_generator.rb
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hobosupport>, ["= 0.8.6"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.2.2"])
+    else
+      s.add_dependency(%q<hobosupport>, ["= 0.8.6"])
+      s.add_dependency(%q<rails>, [">= 2.2.2"])
+    end
+  else
+    s.add_dependency(%q<hobosupport>, ["= 0.8.6"])
+    s.add_dependency(%q<rails>, [">= 2.2.2"])
+  end
+end

data/lib/hobo_fields/email_address.rb

@@ -13,7 +13,7 @@ module HoboFields
     end
 
     def to_html(xmldoctype = true)
-      self
+      self.sub('@', " at ").gsub('.', ' dot ')
     end
 
     HoboFields.register_type(:email_address, self)

data/lib/hobo_fields/field_spec.rb

@@ -14,6 +14,8 @@ module HoboFields
     end
 
     attr_accessor :model, :name, :type, :position, :options
+    
+    TYPE_SYNONYMS = [[:timestamp, :datetime]]
 
     def sql_type
       options[:sql_type] or begin
@@ -45,9 +47,20 @@ module HoboFields
     def default
       options[:default]
     end
+    
+    def same_type?(col_spec)
+      t = sql_type
+      TYPE_SYNONYMS.each do |synonyms|
+        if t.in? synonyms
+          return col_spec.type.in?(synonyms)
+        end
+      end
+      t = col_spec.type
+    end
+      
 
     def different_to?(col_spec)
-      sql_type != col_spec.type ||
+      !same_type?(col_spec) ||
         begin
           check_attributes = [:null, :default]
           check_attributes += [:precision, :scale] if sql_type == :decimal

data/lib/hobo_fields/migration_generator.rb

@@ -17,18 +17,14 @@ module HoboFields
       g.generate
     end
 
-    def initialize(*args)
-      options = args.extract_options!
-      @ambiguity_resolver = args.first
+    def initialize(ambiguity_resolver={})
+      @ambiguity_resolver = ambiguity_resolver
       @drops = []
       @renames = nil
-      @force_drop = options[:force_drop]
     end
 
     attr_accessor :renames
     
-    def force_drop?; @force_drop end
-
 
     def load_rails_models
       if defined? RAILS_ROOT
@@ -80,11 +76,7 @@ module HoboFields
     # return a hash of table renames and modifies the passed arrays so
     # that renamed tables are no longer listed as to_create or to_drop
     def extract_table_renames!(to_create, to_drop)
-      if force_drop?
-        # no renames at all
-        {}
-        
-      elsif renames
+      if renames
         # A hash of table renames has been provided
 
         to_rename = {}
@@ -110,11 +102,7 @@ module HoboFields
 
 
     def extract_column_renames!(to_add, to_remove, table_name)
-      if force_drop?
-        # no renames at all
-        {}
-        
-      elsif renames
+      if renames
         to_rename = {}
         column_renames = renames._?[table_name.to_sym]
         if column_renames
@@ -150,8 +138,17 @@ module HoboFields
 
     def generate
       models, db_tables = models_and_tables
-      models_by_table_name = models.index_by {|m| m.table_name}
-      model_table_names = models.*.table_name
+      models_by_table_name = {}
+      models.each do |m|
+        if !models_by_table_name.has_key?(m.table_name)
+          models_by_table_name[m.table_name] = m
+        elsif m.superclass==models_by_table_name[m.table_name].superclass.superclass
+          # we need to ensure that models_by_table_name contains the
+          # base class in an STI hierarchy
+          models_by_table_name[m.table_name] = m
+        end
+      end
+      model_table_names = models_by_table_name.keys
 
       to_create = model_table_names - db_tables
       to_drop = db_tables - model_table_names - always_ignore_tables
@@ -200,7 +197,8 @@ module HoboFields
 
     def create_table(model)
       longest_field_name = model.field_specs.values.map { |f| f.sql_type.to_s.length }.max
-      (["create_table :#{model.table_name} do |t|"] +
+      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
@@ -213,15 +211,19 @@ module HoboFields
     def change_table(model, current_table_name)
       new_table_name = model.table_name
 
-      db_columns = model.connection.columns(current_table_name).index_by{|c|c.name} - [model.primary_key]
+      db_columns = model.connection.columns(current_table_name).index_by{|c|c.name}
+      key_missing = db_columns[model.primary_key].nil?
+      db_columns -= [model.primary_key]
+      
       model_column_names = model.field_specs.keys.*.to_s
       db_column_names = db_columns.keys.*.to_s
 
       to_add = model_column_names - db_column_names
+      to_add += [model.primary_key] if key_missing
       to_remove = db_column_names - model_column_names - [model.primary_key.to_sym]
 
       to_rename = extract_column_renames!(to_add, to_remove, new_table_name)
-
+      
       db_column_names -= to_rename.keys
       db_column_names |= to_rename.values
       to_change = db_column_names & model_column_names

data/lib/hobo_fields/model_extensions.rb

@@ -15,7 +15,6 @@ module HoboFields
     # and speeds things up a little.
     inheriting_cattr_reader :field_specs => HashWithIndifferentAccess.new
 
-
     def self.inherited(klass)
       fields do |f|
         f.field(inheritance_column, :string)
@@ -109,16 +108,16 @@ module HoboFields
     def self.declare_field(name, type, *args)
       options = args.extract_options!
       try.field_added(name, type, args, options)
-      add_validations_for_field(name, type, args, options)
+      add_validations_for_field(name, type, args)
       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)
     end
 
 
-    # Add field validations according to arguments and options in the
+    # Add field validations according to arguments in the
     # field declaration
-    def self.add_validations_for_field(name, type, args, options)
+    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)
 

data/lib/hobo_fields.rb

@@ -9,7 +9,7 @@ end
 
 module HoboFields
 
-  VERSION = "0.8.5"
+  VERSION = "0.8.6"
 
   extend self
 
@@ -18,13 +18,17 @@ module HoboFields
     :date          => Date,
     :datetime      => (defined?(ActiveSupport::TimeWithZone) ? ActiveSupport::TimeWithZone : Time),
     :time          => Time,
-    :integer       => Fixnum,
-    :big_integer   => BigDecimal,
+    :integer       => Integer,
     :decimal       => BigDecimal,
     :float         => Float,
     :string        => String
   }
 
+  ALIAS_TYPES = {
+    Fixnum => "integer",
+    Bignum => "integer"
+  }
+
   # Provide a lookup for these rather than loading them all preemptively
   
   STANDARD_TYPES = {
@@ -44,7 +48,7 @@ module HoboFields
   attr_reader :field_types
 
   def to_class(type)
-    if type.is_a?(Symbol, String)
+    if type.is_one_of?(Symbol, String)
       type = type.to_sym
       field_types[type] || standard_class(type)
     else
@@ -54,11 +58,13 @@ module HoboFields
 
 
   def to_name(type)
-    field_types.index(type)
+    field_types.index(type) || ALIAS_TYPES[type]
   end
 
 
   def can_wrap?(type, val)
+    col_type = type::COLUMN_TYPE
+    return false if val.blank? && (col_type == :integer || col_type == :float || col_type == :decimal)
     klass = Object.instance_method(:class).bind(val).call # Make sure we get the *real* class
     arity = type.instance_method(:initialize).arity
     (arity == 1 || arity == -1) && !@never_wrap_types.any? { |c| klass <= c }

data/rails_generators/hobo_migration/hobo_migration_generator.rb

@@ -1,8 +1,6 @@
 require File.dirname(__FILE__) + '/../../lib/hobofields'
 class HoboMigrationGenerator < Rails::Generator::Base
 
-  default_options :force_drop => false
-
   def initialize(runtime_args, runtime_options = {})
     super
     @migration_name = runtime_args.first || begin
@@ -29,7 +27,7 @@ class HoboMigrationGenerator < Rails::Generator::Base
   def manifest
     return record {|m| } if migrations_pending?
 
-    generator = HoboFields::MigrationGenerator.new(self, :force_drop => options[:force_drop])
+    generator = HoboFields::MigrationGenerator.new(self)
     up, down = generator.generate
 
     if up.blank?
@@ -40,14 +38,14 @@ class HoboMigrationGenerator < Rails::Generator::Base
     puts "\n---------- Up Migration ----------", up, "----------------------------------"
     puts "\n---------- Down Migration --------", down, "----------------------------------"
 
-    action = input("What now: [g]enerate migration, generate and [m]igrate now or [c]ancel?", /^(g|m|c)$/)
+    action = options[:action] || input("What now: [g]enerate migration, generate and [m]igrate now or [c]ancel?", /^(g|m|c)$/)
 
     if action == 'c'
       # record nothing to keep the generator happy
       record {|m| }
     else
       puts "\nMigration filename:", "(you can type spaces instead of '_' -- every little helps)"
-      migration_name = input("Filename [#@migration_name]:", /^[a-z0-9_ ]*$/).strip.gsub(' ', '_')
+      migration_name = input("Filename [#@migration_name]:", /^[a-z0-9_ ]*$/).strip.gsub(' ', '_') unless options[:default_name]
       migration_name = @migration_name if migration_name.blank?
 
       at_exit { rake_migrate } if action == 'm'
@@ -68,6 +66,8 @@ class HoboMigrationGenerator < Rails::Generator::Base
 
 
   def extract_renames!(to_create, to_drop, kind_str, name_prefix="")
+    return {} if options[:force_drop]
+    
     to_rename = {}
     rename_to_choices = to_create
     to_drop.dup.each do |t|
@@ -122,16 +122,17 @@ class HoboMigrationGenerator < Rails::Generator::Base
   
   protected
     def banner
-      "Usage: #{$0} #{spec.name} [<migration-name>] [--force-drop]"
+      "Usage: #{$0} #{spec.name} [<migration-name>]"
     end
 
     def add_options!(opt)
       opt.separator ''
       opt.separator 'Options:'
-      opt.on("--force-drop",
-             "Don't prompt to disambiguate drops from renames - drop everything") do |v|
-        options[:force_drop] = true
-      end
+      
+      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' }
     end
   
 

data/test/hobofields.rdoctest

@@ -14,7 +14,7 @@ It still has all the benefits of writing your own migrations, for example if you
 
 First off, if you're using the migration generator outside of Hobo, do remember the `--skip-migration` option when generating your models:
 
-	$ ./script/generate model blog_post --skip-migration
+        $ ./script/generate model blog_post --skip-migration
 
 Now edit your model as follows:
 
@@ -30,22 +30,22 @@ Now edit your model as follows:
 
 Then, simply run
 
-	$ ./script/genearte hobo_migration
+        $ ./script/genearte hobo_migration
 
 And voila
 
-	---------- Up Migration ----------
-	create_table :blog_posts do |t|
-	  t.string   :title
-	  t.text     :body
-	  t.datetime :created_at
-	  t.datetime :updated_at
-	end
-	----------------------------------
-
-	---------- Down Migration --------
-	drop_table :blog_posts
-	----------------------------------
+        ---------- Up Migration ----------
+        create_table :blog_posts do |t|
+          t.string   :title
+          t.text     :body
+          t.datetime :created_at
+          t.datetime :updated_at
+        end
+        ----------------------------------
+
+        ---------- Down Migration --------
+        drop_table :blog_posts
+        ----------------------------------
 {: .ruby}
 
 The migration generator has created a migration to change from the schema that is currently in your database, to the schema that your models need. That's really all there is to it. You are now free to simply hack away on your app and run the migration generator every time the database needs to play catch-up.
@@ -54,9 +54,9 @@ Note that the migration generator is interactive -- it can't tell the difference
 
 ## Installing
 
-The simplest and recommended way to install HoboFeilds is as a gem:
+The simplest and recommended way to install HoboFields is as a gem:
 
-	$ gem install hobofields
+        $ gem install hobofields
 
 The source lives on GitHub as part of the main Hobo repo:
 
@@ -64,7 +64,7 @@ The source lives on GitHub as part of the main Hobo repo:
 
 The simplest way to install HoboFields as a plugin is to use the subversion mirror:
 
-	svn export svn://hobocentral.net/hobo/tags/rel_0.7.5/hobofields vendor/plugins
+        svn export svn://hobocentral.net/hobo/tags/rel_0.7.5/hobofields vendor/plugins
 
 ## Rich Types
 
@@ -72,19 +72,19 @@ In addition to the migration generator, HoboFields provides a Rich-Type mechanis
 
 Read more:
 
- - [HoboFields Rich Types](/hobofields/rich_types)
+ - [HoboFields Rich Types](/manual/hobofields/rich_types)
 
 ## API
 
 HoboFields provides various API methods. Read more:
 
- - [HoboFields API](/hobofields/hobofields_api)
+ - [HoboFields API](/manual/hobofields/hobofields_api)
 
 ## Migration Generator Details
 
 The migration generator doctests provide a lot more detail. They're not really that great as documentation because doctests run in a single irb session, and that doesn't fit well with the concept of a generator. Skip these unless you're really keen to see the details of the migration generator in action
 
- - [Migration Generator Details](/hobofields/migration_generator)
+ - [Migration Generator Details](/manual/hobofields/migration_generator)
 
 ## About Doctests
 
@@ -92,3 +92,5 @@ HoboFields is documented and tested using *doctests*. This is an idea that comes
 
 Doctests are a great way to get both documentation and tests from the same source. We're still experimenting with exactly how this all works though, so if the docs seem strange in places, please bear with us!
 
+You may download rubydoctest via [github](http://www.github.com/tablatom/rubydoctest)
+