hobo_fields 1.3.0.RC

data/CHANGES.txt

@@ -0,0 +1,38 @@
+== HoboFields 0.7.4 ==
+
+    Fix to using the migration generator with STI
+
+    HoboFields::Text - fix to to_html
+
+    Ensure that the bundled rich types are only loaded on demand
+
+    HoboFields::TextileString -- adding require 'redcloth'
+
+    Fix for HoboFields::EnumString -- couldn't set values using
+    symbols
+
+    Adding to_html to PasswordString (returns '[password-hidden]')
+
+    EnumString -- now defines constants on the class for each value in
+    the enum
+
+      Also, won't define an is_foo? method if that already exists
+
+    Removing HoboFields::Percentage -- this is better handled as an
+    application specific type
+
+      For example, is a percentage an fixnum or a float? Is 101% valid
+      or invalid?
+
+    Fix to validates_virtual_field
+
+    *Breaking Change* EnumString: Change to automatically defined
+     class methods on EnumString classes
+
+        It used to be that if you did EnumString.for(:foo, :baa), your
+        class had methods foo, baa and the instance got methods foo?
+        and baa?. There was a big problem with name clashes with other
+        class methods. You now get no class methods, and the instance
+        methods are called is_foo? and is_baa?.
+
+    Rich field type fix: don't attempt to wrap booleans

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Tom Locke
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,8 @@
+= HoboFields
+
+Rich field types and migration-generator for Rails.
+
+Part of the Hobo project
+
+http://hobocentral.net/hobo_fields
+

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'active_record'
+require 'tmpdir'
+
+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, '"\&"')
+RUBYDOCTEST = ENV['RUBYDOCTEST'] || "#{RUBY} -S rubydoctest"
+
+$:.unshift File.expand_path('../../hobo_support/lib', __FILE__)
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'hobo_support'
+require 'hobo_fields'
+
+GEM_ROOT = File.expand_path('../', __FILE__)
+TESTAPP_PATH = File.join Dir.tmpdir, 'hobo_fields_testapp'
+BIN = File.expand_path('../bin/hobofields', __FILE__)
+require 'hobo_support/common_tasks'
+include HoboSupport::CommonTasks
+
+
+namespace "test" do
+  desc "Run the doctests"
+  task :doctest do |t|
+    files=Dir['test/*.rdoctest'].map {|f| File.expand_path(f)}.join(' ')
+    exit(1) if !system("#{RUBYDOCTEST} #{files}")
+  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

data/VERSION

@@ -0,0 +1 @@
+1.3.0.RC

data/bin/hobofields

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+if ENV["HOBODEV"]
+  dev_root = File.expand_path ENV["HOBODEV"], FileUtils.pwd
+  $:.unshift "#{dev_root}/hobo_support/lib"
+else
+  require 'rubygems'
+end
+
+begin
+  require 'hobo_support/command'
+rescue LoadError
+  puts "The 'hobo_support' gem is not installed.
+You probably need to set the HOBODEV environment variable to the local repository path."
+  exit
+end
+
+HoboSupport::Command.run(:hobofields)

data/hobo_fields.gemspec

@@ -0,0 +1,31 @@
+name = File.basename( __FILE__, '.gemspec' )
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+require 'date'
+
+Gem::Specification.new do |s|
+
+  s.authors = ['Tom Locke']
+  s.email = 'tom@tomlocke.com'
+  s.homepage = 'http://hobocentral.net'
+  s.rubyforge_project = 'hobo'
+  s.summary = 'Rich field types and migration generator for Rails'
+  s.description = 'Rich field types and migration generator for Rails'
+
+  s.add_runtime_dependency('hobo_support', ["= #{version}"])
+  s.add_development_dependency('rubydoctest', [">= 0"])
+  s.add_development_dependency('redcloth', [">= 0"]) # for testing rich types
+  s.add_development_dependency('bluecloth', [">= 0"])  # for testing rich types
+
+  s.executables = ["hobofields"]
+  s.files = `git ls-files -x #{name}/* -z`.split("\0")
+
+  s.name = name
+  s.version = version
+  s.date = Date.today.to_s
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+
+end
+

data/lib/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 migration name,
+        supplying a numbered default name.
+
+        The generator is conservative and will prompt you to resolve
+        any ambiguities.
+
+Examples:
+
+        $ rails 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/lib/generators/hobo/migration/migration_generator.rb

@@ -0,0 +1,162 @@
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+require 'generators/hobo_support/thor_shell'
+
+module Hobo
+  class MigrationGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :name, :type => :string, :optional => true
+
+    include Rails::Generators::Migration
+    include Generators::HoboSupport::ThorShell
+
+    # the Rails::Generators::Migration.next_migration_number gives a NotImplementedError
+    # in Rails 3.0.0.beta4, so we need to implement the logic of ActiveRecord.
+    # For other ORMs we will wait for the rails implementation
+    # see http://groups.google.com/group/rubyonrails-talk/browse_thread/thread/a507ce419076cda2
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number dirname
+    end
+
+    def self.banner
+      "rails generate hobo:migration #{self.arguments.map(&:usage).join(' ')} [options]"
+    end
+
+    class_option :drop,
+                 :aliases => '-d',
+                 :type => :boolean,
+                 :desc => "Don't prompt with 'drop or rename' - just drop everything"
+
+    class_option :default_name,
+                 :aliases => '-n',
+                 :type => :boolean,
+                 :desc => "Don't prompt for a migration name - just pick one"
+
+    class_option :generate,
+                 :aliases => '-g',
+                 :type => :boolean,
+                 :desc => "Don't prompt for action - generate the migration"
+
+    class_option :migrate,
+                 :aliases => '-m',
+                 :type => :boolean,
+                 :desc => "Don't prompt for action - generate and migrate"
+
+    def migrate
+      return if migrations_pending?
+
+      generator = Generators::Hobo::Migration::Migrator.new(lambda{|c,d,k,p| extract_renames!(c,d,k,p)})
+      up, down = generator.generate
+
+      if up.blank?
+        say "Database and models match -- nothing to change"
+        return
+      end
+
+      say "\n---------- Up Migration ----------"
+      say up
+      say "----------------------------------"
+
+      say "\n---------- Down Migration --------"
+      say down
+      say "----------------------------------"
+
+      action = options[:generate] && 'g' ||
+               options[:migrate] && 'm' ||
+               choose("\nWhat now: [g]enerate migration, generate and [m]igrate now or [c]ancel?", /^(g|m|c)$/)
+
+      if action != 'c'
+        if name.blank? && !options[:default_name]
+          final_migration_name = choose("\nMigration filename: [<enter>=#{migration_name}|<custom_name>]:", /^[a-z0-9_ ]*$/, migration_name).strip.gsub(' ', '_')
+        end
+        final_migration_name = migration_name if final_migration_name.blank?
+
+        up.gsub!("\n", "\n    ")
+        up.gsub!(/ +\n/, "\n")
+        down.gsub!("\n", "\n    ")
+        down.gsub!(/ +\n/, "\n")
+
+        @up = up
+        @down = down
+        @migration_class_name = final_migration_name.camelize
+
+        migration_template 'migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb"
+        rake('db:migrate') if action == 'm'
+      end
+    rescue HoboFields::Model::FieldSpec::UnknownSqlTypeError => e
+      say "Invalid field type: #{e}"
+    end
+
+  private
+
+    def migrations_pending?
+      pending_migrations = ActiveRecord::Migrator.new(:up, 'db/migrate').pending_migrations
+
+      if pending_migrations.any?
+        say "You have #{pending_migrations.size} pending migration#{'s' if pending_migrations.size > 1}:"
+        pending_migrations.each do |pending_migration|
+          say '  %4d %s' % [pending_migration.version, pending_migration.name]
+        end
+        true
+      else
+        false
+      end
+    end
+
+    def extract_renames!(to_create, to_drop, kind_str, name_prefix="")
+      to_rename = {}
+
+      unless options[:drop]
+
+        rename_to_choices = to_create
+        to_drop.dup.each do |t|
+          while true
+            if rename_to_choices.empty?
+              say "\nCONFIRM DROP! #{kind_str} #{name_prefix}#{t}"
+              resp = ask("Enter 'drop #{t}' to confirm or press enter to keep:")
+              if resp.strip == "drop " + t.to_s
+                break
+              elsif resp.strip.empty?
+                to_drop.delete(t)
+                break
+              else
+                next
+              end
+            else
+              say "\nDROP, RENAME or KEEP?: #{kind_str} #{name_prefix}#{t}"
+              say "Rename choices: #{to_create * ', '}"
+              resp = ask "Enter either 'drop #{t}' or one of the rename choices or press enter to keep:"
+              resp.strip!
+
+              if resp == "drop " + t
+                # Leave things as they are
+                break
+              else
+                resp.gsub!(' ', '_')
+                to_drop.delete(t)
+                if resp.in?(rename_to_choices)
+                  to_rename[t] = resp
+                  to_create.delete(resp)
+                  rename_to_choices.delete(resp)
+                  break
+                elsif resp.empty?
+                  break
+                else
+                  next
+                end
+              end
+            end
+          end
+        end
+      end
+      to_rename
+    end
+
+    def migration_name
+      name || Generators::Hobo::Migration::Migrator.default_migration_name
+    end
+
+  end
+end
+