mo2tex 1.0.0

data/README.md

@@ -0,0 +1,29 @@
+# `mo2tex` - A pure `ruby` monteore-to-`latex` table generator
+
+![[pipeline](https://gitlab.com/SMELAT/mo2tex)](https://gitlab.com/SMELAT/mo2tex/badges/master/pipeline.svg)
+
+`mo2tex` is a pure `ruby` monteore-to-`latex` table generator
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add mo2tex
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install mo2tex
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/SMELAT/mo2tex.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/config/courses.yml

@@ -0,0 +1,165 @@
+calendar:
+  start_date: 20241104
+  end_date:   20251031
+  exclude:    [ 20241221-20250106, 20250220-20250301, 20250417-20250422, 20250425, 20250501, 20250602, 20250625-20251011 ]
+  file:       Bernardini-A.A.2024-2025.ics
+  day_schedule: 
+    lunedì:
+      orario: 
+        - '9:00'
+        - '15:00'
+      pausa:
+        - '13:30'
+        - '14:00'
+    martedì:
+      orario:
+        - '9:00'
+        - '17:00'
+      pausa:
+        - '12:00'
+        - '13:00'
+
+courses:
+  Bernardini_-_Composizione_Musicale_Elettroacustica_TR_I:
+    studenti: Timpone, Valle
+    ore: 30
+    tipologia: individuale
+    tip_effettiva: individuale
+    inizio: 20241104
+    frequenza: settimanale
+    giorno: lunedì
+    orario: 9:00
+    durata_lezione: 1:30
+    aula: 18s
+    online: [ 20241125 ]
+  
+  Bernardini_-_Composizione_Musicale_Elettroacustica_TR_II:
+    studenti: Freddoneve, De Paolis
+    ore: 30
+    tipologia: individuale
+    tip_effettiva: individuale
+    inizio: 20241104
+    frequenza: settimanale
+    giorno: lunedì
+    orario: 10:30
+    durata_lezione: 1:30
+    aula: 18s
+    online: [ 20241125 ]
+  
+  Bernardini_-_Composizione_Musicale_Elettroacustica_TR_III_A:
+    studenti: Diaz, Erdi
+    studenti_fc: Corsi
+    ore: 30
+    tipologia: individuale
+    tip_effettiva: individuale
+    inizio: 20241104
+    frequenza: settimanale
+    giorno: lunedì
+    orario: 12:00
+    durata_lezione: 1:30
+    aula: 18s
+    online: [ 20241125 ]
+  
+  Bernardini_-_Composizione_Musicale_Elettroacustica_TR_III_B:
+    studenti: Pellegrino, Cutini, De Caro
+    ore: 30
+    tipologia: individuale
+    tip_effettiva: collettiva
+    inizio: 20241112
+    frequenza: quindicinale
+    giorno: martedì
+    orario: 15:00
+    durata_lezione: 2:00
+    aula: ottofonia
+    online: [ 20241126 ]
+  
+  Bernardini_-_Composizione_Musicale_Informatica_TR_I_TS:
+    studenti: Noto, Varone, Mauti, Savastano, Vona, Cannuciari
+    ore: 20
+    tipologia: collettiva
+    tip_effettiva: collettiva
+    inizio: 20241104
+    frequenza: settimanale
+    giorno: lunedì
+    orario: 14:00
+    durata_lezione: 1:30
+    aula: 18s
+    online: [ 20241125 ]
+  
+  Bernardini_-_Composizione_Musicale_Informatica_TR_II_TS:
+    studenti: Chierici, Rossi
+    ore: 20
+    tipologia: collettiva
+    tip_effettiva: collettiva
+    inizio: 20241105
+    frequenza: settimanale
+    giorno: martedì
+    orario: 9:00
+    durata_lezione: 1:00
+    aula: ottofonia
+    online: [ 20241126 ]
+  
+  Bernardini_-_Composizione_Audiovisiva_Integrata_TR_I_A_MA:
+    studenti: Di Girolamo, Bonfè, Bongiovanni
+    ore: 30
+    tipologia: individuale
+    tip_effettiva: collettiva
+    inizio: 20241105
+    frequenza: settimanale
+    giorno: martedì
+    orario: 13:00
+    durata_lezione: 2:00
+    aula: ottofonia
+    online: [ 20241126 ]
+  
+  Bernardini_-_Composizione_Audiovisiva_Integrata_TR_I_B_MA:
+    studenti: Becherucci, Filippi, Barbarossa
+    ore: 30
+    tipologia: individuale
+    tip_effettiva: collettiva
+    inizio: 20250318
+    frequenza: settimanale
+    giorno: martedì
+    orario: 13:00
+    durata_lezione: 2:00
+    aula: ottofonia
+    online: [ 20241126 ]
+  
+  Bernardini_-_Composizione_Musicale_Elettroacustica_BN_II_ME:
+    studenti: Ferracuti
+    ore: 20
+    tipologia: individuale
+    tip_effettiva: individuale
+    inizio: 20241105
+    frequenza: settimanale
+    giorno: martedì
+    orario: 10:00
+    durata_lezione: 1:00
+    aula: ottofonia
+    online: [ 20241126 ]
+  
+  Bernardini_-_Composizione_Audiovisiva_Integrata_BN_II_ME:
+    studenti: Ferracuti
+    ore: 20
+    tipologia: individuale
+    tip_effettiva: individuale
+    inizio: 20250318
+    frequenza: settimanale
+    giorno: martedì
+    orario: 10:00
+    durata_lezione: 1:00
+    aula: ottofonia
+    online: [ 20241126 ]
+
+  Bernardini_-_Composizione_Audiovisiva_Integrata_BN_I_MA:
+    studenti: Rossi Minelli
+    ore: 20
+    tipologia: individuale
+    tip_effettiva: individuale
+    inizio: 20241105
+    frequenza: settimanale
+    giorno: martedì
+    orario: 11:00
+    durata_lezione: 1:00
+    aula: ottofonia
+    online: [ 20241126 ]

data/config/templates/latex/body.tex.erb

@@ -0,0 +1,5 @@
+\begin{longtable}{l c r}
+<%= self.table_body %>
+\hline
+\multicolumn{2}{l}{\bfseries Totale ore:} & {\bfseries\large\hfill <%= self.total_hours_done %>}\\
+\end{longtable}

data/config/templates/latex/header.tex

@@ -0,0 +1,20 @@
+\documentclass[10pt]{scrartcl}
+\usepackage[italian]{babel}
+\usepackage[margin=1cm]{geometry}
+\usepackage{longtable}
+\usepackage{needspace}
+\usepackage{xspace}
+
+\newcommand{\AAcc}{A.A. 2024--2025\xspace}
+
+\title{Conservatorio ``Ottorino Respighi'' Latina\\%
+       Scuola di Musica Elettronica\\%
+			 \AAcc\\%
+			 Docente: Nicola Bernardini\\%
+			 Orari delle lezioni}
+
+\date{~}
+
+\begin{document}
+
+\maketitle

data/config/templates/latex/trailer.tex

@@ -0,0 +1 @@
+\end{document}

data/config/templates/pic/body.pic.erb

@@ -0,0 +1,14 @@
+.PS
+# -*- coding: utf-8 -*-
+
+  #
+  # Page n.<%= page.number %>
+  #
+  page_frame(<%= page.number -%>)
+  <% page.containers.each do |cont| -%>
+    container(<%= cont.number %>, <%= cont.location_tag %>, "\s[-2]\fB<%= cont.wdate %>\fP\s0")
+    <% cont.slots.each do |ev| -%>
+      event(<%= ev.number %>, <%= ev.location_tag %>, "\s[-3]<%= ev.pic_time %>\s0", <%= ev.pic_dur %>, "\s[-2]\fB<%= ev.pic_title %>\fP\s0", <%= ev.color %>)
+    <% end %>
+  <% end %>
+.PE

data/config/templates/pic/header.pic

@@ -0,0 +1,13 @@
+.po 0.5i
+.ll 7.27i 
+.\".pl 10.423 
+.PS
+scale=2.54 # we want centimeters
+maxpswid=21 # a4 portrait with 0cm margin
+maxpsht=29.7
+textwid=maxpswid-scale
+textht =maxpsht-1.035*scale
+
+copy "config/templates/pic/objects.pic"
+.PE
+

data/config/templates/pic/objects.pic

@@ -0,0 +1,46 @@
+.PS
+#
+# page frame:
+#
+# +page_frame(npage)+
+#
+# creates a page where to insert containers
+#
+framewid = textwid
+frameht  = textht
+define page_frame {
+  PageFrame$1: box invis wid framewid ht frameht
+}
+#
+# main container:
+#
+# +container(container_number, placement, daystring)+
+#
+# will produce a Container<container_number> box where to put each day
+#
+containerht = frameht/4
+containerwid = framewid/4
+subcontainerwid = containerwid*0.65
+subcontainerht  = containerht*0.93
+define container {
+  Container$1: box wid containerwid ht containerht with .nw at $2
+  Subcontainer$1: box wid subcontainerwid ht subcontainerht with .se at Container$1.se
+  line invis from Container$1.nw to Container$1.ne $3 below
+}
+#
+# event:
+#
+# +event(event_number, placement, time, dur, title, color)+
+#
+# will produce a Event<event_number> box where to put the weeks
+#
+totdaydur = 8
+dayoffset = 9
+define event {
+  event_ht = (subcontainerht/totdaydur)*$4
+  Event$1: box wid subcontainerwid ht event_ht with .nw at $2 $5 shaded $6
+  tag_wid = containerwid - subcontainerwid
+  Ttag$1: box invis wid tag_wid ht event_ht with .e at Event$1.w
+  line invis from Ttag$1.nw to Ttag$1.ne $3 below
+}
+.PE

data/config/templates/pic/trailer.pic.erb

@@ -0,0 +1,3 @@
+.\"
+.\" created with mo2tex rev.<%= Git::Describe::git %>
+.\"

data/exe/m2c

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+version = '1.0.0'
+ourlib = File.join(ENV['HOME'], '.rvm', 'gems', 'ruby-3.4.0-preview1@mo2tex', 'gems', "mo2tex-#{version}", 'lib')
+$:<< File.join('.', 'lib')
+$:<< ourlib
+require 'mo2tex'
+
+begin
+  puts(Mo2tex::m2ical(ARGV))
+rescue ArgumentError => msg
+  STDERR.puts(msg)
+  exit(-1)
+end
+
+exit(0)

data/exe/m2l

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+version = '1.0.0'
+ourlib = File.join(ENV['HOME'], '.rvm', 'gems', 'ruby-3.4.0-preview1@mo2tex', 'gems', "mo2tex-#{version}", 'lib')
+$:<< File.join('.', 'lib')
+$:<< ourlib
+require 'mo2tex'
+
+begin
+  puts(Mo2tex::m2latex(ARGV))
+rescue ArgumentError => msg
+  STDERR.puts(msg)
+  exit(-1)
+end
+
+exit(0)

data/exe/m2p

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+version = '1.0.0'
+ourlib = File.join(ENV['HOME'], '.rvm', 'gems', 'ruby-3.4.0-preview1@mo2tex', 'gems', "mo2tex-#{version}", 'lib')
+$:<< File.join('.', 'lib')
+$:<< ourlib
+require 'mo2tex'
+
+begin
+  puts(Mo2tex::m2pic(ARGV))
+rescue ArgumentError => msg
+  STDERR.puts(msg)
+  exit(-1)
+end
+
+exit(0)

data/lib/mo2tex/calendar.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'date'
+require 'icalendar'
+
+module Mo2tex
+
+	class Calendar
+
+    attr_reader :filename, :start_date, :end_date, :exclude, :events, :day_schedule_templates
+
+		class UnknownEvent < Error; end
+
+		def initialize(config)
+      @filename = config['file']
+      @start_date = DateTime.parse(config['start_date'].to_s)
+      @end_date = DateTime.parse(config['end_date'].to_s)
+      @exclude = ExclusionManager.new(config['exclude'], self.start_date, self.end_date)
+      @day_schedule_templates = parse_day_schedule_templates(config['day_schedule'])
+		end
+
+    def create_icalendar(school)
+      ical = Icalendar::Calendar.new
+      school.courses.each do
+        |title, course|
+        course.events.each do
+          |ev|
+          ev.to_ical(ical)
+        end
+      end
+      return ical.publish
+    end
+
+    def create_pic_schedule(school)
+      pic = Pic.new(school) 
+    end
+
+    def to_file(school, fname = nil)
+      fname ||= self.filename
+      ical = self.create_icalendar(school)
+      File.open(fname, 'w') { |fh| fh.puts(ical.to_ical) }
+      return fname
+    end
+
+  private
+
+    def parse_day_schedule_templates(conf)
+      return conf
+    end
+
+	end
+
+end

data/lib/mo2tex/course.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Mo2tex
+
+	class Course
+
+		include CourseHelper
+
+    attr :title, :hours, :type, :real_type, :students, :students_fc,
+         :start, :freq, :wday, :dur, :when, :events, :excl_mgr, :warnings,
+         :hours_done, :where, :online
+
+		def initialize(title, desc, exmgr)
+      @warnings = {}
+      @hours_done = 0
+      @excl_mgr = exmgr
+      self.excl_mgr << desc['exclude'] if desc.has_key?('exclude')
+			@title = normalize_title(title)
+			@hours = desc['ore']
+			@type  = desc['tipologia']
+      @real_type = desc['tip_effettiva']
+			@students = desc['studenti']
+      @students_fc = desc['studenti_fc']
+			@start = DateTime.parse(desc['inizio'].to_s)
+      @freq  = parse_frequency(desc['frequenza'])
+      @wday  = desc['giorno']
+      @dur   = parse_dur(desc['durata_lezione']) # beware! YAML converts in seconds!
+      @when  = parse_dur(desc['orario'])         # beware! YAML converts in seconds!
+      @where = 'aula ' + desc['aula']
+      @online = desc['online']
+      @events = generate_events
+		end
+
+    def generate(&block)
+      result = ''
+      self.events.each do
+        |ev|
+        result += yield(self.title, self.number_of_lessons, ev)
+      end
+      return result
+    end
+
+		def course_dur_in_seconds
+			return self.academic_hours * 3600
+		end
+
+    def lesson_dur_in_seconds
+      return ((self.dur * 24)*3600).round.to_i
+    end
+
+		def number_of_lessons
+      result = (self.course_dur_in_seconds.to_f / self.lesson_dur_in_seconds.to_f).round.to_i
+      return result
+		end
+
+		class <<self
+
+			def create(title, desc, exm)
+				result = nil
+				case desc['tip_effettiva']
+					when 'collettiva'
+						result = CollectiveCourse.new(title, desc, exm)
+					when 'individuale'
+						result = IndividualCourse.new(title, desc, exm)
+					else
+						raise UnknownCourseType, "Unknown type #{desc['tipologia']}"
+				end
+				return result
+			end
+
+		end
+
+		def num_students
+      split_studs = self.students.split(/, */)
+			return split_studs.size
+		end
+
+		def total_hours
+			raise PureVirtualMethodCalled, 'Course#total_hours'
+		end
+
+		def academic_hours
+			return self.total_hours
+		end
+
+    def all_students
+      return self.students + ' ' + self.students_fc
+    end
+
+    def hours_done_per_lesson(dts, dte)
+			raise PureVirtualMethodCalled, 'Course#hours_done_per_lesson'
+    end
+
+	private
+
+		def latex_title
+			return "\\multicolumn{3}{\\bfseries #{self.title}}\\\\\n"
+		end
+
+    def parse_frequency(f)
+      result = nil
+      case f
+      when 'settimanale'
+        result = 7
+      when 'quindicinale'
+        result = 14
+      else
+        raise UnknownCourseFrequency, f
+      end
+      return result
+    end
+
+    #
+    # +parse_dur(d)+
+    #
+    # the argument is a number converted in seconds (usually, directly by YAML)
+    # so, in order to get it palatable to DateTime, we reconvert it in fraction of days.
+    #
+    def parse_dur(d)
+      frac_hours = d.to_f/3600.0
+      result = (frac_hours/24.0).to_r
+      return result
+    end
+
+    def generate_events
+      result = []
+      tot_nlessons = self.number_of_lessons
+      current_date = self.start
+      nless = 1
+      while (nless <= tot_nlessons) do
+        if self.excl_mgr.skip?(current_date)
+          current_date += self.freq
+          break if self.excl_mgr.out_of_range?(current_date)
+          next
+        end
+        lesson_start = calc_lesson_start(current_date)
+        lesson_end   = calc_lesson_end(current_date)
+        result << Event.new(lesson_start, lesson_end, nless, tot_nlessons, self.title, self.students, self.where, self.online)
+        current_date += self.freq
+        raise WrongWeekDay, "#{current_date.to_it_wday} != #{self.wday} for course \"#{self.title}\"" unless current_date.wday == DateTime.from_it_wday(self.wday)
+        nless += 1
+        @hours_done += self.hours_done_per_lesson(lesson_start, lesson_end) # hours spent teaching
+      end
+      raise EventsNotGenerated, "no events generated for course \"#{self.title}\" (#{self.type})" unless result && !result.empty?
+      self. warnings[:not_enough_lessons] = "n.lessons(#{result.size}) != expected number of lessons(#{self.number_of_lessons}) for course \"#{self.title}\" (#{self.type})" unless result.size == self.number_of_lessons
+      return result
+    end
+
+    def calc_lesson_start(dt)
+      return calc_time(dt, mceil(self.when))
+    end
+
+    def calc_lesson_end(dt)
+      return calc_time(dt, mceil(self.when) + mceil(self.dur))
+    end
+
+    def calc_time(dt, t)
+      return dt + t
+    end
+
+    def mceil(n, prec = 10000)
+      return ((n.to_f*prec.to_f).ceil/prec.to_f)
+    end
+
+	end
+
+	class CollectiveCourse < Course
+
+		def total_hours
+			return self.hours
+		end
+
+    def hours_done_per_lesson(dts, dte)
+      return (dte - dts).to_f * 24.0
+    end
+
+	end
+
+	class IndividualCourse < Course
+
+		def total_hours
+			return self.hours * self.num_students
+		end
+
+		def academic_hours
+			return (self.total_hours * 0.75)
+		end
+
+    def hours_done_per_lesson(dts, dte)
+      return ((dte - dts).to_f/0.75) * 24.0
+    end
+
+
+	end
+
+end