singer 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a8bd4bab0f3283223aa2db41a7bbffb58e84c8033f123892a5526942e35102
-  data.tar.gz: 0031afac6095b8c2d40b6a699f698c5c170b2a115b4aeca0c5c29149cf22498b
+  metadata.gz: 23ff6172f3189c234f2b95c1aaee2a67e5b91ffd10c88375c54e37cb4417abb5
+  data.tar.gz: 037ff1bd0e545efd4156ad9ff84cb2934070f0e704e05156acbff1fd7d787cfb
 SHA512:
-  metadata.gz: db604b8c31e53948e5a367b4282173ecc098b09ab1cd6c4ff28e941bfd5598818b03551354924e65671de348e09e5bb89d7695565d38340475a49051f9db0a9f
-  data.tar.gz: 90505991f184b2925937143403c70b43287e6bce20088300fe79c603f52cde53d8b87645792b6c07564554c80b4f219689339ab09d96db78682dc4671f89f5c4
+  metadata.gz: 494f03f90b0584d1c0ba3ae4b72454151e8379591082e51fa61cbaae3ad65c50b91463ef52ba56208a7ef6f63d6c8b75f4c4f3c99430a9b367284e337f77cf59
+  data.tar.gz: 55646990590d66996705547ed95ff21b21a6a19609db53231c6f416d91fc37d84f0d1fc1c12189b932ade10a479ebef2f619cd5e1a0c8d3b07eb8a1f58f89d4a

data/exe/singer

@@ -2,4 +2,5 @@
 
 require 'singer'
 
+Singer.configure(ARGV)
 Singer.generate

data/lib/singer/configuration.rb

@@ -0,0 +1,4 @@
+module Singer
+	# holds settings
+	CONFIGURATION = Struct.new(:template_name, :camelcase_name, :snakecase_name).new
+end

data/lib/singer/paths.rb

@@ -4,5 +4,17 @@ module Singer
 		def self.templates_from_gem
 			@templates_from_gem ||= File.expand_path('../../templates', __dir__)
 		end
+
+		def self.output_path(...)
+			File.join(...).gsub(/__([[:alpha:]][[:word:]]+)__/) do |match|
+				potential_config = $1.downcase
+
+				if CONFIGURATION.respond_to?(potential_config)
+					CONFIGURATION.send(potential_config)
+				else
+					match
+				end
+			end
+		end
 	end
 end

data/lib/singer/template.rb

@@ -18,18 +18,17 @@ module Singer
 		def initialize(path)
 			@path = path
 			Dir.chdir(path) do # we could use only Dir[base: path], but all the code uses relative paths
-				entries = Dir['**/*']
+				entries = Dir.glob('**/*', flags: File::FNM_DOTMATCH)
 				@files = entries.select{ File.file?(_1) }
 			end
 		end
 
 		def generate(output_path)
-			FileUtils.mkdir_p(output_path)
 			files.each do |file|
-				input_file = File.join(path, file)
-				output_file = File.join(output_path, file)
-				FileUtils.mkdir_p(File.dirname(output_file))
-				FileUtils.cp(input_file, output_file)
+				source_file = File.join(path, file)
+				target_file = Paths.output_path(output_path, file)
+				FileUtils.mkdir_p(File.dirname(target_file))
+				TemplatingMethods.send(:erb, source_file, target_file)
 			end
 		end
 	end

data/lib/singer/templating_methods.rb

@@ -0,0 +1,14 @@
+require 'erb'
+
+module Singer
+	# different ways to create output file from source template file
+	class TemplatingMethods
+		def self.copy(source_file, target_file)
+			FileUtils.cp(source_file, target_file)
+		end
+
+		def self.erb(source_file, target_file)
+			File.write(target_file, ERB.new(File.read(source_file)).result)
+		end
+	end
+end

data/lib/singer/version.rb

@@ -1,3 +1,3 @@
 module Singer
-	VERSION = '0.2.0'.freeze
+	VERSION = '0.4.0'.freeze
 end

data/lib/singer.rb

@@ -1,12 +1,34 @@
 require_relative 'singer/version'
+require_relative 'singer/configuration'
 require_relative 'singer/paths'
 require_relative 'singer/template'
+require_relative 'singer/templating_methods'
 
 # Singer, which generates Sinatra apps etc. from templates
 module Singer
 	class Error < StandardError; end
+	class NameMissingError < StandardError; end
+	class TemplateUnknown < StandardError; end
+
+	DEFAULT_TEMPLATE_NAME = 'tdd'.freeze
+
+	def self.configure(argvies)
+		raise NameMissingError, 'Missing mandatory argument NAME' if argvies.empty?
+
+		encase_name(argvies.pop)
+		CONFIGURATION.template_name = argvies.shift || DEFAULT_TEMPLATE_NAME
+	end
+
+	def self.encase_name(name)
+		CONFIGURATION.snakecase_name = name.gsub(/(\w)([A-Z])/){ "#{$1}_#{$2}" }.gsub(/_+/, '_').downcase
+		CONFIGURATION.camelcase_name = CONFIGURATION.snakecase_name.split('_').map(&:capitalize).join
+	end
 
 	def self.generate
-		Template.all['tdd'].generate('.')
+		unless Template.all.key?(CONFIGURATION.template_name)
+			raise TemplateUnknown, "Template #{CONFIGURATION.template_name.inspect} not found"
+		end
+
+		Template.all[CONFIGURATION.template_name].generate('.')
 	end
 end

data/templates/sinatra_app/.gitignore

@@ -0,0 +1,12 @@
+# Ruby stuff
+/coverage/
+/doc/
+/.bundle/
+/vendor/
+
+# prototyping and temporary stuff
+/tmp/
+/todo/
+
+# database
+/db/*.sqlite3

data/templates/sinatra_app/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+gem 'colorize'
+gem 'haml'
+gem 'puma'
+gem 'rackup'
+gem 'sassc'
+gem 'sinatra'
+gem 'zeitwerk'
+
+group :test do # for humans
+	gem 'fivemat'
+	gem 'minitest-rg'
+end
+
+group :test, :ci do
+	gem 'minitest', '~> 5.23.0' # fivemat double-outputs with newer than this
+	gem 'mocha'
+	gem 'rack-test'
+	gem 'rake'
+	gem 'rubocop'
+	gem 'simplecov'
+end
+
+group :ci do # for CI automation
+	gem 'minitest-junit'
+	gem 'simplecov-cobertura'
+end

data/templates/sinatra_app/config/config.ru

@@ -0,0 +1,3 @@
+require_relative '../lib/zeitwerk_setup'
+
+run <%= Singer::CONFIGURATION.camelcase_name %>::Server

data/templates/sinatra_app/config/puma.rb

@@ -0,0 +1,6 @@
+port 80, '0.0.0.0'
+
+app_domain = ENV.fetch('APP_DOMAIN', nil)
+cert = "/etc/letsencrypt/live/#{app_domain}/fullchain.pem"
+key = "/etc/letsencrypt/live/#{app_domain}/privkey.pem"
+ssl_bind '0.0.0.0', 443, {cert:, key:} if File.exist?(cert) && File.exist?(key)

data/templates/sinatra_app/exe/server.rb

@@ -0,0 +1,3 @@
+require 'zeitwerk_setup'
+
+<%= Singer::CONFIGURATION.camelcase_name %>::Server.run!

data/templates/sinatra_app/lib/__SNAKECASE_NAME__/hello.rb

@@ -0,0 +1,8 @@
+module <%= Singer::CONFIGURATION.camelcase_name %>
+	# demo class - TODO: remove
+	class Hello
+		def self.greet(target)
+			"Hello, #{target}."
+		end
+	end
+end

data/templates/sinatra_app/lib/__SNAKECASE_NAME__/server.rb

@@ -0,0 +1,38 @@
+require 'sinatra/base'
+require 'haml'
+require 'sassc'
+require 'colorize'
+
+module <%= Singer::CONFIGURATION.camelcase_name %>
+	# Sinatra app with routes
+	class Server < Sinatra::Base
+		set :root, '.' # to make directory structure with views/ work
+		enable :logging
+		configure :development do
+			set :bind, '0.0.0.0'
+			set :port, 80
+		end
+
+		def dump_errors!(boom, out = @env['rack.errors'])
+			filtered_backtrace = boom.backtrace.reject{ _1.include?('/vendor/') }
+			header = "#{Time.now.strftime('%F %T')} - #{boom.class} - #{boom.message.white.on_red}:"
+			error_message = [header, *filtered_backtrace].join("\n\t")
+			out.puts(error_message)
+		end
+
+		def self.compiled_style
+			SassC::Engine.new(File.read('views/style.sass'), syntax: :sass).render
+		end
+		COMPILED_STYLE = compiled_style
+
+		get '/' do
+			redirect '/hello/world'
+		end
+
+		get '/hello/:target' do # TODO: remove
+			@salutation = Hello.greet params[:target]
+
+			haml :index
+		end
+	end
+end

data/templates/sinatra_app/lib/zeitwerk_setup.rb

@@ -0,0 +1,6 @@
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.new
+loader.push_dir 'lib'
+loader.ignore('lib/zeitwerk_setup.rb')
+loader.setup

data/templates/sinatra_app/test/minitest_helper.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'minitest/rg'
+
+require 'mocha/minitest'
+Mocha.configure do |c|
+	c.display_matching_invocations_on_failure = true
+	c.strict_keyword_argument_matching = true
+	c.stubbing_method_on_non_mock_object = :allow
+	c.stubbing_method_unnecessarily = :prevent
+	c.stubbing_non_existent_method = :prevent
+	c.stubbing_non_public_method = :allow
+end
+
+require 'rack/test'
+
+require 'zeitwerk_setup'
+
+ENV['APP_ENV'] = 'test' # so that Sinatra and Sequel know we're in test mode

data/templates/sinatra_app/test/server/test_server.rb

@@ -0,0 +1,32 @@
+require 'minitest_helper'
+
+class TestServer < Minitest::Test
+	include Rack::Test::Methods
+
+	def app
+		<%= Singer::CONFIGURATION.camelcase_name %>::Server
+	end
+
+	def test_top_level_redirects
+		get '/'
+
+		assert last_response.redirect?
+		assert_match %r{/hello/world$}, last_response.headers['location']
+	end
+
+	# TODO: remove
+	def test_hello_with_param_slug_includes_a_greeting
+		get '/hello/everyone'
+
+		refute_predicate last_response, :redirect?
+		assert_predicate last_response, :ok?
+		assert_includes last_response.body, 'Hello, everyone.'
+	end
+
+	def test_hello_without_param_is_a_404_error
+		get '/hello'
+
+		refute_predicate last_response, :ok?
+		assert_equal 404, last_response.status
+	end
+end

data/templates/sinatra_app/test/server/test_server_error_dumping.rb

@@ -0,0 +1,26 @@
+require 'minitest_helper'
+
+class TestServerErrorDumping < 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
+
+		log = mock()
+		log.expects(:puts).with do |message|
+			refute message.lines.any?{ _1.include?('/vendor/') } # now you don't
+		end
+
+		app = <%= Singer::CONFIGURATION.camelcase_name %>::Server.new! # .new! returns real instance without Sinatra::Wrapper
+		app.dump_errors!(exc, log)
+	end
+
+	def generate_exception_with_realistic_backtrace
+		raise 'ciastka'
+	rescue RuntimeError => exc
+		exc
+	end
+
+	def test_generate_exception_with_realistic_backtrace
+		assert_kind_of RuntimeError, generate_exception_with_realistic_backtrace
+	end
+end

data/templates/sinatra_app/test/test_autoloading.rb

@@ -0,0 +1,19 @@
+require 'minitest_helper'
+
+class TestAutoloading < Minitest::Test
+	def test_zeitwerk_has_one_loader
+		refute_empty Zeitwerk::Registry.loaders
+		assert_equal 1, Zeitwerk::Registry.loaders.size
+	end
+
+	# this test is kinda slow, but not as slow as Rack::Test
+	def test_zeitwerk_eager_autoloading_works
+		loader = Zeitwerk::Registry.loaders.first
+		# loader.log!
+		loader.eager_load(force: true)
+	rescue Zeitwerk::NameError => exc
+		flunk exc.message
+	else
+		pass
+	end
+end

data/templates/sinatra_app/test/test_hello.rb

@@ -0,0 +1,8 @@
+require 'minitest_helper'
+
+# TODO: remove
+class TestHello < Minitest::Test
+	def test_greet_with_a_param_generates_a_greeting_string
+		assert_equal 'Hello, stranger.', <%= Singer::CONFIGURATION.camelcase_name %>::Hello.greet(:stranger)
+	end
+end

data/templates/sinatra_app/views/index.haml

@@ -0,0 +1 @@
+#salutation= @salutation

data/templates/sinatra_app/views/layout.haml

@@ -0,0 +1,7 @@
+!!!
+%html
+	%head
+		%title <%= Singer::CONFIGURATION.camelcase_name %>
+		%meta{charset: 'UTF-8'}
+		%style!= COMPILED_STYLE
+	%body!= yield

data/templates/sinatra_app/views/style.sass

@@ -0,0 +1,17 @@
+html
+	--primary-font: Departure Mono, Joystix Monospace, ui-monospace, monospace, sans-serif
+	font-family: var(--primary-font)
+	font-size: 64px
+body
+	--color-text: Black
+	--color-background: White
+	color: var(--color-text)
+	background-color: var(--color-background)
+	margin: 0px
+body > *
+	padding: 1em
+
+@media (prefers-color-scheme: dark)
+	body
+		--color-text: White
+		--color-background: #222

data/templates/tdd/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# gem 'awesome_print'
+gem 'colorize'
+gem 'minitest'
+gem 'minitest-rg'
+# gem 'rake'
+# gem 'rubocop'

data/templates/tdd/lib/{ruby.rb → __SNAKECASE_NAME__.rb}

@@ -1,5 +1,5 @@
 require 'colorize'
-require 'awesome_print'
+# require 'awesome_print'
 
 class <%= Singer::CONFIGURATION.camelcase_name %>
 	def hello(who:)

data/templates/tdd/test/{test_ruby.rb → test___SNAKECASE_NAME__.rb}

@@ -1,7 +1,7 @@
 require 'minitest/rg'
 require 'minitest/autorun' if $PROGRAM_NAME == __FILE__
 
-require_relative '<%= Singer::CONFIGURATION.snakecase_name %>'
+require_relative '../lib/<%= Singer::CONFIGURATION.snakecase_name %>'
 
 class Test<%= Singer::CONFIGURATION.camelcase_name %> < Minitest::Test
 	# TEST_INPUT = File.read('input_mini.txt').lines(chomp: true)

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: singer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Emil Chludziński
 bindir: exe
 cert_chain: []
-date: 2025-01-19 00:00:00.000000000 Z
-dependencies: []
+date: 2025-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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.
@@ -23,11 +37,30 @@ files:
 - README.md
 - exe/singer
 - lib/singer.rb
+- lib/singer/configuration.rb
 - lib/singer/paths.rb
 - lib/singer/template.rb
+- lib/singer/templating_methods.rb
 - lib/singer/version.rb
-- templates/tdd/lib/ruby.rb
-- templates/tdd/test/test_ruby.rb
+- templates/sinatra_app/.gitignore
+- templates/sinatra_app/Gemfile
+- templates/sinatra_app/config/config.ru
+- templates/sinatra_app/config/puma.rb
+- templates/sinatra_app/exe/server.rb
+- templates/sinatra_app/lib/__SNAKECASE_NAME__/hello.rb
+- templates/sinatra_app/lib/__SNAKECASE_NAME__/server.rb
+- templates/sinatra_app/lib/zeitwerk_setup.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/views/index.haml
+- templates/sinatra_app/views/layout.haml
+- templates/sinatra_app/views/style.sass
+- templates/tdd/Gemfile
+- templates/tdd/lib/__SNAKECASE_NAME__.rb
+- templates/tdd/test/test___SNAKECASE_NAME__.rb
 homepage: https://gitlab.com/tanstaafl/singer/
 licenses:
 - MIT