lotus-helpers 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30f2cf703b4746c9bd13c43eb4f7e8d080251dd2
-  data.tar.gz: 78149500f0aefbcd5748f5184d5927cbc3e524e1
+  metadata.gz: d83c162dc06d805a23d1266f8898ef9dbfaf1527
+  data.tar.gz: d2c072bfbcb73f392862e8614f3ac1c7ecf739a8
 SHA512:
-  metadata.gz: 903e02d8560775ebae4c3801cd263d7477766065bf31936e845c245c4a1d526093b2375e7900e5244522b2e9aaafc7c4f84c47cb9f8c1c4fa38b15bb2019a5dc
-  data.tar.gz: 3e840682aef29d505b238de7085cb6703ae31dff639c8b31b04064f4498a5d87f553fe09ae302cd2419d45bfaa8fffa15d7016425f3c24291e3f83b5e9310c34
+  metadata.gz: 46166d61c7fe8ae7c7b13cbc98c55ae830f836970f93247559c0045dcca7827fd71ea32fbac75482a8c9b362ae56e6e84f9e75359634f5c747b446df390e83df
+  data.tar.gz: 9b932b774eb95ed64c2e6c4779cfaf37a4861cce5121f55c9b29114809bfb748b43dcfa36ffe13dea19d59a3ff80f175720c57f9070cf2ff865c1af55720367b

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Lotus::Helpers
+View helpers for Ruby web applications
+
+## v0.2.6 - 2016-01-12
+### Added
+- [Cam Huynh] Added support for HTML helper (`#html`) block syntax (eg. `html { div('hello') }`)
+- [Shin-ichi Ueda] Added support for `<dd>` HTML tag
+
+### Fixed
+- [Rodrigo Panachi] Don't generate CSRF token hidden input for forms with `GET` method
+
+## v0.2.5 - 2015-09-30
+### Added
+- [Leonardo Saraiva] Improved support for HTML content in `#link_to` helper. It now accepts blocks to build markup inside an anchor tag.
+- [José Mota] Added `#text` to the form builder
+- [Alex Wochna] Added `#number_field` to the form builder
+- [Scott Le] Added `#text_area` to the form builder
+
+### Fixed
+- [Pascal Betz] Ensure boolean attributes in HTML forms to not be printed if their value is `nil` (eg. avoid to print `disabled=""`).
+
+### Changed
+- [Luca Guidi] Form `#label` helper outputs capitalized strings, instead of titleized (eg. `"Remember me"` instead of `"Remember Me"`).
+
+## v0.2.0 - 2015-06-23
+### Added
+- [Luca Guidi] Introduced `Lotus::Helpers::FormHelper`. HTML5 form generator (`#form_for`).
+- [Tom Kadwill & Luca Guidi] Introduced `Lotus::Helpers::NumberFormattingHelper`. Format numbers (`#format_number`).
+- [Tom Kadwill] Introduced `Lotus::Helpers::LinkToHelper`. Link helper (`#link_to`).
+
+## v0.1.0 - 2015-03-23
+### Added
+- [Luca Guidi] Introduced `Lotus::Helpers::RoutingHelper`. It exposes `#routes` in views for compatibility with Lotus (`lotusrb` gem)
+- [Alfonso Uceda Pompa] Introduced `Lotus::Helpers::EscapeHelper`. It implements OWASP/ESAPI suggestions for HTML, HTML attribute and URL escape helpers.
+- [Luca Guidi] Introduced `Lotus::Helpers::HtmlHelper`. It allows to generate complex HTML5 markup with Ruby.

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Luca Guidi
+Copyright (c) 2014-2016 Luca Guidi
 
 MIT License
 

data/README.md

@@ -384,4 +384,4 @@ __Lotus::Helpers__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2015 Luca Guidi – Released under MIT License
+Copyright © 2014-2016 Luca Guidi – Released under MIT License

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

@@ -18,6 +18,12 @@ module Lotus
         # @api private
         BROWSER_METHODS = ['GET', 'POST'].freeze
 
+        # Set of HTTP methods that should NOT generate CSRF token
+        #
+        # @since 0.2.0
+        # @api private
+        EXCLUDED_CSRF_METHODS = ['GET'].freeze
+
         # Checked attribute value
         #
         # @since 0.2.0
@@ -106,15 +112,16 @@ module Lotus
 
           # Nested form
           if @context.nil? && attributes.is_a?(Values)
-            @values     = attributes
-            @attributes = {}
-            @name       = form
+            @values      = attributes
+            @attributes  = {}
+            @name        = form
           else
-            @form       = form
-            @name       = form.name
-            @values     = Values.new(form.values, @context.params)
-            @attributes = attributes
-            @csrf_token = csrf_token
+            @form        = form
+            @name        = form.name
+            @values      = Values.new(form.values, @context.params)
+            @attributes  = attributes
+            @verb_method = verb_method
+            @csrf_token  = csrf_token
           end
         end
 
@@ -792,22 +799,27 @@ module Lotus
         # @api private
         # @since 0.2.0
         def _method_override!
-          verb = (@attributes.fetch(:method) { DEFAULT_METHOD }).to_s.upcase
-
-          if BROWSER_METHODS.include?(verb)
-            @attributes[:method] = verb
+          if BROWSER_METHODS.include?(@verb_method)
+            @attributes[:method] = @verb_method
           else
             @attributes[:method] = DEFAULT_METHOD
-            @verb                = verb
+            @verb                = @verb_method
           end
         end
 
+        # Return the method from attributes
+        #
+        # @api private
+        def verb_method
+          (@attributes.fetch(:method) { DEFAULT_METHOD }).to_s.upcase
+        end
+
         # Return CSRF Protection token from view context
         #
         # @api private
         # @since 0.2.0
         def csrf_token
-          @context.csrf_token if @context.respond_to?(:csrf_token)
+          @context.csrf_token if @context.respond_to?(:csrf_token) && !EXCLUDED_CSRF_METHODS.include?(@verb_method)
         end
 
         # Return a set of default HTML attributes

data/lib/lotus/helpers/html_helper.rb

@@ -65,6 +65,15 @@ module Lotus
     #   #  hello
     #   #</div>
     #
+    #   # 8
+    #   html do
+    #     li 'Hello'
+    #     li 'Lotus'
+    #   end
+    #   # =>
+    #   #<li>Hello</li>
+    #   #<li>Lotus</li>
+    #
     #
     #
     # @example Complex markup
@@ -178,14 +187,20 @@ module Lotus
       private
       # Instantiate an HTML builder
       #
+      # @param blk [Proc,Lotus::Helpers::HtmlHelper::HtmlBuilder,NilClass] the optional content block
+      #
       # @return [Lotus::Helpers::HtmlHelper::HtmlBuilder] the HTML builder
       #
       # @since 0.1.0
       #
       # @see Lotus::Helpers::HtmlHelper
       # @see Lotus::Helpers::HtmlHelper::HtmlBuilder
-      def html
-        HtmlBuilder.new
+      def html(&blk)
+        if block_given?
+          HtmlBuilder.new.fragment(&blk)
+        else
+          HtmlBuilder.new
+        end
       end
     end
   end

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

@@ -3,6 +3,7 @@ require 'lotus/utils/class_attribute'
 require 'lotus/utils/escape'
 require 'lotus/helpers/html_helper/empty_html_node'
 require 'lotus/helpers/html_helper/html_node'
+require 'lotus/helpers/html_helper/html_fragment'
 require 'lotus/helpers/html_helper/text_node'
 
 module Lotus
@@ -45,6 +46,7 @@ module Lotus
           'div',
           'dl',
           'dt',
+          'dd',
           'em',
           'fieldset',
           'figcaption',
@@ -231,6 +233,32 @@ module Lotus
           self
         end
 
+        # Define a HTML fragment
+        #
+        # @param blk [Proc] the optional nested content espressed as a block
+        #
+        # @return [self]
+        #
+        # @since 0.2.6
+        # @api public
+        #
+        # @see Lotus::Helpers::HtmlHelper
+        #
+        # @example
+        #   html.fragment('Lotus') # => Lotus
+        #
+        #   html do
+        #     p 'hello'
+        #     p 'lotus'
+        #   end
+        #   # =>
+        #     <p>hello</p>
+        #     <p>lotus</p>
+        def fragment(&blk)
+          @nodes << HtmlFragment.new(&blk)
+          self
+        end
+
         # Defines a custom empty tag
         #
         # @param name [Symbol,String] the name of the tag
@@ -296,6 +324,18 @@ module Lotus
           Utils::Escape::SafeString.new(@nodes.map(&:to_s).join(NEWLINE))
         end
 
+        # Encode the content with the given character encoding
+        #
+        # @param encoding [Encoding,String] the encoding or its string representation
+        #
+        # @return [String] the encoded string
+        #
+        # @since 0.2.5
+        # @api private
+        def encode(encoding)
+          to_s.encode(encoding)
+        end
+
         # Check if there are nested nodes
         #
         # @return [TrueClass,FalseClass] the result of the check

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

@@ -0,0 +1,45 @@
+module Lotus
+  module Helpers
+    module HtmlHelper
+      # HTML Fragment
+      #
+      # @since 0.2.6
+      # @api private
+      #
+      # @see Lotus::Helpers::HtmlHelper::HtmlFragment
+      class HtmlFragment
+        # Initialize a HTML Fragment
+        #
+        # @param blk [Proc,Lotus::Helpers::HtmlHelper::HtmlBuilder,NilClass] the content block
+        #
+        # @return [Lotus::Helpers::HtmlHelper::HtmlFragment]
+        def initialize(&blk)
+          @builder = HtmlBuilder.new
+          @blk = blk
+        end
+
+        # Resolve and return the output
+        #
+        # @return [String] the output
+        #
+        # @since 0.2.6
+        # @api private
+        #
+        # @see Lotus::Helpers::HtmlHelper::EmptyHtmlNode#to_s
+        def to_s
+          content.to_s
+        end
+
+        def content
+          result = @builder.resolve(&@blk)
+
+          if @builder.nested?
+            @builder.to_s
+          else
+            "#{ Utils::Escape.html(result) }"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/helpers/routing_helper.rb

@@ -28,10 +28,10 @@ module Lotus
     #   module Web::Views::Home
     #     class Index
     #       include Web::View
-    #     end
     #
-    #     def link_to_home
-    #       %(<a href="#{ routes.home_path }">Home</a>)
+    #       def link_to_home
+    #         %(<a href="#{ routes.home_path }">Home</a>)
+    #       end
     #     end
     #   end
     #

data/lib/lotus/helpers/version.rb

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

data/lotus-helpers.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -- lib/* LICENSE.md README.md lotus-helpers.gemspec`.split($/)
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md lotus-helpers.gemspec`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'lotus-utils', '~> 0.5', '>= 0.5.2'
+  spec.add_dependency 'lotus-utils', '~> 0.6'
 
   spec.add_development_dependency 'bundler',  '~> 1.6'
   spec.add_development_dependency 'rake',     '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lotus-utils
@@ -18,20 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +77,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
 - lib/lotus-helpers.rb
@@ -95,6 +90,7 @@ files:
 - lib/lotus/helpers/html_helper.rb
 - lib/lotus/helpers/html_helper/empty_html_node.rb
 - lib/lotus/helpers/html_helper/html_builder.rb
+- lib/lotus/helpers/html_helper/html_fragment.rb
 - lib/lotus/helpers/html_helper/html_node.rb
 - lib/lotus/helpers/html_helper/text_node.rb
 - lib/lotus/helpers/link_to_helper.rb
@@ -122,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Lotus helpers