dionysus 0.3.2 → 0.4.0

data/.gitignore

@@ -14,9 +14,9 @@ tmtags
 *.swp
 
 ## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-.bundle
+/coverage
+/docs
+/pkg
+/.bundle
 
 ## PROJECT::SPECIFIC

data/Gemfile

@@ -1,3 +1,5 @@
+source :gemcutter
+
 gem 'bundler',        '~> 0.9.21'
 gem 'activesupport',  '~> 3.0.0.beta'
 
@@ -6,4 +8,6 @@ group :development do
   gem 'jeweler',  '~> 1.4.0'
   gem 'rake',     '~> 0.8.7'
   gem 'rcov',     '~> 0.8.1'
+  gem 'sdoc',     '~> 0.2.17'
+  gem 'rdiscount', '~> 1.6.0'
 end

data/Gemfile.lock

@@ -8,6 +8,10 @@ dependencies:
     group: 
     - :development
     version: ~> 1.3.0
+  sdoc: 
+    group: 
+    - :development
+    version: ~> 0.2.17
   rcov: 
     group: 
     - :development
@@ -20,6 +24,10 @@ dependencies:
     group: 
     - :default
     version: ~> 0.9.21
+  rdiscount: 
+    group: 
+    - :development
+    version: ~> 1.6.0
   activesupport: 
     group: 
     - :default
@@ -30,29 +38,38 @@ specs:
 - builder: 
     version: 2.1.2
 - i18n: 
-    version: 0.3.6
+    version: 0.3.7
 - memcache-client: 
-    version: 1.7.8
+    version: 1.8.2
 - tzinfo: 
-    version: 0.3.16
+    version: 0.3.20
 - activesupport: 
     version: 3.0.0.beta3
 - bundler: 
-    version: 0.9.21
+    version: 0.9.24
 - json_pure: 
-    version: 1.1.9
+    version: 1.4.1
 - gemcutter: 
     version: 0.5.0
 - git: 
     version: 1.2.5
 - rubyforge: 
-    version: 2.0.3
+    version: 2.0.4
 - jeweler: 
     version: 1.4.0
+- json: 
+    version: 1.4.1
 - rcov: 
     version: 0.8.1.2.0
+- rdiscount: 
+    version: 1.6.3.1
+- rdoc: 
+    version: 2.5.6
 - rspec: 
     version: 1.3.0
-hash: ab6203010c041eee427af7ba685f739a6199f93d
-sources: []
-
+- sdoc: 
+    version: 0.2.17
+hash: 7067b85b35efe373501ac3b1b893d54629bdd613
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/Rakefile

@@ -9,6 +9,8 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   gem.name = "dionysus"
@@ -39,13 +41,53 @@ task :spec => :check_dependencies
 task :default => :spec
 
 require 'rake/rdoctask'
+require 'sdoc'
+require 'dionysus/rdoc/markdown'
+require 'dionysus/rdoc/no_markup'
+RDoc::NoMarkup.files.include('LICENSE', 'VERSION')
+
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.options << '--fmt' << 'shtml'
+  rdoc.template = 'direct'
   rdoc.title = "Dionysus #{version}"
-  rdoc.rdoc_files.include('README*', 'LICENSE', 'VERSION')
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include('README.md', 'LICENSE', 'VERSION')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = 'docs'
 end
 
 task :clobber => [:clobber_rcov, :clobber_rdoc]
+
+# Github pages tasks taken from the sdoc-helpers gem.
+# http://github.com/defunkt/sdoc-helpers
+# Author: Chris Wanstrath chris@ozmm.org
+namespace :pages do
+  task :publish => [ :check_dirty, :rerdoc ] do
+    version = File.exist?('VERSION') ? File.read('VERSION') : ""
+    `git checkout gh-pages`
+    `ls -1 | grep -v docs | xargs rm -rf; mv docs/* .; rm -rf docs`
+    `git add .; git commit -m "update docs for version #{version}"; git push origin gh-pages`
+    `git checkout master`
+    puts :done
+  end
+
+  desc "Initialize GitHub Pages with documentation"
+  task :init => [ :check_dirty, :rerdoc ] do
+    `git symbolic-ref HEAD refs/heads/gh-pages`
+    `rm .git/index`
+    `ls -1 | grep -v docs | xargs rm -rf; mv docs/* .; rm -rf docs`
+    `git add .;git commit -m "create docs"; git push origin gh-pages`
+    `git checkout master`
+    puts :done
+  end
+
+  task :check_dirty do
+    if !`git status`.include?('nothing to commit')
+      abort "dirty index - not publishing!"
+    end
+  end
+end
+
+desc "Build and publish documentation using GitHub Pages."
+task :pages => "pages:publish"

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/dionysus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dionysus}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis D. Warlick, Jr."]
-  s.date = %q{2010-04-25}
+  s.date = %q{2010-04-26}
   s.email = %q{warlickt@operissystems.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
      "lib/dionysus.rb",
      "lib/dionysus/configuration.rb",
      "lib/dionysus/digest.rb",
+     "lib/dionysus/rdoc/markdown.rb",
+     "lib/dionysus/rdoc/no_markup.rb",
      "lib/dionysus/security.rb",
      "lib/dionysus/security/password_salt.rb",
      "lib/dionysus/security/string.rb",
@@ -63,24 +65,30 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
       s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<sdoc>, ["~> 0.2.17"])
       s.add_development_dependency(%q<rcov>, ["~> 0.8.1"])
       s.add_runtime_dependency(%q<bundler>, ["~> 0.9.21"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_development_dependency(%q<rdiscount>, ["~> 1.6.0"])
       s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0.beta"])
     else
       s.add_dependency(%q<rake>, ["~> 0.8.7"])
       s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_dependency(%q<sdoc>, ["~> 0.2.17"])
       s.add_dependency(%q<rcov>, ["~> 0.8.1"])
       s.add_dependency(%q<bundler>, ["~> 0.9.21"])
       s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+      s.add_dependency(%q<rdiscount>, ["~> 1.6.0"])
       s.add_dependency(%q<activesupport>, ["~> 3.0.0.beta"])
     end
   else
     s.add_dependency(%q<rake>, ["~> 0.8.7"])
     s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    s.add_dependency(%q<sdoc>, ["~> 0.2.17"])
     s.add_dependency(%q<rcov>, ["~> 0.8.1"])
     s.add_dependency(%q<bundler>, ["~> 0.9.21"])
     s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+    s.add_dependency(%q<rdiscount>, ["~> 1.6.0"])
     s.add_dependency(%q<activesupport>, ["~> 3.0.0.beta"])
   end
 end

data/lib/dionysus/rdoc/markdown.rb

@@ -0,0 +1,64 @@
+require 'active_support/concern'
+begin
+  Markdown
+rescue NameError
+  require 'rdiscount'
+end
+
+module RDoc # :nodoc:
+  ##
+  # Extend RDoc to support Markdown files.  It will automatically use Markdown
+  # for any files with the `.md` or `.markdown` extension.  You may also specify
+  # files with `RDoc::Markdown.files`
+  #
+  # After RDoc is loaded:
+  #
+  #     require 'dionysus/rdoc/markdown'
+  #     RDoc::Markdown.files.include('README')
+  module Markdown
+    FILE_NAMES = Rake::FileList.new
+    
+    def self.files() FILE_NAMES; end
+    
+    def self.markdown_for_file?(file_name)
+      %w(.md .markdown).include?(File.extname(file_name)) or
+        self.files.resolve.to_a.include?(file_name)
+    end
+    
+    module Parser # :nodoc:
+      extend ActiveSupport::Concern
+      
+      included do
+        class << self
+          alias_method :can_parse_without_markdown, :can_parse
+          alias_method :can_parse, :can_parse_with_markdown
+        end
+      end
+      
+      module ClassMethods # :nodoc:
+        def can_parse_with_markdown(file_name)
+          result = can_parse_without_markdown(file_name)
+          if result.nil? and Markdown.markdown_for_file?(file_name)
+            ::RDoc::Parser::Simple
+          else
+            result
+          end
+        end
+      end
+    end
+    
+    module TopLevel # :nodoc:
+      extend ActiveSupport::Concern
+      
+      module InstanceMethods # :nodoc:
+        def description
+          return super unless Markdown.markdown_for_file?(full_name)
+          ::Markdown.new(File.read(::RDoc::RDoc.current.generator.basedir + full_name)).to_html
+        end
+      end
+    end
+  end
+end
+
+RDoc::TopLevel.send(:include, RDoc::Markdown::TopLevel)
+RDoc::Parser.send(:include, RDoc::Markdown::Parser)

data/lib/dionysus/rdoc/no_markup.rb

@@ -0,0 +1,56 @@
+require 'active_support/concern'
+
+module RDoc # :nodoc:
+  ##
+  # Extend RDoc to support plaintext files that will be displayed inside a <pre> block.
+  #
+  # After RDoc is loaded:
+  #
+  #     require 'dionysus/rdoc/no_markup'
+  #     RDoc::NoMarkup.files.include('LICENSE','VERSION')
+  module NoMarkup
+    FILE_NAMES = Rake::FileList.new
+    
+    def self.files() FILE_NAMES; end
+    
+    def self.no_markup_for_file?(file_name)
+      self.files.resolve.to_a.include?(file_name)
+    end
+    
+    module Parser # :nodoc:
+      extend ActiveSupport::Concern
+      
+      included do
+        class << self
+          alias_method :can_parse_with_markup, :can_parse
+          alias_method :can_parse, :can_parse_without_markup
+        end
+      end
+      
+      module ClassMethods # :nodoc:
+        def can_parse_without_markup(file_name)
+          if NoMarkup.no_markup_for_file?(file_name)
+            ::RDoc::Parser::Simple
+          else
+            can_parse_with_markup(file_name)
+          end
+        end
+      end
+    end
+    
+    module TopLevel # :nodoc:
+      extend ActiveSupport::Concern
+      
+      module InstanceMethods # :nodoc:
+        def description
+          return super unless NoMarkup.no_markup_for_file?(full_name)
+          txt = File.read(::RDoc::RDoc.current.generator.basedir + full_name)
+          %(<pre>#{txt}</pre>)
+        end
+      end
+    end
+  end
+end
+
+RDoc::TopLevel.send(:include, RDoc::NoMarkup::TopLevel)
+RDoc::Parser.send(:include, RDoc::NoMarkup::Parser)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Travis D. Warlick, Jr.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 -05:00
+date: 2010-04-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,6 +47,20 @@ dependencies:
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 17
+        version: 0.2.17
+  prerelease: false
+  type: :development
+  name: sdoc
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -58,9 +72,9 @@ dependencies:
   prerelease: false
   type: :development
   name: rcov
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -72,9 +86,9 @@ dependencies:
   prerelease: false
   type: :runtime
   name: bundler
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -86,9 +100,23 @@ dependencies:
   prerelease: false
   type: :development
   name: jeweler
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  prerelease: false
+  type: :development
+  name: rdiscount
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -101,7 +129,7 @@ dependencies:
   prerelease: false
   type: :runtime
   name: activesupport
-  version_requirements: *id006
+  version_requirements: *id008
 description: 
 email: warlickt@operissystems.com
 executables: []
@@ -124,6 +152,8 @@ files:
 - lib/dionysus.rb
 - lib/dionysus/configuration.rb
 - lib/dionysus/digest.rb
+- lib/dionysus/rdoc/markdown.rb
+- lib/dionysus/rdoc/no_markup.rb
 - lib/dionysus/security.rb
 - lib/dionysus/security/password_salt.rb
 - lib/dionysus/security/string.rb