fplatex 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00759f874775732822b764a4e8e58a234769874a
+  data.tar.gz: 5527525895755b9f141f4d542c7f7d843c541c26
+SHA512:
+  metadata.gz: ebfee34d140190875adfed11660a3622235c61a74627b1a84f35d25bbbd9ec34694745fc70e6a17c2bf24e98baeabea01a4e3b0ccc856b71fe51b39467c3988a
+  data.tar.gz: eeb8a99747d5c6f5e48819c02ca44abd783a60ff7411dd00f85f44ebf0525721c0b6f560041cb44f65c58409c66131430e1a8f9e986538cf833ae04512f6863a

data/bin/fplatex

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'highline/import'
+require 'fileutils'
+require 'yaml'
+
+class ScriptArguments < Hash
+    def initialize(args)
+        super()
+
+        opt_parser = OptionParser.new do |opts|
+            opts.banner = "Usage: fp_latex [options] \n If options aren't covered, script will ask for variables."
+
+            opts.on('-c COURSE', '--course', 'The course this assignment is for') do |course|
+                self[:course] = course
+            end
+
+            opts.on('-a AUTHOR', '--author', 'Your name') do |author|
+                self[:author] = author
+            end
+
+            opts.on('-t TITLE', '--title', 'Homework Assignment Name') do |title|
+                self[:title] = title
+            end
+
+            opts.on('-d DUEDATE', '--due-date', 'Due date of assignment') do |due_date|
+                self[:due_date] = due_date
+            end
+
+            opts.on('-p PROFESSOR', '--professor', 'The professor for the course') do |professor|
+                self[:professor] = professor
+            end
+
+            opts.on('-f FILENAME', '--filename', 'Desired filename of latex file, will append \'.tex\' if not already put. Uses relative paths.') do |filename|
+                self[:filename] = filename
+            end
+
+            opts.on('-y YAMLFILE', '--yaml-file',
+                    'Load a yaml file with all the variables set already. Must indicate which hash to use. For any missing variables, this script will ask for them if not specified by other flags.') do |yaml_file|
+              self[:yaml_file] = yaml_file
+            end
+
+            opts.on('-e PRESET', '--environment',
+                    'After choosing a yaml file, you must choose a preset set of variables. This is so you should only need one yaml file with all your variables and presets. Variables passed by flags override arguments from yaml file.') do |preset|
+              self[:preset] = preset
+            end
+
+            opts.on('-h', '--help', 'Display this help and exit') do
+                puts opts
+                exit
+            end
+        end
+
+        opt_parser.parse!(args)
+
+      end
+end
+
+arguments = ScriptArguments.new(ARGV)
+
+class LatexVariables
+    def initialize(args)
+        @template_path = `gem which latex_hw_template.tex`
+        @template_path.slice!("\n")
+        if @template_path.empty?
+          puts "Can't find the latex template from the gem path, consider uninstalling and reinstalling"
+          exit
+        end
+
+        if args[:yaml_file] and File.exists?(args[:yaml_file])
+          config = YAML.load(File.new(args[:yaml_file]))
+          if args[:preset].nil? or config[args[:preset]].nil?
+            puts "If you're trying to use a YAML file to load variables you need to pass a valid preset hash as well."
+            exit
+          else
+            @filename = parse_filename(config[args[:preset]]['filename'])
+            @course = config[args[:preset]]['course']
+            @professor = config[args[:preset]]['professor']
+            @author = config[args[:preset]]['author']
+            @due_date = config[args[:preset]]['duedate']
+            @title = config[args[:preset]]['title']
+        end
+      end
+
+        if args[:filename]
+            @filename = parse_filename args[:filename]
+            if File.exists?(args[:filename])
+                confirm = ask("File named #{@filename} already exists, overwrite? [Y/N] ") { |yn| yn.limit = 1, yn.validate = /[yn]/i }
+                exit unless confirm.downcase == 'y'
+            else
+                system "cp #{@template_path} #{@filename}"
+            end
+        elsif !@filename
+            filename = ask("What would you like to name this latex file?")
+            @filename = parse_filename(filename)
+            FileUtils.cp("#{@template_path}", "#{@filename}")
+        end
+        if args[:course]
+            @course = args[:course]
+        elsif !@course
+            @course = ask("What course is this assignment for?")
+        end
+        if args[:professor]
+            @professor = args[:professor]
+        elsif !@professor
+            @professor = ask("What is the name of your professor?")
+        end
+        if args[:author]
+            @author = args[:author]
+        elsif !@author
+            @author = ask("Who are you?")
+        end
+        if args[:due_date]
+            @due_date = args[:due_date]
+        elsif !@due_date
+            @due_date = ask("When is this assignment due?")
+        end
+        if args[:title]
+            @title = args[:title]
+        elsif !@title
+            @title = ask("What is the title of this assignment?")
+        end
+
+    end
+
+    def parse_filename(filename)
+      if filename.nil? or filename.empty?
+        nil
+      elsif (filename =~ /^*\.$/i).nil?
+        filename + ".tex"
+      elsif (filename =~ /^*\.$/i)
+        filename + "tex"
+      else
+        filename
+      end
+    end
+
+    def execute
+        text = File.read(@filename)
+        new_text = text.gsub(/HOMEWORKTITLE/, @title).gsub(/DUEDATE/, @due_date).gsub(/COURSE/, @course).gsub(/PROFESSOR/, @professor).gsub(/AUTHOR/,@author)
+        File.write(@filename, new_text)
+        system "latex #{@filename}" if system "which latex"
+		    system "pdflatex #{@filename}" if system "which pdflatex"
+    end
+
+end
+
+latex_variables = LatexVariables.new(arguments)
+latex_variables.execute

data/lib/latex_hw_template.tex

@@ -0,0 +1,155 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Structured General Purpose Assignment
+% LaTeX Template
+%
+% This template has been downloaded from:
+% http://www.latextemplates.com
+%
+% Original author:
+% Ted Pavlic (http://www.tedpavlic.com)
+%
+% Note:
+% The \lipsum[#] commands throughout this template generate dummy text
+% to fill the template out. These commands should all be removed when 
+% writing assignment content.
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%----------------------------------------------------------------------------------------
+%	PACKAGES AND OTHER DOCUMENT CONFIGURATIONS
+%----------------------------------------------------------------------------------------
+
+\documentclass{article}
+\usepackage[numbered, framed]{matlab-prettifier}
+\usepackage{amsmath}%
+\usepackage{MnSymbol}%
+\usepackage{wasysym}%
+\usepackage{cancel}
+\usepackage{tikz}
+\usepackage{graphicx}
+\usepackage[margin=1in]{geometry} 
+\usetikzlibrary{automata,positioning}
+\usepackage{fancyhdr} % Required for custom headers
+\usepackage{lastpage} % Required to determine the last page for the footer
+\usepackage{extramarks} % Required for headers and footers
+\usepackage{graphicx} % Required to insert images
+\usepackage{lipsum} % Used for inserting dummy 'Lorem ipsum' text into the template
+\usepackage{enumitem}
+\usepackage{graphicx}
+% Margins
+\topmargin=-0.45in
+\evensidemargin=0in
+\oddsidemargin=0in
+\textwidth=6.5in
+\textheight=9.0in
+\headsep=0.25in 
+
+\linespread{1.1} % Line spacing
+
+% Set up the header and footer
+\pagestyle{fancy}
+\lhead{\hmwkAuthorName} % Top left header
+\chead{\hmwkClass\ (\hmwkClassInstructor\ \hmwkClassTime): \hmwkTitle} % Top center header
+\rhead{\firstxmark} % Top right header
+\lfoot{\lastxmark} % Bottom left footer
+\cfoot{} % Bottom center footer
+\rfoot{Page\ \thepage\ of\ \pageref{LastPage}} % Bottom right footer
+\renewcommand\headrulewidth{0.4pt} % Size of the header rule
+\renewcommand\footrulewidth{0.4pt} % Size of the footer rule
+
+%----------------------------------------------------------------------------------------
+%	DOCUMENT STRUCTURE COMMANDS
+%	Skip this unless you know what you're doing
+%----------------------------------------------------------------------------------------
+
+% Header and footer for when a page split occurs within a problem environment
+\newcommand{\enterProblemHeader}[1]{
+\nobreak\extramarks{#1}{#1 continued on next page\ldots}\nobreak
+\nobreak\extramarks{#1 (continued)}{#1 continued on next page\ldots}\nobreak
+}
+
+% Header and footer for when a page split occurs between problem environments
+\newcommand{\exitProblemHeader}[1]{
+\nobreak\extramarks{#1 (continued)}{#1 continued on next page\ldots}\nobreak
+\nobreak\extramarks{#1}{}\nobreak
+}
+
+\setcounter{secnumdepth}{0} % Removes default section numbers
+\newcounter{homeworkProblemCounter} % Creates a counter to keep track of the number of problems
+
+\newcommand{\homeworkProblemName}{}
+\newenvironment{homeworkProblem}[1][Problem \arabic{homeworkProblemCounter}]{ % Makes a new environment called homeworkProblem which takes 1 argument (custom name) but the default is "Problem #"
+\stepcounter{homeworkProblemCounter} % Increase counter for number of problems
+\renewcommand{\homeworkProblemName}{#1} % Assign \homeworkProblemName the name of the problem
+\section{\homeworkProblemName} % Make a section in the document with the custom problem count
+\enterProblemHeader{} % Header and footer within the environment
+}{
+\exitProblemHeader{} % Header and footer after the environment
+}
+
+\newcommand{\problemAnswer}[1]{ % Defines the problem answer command with the content as the only argument
+\noindent\framebox[\columnwidth][c]{\begin{minipage}{0.98\columnwidth}#1\end{minipage}} % Makes the box around the problem answer and puts the content inside
+}
+
+\newcommand{\homeworkSectionName}{}
+\newenvironment{homeworkSection}[1]{ % New environment for sections within homework problems, takes 1 argument - the name of the section
+%\renewcommand{\homeworkSectionName}{#1} % Assign \homeworkSectionName to the name of the section from the environment argument
+\subsection{\homeworkSectionName} % Make a subsection with the custom name of the subsection
+\enterProblemHeader{ [\homeworkSectionName]} % Header and footer within the environment
+}{
+\enterProblemHeader{} % Header and footer after the environment
+}
+   
+%----------------------------------------------------------------------------------------
+%	NAME AND CLASS SECTION
+%----------------------------------------------------------------------------------------
+
+\newcommand{\hmwkTitle}{HOMEWORKTITLE} % Assignment title
+\newcommand{\hmwkDueDate}{DUEDATE} % Due date
+\newcommand{\hmwkClass}{COURSE} % Course/class
+\newcommand{\hmwkClassTime}{} % Class/lecture time
+\newcommand{\hmwkClassInstructor}{\: PROFESSOR} % Teacher/lecturer
+\newcommand{\hmwkAuthorName}{AUTHOR} % Your name
+
+%----------------------------------------------------------------------------------------
+%	TITLE PAGE
+%----------------------------------------------------------------------------------------
+
+\title{
+\vspace{2in}
+\textmd{\textbf{\hmwkClass:\ \hmwkTitle}}\\
+\normalsize\vspace{0.1in}\small{Due\ on\ \hmwkDueDate}\\
+\vspace{0.1in}\large{\hmwkClassInstructor}
+\vspace{3in}
+}
+\author{\hmwkAuthorName}
+\date{} % Insert date here if you want it to appear below your name
+
+%----------------------------------------------------------------------------------------
+
+\begin{document}
+
+\maketitle
+
+
+%----------------------------------------------------------------------------------------
+%	TABLE OF CONTENTS
+%----------------------------------------------------------------------------------------
+
+%\setcounter{tocdepth}{1} % Uncomment this line if you don't want subsections listed in the ToC
+
+%\newpage
+%\tableofcontents
+\newpage
+
+%----------------------------------------------------------------------------------------
+%	PROBLEM 9.10.1
+%----------------------------------------------------------------------------------------
+
+% To have just one problem per page, simply put a \clearpage after each problem
+\begin{homeworkProblem}[Problem 1]
+\end{homeworkProblem}
+ \clearpage
+%----------------------------------------------------------------------------------------
+
+\end{document}

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: fplatex
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Francis Phan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+description: Speed up work flow of writing reports
+email: fphan@umass.edu
+executables:
+- fplatex
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/fplatex
+- lib/latex_hw_template.pdf
+- lib/latex_hw_template.tex
+homepage: https://github.com/francisphan/fplatex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Latex Report template
+test_files: []