hobofields 0.7.5

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/Manifest

@@ -0,0 +1,25 @@
+CHANGES.txt
+generators/hobo_migration/hobo_migration_generator.rb
+generators/hobo_migration/templates/migration.rb
+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/text.rb
+lib/hobo_fields/textile_string.rb
+lib/hobo_fields.rb
+lib/hobofields.rb
+LICENSE.txt
+README.txt
+test/hobofields.rdoctest
+test/hobofields_api.rdoctest
+test/migration_generator.rdoctest
+test/rich_types.rdoctest
+Manifest

data/README.txt

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

data/generators/hobo_migration/hobo_migration_generator.rb

@@ -0,0 +1,95 @@
+class HoboMigrationGenerator < Rails::Generator::Base
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @migration_name = runtime_args.first || begin
+                                              i = Dir["#{RAILS_ROOT}/db/migrate/*hobo_migration*"].length
+                                              "hobo_migration_#{i+1}"
+                                            end
+  end
+  
+  def manifest
+    generator = HoboFields::MigrationGenerator.new(self)
+    up, down = generator.generate
+
+    if up.blank?
+      puts "Database and models match -- nothing to change"
+      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))
+
+    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 = @migration_name if migration_name.blank?
+      
+      at_exit { system "rake db: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 }, 
+                             :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]}"
+    record {|m| }
+  end
+  
+  
+  def extract_renames!(to_create, to_drop, kind_str, name_prefix="")
+    to_rename = {}
+    rename_to_choices = to_create
+    to_drop.dup.each do |t|
+      if rename_to_choices.empty?
+        puts "\nCONFIRM DROP! #{kind_str} #{name_prefix}#{t}"
+        resp = input("Enter 'drop #{t}' to confirm:")
+        if resp.strip != "drop " + t.to_s
+          to_drop.delete(t)
+        end
+      else
+        puts "\nDROP or RENAME?: #{kind_str} #{name_prefix}#{t}"
+        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
+          to_drop.delete(t)
+          if resp.in?(rename_to_choices)
+            to_rename[t] = resp
+            to_create.delete(resp)
+            rename_to_choices.delete(resp)
+          end
+        end
+      end
+    end
+    to_rename
+  end
+
+  
+  def input(prompt, options=nil)
+    print(prompt + " ")
+    if options
+      while !(response = STDIN.readline.strip.downcase).in?(options); 
+        print(prompt + " ")
+      end
+      response
+    else
+      STDIN.readline
+    end
+  end
+  
+end
+

data/generators/hobo_migration/templates/migration.rb

@@ -0,0 +1,9 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    <%= up %>
+  end
+
+  def self.down
+    <%= down %>
+  end
+end

data/hobofields.gemspec

@@ -0,0 +1,42 @@
+
+# Gem::Specification for Hobofields-0.7.5
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{hobofields}
+  s.version = "0.7.5"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Locke"]
+  s.date = %q{2008-04-18}
+  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/text.rb", "lib/hobo_fields/textile_string.rb", "lib/hobo_fields.rb", "lib/hobofields.rb", "LICENSE.txt", "README.txt"]
+  s.files = ["CHANGES.txt", "generators/hobo_migration/hobo_migration_generator.rb", "generators/hobo_migration/templates/migration.rb", "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/text.rb", "lib/hobo_fields/textile_string.rb", "lib/hobo_fields.rb", "lib/hobofields.rb", "LICENSE.txt", "README.txt", "test/hobofields.rdoctest", "test/hobofields_api.rdoctest", "test/migration_generator.rdoctest", "test/rich_types.rdoctest", "Manifest", "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.0.1}
+  s.summary = %q{Rich field types and migration generator for Rails}
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'echoe'
+# 
+# Echoe.new('hobofields') do |p|
+#   p.author  = "Tom Locke"
+#   p.email   = "tom@tomlocke.com"
+#   p.summary = "Rich field types and migration generator for Rails"
+#   p.url     = "http://hobocentral.net/hobofields"
+#   p.project = "hobo"
+#   
+#   p.changelog = "CHANGES.txt"
+#   p.version   = "0.7.5"
+# end
+# 

data/init.rb

@@ -0,0 +1,4 @@
+require 'hobosupport'
+
+# Use ActiveSupport to load if it hasn't been loaded already
+HoboFields

data/lib/hobo_fields/email_address.rb

@@ -0,0 +1,24 @@
+module HoboFields
+  
+  class EmailAddress < String
+    
+    COLUMN_TYPE = :string
+    
+    def validate
+      "is not valid" unless valid? || blank?
+    end
+    
+    def valid?
+      self =~ /^\s*([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\s*$/i
+    end
+    
+    def to_html
+      self
+    end
+
+    HoboFields.register_type(:email_address, self)
+
+  end
+
+end
+

data/lib/hobo_fields/enum_string.rb

@@ -0,0 +1,64 @@
+require 'hobo_fields/field_declaration_dsl'
+
+module HoboFields
+  
+  class EnumString < String
+    
+    module DeclarationHelper
+      
+      def enum_string(*values)
+        EnumString.for(*values)
+      end
+      
+    end
+    
+    FieldDeclarationDsl.send(:include, DeclarationHelper)
+
+    
+    class << self 
+      
+      def with_values(*values)
+        @values = values.*.to_s
+      end
+      
+      attr_accessor :values
+      
+      def for(*values)
+        values = values.*.to_s
+        c = Class.new(EnumString) do
+          values.each do |v|
+            const_name = v.upcase
+            const_set(const_name, self.new(v)) unless const_defined?(const_name)
+
+            method_name = "is_#{v.underscore}?"
+            define_method(method_name) { self == v } unless self.respond_to?(method_name)
+          end
+        end
+        c.with_values(*values)
+        c
+      end
+      
+      def inspect
+        name.blank? ? "#<EnumString #{(values || []) * ' '}>" : name
+      end
+      alias_method :to_s, :inspect
+      
+    end
+
+    COLUMN_TYPE = :string
+    
+    def validate
+      "must be one of #{self.class.values * ', '}" unless self.in?(self.class.values)
+    end
+    
+    def ==(other)
+      if other.is_a?(Symbol)
+        super(other.to_s)
+      else
+        super
+      end
+    end
+    
+  end
+  
+end

data/lib/hobo_fields/field_declaration_dsl.rb

@@ -0,0 +1,29 @@
+module HoboFields
+  
+  class FieldDeclarationDsl < BlankSlate
+    
+    def initialize(model)
+      @model = model
+    end
+    
+    attr_reader :model
+    
+    
+    def timestamps
+      field(:created_at, :datetime)
+      field(:updated_at, :datetime)
+    end
+    
+    
+    def field(name, type, *args)
+      @model.declare_field(name, type, *args)
+    end
+    
+    
+    def method_missing(name, *args)
+      field(name, *args)
+    end
+    
+  end
+  
+end

data/lib/hobo_fields/field_spec.rb

@@ -0,0 +1,72 @@
+module HoboFields
+  
+  class FieldSpec
+    
+    class UnknownSqlTypeError < RuntimeError; end
+  
+    def initialize(model, name, type, options={})
+      raise ArgumentError, "you cannot provide a field spec for the primary key" if name == model.primary_key
+      self.model = model
+      self.name = name.to_sym
+      self.type = type.is_a?(String) ? type.to_sym : type
+      self.options = options
+      self.position = model.field_specs.length
+    end
+    
+    attr_accessor :model, :name, :type, :position, :options
+    
+    def sql_type
+      options[:sql_type] or begin
+                              if native_type?(type)
+                                type
+                              else
+                                field_class = HoboFields.to_class(type)
+                                field_class && field_class::COLUMN_TYPE or raise UnknownSqlTypeError, "#{model}.#{name}::#{type}"
+                              end
+                            end
+    end
+    
+    def limit
+      options[:limit] || native_types[sql_type][:limit]
+    end
+    
+    def precision
+      options[:precision]
+    end
+    
+    def scale
+      options[:scale]
+    end
+    
+    def null
+      :null.in?(options) ? options[:null] : true
+    end
+    
+    def default
+      options[:default]
+    end
+    
+    def different_to?(col_spec)
+      sql_type != col_spec.type ||
+        begin
+          check_cols = [:null, :default]
+          check_cols += [:precision, :scale] if sql_type == :decimal
+          check_cols << :limit if sql_type.in?([:string, :text, :binary, :integer])
+          check_cols.any? { |k| col_spec.send(k) != self.send(k) }
+        end
+    end
+    
+    
+    private
+    
+    def native_type?(type)
+      type.in?(native_types.keys - [:primary_key])
+    end
+    
+    def native_types
+      model.connection.native_database_types
+    end
+    
+  end
+  
+end

data/lib/hobo_fields/fields_declaration.rb

@@ -0,0 +1,22 @@
+module HoboFields
+  
+  FieldsDeclaration = classy_module do 
+    
+    def self.fields(&b)
+      # Any model that calls 'fields' gets a bunch of other
+      # functionality included automatically, but make sure we only include it once
+      include HoboFields::ModelExtensions unless HoboFields::ModelExtensions.in?(included_modules)
+      
+      if b
+        dsl = FieldDeclarationDsl.new(self)
+        if b.arity == 1
+          yield dsl
+        else
+          dsl.instance_eval(&b)
+        end
+      end
+    end
+    
+  end
+
+end

data/lib/hobo_fields/html_string.rb

@@ -0,0 +1,15 @@
+module HoboFields
+  
+  class HtmlString < String
+  
+    COLUMN_TYPE = :text
+    
+    def to_html
+      self
+    end
+
+    HoboFields.register_type(:html, self)
+
+  end
+
+end

data/lib/hobo_fields/markdown_string.rb

@@ -0,0 +1,13 @@
+module HoboFields
+  
+  class MarkdownString < HoboFields::Text
+  
+    HoboFields.register_type(:markdown, self)
+
+    def to_html
+      blank? ? "" : BlueCloth.new(self).to_html
+    end
+
+  end
+
+end