docify 1.0.0

data/README.rdoc

@@ -0,0 +1,48 @@
+= Docify
+
+This gem allows you to render your documentation files (Rdoc/Markup/Textile) into nice-looking html files.
+
+Produced result looks similar to GitHub's README and other doc files.
+
+== Dependencies
+
+* github/markup
+* rdiscount
+* RedCloth
+
+== Installation
+
+  gem install docify
+  
+== Usage
+  
+  Usage: docify [options] FILE
+    -l, --list                       List of all formats
+    -f, --format FORMAT              Render as format
+        --no-css                     Disable css styling
+    -o, --output=PATH                Output file path
+    -h, --help                       Show this information
+  
+By default docify will write result to terminal:
+
+  docify YOUR_FILE.rdoc
+  
+  >> ...... rendered content
+  
+To save results just pass --output with filename
+
+  docify YOUR_FILE.rdoc --output ~/Desktop/file.html
+  
+Or use regular piping:
+
+  docify YOUR_FILE.rdoc > ~/Desktop/file.html
+  
+Format will be automatically detected from filename. But if you need to force your format just type:
+
+  docify YOUR_FILE.rdoc --format textile
+  
+Default format: Rdoc
+  
+== Authors
+
+* Dan Sosedoff - http://github.com/sosedoff

data/Rakefile

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+end

data/bin/docify

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'rubygems'
+require 'optparse'
+require 'docify'
+
+# ------------------------------------------------------------------------------
+# Default options
+# ------------------------------------------------------------------------------
+
+options = {
+  :format  => nil,   # Render format
+  :output  => nil,   # Output filename
+  :use_css => true   # Embedded CSS support
+}
+
+# ------------------------------------------------------------------------------
+# Setup OptParser
+# ------------------------------------------------------------------------------
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: docify [options] FILE"
+  opts.on('-l', '--list', 'List of all formats') do
+    puts "Formats:"
+    Docify::FORMATS.each { |f| puts "- #{f}" }
+    exit
+  end
+  opts.on('-f', '--format FORMAT', 'Render as format') do |f|
+    unless Docify.valid_format?(f)
+      puts "Invalid format!" ; exit
+    end
+    options[:format] = f
+  end
+  opts.on('--no-css', 'Disable css styling') { options[:use_css] = false }
+  opts.on('-o', '--output=PATH', 'Output file path') do |path|
+    options[:output] = path
+  end
+  opts.on('-h', '--help', "Show this information") { puts opts.to_s ; exit }
+end
+
+# ------------------------------------------------------------------------------
+# Execute
+# ------------------------------------------------------------------------------
+
+begin
+  optparse.parse!
+  file = ARGV.shift.to_s.strip
+  unless file.empty?
+    begin
+      options[:format] = Docify.detect_format(file)
+      doc = Docify::Document.new(file)
+      doc.render(options[:format], options[:use_css])
+      if options[:output].nil?
+        puts doc.content
+      else
+        doc.save_to(options[:output])
+      end
+    rescue ArgumentError => e
+      puts "Error: #{e.message}"
+      exit
+    end
+  else
+    puts optparse.to_s
+    exit
+  end
+end

data/lib/docify.rb

@@ -0,0 +1,6 @@
+require 'github/markup'
+
+require 'docify/version'
+require 'docify/format'
+require 'docify/style'
+require 'docify/document'

data/lib/docify/document.rb

@@ -0,0 +1,48 @@
+module Docify 
+  class Document
+    attr_reader :path
+    attr_reader :content
+    
+    # Initialize a new Document object with file path
+    def initialize(path)
+      raise ArgumentError, "File [#{path}] does not exist!" unless File.exists?(path)
+      raise ArgumentError, "File required!" unless File.file?(path)
+      @path = path
+      @content = ""
+    end
+    
+    # Render document by specified format
+    def render(format, embed_css=true)
+      raise ArgumentError, 'Invalid format!' unless FORMATS.include?(format)
+      result = GitHub::Markup.render("doc.#{format}", File.read(@path))
+      if embed_css
+        params = {:title => File.basename(@path), :content => result}
+        params[:css] = Docify::CSS if embed_css
+        @content = template(params)
+      else
+        @content = result
+      end
+      @content
+    end
+    
+    # Save rendered content into file
+    def save_to(path)
+      unless File.exists?(File.dirname(path))
+        raise ArgumentError, "Output path does not exist!"
+      end
+      if File.directory?(path)
+        raise ArgumentError, "Output path should be a file!"
+      end
+      File.open(path, 'w') { |f| f.write(@content) }
+    end
+    
+    private
+    
+    # Render template with provided data
+    def template(params={})
+      TEMPLATE.gsub(REGEX) do |m|
+        m = params[m.scan(REGEX).flatten.last.to_sym]
+      end
+    end
+  end
+end

data/lib/docify/format.rb

@@ -0,0 +1,23 @@
+module Docify
+  # All supported formats
+  FORMATS = ['rdoc', 'markdown', 'textile']
+  
+  # Aliases for file extensions
+  ALIASES = {
+    '.rdoc'     => 'rdoc',
+    '.textile'  => 'textile',
+    '.markdown' => 'markdown',
+    '.md'       => 'markdown'
+  }
+  
+  # Returns true if provided format is supported
+  def self.valid_format?(f)
+    FORMATS.include?(f)
+  end
+  
+  # Automatically detect format from extension
+  def self.detect_format(file)
+    ext = File.extname(file).downcase
+    ALIASES.key?(ext) ? ALIASES[ext] : FORMATS.first
+  end
+end

data/lib/docify/style.rb

@@ -0,0 +1,40 @@
+module Docify
+REGEX = /(\{\{([a-z\-\_]{1,})\}\})/i
+  
+  TEMPLATE = <<END_TEMPLATE
+<html>
+  <head>
+    <title>{{title}}</title>
+    {{css}}
+  </head>
+  <body>
+    <div id="content">{{content}}</div>
+    <!-- Generated with Docify -->
+  </body>
+</html>
+END_TEMPLATE
+  
+  CSS = <<END_CSS
+<style>
+  body {
+    background: #fff;
+    font: 13.34px helvetica,arial,freesans,clean,sans-serif;
+  }
+  #content { width: 80%; margin: 0px auto; }
+  pre {
+    margin: 1em 0;
+    font-size: 12px;
+    background-color: #eee;
+    border: 1px solid #ddd;
+    padding: 5px;
+    line-height: 1.5em;
+    color: #444;
+    overflow: auto;
+    -webkit-box-shadow:rgba(0,0,0,0.07) 0 1px 2px inset;
+    -webkit-border-radius:3px;
+    -moz-border-radius:3px;
+    border-radius:3px;
+  }
+</style>
+END_CSS
+end

data/lib/docify/version.rb

@@ -0,0 +1,3 @@
+module Docify
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: docify
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 -05:00
+default_executable: docify
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: github-markup
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 6
+        - 8
+        version: 1.6.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 4
+        - 2
+        - 3
+        version: 4.2.3
+  type: :runtime
+  version_requirements: *id003
+description: Docify provides a command line tool to render documentation files (RDoc, Markdown, Textile) into nice-looking html.
+email: dan.sosedoff@gmail.com
+executables: 
+- docify
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- bin/docify
+- lib/docify/document.rb
+- lib/docify/format.rb
+- lib/docify/style.rb
+- lib/docify/version.rb
+- lib/docify.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/sosedoff/docify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Docify - Render documentation with favorite markup into html.
+test_files: []
+