insider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed15027e66018294873cd41ec95c5c771cf0cf4f78230b1137ec46e3c4637533
+  data.tar.gz: aff3295b000958c970d20b15b09091086e0d7678c43ab17e69760cecada49ec0
+SHA512:
+  metadata.gz: c2bd1cb4d634e604778c6eb2db9c825d45b9d3a2f98dea0e71180b97c9663c3ae106b8e5abfe3f585df241326c5ddf6f695ec6a0e7be7a155f4b2d795f4e0f14
+  data.tar.gz: fe51d7b831a6ee46e9b2f03db9f7a4d78aebbad1ea81748cd24c0ebea5e27eed1dc870c9b71bd52c27c33d0c6f9c38606f09ae339f9df23da7fb313f5beab983

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-01-25
+
+### Added
+- Initial release of Insider gem
+- Template class with variable substitution functionality
+- Support for `{{variable}}` syntax in templates
+- `Insider[id]` class method for creating templates
+- `insider(name)` instance method for creating templates
+- `apply(variables)` method for template rendering
+- Complete API documentation with YARD comments
+- Comprehensive README with installation and usage examples
+- MIT License
+
+### Features
+- Simple and intuitive template engine
+- Support for multiple variable substitutions
+- Reusable template instances
+- Zero dependency footprint
+- Ruby 2.6.0+ compatibility
+
+### Documentation
+- Full README with examples and API reference
+- Inline code documentation with YARD tags
+- Basic changelog structure

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in insider.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Erik Olson
+
+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,99 @@
+# Insider
+
+A simple and elegant Ruby gem for string template interpolation with variable substitution.
+
+## Features
+
+- Simple template engine with `{{variable}}` syntax
+- Lightweight and dependency-free
+- Easy-to-use API for quick template rendering
+- Support for multiple variable substitutions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'insider'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install insider
+```
+
+## Usage
+```ruby
+# first and always
+require 'insider'
+
+
+# 1. By using including the module within a class
+class MyClass
+  include Insider
+  attr_reader :message
+  def initialize name
+    @name = name
+    # 2. creating an insider instance
+    @message = insider("my_class_id")
+  end
+  def hello!
+    # 3. the template can be set
+    @message.template = %["Hello, {{name}}!"]
+    # 4. and arguments applied
+    @message.apply(name: @name)
+    # 5. anywhere!
+  end
+end
+
+# then, by creating a class instance
+@x = MyClass.new("World")
+# our insider can work.
+@x.hello! => "Hello, World!"
+
+### AND / OR ###
+
+# Use the module directly
+# 1. create an instance
+@template = Insider[:my_template]
+# 2. set the template
+@template.template = "Hello, {{name}}!"
+# 3. apply arguments
+@template.apply(name: "World") => "Hello, World!"
+```
+
+## API Reference
+
+### Insider::Template
+
+#### Methods
+
+- `initialize(id)` - Creates a new template with the given identifier
+- `template` - Getter/setter for the template string
+- `apply(variables = {})` - Applies variable substitution to the template
+
+### Insider Module
+
+- `Insider[id]` - Creates a new template instance with the given ID
+- `insider(name)` - Instance method to create a new template
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/insider.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/insider/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Insider
+  VERSION = "0.1.0"
+end

data/lib/insider.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "insider/version"
+
+module Insider
+  # Custom error class for Insider gem
+  class Error < StandardError; end
+
+  # Template class for managing and rendering string templates with variable substitution
+  class Template
+    # @return [String, nil] The template string with {{variable}} placeholders
+    attr_accessor :template
+
+    # Initialize a new Template instance
+    # @param id [String, Integer] The identifier for the template
+    def initialize(id)
+      @id = id
+    end
+
+    # Apply variable substitution to the template
+    # @param variables [Hash] Hash of variable names and their replacement values
+    # @return [String] The rendered template with all placeholders replaced
+    # @example
+    #   template = Template.new(:greeting)
+    #   template.template = "Hello, {{name}}!"
+    #   template.apply(name: "World") #=> "Hello, World!"
+    def apply(variables = {})
+      result = @template.dup
+      variables.each do |key, value|
+        result.gsub!("{{#{key}}}", value.to_s)
+      end
+      result
+    end
+  end
+
+  # Instance method to create a new Template
+  # @param name [String, Integer] The identifier for the template
+  # @return [Template] A new Template instance
+  def insider(name)
+    Template.new(name)
+  end
+
+  # Class method to create a new Template
+  # @param key [String, Integer] The identifier for the template
+  # @return [Template] A new Template instance
+  # @example
+  #   template = Insider[:email]
+  #   template.template = "Dear {{name}}, your order {{order_id}} is ready."
+  #   template.apply(name: "John", order_id: "12345") #=> "Dear John, your order 12345 is ready."
+  def self.[](key)
+    Template.new(key)
+  end
+end
+
+##
+# @example Basic usage
+#   insider = Insider[:my_template]
+#   insider.template = "Hello, {{x}}!"
+#   insider.apply(x: "World!") #=> "Hello, World!"
+#
+# @example Multiple variables
+#   template = Insider[:email]
+#   template.template = "Dear {{name}}, your order {{order_id}} is {{status}}."
+#   template.apply(name: "Alice", order_id: "12345", status: "shipped")
+#   #=> "Dear Alice, your order 12345 is shipped."

data/sig/insider.rbs

@@ -0,0 +1,4 @@
+module Insider
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: insider
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Olson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-26 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight and elegant Ruby gem for string template interpolation
+  using {{variable}} syntax. Perfect for generating dynamic content, emails, or any
+  text that requires variable substitution.
+email:
+- xorgnak@xorgnak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/insider.rb
+- lib/insider/version.rb
+- sig/insider.rbs
+homepage: https://github.com/xorgnak/insider
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/xorgnak/insider
+  source_code_uri: https://github.com/xorgnak/insider
+  changelog_uri: https://github.com/xorgnak/insider/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.3.15
+signing_key:
+specification_version: 4
+summary: Simple Ruby template engine with variable substitution
+test_files: []