merb_helpers 0.9.3 → 0.9.4

data/Rakefile

@@ -1,61 +1,72 @@
 require 'rubygems'
 require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
+require "rake/rdoctask"
+require "extlib"
+require 'merb-core/tasks/merb_rake_helper'
+require "spec/rake/spectask"
 
-PLUGIN = "merb_helpers"
-NAME = "merb_helpers"
-VERSION = "0.9.3"
-AUTHOR = "Yehuda Katz"
-EMAIL = "wycats@gmail.com"
-HOMEPAGE = "http://merb.rubyforge.org/"
-SUMMARY = "Helper support for merb (similar to the Rails form helpers)"
+##############################################################################
+# Package && release
+##############################################################################
+RUBY_FORGE_PROJECT  = "merb"
+PROJECT_URL         = "http://merbivore.com"
+PROJECT_SUMMARY     = "Helper support for merb (similar to the Rails form helpers)"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY
 
-windows = (PLATFORM =~ /win32|cygwin/)
+GEM_AUTHOR = "Yehuda Katz"
+GEM_EMAIL  = "ykatz@engineyard.com"
 
-SUDO = windows ? "" : "sudo"
+GEM_NAME    = "merb_helpers"
+PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+GEM_VERSION = (Merb::MORE_VERSION rescue "0.9.4") + PKG_BUILD
+
+RELEASE_NAME    = "REL #{GEM_VERSION}"
+
+require "extlib/tasks/release"
 
 spec = Gem::Specification.new do |s|
-  s.name = NAME
-  s.version = VERSION
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
   s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
-  s.summary = SUMMARY
-  s.description = s.summary
-  s.author = AUTHOR
-  s.email = EMAIL
-  s.homepage = HOMEPAGE
-  s.add_dependency("merb-core", ">=0.9.3")
+  s.summary = PROJECT_SUMMARY
+  s.description = PROJECT_DESCRIPTION
+  s.author = GEM_AUTHOR
+  s.email = GEM_EMAIL
+  s.homepage = PROJECT_URL
+  s.add_dependency('merb-core', '>= 0.9.4')
   s.require_path = 'lib'
-  s.autorequire = PLUGIN
   s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
 end
 
-
 Rake::GemPackageTask.new(spec) do |pkg|
   pkg.gem_spec = spec
 end
 
-desc "Run :package and install resulting .gem"
+##############################################################################
+# Installation
+##############################################################################
+desc "Install the gem"
 task :install => [:package] do
-  sh %{#{SUDO} gem install pkg/#{NAME}-#{VERSION} --no-rdoc --no-ri --no-update-sources}
+  sh %{#{sudo} gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
 end
 
-Rake::RDocTask.new do |rdoc|
-      files = ['README', 'LICENSE',
-               'lib/**/*.rb']
-      rdoc.rdoc_files.add(files)
-      rdoc.main = 'README'
-      rdoc.title = 'Merb Helper Docs'
-      rdoc.rdoc_dir = 'doc/rdoc'
-      rdoc.options << '--line-numbers' << '--inline-source'
+namespace :jruby do
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
 end
 
-
-Spec::Rake::SpecTask.new do |t|
-   t.spec_opts = ["--format", "specdoc", "--colour"]
-   t.spec_files = Dir['spec/**/*_spec.rb'].sort   
+##############################################################################
+# Specs
+##############################################################################
+desc "Run all specs"
+Spec::Rake::SpecTask.new("specs") do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
 end
 
 desc "Run all specs and generate an rcov report"
@@ -67,4 +78,15 @@ Spec::Rake::SpecTask.new('rcov') do |t|
   t.rcov_opts = ['--exclude', 'gems', '--exclude', 'spec']
 end
 
-
+##############################################################################
+# Documentation
+##############################################################################
+Rake::RDocTask.new do |rdoc|
+      files = ['README', 'LICENSE',
+               'lib/**/*.rb']
+      rdoc.rdoc_files.add(files)
+      rdoc.main = 'README'
+      rdoc.title = 'Merb Helper Docs'
+      rdoc.rdoc_dir = 'doc/rdoc'
+      rdoc.options << '--line-numbers' << '--inline-source'
+end

data/lib/merb_helpers/core_ext.rb

@@ -0,0 +1,31 @@
+class Date
+  include OrdinalizedFormatting
+  
+  # Converts a Date instance to a Time, where the time is set to the beginning of the day.
+  # The timezone can be either :local or :utc (default :utc).
+  #
+  # ==== Examples:
+  #   date = Date.new(2007, 11, 10)
+  #   date.to_s                      # => 2007-11-10
+  #
+  #   date.to_time                   # => Sat Nov 10 00:00:00 UTC 2007
+  #   date.to_time(:utc)             # => Sat Nov 10 00:00:00 UTC 2007
+  #   date.to_time(:local)           # => Sat Nov 10 00:00:00 -0800 2007
+  #
+  def to_time(form = :utc)
+    ::Time.send("#{form}", year, month, day)
+  end
+  
+  def to_date; self; end
+end
+
+class Time
+  include OrdinalizedFormatting
+  
+  # Ruby 1.8-cvs and 1.9 define private Time#to_date
+  %w(to_date to_datetime).each do |method|
+    public method if private_instance_methods.include?(method)
+  end
+  
+  def to_time; self; end
+end

data/lib/merb_helpers/date_time_helpers.rb

@@ -1,52 +1,3 @@
-
-# Everything above here has pretty much been implemented in the assistance gem...
-
-# Time.now.to_ordinalized_s :long
-# => "February 28th, 2006 21:10"
-module OrdinalizedFormatting
-  
-  def self.extended(obj)
-    include Merb::Helpers::DateAndTime
-  end
-  
-  def to_ordinalized_s(format = :default)
-    format = Merb::Helpers::DateAndTime.date_formats[format] 
-    return self.to_s if format.nil?
-    strftime_ordinalized(format)
-  end
-
-  def strftime_ordinalized(fmt)
-    strftime(fmt.gsub(/(^|[^-])%d/, '\1_%d_')).gsub(/_(\d+)_/) { |s| s.to_i.ordinalize }
-  end
-end
-
-class Date
-  include OrdinalizedFormatting
-  # Converts a Date instance to a Time, where the time is set to the beginning of the day.
-  # The timezone can be either :local or :utc (default :utc).
-  #
-  # ==== Examples:
-  #   date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007
-  #
-  #   date.to_time                   # => Sat Nov 10 00:00:00 0800 2007
-  #   date.to_time(:local)           # => Sat Nov 10 00:00:00 0800 2007
-  #
-  #   date.to_time(:utc)             # => Sat Nov 10 00:00:00 UTC 2007
-  def to_time(form = :utc)
-    ::Time.send("#{form}_time", year, month, day)
-  end
-  def to_date; self; end
-end
-
-class Time
-  include OrdinalizedFormatting
-  # Ruby 1.8-cvs and 1.9 define private Time#to_date
-  %w(to_date to_datetime).each do |method|
-    public method if private_instance_methods.include?(method)
-  end
-  def to_time; self; end
-end
-
 module Merb
   module Helpers
     # Provides a number of methods for displaying and dealing with dates and times
@@ -78,11 +29,17 @@ module Merb
         @@time_class
       end
       
-      def time_output
-        @@time_output
+      # ==== Parameters
+      # format<Symbol>:: time format to use
+      # locale<String, Symbol>:: An optional value which can be used by localization plugins
+      #
+      # ==== Returns
+      # String:: a string used to format time using #strftime
+      def self.time_output(format, locale=nil)
+        @@time_output[format]
       end
       
-      def date_formats
+      def self.date_formats
         @@date_formats
       end
       
@@ -90,27 +47,28 @@ module Merb
       #
       # ==== Parameters
       # time<~to_date>:: The Date or Time to test
+      # locale<String, Symbol>:: An optional value which can be used by localization plugins
       #
       # ==== Returns
-      # String:: The sexy relative date
+      # String:: Relative date
       #
       # ==== Examples
       #   relative_date(Time.now.utc) => "today"
       #   relative_date(5.days.ago) => "March 5th"
       #   relative_date(1.year.ago) => "March 10th, 2007"
-      def relative_date(time)
+      def relative_date(time, locale=nil)
         date  = time.to_date
         today = DateAndTime.time_class.now.to_date
         if date == today
-          DateAndTime.time_output[:today]
+          DateAndTime.time_output(:today, locale)
         elsif date == (today - 1)
-          DateAndTime.time_output[:yesterday]
+          DateAndTime.time_output(:yesterday, locale)
         elsif date == (today + 1)
-          DateAndTime.time_output[:tomorrow]
+          DateAndTime.time_output(:tomorrow, locale)
         else
-          fmt  = DateAndTime.time_output[:initial_format].dup
-          fmt << DateAndTime.time_output[:year_format] unless date.year == today.year
-          time.strftime_ordinalized(fmt)
+          fmt  = DateAndTime.time_output(:initial_format, locale).dup
+          fmt << DateAndTime.time_output(:year_format, locale) unless date.year == today.year
+          time.strftime_ordinalized(fmt, locale)
         end
       end
       
@@ -188,6 +146,7 @@ module Merb
       # from_time<~to_time>:: The Date or Time to start from
       # to_time<~to_time>:: The Date or Time to go to, Defaults to Time.now.utc
       # include_seconds<Boolean>:: Count the seconds initially, Defaults to false
+      # locale<String, Symbol>:: An optional value which can be used by localization plugins
       #
       # ==== Returns
       # String:: The time distance
@@ -199,7 +158,7 @@ module Merb
       # time_lost_in_words(Time.now)                     # => less than a minute
       # time_lost_in_words(Time.now, Time.now, true)     # => less than 5 seconds
       #
-      def time_lost_in_words(from_time, to_time = Time.now.utc, include_seconds = false)
+      def time_lost_in_words(from_time, to_time = Time.now.utc, include_seconds = false, locale=nil)
         from_time = from_time.to_time if from_time.respond_to?(:to_time)
         to_time = to_time.to_time if to_time.respond_to?(:to_time)
         distance_in_minutes = (((to_time - from_time).abs)/60).round
@@ -230,13 +189,14 @@ module Merb
       end
       alias :time_ago_in_words :time_lost_in_words
       
-      def prettier_time(time, ampm=true)
+      def prettier_time(time, ampm=true, locale=nil)
         time.strftime("%I:%M#{" %p" if ampm}").sub(/^0/, '')
       end
     end
   end
 end
 
-class Merb::Controller #:nodoc:
+class Merb::Controller 
   include Merb::Helpers::DateAndTime
 end
+

data/lib/merb_helpers/form_helpers.rb

@@ -1,6 +1,6 @@
 require "#{File.dirname(__FILE__)}/tag_helpers"
 
-module Merb #:nodoc:
+module Merb
   
   # Merb helpers include several helpers used for simplifying view creation.
   # The available helpers currently include form tag helpers for both resource based and generic HTML form tag creation
@@ -46,7 +46,7 @@ module Merb #:nodoc:
       # Provides a HTML formatted display of resource errors in an unordered list with a h2 form submission error
       # ==== Options
       # +build_li+:: Block for generating a list item for an error. It receives an instance of the error.
-      # +html_class+:: Set for custom error div class default is <tt>submittal_failed<tt>
+      # +html_class+:: Set for custom error div class default is <tt>submission_failed<tt>
       #
       # ==== Examples
       #   <%= error_messages_for :person %>
@@ -71,7 +71,7 @@ module Merb #:nodoc:
           yield(obj.errors)
         else
           error_plurality = (error_count == 1 ? 'problem' : 'problems')
-          "<h2>Form submittal failed because of #{error_count} #{error_plurality}</h2>"
+          "<h2>Form submission failed because of #{error_count} #{error_plurality}</h2>"
         end
         
         markup = %Q{
@@ -88,7 +88,7 @@ module Merb #:nodoc:
         }
       end
       
-      def obj_from_ivar_or_sym(obj) #:nodoc:
+      def obj_from_ivar_or_sym(obj) 
         obj.is_a?(Symbol) ? instance_variable_get("@#{obj}") : obj
       end
       
@@ -164,19 +164,19 @@ module Merb #:nodoc:
         @_obj, @_block, @_object_name = old_obj, old_block, old_object_name
       end
       
-      def control_name(col) #:nodoc:
+      def control_name(col)
         "#{@_object_name}[#{col}]"
       end
       
-      def control_id(col) #:nodoc:
+      def control_id(col)
         "#{@_object_name}_#{col}"
       end
       
-      def control_value(col) #:nodoc:
+      def control_value(col)
         escape_xml(@_obj.send(col))
       end
       
-      def control_name_value(col, attrs) #:nodoc:
+      def control_name_value(col, attrs)
         {:name => control_name(col), :value => control_value(col)}.merge(attrs)
       end
       
@@ -212,7 +212,7 @@ module Merb #:nodoc:
       def password_control(col, attrs = {})
         attrs.merge!(:name => control_name(col), :id => control_id(col))
         errorify_field(attrs, col)
-        password_field(control_name_value(col, attrs))
+        password_field({:name => control_name(col)}.merge(attrs))
       end
       
       # Provides a generic HTML password input tag.
@@ -221,7 +221,6 @@ module Merb #:nodoc:
       #     <%= password_field :name => :password, :label => "Password" %>
       #     # => <label for="password">Password</label><input type="password" name="password" id="password"/>
       def password_field(attrs = {})
-        attrs.delete(:value)
         attrs.merge!(:type => 'password')
         attrs.add_html_class!("password")
         optional_label(attrs) { self_closing_tag("input", attrs) }
@@ -229,7 +228,7 @@ module Merb #:nodoc:
       
       # translate column values from the db to boolean
       # nil, false, 0 and '0' are false. All others are true
-      def col_val_to_bool(val) #:nodoc:
+      def col_val_to_bool(val)
         !(val == "0" || val == 0 || !val)
       end
       private :col_val_to_bool
@@ -305,6 +304,20 @@ module Merb #:nodoc:
         self_closing_tag("input", attrs)
       end
       
+      # Provides a HTML radio input tag based on a resource attribute.
+      #
+      # ==== Example
+      #     <% form_for :person, :action => url(:people) do %>
+      #       <%= radio_control :first_name %>
+      #     <% end %>
+      def radio_control(col, attrs = {})
+        errorify_field(attrs, col)
+        attrs.merge!(:id => control_id(col))
+        val = @_obj.send(col)
+        attrs.merge!(:checked => "checked") if val.to_s == attrs[:value]
+        optional_label(attrs) { radio_field(control_name_value(col, attrs)) }
+      end
+
       # Provides a radio group based on a resource attribute.
       # This is generally used within a resource block such as +form_for+.
       #
@@ -334,8 +347,10 @@ module Merb #:nodoc:
       # ==== Example
       #     <%= radio_field :name => "radio_options", :value => "1", :label => "One" %>
       #     <%= radio_field :name => "radio_options", :value => "2", :label => "Two" %>
+      #     <%= radio_field :name => "radio_options", :value => "3", :label => "Three", :checked => true %>
       def radio_field(attrs = {})
         attrs.merge!(:type => "radio")
+        attrs.delete(:checked) unless attrs[:checked]
         attrs.add_html_class!("radio")
         optional_label(attrs){self_closing_tag("input", attrs)}
       end
@@ -559,6 +574,7 @@ module Merb #:nodoc:
       # Generates a delete button inside of a form. 
       # 
       #     <%= delete_button :news_post, @news_post, 'Remove' %>
+      #     <%= delete_button('/posts/24/comments/10') %>
       # 
       # The HTML generated for this would be:
       # 
@@ -566,10 +582,17 @@ module Merb #:nodoc:
       #       <input type="hidden" value="delete" name="_method"/>
       #       <button type="submit">Remove</button>
       #     </form>
-      def delete_button(symbol, obj = instance_variable_get("@#{symbol}"), contents = 'Delete', form_attrs = {}, button_attrs = {})
+      #
+      #     <form method="post" action="/posts/24/comments/10">
+      #       <input type="hidden" value="delete" name="_method"/>
+      #       <button type="submit">Remove</button>
+      #     </form>
+      def delete_button(symbol_or_string, obj = nil, contents = 'Delete', form_attrs = {}, button_attrs = {})
+        obj ||= instance_variable_get("@#{symbol_or_string}") if symbol_or_string.kind_of?(Symbol)
+        
         button_attrs[:type] = :submit
         
-        form_attrs.merge! :action => url(symbol, obj), :method => :delete
+        form_attrs.merge! :action => symbol_or_string.kind_of?(Symbol) ? url(symbol_or_string, obj) : symbol_or_string, :method => :delete
         
         fake_form_method = set_form_method(form_attrs, obj)
         
@@ -627,6 +650,6 @@ module Merb #:nodoc:
   end
 end
 
-class Merb::Controller #:nodoc:
+class Merb::Controller
   include Merb::Helpers::Form
 end

data/lib/merb_helpers/ordinalize.rb

@@ -20,4 +20,35 @@ module Ordinalize
     end
   end
 end
-Integer.send :include, Ordinalize
+
+Integer.send :include, Ordinalize
+
+# Time.now.to_ordinalized_s :long
+# => "February 28th, 2006 21:10"
+module OrdinalizedFormatting
+  
+  def self.extended(obj)
+    include Merb::Helpers::DateAndTime
+  end
+  
+  def to_ordinalized_s(format = :default)
+    format = Merb::Helpers::DateAndTime.date_formats[format] 
+    return self.to_s if format.nil?
+    strftime_ordinalized(format)
+  end
+
+  # Gives you a relative date in an attractive format
+  #
+  # ==== Parameters
+  # format<String>:: strftime string used to formatt a time/date object
+  # locale<String, Symbol>:: An optional value which can be used by localization plugins
+  #
+  # ==== Returns
+  # String:: Ordinalized time/date object
+  #
+  # ==== Examples
+  #    5.days.ago.strftime_ordinalized('%b %d, %Y')     # => 
+  def strftime_ordinalized(fmt, format=nil)
+    strftime(fmt.gsub(/(^|[^-])%d/, '\1_%d_')).gsub(/_(\d+)_/) { |s| s.to_i.ordinalize }
+  end
+end

data/lib/merb_helpers/tag_helpers.rb

@@ -26,7 +26,7 @@ module Merb
       #   # <div class="class">content</div>
       # 
       def tag(name, contents = nil, attrs = {}, &block)
-        attrs = contents if contents.is_a?(Hash)
+        attrs, contents = contents, nil if contents.is_a?(Hash)
         contents = capture(&block) if block_given?
         open_tag(name, attrs) + contents.to_s + close_tag(name)
       end
@@ -56,6 +56,6 @@ module Merb
   end
 end
 
-class Merb::Controller #:nodoc:
+class Merb::Controller
   include Merb::Helpers::Tag
 end    

data/lib/merb_helpers/time_dsl.rb

@@ -55,4 +55,5 @@ module TimeDSL
   end
   alias :from_now :since
 end
+
 Numeric.send :include, TimeDSL

data/lib/merb_helpers.rb

@@ -1,42 +1,39 @@
 module Merb
   
   module Helpers
-    HELPERS_DIR   = File.dirname(__FILE__) / 'merb_helpers'
-    HELPERS_FILES = Dir["#{HELPERS_DIR}/*_helpers.rb"].collect {|h| h.match(/\/(\w+)\.rb/)[1]}
-      
-    def self.load_helpers(helpers = HELPERS_FILES)
-      helpers.each {|h| Kernel.load(File.join(HELPERS_DIR, "#{h}.rb") )} # using load here allows specs to work
-    end
+    
+    @@helpers_dir   = File.dirname(__FILE__) / 'merb_helpers'
+    @@helpers_files = Dir["#{@@helpers_dir}/*_helpers.rb"].collect {|h| h.match(/\/(\w+)\.rb/)[1]}
     
     def self.load
-      require HELPERS_DIR + '/time_dsl'
-      require HELPERS_DIR + '/ordinalize'
-      # TODO remove with and without and only allow 2 options:
-      # config[:load] 
-      # if defined then load the modules passed along
-      # otherwise load everything
+      require @@helpers_dir + '/time_dsl'
+      require @@helpers_dir + '/ordinalize'
+      require @@helpers_dir + '/core_ext'
        
       if Merb::Plugins.config[:merb_helpers]
         config = Merb::Plugins.config[:merb_helpers]
-        raise "With and Without options cannot be used with merb_helpers plugin configuration" if config[:with] && config[:without]
-        if config[:include]
+        raise "With and Without options have been deprecated" if config[:with] || config[:without]
+        
+        if config[:include] && !config[:include].empty?
           load_helpers(config[:include])
-        elsif config[:exclude]
-          load_helpers(HELPERS_FILES.reject {|h| config[:exclude].include? h})
         else
           # This is in case someone defines an entry in the config,
           # but doesn't put in a with or without option
           load_helpers
         end
+        
       else
         load_helpers
       end
     end
     
+    # Load only specific helpers instead of loading all the helpers
+    def self.load_helpers(helpers = @@helpers_files)
+      helpers.each {|helper| Kernel.load(File.join(@@helpers_dir, "#{helper}.rb") )} # using load here allows specs to work
+    end
+    
   end
   
 end
 
-Merb::BootLoader.before_app_loads do  
-  Merb::Helpers.load
-end
+Merb::Helpers.load

metadata

@@ -1,28 +1,29 @@
 --- !ruby/object:Gem::Specification 
 name: merb_helpers
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Yehuda Katz
-autorequire: merb_helpers
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-05-04 00:00:00 -05:00
+date: 2008-08-03 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: merb-core
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.3
+        version: 0.9.4
     version: 
 description: Helper support for merb (similar to the Rails form helpers)
-email: wycats@gmail.com
+email: ykatz@engineyard.com
 executables: []
 
 extensions: []
@@ -37,6 +38,7 @@ files:
 - Rakefile
 - TODO
 - lib/merb_helpers
+- lib/merb_helpers/core_ext.rb
 - lib/merb_helpers/date_time_helpers.rb
 - lib/merb_helpers/form_helpers.rb
 - lib/merb_helpers/ordinalize.rb
@@ -44,7 +46,7 @@ files:
 - lib/merb_helpers/time_dsl.rb
 - lib/merb_helpers.rb
 has_rdoc: true
-homepage: http://merb.rubyforge.org/
+homepage: http://merbivore.com
 post_install_message: 
 rdoc_options: []
 
@@ -64,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.0.1
+rubyforge_project: merb
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Helper support for merb (similar to the Rails form helpers)