mo2tex 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0d4a3e29680a83e0ed36be6adb016ccbae0514ae391b20ae47cf9636afa5af0
-  data.tar.gz: 89558d4aedee21d11e805100bb4382ce5e9f8074e5e605ec7ffc2153fc07320f
+  metadata.gz: f68191fdbb4823e1f2918d06fc359c049094683a488e10a3dba6173372e6f195
+  data.tar.gz: ebec861600d24f1e1e95e860ed705861829928cd1a3489d8495bb8c7a5bc39ca
 SHA512:
-  metadata.gz: c0b52b0888cfad63b7f2ea9ac5ff0dad89b883fa64b2bd2f68b9c8c6ecfd46275aaf786da78a8ddca98765a85a80fc3f7c74768eb210d107149f46e87acb5fdd
-  data.tar.gz: d8ad2fa5702a9bf2337ab2aab272afc8424da4b0a27ee1407f44226f5661dd75f770bb221f2faa4dde8a87f75cb8e1afeaa0591036133fe9c88a3689e4dbb3ff
+  metadata.gz: 0277efd60def0f56f639e2f93bf7b73f1927240bffa7605aaf5e3a425664d205c6f476a959920d50c1970d11a9ad18000c3e55de4eda3359013c79739274f805
+  data.tar.gz: 66a0283cb729da2a976a14157cdaa987885f67d839152990a3f1739c19d64f019c5da0f78dfde3329aa640812f8149f32655777742a8b0072b6d9568a33bd256

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/lib/mo2tex/pic.rb

@@ -200,12 +200,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 +277,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.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mo2tex
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nicola Bernardini
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2025-01-08 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: []