md2slides 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ead7e0a1d48738b1f88a039ec73924afcab9eb35ea0a3bf15f6933d655690e
-  data.tar.gz: dfe7efa2cc63e30e8c71dc15c74b784725e812fed5dd619034393f4dd97bc772
+  metadata.gz: 8940d8d5f290e134eae76153e0e1761a9133be69d0abfdb3ba63ef2ee0076906
+  data.tar.gz: d0d09ed3fc8cd268c8126445c0edcd66aa7cfb7f16832b6819e9bdca57f79ecf
 SHA512:
-  metadata.gz: 33410bc7876fcb1b24f24628d73a66a3d5314cb34b6a9460301b68c95fc22e5e2ce6677559f66eebff3df6d4742f148ab91007dfe63de4f56e08b2009c780050
-  data.tar.gz: bbed92243410bd696a193a4859e9076590690946662b29c792ef6bec9b5c33e68adc8fd5c760b0490019cc2a17226b0911ba2bc96a06811f0447d287c41abb7c
+  metadata.gz: f50b81972a9c0bcb5308f1cb37a3b748a154b5435b19b6438518f58d270ef437e486f2fc2fd598f574eca89ade8bc604176dbd43efe4e0e7f899999ec17cbbe6
+  data.tar.gz: 9c326d70264073f5f0d5aa1c5c9ce052732d4dae7c6cecaa9a80b19f6cd6888d88a451f7d5ee340058c0aeefb264b8886e7c6fe14ce8d280daf94263f56f629b

data/README.md

@@ -3,8 +3,27 @@
 A video file of a presentation will be also generated, and it may contains narration if supplied.
 Narration can be given as notes in slides, and the audio will be generated using Google text-to-speech API and ffmpeg.
 
+## Installation
+
+install by gem:
+
+    % gem install md2slides
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'md2slides'
+```
+
+and then execute:
+
+    $ bundle
+
 ## Quick start
-1. Generate your Google API credentials and copy it to credentails.json:
+1. Generate your Google API credentials on API service page of your Google cloud console:
+	https://console.cloud.google.com/apis/
+
+2. copy API credentials:
 ```
 % mkdir ~/.config/gcloud
 % cat >> ~/.config/gcloud/credentials.json
@@ -22,14 +41,10 @@ Narration can be given as notes in slides, and the audio will be generated using
 }
 ^D (this means CTRL + D)
 ```
-2. install ffmpeg if necessary (if producing video file).
 
-3. install necessary gems.
-```
-% bundle install --path vendor/bundle
-```
+3. install ffmpeg if necessary (if producing video file).
 
-4. create an empty Google slide.
+4. create an empty Google slide, share it with **client_email** user, and copy the URL.
 
 5. write a markdown file.
 ```
@@ -53,33 +68,21 @@ narration text...
 ^D (this means CTRL + D)
 ```
 
-6. execute.
+6. run the script.
 ```
-bundle exec bin/md2slides doc/sample.md
+% md2slides deploy sample.md
 ```
 
-7. the Google presentation is updated, and the video is stored in the current directory.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'md2slides'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install md2slides
+the Google presentation is updated, and the video is stored in the current directory.
 
 ## Usage
 
 TODO: Write usage instructions here
 
+## TODO
+
+See [TODO.md](https://github.com/ohmori7/md2slides/blob/main/TODO.md "TODO.md")
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/md2slides

@@ -3,24 +3,37 @@
 
 # Copyright (c) 2025 Motoyuki OHMORI All rights reserved.
 
-$:.unshift File.join(File.dirname(File.dirname(File.realpath(__FILE__))), 'lib')
-
+require 'optparse'
 require 'md2slides'
 
+options = {}
+$opts = OptionParser.new do |opts|
+	progname = File.basename(__FILE__)
+	opts.banner = <<~EOF
+		Usage:
+			#{progname} list <MD> [<URL or ID>]
+			#{progname} update <MD> [<URL or ID>]
+			#{progname} fetch <MD> [<URL or ID>]
+			#{progname} audio <MD> [<URL or ID>]
+			#{progname} video <MD> [<URL or ID>]
+			#{progname} deploy <MD> [<URL or ID>]
+			#{progname} -h
+	EOF
+	opts.on('-h', '--help', 'show usage') { options[:h] = true }
+	opts.parse!
+end
+
 def usage(errmsg = nil)
 	puts "ERROR: #{errmsg}" if errmsg
 	puts <<~EOF
-Usage:
-	#{$progname} [-f] <file> [<URL or id>]
-	#{$progname} -h
-
+#{$opts.banner}
 Description:
-	generate a Google Presentation file.
+	generate a Google presentation file.
 
 Argument:
 	-h:		output this message.
-	<file>:		a file written in markdown
-	<URL or id>:	a URL or a ID of a presentation
+	<MD>:		a file written in markdown
+	<URL or id>:	a URL or a ID of a Google presentation
 
 BUGS:
 	only .md is allowed for an input file for now.
@@ -29,35 +42,45 @@ BUGS:
 	exit 1
 end
 
-v = ARGV.shift
-case v
-when '-h'
-	usage
-when nil
-	usage
-end
-
-path = v
+usage if options[:h]
+usage if ARGV.size < 2
+cmd = ARGV.shift
+path = ARGV.shift
 filename = File.basename(path)
 if filename =~ /^(.*)\.(md)$/i
 	name, ext = $1, $2
 else
-	raise("cannot find the file name extention: #{filename}")
+	usage("cannot find the file name extention: #{filename}")
 end
 
 md = MD.new(path)
 url = md.attributes[:url]
 if url.nil?
 	url = ARGV.shift
-	usage("No URL and ID specified in the presentation and the argument") if ARGV.size != 0
+	usage("No URL and ID specified in the presentation and the argument") if url.nil?
+	usage("extra arguments: #{ARGV.join(", ")}") if ! ARGV.nil
 else
 	usage("URL or ID duplicatedly specified!!") if ARGV.size != 0
 end
 
-presentation = Presentation.new(url)
-presentation.list
-presentation.update(md)
-#presentation.stick_out_check
-presentation.download
-presentation.generate_audio
-presentation.generate_video
+presentation = Presentation.new(md)
+case cmd
+when 'list'
+	presentation.list
+when 'update'
+	presentation.update
+	#presentation.stick_out_check
+when 'fetch'
+	presentation.download
+when 'audio'
+	presentation.generate_audio
+when 'video'
+	presentation.generate_video
+when 'deploy'
+	presentation.update
+	presentation.download
+	presentation.generate_audio
+	presentation.generate_video
+else
+	usage("unknown command: #{cmd}")
+end

data/lib/md2slides/audio.rb

@@ -2,9 +2,8 @@ class Presentation
 	# XXX: Google Text to Speech produces at this rate...
 	AUDIO_RATE = 24000
 
-	def generate_audio0(i, slide, dir)
-		print "slide \##{i + 1}: generating audio... "
-		notes = get_slide_note(slide)
+	def generate_audio0(i, notes, dir)
+		print "slide \##{i}: generating audio... "
 		path = __data_slide_path(i, '.m4a', dir)
 		if notes
 			opath = __data_slide_path(i, '.mp3', dir)
@@ -45,8 +44,14 @@ class Presentation
 
 	def generate_audio(dir = nil)
 		dir = __data_path(dir)
-		@presentation.slides.each_with_index do |slide, i|
-			generate_audio0(i, slide, dir)
+		if @md
+			@md.each_with_index do |page, i|
+				generate_audio0(i + 1, page.comments, dir)
+			end
+		else
+			@presentation.slides.each_with_index do |slide, i|
+				generate_audio0(i + 1, get_slide_note(slide), dir)
+			end
 		end
 	end
 end

data/lib/md2slides/md.rb

@@ -3,13 +3,13 @@ class MD
 		include Enumerable
 
 		class Element
-			attr_reader :type, :value
-			def initialize(type, value)
-				@type, @value = type, value
+			attr_reader :type, :value, :attributes
+			def initialize(type, value, attributes)
+				@type, @value, @attributes = type, value, attributes
 			end
 
 			def to_s
-				"#{@type.to_s}: #{@value}"
+				"#{@type.to_s}: #{@value} (#{@attributes.map { |k, v| "#{k}: #{v}"}.join(",")})"
 			end
 		end
 
@@ -18,9 +18,15 @@ class MD
 			@comments = []
 		end
 
-		def add(type, value)
+		def add(type, value, attributes = nil)
 			return if value.nil? || value.empty?
-			@elements.push(Element.new(type, value))
+			case type.to_s
+			when /^h([0-9]+)$/
+				n = $1.to_i - 1
+				attributes ||= {}
+				attributes[:indent] = n
+			end
+			@elements.push(Element.new(type, value, attributes))
 		end
 
 		def add_comment(c)
@@ -63,6 +69,8 @@ class MD
 		end
 	end
 
+	include Enumerable
+
 	attr_reader :attributes
 
 	def initialize(path)
@@ -79,8 +87,8 @@ class MD
 		@pages.each(&block)
 	end
 
-	def each_with_index(&block)
-		@pages.each_with_index(&block)
+	def size
+		@pages.size
 	end
 
 	def parse_header(text)
@@ -99,8 +107,8 @@ class MD
 	def parse_page(text)
 		@pages << page = Page.new
 		is_in_comment = false
-		text.each_line do |l|
-			l.strip!
+		text.each_line do |l0|
+			l = l0.strip
 			next if l.empty?
 			if is_in_comment
 				if l =~ /(.*) ?-->(.*)$/
@@ -118,7 +126,11 @@ class MD
 					h = "h#{sharps.size}"
 					page.add(h.to_sym, title)
 				when /^[-*] *(.*)$/
-					page.add(:li, $1)
+					s = $1
+					if l0 =~ /^( +).*$/
+						indent = { indent: $1.size }
+					end
+					page.add(:li, s, indent)
 				when /^<!-- *(.*)$/
 					l = $1
 					if l =~ /(.*) ?-->(.*)$/

data/lib/md2slides/presentation.rb

@@ -16,10 +16,12 @@ class Presentation
 	attr_reader :id
 
 	def self.filename_sanitize(s)
-		s.gsub(/[\/\\:\*\?"<>\|]/, '')
+		s&.gsub(/[\/\\:\*\?"<>\|]/, '')
 	end
 
-	def initialize(url = nil)
+	def initialize(md = nil)
+		@md = md
+		url = md&.attributes[:url]
 		if url =~ %r{https://docs.google.com/presentation/d/([^\/ ]+).*$}
 			@id = $1
 		elsif url
@@ -29,7 +31,6 @@ class Presentation
 		@authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
 			json_key_io: File.open(ENV['GOOGLE_APPLICATION_CREDENTIALS']),
 			scope: GOOGLE_OAUTH_SCOPE)
-		@authorizer.fetch_access_token!
 
 		@slides_service = Google::Apis::SlidesV1::SlidesService.new
 		@slides_service.client_options.application_name = APPLICATION_NAME
@@ -39,13 +40,9 @@ class Presentation
 		@drive_service.client_options.application_name = APPLICATION_NAME
 		@drive_service.authorization = @authorizer
 
-		if @id
-			@presentation = @slides_service.get_presentation(@id)
-		end
-
 		@requests = []
 
-		# XXX: this script always runs by an API user...
+		# XXX: this seript always runs by an API user...
 		#people_service = Google::Apis::PeopleV1::PeopleServiceService.new
 		#people_service.authorization = @authorizer
 		#profile = people_service.get_person("people/me", person_fields: "names,emailAddresses")
@@ -54,13 +51,29 @@ class Presentation
 		#puts "#{name}: #{email}"
 	end
 
+	def __get_presentation
+		begin
+			@authorizer.fetch_access_token!
+			@presentation = @slides_service.get_presentation(@id)
+		rescue => e
+			require 'webrick'
+			raise(e, "#{e.message} (#{e.status_code} " +
+			    "#{WEBrick::HTTPStatus.reason_phrase(e.status_code)})\n" +
+			    "#{e.full_message}")
+		end
+	end
+
 	def exists?
-		@id && @presentation
+		return false if ! @id
+		if @presentation.nil?
+			__get_presentation
+		end
+		!! @presentation
 	end
 
 	def existence_check
 		if ! exists?
-			raise("presentation (ID: #{@id})does not exists!!!")
+			raise("presentation (ID: #{@id}) does not exists!!!")
 		end
 	end
 
@@ -141,8 +154,7 @@ class Presentation
 			@slides_service.batch_update_presentation(@id, batch_update_request)
 			@requests = []
 		rescue => e
-			p e.body
-			raise e
+			raise(e, "#{e.body}\n#{e.full_message}")
 		end
 		@presentation = @slides_service.get_presentation(@id)
 	end
@@ -299,7 +311,7 @@ class Presentation
 		puts "title: #{@presentation.title}"
 		puts "pages: #{@presentation.slides.size}"
 		@presentation.slides.each_with_index do |slide, i|
-			puts "- Slide \##{i + 1} contains #{slide.page_elements.count} elements."
+			puts "- slide \##{i + 1} contains #{slide.page_elements.count} elements."
 		end
 	end
 
@@ -311,14 +323,14 @@ class Presentation
 		end
 	end
 
-	def update(md)
+	def update
 		#
 		# XXX: currently, clear all slides...
 		#
 		if exists?
 			clear
 		end
-		md.each do |page|
+		@md.each do |page|
 			if page.title_subtitle_only?
 				layout = 'TITLE'
 			elsif page.title_only?
@@ -334,12 +346,8 @@ class Presentation
 				set_slide_subtitle(slide, page.subtitle)
 			else
 				texts = page.map do |e|
-					case e.type.to_s
-					when /^h([0-9]+)$/
-						n = $1.to_i - 1
-					else
-						n = 1
-					end
+					# calculate the indentation.
+					n = (e.attributes&.[](:indent).to_i / 2).to_i
 					"\t" * n + e.value
 				end.join("\n")
 				if texts.size > 0
@@ -357,14 +365,19 @@ class Presentation
 
 	def __data_path(basedir)
 		basedir = '.' if basedir.nil?
-		title, subtitle = get_title
+		if @md
+			title = @md.first.title
+			subtitle = @md.first.subtitle
+		elsif @presentation
+			title, subtitle = get_title
+		end
 		title = self.class.filename_sanitize(title)
 		subtitle = self.class.filename_sanitize(subtitle)
 		File.join(basedir, "#{title}-#{subtitle}-#{@id}")
 	end
 
 	def __data_slide_path(i, ext, basedir = nil)
-		path = "slide-#{i + 1}#{ext}"
+		path = "slide-#{i}#{ext}"
 		if basedir
 			path = File.join(basedir, path)
 		end
@@ -419,7 +432,7 @@ class Presentation
 		File.open(lockfile, File::RDWR|File::CREAT, 0644) do |f|
 			f.flock(File::LOCK_EX | File::LOCK_NB)
 			@presentation.slides.each_with_index do |slide, i|
-				download_slide(i, slide, dir)
+				download_slide(i + 1, slide, dir)
 			end
 		end
 	end

data/lib/md2slides/text_to_speech.rb

@@ -16,9 +16,14 @@ class Presentation
 		end
 		filename += '.mp3'
 
+		text.strip!
+		if text !~ /^<speak>/
+			text = "<speak>#{text}</speak>"
+		end
+
 		response = Google::Cloud::TextToSpeech.new.synthesize_speech(
 		    # XXX: I don't know how to create an object of Google::Cloud::TextToSpeech::SynthesisInput...
-		    { text: text },
+		    { ssml: text },
 		    #
 		    # Standard is the cheapest.
 		    #	ja-JP-Standard-A, B female

data/lib/md2slides/version.rb

@@ -1,3 +1,3 @@
 module Md2slides
-	VERSION = "0.0.3"
+	VERSION = "0.0.5"
 end

data/lib/md2slides/video.rb

@@ -1,6 +1,9 @@
 require 'open3'
 
 class Presentation
+	VIDEO_FRAME_RATE = 1
+	VIDEO_ONLY_DURATION = 4
+
 	def generate_slide_video(i, dir)
 		img = __data_slide_path(i, '.png', dir)
 		audio = __data_slide_path(i, '.m4a', dir)
@@ -11,11 +14,11 @@ class Presentation
 			timeopt = '-shortest'
 		else
 			audioin = "-f lavfi -i aevalsrc=0"
-			timeopt = "-vframes 60"
+			timeopt = "-vframes #{VIDEO_FRAME_RATE * VIDEO_ONLY_DURATION}"
 		end
 		cmd = <<~CMD
 			ffmpeg -hide_banner -y				\
-			    -framerate 15 -loop 1 -i "#{img}"		\
+			    -framerate #{VIDEO_FRAME_RATE} -loop 1 -i "#{img}" \
 			    #{audioin} -map 0:v:0 -map 1:a:0		\
 			    -c:v libx264 -tune stillimage		\
 			    -c:a aac -ar #{AUDIO_RATE} -ac 1		\
@@ -29,8 +32,9 @@ class Presentation
 
 	def generate_video(dir = nil)
 		dir = __data_path(dir)
-		@presentation.slides.each_with_index do |slide, i|
-			print "slide \##{i + 1}: generating video..."
+		pages = @md&.size || @presentation&.slides&.size.to_i
+		for i in 1..pages
+			print "slide \##{i}: generating video..."
 			generate_slide_video(i, dir)
 			puts "done"
 		end
@@ -38,7 +42,7 @@ class Presentation
 		print "concatenate video files..."
 		videolist = 'video-list.txt'
 		File.open(File.join(dir, videolist), 'w') do |f|
-			@presentation.slides.each_with_index do |slide, i|
+			for i in 1..pages
 				f.puts("file #{__data_slide_path(i, '.mp4')}")
 			end
 		end

data/lib/md2slides.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(File.dirname(File.realpath(__FILE__)))
-
 module Md2slides
 	class Error < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: md2slides
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Motoyuki OHMORI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-04-29 00:00:00.000000000 Z
+date: 2025-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth