templet 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f53a3264d04846496a5fab85e4870ca1f1028b5
-  data.tar.gz: 35f92da74584cca4bf699f0aff237b96f4772a69
+  metadata.gz: 7bc21aab645cc1952ee135c2086f2828d577214f
+  data.tar.gz: 4a94ac0f8fb7ad6a82ac0e673c51f76d3d34ea64
 SHA512:
-  metadata.gz: c5c00ae7fc9c270c20986ec45c9fcfa601dbd64f3cf30ae711ef06192eb86ad4a83e85cf16c3402609b6677ece80db87efe3a68df02284ad0335263f2aacdc84
-  data.tar.gz: 8290792806560547f80b385b7a95ac22003b262e4b23c033a1b130b27a714c8984846bba9546fd65fe8dfb5cc773dadd8f9aef02b77b929f1381841bb2659ca3
+  metadata.gz: 1291da062a0ba09b3c14780319b947ad252b36a3628b6be92c0e9beccbbeab733604b2a619e9ab49714f114e1e432ab30ad656a72f4e19c7481ee117098b2f07
+  data.tar.gz: 2042fc238a893d2e232575ae8d8f7af25931e716ed0fa2c1e6d4f809f38d2459cdca013ee2d67b621e00c4c2d0661fce9d192cebb7363136a69912e162913990

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    templet (0.1.0)
+    templet (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -21,17 +21,20 @@ It has three main sections:
 
 3. Helper methods for rendering HTML tables and lists.
 
-_Incidentally, and if such a need arises,
+_Incidentally, if such a need arises,
 there is another renderer class, *Templet::Renderers::ERb*,
-that you may use to insert markup inside of an ERb layout,
+that you may use to insert markup inside of a main ERb layout,
 either on file or as a string._
 
+> To load these classes you add the line: `require 'templet'`.
+
 ## The basic DSL (Renderer)
 
 The DSL processing (i.e. HTML rendering) is handled by
 the class, *Templet::Renderer*.
 But don't expect anything earth-shattering,
 as this class breaks no new ground.
+
 It's as simple a DSL as you're likely to come across.
 Also, there are a good few others that are similar,
 e.g. XML Builder, Markaby, Arbre, and Fortitude.
@@ -83,12 +86,21 @@ But there's no need for you to embark on such a venture yourself,
 as these things are implemented in the related gem:
 [templet\_rails](https://github.com/srycyk/templet_rails).
 
+> There is a third kind of component, *Templet::Component::Template*
+> that renders an auxiliary ERb template, _(like a Rails partial)_.
+> However, this experimental feature is inefficient and, besides,
+> it merely regurgitates existing functionality that this gem
+> sets out to replace!
+> Having said this, there may be some *corner* cases where using this
+> kind of Component will make sense.
+> _This Component isn't explained here, but the tests outline usage._
+
 ## HTML Helpers
 
 Some further classes are included (in the *templet/html/* sub-directory),
-that provide a shortened way to render HTML tables and lists.
-Their content is determined by a Ruby Hash or Array,
-which is given as input.
+that provide a short-hand way to render HTML lists and tables.
+A stardard HTML list is generated from a given Ruby Array, similarly,
+an HTML table (or definition list) is generated from a Ruby Hash.
 
 Examples of using these are given towards the end.
 
@@ -99,7 +111,8 @@ it's best not to construct an instance of a *Renderer* explicitly,
 even though this is illustrated in the examples which follow.
 
 As noted, it's neater to use the *Renderer* implicitly,
-that is, by means of a *Layout* containing a number of *Partials*.
+that is, by means of a *Layout* containing a number of *Partials*,
+which both contain an instance of a *Renderer*.
 
 Still, it is useful to have a grounding in the basic rules and techniques,
 as they apply to the Components as well.
@@ -171,26 +184,23 @@ require 'templet'
 
   # The first two arguments are contexts for method lookups
   #
-  # The final argument list local variables which take precendence
+  # The final argument list local variables which take precedence
   #
   # The block renders the markup
   # Note the shortcut call, this call is stated in full in the above example
   html = Templet.(self, Lister.new, title: 'A Title') do
            more_content = 'More content'
 
-           # +title+ is (in effect) a local variable passed into the constru
-ctor
+           # +title+ is (in effect) a local variable passed into the constructor
            [ -> { h1(title, :strong) }, # you can include anything callable
 
-             # Calls +items+ from Lister instance, given as a contructor arg
-ument
+             # Calls +items+ from Lister instance, given as a constructor argument
              # The +_p+ call renders a <p> tag
              #   without the underscore the Kernel#p method would override
              _p(ul(:list_unstyled) { items.map {|item| li item } }),
 
              div(:row) do
-               # Calls +content+ because +self+ is passed into the contructo
-r
+               # Calls +content+ because +self+ is passed into the constructor
                # +col_tag+ is a closure variable defined above
                [ col_tag.(content), col_tag.(more_content), col_tag.('...') 
 ]
@@ -224,15 +234,19 @@ This produces the following HTML:
 
 ## Notes on Usage
 
+### Return Types
+
 The main quirk is that the *Renderer* only outputs
 the actual return value of a given block.
 That is, statements preceding the very last one won't
 show up in the resultant markup.
 *This behaviour differs from that of most other markup API's.*
 
-A block's return type must be either an array of strings or of *callable*
-entities (which themselves return one or more strings).
-This array can be nested at any depth.
+A block's return type must be either strings or *callable* entities
+(which themselves return one or more strings), or else an array of such.
+If an array is returned, it can  be nested to any depth (as it's flattened).
+
+### Renderer Context
 
 Importantly, the block, passed to *Renderer#call*, is **not**
 executed in its natural local (i.e. lexical) scope.
@@ -244,8 +258,10 @@ as one of the initial arguments.
 *To put this in more practical terms: be aware that if an error does occur,
 its origin may be flagrantly misreported in the stack trace.*
 
+### Further Guidance
+
 The tests have more examples of usage,
-also, the source code is easy to follow and is commented.
+also, the source code is easy to follow and is liberally commented.
 
 But don't dig too deep.
 There's not a lot you need to learn to get started,
@@ -256,12 +272,12 @@ and you should be able to pick up the rest as you go along.
 As said, Components facilitate a modular (object oriented) approach
 to rendering markup.
 
-You begin with a Layout, which, typically, contains a number of Partials.
+You begin with a Layout, consists of a number of Partials.
 
-There's no need to have more than a single Layout,
+There is often no need to have more than a single Layout,
 since Partials can be nested inside one another.
 
-Together, they perform much the same function as their namesakes in Rails.
+They perform much the same function as their namesakes in Rails.
 
 ### Examples of a Layout with Partials
 
@@ -359,12 +375,10 @@ This produces the following HTML:
 
 ## Examples of Rendering HTML Composites
 
-In these examples, a *nil* value is passed to the constructor,
+In the following examples, a **nil** value is passed to the constructor,
 but in application code, this will be, in nearly all cases,
 replaced by an instance of a *Renderer*.
 
-> To load these claases you must add: `require 'templet/html'`.
-
 ### An Unordered List
 
 ```ruby
@@ -384,7 +398,7 @@ This produces the following HTML:
 
 ### A Definition List
 
-In basic cases, you pass in a Hash,
+In the most basic use, you pass in a Hash,
 where the key is the title (the *dt* tag),
 and the value is the data (the *dd* tag).
 This is done as follows:
@@ -414,6 +428,7 @@ If a Symbol is given then it's used as a (Hash) key,
 as in `record[key]`.
 If a Proc is given then it's called with the
 record passed as the first parameter, as in `func.call(record)`.
+_Where *func* is the passed-in Proc_
 
 ```ruby
 record = OpenStruct.new(field_1: 'Value 1', field_2: 'Value 2')
@@ -437,8 +452,8 @@ This produces the following HTML:
 ### A Table
 
 To render an HTML table you pass to the *call* method,
-a control Hash (as set out just above),
-and a list of records, obviously, with a table row for each record.
+a control Hash (as set out for the Definition List just above),
+and a list of records which, obviously, map to a table row.
 
 ```ruby
 controls = { 'Title 1' => nil, # shows the whole of the 'numbers' hash
@@ -526,6 +541,9 @@ Or install it yourself as:
     $ gem install templet
 ```
 
+Or get it from Github at
+[github.com/srycyk/templet](https://github.com/srycyk/templet).
+
 ## Licence
 
 The gem is available as open source under the terms

data/lib/templet.rb

@@ -16,6 +16,6 @@ module Templet
   end
 
   def self.erb(template_path, **locals, &block)
-    Renderers::Erb.(template_path, **locals, &block)
+    Renderers::ERb.(template_path, **locals, &block)
   end
 end

data/lib/templet/component.rb

@@ -1,10 +1,10 @@
 
-require 'templet'
-
 require 'templet/component/partial'
 require 'templet/component/layout'
+require 'templet/component/template'
 
 module Templet
   module Component
   end
 end
+

data/lib/templet/component/partial.rb

@@ -8,8 +8,11 @@ module Templet
       # +contexts+:: A list containing objects whose methods will be looked up
       # +locals+:: Objects you can reference by the name given as the key
       def initialize(renderer, *contexts, **locals)
-        self.renderer = renderer&.new_instance(self, *contexts, **locals) ||
-                        Renderer.new(self, *contexts, **locals)
+        self.renderer = if renderer
+                          renderer.new_instance(self, *contexts, **locals)
+                        else
+                          Renderer.new(self, *contexts, **locals)
+                        end
       end
 
       # Entry point - the block returns markup

data/lib/templet/component/template.rb

@@ -0,0 +1,16 @@
+
+module Templet
+  module Component
+    # Used for ERb support
+    class Template < Templet::Renderers::ERb
+      # +template+:: Given as string or file or at __END__
+      # +locals+:: Objects you can reference by the name given as the key
+      def initialize(renderer, template=nil, **locals)
+        self.proto_template = template
+
+        self.context = renderer.new_instance(self, **locals)
+      end
+    end
+  end
+end
+

data/lib/templet/html.rb

@@ -1,6 +1,4 @@
 
-require 'templet'
-
 require 'templet/html/table'
 require 'templet/html/list'
 require 'templet/html/definition_list'

data/lib/templet/html/table.rb

@@ -20,7 +20,7 @@ module Templet
                     if title.respond_to?(:call)
                       th title.(self, opaque_heading, opaque_row)
                     else
-                      th heading(title)
+                      th heading(title.to_s)
                     end
                   end
                 end
@@ -56,7 +56,7 @@ module Templet
       end
 
       def heading(title)
-        title[0] == '_' ? '' : title.capitalize
+        title[0] == '_' ? '' : title.capitalize.tr('_', ' ')
       end
     end
   end

data/lib/templet/renderer.rb

@@ -27,7 +27,7 @@ module Templet
 
     # The block contains the markup
     def call(&block)
-      Renderers::ListPresenter.new.(instance_eval &block)
+      Renderers::ListPresenter.new.(instance_eval(&block))
     end
 
     def method_missing(name, *args, &block)

data/lib/templet/renderers/erb.rb

@@ -6,38 +6,78 @@ module Templet
   module Renderers
     # For rendering a supplied block within an ERb template
     class ERb
-      attr_accessor :erb, :context
+      attr_accessor :context, :proto_template
 
-      # template_path can be a local ERb file, or template text
+      # template_path can be a local ERb file, template string, or DATA append
       #
       # locals are local variables for the ERb template alone
-      def initialize(template, **locals)
-        self.erb = ERB.new get_template(template)
+      def initialize(proto_template=nil, **locals)
+        self.proto_template = proto_template
 
         self.context = OpenStruct.new(**locals)
       end
 
       # The return value from the block in substituted in <%= yield %>
       def call(&block)
-        locals_binding = context.instance_eval { binding }
+        context_binding = context.instance_eval { ::Kernel.binding }
 
-        erb.result locals_binding, &block
+        erb.result context_binding, &block
       end
 
       # Shortcut to instance method
-      def self.call(template_path, **locals, &block)
-        new(template_path, **locals).(&block)
+      def self.call(template=nil, **locals, &block)
+        new(template, **locals).(&block)
       end
 
       private
 
-      def get_template(template)
-        if template =~ /<%/
-          template
+      def erb
+        @erb ||= ERB.new get_template
+      end
+
+      def get_template
+        if proto_template
+          if proto_template =~ /(<%)|(\s\s)|(\n)/m
+            proto_template
+          else
+            IO.read proto_template
+          end
+        else
+          template or ''
+        end
+      end
+
+      def template(read_from=false)
+        if read_from
+          call_stack = caller
+
+          read_erb(call_stack) or read_end(call_stack)
+        end
+      end
+
+      def read_erb(call_stack)
+        path = erb_path(call_stack)
+
+        IO.read(path) if File.file?(path)
+      end
+
+      def erb_path(call_stack)
+        source_path(call_stack, 0).sub(/\.rb$/, '.erb')
+      end
+
+      def read_end(call_stack)
+        if defined? DATA
+          DATA.read
         else
-          IO.read template
+          path = source_path(call_stack, 0)
+
+          IO.read(path).split(/\s__END__\s/, 2)&.last
         end
       end
+
+      def source_path(call_stack, index)
+        call_stack[index].split(":").first
+      end
     end
   end
 end

data/lib/templet/version.rb

@@ -1,3 +1,3 @@
 module Templet
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: templet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - stephen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ files:
 - lib/templet/component.rb
 - lib/templet/component/layout.rb
 - lib/templet/component/partial.rb
+- lib/templet/component/template.rb
 - lib/templet/html.rb
 - lib/templet/html/definition_list.rb
 - lib/templet/html/list.rb