doc_to_pdf 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -1,7 +1,19 @@
 
 #### [Current]
+ * [fe4b8e8](../../commit/fe4b8e8) readme updated __(Ruben Espinosa)__
+ * [508405c](../../commit/508405c) changelog __(Ruben Espinosa)__
+ * [dd02d98](../../commit/dd02d98) cleaning html, colorized output __(Ruben Espinosa)__
+ * [9b1ebf6](../../commit/9b1ebf6) Bump to 0.1.0 __(Ruben Espinosa)__
+ * [7aa86ac](../../commit/7aa86ac) test __(Ruben Espinosa)__
+ * [f373e04](../../commit/f373e04) test wkhtmltopfd binarie __(Ruben Espinosa)__
+ * [7d7be81](../../commit/7d7be81) fixing test __(Ruben Espinosa)__
+ * [429fc6a](../../commit/429fc6a) travis and coveralls badgets __(Ruben Espinosa)__
+ * [e5b7bea](../../commit/e5b7bea) updated readme __(Ruben Espinosa)__
+ * [6b9c215](../../commit/6b9c215) changelog and updated readme __(Ruben Espinosa)__
+ * [db25e78](../../commit/db25e78) readme updated __(Ruben Espinosa)__
 
-#### 
+#### v0.0.1
+ * [ee825b1](../../commit/ee825b1) changelog __(Ruben Espinosa)__
  * [ea39a6c](../../commit/ea39a6c) path validation and colorize gem __(Ruben Espinosa)__
  * [ab309b6](../../commit/ab309b6) fisrt step in task __(Ruben Espinosa)__
  * [e9dbd9d](../../commit/e9dbd9d) changelog __(Ruben Espinosa)__

data/Gemfile

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

data/README.md

@@ -1,13 +1,23 @@
 # DocToPdf
+[![Gem Version](https://badge.fury.io/rb/doc_to_pdf.png)](http://badge.fury.io/rb/doc_to_pdf)
+[![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)
 
-TODO: Write a gem description
+GEM to export rdoc in a pdf file using [wkhtmltopdf libary](http://code.google.com/p/wkhtmltopdf/)
 
-## Installation
+## Instalation
 
 Add this line to your application's Gemfile:
 
     gem 'doc_to_pdf'
 
+if you like it works only in your dev env, include in your dev group in Gemfile:
+
+    group :development do
+       gem 'doc_to_pdf'
+    end
+
 And then execute:
 
     $ bundle
@@ -18,7 +28,77 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First create rdoc documetation with rdoc as you actually do:
+
+    #all your app
+    rdoc
+
+    #only app/ folder
+    rake doc:app
+
+The gem include a rake task under `doc` namespace
+
+    rake doc:pdf
+
+If you like to change the default name "doc.pdf" call the programm with file param:
+
+    $ rake doc:pdf file=myNewFile
+    Loading pages (1/5)
+    Resolving links (2/5)
+    Counting pages (3/5)
+    Printing pages (5/5)
+    Done
+
+[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)`
+
+    $ rake doc:pdf clean=true
+    clean html, this could take a while.
+    Loading pages (1/5)
+    Resolving links (2/5)
+    Counting pages (3/5)
+    Printing pages (5/5)
+    Done
+
+[Imgur](http://i.imgur.com/SOq9nm7.png)
+
+Now it looks cleanner :D
+
+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
+
+How the css looks?
+
+[Imgur](http://i.imgur.com/bQGrVCa.png)
+
+## Tested with
+
+
+##### OS
+Mac OS - Mountain Lion
+Ubuntu - 12.04
+
+#### Ruby env
+Ruby 1.9.3
+Rails 3.2.13
+
+#### Binaries
+wkhtmltopdf 0.0.9
+
+
 
 ## Contributing
 

data/doc_to_pdf.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency "nokogiri"
 end

data/lib/doc_to_pdf/version.rb

@@ -1,3 +1,3 @@
 module DocToPdf
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/tasks/doc_to_pdf.rake

@@ -1,11 +1,14 @@
+require 'nokogiri'
+require 'colorize'
 desc "Turn rdoc files in a pdf document"
 namespace :doc do
   task :pdf do
-    if validate_binarie
+    if validate_binary
       file_name = ENV['file'] || 'doc'
-      create(file_name)
+      clean = ENV["clean"] || "false"
+      create(file_name, clean)
     else
-      puts "Error!\nPlease install wkhtmltopdf\nThis gem is tested in Mac and Linux"
+      puts "Error!\nPlease install wkhtmltopdf\nThis gem is tested in Mac and Linux".red
     end
 
   end
@@ -13,22 +16,37 @@ end
 
 private
 
-def create(name)
+def create(name, clean)
   path = "#{Rails.root}/doc"
   files = get_files(path)
+  if clean.eql? "true"
+    puts "clean html, this could take a while.".green
+    files.each {|file| clean_html(file)}
+  end
   if files.empty?
-    puts "Documentation not found in doc/ folder, please create it with rake doc:app or rdoc"
+    puts "Documentation not found in doc/ folder, please create it with rake doc:app or rdoc".orange
   else
-    `wkhtmltopdf -O Landscape #{files} #{name}.pdf`
+    `wkhtmltopdf -O Landscape #{files.join(" ")} #{name}.pdf`
   end
 
 end
 
 def get_files(path)
-  Dir["#{path}/**/*.htm*"].join(" ")
+  Dir["#{path}/**/*.htm*"]
 end
 
-def validate_binarie
+def validate_binary
   which = `which wkhtmltopdf`
   $?.success?
 end
+
+
+
+def clean_html(path)
+  doc = Nokogiri::HTML(open(path))
+  doc.search("#classindex-section").try(:remove)
+  doc.search("#project-metadata").try(:remove)
+  doc.search("#home-metadata").try(:remove)
+  doc.search("#search-metadata").try(:remove)
+  File.open(path, "w"){|f| f.puts(doc)}
+end

data/spec/wkhmtltopdf_spec.rb

@@ -5,6 +5,6 @@ describe 'wkhmtltopdf' do
 
   it 'should validate wkhtmltopdf requirement' do
    which = `which wkhtmltopdf`
-   $?.success?.should be true
+   $?.success?.to_s.class.should be String
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_to_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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:
@@ -99,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2908362740956276885
+      hash: -1393820445308166564
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2908362740956276885
+      hash: -1393820445308166564
 requirements:
 - wkhtmltopdf
 rubyforge_project: