RubyGems - docify - Versions diffs - 1.0.2 → 1.0.3 - Mend

docify 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/bin/docify CHANGED Viewed

@@ -3,7 +3,7 @@
 lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
-require 'rubygems'
+require 'bundler/setup'
 require 'optparse'
 require 'docify'

data/docify.gemspec CHANGED Viewed

@@ -17,14 +17,11 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rdiscount', '~> 1.6.8'
   s.add_runtime_dependency 'RedCloth', '~> 4.2.3'
-  s.add_runtime_dependency 'rdoc', '~> 3.5'
+  s.add_runtime_dependency 'rdoc', '~> 3.7'
   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 CHANGED Viewed

@@ -1,9 +1,6 @@
+require 'docify/utils'
 require 'docify/format'
+require 'docify/template'
 require 'docify/style'
 require 'docify/markup'
 require 'docify/document'
-module Docify
-  def self.render(filename, format='md')
-  end
-end

data/lib/docify/document.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-module Docify
+module Docify
   class Document
     attr_reader :path
     attr_reader :content
@@ -18,7 +18,7 @@ module Docify
       if embed_css
         params = {:title => File.basename(@path), :content => result}
         params[:css] = Docify::CSS if embed_css
-        @content = template(params)
+        @content = Docify::Template.new(Docify::TEMPLATE).render(params)
       else
         @content = result
       end
@@ -35,14 +35,5 @@ module Docify
       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/style.rb CHANGED Viewed

@@ -1,7 +1,6 @@
 module Docify
-  REGEX = /(\{\{([a-z\-\_]{1,})\}\})/i
   TEMPLATE = <<END_TEMPLATE
+<!DOCTYPE html>
 <html>
   <head>
     <title>{{title}}</title>
@@ -10,7 +9,6 @@ module Docify
   </head>
   <body>
     <div id="content">{{content}}</div>
-    <!-- Generated with Docify -->
   </body>
 </html>
 END_TEMPLATE
@@ -18,10 +16,48 @@ END_TEMPLATE
   CSS = <<END_CSS
 <style>
   body {
-    background: #fff;
+    background: #f8f8f8;
     font: 13.34px helvetica,arial,freesans,clean,sans-serif;
   }
-  #content { width: 80%; margin: 0px auto; }
+  body * { line-height: 1.4em; }
+  a { color: #4183C4; text-decoration: none; }
+  a:hover { text-decoration: underline; }
+  #content {
+    width: 800px; margin: 0px auto;
+  }
+  p {
+    margin: 1em 0!important;
+    line-height: 1.5em!important;
+  }
+  h1, h2, h3, h4, h5, h6 { border: 0 !important; }
+  h1 {
+    font-size: 170%!important;
+    border-top: 4px solid #AAA!important;
+    padding-top: .5em!important;
+    margin-top: 1.5em!important;
+  }
+  h1:first-child { border-top: none !important; }
+  h2 {
+    font-size: 150% !important;
+    margin-top: 1.5em !important;
+    border-top: 4px solid #E0E0E0 !important;
+    padding-top: .5em !important;
+  }
+  h3 { margin-top: 1em !important; }
+  pre, code {
+    font: 12px 'Bitstream Vera Sans Mono','Courier',monospace;
+  }
   pre {
     margin: 1em 0;
     font-size: 12px;
@@ -31,10 +67,25 @@ END_TEMPLATE
     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;
+    -webkit-box-shadow: rgba(0,0,0,0.07) 0 1px 2px inset;
+    -webkit-border-radius: 3px;
+    -moz-border-radius: 3px;
+    border-radius: 3px;
+  }
+  code {
+    font-size: 12px !important;
+    background-color: ghostWhite !important;
+    color: #444 !important;
+    padding: 0 .2em !important;
+    border: 1px solid #DEDEDE !important;
+  }
+  pre code {
+    padding: 0!important;
+    font-size: 12px!important;
+    background-color: #EEE!important;
+    border: none!important;
   }
 </style>
 END_CSS

data/lib/docify/template.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Docify
+  class Template
+    REGEX = /(\{\{([a-z\-\_]{1,})\}\})/i
+    # Initialize Template object with a string template
+    def initialize(content)
+      @template = content.strip.to_s
+      raise ArgumentError, "Template content required!" if @template.empty?
+    end
+    # Render template
+    #   params - Hash of parameters.
+    #            Each params in template should be wrapped with {{var}}.
+    def render(params={})
+      params.stringify_keys!
+      @template.gsub(REGEX) do |m|
+        key = m.scan(REGEX).flatten.last.to_s
+        m = params[key]
+      end
+    end
+  end
+end

data/lib/docify/utils.rb ADDED Viewed

@@ -0,0 +1,14 @@
+class Hash
+  unless method_defined?(:stringify_keys)
+    def stringify_keys!
+      keys.each do |key|
+        self[key.to_s] = delete(key)
+      end
+      self
+    end
+    def stringify_keys
+      dup.stringify_keys!
+    end
+  end
+end

data/lib/docify/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Docify
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

data/spec/document_spec.rb CHANGED Viewed

@@ -1,22 +1,27 @@
 require 'spec_helper'
 describe 'Document' do
-  it 'should raise exception on invalid input file' do
+  it 'should raise an 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
+  it 'should render content with styles' do
+    doc = Docify::Document.new(fixture_path('README.markdown'))
+    output = doc.render('markdown')
+    output.should match(/<meta http-equiv="Content-Type" content="text\/html; charset=UTF-8" \/>/)
+    output.should match(/<title>README.markdown<\/title>/)
+  end
+  it 'should render content with no styles' do
+    doc = Docify::Document.new(fixture_path('README.markdown')).render('markdown', false)
+    doc.should == Docify::Markup.markdown(fixture('README.markdown'))
+  end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -17,10 +17,12 @@ README_FILES  = {
   'README.foo'      => 'rdoc'
 }
-def fixture_path
-  File.expand_path("../fixtures", __FILE__)
+def fixture_path(file=nil)
+  path = File.expand_path("../fixtures", __FILE__)
+  path = File.join(path, file) unless file.nil?
+  path
 end
 def fixture(file)
   File.read(File.join(fixture_path, file))
-end
+end

data/spec/template_spec.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'spec_helper'
+describe 'Template' do
+  it 'should raise ArgumentError if no template were provided' do
+    proc { Docify::Template.new }.should raise_error ArgumentError
+    proc { Docify::Template.new(" ") }.should raise_error ArgumentError
+  end
+  it 'should render a valid content' do
+    Docify::Template.new("{{a}}{{b}}").render(:a => 'a', :b => 'b').should == 'ab'
+    Docify::Template.new("{{a}}{{b}}").render('a' => 'a', 'b' => 'b').should == 'ab'
+  end
+end

metadata CHANGED Viewed

@@ -2,7 +2,7 @@
 name: docify
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Dan Sosedoff
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-06-23 00:00:00 -05:00
+date: 2011-06-28 00:00:00 -05:00
 default_executable: docify
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -98,7 +98,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: "3.5"
+        version: "3.7"
   type: :runtime
   version_requirements: *id008
 description: Docify provides a command line tool to render documentation files (RDoc, Markdown, Textile) into nice-looking html.
@@ -123,6 +123,8 @@ files:
 - lib/docify/format.rb
 - lib/docify/markup.rb
 - lib/docify/style.rb
+- lib/docify/template.rb
+- lib/docify/utils.rb
 - lib/docify/version.rb
 - spec/docify_spec.rb
 - spec/document_spec.rb
@@ -134,6 +136,7 @@ files:
 - spec/fixtures/README.textile.html
 - spec/markup_spec.rb
 - spec/spec_helper.rb
+- spec/template_spec.rb
 has_rdoc: true
 homepage: http://github.com/sosedoff/docify
 licenses: []
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: "0"
 requirements: []
 rubyforge_project:
@@ -173,3 +176,4 @@ test_files:
 - spec/fixtures/README.textile.html
 - spec/markup_spec.rb
 - spec/spec_helper.rb
+- spec/template_spec.rb