stellar-erb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d36ba6cabfdabcea69f3c1eae4a85ac8a178295783bb045eddfa1fe3f466671
-  data.tar.gz: 2a278f0be5a4b6d19635fc5de83737b260ee0904573dcc4986d64f0c131ba6b8
+  metadata.gz: aa98284e8fd7eb00da41c159321eea5c1019d02eda68661035ea6b2a947ec338
+  data.tar.gz: ba5fcba9afa15e38675584f58c2364d22effdada46cfd81029bd37d7f91f50e9
 SHA512:
-  metadata.gz: a1d708c9a15b841ac2c9ed100c6d513cffad5b3f18b0adbca3ac0ed2cb057f6f46e6b18841a6570903b3e8dff00a4f856f28fc7befd71d1bd4b5f03ab212f9b5
-  data.tar.gz: 835d54c01f66476e40595ec201c6b02f727d680ff6898bdb0fd9e38f83b3d749d15e7fada2656f9d56d9ca293e01ec86047c764d34b91407d4f1d758e2a27cd1
+  metadata.gz: 5f7e3417120b4038a87d11dc65bbb84597e60b12297102320445482c250817f81ec6e0eac82b1adc9935f5a9b06612b1c2fc53f87a9f7fa4bcd0b5c2047ce338
+  data.tar.gz: 6af4affdc2fe29714c54e595821644be708f3e088b9d172da23b51b948a617c1d2a804f6d5ea54ea9ace2ebe3cbbb85ecc4c2e3be58be0c6acc4c3f68cea27c5

data/README.md

@@ -2,35 +2,30 @@
 
 ![Stellar::ERb logo](logo.png)
 
-
-
-A safe, easy to use wrapper for ERB (Embedded Ruby) templates outside of Rails.
-
+A robust, safe, and feature-rich wrapper for ERB (Embedded Ruby) template rendering outside of Rails.
 
 ## Overview
 
-Stellar::Erb provides a robust method for reading `.erb` files from disk and rendering them to strings, with built-in support for:
-- Variable passing
-- Error handling with context
-- Clean backtraces
-- Template reusability
+Stellar::Erb provides a sophisticated yet easy-to-use solution for working with ERB templates in Ruby applications. It offers enhanced error handling, clean backtraces, and a flexible API that makes template rendering both powerful and maintainable.
+
+### Key Features
 
+- **Safe Template Rendering**: Built-in protection against common template injection vulnerabilities
+- **Rich Error Context**: Detailed error messages with line numbers and surrounding code context
+- **Flexible Variable Passing**: Support for both global and per-render local variables
+- **String Template Support**: Render ERB directly from strings in addition to files
+- **Reusable Views**: Create view instances for efficient template reuse
+- **Minimal Dependencies**: Works standalone without requiring Rails
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'stellar-erb'
 ```
 
-And then execute:
-
-```bash
-$ bundle install
-```
-
-Or install it yourself as:
+Or install directly:
 
 ```bash
 $ gem install stellar-erb
@@ -42,55 +37,100 @@ $ gem install stellar-erb
 
 ```ruby
 # template.erb
-<h1>Hello, <%= name %>!</h1>
-<ul>
-  <% items.each do |item| %>
-    <li><%= item %></li>
+<div class="greeting">
+  <h1>Hello, <%= name %>!</h1>
+  <% if show_date %>
+    <p>Today is <%= Date.today %></p>
   <% end %>
-</ul>
+</div>
 
 # Ruby code
-result = Stellar::Erb::View.render('template.erb', 
-  name: 'John', 
-  items: ['apple', 'banana', 'orange']
+result = Stellar::Erb.render('template.erb', 
+  name: 'John',
+  show_date: true
 )
 ```
 
+### String Template Rendering
 
+```ruby
+template_string = <<~ERB 
+  <ul class="items">
+    <% items.each do |item| %>
+      <li><%= item.name %> - $<%= item.price %></li>
+    <% end %>
+  </ul>
+ERB
+
+result = Stellar::Erb.render_string(template_string, 
+  items: [
+    OpenStruct.new(name: 'Widget', price: 9.99),
+    OpenStruct.new(name: 'Gadget', price: 19.99)
+  ]
+)
+```
 
-#### Creating Reusable Views
+### Reusable Views
 
 ```ruby
-# Create a view instance for reuse
-view = Stellar::Erb::View.new('templates/header.erb', 
-  company_name: 'Acme Corp'
+# Create a reusable view instance
+header = Stellar::Erb::View.new('partials/header.erb', 
+  company: 'Acme Corp',
+  logo_url: '/images/logo.png'
 )
 
-# Render multiple times with different locals
-page1 = view.render(title: 'Home')
-page2 = view.render(title: 'About')
+# Render with different page-specific variables
+page1 = header.render(title: 'Home Page')
+page2 = header.render(title: 'About Us')
 ```
 
-#### Error Handling
+### Error Handling
 
 ```ruby
 begin
-  Stellar::Erb::View.render('template.erb', user: current_user)
+  result = Stellar::Erb::View.render('template.erb', user: current_user)
 rescue Stellar::Erb::Error => e
-  puts "Error: #{e.message}"
-  puts "\nContext:"
+  puts "Template Error: #{e.message}"
+  
+  # Show context around the error
+  puts "\nError Context:"
   puts e.context_lines.join("\n")
-  puts "\nOriginal error: #{e.original_error.class}"
+  
+  # Access original error details
+  puts "Line Number: #{e.line_number}"
+  puts "Template Path: #{e.template_path}"
 end
 ```
 
 
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+# Setup development environment
+bin/setup
+
+# Run tests
+rake test
 
-Development workflow:
+# Run specific test file
+ruby -Ilib:test test/stellar/erb/view_test.rb
+
+# Generate documentation
+yard doc
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Add tests for your changes
+4. Make your changes
+5. Ensure tests pass (`rake test`)
+6. Commit your changes (`git commit -am 'Add amazing feature'`)
+7. Push to the branch (`git push origin feature/amazing-feature`)
+8. Create a Pull Request
+
+### Development Workflow
 
 ```mermaid
 flowchart TD
@@ -107,28 +147,22 @@ flowchart TD
     I -->|No| G
 ```
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b feature/my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin feature/my-new-feature`)
-5. Create new Pull Request
-
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
+Released under the MIT License. See [LICENSE](LICENSE) for details.
 
 ## Support
 
-For bug reports and feature requests, please use the [GitHub Issues](https://github.com/durableprogramming/stellar-erb/issues) page.
+- **Documentation**: [RubyDoc](https://www.rubydoc.info/gems/stellar-erb)
+- **Issues**: [GitHub Issues](https://github.com/durableprogramming/stellar-erb/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/durableprogramming/stellar-erb/discussions)
 
----
-
-Stellar::Erb is actively maintained by [Durable Programming, LLC](https://github.com/durableprogramming).
+## Commercial Support
 
+Professional support, custom development, and training services are available from [Durable Programming, LLC](https://www.durableprogramming.com).
 
-Commercial support for Stellar::Erb and related tools is available from Durable Programming, LLC. You can contact us at [durableprogramming.com](https://www.durableprogramming.com).
+---
 
-![Durable Programming, LLC Logo](https://durableprogramming.com/images/logo.png)
+[![Build Status](https://github.com/durableprogramming/stellar-erb/actions/workflows/main.yml/badge.svg)](https://github.com/durableprogramming/stellar-erb/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/stellar-erb.svg)](https://badge.fury.io/rb/stellar-erb)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

data/lib/stellar/erb/error.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module Stellar
   module Erb
     class Error < StandardError
-      attr_reader :template_path, :original_error, :line_number
+      attr_accessor :template_path, :original_error, :line_number
 
       def initialize(message = nil, template_path: nil, original_error: nil, line_number: nil)
         @template_path = template_path
         @original_error = original_error
         @line_number = line_number
+        message ||= self.class.name
         super(message)
       end
 
@@ -23,39 +26,39 @@ module Stellar
 
       def self.wrap(error, template_path: nil)
         return error if error.is_a?(self)
-        
+
         line_number = extract_line_number(error, template_path)
         message = error.message
-        
-        new(message, 
-            template_path: template_path, 
-            original_error: error, 
+
+        new(message,
+            template_path: template_path,
+            original_error: error,
             line_number: line_number)
       end
 
       def self.extract_line_number(error, template_path)
         return nil unless template_path && error.backtrace
-        
+
         backtrace_line = error.backtrace.find { |line| line.include?(template_path) }
         return nil unless backtrace_line
-        
+
         match = backtrace_line.match(/:(\d+):/)
         match ? match[1].to_i : nil
       end
-      
+
       def context_lines(number_of_lines = 5)
         return [] unless template_path && line_number && File.exist?(template_path)
-        
+
         lines = File.readlines(template_path)
         start_line = [line_number - number_of_lines - 1, 0].max
         end_line = [line_number + number_of_lines - 1, lines.length - 1].min
-        
+
         context = []
         (start_line..end_line).each do |i|
           prefix = i + 1 == line_number ? "=>" : "  "
           context << "#{prefix} #{i + 1}: #{lines[i].chomp}"
         end
-        
+
         context
       end
     end

data/lib/stellar/erb/version.rb

@@ -2,6 +2,6 @@
 
 module Stellar
   module Erb
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/stellar/erb/view.rb

@@ -1,39 +1,40 @@
+# frozen_string_literal: true
+
 module Stellar
   module Erb
     class View
-      attr_reader :template_path, :template_content, :locals
-      
+      attr_accessor :template_path, :template_content, :locals
+
       def initialize(template_path, locals = {})
         @template_path = template_path
-        @template_content = File.read(template_path)
+        if @template_path
+          @template_content = File.read(template_path)
+        end
         @locals = locals
       end
-      
+
       def render(additional_locals = {})
         all_locals = locals.merge(additional_locals)
-        binding_obj = Binding.new(all_locals)
         erb = ::ERB.new(template_content)
-        erb.result(binding_obj.get_binding)
+        erb.result_with_hash(all_locals)
       rescue StandardError => e
         handle_error(e)
       end
-      
+
       def self.render(template_path, locals = {})
         new(template_path, locals).render
       end
-      
+
       private
-      
+
       def handle_error(error)
-        if error.is_a?(SyntaxError)
-          raise Error, "Syntax error in template #{template_path}: #{error.message}"
-        else
-          backtrace = error.backtrace.select { |line| line.include?(template_path) }
-          message = "Error rendering template #{template_path}: #{error.message}"
-          error_with_context = Error.new(message)
-          error_with_context.set_backtrace(backtrace.empty? ? error.backtrace : backtrace)
-          raise error_with_context
-        end
+        raise Error, "Syntax error in template #{template_path}: #{error.message}" if error.is_a?(SyntaxError)
+
+        backtrace = error.backtrace.select { |line| line.include?(template_path) }
+        message = "Error rendering template #{template_path}: #{error.message}"
+        error_with_context = Error.new(message)
+        error_with_context.set_backtrace(backtrace.empty? ? error.backtrace : backtrace)
+        raise error_with_context
       end
     end
   end

data/lib/stellar/erb.rb

@@ -1,16 +1,55 @@
 require_relative "erb/version"
-require_relative "erb/binding"
 require_relative "erb/error"
 require_relative "erb/view"
 require "erb"
 
 module Stellar
   module Erb
+    # :nodoc:
+    # This module provides a lightweight ERB template rendering system
+    # with error handling capabilities.
+
     class Error < StandardError; end
-    
+
     # Shortcut method for rendering templates
+    # This method provides a convenient interface to render ERB templates
+    # directly from the Stellar::Erb module without instantiating a View.
+    #
+    # @param template_path [String] The path to the ERB template file
+    # @param locals [Hash] A hash of local variables to be made available in the template
+    # @return [String] The rendered template result
+    # 
+    # @example Render a template with variables
+    #   Stellar::Erb.render("path/to/template.erb", name: "World")
+    #
+    # @example Render a template without variables
+    #   Stellar::Erb.render("path/to/simple.erb")
+    #
+    # @raise [Stellar::Erb::Error] if an error occurs during template rendering
+    # @raise [Errno::ENOENT] if the template file doesn't exist
     def self.render(template_path, locals = {})
       View.render(template_path, locals)
     end
+
+    # Renders an ERB template from a string instead of a file
+    # This is useful for template strings that are generated dynamically
+    # or stored in a database rather than in files.
+    #
+    # @param str [String] The ERB template string to render
+    # @param locals [Hash] A hash of local variables to be made available in the template
+    # @return [String] The rendered template result
+    #
+    # @example Render a string template with variables
+    #   Stellar::Erb.render_string("<p>Hello, <%= name %></p>", name: "World")
+    #
+    # @example Render a string template without variables
+    #   Stellar::Erb.render_string("<p>Static content</p>")
+    #
+    # @raise [Stellar::Erb::Error] if an error occurs during template rendering
+    def self.render_string(str, locals = {})
+      v = View.new(nil, locals)
+      v.template_content = str
+      v.render()
+    end
   end
 end

data/lib/stellar/erb.rb.2.bak

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "erb/version"
+require_relative "erb/error"
+require_relative "erb/view"
+require "erb"
+
+module Stellar
+  module Erb
+    class Error < StandardError; end
+
+    # Shortcut method for rendering templates
+    def self.render(template_path, locals = {})
+      View.render(template_path, locals)
+    end
+  end
+end

data/lib/stellar/erb.rb.2.diff.bak

@@ -0,0 +1,16 @@
+13,27d12
+<     # This method provides a convenient interface to render ERB templates
+<     # directly from the Stellar::Erb module without instantiating a View.
+<     #
+<     # @param template_path [String] The path to the ERB template file
+<     # @param locals [Hash] A hash of local variables to be made available in the template
+<     # @return [String] The rendered template result
+<     # 
+<     # @example Render a template with variables
+<     #   Stellar::Erb.render("path/to/template.erb", name: "World")
+<     #
+<     # @example Render a template without variables
+<     #   Stellar::Erb.render("path/to/simple.erb")
+<     #
+<     # @raise [Stellar::Erb::Error] if an error occurs during template rendering
+<     # @raise [Errno::ENOENT] if the template file doesn't exist

data/lib/stellar/erb.rb.3.bak

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "erb/version"
+require_relative "erb/error"
+require_relative "erb/view"
+require "erb"
+
+module Stellar
+  module Erb
+    class Error < StandardError; end
+
+    # Shortcut method for rendering templates
+    # This method provides a convenient interface to render ERB templates
+    # directly from the Stellar::Erb module without instantiating a View.
+    #
+    # @param template_path [String] The path to the ERB template file
+    # @param locals [Hash] A hash of local variables to be made available in the template
+    # @return [String] The rendered template result
+    # 
+    # @example Render a template with variables
+    #   Stellar::Erb.render("path/to/template.erb", name: "World")
+    #
+    # @example Render a template without variables
+    #   Stellar::Erb.render("path/to/simple.erb")
+    #
+    # @raise [Stellar::Erb::Error] if an error occurs during template rendering
+    # @raise [Errno::ENOENT] if the template file doesn't exist
+    def self.render(template_path, locals = {})
+      View.render(template_path, locals)
+    end
+    def self.render_string(str, locals = {})
+      v = View.new(nil, locals)
+      v.template_content = str
+      v.render()
+    end
+  end
+end

data/lib/stellar/erb.rb.3.diff.bak

@@ -0,0 +1,30 @@
+0a1,7
+> # frozen_string_literal: true
+> 
+> require_relative "erb/version"
+> require_relative "erb/error"
+> require_relative "erb/view"
+> require "erb"
+> 
+3,6d9
+<     # :nodoc:
+<     # This module provides a lightweight ERB template rendering system
+<     # with error handling capabilities.
+< 
+28,43d30
+< 
+<     # Renders an ERB template from a string instead of a file
+<     # This is useful for template strings that are generated dynamically
+<     # or stored in a database rather than in files.
+<     #
+<     # @param str [String] The ERB template string to render
+<     # @param locals [Hash] A hash of local variables to be made available in the template
+<     # @return [String] The rendered template result
+<     #
+<     # @example Render a string template with variables
+<     #   Stellar::Erb.render_string("<p>Hello, <%= name %></p>", name: "World")
+<     #
+<     # @example Render a string template without variables
+<     #   Stellar::Erb.render_string("<p>Static content</p>")
+<     #
+<     # @raise [Stellar::Erb::Error] if an error occurs during template rendering

data/lib/stellar.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module Stellar
   # This is a namespace module to contain all Stellar components
+  
   autoload :Erb, "stellar/erb"
+  
 end

data/lib/stellar.rb.1.bak

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Stellar
+  # This is a namespace module to contain all Stellar components
+  autoload :Erb, "stellar/erb"
+end

data/lib/stellar.rb.1.diff.bak

@@ -0,0 +1,15 @@
+5,8d4
+<   
+<   # Autoload the Erb module when it's first referenced
+<   # This avoids loading the code until it's needed, improving performance
+<   # and reducing memory usage for applications that don't use Erb functionality
+10,18d5
+<   
+<   # Additional Stellar components can be autoloaded here as the library grows
+<   # For example:
+<   # autoload :Json, "stellar/json"
+<   # autoload :Yaml, "stellar/yaml"
+<   # autoload :Markdown, "stellar/markdown"
+<   
+<   # This module can also include utility methods that are used throughout
+<   # the Stellar framework components

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stellar-erb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Durable Programming, LLC
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE.txt
+- LICENSE
 - README.md
 - bin/console
 - bin/setup
 - lib/stellar.rb
+- lib/stellar.rb.1.bak
 - lib/stellar.rb.1.diff.bak
 - lib/stellar/erb.rb
 - lib/stellar/erb.rb.1.bak
 - lib/stellar/erb.rb.1.diff.bak
-- lib/stellar/erb/binding.rb
+- lib/stellar/erb.rb.2.bak
+- lib/stellar/erb.rb.2.diff.bak
+- lib/stellar/erb.rb.3.bak
+- lib/stellar/erb.rb.3.diff.bak
 - lib/stellar/erb/binding.rb.1.diff.bak
 - lib/stellar/erb/error.rb
 - lib/stellar/erb/error.rb.1.bak

data/lib/stellar/erb/binding.rb

@@ -1,32 +0,0 @@
-module Stellar
-  module Erb
-    class Binding
-      attr_reader :locals
-      
-      def initialize(locals = {})
-        @locals = locals
-      end
-      
-      def get_binding
-        locals.each do |key, value|
-          singleton_class.class_eval do
-            define_method(key) { value }
-          end
-        end
-        binding
-      end
-      
-      def method_missing(method_name, *args, &block)
-        if locals.key?(method_name)
-          locals[method_name]
-        else
-          super
-        end
-      end
-      
-      def respond_to_missing?(method_name, include_private = false)
-        locals.key?(method_name) || super
-      end
-    end
-  end
-end