doc_to_pdf 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --format documentation
data/CHANGELOG.md ADDED
@@ -0,0 +1,8 @@
1
+
2
+ #### [Current]
3
+
4
+ ####
5
+ * [ea39a6c](../../commit/ea39a6c) path validation and colorize gem __(Ruben Espinosa)__
6
+ * [ab309b6](../../commit/ab309b6) fisrt step in task __(Ruben Espinosa)__
7
+ * [e9dbd9d](../../commit/e9dbd9d) changelog __(Ruben Espinosa)__
8
+ * [2244a70](../../commit/2244a70) railtie __(Ruben Espinosa)__
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in doc_to_pdf.gemspec
4
+ gemspec
5
+ gem 'rspec'
6
+ gem 'coveralls', :require => false
7
+ gem 'rails', '3.2.12'
8
+ gem 'colorize'
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Ruben Espinosa
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,29 @@
1
+ # DocToPdf
2
+
3
+ TODO: Write a gem description
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'doc_to_pdf'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install doc_to_pdf
18
+
19
+ ## Usage
20
+
21
+ TODO: Write usage instructions here
22
+
23
+ ## Contributing
24
+
25
+ 1. Fork it
26
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
27
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
28
+ 4. Push to the branch (`git push origin my-new-feature`)
29
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+ RSpec::Core::RakeTask.new
4
+
5
+ task :default => :spec
6
+ task :test => :spec
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'doc_to_pdf/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "doc_to_pdf"
8
+ spec.version = DocToPdf::VERSION
9
+ spec.authors = ["Ruben Espinosa"]
10
+ spec.email = ["rderoldan1@gmail.com"]
11
+ spec.description = %q{Turn documentation stored in doc folder in your rails app in a pdf file using wkhtmltopdf}
12
+ spec.summary = %q{Turn documentation in pdf file}
13
+ spec.homepage = ""
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.requirements << 'wkhtmltopdf'
22
+ spec.add_development_dependency "bundler", "~> 1.3"
23
+ spec.add_development_dependency "rake"
24
+ spec.add_runtime_dependency "colorize"
25
+ end
@@ -0,0 +1,12 @@
1
+ require 'doc_to_pdf'
2
+ require 'rails'
3
+
4
+ module DocToPdf
5
+ class Railtie < Rails::Railtie
6
+ railtie_name :doc_to_pdf
7
+
8
+ rake_tasks do
9
+ load "tasks/doc_to_pdf.rake"
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ module DocToPdf
2
+ VERSION = "0.0.1"
3
+ end
data/lib/doc_to_pdf.rb ADDED
@@ -0,0 +1,5 @@
1
+ require "doc_to_pdf/version"
2
+
3
+ module DocToPdf
4
+ require 'doc_to_pdf/railtie' if defined?(Rails)
5
+ end
@@ -0,0 +1,34 @@
1
+ desc "Turn rdoc files in a pdf document"
2
+ namespace :doc do
3
+ task :pdf do
4
+ if validate_binarie
5
+ file_name = ENV['file'] || 'doc'
6
+ create(file_name)
7
+ else
8
+ puts "Error!\nPlease install wkhtmltopdf\nThis gem is tested in Mac and Linux"
9
+ end
10
+
11
+ end
12
+ end
13
+
14
+ private
15
+
16
+ def create(name)
17
+ path = "#{Rails.root}/doc"
18
+ files = get_files(path)
19
+ if files.empty?
20
+ puts "Documentation not found in doc/ folder, please create it with rake doc:app or rdoc"
21
+ else
22
+ `wkhtmltopdf -O Landscape #{files} #{name}.pdf`
23
+ end
24
+
25
+ end
26
+
27
+ def get_files(path)
28
+ Dir["#{path}/**/*.htm*"].join(" ")
29
+ end
30
+
31
+ def validate_binarie
32
+ which = `which wkhtmltopdf`
33
+ $?.success?
34
+ end
@@ -0,0 +1,8 @@
1
+ require 'rspec'
2
+ require 'spec_helper'
3
+
4
+ describe 'rails_included' do
5
+ it 'should validate if is included in rails' do
6
+ Rails.class.should be Module
7
+ end
8
+ end
@@ -0,0 +1,13 @@
1
+ require 'rubygems'
2
+ require 'bundler/setup'
3
+ require 'coveralls'
4
+
5
+ Coveralls.wear! 'rails'
6
+ require 'rails'
7
+
8
+ require File.expand_path('../../lib/doc_to_pdf', __FILE__)
9
+
10
+
11
+
12
+ RSpec.configure do |config|
13
+ end
data/spec/task_spec.rb ADDED
@@ -0,0 +1,10 @@
1
+ require 'rspec'
2
+ require 'spec_helper'
3
+
4
+ describe 'task ' do
5
+
6
+ it 'should convert pdf' do
7
+ require 'rake'
8
+ expect {Rake::Task["doc:pdf"].invoke}.to raise_error
9
+ end
10
+ end
@@ -0,0 +1,9 @@
1
+ require 'rspec'
2
+ require 'spec_helper'
3
+
4
+ describe 'VersionTest' do
5
+
6
+ it 'should be the version number' do
7
+ DocToPdf::VERSION
8
+ end
9
+ end
@@ -0,0 +1,10 @@
1
+ require 'rspec'
2
+ require 'spec_helper'
3
+
4
+ describe 'wkhmtltopdf' do
5
+
6
+ it 'should validate wkhtmltopdf requirement' do
7
+ which = `which wkhtmltopdf`
8
+ $?.success?.should be true
9
+ end
10
+ end
metadata ADDED
@@ -0,0 +1,124 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: doc_to_pdf
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Ruben Espinosa
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-08-30 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: bundler
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: '1.3'
22
+ type: :development
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: '1.3'
30
+ - !ruby/object:Gem::Dependency
31
+ name: rake
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: '0'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ - !ruby/object:Gem::Dependency
47
+ name: colorize
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ! '>='
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :runtime
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ! '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ description: Turn documentation stored in doc folder in your rails app in a pdf file
63
+ using wkhtmltopdf
64
+ email:
65
+ - rderoldan1@gmail.com
66
+ executables: []
67
+ extensions: []
68
+ extra_rdoc_files: []
69
+ files:
70
+ - .gitignore
71
+ - .rspec
72
+ - CHANGELOG.md
73
+ - Gemfile
74
+ - LICENSE.txt
75
+ - README.md
76
+ - Rakefile
77
+ - doc_to_pdf.gemspec
78
+ - lib/doc_to_pdf.rb
79
+ - lib/doc_to_pdf/railtie.rb
80
+ - lib/doc_to_pdf/version.rb
81
+ - lib/tasks/doc_to_pdf.rake
82
+ - spec/rails_spec.rb
83
+ - spec/spec_helper.rb
84
+ - spec/task_spec.rb
85
+ - spec/version_spec.rb
86
+ - spec/wkhmtltopdf_spec.rb
87
+ homepage: ''
88
+ licenses:
89
+ - MIT
90
+ post_install_message:
91
+ rdoc_options: []
92
+ require_paths:
93
+ - lib
94
+ required_ruby_version: !ruby/object:Gem::Requirement
95
+ none: false
96
+ requirements:
97
+ - - ! '>='
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ segments:
101
+ - 0
102
+ hash: 2908362740956276885
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ none: false
105
+ requirements:
106
+ - - ! '>='
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ segments:
110
+ - 0
111
+ hash: 2908362740956276885
112
+ requirements:
113
+ - wkhtmltopdf
114
+ rubyforge_project:
115
+ rubygems_version: 1.8.25
116
+ signing_key:
117
+ specification_version: 3
118
+ summary: Turn documentation in pdf file
119
+ test_files:
120
+ - spec/rails_spec.rb
121
+ - spec/spec_helper.rb
122
+ - spec/task_spec.rb
123
+ - spec/version_spec.rb
124
+ - spec/wkhmtltopdf_spec.rb