rubyoshka 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aabb46d1744db33af049b11eec91a9e18a938aea5391ab2f22e41c0bccce77ae
-  data.tar.gz: 7d1a473f5c25ab35f38d0886dee156f2da38bce9306cb48a4e39e47d6d2e818d
+  metadata.gz: ba3dd09fc4ab56c9af5a69c47d9da50949180b0c636c788ed74660bbc04b4b5d
+  data.tar.gz: faf523787f5ff11bb3e0d5346ad684b8e3c22c8fdf522e30ff0f43ff4da40a74
 SHA512:
-  metadata.gz: c5c43c9e8bb8f0b2a076a2a607ce3d735575748be1a6998dedb38ef795bfe3a8a33f2d3039c5ba379085b2750929966d4a9f41201651196dc2c1e5ea280c21c1
-  data.tar.gz: 120ad28457f4c3c1775de5d2b542d365a3abb5fdcdf01946097b251dd1830eaee7d2d6bc63bf1fe72c195073e80b9c2e4b3b0d9bddc2445c81c31d45aa9157a2
+  metadata.gz: e10f0611cc2596ac27dd3f93df91db2d77e6ba12bc3159cdb3f29ab1b6abd3caedc66161e14a18b776cba72164a7dad725c1d60e8b4a09bcc39f96a34fb1790f
+  data.tar.gz: ad0b35a97f0d76fa7c82fd456751004f75af759b9d98efc824f3ae99d6fdb5d3a6905aecbb083dc5f44d272cd828c6728e27330ceab5355f1d25c24a7090f3fc

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.6 2021-03-03
+--------------
+
+* Fix Rubyoshka on Ruby 3.0
+* Refactor and add more tests
+
 0.5 2021-02-27
 --------------
 

data/lib/rubyoshka.rb

@@ -2,219 +2,10 @@
 
 require 'escape_utils'
 
+require_relative 'rubyoshka/renderer'
+
 # A Rubyoshka is a template representing a piece of HTML
 class Rubyoshka
-  # A Renderer is a rendering of a Rubyoshka
-  class Renderer
-    attr_reader :context
-  
-    # Initializes attributes and renders the given block
-    # @param context [Hash] rendering context
-    # @param block [Proc] template block
-    # @return [void]
-    def initialize(context, &block)
-      @context = context
-      @buffer = +''
-      instance_eval(&block)
-    end
-  
-    # Returns the result of the rendering
-    # @return [String]
-    def to_s
-      @buffer
-    end
-
-    def escape_text(text)
-      raise NotImplementedError
-    end
-
-    def escape_uri(uri)
-      EscapeUtils.escape_uri(v)
-    end
-
-    S_TAG_METHOD_LINE = __LINE__ + 1
-    S_TAG_METHOD = <<~EOF
-      S_TAG_%<TAG>s_PRE = '<%<tag>s'
-      S_TAG_%<TAG>s_CLOSE = '</%<tag>s>'
-      
-      def %<tag>s(text = nil, **props, &block)
-        @buffer << S_TAG_%<TAG>s_PRE
-        emit_props(props) unless props.empty?
-      
-        if block
-          @buffer << S_GT
-          instance_eval(&block)
-          @buffer << S_TAG_%<TAG>s_CLOSE
-        elsif Rubyoshka === text
-          @buffer << S_GT
-          emit(text)
-          @buffer << S_TAG_%<TAG>s_CLOSE
-        elsif text
-          @buffer << S_GT << escape_text(text.to_s) << S_TAG_%<TAG>s_CLOSE
-        else
-          @buffer << S_SLASH_GT
-        end
-      end
-    EOF
-
-    R_CONST_SYM = /^[A-Z]/
-  
-    # Catches undefined tag method call and handles them by defining the method
-    # @param sym [Symbol] HTML tag or component identifier
-    # @param args [Array] method call arguments
-    # @param block [Proc] block passed to method call
-    # @return [void]
-    def method_missing(sym, *args, &block)
-      value = @local && @local[sym]
-      return value if value
-
-      if sym =~ R_CONST_SYM
-        # Component reference (capitalized method name)
-        o = instance_eval(sym.to_s) rescue Rubyoshka.const_get(sym) \
-            rescue Object.const_get(sym)
-        case o
-        when ::Proc
-          self.class.define_method(sym) { |*a, &b| emit(o.(*a, &b)) }
-          emit(o.(*args, &block))
-        when Rubyoshka
-          self.class.define_method(sym) { |**ctx|
-            ctx.empty? ? emit(o) : with(ctx) { emit(o) }
-          }
-          ctx = args.first
-          Hash === ctx ? with(ctx) { emit(o) } : emit(o)
-        when ::String
-          @buffer << o
-        else
-          e = StandardError.new "Cannot render #{o.inspect}"
-          e.set_backtrace(caller)
-          raise e
-        end
-      else
-        tag = sym.to_s
-        code = S_TAG_METHOD % { tag: tag, TAG: tag.upcase }
-        self.class.class_eval(code, __FILE__, S_TAG_METHOD_LINE)
-        send(sym, *args, &block)
-      end
-    end
-  
-    # Emits the given object into the rendering buffer
-    # @param o [Proc, Rubyoshka, Module, String] emitted object
-    # @return [void]
-    def emit(o)
-      case o
-      when ::Proc
-        instance_eval(&o)
-      when Rubyoshka
-        instance_eval(&o.block)
-      when Module
-        # If module is given, the component is expected to be a const inside the module
-        emit(o::Component)
-      when nil
-      else
-        @buffer << o.to_s
-      end
-    end
-    alias_method :e, :emit
-  
-    S_LT              = '<'
-    S_GT              = '>'
-    S_LT_SLASH        = '</'
-    S_SPACE_LT_SLASH  = ' </'
-    S_SLASH_GT        = '/>'
-    S_SPACE           = ' '
-    S_EQUAL_QUOTE     = '="'
-    S_QUOTE           = '"'
-
-    # Emits tag attributes into the rendering buffer
-    # @param props [Hash] tag attributes
-    # @return [void]
-    def emit_props(props)
-      props.each { |k, v|
-        case k
-        when :src, :href
-          @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE <<
-            EscapeUtils.escape_uri(v) << S_QUOTE
-        else
-          case v
-          when true
-            @buffer << S_SPACE << k.to_s
-          when false, nil
-            # emit nothing
-          else
-            @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE << v << S_QUOTE
-          end
-        end
-      }
-    end
-
-    # Emits the p tag (overrides Object#p)
-    # @param text [String] text content of tag
-    # @param props [Hash] tag attributes
-    # @para block [Proc] nested HTML block
-    # @return [void]
-    def p(text = nil, **props, &block)
-      method_missing(:p, text, **props, &block)
-    end
-  
-    S_HTML5_DOCTYPE = '<!DOCTYPE html>'
-  
-    # Emits an HTML5 doctype tag and an html tag with the given block
-    # @param block [Proc] nested HTML block
-    # @return [void]
-    def html5(&block)
-      @buffer << S_HTML5_DOCTYPE
-      self.html(&block)
-    end
-
-    # Emits text into the rendering buffer
-    # @param data [String] text
-    def text(data)
-      @buffer << escape_text(data)
-    end
-
-    # Sets a local context for the given block
-    # @param ctx [Hash] context hash
-    # @param block [Proc] nested HTML block
-    # @return [void]
-    def with(**ctx, &block)
-      old_local, @local = @local, ctx
-      instance_eval(&block)
-    ensure
-      @local = old_local
-    end
-
-    # Caches the given block with the given arguments as cache key
-    # @param vary [*Object] cache key
-    # @param block [Proc] nested HTML block
-    # @return [void]
-    def cache(*vary, &block)
-      key = [block.source_location, *vary]
-
-      if (cached = Rubyoshka.cache[key])
-        @buffer << cached
-        return
-      end
-
-      cache_pos = @buffer.length
-      instance_eval(&block)
-      diff = @buffer[cache_pos..-1]
-      Rubyoshka.cache[key] = diff
-    end
-  end
-
-  class HTMLRenderer < Renderer
-    def escape_text(text)
-      EscapeUtils.escape_html(text.to_s)
-    end
-
-  end
-
-  class XMLRenderer < Renderer
-    def escape_text(text)
-      EscapeUtils.escape_xml(text.to_s)
-    end
-  end
-
   attr_reader :block
 
   # Initializes a Rubyoshka with the given block
@@ -223,7 +14,7 @@ class Rubyoshka
   # @param [void]
   def initialize(mode: :html, **ctx, &block)
     @mode = mode
-    @block = ctx.empty? ? block : proc { with(ctx, &block) }
+    @block = ctx.empty? ? block : proc { with(**ctx, &block) }
   end
 
   H_EMPTY = {}.freeze
@@ -255,7 +46,12 @@ class Rubyoshka
   def self.component(&block)
     proc { |*args| new { instance_exec(*args, &block) } }
   end
+
+  def self.xml(**ctx, &block)
+    new(mode: :xml, **ctx, &block)
+  end
 end
+::H = Rubyoshka
 
 module ::Kernel
   # Convenience method for creating a new Rubyoshka
@@ -263,6 +59,6 @@ module ::Kernel
   # @param block [Proc] nested block
   # @return [Rubyoshka] Rubyoshka template
   def H(**ctx, &block)
-    Rubyoshka.new(ctx, &block)
+    Rubyoshka.new(**ctx, &block)
   end
 end

data/lib/rubyoshka/html.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative './html'
+
+class Rubyoshka
+  # Markup extensions 
+  module HTML
+    # Emits the p tag (overrides Object#p)
+    # @param text [String] text content of tag
+    # @param props [Hash] tag attributes
+    # @para block [Proc] nested HTML block
+    # @return [void]
+    def p(text = nil, **props, &block)
+      method_missing(:p, text, **props, &block)
+    end
+  
+    S_HTML5_DOCTYPE = '<!DOCTYPE html>'
+  
+    # Emits an HTML5 doctype tag and an html tag with the given block
+    # @param block [Proc] nested HTML block
+    # @return [void]
+    def html5(&block)
+      @buffer << S_HTML5_DOCTYPE
+      self.html(&block)
+    end
+
+    def link_stylesheet(href, custom_attributes = nil)
+      attributes = {
+        rel: 'stylesheet',
+        href: href
+      }
+      if custom_attributes
+        attributes = custom_attributes.merge(attributes)
+      end
+      link(**attributes)
+    end
+  end
+end

data/lib/rubyoshka/renderer.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require_relative './html'
+
+class Rubyoshka
+  # A Renderer is a rendering of a Rubyoshka
+  class Renderer
+    attr_reader :context
+  
+    # Initializes attributes and renders the given block
+    # @param context [Hash] rendering context
+    # @param block [Proc] template block
+    # @return [void]
+    def initialize(context, &block)
+      @context = context
+      @buffer = +''
+      instance_eval(&block)
+    end
+  
+    # Returns the result of the rendering
+    # @return [String]
+    def to_s
+      @buffer
+    end
+
+    def escape_text(text)
+      raise NotImplementedError
+    end
+
+    def escape_uri(uri)
+      EscapeUtils.escape_uri(v)
+    end
+
+    S_TAG_METHOD_LINE = __LINE__ + 1
+    S_TAG_METHOD = <<~EOF
+      S_TAG_%<TAG>s_PRE = '<%<tag>s'
+      S_TAG_%<TAG>s_CLOSE = '</%<tag>s>'
+      
+      def %<tag>s(text = nil, **props, &block)
+        @buffer << S_TAG_%<TAG>s_PRE
+        emit_props(props) unless props.empty?
+      
+        if block
+          @buffer << S_GT
+          instance_eval(&block)
+          @buffer << S_TAG_%<TAG>s_CLOSE
+        elsif Rubyoshka === text
+          @buffer << S_GT
+          emit(text)
+          @buffer << S_TAG_%<TAG>s_CLOSE
+        elsif text
+          @buffer << S_GT << escape_text(text.to_s) << S_TAG_%<TAG>s_CLOSE
+        else
+          @buffer << S_SLASH_GT
+        end
+      end
+    EOF
+
+    R_CONST_SYM = /^[A-Z]/
+  
+    # Catches undefined tag method call and handles them by defining the method
+    # @param sym [Symbol] HTML tag or component identifier
+    # @param args [Array] method call arguments
+    # @param block [Proc] block passed to method call
+    # @return [void]
+    def method_missing(sym, *args, **opts, &block)
+      value = @local && @local[sym]
+      return value if value
+
+      if sym =~ R_CONST_SYM
+        # Component reference (capitalized method name)
+        o = instance_eval(sym.to_s) rescue Rubyoshka.const_get(sym) \
+            rescue Object.const_get(sym)
+        case o
+        when ::Proc
+          self.class.define_method(sym) { |*a, **c, &b| emit(o.(*a, **c, &b)) }
+          emit(o.(*args, **opts,&block))
+        when Rubyoshka
+          self.class.define_method(sym) do |**ctx|
+            ctx.empty? ? emit(o) : with(**ctx) { emit(o) }
+          end
+          Hash === opts.empty? ? emit(o) : with(**opts) { emit(o) }
+        when ::String
+          @buffer << o
+        else
+          e = StandardError.new "Cannot render #{o.inspect}"
+          e.set_backtrace(caller)
+          raise e
+        end
+      else
+        tag = sym.to_s
+        code = S_TAG_METHOD % { tag: tag, TAG: tag.upcase }
+        self.class.class_eval(code, __FILE__, S_TAG_METHOD_LINE)
+        send(sym, *args, **opts, &block)
+      end
+    end
+  
+    # Emits the given object into the rendering buffer
+    # @param o [Proc, Rubyoshka, Module, String] emitted object
+    # @return [void]
+    def emit(o)
+      case o
+      when ::Proc
+        instance_eval(&o)
+      when Rubyoshka
+        instance_eval(&o.block)
+      when Module
+        # If module is given, the component is expected to be a const inside the module
+        emit(o::Component)
+      when nil
+      else
+        @buffer << o.to_s
+      end
+    end
+    alias_method :e, :emit
+  
+    S_LT              = '<'
+    S_GT              = '>'
+    S_LT_SLASH        = '</'
+    S_SPACE_LT_SLASH  = ' </'
+    S_SLASH_GT        = '/>'
+    S_SPACE           = ' '
+    S_EQUAL_QUOTE     = '="'
+    S_QUOTE           = '"'
+
+    # Emits tag attributes into the rendering buffer
+    # @param props [Hash] tag attributes
+    # @return [void]
+    def emit_props(props)
+      props.each { |k, v|
+        case k
+        when :src, :href
+          @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE <<
+            EscapeUtils.escape_uri(v) << S_QUOTE
+        else
+          case v
+          when true
+            @buffer << S_SPACE << k.to_s
+          when false, nil
+            # emit nothing
+          else
+            @buffer << S_SPACE << k.to_s << S_EQUAL_QUOTE << v << S_QUOTE
+          end
+        end
+      }
+    end
+
+    # Emits text into the rendering buffer
+    # @param data [String] text
+    def text(data)
+      @buffer << escape_text(data)
+    end
+
+    # Sets a local context for the given block
+    # @param ctx [Hash] context hash
+    # @param block [Proc] nested HTML block
+    # @return [void]
+    def with(**ctx, &block)
+      old_local, @local = @local, ctx
+      instance_eval(&block)
+    ensure
+      @local = old_local
+    end
+
+    # Caches the given block with the given arguments as cache key
+    # @param vary [*Object] cache key
+    # @param block [Proc] nested HTML block
+    # @return [void]
+    def cache(*vary, **opts, &block)
+      key = [block.source_location.hash, vary.hash, opts.hash]
+
+      if (cached = Rubyoshka.cache[key])
+        @buffer << cached
+        return
+      end
+
+      cache_pos = @buffer.length
+      instance_eval(&block)
+      diff = @buffer[cache_pos..-1]
+      Rubyoshka.cache[key] = diff
+    end
+  end
+
+  class HTMLRenderer < Renderer
+    include HTML
+    
+    def escape_text(text)
+      EscapeUtils.escape_html(text.to_s)
+    end
+  end
+
+  class XMLRenderer < Renderer
+    def escape_text(text)
+      EscapeUtils.escape_xml(text.to_s)
+    end
+  end
+end

data/lib/rubyoshka/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rubyoshka
-  VERSION = '0.5'
+  VERSION = '0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyoshka
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -90,6 +90,8 @@ files:
 - CHANGELOG.md
 - README.md
 - lib/rubyoshka.rb
+- lib/rubyoshka/html.rb
+- lib/rubyoshka/renderer.rb
 - lib/rubyoshka/version.rb
 homepage: http://github.com/digital-fabric/rubyoshka
 licenses: