guard-yard 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Panayiotis Thomakos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,48 @@
+# Guard::Yard
+
+Guard::Yard allows you to automatically run and update your local YARD Documentation Server. It aims to centralize your file monitoring to guard instead of using the `yard server --reload` command which can be unreliable and provides little control over the generated documentation. Guard::Yard monitors files and updates only the documentation than changes, as opposed to generating the entire documentation suite. That means that changes to your documentation are available sooner!
+
+## Install
+
+Ensure you have [Guard](https://github.com/guard/guard) installed before you continue.
+
+Add guard-yard to your Gemfile (inside development group):
+
+    gem 'guard-yard'
+
+Install or update your bundle:
+
+    bundle install
+
+Add the default guard-yard definition to your Guardfile:
+
+    guard init yard
+
+## Guardfile
+
+Please read the [Guardfile DSL documentation](https://github.com/guard/guard#readme) for additional information.
+
+Guard::Yard automatically detects changes in your app, lib and ext directories, but you can have it monitor additional files using the Guardfile DSL.
+
+Guard::Yard also provides some basic options for doc generation and running the YARD server.
+
+    guard 'yard', :port => '8808' do
+      ...
+    end
+
+Available options:
+
+    :port => '8808'         # Port on which the server shoud run.
+
+## Clean-Slate Documentation
+
+To generate or re-create documentation from a clean-slate, run the following command:
+
+    rm -rf .yardoc && yard doc
+
+When booting guard, Guard::Yard will do this for you automatically if no .yardoc directory is present. Once guard is running you can execute this command by using the `Ctrl-\` key combination as well.
+
+
+## Troubleshooting
+
+If you are running into issues, try re-creating your documentation using `rm -rf .yardoc && yard doc`. Once this operation is complete, restart guard. If you are still having problems, open a new issue in the GitHub issue tracker for this project.

data/lib/guard/yard.rb

@@ -0,0 +1,71 @@
+require 'guard'
+require 'guard/guard'
+require 'yard'
+
+module Guard
+  class Yard < Guard
+    autoload :Server, 'guard/yard/server'
+    attr_accessor :server
+
+    def initialize(watchers=[], options={})
+      super
+      @server = Server.new(options[:port])
+    end
+
+    def start
+      UI.info "[Guard::Yard] Starting YARD Documentation Server."
+      boot
+    end
+
+    def stop
+      server.kill
+    end
+
+    def reload
+      UI.info "[Guard::Yard] Reloading YARD Documentation Server."
+      boot
+    end
+
+    def run_all
+      UI.info "[Guard::Yard] Generating all documentation."
+      system('rm -rf .yardoc && yard doc')
+      UI.info "[Guard::Yard] Documentation has been generated."
+      true
+    end
+
+    def run_on_change(paths)
+      UI.info "[Guard::Yard] Detected changes in #{paths.join(',')}."
+      paths.each{ |path| document([path]) }
+      UI.info "[Guard::Yard] Updated documentation for #{paths.join(',')}."
+    end
+
+    private
+
+    def check
+      return true if File.exists?('.yardoc')
+      UI.info "[Guard::Yard] Documentation missing."
+      run_all and true
+    end
+
+    def boot
+      check and server.kill and server.spawn and server.verify
+    end
+
+    def document files
+      ::YARD::Registry.load!
+      ::YARD::Registry.load(files, true)
+      ::YARD::Registry.load_all
+      options = ::YARD::CLI::Yardoc.new.options
+      objects = ::YARD::Registry.all(:root, :module, :class).reject do |object|
+        (!options[:serializer] || options[:serializer].exists?(object)) \
+          && !object.files.any?{|f,line| files.include?(f)}
+      end
+      ::YARD::Templates::Engine.generate(objects, options)
+      save_registry
+    end
+
+    def save_registry
+      ::YARD::Registry.save(true)
+    end
+  end
+end

data/lib/guard/yard/server.rb

@@ -0,0 +1,49 @@
+require 'socket'
+
+module Guard
+  class Yard
+    class Server
+      attr_accessor :pid, :port
+
+      def initialize(port)
+        @port = port || '8808'
+      end
+
+      def spawn
+        self.pid = fork
+        raise 'Fork failed' if pid == -1
+
+        unless pid
+          Signal.trap('QUIT', 'IGNORE')
+          Signal.trap('INT', 'IGNORE')
+          Signal.trap('TSTP', 'IGNORE')
+
+          exec("yard server -p #{port}")
+        end
+        pid
+      end
+
+      def kill
+        Process.kill('KILL', pid) unless pid.nil?
+        true
+      end
+
+      def verify
+        5.times do
+          sleep 1
+          begin
+            TCPSocket.new('localhost', port.to_i).close
+          rescue Errno::ECONNREFUSED
+            next
+          end
+          UI.info "[Guard::Yard] Server successfully started."
+          return true
+        end
+        UI.error "[Guard::Yard] Error starting documentation server."
+        Notifier.notify "[Guard::Yard] Server NOT started.",
+          :title => 'yard', :image => failed
+        false
+      end
+    end
+  end
+end

data/lib/guard/yard/templates/Guardfile

@@ -0,0 +1,5 @@
+guard 'yard' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch($r{ext/.+\.c})
+end

data/lib/guard/yard/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module Yard
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: guard-yard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pan Thomakos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-21 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2152555340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152555340
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2152517400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152517400
+description: Guard::Yard automatically monitors Yard Documentation.
+email:
+- pan.thomakos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/yard/server.rb
+- lib/guard/yard/templates/Guardfile
+- lib/guard/yard/version.rb
+- lib/guard/yard.rb
+- LICENSE
+- README.markdown
+has_rdoc: true
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: guard-yard
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Guard gem for YARD
+test_files: []