lotus-helpers 0.1.0 → 0.2.0

data/lib/lotus/helpers/form_helper/html_node.rb

@@ -0,0 +1,79 @@
+require 'lotus/helpers/html_helper/html_node'
+
+module Lotus
+  module Helpers
+    module FormHelper
+      # HTML form node
+      #
+      # @since x.x.x
+      # @api private
+      #
+      # @see Lotus::Helpers::HtmlHelper::HtmlNode
+      class HtmlNode < ::Lotus::Helpers::HtmlHelper::HtmlNode
+        # Initialize a new HTML form node
+        #
+        # @param name [Symbol,String] the name of the tag
+        # @param content [String,Proc,Lotus::Helpers::HtmlHelper::FormBuilder,NilClass] the optional content
+        # @param attributes [Hash,NilClass] the optional tag attributes
+        # @param options [Hash] a set of data
+        #
+        # @return [Lotus::Helpers::FormHelper::HtmlNode]
+        #
+        # @since x.x.x
+        # @api private
+        def initialize(name, content, attributes, options)
+          super
+
+          @verb       = options.fetch(:verb,       nil)
+          @csrf_token = options.fetch(:csrf_token, nil)
+
+          @builder = FormBuilder.new(
+            options.fetch(:name),
+            options.fetch(:values)
+          )
+        end
+
+        private
+        # Resolve the (nested) content
+        #
+        # @return [String] the content
+        #
+        # @since x.x.x
+        # @api private
+        #
+        # @see Lotus::Helpers::HtmlHelper::HtmlNode#content
+        def content
+          _method_override!
+          _csrf_protection!
+          super
+        end
+
+        # Inject a hidden field to make Method Override possible
+        #
+        # @since x.x.x
+        # @api private
+        def _method_override!
+          return if @verb.nil?
+
+          verb = @verb
+          @builder.resolve do
+            input(type: :hidden, name: :_method, value: verb)
+          end
+        end
+
+        # Inject a hidden field for CSRF Protection token
+        #
+        # @since x.x.x
+        # @api private
+        def _csrf_protection!
+          return if @csrf_token.nil?
+
+          _csrf_token = @csrf_token
+          @builder.resolve do
+            input(type: :hidden, name: FormHelper::CSRF_TOKEN, value: _csrf_token)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/helpers/form_helper/values.rb

@@ -0,0 +1,38 @@
+require 'lotus/utils/hash'
+
+module Lotus
+  module Helpers
+    module FormHelper
+      class Values
+        GET_SEPARATOR = '.'.freeze
+
+        def initialize(values, params)
+          @values = Utils::Hash.new(values).stringify!
+          @params = params
+        end
+
+        def get(key)
+          @params.get(key) || _get_from_values(key)
+        end
+
+        private
+        def _get_from_values(key)
+          initial_key, *keys = key.to_s.split(GET_SEPARATOR)
+          result             = @values[initial_key]
+
+          Array(keys).each do |k|
+            break if result.nil?
+
+            result = if result.respond_to?(k)
+              result.public_send(k)
+            else
+              nil
+            end
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/lotus/helpers/html_helper.rb

@@ -81,7 +81,7 @@ module Lotus
     #     input type: 'submit', value: 'Save changes'
     #   end
     #   # =>
-    #   #<form action="/users" method="POST">
+    #   #<form action="/users" method="POST" accept-charset="utf-8">
     #   #  <div>
     #   #    <label for="user-first-name">First name</label>
     #   #    <input type="text" id="user-first-name" name="user[first_name]" value="L">

data/lib/lotus/helpers/html_helper/html_builder.rb

@@ -1,4 +1,5 @@
 require 'lotus/utils' # RUBY_VERSION >= '2.2'
+require 'lotus/utils/class_attribute'
 require 'lotus/utils/escape'
 require 'lotus/helpers/html_helper/empty_html_node'
 require 'lotus/helpers/html_helper/html_node'
@@ -149,7 +150,7 @@ module Lotus
         CONTENT_TAGS.each do |tag|
           class_eval %{
             def #{ tag }(content = nil, attributes = nil, &blk)
-              @nodes << HtmlNode.new(:#{ tag }, blk || content, attributes || content)
+              @nodes << self.class.html_node.new(:#{ tag }, blk || content, attributes || content, options)
               self
             end
           }
@@ -164,6 +165,11 @@ module Lotus
           }
         end
 
+        include Utils::ClassAttribute
+
+        class_attribute :html_node
+        self.html_node = ::Lotus::Helpers::HtmlHelper::HtmlNode
+
         # Initialize a new builder
         #
         # @return [Lotus::Helpers::HtmlHelper::HtmlBuilder] the builder
@@ -174,6 +180,9 @@ module Lotus
           @nodes = []
         end
 
+        def options
+        end
+
         # Define a custom tag
         #
         # @param name [Symbol,String] the name of the tag
@@ -217,7 +226,7 @@ module Lotus
         #   #  hello
         #   #</custom>
         def tag(name, content = nil, attributes = nil, &blk)
-          @nodes << HtmlNode.new(name, blk || content, attributes || content)
+          @nodes << HtmlNode.new(name, blk || content, attributes || content, options)
           self
         end
 

data/lib/lotus/helpers/html_helper/html_node.rb

@@ -15,9 +15,10 @@ module Lotus
         # @param name [Symbol,String] the name of the tag
         # @param content [String,Proc,Lotus::Helpers::HtmlHelper::HtmlBuilder,NilClass] the optional content
         # @param attributes [Hash,NilClass] the optional tag attributes
+        # @param options [Hash] a optional set of data
         #
         # @return [Lotus::Helpers::HtmlHelper::HtmlNode]
-        def initialize(name, content, attributes)
+        def initialize(name, content, attributes, options = {})
           @builder = HtmlBuilder.new
           @name    = name
           @content = case content

data/lib/lotus/helpers/link_to_helper.rb

@@ -0,0 +1,28 @@
+require 'lotus/helpers/html_helper'
+
+module Lotus
+  module Helpers
+    # LinkTo Helper
+    #
+    # Including <tt>Lotus::Helpers::LinkTo</tt> will include the `link_to` method.
+    #
+    # @since x.x.x
+    #
+    # @see Lotus::Helpers::HtmlHelper#html
+    #
+    # @example Usage
+    #   # 1
+    #   link_to('home', '/') # => <a href="/">home</a>
+    #
+    #   # 2
+    #   link_to('users', :users_path, class: 'my_users') # => <a href="/users" class="my_users">users</div>
+    module LinkToHelper
+      include Lotus::Helpers::HtmlHelper
+
+      def link_to(content, url, options = {}, &blk)
+        options[:href] = url
+        html.a(blk || content, options).to_s
+      end
+    end
+  end
+end

data/lib/lotus/helpers/number_formatting_helper.rb

@@ -0,0 +1,220 @@
+module Lotus
+  module Helpers
+    # Number formatter
+    #
+    # You can include this module inside your view and
+    # the view will have access all methods.
+    #
+    # By including <tt>Lotus::Helpers::NumberFormattingHelper</tt> it will
+    # inject private method: <tt>format_number</tt>.
+    #
+    # @since x.x.x
+    module NumberFormattingHelper
+      private
+      # Format the given number, according to the options
+      #
+      # It accepts a number (<tt>Numeric</tt>) or a string representation.
+      #
+      # If an integer is given, no precision is applied.
+      # For the rest of the numbers, it will format as a float representation.
+      # This is the case of: <tt>Float</tt>, <tt>BigDecimal</tt>,
+      # <tt>Complex</tt>, <tt>Rational</tt>.
+      #
+      # If the argument cannot be coerced into a number, it will raise a
+      # <tt>TypeError</tt>.
+      #
+      # @param number [Numeric,String] the number to be formatted
+      #
+      # @return [String] formatted number
+      #
+      # @raise [TypeError] if number can't be formatted
+      #
+      # @since x.x.x
+      #
+      # @example
+      #   require 'lotus/helpers/number_formatter_helper'
+      #
+      #   class Checkout
+      #     include Lotus::Helpers::NumberFormattingHelper
+      #
+      #     def total
+      #       format_number 1999.99
+      #     end
+      #
+      #     def euros
+      #       format_number 1256.95, delimiter: '.', separator: ','
+      #     end
+      #
+      #     def visitors_count
+      #       format_number '1000'
+      #     end
+      #   end
+      #
+      #   view = Checkout.new
+      #
+      #   view.total
+      #     # => "1,999.99"
+      #
+      #   view.euros
+      #     # => "1.256,95"
+      #
+      #   view.visitors_count
+      #     # => "1,000"
+      def format_number(number, options = {})
+        Formatter.new(number, options).format
+      end
+
+      # Formatter
+      #
+      # @since x.x.x
+      # @api private
+      class Formatter
+        # Regex to delimitate integer part of a number
+        #
+        # @return [Regexp] the delimitation regex
+        #
+        # @since x.x.x
+        # @api private
+        #
+        # @see Lotus::Helpers::NumberFormatter::Formatter#delimitate
+        DELIMITATION_REGEX = /(\d)(?=(\d{3})+$)/
+
+        # Regex to guess if the number is a integer
+        #
+        # @return [Regexp] the guessing regex
+        #
+        # @since x.x.x
+        # @api private
+        #
+        # @see Lotus::Helpers::NumberFormatter::Formatter#to_number
+        INTEGER_REGEXP     = /\A[\d]+\z/
+
+        # Default separator
+        #
+        # @return [String] default separator
+        #
+        # @since x.x.x
+        # @api private
+        DEFAULT_SEPARATOR  = '.'.freeze
+
+        # Default delimiter
+        #
+        # @return [String] default delimiter
+        #
+        # @since x.x.x
+        # @api private
+        DEFAULT_DELIMITER  = ','.freeze
+
+        # Default precision
+        #
+        # @return [String] default precision
+        #
+        # @since x.x.x
+        # @api private
+        DEFAULT_PRECISION  = 2
+
+        # Initialize a new formatter
+        #
+        # @param number [Numeric,String] the number to format
+        # @param options [Hash] options for number formatting
+        # @option options [String] :delimiter hundred delimiter
+        # @option options [String] :separator fractional part delimiter
+        # @option options [Integer] :precision rounding precision
+        #
+        # @since x.x.x
+        # @api private
+        #
+        # @see Lotus::Helpers::NumberFormatter::Formatter::DEFAULT_DELIMITER
+        # @see Lotus::Helpers::NumberFormatter::Formatter::DEFAULT_SEPARATOR
+        # @see Lotus::Helpers::NumberFormatter::Formatter::DEFAULT_PRECISION
+        def initialize(number, options)
+          @number = number
+          @delimiter = options.fetch(:delimiter, DEFAULT_DELIMITER)
+          @separator = options.fetch(:separator, DEFAULT_SEPARATOR)
+          @precision = options.fetch(:precision, DEFAULT_PRECISION)
+        end
+
+        # Format number according to the specified options
+        #
+        # @return [String] formatted number
+        #
+        # @raise [TypeError] if number can't be formatted
+        #
+        # @since x.x.x
+        # @api private
+        def format
+          parts.join(@separator)
+        end
+
+        private
+
+        # Return integer and fractional parts
+        #
+        # @return [Array] parts
+        #
+        # @since x.x.x
+        # @api private
+        def parts
+          integer_part, fractional_part = to_str.split(DEFAULT_SEPARATOR)
+          [delimitate(integer_part), fractional_part].compact
+        end
+
+        # Delimitate the given part
+        #
+        # @return [String] delimitated string
+        #
+        # @since x.x.x
+        # @api private
+        def delimitate(part)
+          part.gsub(DELIMITATION_REGEX) { |digit| "#{digit}#{@delimiter}" }
+        end
+
+        # String coercion
+        #
+        # @return [String] coerced number
+        #
+        # @raise [TypeError] if number can't be formatted
+        #
+        # @since x.x.x
+        # @api private
+        def to_str
+          to_number.to_s
+        end
+
+        # Numeric coercion
+        #
+        # @return [Numeric] coerced number
+        #
+        # @raise [TypeError] if number can't be formatted
+        #
+        # @since x.x.x
+        # @api private
+        def to_number
+          case @number
+          when NilClass
+            raise TypeError
+          when ->(n) { n.to_s.match(INTEGER_REGEXP) }
+            Utils::Kernel.Integer(@number)
+          else
+            Utils::Kernel.Float(rounded_number)
+          end
+        end
+
+        # Round number in case we need to return a <tt>Float</tt> representation.
+        # If <tt>@number</tt> doesn't respond to <tt>#round</tt> return the number as it is.
+        #
+        # @return [Float,Complex,Rational,BigDecimal] rounded number, if applicable
+        #
+        # @since x.x.x
+        # @api private
+        def rounded_number
+          if @number.respond_to?(:round)
+            @number.round(@precision)
+          else
+            @number
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/helpers/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Define version
     #
     # @since 0.1.0
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/lotus-helpers.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'lotus-utils', '~> 0.4'
+  spec.add_dependency 'lotus-utils', '~> 0.5'
 
   spec.add_development_dependency 'bundler',  '~> 1.6'
   spec.add_development_dependency 'rake',     '~> 10.0'