singer 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91934a916b675cfddecdac26f48673a77e9e2f014ae94a7db7623df0adaac67
-  data.tar.gz: f8a8384bdbba9f096d303e91fbd68a2b1063239d89e5f072d1e8e551cee1b7d2
+  metadata.gz: 1496a866af8bd84f5f37b7fd231ebca183cb1af9527c80fcf82d7d12e559ae60
+  data.tar.gz: d162ae6671bde936f13594d4a9ce989179d207f96a92eb3a24496f5db5116fe6
 SHA512:
-  metadata.gz: 5a0d34e3e4ba0b18a55151f796f30d8b0bad715f74a084f37456a4cdebb74d8f66543db90003dc84877a19ef295f0664f1e5ba190cd137d67a670f8819802d01
-  data.tar.gz: d9245c0f2fcbc5671a078daf5bcf71977ba2ec661c1b599e0aedaa2e679948bc4d9ebad738a6302daefe515dae253a5d8d59d6b12b0779b7796b6c9bf52b35d2
+  metadata.gz: 475541c7ea0a9c63f64eb9ee72c8267b0e4eb9f3aa9e240587e37010077123a8dc3e7ab2005c0bea4a7bd0849ec088879d4acb6967ebad766ab829e1b093d26c
+  data.tar.gz: c2cb1b56b6b65d644a844c7305ebf1fa2158d221bce249d1f9cd8970273709f0578df79c2307d89037fa45a57912ccc0a4b6341395ff6e16c651ede61823c57d

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2025 Emil Chludziński
+Copyright (c) 2025-2026 Emil Chludziński
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -19,13 +19,17 @@ For `PROJECT_NAME`, using `snake_case` is best, although an attempt will be made
 
 ## Writing your own templates
 
-Many features of Singer will become clearer when seeing actual usage - please feel encouraged to examine the templates shipped with the gem (you can find them in `templates_from_gem` shown by the `singer --show-paths`).
+Many features of Singer will become clearer when seeing actual usage - please feel encouraged to examine the templates shipped with the gem (you can find them in `templates_from_gem` shown by the `singer --list-paths`).
 
 ### Template location
 
-User-provided templates should be placed in the directory named `templates_from_user` in the `singer --show-paths` output.
+User-provided templates should be placed in the directory named `templates_from_user` in the `singer --list-paths` output.
 Each template resides in a subdirectory - the subdirectory's name becomes the template's name, and is not included in the generated paths (Singer will only replicate the directory structure _inside_ it).
 
+### Using templates from somewhere else
+
+You can also, instead of the name of a known template via `[TEMPLATE_NAME]`, specify the full path to your custom template with the `--template-path` option.
+
 ### Variables available to templates
 
 Templates written in ERB or other templating mechanisms that execute Ruby code will have access to `Singer.configuration` object and its accessors. For example, the following code in a `my_template`'s file:

data/lib/singer/paths.rb

@@ -18,7 +18,12 @@ module Singer
 		end
 
 		def self.output_path(...)
-			File.join(...).gsub(/__([[:alpha:]][[:word:]]+)__/) do |match|
+			substitute_variables(File.join(...))
+		end
+
+		# will substitute non-forbidden variables, 2 characters or more
+		def self.substitute_variables(path)
+			path.gsub(/__([[:alpha:]][[:word:]]*[[:alpha:]])__/) do |match|
 				potential_config = $1.downcase
 
 				if variable_name_can_be_substituted?(potential_config)

data/lib/singer/version.rb

@@ -1,3 +1,3 @@
 module Singer
-	VERSION = '2.0.0'.freeze
+	VERSION = '2.2.0'.freeze
 end

data/templates/sinatra_app/test/{test_autoloading.rb → autoloading_test.rb}

@@ -1,6 +1,6 @@
 require 'minitest_helper'
 
-class TestAutoloading < Minitest::Test
+class AutoloadingTest < Minitest::Test
 	def test_zeitwerk_has_one_loader
 		refute_empty Zeitwerk::Registry.loaders
 		assert_equal 1, Zeitwerk::Registry.loaders.size

data/templates/sinatra_app/test/{test_hello.rb → hello_test.rb}

@@ -1,7 +1,7 @@
 require 'minitest_helper'
 
 # TODO: remove
-class TestHello < Minitest::Test
+class HelloTest < Minitest::Test
 	def test_greet_with_a_param_generates_a_greeting_string
 		assert_equal 'Hello, stranger.', <%= Singer.configuration.project_name_camelcase %>::Hello.greet(:stranger)
 	end

data/templates/sinatra_app/test/server/{test_server_error_dumping.rb → server_error_dumping_test.rb}

@@ -1,6 +1,6 @@
 require 'minitest_helper'
 
-class TestServerErrorDumping < Minitest::Test
+class ServerErrorDumpingTest < Minitest::Test
 	def test_dump_errors_backtrace_is_filtered_against_vendor
 		exc = generate_exception_with_realistic_backtrace
 		assert exc.backtrace.any?{ _1.include?('/vendor/') } # now you see me

data/templates/sinatra_app/test/server/{test_server.rb → server_test.rb}

@@ -1,6 +1,6 @@
 require 'minitest_helper'
 
-class TestServer < Minitest::Test
+class ServerTest < Minitest::Test
 	include Rack::Test::Methods
 
 	def app

data/templates/tdd/test/{test___PROJECT_NAME_SNAKECASE__.rb → __PROJECT_NAME_SNAKECASE___test.rb}

@@ -3,7 +3,7 @@ require 'minitest/autorun' if File.expand_path($PROGRAM_NAME) == File.expand_pat
 
 require_relative '../lib/<%= Singer.configuration.project_name_snakecase %>'
 
-class Test<%= Singer.configuration.project_name_camelcase %> < Minitest::Test
+class <%= Singer.configuration.project_name_camelcase %>Test < Minitest::Test
 	# TEST_INPUT = File.read('input_mini.txt').lines(chomp: true)
 
 	def setup

data/templates/test/test/__PROJECT_NAME_SNAKECASE___test.rb

@@ -0,0 +1,9 @@
+class <%= Singer.configuration.project_name_camelcase %>Test < Minitest::Test
+	def setup
+		@<%= Singer.configuration.project_name_snakecase %> = <%= Singer.configuration.project_name_camelcase %>.new
+	end
+
+	def test_something
+		flunk
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: singer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Emil Chludziński
@@ -25,7 +25,8 @@ dependencies:
         version: '0'
 description: |
   Singer is a highly configurable templating system intended for generating Ruby boilerplate.
-  It aims to make creating and extending Sinatra apps easier.
+  Its main aim is to make creating and extending Sinatra apps easier.
+  It can also be used to generate pretty much any other files from templates, with defined directory structure.
 email:
 - tanstaafl@tlen.pl
 executables:
@@ -52,17 +53,18 @@ files:
 - templates/sinatra_app/lib/__PROJECT_NAME_SNAKECASE__/hello.rb
 - templates/sinatra_app/lib/__PROJECT_NAME_SNAKECASE__/server.rb
 - templates/sinatra_app/lib/zeitwerk_setup.rb
+- templates/sinatra_app/test/autoloading_test.rb
+- templates/sinatra_app/test/hello_test.rb
 - templates/sinatra_app/test/minitest_helper.rb
-- templates/sinatra_app/test/server/test_server.rb
-- templates/sinatra_app/test/server/test_server_error_dumping.rb
-- templates/sinatra_app/test/test_autoloading.rb
-- templates/sinatra_app/test/test_hello.rb
+- templates/sinatra_app/test/server/server_error_dumping_test.rb
+- templates/sinatra_app/test/server/server_test.rb
 - templates/sinatra_app/views/index.haml
 - templates/sinatra_app/views/layout.haml
 - templates/sinatra_app/views/style.sass
 - templates/tdd/Gemfile
 - templates/tdd/lib/__PROJECT_NAME_SNAKECASE__.rb
-- templates/tdd/test/test___PROJECT_NAME_SNAKECASE__.rb
+- templates/tdd/test/__PROJECT_NAME_SNAKECASE___test.rb
+- templates/test/test/__PROJECT_NAME_SNAKECASE___test.rb
 homepage: https://gitlab.com/tanstaafl/singer/
 licenses:
 - MIT
@@ -84,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Singer generates code (such as Sinatra apps) from templates.
 test_files: []