padrino-helpers 0.11.3 → 0.11.4

data/lib/padrino-helpers/number_helpers.rb

@@ -29,7 +29,7 @@ module Padrino
       #     %u  The currency unit
       #     %n  The number
       #
-      # @return [String] The formatted representation of the currency
+      # @return [String] The formatted representation of the currency.
       #
       # @example
       #   number_to_currency(1234567890.50)                    # => $1,234,567,890.50
@@ -40,7 +40,6 @@ module Padrino
       #   number_to_currency(1234567890.50, :unit => "£", :separator => ",", :delimiter => "", :format => "%n %u")
       #   # => 1234567890,50 £
       #
-      # @api public
       def number_to_currency(number, options = {})
         options.symbolize_keys!
 
@@ -79,7 +78,7 @@ module Padrino
       # @option options [String] :separator (".")
       #   Sets the separator between the units.
       # @option options [String] :delimiter ("")
-      #   Sets the thousands delimiter
+      #   Sets the thousands delimiter.
       #
       # @return [String] The formatted representation of the percentage
       #
@@ -89,7 +88,6 @@ module Padrino
       #   number_to_percentage(1000, :delimiter => '.', :separator => ',') # => 1.000,000%
       #   number_to_percentage(302.24398923423, :precision => 5)           # => 302.24399%
       #
-      # @api public
       def number_to_percentage(number, options = {})
         options.symbolize_keys!
 
@@ -121,11 +119,11 @@ module Padrino
       #   @param [Hash] options
       #     Options for formatter.
       #   @option options [String] :delimiter (", ")
-      #     Sets the thousands delimiter
+      #     Sets the thousands delimiter.
       #   @option options [String] :separator (".")
       #     Sets the separator between the units.
       #
-      # @return [String] The formatted representation of the number
+      # @return [String] The formatted representation of the number.
       #
       # @example
       #   number_with_delimiter(12345678)                        # => 12,345,678
@@ -135,7 +133,6 @@ module Padrino
       #   number_with_delimiter(98765432.98, :delimiter => " ", :separator => ",")
       #   # => 98 765 432,98
       #
-      # @api public
       def number_with_delimiter(number, *args)
         options = args.extract_options!
         options.symbolize_keys!
@@ -168,9 +165,9 @@ module Padrino
       #   @option options [String] :separator (".")
       #     Sets the separator between the units.
       #   @option options [String] :delimiter ("")
-      #     Sets the thousands delimiter
+      #     Sets the thousands delimiter.
       #
-      # @return [String] The formatted representation of the number
+      # @return [String] The formatted representation of the number.
       #
       # @example
       #   number_with_precision(111.2345)                    # => 111.235
@@ -180,7 +177,6 @@ module Padrino
       #   number_with_precision(1111.2345, :precision => 2, :separator => ',', :delimiter => '.')
       #   # => 1.111,23
       #
-      # @api public
       def number_with_precision(number, *args)
         options = args.extract_options!
         options.symbolize_keys!
@@ -225,7 +221,7 @@ module Padrino
       #   @option options [String] :separator (".")
       #     Sets the separator between the units.
       #   @option options [String] :delimiter ("")
-      #     Sets the thousands delimiter
+      #     Sets the thousands delimiter.
       #
       # @return [String] The formatted representation of bytes
       #
@@ -240,7 +236,6 @@ module Padrino
       #   number_to_human_size(483989, :precision => 0)                      # => 473 KB
       #   number_to_human_size(1234567, :precision => 2, :separator => ',')  # => 1,18 MB
       #
-      # @api public
       def number_to_human_size(number, *args)
         return nil if number.nil?
 
@@ -283,6 +278,6 @@ module Padrino
           end
         end
       end
-    end # NumberHelpers
-  end # Helpers
-end # Padrino
+    end
+  end
+end

data/lib/padrino-helpers/output_helpers.rb

@@ -1,21 +1,20 @@
 module Padrino
   module Helpers
-    ###
+    ##
     # Helpers related to buffer output for various template engines.
     #
     module OutputHelpers
-
-      def self.included(base) # @private
+      def self.included(base)
         base.send(:include, SinatraCurrentEngine) unless base.method_defined?(:current_engine)
       end
 
       ##
-      # Module used to detect the current engine in vanilla sinatra apps.
-      # @private
+      # Module used to detect the current engine in vanilla Sinatra apps.
+      #
       module SinatraCurrentEngine
         attr_reader :current_engine
 
-        def render(engine, *) # @private
+        def render(engine, *)
           @current_engine, engine_was = engine, @current_engine
           output = super
           @current_engine = engine_was
@@ -29,11 +28,11 @@ module Padrino
       # Be aware that trusting the html is up to the caller.
       #
       # @param [Object] *args
-      #   Objects yield to the captured block
+      #   Objects yield to the captured block.
       # @param [Proc] &block
-      #   Template code to capture as html
+      #   Template code to capture as HTML.
       #
-      # @return [String] Captured html resulting from the block
+      # @return [String] Captured HTML resulting from the block.
       #
       # @example
       #   capture_html(&block) => "...html..."
@@ -45,7 +44,6 @@ module Padrino
       #   ActiveSupport::SafeBuffer.new.safe_concat(capture_html { "<foo>" })
       #   # => "<foo>"
       #
-      # @api semipublic
       def capture_html(*args, &block)
         handler = find_proper_handler
         captured_block, captured_html = nil, ""
@@ -63,13 +61,12 @@ module Padrino
       #
       # The output might be subject to escaping, if it is not marked as safe.
       #
-      # @param [String,SafeBuffer] text
+      # @param [String, SafeBuffer] text
       #   Text to concatenate to the buffer.
       #
       # @example
       #   concat_content("This will be output to the template buffer")
       #
-      # @api semipublic
       def concat_content(text="")
         handler = find_proper_handler
         if handler && handler.is_type?
@@ -90,7 +87,6 @@ module Padrino
       # @example
       #   concat_safe_content("This will be output to the template buffer")
       #
-      # @api semipublic
       def concat_safe_content(text="")
         concat_content text.html_safe
       end
@@ -107,7 +103,6 @@ module Padrino
       #
       # @return [Boolean] True if the block is a template; false otherwise.
       #
-      # @api semipublic
       def block_is_template?(block)
         handler = find_proper_handler
         block && handler && handler.block_is_type?(block)
@@ -115,7 +110,7 @@ module Padrino
 
       ##
       # Capture a block or text of content to be rendered at a later time.
-      # Your blocks can also receive values, which are passed to them by <tt>yield_content</tt>
+      # Your blocks can also receive values, which are passed to them by <tt>yield_content</tt>.
       #
       # @overload content_for(key, content)
       #   @param [Symbol] key      Name of your key for the content yield.
@@ -129,7 +124,6 @@ module Padrino
       #   content_for(:name) { |name| ...content... }
       #   content_for(:name, "I'm Jeff")
       #
-      # @api public
       def content_for(key, content = nil, &block)
         content_blocks[key.to_sym] << (block_given? ? block : Proc.new { content })
       end
@@ -138,14 +132,13 @@ module Padrino
       # Is there a content block for a given key?
       #
       # @param [Symbol] key
-      #   Name of content to yield
+      #   Name of content to yield.
       #
       # @return [TrueClass,FalseClass] Result html for the given +key+
       #
       # @example
       #   content_for? :header => true
       #
-      # @api public
       def content_for?(key)
         content_blocks[key.to_sym].present?
       end
@@ -156,18 +149,17 @@ module Padrino
       # as arguments after the key.
       #
       # @param [Symbol] key
-      #   Name of content to yield
+      #   Name of content to yield.
       # @param *args
-      #   Values to pass to the content block
+      #   Values to pass to the content block.
       #
-      # @return [String] Result html for the given +key+
+      # @return [String] Result HTML for the given +key+.
       #
       # @example
       #   yield_content :include
       #   yield_content :head, "param1", "param2"
       #   yield_content(:title) || "My page title"
       #
-      # @api public
       def yield_content(key, *args)
         blocks = content_blocks[key.to_sym]
         return nil if blocks.empty?
@@ -175,41 +167,41 @@ module Padrino
       end
 
       protected
-        ##
-        # Retrieves content_blocks stored by content_for or within yield_content
-        #
-        # @example
-        #   content_blocks[:name] => ['...', '...']
-        #
-        def content_blocks
-          @content_blocks ||= Hash.new { |h,k| h[k] = [] }
-        end
+      ##
+      # Retrieves content_blocks stored by content_for or within yield_content.
+      #
+      # @example
+      #   content_blocks[:name] => ['...', '...']
+      #
+      def content_blocks
+        @content_blocks ||= Hash.new { |h,k| h[k] = [] }
+      end
 
-        ##
-        # Retrieves the template handler for the given output context.
-        # Can handle any output related to capturing or concating in a given template.
-        #
-        # @example
-        #   find_proper_handler => <OutputHelpers::HamlHandler>
-        #
-        def find_proper_handler
-          OutputHelpers.handlers.map { |h| h.new(self) }.find { |h| h.engines.include?(current_engine) && h.is_type? }
-        end
+      ##
+      # Retrieves the template handler for the given output context.
+      # Can handle any output related to capturing or concatenating in a given template.
+      #
+      # @example
+      #   find_proper_handler => <OutputHelpers::HamlHandler>
+      #
+      def find_proper_handler
+        OutputHelpers.handlers.map { |h| h.new(self) }.find { |h| h.engines.include?(current_engine) && h.is_type? }
+      end
 
-        ##
-        # Marks a String or a collection of Strings as safe. `nil` is accepted
-        # but ignored.
-        #
-        # @param [String, Array<String>] the values to be marked safe.
-        #
-        # @return [ActiveSupport::SafeBuffer, Array<ActiveSupport::SafeBuffer>]
-        def mark_safe(value)
-          if value.respond_to? :map!
-            value.map!{|v| v.html_safe if v }
-          else
-            value.html_safe if value
-          end
+      ##
+      # Marks a String or a collection of Strings as safe. `nil` is accepted
+      # but ignored.
+      #
+      # @param [String, Array<String>] the values to be marked safe.
+      #
+      # @return [ActiveSupport::SafeBuffer, Array<ActiveSupport::SafeBuffer>]
+      def mark_safe(value)
+        if value.respond_to? :map!
+          value.map!{|v| v.html_safe if v }
+        else
+          value.html_safe if value
         end
-    end # OutputHelpers
-  end # Helpers
-end # Padrino
+      end
+    end
+  end
+end

data/lib/padrino-helpers/output_helpers/abstract_handler.rb

@@ -2,28 +2,26 @@ module Padrino
   module Helpers
     module OutputHelpers
       ##
-      # Returns the list of all available template handlers
+      # Returns the list of all available template handlers.
       #
       # @example
       #   OutputHelpers.handlers => [<OutputHelpers::HamlHandler>, <OutputHelpers::ErbHandler>]
       #
-      # @private
       def self.handlers
         @_template_handlers ||= []
       end
 
       ##
-      # Registers a new handler as available to the output helpers
+      # Registers a new handler as available to the output helpers.
       #
       # @example
       #   OutputHelpers.register(OutputHelpers::HamlHandler)
       #
-      # @private
       def self.register(handler)
         handlers << handler
       end
 
-      # @abstract Extend this to create a template handler
+      # @abstract Extend this to create a template handler.
       class AbstractHandler
         attr_reader :template
 
@@ -32,7 +30,7 @@ module Padrino
         end
 
         ##
-        # Returns extension of the template
+        # Returns extension of the template.
         #
         # @example
         #   @handler.template_extension => "erb"
@@ -44,13 +42,13 @@ module Padrino
         end
 
         ##
-        # Returns an array of engines used for the template
+        # Returns an array of engines used for the template.
         #
         # @example
         #   @handler.engines => [:erb, :erubis]
         #
         def engines
-          # Implemented in subclass
+          # Implemented in subclass.
         end
 
         ##
@@ -60,7 +58,7 @@ module Padrino
         #   @handler.is_type? => true
         #
         def is_type?
-          # Implemented in subclass
+          # Implemented in subclass.
         end
 
         ##
@@ -70,29 +68,29 @@ module Padrino
         #   @handler.block_is_type?(block) => true
         #
         def block_is_type?(block)
-          # Implemented in subclass
+          # Implemented in subclass.
         end
 
         ##
-        # Captures the html from a block of template code for this handler
+        # Captures the html from a block of template code for this handler.
         #
         # @example
         #   @handler.capture_from_template(&block) => "...html..."
         #
         def capture_from_template(*args, &block)
-          # Implemented in subclass
+          # Implemented in subclass.
         end
 
         ##
-        # Outputs the given text to the templates buffer directly
+        # Outputs the given text to the templates buffer directly.
         #
         # @example
         #   @handler.concat_to_template("This will be output to the template buffer")
         #
         def concat_to_template(text="")
-          # Implemented in subclass
+          # Implemented in subclass.
         end
-      end # AbstractHandler
-    end # OutputHelpers
-  end # Helpers
-end # Padrino
+      end
+    end
+  end
+end

data/lib/padrino-helpers/output_helpers/erb_handler.rb

@@ -22,7 +22,8 @@ module Padrino
           !self.output_buffer.nil?
         end
 
-        # Captures the html from a block of template code for this handler
+        ##
+        # Captures the html from a block of template code for this handler.
         #
         # @example
         #   @handler.capture_from_template(&block) => "...html..."
@@ -36,7 +37,7 @@ module Padrino
         end
 
         ##
-        # Outputs the given text to the templates buffer directly
+        # Outputs the given text to the templates buffer directly.
         #
         # @example
         #   @handler.concat_to_template("This will be output to the template buffer")
@@ -57,7 +58,7 @@ module Padrino
         end
 
         ##
-        # Returns an array of engines used for the template
+        # Returns an array of engines used for the template.
         #
         # @example
         #   @handler.engines => [:erb, :erubis]
@@ -67,13 +68,11 @@ module Padrino
         end
 
         protected
-
-          def output_buffer=(val)
-            template.instance_variable_set(:@_out_buf, val)
-          end
-      end # ErbHandler
-
+        def output_buffer=(val)
+          template.instance_variable_set(:@_out_buf, val)
+        end
+      end
       OutputHelpers.register(ErbHandler)
-    end # OutputHelpers
-  end # Helpers
-end # Padrino
+    end
+  end
+end