lessons_indexer 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 004cf03a3ec55d7e9a4df1a0f32b8aa54370dec1
-  data.tar.gz: b6deb71e6bff1dd000089a95bf6a1fb0cecc36a0
+  metadata.gz: 066ca6597bddc89b3925da3df00a4732cfdc4977
+  data.tar.gz: 176a832789ba3064daeb96fac15c8de2abbdd31d
 SHA512:
-  metadata.gz: 355197e5b247cd44cdc76e9037926ba7e8d1ae5d94c15eef7603c44910efccac38972369245951a2362c15c8f32dcf386b76b5e4c88658afca5fbac3c37ffe45
-  data.tar.gz: 18fbaf874163e0409f5ec4f807f1a8764958719da44fb9b8879dbee288848d636ecc797cca58c09a4c546897da97db923f18830dfc94ee1ed575e7ad525f1dab
+  metadata.gz: 41ec1829cc6aa5c2e845189263a53e0e93080596f466a17f4ee1585734060f2f8057b44ea107c6e5496819978fe23699e5b0ca0de95d99c49f1bc2dbdd0e8a45
+  data.tar.gz: ca02f59549d1e92127b1ebeda8139c78ab18ce1dfefcd5acf57f9416ad39326fbbb795344e00fd5b4874ee6bd2670da4bb3b6257c7ae113f4a3f28f47050d42f

data/README.md

@@ -51,6 +51,8 @@ is not set.
 has a heading in the beginning, it will be skipped.
 * `-d` (`--headings_dir`) - relative path to the directory with heading images.
 Defaults to `headings`, has no effect if the `-i` flag is not set.
+* `-f` (`--pdf`) - should PDFs be generated from the lesson files in markdown format. PDFs will have the same name as the
+lesson files, read more [below](#pdf-generation). Defauls to `false`.
 
 ## Some Assumptions
 
@@ -68,6 +70,32 @@ files (of course, they don't need to have the *.md* extension). Valid files name
 All other files will be ignored. If the program cannot find a header image for a specific step,
 this step will be just skipped and the corresponding warning message will be displayed.
 
+## PDF Generation
+
+Starting from version **0.2.0** Indexer supports PDF generation. It is disabled by default - provide `-f` flag to enable this feature.
+
+PDF generation is not a very simple process, so some additional software has to be installed on your machine:
+
+* [Pandoc](http://pandoc.org/) - the main program that makes conversion possible. It supports all major platforms, just select the [version](http://pandoc.org/installing.html) that suits you.
+* [LaTex](http://www.latex-project.org/). Unfortunately, it is not possible to convert directly to PDF, so LaTex is required. Pandoc [lists](http://pandoc.org/installing.html) the recommended
+implementations of LaTex for various platforms.
+* [xetex](http://xetex.sourceforge.net/) - extension for LaTex to integrate typesetting capabilities. By default changing the default
+font family is a huge pain, therefore xetex is used. Please note, that it is already a part of some LaTex implementations
+(for example, if you install full version of MIKTex, xetex will already be present, so no additional actions are needed).
+
+Make sure Pandoc is present in your PATH by typing
+
+```
+pandoc -v
+```
+
+in your terminal.
+
+Indexer uses [Open Sans](http://www.fontsquirrel.com/fonts/open-sans) as a main font and [Liberation Mono](http://www.fontsquirrel.com/fonts/Liberation-Mono) as monotype font (for code examples). Both of these fonts
+are free (in contrast to Helvetica Neue that has to be purchased), so if you don't have those fonts just download them and install into the fonts directory.
+
+After that you are ready to generate PDFs! Just remember that it will take some time (about 5-10 seconds per lesson file).
+
 ## Testing
 
 ```

data/lib/lessons_indexer/course.rb

@@ -29,6 +29,14 @@ module LessonsIndexer
       end
     end
 
+    def generate_pdfs
+      within(dir, true) do
+        lessons.list.sort.each do |lesson|
+          %x{pandoc #{lesson.file_name} -f markdown_github -o #{lesson.file_name.gsub(/md\z/i, '')}.pdf --variable geometry:"top=1.5cm, bottom=2.5cm, left=1.5cm, right=1.5cm" --latex-engine=xelatex --variable mainfont="Open Sans" --variable monofont="Liberation Mono" --variable fontsize="12pt"}
+        end
+      end
+    end
+
     def load_headings!
       within(dir + '/' + headings_dir, true) do
         @headings = HeadingsList.new(all_with_pattern(Heading::VERSION_PATTERN).map {|heading| Heading.new(heading)})

data/lib/lessons_indexer/indexer.rb

@@ -14,6 +14,7 @@ module LessonsIndexer
 
       build_index(course) unless options.skip_index
       add_headings(course) if options.headings
+      generate_pdfs(course) if options.pdf
       git_push! if options.git
     end
 
@@ -32,6 +33,13 @@ module LessonsIndexer
       end
     end
 
+    def generate_pdfs(course)
+      course.load_lessons!
+      with_messages("Starting to generate PDFs...", "PDFs for the course #{course.title} were generated!") do
+        course.generate_pdfs
+      end
+    end
+
     def get_course_dir
       dir = Dir.entries('.').detect {|el| el =~ /_handouts\z/i}
       exit_msg("Lesson files were not found inside the provided directory. Aborting...") if dir.nil?

data/lib/lessons_indexer/options.rb

@@ -26,6 +26,7 @@ module LessonsIndexer
           o.bool '-a', '--all', 'Work with all branches (except for master)', default: false
           o.bool '-i', '--headings', 'Add heading images to the beginning of the lesson files?', default: false
           o.string '-d', '--headings_dir', 'Relative path to the directory with heading images', default: 'headings'
+          o.bool '-f', '--pdf', 'Should PDFs be generated?', default: false
         end.to_hash
       rescue Slop::Error => e
         exit_msg e.message

data/lib/lessons_indexer/version.rb

@@ -1,3 +1,3 @@
 module LessonsIndexer
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/course_spec.rb

@@ -22,6 +22,10 @@ RSpec.describe LessonsIndexer::Course do
     expect(subject.generate_index).to eq("# Index for the My Course course\n\n* [Lesson 1.3](my_course_handouts/lesson1.3.md)\n* [Lesson 2.5](my_course_handouts/lesson2.5.md)\n* [Lesson 5.8](my_course_handouts/lesson5.8.md)\n* [Lesson 10.2](my_course_handouts/lesson10.2.md)\n")
   end
 
+  specify "#generate_pdfs" do
+    expect(subject).to respond_to(:generate_pdfs)
+  end
+
   context "#generate_headings" do
     it "should return formatted heading and path to file" do
       expect(subject).to receive(:lessons).and_return(sample_lessons)

data/spec/indexer_spec.rb

@@ -36,6 +36,13 @@ RSpec.describe LessonsIndexer::Indexer do
       expect(subject).not_to receive(:add_headings)
       capture_stdout { subject.do_work! }
     end
+
+    it "should generate pdfs if --pdf is set" do
+      allow(subject.options).to receive(:skip_index).and_return(true)
+      allow(subject.options).to receive(:pdf).and_return(true)
+      expect(subject).to receive(:generate_pdfs)
+      capture_stdout { subject.do_work! }
+    end
   end
 
   context "#get_course_dir" do

data/spec/options_spec.rb

@@ -9,6 +9,7 @@ RSpec.describe LessonsIndexer::Options do
     expect(options.all).to be_falsey
     expect(options.headings).to be_falsey
     expect(options.headings_dir).to eq('headings')
+    expect(options.pdf).to be_falsey
   end
 
   it "should allow to override some options" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lessons_indexer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop