lncs 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lncs-fake.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    lncs (0.0.1)
+      json (~> 1.7)
+      pdf-reader (~> 1.3)
+      thor (~> 0.18)
+      zip (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.2)
+    afm (0.2.0)
+    hashery (2.1.0)
+    json (1.7.7)
+    pdf-reader (1.3.3)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.0)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    rake (10.0.4)
+    ruby-rc4 (0.1.5)
+    thor (0.18.1)
+    ttfunk (1.0.3)
+    zip (2.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  lncs!
+  rake

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Louis M. Rose
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,176 @@
+LNCS Volume Editor Tools
+========================
+A small set of tools that automate some of the more tedious parts of preparing an LNCS volume.
+
+The conventions enforced by `lncs` are intended to comply with the LNCS guidelines for volume editors. If you find an inconsistency between `lncs` and the LNCS guidelines, please [file a bug report](https://github.com/louismrose/lncs/issues).
+
+Installation
+------------
+You'll need to install Ruby 1.9 or later. I recommend doing so via [rvm](https://rvm.io).
+
+You can then install `lncs` via Ruby gems: `gem install lncs`
+
+Get started with the `lncs` executable: `lncs help`
+
+Recommended workflow
+--------------------
+
+1. Download the submissions for your volume
+
+2. Setup a working directory
+
+        > mkdir ecmfa2013
+        > cd ecmfa2013
+        > lncs init    
+
+3. Customise the manifest (e.g., set the path to the submissions, the volume number, ...)
+
+        > vi manifest.json
+        > cat manifest.json
+        {
+          "volume_number": 7949,
+          "sources": "/Users/louis/Downloads/submissions",
+          "sections": [
+            {
+              title: "Foundations",
+              papers: [7,11,14,18,20,24,35,46,63]
+            },
+            {
+              title: "Applications",
+              papers: [2,6,22,29,58,68]
+            }
+          ]
+        }
+    
+4. Unpack and inspect all of the submissions
+
+        > lncs inspect
+        > cd submissions
+        > ls -R
+    
+        ./ecmfa2013_submission_07:
+        7
+        ./ecmfa2013_submission_07/7:
+        paper7.tex   paper7.pdf   copyright.pdf
+    
+        ./ecmfa2013_submission_24:
+        ECMFA2013-cameraready.pdf   ECMFA2013-cameraready.docx  copyright.pdf
+
+
+5. Update the manifest with the paths to the PDF files of each paper
+
+        > vi manifest.json
+        > cat manifest.json
+        {
+          "volume_number": 7949,
+          "sources": "/Users/louis/Downloads/submissions",
+          "sections": [
+            {
+              title: "Foundations",
+              papers: [7,11,14,18,20,24,35,46,63]
+            },
+            {
+              title: "Applications",
+              papers: [2,6,22,29,58,68]
+            }
+          ],
+          papers: {
+            "7" : {
+              pdf: "7/paper.pdf"
+            },
+            "24" : {
+              pdf: "ECMFA2013-cameraready.pdf"
+            }
+          }
+        }
+
+6. Check the status of the submissions 
+
+        > lncs report
+        Foundations
+        007 -- 17pgs zip
+        011 -- 17pgs zip
+        014 -- 17pgs zip
+        018 -- 16pgs zip
+        020 -- 16pgs zip
+        024 -- 16pgs zip
+        035 -- 17pgs zip
+        046 -- 16pgs zip
+        063 -- 17pgs zip
+        Applications
+        002 -- 13pgs zip
+        006 -- 13pgs zip
+        022 -- 13pgs zip
+        029 -- 13pgs zip
+        058 -- 13pgs zip
+        068 -- 11pgs zip
+
+  If a submission exceeds your page limit, you may wish to contact the authors. If a submission is a PDF rather than a ZIP file, you may wish to do the same as you will need to send to Springer the sources and a signed copyright form for each submission.
+
+7. Generate the set of directories required by Springer for the body of the proceedings
+
+        > lncs body
+        > ls body
+        79490001 79490020 79490054 79490086 79490119 79490152 79490178 79490204
+        79490003 79490037 79490070 79490102 79490135 79490165 79490191 79490217
+    
+        > ls -R body/79490001
+        7
+    
+        body/79490001/7:
+        paper7.tex   paper7.pdf   copyright.pdf
+    
+8. Generate the title pages used to construct the table of contents and author index
+
+        > lncs titles
+        > ls titles
+        0001.tex  0020.tex  0054.tex  0086.tex  0119.tex  0152.tex  0178.tex  0204.tex  index.tex
+        0003.tex  0037.tex  0070.tex  0102.tex  0135.tex  0165.tex  0191.tex  0217.tex
+    
+9. Run LaTeX to produce your PDF
+
+        > latex2pdf main.tex
+        > open main.pdf
+    
+10. Override any titles or names of authors (because, for example, `lncs` cannot extract title page information from MS Word source files).
+
+        > vi manifest.json
+        > cat manifest.json
+        {
+          "volume_number": 7949,
+          "sources": "/Users/louis/Downloads/submissions",
+          "sections": [
+            {
+              title: "Foundations",
+              papers: [7,11,14,18,20,24,35,46,63]
+            },
+            {
+              title: "Applications",
+              papers: [2,6,22,29,58,68]
+            }
+          ],
+          papers: {
+            "7" : {
+              pdf: "7/paper.pdf",
+              title: "MOCQL: A Declarative Language for Ad-Hoc Model Querying",
+              authors: ["Harald St\\\"orrle"]
+            },
+            "24" : {
+              pdf: "ECMFA2013-cameraready.pdf"
+            }
+          }
+        }
+
+11. Regenerate your titles and PDF.
+
+        > lncs titles
+        > latex2pdf main.tex
+        > open main.pdf
+
+
+Contributing
+------------
+I'm afraid that this code is not well tested, factored or documented. It was quickly hacked together whilst in my first attempt to edit an LNCS volume. If I'm ever asked to edit a second volume, I plan to tidy up this gem and add a few more features. In the meantime, pull requests are very welcome.
+
+Todo list:
+* Better error reporting when the titles key is specified but not authors and vice versa

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/lncs

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
+
+require 'lncs'
+require 'lncs/cli'
+LNCS::CLI.start

data/lib/lncs/actions.rb

@@ -0,0 +1,7 @@
+require "thor"
+
+module LNCS
+  class Actions < Thor
+    include Thor::Actions
+  end
+end

data/lib/lncs/cli.rb

@@ -0,0 +1,62 @@
+require "thor"
+require "json"
+
+module LNCS
+  class CLI < Thor
+    include Thor::Actions
+    
+    desc "init", "Start an lncs project in the current directory"
+    def init
+      Initialiser.new.run
+    end
+    
+    desc "clean", "Remove all working directories"
+    def clean
+      working_directories = %w{submissions body titles}
+      working_directories.each {|d| remove_dir(d) }
+      create_file 'titles/index.tex'
+    end
+
+    desc "inspect", "Unpack the submissions so that their contents can be inspected manually"
+    def inspect
+      remake_directory("submissions")
+      proceedings.copy_to("submissions")
+    end
+
+    desc "body", "Generate the set of directories containing the body of the report, in the format required by Springer LNCS"
+    def body
+      remake_directory("body")
+      proceedings.generate_body_to("body")
+    end
+
+    desc "titles", "Generate a title page for each submission, including correct page numbers and author index entries"
+    def titles
+      remake_directory("titles")
+      proceedings.generate_titles_to("titles")
+    end
+
+    desc "report", "Print useful statistics about the submissions"
+    def report
+      proceedings.report
+    end
+
+private
+    def remake_directory(dir)
+      remove_dir dir
+      empty_directory dir
+    end
+    
+    def proceedings
+      manifest_missing unless File.exist?("manifest.json")
+      Proceedings.new.tap do |p|
+        p.manifest = JSON.parse(File.read("manifest.json"))
+      end
+    end
+    
+    def manifest_missing
+      puts "Error: lncs could not find a manifest.json file in the current directory."
+      puts "You can use 'lncs init' to create a basic manifest file."
+      exit 1
+    end
+  end
+end

data/lib/lncs/initialiser.rb

@@ -0,0 +1,22 @@
+module LNCS
+  class Initialiser < Thor
+    include Thor::Actions
+    
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', '..', 'templates')
+    end
+    
+    no_commands do
+      def run
+        copy_file 'manifest.json'
+        copy_file 'main.tex'
+        copy_file 'llncs.cls'
+        copy_file 'sprmindx.sty'
+        copy_file 'front_matter/organisation.tex'
+        copy_file 'front_matter/preface.tex'
+        copy_file 'front_matter/sponsors.tex'
+        create_file 'titles/index.tex'
+      end
+    end
+  end
+end

data/lib/lncs/paper.rb

@@ -0,0 +1,166 @@
+require 'tmpdir'
+require 'pdf-reader'
+require 'zip/zipfilesystem'
+require 'lncs/actions'
+
+module LNCS
+  class Paper
+    attr_accessor :manifest, :path
+    
+    def pdf
+      manifest["pdf"]
+    end
+    
+    def title
+      manifest["title"]
+    end
+    
+    def authors
+      manifest["authors"]
+    end
+  
+    def name
+      File.basename(path)
+    end
+  
+    def id
+      name.match(/(\d+).(pdf|zip)/)[1]
+    end
+  
+    def type
+      name.match(/(pdf|zip)/)[1]
+    end
+  
+    def generate_title_to(dst, start_page)
+      raise "Error: Cannot generate title from PDF for paper ##{id}" if type == "pdf"
+      check_pdf_exists
+    
+      captured = title_page_from_manifest_or_latex
+      captured += "\n" + authors_from_manifest_or_latex.map do |a| 
+        a.gsub!(/(?<forename>\S*) (?<surname>.*)/, '\k<surname>, \k<forename>') if a   
+        "\\index{#{a}}"
+      end.join("\n") + "\n"
+    
+      captured += "\\maketitle\n"
+      captured += "\\clearpage\n"
+      captured += "\\setcounter{page}{#{start_page + page_count}}"
+    
+      actions.create_file(dst, captured)
+    end
+  
+    def copy_to(dst)
+      check_pdf_exists
+      
+      FileUtils.mkdir_p(dst)
+    
+      if type == "zip"
+        Zip::ZipFile.open(path) do |zipfile|
+          zipfile.select { |file| zipfile.get_entry(file).file? }.each do |file|
+            actions.create_file(File.join(dst, file.name), zipfile.read(file))
+          end
+        end
+      else
+        actions.copy_file(path, File.join(dst, name))
+      end
+    end
+  
+    def page_count
+      check_pdf_exists
+      
+      PDF::Reader.new(open_pdf).page_count
+    end
+  
+  private
+    def check_pdf_exists
+      raise "Error: no file found at path '#{path}'" unless File.exist?(path)
+      
+      if type == "zip"
+        pdf_exists = Zip::ZipFile.open(path) { |zipfile| zipfile.find_entry(pdf) }
+        raise "Error: no PDF file found at path '#{pdf}' within the ZIP file #{path}" unless pdf_exists  
+      end
+    end
+    
+    def open_pdf      
+      if type == "zip"
+        extracted_pdf = File.join(Dir.tmpdir, pdf)
+        Zip::ZipFile.open(path) do |zipfile|
+          FileUtils.mkdir_p(File.dirname(extracted_pdf))
+          zipfile.extract(pdf, extracted_pdf) { true }
+        end
+        File.open(extracted_pdf, "rb")
+      else
+        File.open(path, "rb")
+      end
+    end
+    
+    def authors_from_manifest_or_latex
+      if authors
+        authors
+      else
+        regex = %r{
+          \\author(?<re>
+            \{
+              (?:
+                (?> [^{}]+ )
+                |
+                \g<re>
+              )*
+            \}
+          )
+        }x
+      
+        title_page = title_page_from_manifest_or_latex
+        if regex.match(title_page)
+          author_tag = regex.match(title_page)[1]
+          author_tag = author_tag[1..-2]                  # strip starting and closing bracket
+          author_tag.gsub! /\\\\/, ''                     # strip forced linebreaks
+          author_tag.gsub! /\\inst\{[^\}]*?\}/, ''         # strip institutions
+          author_tag.split('\and').map do |a|
+            a.strip!
+          end
+        else
+          []
+        end
+      end
+    end
+  
+    def title_page_from_manifest_or_latex
+      if title
+  """
+  \\title{#{title}}\n
+  \\author{#{authors_from_manifest_or_latex.join(" \\and ")}}\n
+  """
+      else
+        captured = ""
+        each_tex do |tex|
+          capturing = false
+          while (line = tex.gets)
+            break if line.include? '\maketitle'
+            captured += line if capturing and not line.include? '\frontmatter' and not line.include? '\mainmatter'
+            capturing = true if line.include? '\begin{document}'
+          end
+        end
+        captured.gsub /\\mails[a-z](\\\\)?/, '$ $'  # remove any \mailsa or similar commands
+      end
+    end
+  
+    def each_tex
+      if type == "zip"
+        Zip::ZipFile.open(path) do |zipfile|
+          zipfile.each do |file|
+            if file.name.end_with? "tex" and not file.name.end_with? "llncs.tex"
+              extracted_tex = File.join(Dir.tmpdir, file.name)
+              FileUtils.mkdir_p(File.dirname(extracted_tex))
+              zipfile.extract(file, extracted_tex) { true }
+              File.open(extracted_tex, "rb") { |file| yield(file) }
+            end
+          end
+        end
+      end
+    end
+  
+    def actions
+      Actions.new
+    end
+  end
+end

data/lib/lncs/proceedings.rb

@@ -0,0 +1,75 @@
+require 'lncs/actions'
+
+module LNCS
+  class Proceedings
+    attr_accessor :manifest
+    
+    def volume_number
+      manifest["volume_number"]
+    end
+  
+    def source_directory
+      manifest["sources"]
+    end
+  
+    def papers
+      manifest["papers"]
+    end
+  
+    def paper_file_name_for(paper_id)
+      Dir.chdir(source_directory) do
+        Dir.glob("*_#{paper_id}.{pdf,zip}")[0]
+      end
+    end
+  
+    def paper_path_for(paper_id)
+      filename = paper_file_name_for(paper_id)
+      raise "Error: no file with name ending '#{paper_id}.pdf' or '#{paper_id}.zip' found at path '#{source_directory}'" unless filename
+      File.join(source_directory, filename)
+    end
+  
+    def paper_manifest_for(paper_id)
+      paper_manifest = papers.fetch(paper_id.to_s, {})
+      paper_manifest["pdf"] = paper_file_name_for(paper_id) unless paper_manifest["pdf"]
+      paper_manifest
+    end
+  
+    def sections
+      manifest["sections"].map do |section|
+        Section.new.tap do |s|
+          s.manifest = section
+          s.proceedings = self
+        end
+      end
+    end
+
+    def copy_to(dst)
+      sections.each { |section| section.copy_to(dst) }
+    end
+
+    def generate_body_to(dst)
+      start_page = 1
+      sections.each do |s|
+        start_page = s.generate_body_to(dst, volume_number, start_page)
+      end
+    end
+
+    def generate_titles_to(dst)
+      actions.remove_file("#{dst}/index.tex")
+      actions.create_file("#{dst}/index.tex")
+      start_page = 1
+      sections.each do |s|
+        start_page = s.generate_titles_to(dst, start_page)
+      end
+    end
+
+    def report
+      sections.each { |s| s.report }
+    end
+
+  private
+    def actions
+      Actions.new
+    end
+  end
+end

data/lib/lncs/section.rb

@@ -0,0 +1,60 @@
+require 'lncs/actions'
+
+module LNCS
+  class Section
+    attr_accessor :manifest, :proceedings
+  
+    def papers
+      manifest["papers"].map do |paper_id|      
+        Paper.new.tap do |p|
+          p.manifest = proceedings.paper_manifest_for(paper_id)
+          p.path = proceedings.paper_path_for(paper_id)
+        end
+      end
+    end
+    
+    def title
+      manifest["title"]
+    end
+  
+    def copy_to(dst)
+      papers.each { |paper| paper.copy_to("#{dst}/#{paper.id}") }
+    end
+  
+    def generate_body_to(dst, volume_number, start_page)
+      papers.each do |paper|
+        padded_start_page = "%04d" % start_page.to_s
+        paper.copy_to("#{dst}/#{volume_number}#{padded_start_page}")  
+        start_page += paper.page_count
+      end
+      start_page
+    end
+  
+    def generate_titles_to(dst, start_page)
+      titles = []
+      papers.each do |paper|
+        padded_start_page = "%04d" % start_page.to_s
+        titles << "#{dst}/#{padded_start_page}.tex"
+        paper.generate_title_to(titles.last, start_page)
+        start_page += paper.page_count
+      end
+      
+      actions.append_file("#{dst}/index.tex") do
+        "\\addtocmark{#{title}}\n" +
+        titles.map {|title| "\\input{#{title}}\n"}.join
+      end
+    
+      start_page
+    end
+  
+    def report
+      puts title
+      papers.each { |paper| puts "#{"%03d" % paper.id} -- #{paper.page_count}pgs #{paper.type}" }
+    end
+    
+  private
+    def actions
+      Actions.new
+    end
+  end
+end

data/lib/lncs/version.rb

@@ -0,0 +1,3 @@
+module LNCS
+  VERSION = "0.0.1"
+end

data/lib/lncs.rb

@@ -0,0 +1,6 @@
+module LNCS
+  autoload :Initialiser, 'lncs/initialiser'
+  autoload :Paper,       'lncs/paper'
+  autoload :Proceedings, 'lncs/proceedings'
+  autoload :Section,     'lncs/section'
+end

data/lncs.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require 'lncs/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'lncs'
+  spec.version     = LNCS::VERSION
+  spec.licenses    = ['MIT']
+  spec.authors     = ["Louis M. Rose"]
+  spec.email       = ["louismrose@gmail.com"]
+  spec.homepage    = "https://github.com/louismrose/lncs"
+  spec.summary     = %q{A few tools for automating the preparation of a Springer LNCS volume}
+  spec.description = %q{Automates the production of tables of contents and author indexes, and the arrangement of papers for a Springer LNCS volume.}
+
+  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.files       = `git ls-files`.split($/)
+  spec.executables   = %w(lncs)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "json", "~> 1.7"
+  spec.add_dependency "thor", "~> 0.18"
+  spec.add_dependency "zip", "~> 2.0"
+  spec.add_dependency "pdf-reader", "~> 1.3"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end