gimli 0.2.0 → 0.2.1

data/README.textile

@@ -49,6 +49,8 @@ To apply some style to the pdf or override the standard style add a css file in
 
 Standard behavior is for gimli to output the files in the current directory. To override this use the @-o@ flag to point out another output directory. Gimli tries to create it if it doesn't exist.
 
+Gimli also plays nice with Jekyll style markup files. You can pass gimli the @-y@ flag to have it remove Jekyll's YAML front matter from the top of your markup files. Allowing you to use gimli & Jekyll together on your Blog/Resume/Catalogue to create nicely formatted versions for online and offline viewing.
+
 Run @gimli -h@ for a full list of options available
 
 h2. Syntax highlighting

data/bin/gimli

@@ -9,5 +9,5 @@ if ARGV.flags.version?
   exit
 end
 
-Gimli.process! ARGV.flags.file, ARGV.flags.recursive?, ARGV.flags.merge?, ARGV.flags.outputfilename, ARGV.flags.outputdir, ARGV.flags.stylesheet
+Gimli.process! ARGV.flags.file, ARGV.flags.recursive?, ARGV.flags.merge?, ARGV.flags.removefrontmatter, ARGV.flags.outputfilename, ARGV.flags.outputdir, ARGV.flags.stylesheet
 

data/lib/gimli.rb

@@ -10,10 +10,10 @@ require 'gimli/path'
 module Gimli
 
   # Starts the processing of selected files
-  def self.process!(file, recursive = false, merge = false, output_filename = nil, output_dir = nil, stylesheet = nil)
+  def self.process!(file, recursive = false, merge = false, remove_front_matter = false, output_filename = nil, output_dir = nil, stylesheet = nil)
 
 
     @files = Path.list_valid(file, recursive).map { |file| MarkupFile.new(file) }
-    Converter.new(@files, output_filename, output_dir, stylesheet).convert!(merge)
+    Converter.new(@files, merge, remove_front_matter, output_filename, output_dir, stylesheet).convert!
   end
 end

data/lib/gimli/converter.rb

@@ -13,21 +13,27 @@ module Gimli
 
     # Initialize the converter with a File
     # @param [Array] files The list of Gimli::MarkupFile to convert (passing a single file will still work)
-    def initialize(files, output_filename = nil, output_dir = nil, stylesheet = nil)
+    # @param [Boolean] merge
+    # @param [Boolean] remove_front_matter
+    # @param [String] output_filename
+    # @param [String] output_dir
+    # @param [String] stylesheet
+    def initialize(files, merge = false, remove_front_matter = false, output_filename = nil, output_dir = nil, stylesheet = nil)
       @files = files
+      @merge = merge
+      @remove_front_matter = remove_front_matter
       @output_filename = output_filename
       @output_dir = output_dir
       @stylesheet = stylesheet
     end
 
     # Convert the file and save it as a PDF file
-    # @param [Boolean] merge if true a single pdf with all input files are created
-    def convert!(merge = false)
+    def convert!
       merged_contents = []
       @files.each do |file|
-        markup = Markup.new file
+        markup = Markup.new file, @remove_front_matter
         html = convert_image_urls markup.render, file.filename
-        if merge
+        if @merge
           html = "<div class=\"page-break\"></div>#{html}" unless merged_contents.empty?
           merged_contents << html
         else
@@ -106,7 +112,7 @@ module Gimli
         end
       else
         output_filename = Time.now.to_s.split(' ').join('_')
-        output_filename = @files.last.name if @files.length == 1 || ARGV.flags.merge?
+        output_filename = @files.last.name if @files.length == 1 || @merge
         output_filename = @output_filename unless @output_filename.nil?
       end
 

data/lib/gimli/markup.rb

@@ -26,8 +26,9 @@ module Gimli
     # Initialize a new Markup object.
     #
     # @param [Gimli::File] file  The Gimli::File to process
+    # @param [Boolean] do_remove_yaml_front_matter Should we remove the front matter?
     # @return [Gimli::Markup]
-    def initialize(file)
+    def initialize(file, do_remove_yaml_front_matter = false)
       @filename = file.filename
       @name = file.name
       @data = file.data
@@ -35,6 +36,7 @@ module Gimli
       @tagmap = {}
       @codemap = {}
       @premap = {}
+      @do_remove_yaml_front_matter = do_remove_yaml_front_matter
     end
 
     # Render the content with Gollum wiki syntax on top of the file's own
@@ -42,7 +44,9 @@ module Gimli
     #
     # @return [String] The formatted data
     def render
-      data = extract_code(@data.dup)
+      data = @data.dup
+      data = remove_yaml_front_matter(data) if @do_remove_yaml_front_matter
+      data = extract_code(data)
       data = extract_tags(data)
       begin
         data = data.force_encoding('utf-8') if data.respond_to? :force_encoding
@@ -68,6 +72,15 @@ module Gimli
       doc.to_xhtml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XHTML, :encoding => 'UTF-8')
     end
 
+    # Removes YAML Front Matter
+    # Useful if you want to PDF your Jekyll site.
+    #
+    # @param [String] data - The raw string data.
+    # @return [String] Returns the string data with frontmatter removed
+    def remove_yaml_front_matter(data)
+      data.gsub(/^(---\s*\n.*?\n?)^(---\s*$\n?)/m, '')
+    end
+
     # Extract all tags into the tagmap and replace with placeholders.
     #
     # @param [String] data - The raw string data.

data/lib/gimli/setup.rb

@@ -28,6 +28,10 @@ module Gimli extend OptiFlagSet
     description 'Merge markup files into single pdf file'
     alternate_forms 'm'
   end
+  optional_switch_flag 'removefrontmatter' do
+    description 'Remove yaml frontmatter from your files.'
+    alternate_forms 'y'
+  end
   optional_switch_flag 'version' do
     description 'Show version information and quit'
     alternate_forms 'v'

data/lib/gimli/version.rb

@@ -2,7 +2,7 @@
 
 module Gimli
 
-  Version = "0.2.0"
+  Version = "0.2.1"
 
 end
 

data/spec/fixtures/yaml_front_matter.textile

@@ -0,0 +1,7 @@
+---
+layout: test
+---
+
+
+
+This should be at the top of the file

data/spec/gimli/converter_spec.rb

@@ -31,7 +31,7 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     output_filename = 'my_file'
 
-    converter = Gimli::Converter.new [file], output_filename
+    converter = Gimli::Converter.new [file], false, false, output_filename
     mock(converter).output_dir { Dir.getwd }
 
     converter.output_file.should == File.join(Dir.getwd, "#{output_filename}.pdf")
@@ -50,7 +50,7 @@ describe Gimli::Converter do
     dir = '/tmp/out'
 
     file = Gimli::MarkupFile.new 'fake'
-    converter = Gimli::Converter.new file, nil, dir
+    converter = Gimli::Converter.new file, false, false, nil, dir
 
     mock(File).directory?(dir) { true }
 
@@ -68,7 +68,7 @@ describe Gimli::Converter do
     file = Gimli::MarkupFile.new 'fake'
     stylesheet = '/home/me/gimli/my-style.css'
 
-    converter = Gimli::Converter.new file, nil, nil, stylesheet
+    converter = Gimli::Converter.new file, false, false, nil, nil, stylesheet
 
     converter.stylesheet.should == stylesheet
   end

data/spec/gimli/markup_spec.rb

@@ -58,5 +58,14 @@ describe Gimli::Markup do
     markup.render.should == output
   end
 
+  it "should remove yaml front matter if asked to" do
+    output = "<p>This should be at the top of the file</p>"
+
+    file = Gimli::MarkupFile.new File.expand_path('../../fixtures/yaml_front_matter.textile', __FILE__)
+    markup = Gimli::Markup.new file, true
+
+    markup.render.should == output
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gimli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup
-  requirement: &22561440 !ruby/object:Gem::Requirement
+  requirement: &22129260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *22561440
+  version_requirements: *22129260
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &22557940 !ruby/object:Gem::Requirement
+  requirement: &22128480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.17.2
   type: :runtime
   prerelease: false
-  version_requirements: *22557940
+  version_requirements: *22128480
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &22556960 !ruby/object:Gem::Requirement
+  requirement: &22127580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 4.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *22556960
+  version_requirements: *22127580
 - !ruby/object:Gem::Dependency
   name: org-ruby
-  requirement: &22555840 !ruby/object:Gem::Requirement
+  requirement: &22125580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *22555840
+  version_requirements: *22125580
 - !ruby/object:Gem::Dependency
   name: creole
-  requirement: &22555200 !ruby/object:Gem::Requirement
+  requirement: &22124000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *22555200
+  version_requirements: *22124000
 - !ruby/object:Gem::Dependency
   name: wikicloth
-  requirement: &22554420 !ruby/object:Gem::Requirement
+  requirement: &22122800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *22554420
+  version_requirements: *22122800
 - !ruby/object:Gem::Dependency
   name: albino
-  requirement: &22553060 !ruby/object:Gem::Requirement
+  requirement: &22122100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.3.3
   type: :runtime
   prerelease: false
-  version_requirements: *22553060
+  version_requirements: *22122100
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &22551860 !ruby/object:Gem::Requirement
+  requirement: &22121380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *22551860
+  version_requirements: *22121380
 - !ruby/object:Gem::Dependency
   name: wkhtmltopdf-binary
-  requirement: &22550100 !ruby/object:Gem::Requirement
+  requirement: &22081420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.9.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *22550100
+  version_requirements: *22081420
 - !ruby/object:Gem::Dependency
   name: pdfkit
-  requirement: &22546560 !ruby/object:Gem::Requirement
+  requirement: &22080260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 0.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *22546560
+  version_requirements: *22080260
 - !ruby/object:Gem::Dependency
   name: optiflag
-  requirement: &22545840 !ruby/object:Gem::Requirement
+  requirement: &22079540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *22545840
+  version_requirements: *22079540
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22545180 !ruby/object:Gem::Requirement
+  requirement: &22079080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22545180
+  version_requirements: *22079080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22544200 !ruby/object:Gem::Requirement
+  requirement: &22078580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22544200
+  version_requirements: *22078580
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &22543320 !ruby/object:Gem::Requirement
+  requirement: &22078140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22543320
+  version_requirements: *22078140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &22542540 !ruby/object:Gem::Requirement
+  requirement: &22077620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,7 +175,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22542540
+  version_requirements: *22077620
 description: Utility for converting markup files to pdf files. Useful for reports
   etc.
 email: fredrik.wallgren@gmail.com
@@ -198,6 +198,7 @@ files:
 - spec/spec_helper.rb
 - spec/fixtures/code_with_utf8.textile
 - spec/fixtures/code_block_with_utf8.textile
+- spec/fixtures/yaml_front_matter.textile
 - spec/fixtures/recursion/level2/level2.markdown
 - spec/fixtures/recursion/level1.textile
 - spec/fixtures/code_block.textile
@@ -223,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1493974172056676610
+      hash: 2493386614260603891
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -232,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1493974172056676610
+      hash: 2493386614260603891
 requirements: []
 rubyforge_project: gimli
 rubygems_version: 1.8.6