opal-haml 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1419033dec6d3a72ed09a3011ecc454551406271
-  data.tar.gz: '02064278322c4b072f766465870a035cc4724ad5'
+  metadata.gz: '09295c5a78ced0158a3b1fa7e80aa2048fca99ed'
+  data.tar.gz: 1549592bbd08fc4e9ddcaf743e4736413d2f05fd
 SHA512:
-  metadata.gz: 5c66562091ba037ecbead72df0a925044e129c65a2d8d31965cd4a0293bdfa7935614630335b6f4c45577f949b3e903a4a532ff74efc139ad603cbe982866977
-  data.tar.gz: 9c7de3fd306c703c012ee02992339cff80df33b18042aca33bc3ab535f2f43effd18cb38da334de2b1c00d68ec6f824942fdfa9129f4ef7e63690921f9669a76
+  metadata.gz: 3a1385061b8c9d8e9255cab355fbc84808e21b1545407ed5bb6c3f739805e20fea2d5ff0783299af9412841105b25d7973cdbaaa7f265af4714f22d8c39f854a
+  data.tar.gz: e58fc44ac5ebee247678509248157637c149892413a35d1716a7f13fb0773bf6dbd3d8f6cf7b7c26a71b3e2e6be9f0b741229f82cf4d8e21319c22c55f9253d2

data/CHANGELOG.md

@@ -1,37 +1,41 @@
+## 0.4.4 2017-05-13
+
+- Improve support for the attribute builder
+
 ## 0.4.3 2017-05-02
 
-*   Add support for Haml v5.0
+- Add support for Haml v5.0
 
 ## 0.4.2 2016-10-06
 
-*   Avoid Sprockets v3.7 deprecations
+- Avoid Sprockets v3.7 deprecations
 
 ## 0.4.1 2015-11-02
 
-*   Add support for nested attribute hashes: `%div{ data: { foo: 123 } }` now becomes `<div data-foo="123"></div>`.
+- Add support for nested attribute hashes: `%div{ data: { foo: 123 } }` now becomes `<div data-foo="123"></div>`.
 
-*   Attribute values are now properly escaped.
+- Attribute values are now properly escaped.
 
 ## 0.4.0 2015-08-07
 
-*   Add support for Opal 0.8.
+- Add support for Opal 0.8.
 
-*   Update the processor to reuse the good stuff from the Opal::Processor.
+- Update the processor to reuse the good stuff from the Opal::Processor.
 
-*   Now each compiled template automatically requires `opal-haml` with the new module system.
+- Now each compiled template automatically requires `opal-haml` with the new module system.
 
 ## 0.3.0 2015-02-03
 
-*   Add support for new opal Builder processors.
+- Add support for new opal Builder processors.
 
-*   Implicitly require `opal-haml` when any haml template is required
+- Implicitly require `opal-haml` when any haml template is required
 
-*   Cleanup generated code to be use Opal ERB runtime directly.
+- Cleanup generated code to be use Opal ERB runtime directly.
 
 ## 0.2.0 2013-12-17
 
-*   Remove opal-sprockets dependency
+- Remove opal-sprockets dependency
 
 ## 0.1.0 2013-12-17
 
-*   Initial release
+- Initial release

data/lib/opal/haml/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Haml
-    VERSION = '0.4.3'
+    VERSION = '0.4.4'
   end
 end

data/opal/haml/attribute_builder.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2006-2009 Hampton Catlin and Natalie Weizenbaum
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+module Haml
+  module AttributeBuilder
+    # https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+    INVALID_ATTRIBUTE_NAME_REGEX = /[ \0"'>\/=]/
+
+    class << self
+      def build_attributes(is_html, attr_wrapper, escape_attrs, hyphenate_data_attrs, attributes = {})
+        # @TODO this is an absolutely ridiculous amount of arguments. At least
+        # some of this needs to be moved into an instance method.
+        join_char = hyphenate_data_attrs ? '-' : '_'
+
+        attributes.each do |key, value|
+          if value.is_a?(Hash)
+            data_attributes = attributes.delete(key)
+            data_attributes = flatten_data_attributes(data_attributes, '', join_char)
+            data_attributes = build_data_keys(data_attributes, hyphenate_data_attrs, key)
+            verify_attribute_names!(data_attributes.keys)
+            attributes = data_attributes.merge(attributes)
+          end
+        end
+
+        result = attributes.collect do |attr, value|
+          next if value.nil?
+
+          value = filter_and_join(value, ' ') if attr == 'class'
+          value = filter_and_join(value, '_') if attr == 'id'
+
+          if value == true
+            next " #{attr}" if is_html
+            next " #{attr}=#{attr_wrapper}#{attr}#{attr_wrapper}"
+          elsif value == false
+            next
+          end
+
+          value =
+            if escape_attrs == :once
+              Haml::Helpers.escape_once(value.to_s)
+            elsif escape_attrs
+              Haml::Helpers.html_escape(value.to_s)
+            else
+              value.to_s
+            end
+          " #{attr}=#{attr_wrapper}#{value}#{attr_wrapper}"
+        end
+        result.compact!
+        result.sort!
+        result.join
+      end
+
+      # @return [String, nil]
+      def filter_and_join(value, separator)
+        return '' if (value.respond_to?(:empty?) && value.empty?)
+
+        if value.is_a?(Array)
+          value = value.flatten
+          value.map! {|item| item ? item.to_s : nil}
+          value.compact!
+          value = value.join(separator)
+        else
+          value = value ? value.to_s : nil
+        end
+        !value.nil? && !value.empty? && value
+      end
+
+      # Merges two attribute hashes.
+      # This is the same as `to.merge!(from)`,
+      # except that it merges id, class, and data attributes.
+      #
+      # ids are concatenated with `"_"`,
+      # and classes are concatenated with `" "`.
+      # data hashes are simply merged.
+      #
+      # Destructively modifies `to`.
+      #
+      # @param to [{String => String,Hash}] The attribute hash to merge into
+      # @param from [{String => Object}] The attribute hash to merge from
+      # @return [{String => String,Hash}] `to`, after being merged
+      def merge_attributes!(to, from)
+        from.keys.each do |key|
+          to[key] = merge_value(key, to[key], from[key])
+        end
+        to
+      end
+
+      # Merge multiple values to one attribute value. No destructive operation.
+      #
+      # @param key [String]
+      # @param values [Array<Object>]
+      # @return [String,Hash]
+      def merge_values(key, *values)
+        values.inject(nil) do |to, from|
+          merge_value(key, to, from)
+        end
+      end
+
+      def verify_attribute_names!(attribute_names)
+        attribute_names.each do |attribute_name|
+          if attribute_name =~ INVALID_ATTRIBUTE_NAME_REGEX
+            raise InvalidAttributeNameError.new("Invalid attribute name '#{attribute_name}' was rendered")
+          end
+        end
+      end
+
+      private
+
+      # Merge a couple of values to one attribute value. No destructive operation.
+      #
+      # @param to [String,Hash,nil]
+      # @param from [Object]
+      # @return [String,Hash]
+      def merge_value(key, to, from)
+        if from.kind_of?(Hash) || to.kind_of?(Hash)
+          from = { nil => from } if !from.is_a?(Hash)
+          to   = { nil => to }   if !to.is_a?(Hash)
+          to.merge(from)
+        elsif key == 'id'
+          merged_id = filter_and_join(from, '_')
+          if to && merged_id
+            merged_id = "#{to}_#{merged_id}"
+          elsif to || merged_id
+            merged_id ||= to
+          end
+          merged_id
+        elsif key == 'class'
+          merged_class = filter_and_join(from, ' ')
+          if to && merged_class
+            merged_class = (merged_class.split(' ') | to.split(' ')).sort.join(' ')
+          elsif to || merged_class
+            merged_class ||= to
+          end
+          merged_class
+        else
+          from
+        end
+      end
+
+      def build_data_keys(data_hash, hyphenate, attr_name="data")
+        Hash[data_hash.map do |name, value|
+          if name == nil
+            [attr_name, value]
+          elsif hyphenate
+            ["#{attr_name}-#{name.to_s.tr('_', '-')}", value]
+          else
+            ["#{attr_name}-#{name}", value]
+          end
+        end]
+      end
+
+      def flatten_data_attributes(data, key, join_char, seen = [])
+        return {key => data} unless data.is_a?(Hash)
+
+        return {key => nil} if seen.include? data.object_id
+        seen << data.object_id
+
+        data.sort {|x, y| x[0].to_s <=> y[0].to_s}.inject({}) do |hash, (k, v)|
+          joined = key == '' ? k : [key, k].join(join_char)
+          hash.merge! flatten_data_attributes(v, joined, join_char, seen)
+        end
+      end
+    end
+  end
+end

data/opal/opal-haml.rb

@@ -1,4 +1,5 @@
 require 'template'
+require 'haml/attribute_builder'
 
 module Haml
   module Buffer

data/spec/fixtures/attributes_helper.haml

@@ -0,0 +1,7 @@
+.keyboard
+  -2.times do
+    .octave
+      -@keyboard.notes.each do |note|
+        %a.key(class="#{2+2}")
+        .key{class: "#{note.note_class}"}
+          .name= note.name

data/spec/haml_spec.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
-require File.expand_path('../simple', __FILE__)
-require File.expand_path('../advanced', __FILE__)
-require File.expand_path('../html_content', __FILE__)
+require_tree './fixtures'
 
 describe "Haml files" do
-  let(:simple) { Template['simple'] }
-  let(:advanced) { Template['advanced'] }
-  let(:html_content) { Template['html_content'] }
+  let(:simple)            { Template['fixtures/simple'] }
+  let(:advanced)          { Template['fixtures/advanced'] }
+  let(:html_content)      { Template['fixtures/html_content'] }
+  let(:attributes_helper) { Template['fixtures/attributes_helper'] }
 
   it "should be defined by filename on Template namespace" do
     expect(simple).to be_kind_of(Template)
@@ -29,4 +28,30 @@ describe "Haml files" do
     @h1_content = 'Ford Perfect'
     expect(html_content.render(self)).to include('<h1>Ford Perfect</h1>')
   end
+
+  it 'can generates attributes' do
+    require 'ostruct'
+    note = Struct.new(:name, :note_class)
+    @keyboard = OpenStruct.new(notes: [note.new(:C, :sharp), note.new(:F, :sharp)])
+    expect([
+      "<div class='keyboard'>"+
+        "<div class='octave'>"+
+          "<a class='4 key'></a><div class='key sharp'><div class='name'>C</div></div>"+
+          "<a class='4 key'></a><div class='key sharp'><div class='name'>F</div></div>"+
+        "</div><div class='octave'>"+
+          "<a class='4 key'></a><div class='key sharp'><div class='name'>C</div></div>"+
+          "<a class='4 key'></a><div class='key sharp'><div class='name'>F</div></div>"+
+        "</div>"+
+      "</div>",
+      "<div class='keyboard'>"+
+        "<div class='octave'>"+
+          "<a class='key 4'></a><div class='key sharp'><div class='name'>C</div></div>"+
+          "<a class='key 4'></a><div class='key sharp'><div class='name'>F</div></div>"+
+        "</div><div class='octave'>"+
+          "<a class='key 4'></a><div class='key sharp'><div class='name'>C</div></div>"+
+          "<a class='key 4'></a><div class='key sharp'><div class='name'>F</div></div>"+
+        "</div>"+
+      "</div>"
+    ]).to include(attributes_helper.render(self))
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-haml
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Adam Beynon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -86,12 +86,14 @@ files:
 - lib/opal/haml/processor.rb
 - lib/opal/haml/version.rb
 - opal-haml.gemspec
+- opal/haml/attribute_builder.rb
 - opal/opal-haml.rb
-- spec/advanced.haml
+- spec/fixtures/advanced.haml
+- spec/fixtures/attributes_helper.haml
+- spec/fixtures/html_content.haml
+- spec/fixtures/simple.haml
 - spec/haml_spec.rb
-- spec/html_content.haml
 - spec/output_buffer_spec.rb
-- spec/simple.haml
 - spec/spec_helper.rb
 homepage: http://opalrb.org
 licenses:
@@ -118,9 +120,10 @@ signing_key:
 specification_version: 4
 summary: Run Haml templates client-side with Opal
 test_files:
-- spec/advanced.haml
+- spec/fixtures/advanced.haml
+- spec/fixtures/attributes_helper.haml
+- spec/fixtures/html_content.haml
+- spec/fixtures/simple.haml
 - spec/haml_spec.rb
-- spec/html_content.haml
 - spec/output_buffer_spec.rb
-- spec/simple.haml
 - spec/spec_helper.rb