kelredd-useful 0.1.25 → 0.2.0

data/README.rdoc

@@ -3,7 +3,8 @@
 == Description
 
 A collection of useful helpers for various ruby things.  Includes
-helpers for sinatra, ruby base classes, mysql, rails, erb, etc...
+ruby extensions that play nice with activesupport, helpers for
+sinatra/rails/activerecord/erb, etc...
 
 You probably never want them all, all the time, but just require in
 the pieces you are interested in.
@@ -20,8 +21,8 @@ the pieces you are interested in.
 == Usage
 
     require 'rubygems'
+    require 'useful/ruby_extensions'
     require 'useful/sinatra_helpers'
-    require 'useful/mysql_helpers'
 
 == License
 

data/Rakefile

@@ -20,19 +20,12 @@ spec = Gem::Specification.new do |s|
   # s.executables    = ['useful']
   
   s.add_dependency('json')
-  s.add_dependency('tmail')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-end
-
 desc 'Generate the gemspec to serve this Gem from Github'
 task :gemspec do
   file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
@@ -40,6 +33,12 @@ task :gemspec do
   puts "Created gemspec: #{file}"
 end
 
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
 require 'cucumber'
 require 'cucumber/rake/task'
 

data/lib/useful/active_record_helpers/mysql_migration_helpers.rb

@@ -1,82 +1,81 @@
-module Useful
-  module ActiveRecordHelpers
-    module MysqlMigrationHelpers
-      
-      module ClassMethods
+module Useful; end
+module Useful::ActiveRecordHelpers; end
 
-        def foreign_key(from_table, from_column, to_table, opts={})
-          opts[:destination_key] = 'id' unless opts[:destination_key]
-          constraint_name = "fk_#{from_table}_#{from_column}"
-          execute %{alter table #{from_table}
-                    add constraint #{constraint_name}
-                    foreign key (#{from_column})
-                    references #{to_table}(#{opts[:destination_key]})}
-        end
+module Useful::ActiveRecordHelpers::MysqlMigrationHelpers
+  
+  module ClassMethods
 
-        def drop_foreign_key(from_table, *from_columns)
-          from_columns.each { |from_column|
-            constraint_name = "fk_#{from_table}_#{from_column}"
-            execute %{alter table #{from_table} drop FOREIGN KEY #{constraint_name}}
-          }
-        end
+    def foreign_key(from_table, from_column, to_table, opts={})
+      opts[:destination_key] = 'id' unless opts[:destination_key]
+      constraint_name = "fk_#{from_table}_#{from_column}"
+      execute %{alter table #{from_table}
+                add constraint #{constraint_name}
+                foreign key (#{from_column})
+                references #{to_table}(#{opts[:destination_key]})}
+    end
 
-        def remove_column_with_fk(table, column)
-          drop_foreign_key(table, column)
-          remove_column(table, column)
-        end
+    def drop_foreign_key(from_table, *from_columns)
+      from_columns.each { |from_column|
+        constraint_name = "fk_#{from_table}_#{from_column}"
+        execute %{alter table #{from_table} drop FOREIGN KEY #{constraint_name}}
+      }
+    end
 
-        def safe_drop_table(table_name)
-          execute "drop table if exists #{table_name}"
-        end
+    def remove_column_with_fk(table, column)
+      drop_foreign_key(table, column)
+      remove_column(table, column)
+    end
 
-        def unique_constraint(table_name, columns)
-          execute %{ALTER TABLE #{table_name} ADD CONSTRAINT uniq_#{columns.join('_')} UNIQUE KEY (#{columns.join(", ")})}
-        end
+    def safe_drop_table(table_name)
+      execute "drop table if exists #{table_name}"
+    end
 
-        def set_auto_increment(table, number)
-          execute %{ALTER TABLE #{table} AUTO_INCREMENT = #{number}}
-        end
+    def unique_constraint(table_name, columns)
+      execute %{ALTER TABLE #{table_name} ADD CONSTRAINT uniq_#{columns.join('_')} UNIQUE KEY (#{columns.join(", ")})}
+    end
 
-        def clear_table(table_to_clear)
-          execute %{delete from #{table_to_clear}}
-        end
+    def set_auto_increment(table, number)
+      execute %{ALTER TABLE #{table} AUTO_INCREMENT = #{number}}
+    end
 
-        def create_view(view_name,sql_query_definition)
-          execute %{
-            CREATE SQL SECURITY INVOKER VIEW #{view_name.to_s} AS
-            #{sql_query_definition}
-          }
-        end
+    def clear_table(table_to_clear)
+      execute %{delete from #{table_to_clear}}
+    end
 
-        def drop_view(view_name)
-          execute %{
-            DROP VIEW #{view_name}
-          }
-        end
+    def create_view(view_name,sql_query_definition)
+      execute %{
+        CREATE SQL SECURITY INVOKER VIEW #{view_name.to_s} AS
+        #{sql_query_definition}
+      }
+    end
 
-        def alter_view(view_name,sql_query_definition)
-          execute %{
-            ALTER SQL SECURITY INVOKER VIEW #{view_name.to_s} AS
-            #{sql_query_definition}
-          }
-        end
+    def drop_view(view_name)
+      execute %{
+        DROP VIEW #{view_name}
+      }
+    end
 
-      	def raise_err(msg = '')
-      	  raise ActiveRecord::IrreversibleMigration, msg
-      	end
+    def alter_view(view_name,sql_query_definition)
+      execute %{
+        ALTER SQL SECURITY INVOKER VIEW #{view_name.to_s} AS
+        #{sql_query_definition}
+      }
+    end
 
-      end
-      
-      module InstanceMethods
-      end
-      
-      def self.included(receiver)
-        receiver.extend         ClassMethods
-        receiver.send :include, InstanceMethods
-      end
+  	def raise_err(msg = '')
+  	  raise ActiveRecord::IrreversibleMigration, msg
+  	end
 
-    end
   end
+  
+  module InstanceMethods
+  end
+  
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+
 end
 
 module ActiveRecord

data/lib/useful/active_record_helpers.rb

@@ -1,3 +1,3 @@
 Dir[File.join(File.dirname(__FILE__), "active_record_helpers" ,"*.rb")].each do |file|
-  require file
+  require "useful/active_record_helpers/#{File.basename(file, ".rb")}"
 end

data/lib/useful/cap_tasks/app_role_migrations.rb

@@ -0,0 +1,41 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "useful/cap_tasks requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  namespace :deploy do
+
+    # These tasks override the default cap migration tasks
+    # => allows for running your migrations on the primary app server only
+  
+    desc "_: (#{application}) Bring down site, deploy with migrations on primary app server only, bring site back up."
+    task :migrations, :roles => :app, :only => { :primary => true } do
+      stop
+      update
+      migrate
+      start
+    end
+
+    # Copied from http://github.com/jamis/capistrano/blob/df0935c4c135207582da343aacdd4cf080fcfed0/lib/capistrano/recipes/deploy.rb
+    # => changed :roles => :db to :roles => :app so that migrations will run on the primary app server only
+    # => also added , :pty => false as an argument on the run command
+    desc "_: (#{application}) port of default cap task to only run on primary app server"
+    task :migrate, :roles => :app, :only => { :primary => true } do
+      rake = fetch(:rake, "rake")
+      rails_env = fetch(:rails_env, "production")
+      migrate_env = fetch(:migrate_env, "")
+      migrate_target = fetch(:migrate_target, :latest)
+
+      directory = case migrate_target.to_sym
+        when :current then current_path
+        when :latest  then current_release
+        else raise ArgumentError, "unknown migration target #{migrate_target.inspect}"
+        end
+
+      run "cd #{directory}; #{rake} RAILS_ENV=#{rails_env} #{migrate_env} db:migrate", :pty => false
+    end
+
+  end
+
+end

data/lib/useful/cap_tasks/disable_migrate.rb

@@ -0,0 +1,15 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "useful/cap_tasks requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  namespace :deploy do
+
+    desc "_: (#{application}) no migrating needed, this one does nothing..."
+    task :migrate, :roles => :app, :only => { :primary => true } do
+    end
+  
+  end
+
+end

data/lib/useful/cap_tasks/git_query_revision_remote.rb

@@ -0,0 +1,31 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "useful/cap_tasks requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  namespace :deploy do
+  
+    task :before_update_code, :except => { :no_release => true } do
+
+      # Set the branch name to current git HEAD if this stage is configured that way
+      set :branch, run_locally("git symbolic-ref HEAD 2>/dev/null").split('/').last.strip if branch == :current_git_branch
+
+      # hack to remotely lookup the revision sending the config'd scm_password
+      # => prevents having to enter it locally
+      set :real_revision, source.local.query_revision(revision) { |cmd|
+        with_env("LC_ALL", "C") {
+          result = nil
+          run cmd do |ch, stream, out|
+            ch.send_data(scm_password)
+            ch.send_data("\n")
+            result = out
+          end
+          result
+        }
+      }
+    end
+  
+  end
+
+end

data/lib/useful/cap_tasks/passenger_deploy.rb

@@ -0,0 +1,44 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "useful/cap_tasks requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  namespace :deploy do
+
+    task :after_deploy, :except => { :no_release => true } do
+      web.enable
+      cleanup
+    end
+  
+    desc "_: (#{application}) Start app from cold state."
+    task :start, :roles => :app, :except => { :no_release => true } do
+      restart
+      web.enable
+    end
+
+    desc "_: (#{application}) Stop app and put in cold state."
+    task :stop, :roles => :app, :except => { :no_release => true } do
+      web.disable
+    end
+
+    desc "_: (#{application}) Restart app from hot state."
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "touch #{current_path}/tmp/restart.txt"
+    end
+
+  end
+
+  namespace :web do
+    desc "_: (#{application}) Enable app and remove down page."
+    task :enable, :roles => :app, :except => { :no_release => true } do
+      run "rm #{current_path}/public/#{down_html}.html"
+    end
+
+    desc "_: (#{application}) Put up down page and disable app"
+    task :disable, :roles => :app, :except => { :no_release => true } do
+      run "cp #{shared_path}/#{down_html}.html #{current_path}/public/#{down_html}.html"
+    end
+  end
+
+end

data/lib/useful/cap_tasks/rack_cache.rb

@@ -0,0 +1,17 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "useful/cap_tasks requires Capistrano 2"
+end
+
+Capistrano::Configuration.instance.load do
+
+  namespace :cache do
+  
+    desc "Clear the Rack cache"
+    task :xrack, :roles => :app, :except => { :no_release => true } do
+      run "rm -rf #{shared_path}/cache-rack/body/*"
+      run "rm -rf #{shared_path}/cache-rack/meta/*"
+    end
+
+  end
+
+end

data/lib/useful/cap_tasks.rb

@@ -1,3 +1 @@
-Dir[File.join(File.dirname(__FILE__), "cap_tasks" ,"*.rb")].each do |file|
-  require file
-end
+require 'useful/cap_tasks/globals'

data/lib/useful/erb_helpers/common.rb

@@ -0,0 +1,86 @@
+# Note: these helpers are designed to be namespaced and actionpack safe
+# => these helpers are included in the useful/rails_extensions/erb
+# => don't put any actionpack helpers in this module
+
+module Useful; end
+module Useful::ErbHelpers; end
+
+module Useful::ErbHelpers::Common
+  
+  OPTIONS = {
+    :disabled => 'disabled',
+    :checked => 'checked',
+    :multiple => 'multiple',
+    :multipart => 'multipart/form-data',
+    :default_submit_value => "Save changes"
+  }.freeze
+  
+  def erb_helper_clear_output_buffer
+    @_out_buf = ""
+  end
+  
+  protected
+  
+  def erb_helper_common_safe_id(id)
+    id.gsub(/\[\]/, '').gsub(/\[/, '_').gsub(/\]/, '').gsub(/\W/,'')
+  end
+  
+  def erb_helper_common_capture(*args, &block)
+    erb_helper_common_with_output_buffer { block.call(*args) }
+  end
+  
+  def erb_helper_common_with_output_buffer(buf = '') #:nodoc:
+    @_out_buf, old_buffer = buf, @_out_buf
+    result = yield
+    @_out_but.blank? ? result : @_out_buf
+  ensure
+    @_out_buf = old_buffer
+  end
+  
+  def erb_helper_convert_options_to_javascript!(options)
+    confirm, popup = options.delete(:confirm), options.delete(:popup)
+    if confirm || popup
+      options[:onclick] = case
+        when confirm && popup
+          "javascript: if (#{erb_helper_confirm_javascript(confirm)}) { #{erb_helper_popup_javascript(popup)} }; return false;"
+        when confirm
+          "javascript: return #{erb_helper_confirm_javascript(confirm)};"
+        when popup
+          "javascript: #{erb_helper_popup_javascript(popup)} return false;"
+        else
+          "javascript: return false;" # should never case to this b/c of if statement
+      end
+    end
+  end
+
+  def erb_helper_confirm_javascript(confirm)
+    "confirm('#{escape_javascript(confirm)}')"
+  end
+
+  def erb_helper_popup_javascript(popup)
+    popup.kind_of?(::Array) ? "window.open(this.href,'#{popup.first}','#{popup.last}');" : "window.open(this.href);"
+  end
+
+  def erb_helper_disable_with_javascript(disable_with)
+    "javascript: this.disabled=true; this.value='#{escape_javascript(disable_with)}'; this.form.submit();"
+  end
+
+  JS_ESCAPE_MAP = {
+    '\\'    => '\\\\',
+    '</'    => '<\/',
+    "\r\n"  => '\n',
+    "\n"    => '\n',
+    "\r"    => '\n',
+    '"'     => '\\"',
+    "'"     => "\\'"
+  }.freeze
+  # Escape carrier returns and single and double quotes for JavaScript segments.
+  def escape_javascript(javascript)
+    if javascript
+      javascript.gsub(/(\\|<\/|\r\n|[\n\r"'])/) { JS_ESCAPE_MAP[$1] }
+    else
+      ''
+    end
+  end
+
+end      

data/lib/useful/erb_helpers/forms.rb

@@ -0,0 +1,118 @@
+# Note: these helpers are NOT actionpack safe
+# => these helpers should NOT be included in the useful/rails_extensions/erb
+# => these helpers are designed to emulate their corresponding actionpack helpers
+
+require 'useful/erb_helpers/common'
+require 'useful/erb_helpers/tags'
+require 'useful/ruby_extensions/string' unless ::String.new.respond_to?('humanize') && ::String.new.respond_to?('ends_with?')
+require 'useful/ruby_extensions/object' unless ::Object.new.respond_to?('true?')
+
+module Useful; end
+module Useful::ErbHelpers; end
+
+module Useful::ErbHelpers::Forms
+      
+  include Useful::ErbHelpers::Common
+  
+  def form_tag(url, options={}, &block) 
+    options[:method] = 'post' unless ['get','post','put','delete'].include?(options[:method])
+    options.update :action => url
+    if multipart = options.delete(:multipart)
+      options[:enctype] = OPTIONS[:multipart]
+    end
+    if block_given?
+      @_out_buf ||= ''
+      @_out_buf << tag(:form, options) { erb_helper_common_capture(&block) }
+    else
+      tag(:form, options)
+    end
+  end
+  
+  def field_set_tag(legend=nil, options={}, &block)
+    legend_html = legend.nil? ? '' : tag(:legend) { legend.to_s }
+    if block_given?
+      @_out_buf ||= ''
+      @_out_buf << tag(:fieldset, options) { legend_html + erb_helper_common_capture(&block) }
+    else
+      tag(:fieldset, options) { legend_html }
+    end
+  end
+  
+  def label_tag(name, value=nil, options={})
+    value ||= name.to_s.gsub(/\[/, '_').gsub(/\]/, '').humanize
+    options[:for] ||= erb_helper_common_safe_id(name)
+    tag(:label, options) { value }
+  end
+  
+  def hidden_field_tag(name, value=nil, options={}) 
+    input_tag('hidden', name, value, options)
+  end
+  
+  def text_field_tag(name, value=nil, options={}) 
+    input_tag('text', name, value, options)
+  end
+  
+  def password_field_tag(name="password", value=nil, options={}) 
+    input_tag('password', name, value, options)
+  end
+  
+  def file_field_tag(name, options={})
+    input_tag('file', name, nil, options)
+  end
+  
+  # Special options:
+  # => :disable_with - string
+  #   => will add js onclick event to first disable submit, setting text to value, and then submitting form
+  # => :confirm - string
+  #   => will add js confirm confirmation before submitting
+  def submit_tag(value=OPTIONS[:default_submit_value], options={})
+    options[:onclick] = erb_helper_disable_with_javascript(options.delete(:disabled_with)) if options.has_key?(:disabled_with)
+    if options.has_key?(:confirm)
+      options[:onclick] ||= 'return true;'
+      options[:onclick] = "if (!#{erb_helper_confirm_javascript(options.delete(:confirm))}) return false; #{options[:onclick]}"
+    end
+    input_tag('submit', 'commit', value, options)
+  end
+  
+  # Special options:
+  # => :confirm - string
+  #   => will add js confirm confirmation before submitting
+  def image_submit_tag(source, options={})
+    options[:src] = ['/'].include?(source[0..0]) ? source : "/images/#{source}"
+    options[:alt] ||= OPTIONS[:default_submit_value]
+    if options.has_key?(:confirm)
+      options[:onclick] ||= 'return true;'
+      options[:onclick] = "if (!#{erb_helper_confirm_javascript(options.delete(:confirm))}) return false; #{options[:onclick]}"
+    end
+    input_tag('image', nil, nil, options)
+  end
+  
+  # Special options:
+  # => :size - A string specifying the dimensions (columns by rows) of the textarea (e.g., "25x10").
+  # => :rows - Specify the number of rows in the textarea
+  # => :cols - Specify the number of columns in the textarea
+  # => :escape - By default, the contents of the text input are HTML escaped. If you need unescaped contents, set this to false.
+  def text_area_tag(name, content=nil, options={}) 
+    options[:tag] = 'textarea'
+    if size = options.delete(:size)
+      options[:cols], options[:rows] = size.split("x") if size.respond_to?(:split)
+    end
+    unless options.has_key?(:escape) && options.delete(:escape).false?
+      content = escape_html(content)
+    end
+    input_tag(nil, name, nil, options) { content || '' }
+  end
+  
+  # Note: purposely left out:
+  # => select_tag
+  # => check_box_tag
+  # => radio_button_tag
+  # Not going to reinvent the inferior actionpack versions here.
+  # => prefer, instead, the corresponding 'proper' versions
+  # => see useful/erb_helpers/proper.rb (which is included in useful/rails_extensions/erb)
+
+  def self.included(receiver)
+    receiver.send :include, Useful::ErbHelpers::Tags
+  end
+  
+end