gimli 0.5.9 → 0.6.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 745aff7824afe2baa8df9ad61964390a45565f88
-  data.tar.gz: 5615bd88c9ec48c9bc0d4f39ebfe7bd16dc080e1
+  metadata.gz: b84d39c6c0ac2ce7c3ecff0d47df9b6e9ac0c3ba
+  data.tar.gz: cfcf90b95333dd707228831fc416f70f90aa0af4
 SHA512:
-  metadata.gz: 469693e533fc1aad077030634f6ca197255155ce3e086dc3dda6d689d7c1f386417d16e2774f9b9c1fe2fc934bf662dc1539fce96d3f2f294a9e1f1c96b03a0b
-  data.tar.gz: 65f84c7f0f68f814a949d72983ee821b23eab0d120e975e4313f5f31256f39462dfbf0aef9fa2ae21629bcb32a2083147866983f70404ba4a88e46ef244f2db9
+  metadata.gz: 831b59d7a468451cdb341d81ffd141f448f0e0dceddb03ecdbf836714c377586abe5f4becc431dd2ff1229506c53e7a2c0944c7e6266d604d6d929c9eb918703
+  data.tar.gz: 7e9b8c0575454d38f4674213426782dc232ee0f8718667d79d64f54ce00f6b6fcefd4287944a7ecde501408befdb302c5859d802c74b23338bab590d77646574

data/README.textile

@@ -0,0 +1,79 @@
+h1. gimli - utility for converting markup to pdf
+
+"!https://secure.travis-ci.org/walle/gimli.png!":http://travis-ci.org/walle/gimli
+
+h2. Description
+
+Gimli is a utility for converting markup to pdf files. Useful for reports and such things.
+It's a developed version of "textile2pdf":https://github.com/walle/textile2pdf to support multiple markup styles and to get syntax highlighting.
+
+It's inspired by the markup convertion in "gollum":https://github.com/github/gollum. The markup code is adapted from gollum.
+It works by converting the markup to pdf using "wkhtmltopdf":https://github.com/antialize/wkhtmltopdf
+The markup is converted to html using "github/markup":https://github.com/github/markup
+
+h3. Markup
+
+Markup files may be written in any format supported by GitHub-Markup (except roff).
+
+h3. Images
+
+Images can be included by absolute url on your hard drive or a absolute url on the Internet. You can also refer to an image relative from the markup file. Example in textile.
+
+<pre>
+!/tmp/test.jpg!
+!http://upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png!
+!../images/test.jpg!
+</pre>
+
+h2. Installation
+
+The best way to install Gimli is with RubyGems:
+
+bc. $ [sudo] gem install gimli
+
+You can install from source:
+
+bc. $ cd gimli/
+$ bundle
+$ rake install
+
+h2. Running
+
+The standard way to run gimli is to go to a folder with markup files and running
+
+bc. $ gimli
+
+To apply some style to the pdf or override the standard style add a css file in the directory named @gimli.css@ or use the @-s@ flag to point out another css file.
+
+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.
+
+To pass parameters directly to wkhtmltopdf, use the @-w@ flag. eg.
+
+bc. $ gimli -f test.md -w '--toc --footer-right "[page]/[toPage]"'
+
+This gives a pdf with a table of contents and page numbers in the footer.
+
+See the "man page":http://wkhtmltopdf.org/usage/wkhtmltopdf.txt for wkhtmltopdf for all possible parameters.
+
+Run @gimli -h@ for a full list of options available
+
+h2. Syntax highlighting
+
+In page files you can get automatic syntax highlighting for a wide range of languages by using the following syntax:
+
+bc. ```ruby
+  def foo
+    puts 'bar'
+  end
+```
+
+The block must start with three backticks (as the first characters on the line). After that comes the name of the language that is contained by the block. The language must be one of the short name lexer strings supported by coderay. See the list of lexers for valid options.
+
+If the block contents are indented two spaces or one tab, then that whitespace will be ignored (this makes the blocks easier to read in plaintext).
+
+The block must end with three backticks as the first characters on a line.
+
+The syntax highlightning is powered by "coderay":https://github.com/rubychan/coderay and is using a "github theme":https://github.com/pie4dan/CodeRay-GitHub-Theme.
+

data/lib/gimli/converter.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 require 'fileutils'
-require 'tempfile'
 
 require 'gimli/markup'
 
@@ -10,6 +9,8 @@ module Gimli
   # The class that converts the files
   class Converter
 
+    COVER_FILE_PATH = ::File.expand_path("../../../config/cover.html", __FILE__)
+
     # Initialize the converter with a File
     # @param [Array] files The list of Gimli::MarkupFile to convert (passing a single file will still work)
     # @param [Gimli::Config] config
@@ -18,10 +19,7 @@ module Gimli
 
       @stylesheets = []
       parameters = [@config.wkhtmltopdf_parameters]
-      if config.cover
-        @coverfile = Tempfile.new(['coverfile', '.html'])
-        parameters << '--cover' << @coverfile.path
-      end
+      parameters << '--cover' << COVER_FILE_PATH if config.cover
       @wkhtmltopdf = Wkhtmltopdf.new parameters.join(' ')
     end
 
@@ -66,7 +64,6 @@ module Gimli
       load_stylesheets
       generate_cover!
       append_stylesheets html
-      puts @wkhtmltopdf.command(output_file(filename)).join(' ') if @config.debug
       @wkhtmltopdf.output_pdf html, output_file(filename)
     end
 
@@ -132,8 +129,9 @@ module Gimli
       html = "<div class=\"cover\">\n#{markup.render}\n</div>"
       append_stylesheets(html)
       html = add_head(html)
-      @coverfile.write(html)
-      @coverfile.close
+      File.open(COVER_FILE_PATH, 'w') do |f|
+        f.write html
+      end
     end
   end
 end

data/lib/gimli/path.rb

@@ -23,7 +23,7 @@ module Gimli
       end
 
       # Use select to support ruby 1.8
-      Dir.glob(target).sort().select { |file| MarkupFile.new(file).valid? }
+      Dir.glob(target).select { |file| MarkupFile.new(file).valid? }
     end
   end
 end

data/lib/gimli/setup.rb

@@ -33,7 +33,7 @@ module Gimli extend OptiFlagSet
     alternate_forms 'm'
   end
   optional_switch_flag 'debug' do
-    description 'Debugs wkhtmltopdf command and html output to stdout'
+    description 'Debugs html output to stdout'
     alternate_forms 'd'
   end
   optional_switch_flag 'removefrontmatter' do

data/lib/gimli/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
 module Gimli
-  VERSION = "0.5.9"
+  VERSION = "0.6.0.pre"
 end
 

data/spec/gimli/converter_spec.rb

@@ -131,9 +131,10 @@ describe Gimli::Converter do
       stub(renderer).render { 'fake' }
     end
 
+    FileUtils.rm_f(Gimli::Converter::COVER_FILE_PATH)
     converter.generate_cover!
-    coverfile = converter.instance_variable_get(:@coverfile)
-    File.exists?(coverfile.path).should == true
+    File.exists?(Gimli::Converter::COVER_FILE_PATH).should == true
+    FileUtils.rm_f(Gimli::Converter::COVER_FILE_PATH)
   end
 end
 

data/spec/gimli/markup_file_spec.rb

@@ -11,15 +11,15 @@ describe Gimli::MarkupFile do
   end
 
   it 'should recognize valid format' do
-    @file.valid_format?('textile').should be true
+    @file.valid_format?('textile').should be_true
   end
 
   it 'should recognize invalid format' do
-    @file.valid_format?('abc123').should be false
+    @file.valid_format?('abc123').should be_false
   end
 
   it 'should recognize nil as invalid format' do
-    @file.valid_format?(nil).should be false
+    @file.valid_format?(nil).should be_false
   end
 
   it 'should give the name as the filename without the extension' do

data/spec/gimli/path_spec.rb

@@ -26,7 +26,7 @@ describe Gimli::Path do
 
   # What is the sound of one file recursing?
   it 'should find one file, with a specified file, with recursion' do
-    Gimli::Path.list_valid('README.md', true).length.should == 1
+    Gimli::Path.list_valid('README.textile', true).length.should == 1
   end
 
 end

data/spec/spec_helper.rb

@@ -7,8 +7,5 @@ end
 
 RSpec.configure do |config|
   config.mock_with :rr
-  config.expect_with :rspec do |c|
-    c.syntax = :should
-  end
 end
 

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: gimli
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.0.pre
 platform: ruby
 authors:
 - Fredrik Wallgren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2014-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.7
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: 1.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: 1.5.5
 - !ruby/object:Gem::Dependency
-  name: wkhtmltopdf-binary
+  name: wkhtmltopdf-binary-11
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9.3
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9.3
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: optiflag
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Utility for converting markup files to pdf files. Useful for reports
@@ -171,7 +171,7 @@ executables:
 - gimli
 extensions: []
 extra_rdoc_files:
-- README.md
+- README.textile
 - LICENSE
 files:
 - bin/gimli
@@ -214,29 +214,28 @@ files:
 - spec/spec_helper.rb
 - config/style.css
 - LICENSE
-- README.md
-- CHANGELOG.md
+- README.textile
 homepage: https://github.com/walle/gimli
 licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: gimli
-rubygems_version: 2.0.14
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Utility for converting markup files to pdf files.

data/CHANGELOG.md

@@ -1,77 +0,0 @@
-# Changelog
-
-## 0.5.9
-
-* Add sort on files in path to ensure the alphabetical order is maintained.
-
-## 0.5.8
-
-* Use a tempfile for the cover option. Fixes bug where using system ruby on
-  OSX gets write error.
-
-## 0.5.5
-
-* Add --cover option for creating cover with markdown file https://github.com/walle/gimli/pull/48 Thanks @k0kubun
-
-## 0.5.4
-
-* Use the -q parameter instead of --quiet. https://github.com/walle/gimli/pull/52 Thanks @nelsonsar
-* Bugfix with UTF-8 characters. Thanks @toshi-kawanishi
-
-## 0.5.3
-
-* Merge fixes for gemfile and gitignore. Thanks @docwhat
-
-## 0.5.0
-
-* Support for autolinks and tables using PHP-Markdown style. This version monley patches github/markup to use redcarpet directly in order to be able to pass in extensions.
-
-## 0.4.2
-
-* Fix bug with wkhtmltopdf arguments not being passed to said command #38 (@apognu)
-* Adds debug flag to output generated html to stdout
-* Add css styling to fix issue #36
-
-## 0.4.1
-
-Add utf-8 meta tag to fix display of utf-8 characters
-
-## 0.4.0
-
-* Remove some markup gems as dependencies. Install them outside of gimli to use them. Like all other more "unkommon" markup languages.
-
-## 0.3.2
-
-* Code refactorings
-* Removed support for gollum's "tags" eg. [[File]]. Use markup to create links
-
-## 0.3.1
-
-* Use coderay instead of albino and pygments. This fixes issues with
-  pygments not being installed and simplifies testing.
-
-## 0.3.0
-
-* Remove flags for table of contents and page numbering. Add flag for wkhtmltopdf parameters instead to give more flexibility.
-
-**This version changes the way you use gimli if you are using the -t or
--p flags. Use the -w flag instead to send the parameters directly to
-wkhtmltopdf.**
-
-## 0.2.3
-
-* Bugfix: Transcode to ISO-8859-1 in 1.9 also (@svendahlstrand)
-* Add support for table of contents
-* Bugfix: Fix incompatible character encodings with code fragments
-  (@ebeigarts)
-* Remove warning of iconv being depricated
-
-## 0.2.2
-
-* Add support for printing out page numbers
-
-## 0.2.1
-
-* Add the ability to remove yaml front matter from documents before they are converted (@clowder)
-
-

data/README.md

@@ -1,104 +0,0 @@
-# gimli – utility for converting markup to pdf
-
-[![](https://secure.travis-ci.org/walle/gimli.png)](http://travis-ci.org/walle/gimli)
-
-## Description
-
-Gimli is a utility for converting markup to pdf files. Useful for reports and such things.
-It’s a developed version of [textile2pdf](https://github.com/walle/textile2pdf) to support multiple markup styles and to get syntax highlighting.
-
-It’s inspired by the markup convertion in [gollum](https://github.com/github/gollum). The markup code is adapted from gollum.
-It works by converting the markup to pdf using [wkhtmltopdf](https://github.com/antialize/wkhtmltopdf)
-The markup is converted to html using [github/markup](https://github.com/github/markup)
-
-### Markup
-
-Markup files may be written in any format supported by GitHub-Markup (except roff).
-
-### Images
-
-Images can be included by absolute url on your hard drive or a absolute url on the Internet. You can also refer to an image relative from the markup file. Example in textile.
-
-<pre>
-!/tmp/test.jpg!
-!http://upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png!
-!../images/test.jpg!
-</pre>
-
-## Installation
-
-The best way to install Gimli is with RubyGems:
-
-    $ [sudo] gem install gimli
-
-You can install from source:
-
-```
-$ cd gimli/
-$ bundle
-$ rake install
-```
-
-## Running
-
-The standard way to run gimli is to go to a folder with markup files and running
-
-    $ gimli
-
-To apply some style to the pdf or override the standard style add a css file in the directory named `gimli.css` or use the `-s` flag to point out another css file.
-
-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.
-
-To pass parameters directly to wkhtmltopdf, use the `-w` flag. eg.
-
-    $ gimli -f test.md -w '--toc --footer-right "[page]/[toPage]"'
-
-This gives a pdf with a table of contents and page numbers in the footer.
-
-See the [man page](http://wkhtmltopdf.org/usage/wkhtmltopdf.txt) for wkhtmltopdf for all possible parameters.
-
-Run `gimli -h` for a full list of options available
-
-### Gimli Docker Container
-
-There is a Docker container to use for converting files using gimli without installing gimli to your computer, you can see more about it at https://registry.hub.docker.com/u/walle/gimli/
-
-#### Running the image
-
-    $ docker run -v <host_dir>:<container_dir> walle/gimli -f <container_dir>/my-file.md -o <container_dir>
-
-Where `<host_dir>` is the directory with the files you want to convert and `<container_dir>` is the directory in the image where the files will be put. This will write the pdf files to the same directory as where your source files is. If you want to make a new directory for the pdfs you can call the image like this:
-
-    $ docker run -v <host_dir>:<container_dir> walle/gimli -f <container_dir>/my-file.md -o <container_dir>/pdfs
-
-This will put the pdfs in a folder named pdfs in your `<host_dir>`.
-
-##### A real example
-
-    $ docker run -v /home/walle/gimlidocuments:/tmp/gimli walle/gimli -f /tmp/gimli/my-file.md -o /tmp/gimli
-
-This will generate a pdf from the file in `/home/walle/gimlidocuments/my-file.md` in the `/home/walle/gimlidocuments` directory.
-
-##### Arguments
-
-All arguments you supply to running the image will end up in gimli, so for an example you could supply the `-s` flag to use a custom stylesheet. But the stylesheet must be in `<host_dir>` to be readable by gimli.
-
-## Syntax highlighting
-
-In page files you can get automatic syntax highlighting for a wide range of languages by using the following syntax:
-
-    ```ruby
-      def foo
-        puts 'bar'
-      end
-    ```
-
-The block must start with three backticks (as the first characters on the line). After that comes the name of the language that is contained by the block. The language must be one of the short name lexer strings supported by coderay. See the list of lexers for valid options.
-
-If the block contents are indented two spaces or one tab, then that whitespace will be ignored (this makes the blocks easier to read in plaintext).
-
-The block must end with three backticks as the first characters on a line.
-
-The syntax highlightning is powered by [coderay](https://github.com/rubychan/coderay) and is using a [github theme](https://github.com/pie4dan/CodeRay-GitHub-Theme).