doc_to_pdf 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6952265d27f85e1d07741f051da2e53238ed6f93
-  data.tar.gz: 60a576fb8b452014d52dd12b87297d2cd7fb931d
+  metadata.gz: 6eec2c10af1dfdb89da6ea78f1705f6e8b4b8bbe
+  data.tar.gz: 849fc5ed65b353560fc061632b8f625671ff7ff2
 SHA512:
-  metadata.gz: 7d4fe33ad09b690132372e67a6db864c28fff486ea1c94c1578196e9ed9c974fa8d6c44ffb08d92b854db89f9c00a751eaa5bb87b8df28e6866da821d56faf8b
-  data.tar.gz: b16cbd6c9076a163ea4a791338bc7c7f1742ead96f0885202ea4df907de3fff3728998729b6ca6705eaec8803af981083d6c2986685a3420421f650966990310
+  metadata.gz: 1812e673c80311545c6063241733159c4333c99a62e88985256cf06364aaaf8decbf066b3f61b4c10d5a1f2577a0e705d06fca0a0dadcbe1891942b25f83f5e1
+  data.tar.gz: e72d4bab6395de39d795b626892bb7029803b92bd20b8b98f2d7735bf06b7b8d20cbd6af788171e9c27b024da53223aa30dccce9b48dc9879c9ece391568278a

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 
 #### [Current]
+ * [6b5a763](../../commit/6b5a763) css url __(Ruben Espinosa)__
+ * [02b228e](../../commit/02b228e) readme __(Ruben Espinosa)__
+ * [0272737](../../commit/0272737) changelog __(Ruben Espinosa)__
+ * [483dde9](../../commit/483dde9) Downloading css and help command __(Ruben Espinosa)__
+ * [0caad8b](../../commit/0caad8b) Bump to 0.2.0 __(Ruben Espinosa)__
+ * [e862b4d](../../commit/e862b4d) Merge pull request [#2](../../issues/2) from rderoldan1/nokigiri __(Ruben Espinosa)__
+ * [43828b7](../../commit/43828b7) Update README.md __(Ruben Espinosa)__
+ * [8cb608b](../../commit/8cb608b) changelog __(Ruben Espinosa)__
+ * [c1e3178](../../commit/c1e3178) Update README.md __(Ruben Espinosa)__
+ * [ecb1ce5](../../commit/ecb1ce5) Update README.md __(Ruben Espinosa)__
+ * [1fe1251](../../commit/1fe1251) Update README.md __(Ruben Espinosa)__
+ * [38c6928](../../commit/38c6928) Update README.md __(Ruben Espinosa)__
+ * [15f8234](../../commit/15f8234) Update README.md __(Ruben Espinosa)__
+ * [3e4f1da](../../commit/3e4f1da) Merge pull request [#1](../../issues/1) from rderoldan1/nokigiri __(Ruben Espinosa)__
+
+#### v0.1.3
+ * [f970a4f](../../commit/f970a4f) table of contents support __(Ruben Espinosa)__
+ * [d440443](../../commit/d440443) Bump to 0.1.3 __(Ruben Espinosa)__
+ * [2a6eaca](../../commit/2a6eaca) Bump to 0.1.2 __(Ruben Espinosa)__
+ * [7b6af43](../../commit/7b6af43) changelog __(Ruben Espinosa)__
  * [3408a4c](../../commit/3408a4c) Bump to 0.1.1 __(Ruben Espinosa)__
  * [5b05208](../../commit/5b05208) delete serach and header __(Ruben Espinosa)__
 

data/Gemfile

@@ -6,4 +6,5 @@ gem 'rspec'
 gem 'coveralls', :require => false
 gem 'rails', '3.2.12'
 gem 'colorize'
-gem 'nokogiri'
+gem 'nokogiri'
+gem 'httparty'

data/README.md

@@ -3,6 +3,7 @@
 [![Code Climate](https://codeclimate.com/github/rderoldan1/doc_to_pdf.png)](https://codeclimate.com/github/rderoldan1/doc_to_pdf)
 [![Coverage Status](https://coveralls.io/repos/rderoldan1/doc_to_pdf/badge.png)](https://coveralls.io/r/rderoldan1/doc_to_pdf)
 [![Build Status](https://travis-ci.org/rderoldan1/doc_to_pdf.png?branch=master)](https://travis-ci.org/rderoldan1/doc_to_pdf)
+[![Dependency Status](https://gemnasium.com/rderoldan1/doc_to_pdf.png)](https://gemnasium.com/rderoldan1/doc_to_pdf)
 
 GEM to export rdoc in a pdf file using [wkhtmltopdf libary](http://code.google.com/p/wkhtmltopdf/)
 
@@ -49,12 +50,12 @@ If you like to change the default name "doc.pdf" call the programm with file par
     Printing pages (5/5)
     Done
 
-[Imgur](http://i.imgur.com/w8agvbY.png)
+![Imgur](http://i.imgur.com/w8agvbY.png)
 
 In my case the menu based in the left is more than 4 pages, and the links doesn't work.
 
 
-Also it offer an option to clean the "_innecessary_" html, only pass the param `clean=true (default is false)`
+Also it offer an option to clean the _"innecessary"_ html, only pass the param `clean=true (default is false)`
 
     $ rake doc:pdf clean=true
     clean html, this could take a while.
@@ -63,41 +64,70 @@ Also it offer an option to clean the "_innecessary_" html, only pass the param `
     Counting pages (3/5)
     Printing pages (5/5)
     Done
+    
+_WARNING_: This option change your html files    
+    
 
-[Imgur](http://i.imgur.com/SOq9nm7.png)
+![Imgur](http://i.imgur.com/SOq9nm7.png)
 
 Now it looks cleanner :D
 
+Now the gem will change the css file by the passing css param.
+The css is more prettier in order to cusmotize more like github:
+
+    $ rake doc:pdf clean=true css=true
+    Changing default css created, this could take a while.
+    Creating PDF documentation.
+
+![Imgur](http://i.imgur.com/bQGrVCa.png)
+
+Help command
+
+    $ rake doc:pdf help
+    Usage: rake doc:pdf <options>
+        options:
+          --file=yourName: change default pdf output name
+          --clean=true,false: default is false, this delete "unnecessary" hmtl, like menu and search, please be careful, this option modify doc html files
+          --css=tue,false: default false, this change default css for a prettier one
+          --help, show this message
+
+
 The pdf file is saved in your application root
 
-## Recomendations
 
-* use annotate to comment your models and routes files, [please take a look](https://github.com/ctran/annotate_models)
-* I created a css for prettier in order to cusmotize more like gituh, the file is in (this gist)[https://gist.github.com/rderoldan1/6396578#file-rdoc-css-L1], if
-you like to use it replace the custom css.
- improvements:
- - Code highlight
- - Text formating
- - Fresh colors
+## PDF Layout
 
-How the css looks?
+All the pages include the number of the page, the format is page/total i.e  (12/100)
 
-[Imgur](http://i.imgur.com/bQGrVCa.png)
+Table of content
+![Imgur](http://i.imgur.com/riQ0xqZ.png)
+
+Class Documentation
+![Imgur](http://i.imgur.com/dwU3TBD.png)
+
+## Recomendations
+
+* use annotate to comment your models and routes files, [please take a look](https://github.com/ctran/annotate_models)
 
 ## Tested with
 
 
 ##### OS
-Mac OS - Mountain Lion
-Ubuntu - 12.04
+* Mac OS - Mountain Lion
+
+* Ubuntu - 12.04
 
 #### Ruby env
-Ruby 1.9.3
-Rails 3.2.13
+* Ruby 1.9.3 - 2.0
+
+* Rails 3.2.13
 
 #### Binaries
-wkhtmltopdf 0.0.9
+* wkhtmltopdf 0.0.9
 
+### Requirements GEMS
+* Nokogiri 1.6
+* Colorige
 
 
 ## Contributing

data/doc_to_pdf.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_runtime_dependency "colorize"
   spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "httparty"
 end

data/lib/doc_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module DocToPdf
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/tasks/doc_to_pdf.rake

@@ -1,12 +1,20 @@
 require 'nokogiri'
 require 'colorize'
+require 'httparty'
+
 desc "Turn rdoc files in a pdf document"
 namespace :doc do
   task :pdf do
     if validate_binary
-      file_name = ENV['file'] || 'doc'
-      clean = ENV["clean"] || "false"
-      create(file_name, clean)
+      if ARGV.include?("help")
+        puts help
+        exit
+      else
+        file_name = ENV['file'] || 'doc'
+        clean = ENV["clean"] || "false"
+        css = ENV["css"] || "false"
+        create(file_name, clean, css)
+      end
     else
       puts "Error!\nPlease install wkhtmltopdf\nThis gem is tested in Mac and Linux".red
     end
@@ -16,23 +24,35 @@ end
 
 private
 
-def create(name, clean)
+def create(name, clean, css)
   path = "#{Rails.root}/doc"
-  files = get_files(path)
+  files = get_files(path, "html")
   if clean.eql? "true"
     puts "clean html, this could take a while.".green
     files.each {|file| clean_html(file)}
   end
+  if css.eql? "true"
+    pretty_css
+  end
   if files.empty?
     puts "Documentation not found in doc/ folder, please create it with rake doc:app or rdoc".orange
   else
-    `wkhtmltopdf -t --footer-center [page]/[topage] -O Landscape #{files.join(" ")} #{name}.pdf`
+    puts "Creating PDF documentation.".green
+    `wkhtmltopdf -q -t --footer-center [page]/[topage] -O Landscape #{files.join(" ")} #{name}.pdf`
   end
 
 end
 
-def get_files(path)
-  Dir["#{path}/**/*.htm*"]
+def get_files(path, ext)
+  Dir["#{path}/**/*.#{ext}*"]
+end
+
+def pretty_css
+  puts "Changing default css created, this could take a while.".green
+  path = "#{Rails.root}/doc"
+  css = HTTParty.get("https://gist.github.com/rderoldan1/6396578/raw/rdoc.css").body
+  css_file = get_files(path, "css")
+  File.open(css_file.first, 'w'){|f| f.write(css)}
 end
 
 def validate_binary
@@ -52,3 +72,15 @@ def clean_html(path)
 
   File.open(path, "w"){|f| f.puts(doc)}
 end
+
+def help
+  puts <<-EOF
+Usage: rake doc:pdf <options>
+    options:
+      --file=yourName: change default pdf output name
+      --clean=true,false: default is false, this delete "unnecessary" hmtl, like menu and search, please be careful, this option modify doc html files
+      --css=tue,false: default false, this change default css for a prettier one
+      --help, show this message
+  EOF
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doc_to_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ruben Espinosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Turn documentation stored in doc folder in your rails app in a pdf file
   using wkhtmltopdf
 email: