docs 0.0.1 → 0.0.2

data/bin/docs

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'docs'
+Docs::Docs.start

data/docs.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |s|
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
   s.add_runtime_dependency "thor", "~> 0.14.6"
+  s.add_runtime_dependency "redcarpet", "~> 2.1.0"
+  s.add_runtime_dependency "coderay", "~> 1.0.5"
 end

data/lib/docs/config.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module Docs
+  class Config
+    def initialize(config_file)
+      @config = YAML.load(File.read(config_file))
+      @environment = ENV['DOCS_ENV'] || 'production'
+
+      begin
+        env = @config.delete('environment')[@environment]
+      rescue NoMethodError 
+        env = {}
+      end
+
+      @config.merge!(env)
+    end
+
+    def method_missing(name, *args, &block)
+      name = name.to_s
+      if @config.has_key?(name)
+        @config[name]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/docs/erb_environment.rb

@@ -0,0 +1,28 @@
+require 'coderay'
+require 'json'
+
+module Docs
+  class ERBEnvironment
+    attr_writer :examples
+    attr_accessor :content
+    attr_accessor :config # <%= config.api_endpoint %> 
+
+    # <%= example :source, "curl/users/getting.sh" %>
+    def example(source_or_output, name)
+      raise ArgumentError, "Must specify :source or :output as first argument" unless [:source, :output].include?(source_or_output) 
+      @examples[source_or_output]["examples/#{name}"]
+    end
+
+    def pretty_print_json(json)
+      JSON.pretty_generate(JSON.parse(json))
+    end
+
+    def syntax_highlight(str, language)
+      CodeRay.scan(str, language).div
+    end
+
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/docs/project.rb

@@ -0,0 +1,94 @@
+require 'fileutils'
+require 'digest/md5'
+
+require 'erb'
+require 'redcarpet'
+
+module Docs
+  class Project
+
+    EXTENSIONS_TO_COMMANDS = {
+      '.sh' => 'bash',
+      '.rb' => 'ruby'
+    }
+
+    def initialize
+      @examples = {:source => {}, :output => {}}
+      @erb_environment = ERBEnvironment.new
+
+      @markdown = markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :autolink => true, :space_after_headers => true)
+      @erb_environment.config = @config = Config.new('config.yaml') if File.exists?('config.yaml')
+    end
+
+    def build
+      create_tmp_directory
+      truncate_or_create_output_directory
+
+      load_examples 
+      build_docs
+      copy_public
+    end
+
+    private
+    def load_examples 
+      examples = Dir.glob('examples/**/*')
+      examples.each do |example_name|
+        next unless File.file?(example_name)
+
+        example_file = example_name
+        if File.fnmatch?('*.erb.*', example_name)
+          File.open(example_file = "tmp/#{Digest::MD5.hexdigest(example_name)}#{File.extname(example_name)}", 'w+') do |f| 
+            f.write(render_erb_string File.read(example_name))
+          end
+        end
+
+        @examples[:source][example_name] = File.read(example_file)
+
+        i = IO.popen("#{EXTENSIONS_TO_COMMANDS[File.extname(example_file)]} #{example_file}")
+        @examples[:output][example_name] = i.read
+      end
+
+      @erb_environment.examples = @examples
+    end
+
+    def build_docs
+      docs = Dir.glob('docs/**/*.mdown')
+      docs.each do |doc|
+        output_name = "output/#{doc.sub('docs/', '')[0...-5]}html"
+
+        erbed = render_erb_string(File.read(doc))
+        rendered = @markdown.render(erbed)
+
+        if @config.template
+          @erb_environment.content = rendered 
+          rendered = render_erb_string File.read(@config.template)
+        end
+
+        File.open(output_name, 'w+') do |f|
+          f.write rendered
+        end
+      end
+    end
+
+    def copy_public
+      Dir.glob('public/**').each do |f|
+        next unless File.file?(f)
+        FileUtils.cp(f, "output/#{f.sub('public/', '')}")
+      end
+    end
+
+    def render_erb_string(str)
+      ERB.new(str).result(@erb_environment.get_binding)
+    end
+
+    def truncate_or_create_output_directory
+      FileUtils.rm_rf('output') if Dir.exists?('output')
+      Dir.mkdir('output')
+    end
+
+    def create_tmp_directory
+      Dir.mkdir('tmp') unless Dir.exists?('tmp')
+    end
+
+  end
+end

data/lib/docs/version.rb

@@ -1,3 +1,3 @@
 module Docs
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/docs.rb

@@ -1,7 +1,21 @@
+require "bundler/setup"
+require "thor"
+
 require "docs/version"
+require "docs/project"
+require "docs/config"
+require "docs/erb_environment"
 
 module Docs
-  class Docs < Thor
-    
+  class Docs < Thor 
+
+    desc "build [DIRECTORY]", "Builds the current directory (or DIRECTORY) as a docs project into './output'"
+    def build(directory = '.')
+      previous_directory = Dir.pwd
+      Dir.chdir(directory)
+      Project.new.build
+      Dir.chdir(previous_directory)
+    end
+       
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000Z
+date: 2012-02-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70315023762520 !ruby/object:Gem::Requirement
+  requirement: &70167636469260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,20 +21,47 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70315023762520
+  version_requirements: *70167636469260
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70167636468760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167636468760
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: &70167636468300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167636468300
 description: Documentation generator with support for including code examples and
   compiling them at compile time
 email:
 - ben@benmcredmond.com
-executables: []
+executables:
+- docs
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
 - Rakefile
+- bin/docs
 - docs.gemspec
 - lib/docs.rb
+- lib/docs/config.rb
+- lib/docs/erb_environment.rb
+- lib/docs/project.rb
 - lib/docs/version.rb
 homepage: ''
 licenses: []