docify 1.0.0 → 1.0.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/bin/docify

@@ -66,4 +66,7 @@ begin
     puts optparse.to_s
     exit
   end
+rescue
+  puts optparse.to_s
+  exit
 end

data/docify.gemspec

@@ -0,0 +1,29 @@
+require File.expand_path('../lib/docify/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "docify"
+  s.version     = Docify::VERSION.dup
+  s.summary     = "Terminal tool to render markups into html"
+  s.description = "Docify provides a command line tool to render documentation files (RDoc, Markdown, Textile) into nice-looking html."
+  s.homepage    = "http://github.com/sosedoff/docify"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+  
+  s.add_development_dependency 'rake', '~> 0.8'
+  s.add_development_dependency 'rspec', '~> 2.5'
+  s.add_development_dependency 'ZenTest', '~> 4.5'
+  s.add_development_dependency 'simplecov', '~> 0.4'
+  s.add_development_dependency 'yard', '~> 0.6'
+  
+  s.add_runtime_dependency 'rdiscount', '~> 1.6.8'
+  s.add_runtime_dependency 'RedCloth', '~> 4.2.3'
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths = ["lib"]
+  s.default_executable = 'docify'
+  
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+end

data/lib/docify.rb

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

data/lib/docify/document.rb

@@ -14,7 +14,7 @@ module Docify
     # 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))
+      result = Docify::Markup.render("doc.#{format}", File.read(@path))
       if embed_css
         params = {:title => File.basename(@path), :content => result}
         params[:css] = Docify::CSS if embed_css

data/lib/docify/markup.rb

@@ -0,0 +1,62 @@
+if RUBY_VERSION.include?('1.9')
+  require 'rdoc/markup/to_html'
+else
+  require 'rdoc/generators/html_generator'
+  require 'ostruct'
+end
+
+module Docify
+  module Markup
+    extend self
+  
+    # Auto-detect format from filename and render content
+    def render(filename, content)
+      name = File.basename(filename.to_s.strip)
+      raise ArgumentError, 'Filename required!' if name.empty?
+      format = detect_format(name)
+      format == :text ? content : self.send(format, content)
+    end
+    
+    # Render content for Markdown
+    def markdown(content)
+      Markdown.new(content).to_html
+    end
+    
+    if RUBY_VERSION.include?('1.9')
+      # Render content for RDoc
+      def rdoc(content)
+        RDoc::Markup::ToHtml.new.convert(content)
+      end
+    else
+      # Render content for RDoc
+      def rdoc(content)
+        simple_markup = SM::SimpleMarkup.new
+        generator = Generators::HyperlinkHtml.new('', OpenStruct.new)
+        simple_markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK)
+        simple_markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\.\S+?\])/, :TIDYLINK)
+        simple_markup.convert(content, generator)     
+      end
+    end
+    
+    # Render content for Textile
+    def textile(content)
+      RedCloth.new(content).to_html
+    end
+  
+    protected
+    
+    # Detect markup format from filename
+    def detect_format(filename)
+      case(filename)
+        when /\.rdoc/i
+          :rdoc
+        when /\.(md|mkdn?|mdown|markdown)/i
+          :markdown
+        when /\.textile/i
+          :textile
+        else
+          :text
+      end
+    end
+  end
+end

data/lib/docify/style.rb

@@ -1,10 +1,11 @@
 module Docify
-REGEX = /(\{\{([a-z\-\_]{1,})\}\})/i
+  REGEX = /(\{\{([a-z\-\_]{1,})\}\})/i
   
   TEMPLATE = <<END_TEMPLATE
 <html>
   <head>
     <title>{{title}}</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 
     {{css}}
   </head>
   <body>

data/lib/docify/version.rb

@@ -1,3 +1,3 @@
 module Docify
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'.freeze
 end

data/spec/docify_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe 'Docify' do
+  it 'should validate format' do
+    Docify::FORMATS.each { |f| Docify.valid_format?(f).should == true }
+    Docify.valid_format?('txt').should == false
+  end
+  
+  it 'should detect valid format' do
+    README_FILES.each do |k,v|
+      Docify.detect_format(k).should == v
+    end
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'Document' do
+  it 'should raise exception on invalid input file' do
+    proc { Docify::Document.new('qwe123')}.should raise_error ArgumentError, "File [qwe123] does not exist!"
+    proc { Docify::Document.new('/tmp') }.should raise_error ArgumentError, "File required!"
+  end
+  
+  it 'should render correct layout' do
+    doc = Docify::Document.new('README.rdoc')
+    output = doc.render('rdoc')
+    output.should match(/<meta http-equiv="Content-Type" content="text\/html; charset=UTF-8" \/>/)
+    output.should match(/<title>README.rdoc<\/title>/)
+  end
+  
+  it 'should raise an exception on invalid output path' do
+    doc = Docify::Document.new('README.rdoc')
+    doc.render('rdoc')
+    proc { doc.save_to('~/blah') }.should raise_error ArgumentError, "Output path does not exist!"
+    proc { doc.save_to('/tmp') }.should raise_error ArgumentError, "Output path should be a file!"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Docify', 'lib/docify'
+end
+
+require 'docify'
+
+README_FILES  = {
+  'README'          => 'rdoc',
+  'README.rdoc'     => 'rdoc',
+  'README.md'       => 'markdown',
+  'README.markdown' => 'markdown',
+  'README.textile'  => 'textile',
+  'README.txt'      => 'rdoc',
+  'README.foo'      => 'rdoc'
+}

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: docify
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -15,59 +10,89 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 -05:00
+date: 2011-06-13 00:00:00 -05:00
 default_executable: docify
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: github-markup
+  name: rake
   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: "0.8"
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rdiscount
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.5"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "4.5"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id006 !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
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: RedCloth
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id007 !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
+  version_requirements: *id007
 description: Docify provides a command line tool to render documentation files (RDoc, Markdown, Textile) into nice-looking html.
-email: dan.sosedoff@gmail.com
+email: 
+- dan.sosedoff@gmail.com
 executables: 
 - docify
 extensions: []
@@ -75,14 +100,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
 - Rakefile
 - bin/docify
+- docify.gemspec
+- lib/docify.rb
 - lib/docify/document.rb
 - lib/docify/format.rb
+- lib/docify/markup.rb
 - lib/docify/style.rb
 - lib/docify/version.rb
-- lib/docify.rb
-- README.rdoc
+- spec/docify_spec.rb
+- spec/document_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/sosedoff/docify
 licenses: []
@@ -97,25 +130,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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"
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Docify - Render documentation with favorite markup into html.
-test_files: []
-
+summary: Terminal tool to render markups into html
+test_files: 
+- spec/docify_spec.rb
+- spec/document_spec.rb
+- spec/spec_helper.rb