context_help 0.0.1 → 0.0.2

data/lib/context_help/base.rb

@@ -25,6 +25,16 @@ module ContextHelp
        :link_to_help => false
     }
 
+    def self.help_items
+      @help_items
+    end
+    def self.config
+      @config
+    end
+    def self.flush_items
+      @help_items = []
+    end
+
     def self.help_for(options)
       help_options = options[:context_help]
       self.help_path_for(help_options)
@@ -42,15 +52,6 @@ module ContextHelp
       end
       help.strip
     end
-    def self.help_items
-      @help_items
-    end
-    def self.config
-      @config
-    end
-    def self.flush_items
-      @help_items = []
-    end
     def self.inline_help(options)
       return '' if options[:skip] or !options[:calculated_path]
       if options[:inline_help_builder].is_a?(Proc) 
@@ -68,13 +69,16 @@ module ContextHelp
       ruta = nil
       if !options[:skip]
         if path[:model] and @config[:exclude_models].index(path[:model].to_sym).nil?
-          ruta = 'context_help.models.'+model_name(path[:model])
+          ruta = 'context_help.models.'+Helpers.model_name(path[:model])
           options[:pre_level_class] = @config[:level_classes][:model]
           
           if (path[:attribute])
             ruta = ruta + '.attributes.'+ path[:attribute].to_s.underscore
             options[:pre_level_class] = @config[:level_classes][:model_attribute]
           end  
+        elsif path[:custom]
+          ruta = 'context_help.custom.'+path[:custom]
+          options[:pre_level_class] = @config[:level_classes][:custom]
         elsif path[:tag] and @config[:exclude_tags].index(path[:tag].to_sym).nil?
           ruta = 'context_help.html.'+path[:tag].to_s.downcase
           ruta = ruta + '.' + path[:tag_options][:id].to_s if path[:tag_options][:id]
@@ -84,13 +88,10 @@ module ContextHelp
           else
             options[:pre_level_class] = @config[:level_classes][:html][:default]
           end
-        elsif path[:custom]
-          ruta = 'context_help.custom.'+path[:custom]
-          options[:pre_level_class] = @config[:level_classes][:custom]
         end
       end
       if ruta              
-        options[:calculated_path] = ruta if (I18n.t(ruta+'.title', :default => '') != '') or (Rails.env.development? and @config[:show_missing])
+        options[:calculated_path] = ruta
         self.register_item(options) if register
         return options[:calculated_path]
       end
@@ -100,8 +101,10 @@ module ContextHelp
       if options[:help_builder].is_a?(Proc) 
         options[:help_builder].call(options)
       elsif options[:calculated_path]
-        title = options[:title] || I18n.t(options[:calculated_path]+'.title')
-        text = options[:text] || I18n.t(options[:calculated_path]+'.text')
+        title = Helpers.get_title(options)
+        text = Helpers.get_text(options)
+        return '' if (title.nil? || text.nil?) and !(Rails.env.development? and @config[:show_missing])
+
         html = "<#{options[:title_tag]} id=\"#{options[:item_id]}\" class=\"#{options[:title_class]} #{options[:level_class]}\">#{title}</#{options[:title_tag]}>
         <#{options[:text_tag]} class=\"#{options[:text_class]} #{options[:level_class]}\">#{text}</#{options[:text_tag]}>"
         html += self.link_to_object(options)
@@ -111,7 +114,9 @@ module ContextHelp
     def self.link_to_help(options)  
       if options[:link_to_help_builder].is_a?(Proc)
         options[:link_to_help_builder].call(options)
-      elsif options[:link_to_help] and !I18n.t(options[:calculated_path]+'.title', :default => {}).is_a?(Hash)
+      elsif options[:link_to_help] and options[:calculated_path]
+        title = Helpers.get_title(options)
+        return '' if title.nil?
         "<a href=\"##{options[:item_id]}\" id=\"#{options[:item_id]}_object\" class=\"context_help_link_to_help\">help</a>"
       else
         ''
@@ -159,6 +164,51 @@ module ContextHelp
         @help_items << options 
       end
     end 
+  end
+
+  module Helpers
+    def self.is_visible(options)
+      return false if options[:calculated_path].nil?
+      text = options[:text] || I18n.t(options[:calculated_path]+'.text', :default => {})
+      return false if (text.nil? or text.is_a?(Hash)) and !(Rails.env.development? and ContextHelp::Base.config[:show_missing])
+      true
+    end
+    def self.get_title(options)
+      title = options[:title] || I18n.t(options[:calculated_path]+'.title', :default => {})
+      if (title.nil? or title.is_a?(Hash)) 
+        title = nil
+        if options[:path][:model]
+          model_class = model_name(options[:path][:model]).classify
+          if const_defined?(model_class)
+            model_class = model_class.constantize
+            if options[:path][:attribute] then
+              title = model_class.human_attribute_name(options[:path][:attribute].to_s) rescue I18n.t(options[:calculated_path]+'.title')
+            else
+              title = model_class.human_name
+            end
+          else
+            title = I18n.t(options[:calculated_path]+'.title')
+          end
+        else
+          title = I18n.t(options[:calculated_path]+'.title') if Rails.env.development? and ContextHelp::Base.config[:show_missing]
+        end
+      else
+        if title.start_with?('t.')
+          title = I18n.t title[2, title.length]
+        elsif title.start_with?('I18n.')
+          title = I18n.t title[5, title.length]
+        end
+      end
+      title
+    end
+    def self.get_text(options)
+      text = options[:text] || I18n.t(options[:calculated_path]+'.text', :default => {})
+      if (text.nil? or text.is_a?(Hash)) 
+        nil
+      else
+        text
+      end
+    end
     def self.model_name(model)
       model = model.to_s.underscore
       if model =~ /^[a-z][a-z0-9_]*\[[a-z][a-z0-9_]*_attributes\]/
@@ -170,7 +220,7 @@ module ContextHelp
     def self.merge_options(base, added)
       if base.is_a?(Hash) and added.is_a?(Hash)
         added.each do |key,value|
-          base[key] = self.merge_options(base[key], value)
+          base[key.to_sym] = self.merge_options(base[key.to_sym], value)
         end
         return base
       else

data/lib/context_help/patches/form_helper_patch.rb

@@ -9,48 +9,55 @@ module ActionView
           object_name = ActionController::RecordIdentifier.singular_class_name(record_or_name_or_array)
         end
 
-        options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym} } }, args.last.is_a?(::Hash)? args.last : {})
+        options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym} } }, args.last.is_a?(::Hash)? args.last : {})
         help = ContextHelp::Base.help_for(options)
         help + fields_for_without_context_help_fields_for(record_or_name_or_array, *args, &block)
       end       
       def label_with_context_help_label(object_name, method, text = nil, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         ContextHelp::Base.help_for(help_options)
         link_to_help = ContextHelp::Base.link_to_help(help_options[:context_help])
-        label_without_context_help_label(object_name, method, text.to_s + link_to_help, options)
+        text = if text.blank?
+          i18n_label = I18n.t("helpers.label.#{object_name}.#{method}", :default => "")
+          i18n_label if i18n_label.present?
+        else
+          text.to_s
+        end
+        text ||= method.to_s.humanize
+        label_without_context_help_label(object_name, method, text.to_s + link_to_help, help_options)
       end
       def text_field_with_context_help_text_field(object_name, method, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         text_field_without_context_help_text_field(object_name, method, options) + help
       end
       def password_field_with_context_help_password_field(object_name, method, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         password_field_without_context_help_password_field(object_name, method, options) + help
       end
       def hidden_field_with_context_help_hidden_field(object_name, method, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         hidden_field_without_context_help_hidden_field(object_name, method, options) + help
       end
       def file_field_with_context_help_file_field(object_name, method, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         file_field_without_context_help_file_field(object_name, method, options) + help
       end
       def text_area_with_context_help_text_area(object_name, method, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         text_area_without_context_help_text_area(object_name, method, options) + help
       end
       def check_box_with_context_help_check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         check_box_without_context_help_check_box(object_name, method, options, checked_value, unchecked_value) + help
       end
       def radio_button_with_context_help_radio_button(object_name, method, tag_value, options = {})
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => object_name.to_sym, :attribute=> method.to_sym}}}, options)
         help = ContextHelp::Base.help_for(help_options)
         radio_button_without_context_help_radio_button(object_name, method, tag_value, options) +help
       end

data/lib/context_help/patches/form_tag_helper_patch.rb

@@ -0,0 +1,20 @@
+module ActionView
+  module Helpers
+    module FormTagHelper
+      def form_tag_with_context_help_form_tag(url_for_options = {}, options = {}, *parameters_for_url, &block)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:tag => :form, :tag_options => options}}}, options)
+        ContextHelp::Base.help_for(help_options)
+        form_tag_without_context_help_form_tag(url_for_options, options, *parameters_for_url, &block)        
+      end
+      def label_tag_with_context_help_label_tag(name, text = nil, options = {})
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:tag => :label, :tag_options => options}}}, options)
+        text ||= name.to_s.humanize
+        text = text + ContextHelp::Base.help_for(help_options)
+        label_tag_without_context_help_label_tag name, text, help_options
+      end
+      
+      alias_method_chain :form_tag, :context_help_form_tag
+      alias_method_chain :label_tag, :context_help_label_tag
+    end
+  end
+end

data/lib/context_help/patches/formtastic_patch.rb

@@ -3,14 +3,19 @@ module ContextHelp
     def inputs(*args, &block)
       title = field_set_title_from_args(*args)
       html_options = args.extract_options!
-      help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:tag => 'fieldset', :tag_options => html_options}}}, html_options)
+      help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:tag => 'fieldset', :tag_options => html_options}}}, html_options)
       help_options[:context_help][:title] = title if help_options[:context_help][:path][:tag]
       help = ContextHelp::Base.help_for(help_options)
       super *(args<<help_options), &block
     end
     def input(method, options = {})   
-      options = ContextHelp::Base.merge_options({:context_help => {:path => {:model => model_name.to_sym, :attribute=> method.to_sym}}}, options || {})
-      html = super
+      options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:model => model_name.to_sym, :attribute=> method.to_sym}}}, options || {})
+      super
+    end
+    def radio_input(method, options)
+      options[:label] = localized_string(method, options[:label], :label) || humanized_attribute_name(method)
+      ContextHelp::Base.help_for(options) 
+      super
     end
     def legend_tag(method, options = {})
       if options[:label] == false
@@ -19,8 +24,7 @@ module ContextHelp
         text = localized_string(method, options[:label], :label) || humanized_attribute_name(method)
         text += required_or_optional_string(options.delete(:required))
         text = Formtastic::Util.html_safe(text)
-        text += ContextHelp::Base.link_to_help(options[:context_help])
-        template.content_tag :legend, template.label_tag(nil, text, :for => nil), :class => :label
+        template.content_tag :legend, template.label_tag(nil, text, options), :class => :label
       end
     end
   end

data/lib/context_help/patches/tag_helper_patch.rb

@@ -2,14 +2,16 @@ module ActionView
   module Helpers
     module TagHelper
       def tag_with_context_help_tag(name, options = {}, open = false, escape = true)
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:tag => name.to_sym, :tag_options => options}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:tag => name.to_sym, :tag_options => options}}}, options)
         help = ContextHelp::Base.help_for(help_options)
+        options.delete('context_help')
         tag_without_context_help_tag(name, options, open, escape) + help
       end
       def content_tag_with_context_help_content_tag(name, content_or_options_with_block = nil, options = {}, escape = true, &block)
-        help_options = ContextHelp::Base.merge_options({:context_help => {:path => {:tag => name.to_sym, :tag_options => options}}}, options)
+        help_options = ContextHelp::Helpers.merge_options({:context_help => {:path => {:tag => name.to_sym, :tag_options => options}}}, options)
         help = ContextHelp::Base.help_for(help_options)
-        html = content_tag_without_context_help_content_tag(name, content_or_options_with_block, options, escape, &block) + help
+        options.delete('context_help')
+        content_tag_without_context_help_content_tag(name, content_or_options_with_block, options, escape, &block) + help
       end
 
       alias_method_chain :tag, :context_help_tag

data/lib/context_help/version.rb

@@ -1,3 +1,3 @@
 module ContextHelp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/context_help.rb

@@ -1,3 +1,4 @@
+require 'context_help/patches/form_tag_helper_patch'
 require 'context_help/patches/tag_helper_patch'
 require 'context_help/patches/form_helper_patch'
 require 'context_help/patches/formtastic_patch'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: context_help
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000 -03:00
+date: 2011-08-15 00:00:00.000000000 -03:00
 default_executable: 
 dependencies: []
 description: ContextHelp is a gem that allows you to show inline or aside help about
@@ -29,6 +29,7 @@ files:
 - lib/context_help.rb
 - lib/context_help/base.rb
 - lib/context_help/patches/form_helper_patch.rb
+- lib/context_help/patches/form_tag_helper_patch.rb
 - lib/context_help/patches/formtastic_patch.rb
 - lib/context_help/patches/tag_helper_patch.rb
 - lib/context_help/version.rb