sscharter 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1695717274c0888590e92f6a3dabf86fca4a2d34aaad9f17dc9a88ab20311207
-  data.tar.gz: 78096695809b63551d5f48a3c11d4120ead84157c1146b4064a9f8f1262b66c7
+  metadata.gz: bd7619bb9674b4ec547ba0484ff931c1f39603ffa03fc0a32e826ef4e83adb46
+  data.tar.gz: 668322b1a02019b1ebfad49332cea047c8cd91f5f2de62be88a68dc64460a88c
 SHA512:
-  metadata.gz: 8e64530c4c426710eae970e9bd7fd4609d307a75102cdea4920f9ed5ae8208313cc48efae86c545b95cdecaec79e6da6738d92d5db1f8861ea142b3f2b843c88
-  data.tar.gz: 64725aa5bf3336f3ab3965f583cf4ed80e02296a18a1be9c1427542d9bc79164b602f99b19a2c7f45e243d32e8456911940971ffd3794e8027ec6e4db17d5221
+  metadata.gz: ec041e5ebef20b6e9794a91b842ef7446305732564bdf6e8afd25e4d5a2281d9b6cbb37787a11cee7ce29d2a581aa31bbdf513bdb9f0661f5498e4b412ea26f9
+  data.tar.gz: 9e10bf1ef26b57f7cade038f5cc5cf290aa14b72050c6c3136f96a0c0511dff2ce43300a0b81fb66c0d75deda496ba1da4a13a174ff53f36b2ffb6cbc4f883ad

data/Gemfile

@@ -2,17 +2,4 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in sscharter.gemspec
 gemspec
-
-group :develop do
-	gem 'rake', '~> 13.0'
-	gem 'minitest', '~> 5.0'
-end
-
-gem 'rubyzip', '~> 2.3'
-gem 'launchy', '~> 2.5'
-gem 'webrick', '~> 1.8'
-gem 'filewatcher', '~> 2.0'
-gem 'em-websocket', '~> 0.5'
-gem 'concurrent-ruby', '~> 1.3'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    sscharter (0.7.0)
+    sscharter (0.9.0)
+      base64
       concurrent-ruby (~> 1.3)
       em-websocket (~> 0.5)
       filewatcher (~> 2.0)
       launchy (~> 2.5)
-      rubyzip (~> 2.3)
+      rubyzip (~> 3.1)
       webrick (~> 1.8)
 
 GEM
@@ -14,7 +15,8 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    concurrent-ruby (1.3.4)
+    base64 (0.3.0)
+    concurrent-ruby (1.3.5)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
@@ -24,27 +26,23 @@ GEM
     http_parser.rb (0.8.0)
     launchy (2.5.2)
       addressable (~> 2.8)
-    minitest (5.25.1)
+    minitest (5.25.5)
     module_methods (0.1.0)
-    public_suffix (6.0.1)
-    rake (13.2.1)
-    rubyzip (2.3.2)
-    webrick (1.8.1)
+    public_suffix (6.0.2)
+    rake (13.3.0)
+    rubyzip (3.1.0)
+    webrick (1.9.1)
+    yard (0.9.37)
 
 PLATFORMS
   x64-mingw-ucrt
   x86_64-linux
 
 DEPENDENCIES
-  concurrent-ruby (~> 1.3)
-  em-websocket (~> 0.5)
-  filewatcher (~> 2.0)
-  launchy (~> 2.5)
   minitest (~> 5.0)
   rake (~> 13.0)
-  rubyzip (~> 2.3)
   sscharter!
-  webrick (~> 1.8)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   2.5.17
+   2.7.1

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 sunniesnow
+Copyright (c) 2025 sunniesnow
 
 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

@@ -1,4 +1,4 @@
-# Sscharter
+# sscharter
 
 A Ruby DSL for writing Sunniesnow charts.
 
@@ -7,7 +7,7 @@ A Ruby DSL for writing Sunniesnow charts.
 [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/).
 Then, run
 
-```shell
+```
 gem install sscharter
 ```
 
@@ -27,4 +27,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sunnie
 
 ## Code of Conduct
 
-Everyone interacting in the Sscharter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sscharter/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the sscharter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sunniesnow/sscharter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+Rake::TestTask.new :test do |t|
+	t.libs << 'test'
+	t.libs << 'lib'
+	t.test_files = FileList['test/**/test_*.rb']
+end
+
+YARD::Rake::YardocTask.new do |t|
+	t.files.concat %w[README.md]
+	t.options.concat %w[--title sscharter --output-dir doc --exclude lib/sscharter/cli.rb --readme]
 end
 
 task default: :test

data/lib/sscharter/chart.rb

@@ -2,14 +2,41 @@
 
 require 'json'
 
+# A class to represent a chart.
+# Basically a wrapper around the metadata and events ({Sunniesnow::Event}) of a chart.
+# The main method is {#to_json}, which converts the chart to a JSON string
+# that is actually recognizable by Sunniesnow.
 class Sunniesnow::Chart
 
 	using Sunniesnow::Utils
 
-	attr_accessor :title, :artist, :charter
-	attr_accessor :difficulty_name, :difficulty_color, :difficulty, :difficulty_sup
+	# The schema URL for the output JSON.
+	# This will be set as the `$schema` property in the generated JSON.
+	SCHEMA = 'https://sunniesnow.github.io/schema/chart-1.0.json'
+
+	# The title of the music.
+	# This is one of the metadata of the chart which will be reflected in the generated JSON.
+	# Also, see
+	# {chart file specifications}[https://sunniesnow.github.io/doc/chart.html#title]
+	# for more info.
+	attr_accessor :title
+	
+	attr_accessor :artist
+	attr_accessor :charter
+	attr_accessor :difficulty_name
+	attr_accessor :difficulty_color
+	attr_accessor :difficulty
+	attr_accessor :difficulty_sup
+
+	# An array of Sunniesnow::Event.
 	attr_reader :events
 
+	# @param [Integer] live_reload_port The port to use for live reload.
+	#   It is useless if +production+ is +true+.
+	# @param [Boolean] production Whether the chart is in production or not.
+	#   If +true+, the generated JSON (see {#to_json}) will not contain
+	#   necessary information for sscharter integration in Sunniesnow
+	#   (such as the live reload feature and reverse search feature).
 	def initialize live_reload_port: 31108, production: false
 		@title = ''
 		@artist = ''
@@ -23,8 +50,13 @@ class Sunniesnow::Chart
 		@production = production
 	end
 
+	##
+	# Convert to JSON.
+	# A Sunniesnow chart is always a JSON file in the level file.
+	# This method is used to generate that JSON file.
 	def to_json *args
 		hash = {
+			'$schema': SCHEMA,
 			title: @title,
 			artist: @artist,
 			charter: @charter,
@@ -38,7 +70,7 @@ class Sunniesnow::Chart
 			version: Sunniesnow::Charter::VERSION,
 			port: @live_reload_port
 		} unless @production
-		hash.to_json
+		hash.to_json *args
 	end
 end
 

data/lib/sscharter/cli.rb

@@ -22,13 +22,12 @@ module Sunniesnow
 			module_function
 
 			def config
-				config_filename = File.join PROJECT_DIR, '.sscharter.yml'
-				config_filename = File.join PROJECT_DIR, '.sscharter.yaml' unless File.exist? config_filename
-				unless File.exist? config_filename
-					puts 'No .sscharter.yml found'
+				filenames = %w[sscharter.yml sscharter.yaml .sscharter.yml .sscharter.yaml].map { File.join PROJECT_DIR, _1 }
+				unless filename = filenames.find { File.exist? _1 }
+					$stderr.puts 'Config file sscharter.yml not found'
 					return nil
 				end
-				YAML.load_file config_filename, symbolize_names: true
+				YAML.load_file filename, symbolize_names: true
 			end
 
 			singleton_class.attr_reader :commands
@@ -87,20 +86,18 @@ Sunniesnow::Charter::CLI::Subcommand.new :init, option_parser do |project_dir =
 	FileUtils.cp_r files, files_dir
 	FileUtils.cd project_dir do
 		File.write 'Gemfile', <<~GEMFILE
-			# frozen_string_literal: true
 			source 'https://rubygems.org'
 			gem 'sscharter', '~> #{Sunniesnow::Charter::VERSION}'
 			gem 'rake', '~> #{Rake::VERSION}'
 			gem 'bundler', '~> #{Bundler::VERSION}'
 		GEMFILE
 		File.write 'Rakefile', <<~RAKEFILE
-			# frozen_string_literal: true
 			task default: :build
 			task :build do
 				exec 'bundle exec sscharter build'
 			end
 			task :serve do
-				exec 'bundle exec sscharter serve'
+				exec 'bundle exec sscharter serve --no-open-browser'
 			end
 		RAKEFILE
 		File.write '.gitignore', <<~GITIGNORE
@@ -108,7 +105,7 @@ Sunniesnow::Charter::CLI::Subcommand.new :init, option_parser do |project_dir =
 			/tmp/
 			/build/
 		GITIGNORE
-		File.write '.sscharter.yml', <<~SSCHARTER
+		File.write 'sscharter.yml', <<~SSCHARTER
 			---
 			project_name: #{File.basename project_dir}
 			build_dir: build
@@ -136,21 +133,19 @@ Sunniesnow::Charter::CLI::Subcommand.new :init, option_parser do |project_dir =
 		README
 		FileUtils.mkdir_p 'src'
 		File.write 'src/master.rb', <<~CHART
-			# frozen_string_literal: true
-
 			Sunniesnow::Charter.open 'master' do
 
 			title 'The title of the music'
 			artist 'The artist of the music'
 			charter 'Your name'
 			difficulty_name 'Master'
-			difficulty_color '#8c68f3'
+			difficulty_color :master
 			difficulty '12'
 
 			offset 0
 			bpm 120
 
-			tp_chain 0, 0, 1 do
+			tp_chain 0, 100, 1 do
 				t -50, 0, 'hello'
 				b 1 # proceed by 1 beat
 				t 50, 0, 'world'
@@ -162,7 +157,7 @@ Sunniesnow::Charter::CLI::Subcommand.new :init, option_parser do |project_dir =
 	puts "Project initialized at #{project_dir}"
 end
 
-def build **opts
+def build compression_level: Zip.default_compression, **opts, &block
 	return 1 unless config = Sunniesnow::Charter::CLI.config
 	dir = Sunniesnow::Charter::PROJECT_DIR
 	project_name = config[:project_name] || File.basename(dir)
@@ -171,17 +166,21 @@ def build **opts
 	sources_dir = File.join dir, config[:sources_dir] || 'src'
 	include_files = (config[:include] || []).map { File.join dir, _1 }
 	Sunniesnow::Charter.charts.clear
+	time = Time.now
 	Dir.glob File.join sources_dir, '*.rb' do |filename|
 		load filename
 	rescue Exception => e
 		puts "Error loading #{filename}:"
 		puts e.full_message
+		puts "Build aborted (took #{Time.now - time} seconds)"
 		return 1
 	end
+	puts "Built #{Sunniesnow::Charter.charts.size} chart(s) (took #{Time.now - time} seconds)"
+	time = Time.now
 	FileUtils.mkdir_p build_dir
 	build_filename = File.join build_dir, "#{project_name}.ssc"
 	FileUtils.rm build_filename if File.exist? build_filename
-	Zip::File.open build_filename, create: true do |zip_file|
+	Zip::File.open build_filename, compression_level:, create: true do |zip_file|
 		Dir.glob File.join files_dir, '**', '*' do |filename|
 			zip_file.add filename["#{files_dir}/".length..], filename
 		end
@@ -192,25 +191,33 @@ def build **opts
 		end
 		Sunniesnow::Charter.charts.each do |name, chart|
 			begin
-				output = chart.output_json **opts
+				sunniesnow_chart = chart.to_sunniesnow **opts
 			rescue => e
 				puts 'An error happened. Report if this is a bug of sscharter.'
 				puts e.full_message
 				return 2
 			end
+			block.(name, sunniesnow_chart) if block
 			zip_file.get_output_stream "#{name}.json" do |file|
-				file.write output
+				file.write sunniesnow_chart.to_json
+			rescue => e
+				puts 'An error happened. Report if this is a bug of sscharter.'
+				puts e.full_message
+				return 2
 			end
 		end
+		zip_file.each { _1.time = Time.at 0 }
 	end
+	puts "Created #{project_name}.ssc (took #{Time.now - time} seconds)"
 	0
 end
 
 option_parser = OptionParser.new do |o|
 	o.banner = 'Usage: sscharter build'
+	o.on '--compression-level=LEVEL', Integer, 'Compression level (0-9)'
 end
-Sunniesnow::Charter::CLI::Subcommand.new :build, option_parser do
-	build production: true
+Sunniesnow::Charter::CLI::Subcommand.new :build, option_parser do |compression_level: Zip.default_compression|
+	build compression_level:, production: true
 end
 
 option_parser = OptionParser.new do |o|
@@ -221,8 +228,17 @@ option_parser = OptionParser.new do |o|
 	o.on '--live-reload-port=PORT', Integer, 'live reload port number'
 	o.on '--[no-]production', 'Disable live reload'
 	o.on '--[no-]open-browser', 'Open browser'
+	o.on '--compression-level=LEVEL', Integer, 'Compression level (0-9)'
 end
-Sunniesnow::Charter::CLI::Subcommand.new :serve, option_parser do |host: '0.0.0.0', exposed_host: 'localhost', port: 8011, live_reload_port: 31108, production: false, open_browser: true|
+Sunniesnow::Charter::CLI::Subcommand.new :serve, option_parser do |\
+	host: '0.0.0.0',
+	exposed_host: 'localhost',
+	port: 8011,
+	live_reload_port: 31108,
+	production: false,
+	open_browser: true,
+	compression_level: (production ? Zip.default_compression : 0)
+|
 	return 1 unless config = Sunniesnow::Charter::CLI.config
 	dir = Sunniesnow::Charter::PROJECT_DIR
 	project_name = config[:project_name] || File.basename(dir)
@@ -268,18 +284,23 @@ Sunniesnow::Charter::CLI::Subcommand.new :serve, option_parser do |host: '0.0.0.
 			end
 		end
 	end
-	url = "http://#{exposed_host}:#{port}/#{project_name}.ssc"
+	base_url = "http://#{exposed_host}:#{port}"
+	url = URI.join base_url, "#{project_name}.ssc"
 	filewatcher = Filewatcher.new [files_dir, sources_dir, *include_files]
 	Launchy.open "https://sunniesnow.github.io/game/?level-file=online&level-file-online=#{CGI.escape url}" if open_browser
-	build_proc = ->is_first do
+	build_proc = ->is_first, only_charts do
 		puts is_first ? 'Building...' : 'Rebuilding...'
-		success = build(live_reload_port:, production:) == 0
-		puts success ? is_first ? "Finished; access at #{url}" : 'Finished' : 'Failed'
-		live_reload_clients.each { _1.send JSON.generate type: 'update' } unless production
+		build_result = build(live_reload_port:, production:, compression_level:) do |name, chart|
+			live_reload_clients.each { _1.send JSON.generate type: 'chartUpdate', name:, chart: } unless production
+		end
+		puts build_result == 0 ? is_first ? "Finished; access at #{url}" : 'Finished' : 'Failed'
+		live_reload_clients.each { _1.send JSON.generate type: 'update', onlyCharts: only_charts } unless production
 	end
 	filewatcher_thread = Thread.new do
-		build_proc.(true)
-		filewatcher.watch { |changes| build_proc.(false) }
+		build_proc.(true, false)
+		filewatcher.watch do |changes|
+			build_proc.(false, changes.all? { |filename, event| filename.start_with? sources_dir + '/' })
+		end
 		server.shutdown
 		EM.stop unless production
 	end

data/lib/sscharter/version.rb

@@ -2,6 +2,6 @@
 
 module Sunniesnow
 	class Charter
-		VERSION = "0.7.0"
+		VERSION = "0.9.0"
 	end
 end