hobofields 0.7.5 → 0.8

data/lib/hobo_fields.rb

@@ -1,6 +1,6 @@
 require 'hobosupport'
 
-Dependencies.load_paths |= [ File.dirname(__FILE__) ] if defined?(Dependencies)
+Dependencies.load_paths |= [ File.dirname(__FILE__) ]
 
 module Hobo
   # Empty class to represent the boolean type.
@@ -8,21 +8,22 @@ module Hobo
 end
 
 module HoboFields
-  
-  VERSION = "0.7.5"
-  
+
+  VERSION = "0.8"
+
   extend self
-  
-  PLAIN_TYPES = { 
+
+  PLAIN_TYPES = {
     :boolean       => Hobo::Boolean,
     :date          => Date,
-    :datetime      => Time,
+    :datetime      => (defined?(ActiveSupport::TimeWithZone) ? ActiveSupport::TimeWithZone : Time),
     :integer       => Fixnum,
     :big_integer   => BigDecimal,
+    :decimal       => BigDecimal,
     :float         => Float,
     :string        => String
   }
-  
+
   # Provide a lookup for these rather than loading them all preemptively
   STANDARD_TYPES = {
     :html          => "HtmlString",
@@ -32,12 +33,12 @@ module HoboFields
     :text          => "Text",
     :email_address => "EmailAddress"
   }
-  
+
   @field_types   = HashWithIndifferentAccess.new(PLAIN_TYPES)
   @never_wrap_types = Set.new([NilClass, Hobo::Boolean, TrueClass, FalseClass])
 
   attr_reader :field_types
-  
+
   def to_class(type)
     if type.is_a?(Symbol, String)
       type = type.to_sym
@@ -46,51 +47,51 @@ module HoboFields
       type # assume it's already a class
     end
   end
-  
-  
+
+
   def to_name(type)
     field_types.index(type)
   end
 
-  
+
   def can_wrap?(val)
     # Make sure we get the *real* class
     klass = Object.instance_method(:class).bind(val).call
     !@never_wrap_types.any? { |c| klass <= c }
   end
-  
-  
+
+
   def never_wrap(type)
     @never_wrap_types << type
   end
-  
-  
+
+
   def register_type(name, klass)
     field_types[name] = klass
   end
-  
-  
+
+
   def plain_type?(type_name)
     type_name.in?(PLAIN_TYPES)
   end
-  
-  
+
+
   def standard_class(name)
     class_name = STANDARD_TYPES[name]
     "HoboFields::#{class_name}".constantize if class_name
   end
-  
+
   def enable
     require "hobo_fields/enum_string"
     require "hobo_fields/fields_declaration"
 
     # Add the fields do declaration to ActiveRecord::Base
     ActiveRecord::Base.send(:include, HoboFields::FieldsDeclaration)
-    
+
     # Monkey patch ActiveRecord so that the attribute read & write methods
     # automatically wrap richly-typed fields.
-    ActiveRecord::AttributeMethods::ClassMethods.class_eval do 
-      
+    ActiveRecord::AttributeMethods::ClassMethods.class_eval do
+
       # Define an attribute reader method.  Cope with nil column.
       def define_read_method(symbol, attr_name, column)
         cast_code = column.type_cast_code('v') if column
@@ -110,11 +111,11 @@ module HoboFields
               else
                 access_code
               end
-        
-        evaluate_attribute_method(attr_name, 
+
+        evaluate_attribute_method(attr_name,
                                   "def #{symbol}; @attributes_cache['#{attr_name}'] ||= begin; #{src}; end; end")
       end
-      
+
       def define_write_method(attr_name)
         src = if connected? && (type_wrapper = try.attr_type(attr_name)) &&
                   type_wrapper.is_a?(Class) && type_wrapper.not_in?(HoboFields::PLAIN_TYPES.values)
@@ -125,14 +126,14 @@ module HoboFields
               end
         evaluate_attribute_method(attr_name,
                                   "def #{attr_name}=(val); write_attribute('#{attr_name}', #{src});end", "#{attr_name}=")
-        
+
       end
 
     end
-    
-    
+
+
   end
-  
+
 end
 
 

data/{generators → rails_generators}/hobo_migration/hobo_migration_generator.rb

@@ -1,3 +1,4 @@
+require File.dirname(__FILE__) + '/../../lib/hobofields'
 class HoboMigrationGenerator < Rails::Generator::Base
 
   def initialize(runtime_args, runtime_options = {})
@@ -7,46 +8,63 @@ class HoboMigrationGenerator < Rails::Generator::Base
                                               "hobo_migration_#{i+1}"
                                             end
   end
-  
+
+  def migrations_pending?
+    pending_migrations = ActiveRecord::Migrator.new(:up, 'db/migrate').pending_migrations
+
+    if pending_migrations.any?
+      puts "You have #{pending_migrations.size} pending migration#{'s' if pending_migrations.size > 1}:"
+      pending_migrations.each do |pending_migration|
+        puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+      end
+      true
+    else
+      false
+    end
+  end
+
+
   def manifest
+    return record {|m| } if migrations_pending?
+
     generator = HoboFields::MigrationGenerator.new(self)
     up, down = generator.generate
 
     if up.blank?
       puts "Database and models match -- nothing to change"
-      return record {|m| } 
+      return record {|m| }
     end
-      
+
     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?", %w(g m c))
+
+    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]:").strip.gsub(' ', '_')
+      migration_name = input("Filename [#@migration_name]:", /^[a-z0-9_ ]/).strip.gsub(' ', '_')
       migration_name = @migration_name if migration_name.blank?
-      
-      at_exit { system "rake db:migrate" } if action == 'm'
-      
+
+      at_exit { rake_migrate } if action == 'm'
+
       up.gsub!("\n", "\n    ")
       down.gsub!("\n", "\n    ")
 
       record do |m|
-        m.migration_template 'migration.rb', 'db/migrate', 
-                             :assigns => { :up => up, :down => down, :migration_name => migration_name.camelize }, 
+        m.migration_template 'migration.rb', 'db/migrate',
+                             :assigns => { :up => up, :down => down, :migration_name => migration_name.camelize },
                              :migration_file_name => migration_name
       end
     end
   rescue HoboFields::FieldSpec::UnknownSqlTypeError => e
-    puts "Invalid field type '#{e.message[2]}' for #{e.message[0]}.#{e.message[1]}"
+    puts "Invalid field type: #{e}"
     record {|m| }
   end
-  
-  
+
+
   def extract_renames!(to_create, to_drop, kind_str, name_prefix="")
     to_rename = {}
     rename_to_choices = to_create
@@ -62,7 +80,7 @@ class HoboMigrationGenerator < Rails::Generator::Base
         puts "Rename choices: #{to_create * ', '}"
         resp = input("Enter either 'drop #{t}' or one of the rename choices:")
         resp.strip!
-        
+
         if resp == "drop " + t
           # Leave things as they are
         else
@@ -78,11 +96,11 @@ class HoboMigrationGenerator < Rails::Generator::Base
     to_rename
   end
 
-  
-  def input(prompt, options=nil)
+
+  def input(prompt, format=nil)
     print(prompt + " ")
-    if options
-      while !(response = STDIN.readline.strip.downcase).in?(options); 
+    if format
+      while (response = STDIN.readline.strip.downcase) !~ format
         print(prompt + " ")
       end
       response
@@ -90,6 +108,14 @@ class HoboMigrationGenerator < Rails::Generator::Base
       STDIN.readline
     end
   end
-  
+
+  def rake_migrate
+    if RUBY_PLATFORM =~ /mswin32/
+      system "rake.bat db:migrate"
+    else
+      system "rake db:migrate"
+    end
+  end
+
 end
 

data/rails_generators/hobofield_model/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Stubs out a new model. Pass the model name, either CamelCased or
+    under_scored, and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the model immediately.
+
+    This generates a model class in app/models, a unit test in test/unit,
+    a test fixture in test/fixtures/singular_name.yml, and a migration in
+    db/migrate.
+
+Examples:
+    `./script/generate hobofield_model account`
+
+        creates an Account model, test, fixture, and migration:
+            Model:      app/models/account.rb
+            Test:       test/unit/account_test.rb
+            Fixtures:   test/fixtures/accounts.yml
+
+    `./script/generate hobofield_model post title:string body:text published:boolean`
+
+        creates a Post model with a string title, text body, and published flag.
+        
+After the model is created, and the fields are specified, use hobofield
+to create the migrations incrementally.

data/rails_generators/hobofield_model/hobofield_model_generator.rb

@@ -0,0 +1,38 @@
+class HobofieldModelGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_fixture => false
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+
+      # Model, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path)
+
+      # Create stubs
+      m.template "model.rb.erb",  "app/models/#{file_name}.rb"
+      m.template "test.rb.erb",   "test/unit/#{file_name}_test.rb"
+
+      unless options[:skip_fixture]
+       	m.template 'fixtures.yml.erb',  File.join('test/fixtures', "#{file_name.pluralize}.yml")
+      end
+
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name} ModelName [field:type, field:type]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      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}
+    end
+end

data/rails_generators/hobofield_model/templates/fixtures.yml.erb

@@ -0,0 +1,19 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+<% unless attributes.empty? -%>
+one:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+
+two:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+<% else -%>
+# one:
+#   column: value
+#
+# two:
+#   column: value
+<% end -%>

data/rails_generators/hobofield_model/templates/model.rb.erb

@@ -0,0 +1,10 @@
+class <%= class_name %> < ActiveRecord::Base
+  fields do
+<% for attribute in attributes -%>
+    <%= attribute.name %> :<%= attribute.type %>
+<% end -%>
+<% unless options[:skip_timestamps] %>
+    timestamps
+<% end -%>
+  end
+end

data/rails_generators/hobofield_model/templates/test.rb.erb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/hobofields.rdoctest

@@ -1,57 +1,94 @@
 # HoboFields
 
-## About Doctests
-
-HoboFields is documented and tested using *doctests*. This is an idea that comes from Python that we've been experimenting with for Hobo. Whenever you see code-blocks that start "`>>`", read them as IRB sessions. The `rdoctest` tool extracts these and runs them to verify they behave as advertised. 
+## Introduction
 
-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!
+Welcome to HoboFields -- a spin-off from the Hobo project (Hobo not required!).
 
-## Introduction 
+**HoboFields writes your Rails migrations for you! Your migration writing days are over!**
 
-HoboFields lives on GitHub: [http://github.com/tablatom/hobofields](http://github.com/tablatom/hobofields)
+All we ask is that you declare your fields in the model. It's still perfectly DRY because you're not having to repeat that in the migration -- HoboFields does that for you. In fact, you'll come to love having them there.
 
-You can install it with git:
+It still has all the benefits of writing your own migrations, for example if you want to add some special code to migrate your old data, you can just edit the generated migration.
 
-	git clone git://github.com/tablatom/hobofields.git vendor/plugins/hobofields
+## Example
 
-Or subversion:
+First off, if you're using the migration generator outside of Hobo, do remember the `--skip-migration` option when generating your models:
 
-	svn export svn://hobocentral.net/hobofields/tags/rel_0.7.4 vendor/plugins/hobofields
-	
-HoboFields provides two main features:
+	$ ./script/generate model blog_post --skip-migration
 
- * An extension to ActiveRecord that provides rich field types such as "markdown text" or "email address"
- * A generator that writes your migrations for you. Your migration writing days are over.
- 
-This is all done using a declaration of your fields that you put in your models, for example
+Now edit your model as follows:
 
     class BlogPost < ActiveRecord::Base
       fields do
         title :string
         body  :text
+        timestamps
       end
     end
 {: .ruby}
 
-**NOTE:** If you're going to use the migration generator outside of Hobo, do remember the `--skip-migration` option when generating your models:
 
-	./script/generate model post --skip-migration
+Then, simply run
+
+	$ ./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
+	----------------------------------
+{: .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.
+
+Note that the migration generator is interactive -- it can't tell the difference between renaming something vs. adding one thing and removing another, so sometimes it will ask you to clarify. It's a bit picky about what it makes you type in response, because we really don't want you to lose data when someone's amazing twitter distracts you at the wrong moment.
+
+## Installing
+
+The simplest and recommended way to install HoboFeilds is as a gem:
 
+	$ gem install hobofields
 
-## [Migration Generator](/hobofields/migration_generator)
+The source lives on GitHub as part of the main Hobo repo:
 
-Once you have declared your fields like this, you can run the following, at any time during the development of your project:
+ - [http://github.com/tablatom/hobo](http://github.com/tablatom/hobo)
 
-	$ ./script/generate hobo_migration
-	
-The migration generator will create 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. Note that the migration generator is interactive -- it can't tell the difference between renaming something vs. adding one thing and removing another, so it has to ask you.
+The simplest way to install HoboFields as a plugin is to use the subversion mirror:
 
-The [migration generator doctests](/hobofields/migration_generator) 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
+	svn export svn://hobocentral.net/hobo/tags/rel_0.7.5/hobofields vendor/plugins
 
-## [HoboFields API](/hobofields/hobofields_api)
+## Rich Types
 
-As well as the migration generator, HoboFields provides a bunch of small extensions to ActiveRecord. The [HoboFields API doctests](/hobofields/hobofields_api) provide a useful reference to these.
+In addition to the migration generator, HoboFields provides a Rich-Type mechanism that allows you to declare your fields using higher level concepts like "email-address" or "markdown text". This can give you both automatic validations, and automatic rendering of those values in the UI (this works particularly well if you use the rest of Hobo).
 
-## [Rich Types](/hobofields/rich_types)
+Read more:
+
+ - [HoboFields Rich Types](/hobofields/rich_types)
+
+## API
+
+HoboFields provides various API methods. Read more:
+
+ - [HoboFields API](/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)
+
+## About Doctests
+
+HoboFields is documented and tested using *doctests*. This is an idea that comes from Python that we've been experimenting with for Hobo. Whenever you see code-blocks that start "`>>`", read them as IRB sessions. The `rdoctest` tool extracts these and runs them to verify they behave as advertised.
+
+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!
 
-Documentation for the full set of rich types bundled with HoboFields, and how to create your own, is [here](/hobofields/rich_types).