rake-tomdoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f2987aa27dec0a565c4f5a9ff20c40912d9ff12
+  data.tar.gz: 69c934a4b3135dfba9888a03d3e2293380eb8729
+SHA512:
+  metadata.gz: c2ed85af839397d077a046d91f8f8e28220b082b177bc8489f3fcfe0d99a9044de6e10f0dabefd8e4590860e2f6b9373fe6a3d702d042f217f4f31e99d3d12dd
+  data.tar.gz: 6ef9f149a073d982e3134b550c8b1465094fa8d8e8e282a098c4a6b761ec8dcb0470d61f866bce6ab265c5bfd1cf16d88ae906d82aa01e69d863141225943237

data/README.markdown

@@ -0,0 +1,54 @@
+# rake-tomdoc
+
+Adds `rake tomdoc` to generate documentation for publishing to GitHub Pages.
+
+## Setup
+
+Add this gem as a development dependency to your projects Gemfile or gemspec:
+
+```ruby
+gem 'rake-tomdoc', group: :development
+
+Gem::Specification.new do |s|
+  ...
+  s.add_development_dependency 'rake-tomdoc'
+end
+```
+
+Create a gh-pages branch in your project. Make sure you have committed any
+changes and your repository contains no untracked files!
+
+```
+$ git checkout --orphan gh-pages
+$ git rm -rf .
+$ git commit --allow-empty -m "Created gh-pages branch"
+$ git checkout -
+```
+
+Require the gem in your `Rakefile`:
+
+```ruby
+require 'rake-tomdoc'
+```
+
+## Usage
+
+When you are ready to publish new documentation:
+
+```
+$ rake tomdoc [--trace]
+$ git commit -am "Updating documentation"
+$ git push origin gh-pages
+$ git checkout -
+```
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Commit, do not bump version.
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2013 Site5.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+  require 'rake-tomdoc'
+rescue LoadError
+  abort "Please run `bundle install` first"
+end

data/lib/rake-tomdoc.rb

@@ -0,0 +1,37 @@
+desc "Generates TomDoc using `yard`, and copies it to the `gh-pages` branch."
+task :tomdoc do
+  def cmd(*args)
+    error   = args.pop
+    command = args.map(&:strip).join(' && ')
+    output  = `#{command}`
+    puts "+ #{command}", output if Rake.application.options.trace
+    abort error unless $?.success?
+  end
+
+  def executor
+    cmd "which git",  "Couldn't find `git`!"
+    cmd "which yard", "Couldn't find `yard`!"
+
+    cmd "git diff-files --quiet --ignore-submodules --",
+      "git diff-index --cached --quiet HEAD --ignore-submodules --",
+      "You must be on a clean branch to run this command"
+
+    puts "Generating docs"
+
+    Dir.mktmpdir do |dir|
+      cmd "yard doc --private --plugin tomdoc --output-dir #{dir} - LICENSE",
+        "Couldn't generate docs!"
+
+      cmd "git checkout gh-pages", "Couldn't checkout gh-pages branch!"
+      cmd "cp -rv #{dir}/* .",     "Couldn't copy docs!"
+    end
+
+    puts "Done! Make sure to review the changes and push to GitHub!"
+  end
+
+  if defined?(Bundler)
+    Bundler.with_clean_env(&method(:executor))
+  else
+    executor
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rake-tomdoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joshua Priddle
+- Justin Mazzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-tomdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: 
+email:
+- jpriddle@me.com
+- jmazzi@site5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- README.markdown
+- lib/rake-tomdoc.rb
+homepage: https://github.com/site5/rake-tomdoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: rake-tomdoc
+test_files: []
+has_rdoc: