guard-yard 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434a0ae6ebca42341d296bd0b0dbe0cf6277e338
-  data.tar.gz: 412d9c189a3d610ec839fef398c7861d7349d246
+  metadata.gz: 8b5b502b0b0cff99bc620a14389e0000a20d8ea5
+  data.tar.gz: b47ee07f81d04af0711cb4e639df0f402979dccf
 SHA512:
-  metadata.gz: 61d5b1ec3083a8b5194922943d0bef9843588bf54e46139aedde790393bd1e3ae31f3680557841c938bf2fc3b9e71169e62b7b827f6629464180ee6efca4cd51
-  data.tar.gz: 6ff77b47418369da0b450a65a6229316885fd0167f6197d22ec1d9ff2c7c21248ead659bf0f755e73c181769b9f9a5b7dd59db2846c5fce526087a85f2ad106f
+  metadata.gz: ba4ecd6680472a3720227a7e2f61a64bfc31371b2a78485085e8179c3240d36e931ceed622f66e9c3481cffd2cfed163d3d35ddd3379378e3f8af13d467facd5
+  data.tar.gz: 66504d272dd6678586d60692c6470d59df3baaeb4169f8cad84d7c9a007dd84e411233edeeca343c2291b1b3c55b44677cdcd8df1d6461ab34cf69ee595ce950

data/README.markdown

@@ -36,7 +36,9 @@ Guard::Yard also provides some basic options for doc generation and running the
 
 Available options:
 
+    :server => true         # Disable/Enable server
     :port => '8808'         # Port on which the server shoud run.
+    :host => 'localhost'    # Host to which the server should bind.
     :stdout => 'yard.log'   # File in which to log the yard server output.
     :stderr => '/dev/null'  # File in which to log the yard server errors.
     :cli => '--plugin rest' # Additional command line options to be appended to the server command.
@@ -53,3 +55,5 @@ When booting guard, Guard::Yard will do this for you automatically if no .yardoc
 ## 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.
+
+## Build Status [![Build Status](https://secure.travis-ci.org/panthomakos/guard-yard.png?branch=master)](http://travis-ci.org/panthomakos/guard-yard)

data/lib/guard/yard.rb

@@ -3,6 +3,7 @@ require 'guard/plugin'
 require 'yard'
 
 module Guard
+  # Main guard-yard plugin class.
   class Yard < Plugin
     autoload :NoServer, 'guard/yard/no_server'
     autoload :Server, 'guard/yard/server'
@@ -27,9 +28,9 @@ module Guard
     end
 
     def run_all
-      UI.info "[Guard::Yard] Generating all documentation."
+      UI.info '[Guard::Yard] Generating all documentation.'
       system('rm -rf .yardoc && yard doc')
-      UI.info "[Guard::Yard] Documentation has been generated."
+      UI.info '[Guard::Yard] Documentation has been generated.'
       true
     end
 
@@ -42,16 +43,16 @@ module Guard
     private
 
     def check
-      return true if File.exists?('.yardoc')
-      UI.info "[Guard::Yard] Documentation missing."
-      run_all and true
+      return true if File.exist?('.yardoc')
+      UI.info '[Guard::Yard] Documentation missing.'
+      run_all && true
     end
 
     def boot
-      check and server.kill and server.spawn and server.verify
+      check && server.kill && server.spawn && server.verify
     end
 
-    def document files
+    def document(files)
       ::YARD::Registry.load!
       ::YARD::Registry.load(files, true)
       ::YARD::Registry.load_all
@@ -60,7 +61,7 @@ module Guard
       options = yardoc.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)}
+          && !object.files.any? { |f, _line| files.include?(f) }
       end
       ::YARD::Templates::Engine.generate(objects, options)
       save_registry

data/lib/guard/yard/no_server.rb

@@ -1,5 +1,6 @@
 module Guard
   class Yard
+    # NULL Server
     class NoServer
       [:kill, :spawn, :verify].each do |method|
         define_method(method) { true }

data/lib/guard/yard/server.rb

@@ -2,20 +2,22 @@ require 'socket'
 
 module Guard
   class Yard
+    # Responsible for running, verifying and killing the YARD server.
     class Server
-      attr_accessor :pid, :port
+      attr_accessor :pid, :port, :host
 
       def initialize(options = {})
         @port = options[:port] || '8808'
+        @host = options[:host] || 'localhost'
         @stdout = options[:stdout]
         @stderr = options[:stderr]
         @cli = options[:cli]
       end
 
       def spawn
-        UI.info "[Guard::Yard] Starting YARD Documentation Server."
+        UI.info '[Guard::Yard] Starting YARD Documentation Server.'
 
-        command = ["yard server -p #{port}"]
+        command = ["yard server -p #{port} -b #{host}"]
         command << @cli if @cli
         command << "2> #{@stderr}" if @stderr
         command << "1> #{@stdout}" if @stdout
@@ -24,7 +26,7 @@ module Guard
       end
 
       def kill
-        UI.info "[Guard::Yard] Stopping YARD Documentation Server."
+        UI.info '[Guard::Yard] Stopping YARD Documentation Server.'
         begin
           if pid
             Process.kill('QUIT', pid)
@@ -32,6 +34,7 @@ module Guard
           end
         rescue Errno::ESRCH, Errno::ECHILD
           # Process is already dead.
+          true
         end
         true
       end
@@ -40,16 +43,19 @@ module Guard
         5.times do
           sleep 1
           begin
-            TCPSocket.new('localhost', port.to_i).close
+            TCPSocket.new(host, port.to_i).close
           rescue Errno::ECONNREFUSED
             next
           end
-          UI.info "[Guard::Yard] Server successfully started."
+          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
+        UI.error '[Guard::Yard] Error starting documentation server.'
+        Notifier.notify(
+          '[Guard::Yard] Server NOT started.',
+          title: 'yard',
+          image: :failed
+        )
         false
       end
     end

data/lib/guard/yard/templates/Guardfile

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

data/lib/guard/yard/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module YardVersion
-    VERSION = "2.1.4"
+    VERSION = '2.2.0'.freeze
   end
 end

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: guard-yard
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Pan Thomakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.40'
 description: Guard::Yard automatically monitors Yard Documentation.
 email:
 - pan.thomakos@gmail.com
@@ -45,13 +73,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.markdown
 - lib/guard/yard.rb
-- lib/guard/yard/templates/Guardfile
 - lib/guard/yard/no_server.rb
 - lib/guard/yard/server.rb
+- lib/guard/yard/templates/Guardfile
 - lib/guard/yard/version.rb
-- LICENSE
-- README.markdown
 homepage: https://github.com/panthomakos/guard-yard
 licenses: []
 metadata: {}
@@ -61,19 +89,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: guard-yard
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Guard gem for YARD
 test_files: []
-has_rdoc: