sscharter 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 850d9242b14197642f97c44a83302b16b9093d57bf591b9e0a05be40c9575055
-  data.tar.gz: 6190327d91cd1101e469f35f28df7a0297feffa42409bb200382b756908cd40c
+  metadata.gz: 4e016849d4638b4a228dbefaf3d770a571c52b5d23b8a7a4e19c344f6fd91d9e
+  data.tar.gz: 7210246753c60a6f5873ae82ba9d9abdcea3e8301b08ba92ab6231f01060ef9a
 SHA512:
-  metadata.gz: 127338f44c7290e6feee3bf1f353b1588fd6afdee192149b458417811e8a46bb800869f20715600b76fa18e05c0e5253f249aaa894d93c82f9fb0cef696e1254
-  data.tar.gz: 463989ea415f5701f02ea4d2cf44f188f2e620ac4641bc5b9873b2821997fdd657610d29e94b9b69030fb6b0e59a25fa2f813fc7859e8b5ba7d52a20746aec05
+  metadata.gz: d79d0dd40fa573ea967223a8e5573f48e9e019374cfc294070efff83fe71f6732fdbaa81ce3f249987a9875e41fdeb2424f5ff6eac6fb9a16ca8c8769b30cc61
+  data.tar.gz: 87f8f7e56ef2ecc61e07fc09d35baad818b6105e5ea193766c5599c1041fd936b877f8e3f1173f0ec13f39d178bf09911893a43b958d1b21f58bebb7d1810c4a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sscharter (0.2.1)
+    sscharter (0.3.0)
       filewatcher (~> 2.0)
       launchy (~> 2.5)
       rubyzip (~> 2.3)

data/lib/sscharter/version.rb

@@ -2,6 +2,6 @@
 
 module Sunniesnow
 	class Charter
-		VERSION = "0.2.1"
+		VERSION = "0.3.0"
 	end
 end

data/lib/sscharter.rb

@@ -312,10 +312,11 @@ class Sunniesnow::Charter
 		@current_offset = nil
 		@current_beat = nil
 		@bpm_changes = nil
-		@tip_point_mode = :none
-		@current_tip_point = 0
+		@tip_point_mode_stack = [:none]
+		@current_tip_point_stack = []
+		@tip_point_peak = 0
 		@current_duplicate = 0
-		@tip_point_start_to_add = nil
+		@tip_point_start_to_add_stack = [nil]
 		@groups = [@events]
 	end
 
@@ -408,44 +409,57 @@ class Sunniesnow::Charter
 	end
 
 	def tip_point_chain *args, preserve_beat: true, **opts, &block
-		raise ArgumentError, 'no block given' unless block
 		tip_point :chain, *args, **opts do
 			group preserve_beat: preserve_beat, &block
-		end.tap { @current_tip_point += 1 }
+		end#.tap { @tip_point_peak += 1 }
 	end
 	alias tp_chain tip_point_chain
 
 	def tip_point_drop *args, preserve_beat: true, **opts, &block
-		raise ArgumentError, 'no block given' unless block
 		tip_point :drop, *args, **opts do
 			group preserve_beat: preserve_beat, &block
 		end
 	end
 	alias tp_drop tip_point_drop
 
+	def tip_point_none preserve_beat: true, &block
+		tip_point :none do
+			group preserve_beat: preserve_beat, &block
+		end
+	end
+	alias tp_none tip_point_none
+
 	def group preserve_beat: true, &block
 		raise ArgumentError, 'no block given' unless block
 		@groups.push result = []
-		last_beat = @current_beat
+		unless preserve_beat
+			last_beat = @current_beat
+			last_offset = @current_offset
+			last_bpm_changes = @bpm_changes
+		end
 		instance_eval &block
-		beat! last_beat unless preserve_beat
+		unless preserve_beat
+			@current_beat = last_beat
+			@current_offset = last_offset
+			@bpm_changes = last_bpm_changes
+		end
 		@groups.delete_if { result.equal? _1 }
 		result
 	end
 
-	def clear_tip_point
-		TipPointError.ensure @tip_point_mode, :chain, :drop
-		@tip_point_start_to_add = nil
-		@tip_point_mode = :none
-	end
-
 	def tip_point mode, *args, **opts, &block
-		TipPointError.ensure @tip_point_mode, :none
-		@tip_point_mode = mode
-		@tip_point_start_to_add = TipPointStart.new *args, **opts
+		@tip_point_mode_stack.push mode
+		if mode == :none
+			@current_tip_point_stack.push nil
+		else
+			@tip_point_start_to_add_stack.push TipPointStart.new *args, **opts
+			@current_tip_point_stack.push @tip_point_peak
+			@tip_point_peak += 1
+		end
 		result = block.()
-		@tip_point_start_to_add = nil
-		@tip_point_mode = :none
+		@tip_point_start_to_add_stack.pop
+		@tip_point_mode_stack.pop
+		@current_tip_point_stack.pop
 		result
 	end
 
@@ -454,13 +468,14 @@ class Sunniesnow::Charter
 		event = Event.new type, @current_beat, duration_beats, @bpm_changes, **properties
 		@groups.each { _1.push event }
 		return event unless event.tip_pointable?
-		case @tip_point_mode
+		case @tip_point_mode_stack.last
 		when :chain
 			push_tip_point_start event
-			@tip_point_start_to_add = nil
+			@tip_point_start_to_add_stack[-1] = nil
 		when :drop
 			push_tip_point_start event
-			@current_tip_point += 1
+			@current_tip_point_stack[-1] = @tip_point_peak
+			@tip_point_peak += 1
 		when :none
 			# pass
 		end
@@ -468,8 +483,8 @@ class Sunniesnow::Charter
 	end
 
 	def push_tip_point_start start_event
-		start_event[:tip_point] = @current_tip_point.to_s
-		tip_point_start = @tip_point_start_to_add&.get_start_placeholder start_event
+		start_event[:tip_point] = @current_tip_point_stack.last.to_s
+		tip_point_start = @tip_point_start_to_add_stack.last&.get_start_placeholder start_event
 		@groups.each { _1.push tip_point_start } if tip_point_start
 	end
 
@@ -530,13 +545,14 @@ class Sunniesnow::Charter
 		end
 		if direction.is_a? Symbol
 			direction = DIRECTIONS[direction]
+			raise ArgumentError, "unknown direction #{direction}" unless direction
 		elsif direction.is_a? Numeric
 			warn 'Are you using degrees as angle unit instead of radians?' if direction != 0 && direction % 45 == 0
 			direction = direction.to_f
 		else
 			raise ArgumentError, 'direction must be a symbol or a number'
 		end
-		event :flick, x: x, y: y, angle: direction, text: text.to_s
+		event :flick, x: x.to_f, y: y.to_f, angle: direction, text: text.to_s
 	end
 	alias f flick
 
@@ -554,11 +570,23 @@ class Sunniesnow::Charter
 	end
 
 	def big_text duration_beats = 0, text
+		unless duration_beats.is_a? Numeric
+			raise ArgumentError, 'duration_beats must be a number'
+		end
+		if duration_beats < 0
+			raise ArgumentError, 'duration must be non-negative'
+		end
+		if duration_beats.is_a? Float
+			warn 'Rational is recommended over Float for duration_beats'
+		end
 		event :big_text, duration_beats.to_r, text: text.to_s
 	end
 
 	%i[grid hexagon checkerboard diamond_grid pentagon turntable].each do |method_name|
 		define_method method_name do |duration_beats = 0|
+			unless duration_beats.is_a? Numeric
+				raise ArgumentError, 'duration_beats must be a number'
+			end
 			if duration_beats < 0
 				raise ArgumentError, 'duration must be non-negative'
 			end

data/tutorial/tutorial.md

@@ -701,6 +701,13 @@ end
 transform(notes) { translate 25, 25 }
 ```
 
+> Because argument of `rotate` is in radians,
+> you may want to use the Math constant $\pi$.
+> In Ruby, it is `Math::PI`.
+> If you use this constant a lot, you may want to write `include Math`
+> at the beginning of the source codes file so that you can just write `PI`
+> instead of `Math::PI` every time.
+
 ### Navigate among beats
 
 You have already learned how to use `beat` to proceed the current beat
@@ -853,33 +860,46 @@ in the call of `tip_point_chain` or `tip_point_drop`.
 The beat speed may be specified as a float number,
 and this is the only case where something related to beats is not preferred to be specified as a rational number.
 
-We can categorize the four ways into a table:
+Besides the two methods `tip_point_chain` and `tip_point_drop`,
+there is another method `tip_point_none` (abbreviated as `tp_none`)
+for you to specify that those events in the code block are not connected by tip points.
+This is useful when you nest those methods inside each other.
+Different from `tip_point_chain` and `tip_point_drop`,
+the method `tip_point_none` does not take any arguments
+(besides `preserve_beat`, which will be mentioned later).
+
+We can summarize all of them in the following table:
 
 <table>
   <tr>
     <th>Method</th>
     <td><code>tip_point_chain</code></td>
     <td><code>tip_point_drop</code></td>
+    <td><code>tip_point_none</code></td>
   </tr>
   <tr>
     <th><code>relative_time</code></th>
     <td><code>tip_point_chain x=0, y=0, relative_time=0.0, relative: true</code></td>
     <td><code>tip_point_drop x=0, y=0, relative_time=0.0, relative: true</code></td>
+    <td></td>
   </tr>
   <tr>
     <th><code>speed</code></th>
     <td><code>tip_point_chain x=0, y=0, relative: true, speed:</code></td>
     <td><code>tip_point_drop x=0, y=0, relative: true, speed:</code></td>
+    <td></td>
   </tr>
   <tr>
     <th><code>relative_beat</code></th>
     <td><code>tip_point_chain x=0, y=0, relative: true, relative_beat:</code></td>
     <td><code>tip_point_drop x=0, y=0, relative: true, relative_beat:</code></td>
+    <td></td>
   </tr>
   <tr>
     <th><code>beat_speed</code></th>
     <td><code>tip_point_chain x=0, y=0, relative: true, beat_speed:</code></td>
     <td><code>tip_point_drop x=0, y=0, relative: true, beat_speed:</code></td>
+    <td></td>
   </tr>
 </table>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sscharter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Ulysses Zhan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-07 00:00:00.000000000 Z
+date: 2023-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip