singer 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d324ad6ec097b02fe9db6ab844205b37dd6a53450d69d5c7780d5bd7e7743efa
-  data.tar.gz: 9990fccac83a6ce04a3d89da50e7dd6b109edbfb74fa48e938b40839c34dfe5e
+  metadata.gz: 8d116f657ac1b8d3b57e540ae37bf0d74c21fe357938fbb6aa33309663b9add5
+  data.tar.gz: 7854c981adfd45a2989647f6302022ff0b40e66b47960c2fc536cd428dc99c93
 SHA512:
-  metadata.gz: b5ae6fa28d28668e5afa00615770a6e69628f767e7adaa1344d26bc6e9e0e4c26a60c17aeb51ccae165ad4e50a77fac52b9e38d391d3de01ff398df36bda6682
-  data.tar.gz: f1f56ff0b4234f45d9a68835d9c69110481567aa7a3554f06240913b6125e9017439d601754e522710b326bf6f402b1771f181b2ffb27cf746da1a8fc3762990
+  metadata.gz: 933cc4b306f621d57598f0b1d5f72993fd6c25afea2496aa89f088847b42374b8a01bf68d709a2c3f154455b02b6158f2072677ec23b55ff1b359020c24cfbe5
+  data.tar.gz: 0ed47b046d03641227f28faa499d9ea50cd80901ddf7efa75f5c1da4df07a54b5ad435bb338158047438175862c17b310e92d19ee94ecfafdf135d9810dce468

data/README.md

@@ -8,7 +8,14 @@ Run `gem install singer`.
 
 ## Usage
 
-TODO: Write usage instructions here
+```bash
+singer [OPTION]... [TEMPLATE_NAME] PROJECT_NAME
+```
+
+Run `singer --help` to see up-to-date list of options.
+Run `singer --list-templates` to see available templates' names, both shipped with the gem and found on current system.
+
+For `PROJECT_NAME`, using `snake_case` is best, although an attempt will be made to understand `CamelCase`, too.
 
 ## Development
 

data/exe/singer

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

data/lib/singer/configuration.rb

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

data/lib/singer/option_parsing.rb

@@ -0,0 +1,40 @@
+module Singer
+	# extracts what we need from ARGV
+	class OptionParsing
+		DEFAULT_TEMPLATE_NAME = 'tdd'.freeze
+
+		def self.configure(argvies) # rubocop:disable Metrics/MethodLength
+			options = {}
+			OptionParser.new do |parser|
+				parser.banner = <<~USAGE
+					Usage: #{$PROGRAM_NAME} [OPTION]... [TEMPLATE_NAME] PROJECT_NAME
+					Generates a project from a multi-file template.
+					PROJECT_NAME can be in snake_case or CamelCase.
+
+					Options:
+				USAGE
+				parser.on('--list-templates', 'list all available templates') do
+					list_all_templates
+					Kernel.exit
+				end
+			end.parse!(argvies, into: options)
+
+			raise NameMissingError, 'Missing mandatory argument PROJECT_NAME' if argvies.empty?
+
+			encase_name(argvies.pop)
+			CONFIGURATION.template_name = argvies.shift || DEFAULT_TEMPLATE_NAME
+		end
+
+		def self.list_all_templates
+			name_column_width = Template.all.keys.map(&:length).max
+			Template.all.each do |name, template|
+				puts "#{name.to_s.ljust(name_column_width)} #{template.path}"
+			end
+		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
+	end
+end

data/lib/singer/paths.rb

@@ -1,6 +1,18 @@
 module Singer
 	# helps find files
 	class Paths
+		def self.xdg_config_dir
+			@xdg_config_dir ||= ENV.fetch('XDG_CONFIG_DIR', File.join(Dir.home, '.config'))
+		end
+
+		def self.singer_config_dir
+			@singer_config_dir ||= File.join(xdg_config_dir, 'singer')
+		end
+
+		def self.templates_from_user
+			@templates_from_user ||= File.join(singer_config_dir, 'templates')
+		end
+
 		def self.templates_from_gem
 			@templates_from_gem ||= File.expand_path('../../templates', __dir__)
 		end

data/lib/singer/template.rb

@@ -8,7 +8,13 @@ module Singer
 		end
 
 		def self.load_all
-			Dir[File.join(Paths.templates_from_gem, '*')].to_h do |template_dir|
+			[Paths.templates_from_gem, Paths.templates_from_user]
+				.map{ load_from_directory(_1) }
+				.reduce(&:merge)
+		end
+
+		def self.load_from_directory(dir)
+			Dir[File.join(dir, '*')].to_h do |template_dir|
 				[File.basename(template_dir), new(template_dir)]
 			end
 		end
@@ -18,7 +24,7 @@ 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

data/lib/singer/version.rb

@@ -1,3 +1,3 @@
 module Singer
-	VERSION = '0.3.0'.freeze
+	VERSION = '1.0.0'.freeze
 end

data/lib/singer.rb

@@ -1,26 +1,23 @@
 require_relative 'singer/version'
 require_relative 'singer/configuration'
+require_relative 'singer/option_parsing'
 require_relative 'singer/paths'
 require_relative 'singer/template'
 require_relative 'singer/templating_methods'
 
+require 'optparse'
+
 # Singer, which generates Sinatra apps etc. from templates
 module Singer
 	class Error < StandardError; end
 	class NameMissingError < StandardError; end
-
-	def self.configure(argvies)
-		raise NameMissingError, 'Missing mandatory argument NAME' if argvies.empty?
-
-		encase_name(argvies.last)
-	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
+	class TemplateUnknown < StandardError; 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'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: singer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Emil Chludziński
 bindir: exe
 cert_chain: []
-date: 2025-01-21 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -38,10 +38,28 @@ files:
 - exe/singer
 - lib/singer.rb
 - lib/singer/configuration.rb
+- lib/singer/option_parsing.rb
 - lib/singer/paths.rb
 - lib/singer/template.rb
 - lib/singer/templating_methods.rb
 - lib/singer/version.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/