hobofields 1.0.3 → 1.1.0.pre0

data/Rakefile

@@ -3,11 +3,7 @@ require 'active_record'
 ActiveRecord::ActiveRecordError # hack for https://rails.lighthouseapp.com/projects/8994/tickets/2577-when-using-activerecordassociations-outside-of-rails-a-nameerror-is-thrown
 
 RUBY = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name']).sub(/.*\s.*/m, '"\&"')
-if defined?(Bundler)
-  RUBYDOCTEST = 'bundle exec rubydoctest'
-else
-  RUBYDOCTEST = ENV['RUBYDOCTEST'] || "#{RUBY} -S rubydoctest"
-end
+RUBYDOCTEST = ENV['RUBYDOCTEST'] || "#{RUBY} -S rubydoctest"
 
 $:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '/../hobofields/lib')
 $:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '/../hobosupport/lib')
@@ -38,7 +34,10 @@ Jeweler::Tasks.new do |gemspec|
   gemspec.homepage     = "http://hobocentral.net/"
   gemspec.authors      = ["Tom Locke"]
   gemspec.rubyforge_project = "hobo"
-  gemspec.add_dependency("rails", [">= 2.2.2", "< 3.0.0"])
+  gemspec.add_dependency("rails", [">= 2.2.2"])
   gemspec.add_dependency("hobosupport", ["= #{HoboFields::VERSION}"])    
 end
 Jeweler::GemcutterTasks.new
+Jeweler::RubyforgeTasks.new do |rubyforge|
+  rubyforge.doc_task = false
+end

data/lib/hobo_fields/enum_string.rb

@@ -82,7 +82,7 @@ module HoboFields
     COLUMN_TYPE = :string
 
     def initialize(value)
-      super(self.class.detranslated_values.nil? ? value: (self.class.detranslated_values[value.to_s] || value))
+      super(self.class.detranslated_values.nil? ? value : self.class.detranslated_values[value.to_s])
     end
 
     def validate

data/lib/hobo_fields/field_spec.rb

@@ -60,6 +60,10 @@ module HoboFields
     def default
       options[:default]
     end
+
+    def comment
+      options[:comment]
+    end
     
     def same_type?(col_spec)
       t = sql_type
@@ -74,6 +78,16 @@ module HoboFields
 
     def different_to?(col_spec)
       !same_type?(col_spec) ||
+        # we should be able to use col_spec.comment, but col_spec has
+        # a nil table_name for some strange reason.
+        begin
+          if model.table_exists?
+            col_comment = ActiveRecord::Base.try.column_comment(col_spec.name, model.table_name) 
+            col_comment != nil && col_comment != comment
+          else
+            false
+          end
+        end ||
         begin
           check_attributes = [:null, :default]
           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

data/lib/hobo_fields/migration_generator.rb

@@ -335,6 +335,7 @@ module HoboFields
           change_spec[:scale]     = spec.scale     unless spec.scale.nil?
           change_spec[:null]      = spec.null      unless spec.null && col.null
           change_spec[:default]   = spec.default   unless spec.default.nil? && col.default.nil?
+          change_spec[:comment]   = spec.comment   unless spec.comment.nil? && col.try.comment.nil?
 
           changes << "change_column :#{new_table_name}, :#{c}, " +
             ([":#{spec.sql_type}"] + format_options(change_spec, spec.sql_type, true)).join(", ")

data/lib/hobo_fields/model_extensions.rb

@@ -22,17 +22,13 @@ module HoboFields
     inheriting_cattr_reader :index_specs => []
     inheriting_cattr_reader :ignore_indexes => []
 
-    # eval avoids the ruby 1.9.2 "super from singleton method ..." error
-    # see LH#840
-    eval %(
-      def self.inherited(klass)
-        fields do |f|
-          f.field(inheritance_column, :string)
-        end
-        index(inheritance_column)
-        super
+    def self.inherited(klass)
+      fields do |f|
+        f.field(inheritance_column, :string)
       end
-    )
+      index(inheritance_column)
+      super
+    end
 
     def self.index(fields, options = {})
       # don't double-index fields
@@ -87,20 +83,22 @@ module HoboFields
     def self.belongs_to_with_field_declarations(name, options={}, &block)
       column_options = {}
       column_options[:null] = options.delete(:null) if options.has_key?(:null)
+      column_options[:comment] = options.delete(:comment) if options.has_key?(:comment)
 
       index_options = {}
       index_options[:name] = options.delete(:index) if options.has_key?(:index)
-      bt = belongs_to_without_field_declarations(name, options, &block)
-      refl = reflections[name.to_sym]
-      fkey = refl.primary_key_name
-      declare_field(fkey.to_sym, :integer, column_options)
-      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
+
+      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)
+        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
-      bt
     end
     class << self
       alias_method_chain :belongs_to, :field_declarations

data/lib/hobo_fields/serialized_object.rb

@@ -5,7 +5,7 @@ module HoboFields
     COLUMN_TYPE = :text
     
     def self.declared(model, name, options)
-      model.serialize name, options.delete(:class) || Object
+      model.serialize name, options.delete(:class)
     end
     
     HoboFields.register_type(:serialized, self)

data/lib/hobo_fields.rb

@@ -1,10 +1,6 @@
 require 'hobosupport'
 
-if ActiveSupport::Dependencies.respond_to?(:autoload_paths)
-  ActiveSupport::Dependencies.autoload_paths |= [ File.dirname(__FILE__)]
-else
-  ActiveSupport::Dependencies.load_paths |= [ File.dirname(__FILE__)]
-end
+ActiveSupport::Dependencies.load_paths |= [ File.dirname(__FILE__) ]
 
 module Hobo
   # Empty class to represent the boolean type.
@@ -13,7 +9,7 @@ end
 
 module HoboFields
 
-  VERSION = "1.0.3"
+  VERSION = "1.1.0.pre0"
 
   extend self
 
@@ -68,27 +64,12 @@ module HoboFields
   end
 
 
-  if Object.instance_method(:initialize).arity!=0
-    # version for Ruby 1.9.
-    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
-      init_method = type.instance_method(:initialize)
-      [-1,1].include?(init_method.arity) &&
-        init_method.owner != Object.instance_method(:initialize).owner &&
-        !@never_wrap_types.any? { |c| klass <= c }
-    end
-  else
-    # Ruby 1.8.  1.8.6 doesn't include Method#owner.   1.8.7 could use
-    # the 1.9 function, but this one is faster.
-    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
-      init_method = type.instance_method(:initialize)
-      [-1,1].include?(init_method.arity) && !@never_wrap_types.any? { |c| klass <= c }
-    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 }
   end
 
 
@@ -124,11 +105,7 @@ module HoboFields
     if defined?(::Rails)
       plugins = Rails.configuration.plugin_loader.new(HoboFields.rails_initializer).plugins
       ([::Rails.root] + plugins.map(&:directory)).each do |dir|
-        if ActiveSupport::Dependencies.respond_to?(:autoload_paths)
-          ActiveSupport::Dependencies.autoload_paths << File.join(dir, 'app', 'rich_types')
-        else
-          ActiveSupport::Dependencies.load_paths << File.join(dir, 'app', 'rich_types')
-        end
+        ActiveSupport::Dependencies.load_paths << File.join(dir, 'app', 'rich_types')
         Dir[File.join(dir, 'app', 'rich_types', '*.rb')].each do |f|
           # TODO: should we complain if field_types doesn't get a new value? Might be useful to warn people if they're missing a register_type
           require_dependency f

data/test/hobofields_api.rdoctest

@@ -169,7 +169,7 @@ In your HoboFields models you can also give type information to "virtual fields"
 
 ## Field validations
 
-HoboFields gives you some shorthands for declaring some common validations right in the field declaration.  HoboFields also supports all of the options supported by the [Rails column declaration](http://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/TableDefinition.html#method-i-column)
+HoboFields gives you some shorthands for declaring some common validations right in the field declaration
 
 ### Required fields
 

data/test/migration_generator.rdoctest

@@ -105,7 +105,6 @@ We'll define a method to make that easier next time
     >>
      def migrate(renames={})
        up, down = HoboFields::MigrationGenerator.run(renames)
-       puts up
        ActiveRecord::Migration.class_eval(up)
        ActiveRecord::Base.send(:subclasses).each { |model| model.reset_column_information }
        [up, down]
@@ -666,8 +665,70 @@ HoboFields has some support for legacy keys.
     =>
      "rename_column :adverts, :id, :advert_id
 
+    >> nuke_model_class(Advert)
+    >> nuke_model_class(Ad)
+    >> ActiveRecord::Base.connection.execute "drop table `adverts`;"
+{.hidden}
+
+
+## Comments
+
+Comments can be added to tables and fields with HoboFields.
+
+    >>
+     class Product < ActiveRecord::Base
+       fields do
+         name :string, :comment => "short name"
+         description :string
+       end
+     end
+    >> up, down = HoboFields::MigrationGenerator.run
+    >> up
+    => 
+     'create_table :products do |t|
+       t.string :name, :comment => "short name"
+       t.string :description
+     end'
+    >> migrate
+
+These comments will be saved to your schema if you have the [column_comments](http://github.com/bryanlarsen/column_comments) plugin installed.  If you do not have this plugin installed, the comments will be available by querying `field_specs`:
+
+    >> Product.field_specs["name"].comment
+    => "short name"
+
+The plugin [activerecord-comments](http://github.com/bryanlarsen/activerecord-comments) may be used to get the comments from the database directly.  If the plugin is installed, use this instead:
+
+    Product.column("name").comment
+
+Because it will be quite common for people not to have both [column_comments](http://github.com/bryanlarsen/column_comments) and [activerecord-comments](http://github.com/bryanlarsen/activerecord-comments) installed, it is impossible for HoboFields to determine the difference between no previous comment and a previously missing plugin.   Therefore, HoboFields will not generate a migration if the only change was to add a comment.  HoboFields will generate a migration for a comment change, but only if the plugin is installed.
+
+    >> require 'activerecord-comments'
+
+    >> # manually add comment as the column_comments plugin would
+    >> Product.connection.execute "alter table `products` modify `name` varchar(255) default null comment 'short name';"
+
+    >>
+     class Product < ActiveRecord::Base
+       fields do
+         name :string, :comment => "Short namex"
+         description :string, :comment => "Long name"
+       end
+     end
+    >> up, down = HoboFields::MigrationGenerator.run
+    >> up
+    => "change_column :products, :name, :string, :limit => 255, :comment => \"Short namex\""
+
+
 Cleanup
+{.hidden}
+
+    >> nuke_model_class(Product)
+    >> ActiveRecord::Base.connection.execute "drop table `products`;"
+{.hidden}
+
+Final Cleanup
 {.hidden}
 
     >> system  "mysqladmin #{mysql_login} --force drop #{mysql_database} 2> /dev/null"
 {.hidden}
+

data/test/migration_generator_primary_key.rdoctest

@@ -42,7 +42,6 @@ We'll define a method to make that easier next time
     >>
      def migrate(renames={})
        up, down = HoboFields::MigrationGenerator.run(renames)
-       puts up
        ActiveRecord::Migration.class_eval(up)
        ActiveRecord::Base.send(:subclasses).each { |model| model.reset_column_information }
        [up, down]

data/test/rich_types.rdoctest

@@ -23,9 +23,9 @@ though we don't need it for this test:
         >> mysql_database = "hobofields_doctest"
         >> 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,
+        >> ActiveRecord::Base.establish_connection(:adapter => "mysql",
                                                :database => mysql_database,
-                                               :host => "localhost", :username => mysql_user, :password => mysql_password)
+                                               :host => "localhost", :user => mysql_user, :password => mysql_password)
 {.hidden}
 
 Some load path manipulation you shouldn't need:
@@ -165,52 +165,8 @@ Provides validation of correct email address format.
 
 ### `HoboFields::PasswordString`
 
-`HoboFields::PasswordString` provides a simple `to_html` to prevent
-accidental display of a password. It simply returns "`[password
-hidden]`". The type is also used to indicate the need for an `<input
-type='password'>`
+`HoboFields::PasswordString` provides a simple `to_html` to prevent accidental display of a password. It simply returns "`[password hidden]`". The type is also used to indicate the need for an `<input type='password'>`
 
-### `HoboFields::Serialized`
-
-This type lets you store an arbitrary object as serialized text into
-the database column.   You can optionally pass the :class option to
-restrict the column type.
-
-    >>
-     def migrate(renames={})
-       up, down = HoboFields::MigrationGenerator.run(renames)
-       ActiveRecord::Migration.class_eval(up)
-       ActiveRecord::Base.send(:subclasses).each { |model| model.reset_column_information }
-       [up, down]
-     end
-{.hidden}
-
-    >>
-     class Vault1 < ActiveRecord::Base
-       fields do
-         content :serialized
-       end
-     end
-
-    >> migrate
-    >> Vault1.create!(:content => {:key => "in Vault"})
-    >> Vault1.first.content
-    => {:key => "in Vault"}
-
-    >>
-     class Vault2 < ActiveRecord::Base
-       fields do
-         content :serialized, :class => Hash
-       end
-     end
-
-    >> migrate
-    >> Vault2.create!(:content => {:key => "in Vault"})
-    >> Vault2.first.content
-    => {:key => "in Vault"}
-    >> Vault2.create!(:content => 17) rescue ActiveRecord::SerializationTypeMismatch
-    >> Vault2.all.size
-    => 1   # second record not created because of type mismatch
 
 ## Enum Strings
 

data/test/test_hobofield_model_generator.rb

@@ -4,7 +4,7 @@ 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')}"
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
 
 class TestHobofieldModelGenerator < Test::Unit::TestCase
   include RubiGen::GeneratorTestHelper

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: hobofields
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
+  hash: -1876988165
+  prerelease: true
   segments: 
   - 1
+  - 1
   - 0
-  - 3
-  version: 1.0.3
+  - pre0
+  version: 1.1.0.pre0
 platform: ruby
 authors: 
 - Tom Locke
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-25 00:00:00 -05:00
+date: 2010-11-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,14 +33,6 @@ dependencies:
         - 2
         - 2
         version: 2.2.2
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -50,12 +43,13 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: -1876988165
         segments: 
         - 1
+        - 1
         - 0
-        - 3
-        version: 1.0.3
+        - pre0
+        version: 1.1.0.pre0
   type: :runtime
   version_requirements: *id002
 description: 
@@ -71,7 +65,6 @@ files:
 - LICENSE.txt
 - README.txt
 - Rakefile
-- hobofields.gemspec
 - lib/hobo_fields.rb
 - lib/hobo_fields/email_address.rb
 - lib/hobo_fields/enum_string.rb
@@ -115,8 +108,8 @@ homepage: http://hobocentral.net/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -131,16 +124,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: hobo
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rich field types and migration generator for Rails

data/hobofields.gemspec

@@ -1,80 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{hobofields}
-  s.version = "1.0.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tom Locke"]
-  s.date = %q{2011-02-25}
-  s.email = %q{tom@tomlocke.com}
-  s.files = [
-    "CHANGES.txt",
-    "LICENSE.txt",
-    "README.txt",
-    "Rakefile",
-    "hobofields.gemspec",
-    "lib/hobo_fields.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/index_spec.rb",
-    "lib/hobo_fields/lifecycle_state.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/hobofields.rb",
-    "rails/init.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",
-    "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",
-    "script/destroy",
-    "script/generate",
-    "test/hobofields.rdoctest",
-    "test/hobofields_api.rdoctest",
-    "test/migration_generator.rdoctest",
-    "test/migration_generator_primary_key.rdoctest",
-    "test/rich_types.rdoctest",
-    "test/test_generator_helper.rb",
-    "test/test_hobofield_model_generator.rb"
-  ]
-  s.homepage = %q{http://hobocentral.net/}
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{hobo}
-  s.rubygems_version = %q{1.4.2}
-  s.summary = %q{Rich field types and migration generator for Rails}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 2.2.2", "< 3.0.0"])
-      s.add_runtime_dependency(%q<hobosupport>, ["= 1.0.3"])
-    else
-      s.add_dependency(%q<rails>, [">= 2.2.2", "< 3.0.0"])
-      s.add_dependency(%q<hobosupport>, ["= 1.0.3"])
-    end
-  else
-    s.add_dependency(%q<rails>, [">= 2.2.2", "< 3.0.0"])
-    s.add_dependency(%q<hobosupport>, ["= 1.0.3"])
-  end
-end
-