stellar-erb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d36ba6cabfdabcea69f3c1eae4a85ac8a178295783bb045eddfa1fe3f466671
+  data.tar.gz: 2a278f0be5a4b6d19635fc5de83737b260ee0904573dcc4986d64f0c131ba6b8
+SHA512:
+  metadata.gz: a1d708c9a15b841ac2c9ed100c6d513cffad5b3f18b0adbca3ac0ed2cb057f6f46e6b18841a6570903b3e8dff00a4f856f28fc7befd71d1bd4b5f03ab212f9b5
+  data.tar.gz: 835d54c01f66476e40595ec201c6b02f727d680ff6898bdb0fd9e38f83b3d749d15e7fada2656f9d56d9ca293e01ec86047c764d34b91407d4f1d758e2a27cd1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-13
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David J Berube
+
+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.

data/README.md

@@ -0,0 +1,134 @@
+# Stellar::Erb
+
+![Stellar::ERb logo](logo.png)
+
+
+
+A safe, easy to use wrapper for ERB (Embedded Ruby) templates 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
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stellar-erb'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install stellar-erb
+```
+
+## Usage
+
+### Basic Template Rendering
+
+```ruby
+# template.erb
+<h1>Hello, <%= name %>!</h1>
+<ul>
+  <% items.each do |item| %>
+    <li><%= item %></li>
+  <% end %>
+</ul>
+
+# Ruby code
+result = Stellar::Erb::View.render('template.erb', 
+  name: 'John', 
+  items: ['apple', 'banana', 'orange']
+)
+```
+
+
+
+#### Creating Reusable Views
+
+```ruby
+# Create a view instance for reuse
+view = Stellar::Erb::View.new('templates/header.erb', 
+  company_name: 'Acme Corp'
+)
+
+# Render multiple times with different locals
+page1 = view.render(title: 'Home')
+page2 = view.render(title: 'About')
+```
+
+#### Error Handling
+
+```ruby
+begin
+  Stellar::Erb::View.render('template.erb', user: current_user)
+rescue Stellar::Erb::Error => e
+  puts "Error: #{e.message}"
+  puts "\nContext:"
+  puts e.context_lines.join("\n")
+  puts "\nOriginal error: #{e.original_error.class}"
+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.
+
+Development workflow:
+
+```mermaid
+flowchart TD
+    A[Fork Repository] --> B[Clone Locally]
+    B --> C[Install Dependencies]
+    C --> D[Run Tests]
+    D --> E{Tests Pass?}
+    E -->|Yes| F[Create Feature Branch]
+    E -->|No| D
+    F --> G[Make Changes]
+    G --> H[Run Tests]
+    H --> I{Tests Pass?}
+    I -->|Yes| J[Submit PR]
+    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).
+
+
+## Support
+
+For bug reports and feature requests, please use the [GitHub Issues](https://github.com/durableprogramming/stellar-erb/issues) page.
+
+---
+
+Stellar::Erb is actively maintained by [Durable Programming, LLC](https://github.com/durableprogramming).
+
+
+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)

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "stellar/erb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/stellar/erb/binding.rb

@@ -0,0 +1,32 @@
+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

data/lib/stellar/erb/error.rb

@@ -0,0 +1,63 @@
+module Stellar
+  module Erb
+    class Error < StandardError
+      attr_reader :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
+        super(message)
+      end
+
+      def to_s
+        message = super
+        if template_path && line_number
+          "#{message} in '#{template_path}' on line #{line_number}"
+        elsif template_path
+          "#{message} in '#{template_path}'"
+        else
+          message
+        end
+      end
+
+      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, 
+            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
+  end
+end

data/lib/stellar/erb/error.rb.1.bak

@@ -0,0 +1,47 @@
+module Stellar
+  module Erb
+    class Error < StandardError
+      attr_reader :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
+        super(message)
+      end
+
+      def to_s
+        message = super
+        if template_path && line_number
+          "#{message} in '#{template_path}' on line #{line_number}"
+        elsif template_path
+          "#{message} in '#{template_path}'"
+        else
+          message
+        end
+      end
+
+      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, 
+            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
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+45,60d44
+<       
+<       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

data/lib/stellar/erb/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stellar
+  module Erb
+    VERSION = "0.1.0"
+  end
+end

data/lib/stellar/erb/view.rb

@@ -0,0 +1,40 @@
+module Stellar
+  module Erb
+    class View
+      attr_reader :template_path, :template_content, :locals
+      
+      def initialize(template_path, locals = {})
+        @template_path = template_path
+        @template_content = File.read(template_path)
+        @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)
+      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
+      end
+    end
+  end
+end

data/lib/stellar/erb/view.rb.1.bak

@@ -0,0 +1,41 @@
+module Stellar
+  module Erb
+    class View
+      attr_reader :template_path, :template, :context
+
+      def initialize(template_path, context = {})
+        @template_path = template_path
+        @context = context
+        @template = File.read(template_path)
+      end
+
+      def render(locals = {})
+        b = binding_with_context(locals)
+        result = ::ERB.new(template, trim_mode: '-').result(b)
+        result
+      rescue => e
+        handle_error(e)
+      end
+
+      private
+
+      def binding_with_context(locals = {})
+        context_binding = binding
+        context.merge(locals).each do |key, value|
+          context_binding.local_variable_set(key.to_sym, value)
+        end
+        context_binding
+      end
+
+      def handle_error(error)
+        if error.backtrace.any? { |line| line.include?(template_path) }
+          raise error
+        else
+          new_error = error.class.new("#{error.message} (in template: #{template_path})")
+          new_error.set_backtrace(error.backtrace)
+          raise new_error
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+4,6c4,6
+<       attr_reader :template_path, :template_content, :locals
+<       
+<       def initialize(template_path, locals = {})
+---
+>       attr_reader :template_path, :template, :context
+> 
+>       def initialize(template_path, context = {})
+8,9c8,9
+<         @template_content = File.read(template_path)
+<         @locals = locals
+---
+>         @context = context
+>         @template = File.read(template_path)
+11,17c11,16
+<       
+<       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)
+<       rescue StandardError => e
+---
+> 
+>       def render(locals = {})
+>         b = binding_with_context(locals)
+>         result = ::ERB.new(template, trim_mode: '-').result(b)
+>         result
+>       rescue => e
+20,24c19
+<       
+<       def self.render(template_path, locals = {})
+<         new(template_path, locals).render
+<       end
+<       
+---
+> 
+26c21,29
+<       
+---
+> 
+>       def binding_with_context(locals = {})
+>         context_binding = binding
+>         context.merge(locals).each do |key, value|
+>           context_binding.local_variable_set(key.to_sym, value)
+>         end
+>         context_binding
+>       end
+> 
+28,29c31,32
+<         if error.is_a?(SyntaxError)
+<           raise Error, "Syntax error in template #{template_path}: #{error.message}"
+---
+>         if error.backtrace.any? { |line| line.include?(template_path) }
+>           raise error
+31,35c34,36
+<           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
+---
+>           new_error = error.class.new("#{error.message} (in template: #{template_path})")
+>           new_error.set_backtrace(error.backtrace)
+>           raise new_error

data/lib/stellar/erb.rb

@@ -0,0 +1,16 @@
+require_relative "erb/version"
+require_relative "erb/binding"
+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.1.bak

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "erb/version"
+
+module Stellar
+  module Erb
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

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

@@ -0,0 +1,16 @@
+0a1,2
+> # frozen_string_literal: true
+> 
+2,5d3
+< require_relative "erb/binding"
+< require_relative "erb/error"
+< require_relative "erb/view"
+< require "erb"
+10,14c8
+<     
+<     # Shortcut method for rendering templates
+<     def self.render(template_path, locals = {})
+<       View.render(template_path, locals)
+<     end
+---
+>     # Your code goes here...

data/lib/stellar.rb

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

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: stellar-erb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Durable Programming, LLC
+autorequire:
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Stellar::Erb provides a method for reading .erb files from disk and rendering
+  them to strings, passing arguments, and catching errors with correct backtraces
+  and context.
+email:
+- djberube@durableprogramming.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/stellar.rb
+- 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/binding.rb.1.diff.bak
+- lib/stellar/erb/error.rb
+- lib/stellar/erb/error.rb.1.bak
+- lib/stellar/erb/error.rb.1.diff.bak
+- lib/stellar/erb/version.rb
+- lib/stellar/erb/view.rb
+- lib/stellar/erb/view.rb.1.bak
+- lib/stellar/erb/view.rb.1.diff.bak
+homepage: https://github.com/durableprogramming/stellar-erb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/durableprogramming/stellar-erb
+  source_code_uri: https://github.com/durableprogramming/stellar-erb
+  changelog_uri: https://github.com/durableprogramming/stellar-erb/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A safe, easy to use wrapper for ERB views outside of Rails
+test_files: []