singer 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23ff6172f3189c234f2b95c1aaee2a67e5b91ffd10c88375c54e37cb4417abb5
-  data.tar.gz: 037ff1bd0e545efd4156ad9ff84cb2934070f0e704e05156acbff1fd7d787cfb
+  metadata.gz: 8d116f657ac1b8d3b57e540ae37bf0d74c21fe357938fbb6aa33309663b9add5
+  data.tar.gz: 7854c981adfd45a2989647f6302022ff0b40e66b47960c2fc536cd428dc99c93
 SHA512:
-  metadata.gz: 494f03f90b0584d1c0ba3ae4b72454151e8379591082e51fa61cbaae3ad65c50b91463ef52ba56208a7ef6f63d6c8b75f4c4f3c99430a9b367284e337f77cf59
-  data.tar.gz: 55646990590d66996705547ed95ff21b21a6a19609db53231c6f416d91fc37d84f0d1fc1c12189b932ade10a479ebef2f619cd5e1a0c8d3b07eb8a1f58f89d4a
+  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/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

data/lib/singer/version.rb

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

data/lib/singer.rb

@@ -1,29 +1,18 @@
 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
 	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
 		unless Template.all.key?(CONFIGURATION.template_name)
 			raise TemplateUnknown, "Template #{CONFIGURATION.template_name.inspect} not found"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: singer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Emil Chludziński
 bindir: exe
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -38,6 +38,7 @@ 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