mo2tex 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d4a3e29680a83e0ed36be6adb016ccbae0514ae391b20ae47cf9636afa5af0
-  data.tar.gz: 89558d4aedee21d11e805100bb4382ce5e9f8074e5e605ec7ffc2153fc07320f
+  metadata.gz: c715fef710c9144154aceaa77a10137751823c1820de13f0f72aedeb1167c71e
+  data.tar.gz: e4f860857f59181d7d2b58342915a7d7bfc2f6392fd5eb11283c51baa3fe0d6d
 SHA512:
-  metadata.gz: c0b52b0888cfad63b7f2ea9ac5ff0dad89b883fa64b2bd2f68b9c8c6ecfd46275aaf786da78a8ddca98765a85a80fc3f7c74768eb210d107149f46e87acb5fdd
-  data.tar.gz: d8ad2fa5702a9bf2337ab2aab272afc8424da4b0a27ee1407f44226f5661dd75f770bb221f2faa4dde8a87f75cb8e1afeaa0591036133fe9c88a3689e4dbb3ff
+  metadata.gz: 26f07223a6bad0b70004475bf6fb84822e5861232f80c26c9220205833e6b77d2af4c4d4cbe4cdc4c7b397e84abf968e624a5a731dcac6bd0d32bb300f6a39ff
+  data.tar.gz: 3f6ec6ec2bed786f976313e01be027615c0f9e011a6ccd5843093ed3421b77bf10098a4ebe992190ade255da66286d7fb82422ab6666cea6e8196ae9fa55e10a

data/README.md

@@ -1,22 +1,45 @@
-# `mo2tex` - A pure `ruby` monteore-to-`latex` table generator
+# `mo2tex` - A pure `ruby` monteore-to-`latex`, `ical` and `pic` 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
+`mo2tex` is a pure `ruby` monteore-to-`latex`, `ical` and `pic` table generator
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
+```sh
     $ bundle add mo2tex
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
+```sh
     $ gem install mo2tex
+```
+
+## Configuration
+
+You will have to write a `yaml` configuration file before using `mo2tex`. 
+Please check the [example provided](./config/courses.yml) for a sample configuration file.
 
 ## Usage
 
-TODO: Write usage instructions here
+After installation, you should be able to run:
+
+```sh
+$ m2l <config file> # this should create a latex file on standard out with your monteore listing
+```
+
+Please check the [example provided](./config/courses.yml) for a configuration file.
+
+```sh
+$ m2c <config file> > <ical calendar file> # this should create an ical file on standard out which you can upload anywhere fitting
+```
+
+```sh
+$ m2p <config file> | groff -p -mpic -Tpdf -P-pa4 # this should create a pdf file on standard out with a table of the lessons
+```
 
 ## Development
 

data/Rakefile

@@ -2,6 +2,12 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include(rdoc.main, "lib/**/*.rb")
+end
 
 RSpec::Core::RakeTask.new(:spec)
 

data/config/templates/pic/{header.pic → header.pic.erb}

@@ -8,6 +8,5 @@ maxpsht=29.7
 textwid=maxpswid-scale
 textht =maxpsht-1.035*scale
 
-copy "config/templates/pic/objects.pic"
+copy "<%= self.absolute_pic_objects_include_path -%>"
 .PE
-

data/exe/m2c

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-version = '1.0.0'
+version = '1.0.2'
 ourlib = File.join(ENV['HOME'], '.rvm', 'gems', 'ruby-3.4.0-preview1@mo2tex', 'gems', "mo2tex-#{version}", 'lib')
 $:<< File.join('.', 'lib')
 $:<< ourlib

data/exe/m2l

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-version = '1.0.0'
+version = '1.0.2'
 ourlib = File.join(ENV['HOME'], '.rvm', 'gems', 'ruby-3.4.0-preview1@mo2tex', 'gems', "mo2tex-#{version}", 'lib')
 $:<< File.join('.', 'lib')
 $:<< ourlib

data/exe/m2p

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-version = '1.0.0'
+version = '1.0.2'
 ourlib = File.join(ENV['HOME'], '.rvm', 'gems', 'ruby-3.4.0-preview1@mo2tex', 'gems', "mo2tex-#{version}", 'lib')
 $:<< File.join('.', 'lib')
 $:<< ourlib

data/lib/mo2tex/pic.rb

@@ -114,11 +114,26 @@ module Mo2tex
       def pic_time
         return sprintf("%s-%s", self.slot.dtstart.hm_to_s, self.slot.dtend.hm_to_s)
       end
-  
+
       def pic_title
-        return self.slot.title.sub(/^.*([TB][RN])/, '\1')
+        result = self.slot.class == Event ? make_pic_title : self.slot.title
+        return result
       end
-  
+
+      alias_method :title, :pic_title
+
+    private
+
+      TITLE_RANGE = 2..4   # the title is in this range
+      ANN_RANGE   = 5..-1
+
+      def make_pic_title
+        sep = self.slot.title.gsub(/_+/, ' ').split(/ /)
+        acro   = sep[TITLE_RANGE].map { |w| w[0] }.join
+        ann    = sep[ANN_RANGE].join(' ')
+        return sprintf("%s (%s)", ann, acro)
+      end
+
     end
   
     class Container < Base
@@ -200,12 +215,16 @@ module Mo2tex
         result = ''
         self.pages.each do
           |page|
-  			  result += self.header
+          result += self.header.result(binding)
   			  result += self.body.result(binding)
           result += self.trailer.result(binding)
         end
         return result
   		end
+
+      def absolute_pic_objects_include_path
+        return File.expand_path(File.join(['..'] * 3, 'config', 'templates', 'pic', 'objects.pic'), __FILE__)
+      end
   
       DAYS_PER_PAGE = 12
       DAYS_PER_ROW  = 4
@@ -273,7 +292,8 @@ module Mo2tex
       end
   
   		def read_header
-  			return read('header.pic')
+        template = read('header.pic.erb')
+  			return ERB.new(template, trim_mode: '-')
   		end
   
   		def read_trailer

data/lib/mo2tex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mo2tex
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mo2tex
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Nicola Bernardini
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -65,7 +65,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: mo2tex transforms a Monte Ore calendar into a Tex table
+description: mo2tex transforms a Monte Ore calendar into a LaTex table, or an ical
+  file, or a pic table
 email:
 - nicola.bernardini.rome@gmail.com
 executables:
@@ -86,7 +87,7 @@ files:
 - config/templates/latex/header.tex
 - config/templates/latex/trailer.tex
 - config/templates/pic/body.pic.erb
-- config/templates/pic/header.pic
+- config/templates/pic/header.pic.erb
 - config/templates/pic/objects.pic
 - config/templates/pic/trailer.pic.erb
 - exe/m2c
@@ -132,5 +133,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.0.dev
 specification_version: 4
-summary: mo2tex transforms a Monte Ore calendar into a Tex table
+summary: mo2tex transforms a Monte Ore calendar into a LaTex table, or an ical file,
+  or a pic table
 test_files: []