RubyGems - qiita_org - Versions diffs - 0.1.20 → 0.1.25 - Mend

qiita_org 0.1.20 → 0.1.25

Files changed (1632) hide show

data/gems/ruby/2.7.0/gems/guard-2.16.2/man/guard.1 ADDED

@@ -0,0 +1,108 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GUARD" "1" "November 2014" "" ""
+.
+.SH "NAME"
+\fBguard\fR \- Guard keeps an eye on your file modifications\.
+.
+.SH "DESCRIPTION"
+Guard is a command line tool to easily handle events on file system modifications\.
+.
+.SH "SYNOPSIS"
+\fBguard <COMMAND> <OPTIONS>\fR
+.
+.SH "COMMANDS"
+.
+.SS "start"
+Starts Guard\. This is the default command if none is provided\.
+.
+.P
+The following options are available:
+.
+.P
+\fB\-c\fR, \fB\-\-clear\fR Clears the Shell after each change\.
+.
+.P
+\fB\-n\fR, \fB\-\-notify\fR \fIFLAG\fR Disable notifications (Growl or Libnotify depending on your system)\. Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false\. FLAG can be \fBtrue\fR/\fBfalse\fR or \fBt\fR/\fBf\fR\.
+.
+.P
+\fB\-g\fR, \fB\-\-group\fR \fIGROUP1\fR \fIGROUP2\fR\.\.\. Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc\. Group names should be separated by spaces\. Plugins that don\'t belong to a group are considered global and are always run\.
+.
+.P
+\fB\-P\fR, \fB\-\-plugin\fR \fIPLUGIN1\fR \fIPLUGIN2\fR\.\.\. Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc\. Plugin names should be separated by spaces\.
+.
+.P
+\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\.
+.
+.P
+\fB\-w\fR, \fB\-\-watchdir\fR \fIPATH\fR Tells Guard to watch PATH instead of \fB\./\fR\.
+.
+.P
+\fB\-G\fR, \fB\-\-guardfile\fR \fIFILE\fR Tells Guard to use FILE as its Guardfile instead of \fB\./Guardfile\fR or \fB~/\.Guardfile\fR\.
+.
+.P
+\fB\-i\fR, \fB\-\-no\-interactions\fR Turn off completely any Guard terminal interactions\.
+.
+.P
+\fB\-B\fR, \fB\-\-no\-bundler\-warning\fR Turn off warning when Bundler is not present\.
+.
+.P
+\fB\-l\fR, \fB\-\-latency\fR Overwrite Listen\'s default latency\.
+.
+.P
+\fB\-p\fR, \fB\-\-force\-polling\fR Force usage of the Listen polling listener\.
+.
+.P
+\fB\-y\fR, \fB\-\-wait\-for\-delay\fR Overwrite Listen\'s default \fBwait_for_delay\fR, useful for kate\-like editors through ssh access\.
+.
+.SS "init [GUARDS]"
+If no Guardfile is present in the current directory, creates an empty Guardfile\.
+.
+.P
+If \fIGUARDS\fR are present, add their default Guardfile configuration to the current Guardfile\. Note that \fIGUARDS\fR is a list of the Guard plugin names without the \fBguard\-\fR prefix\. For instance to initialize guard\-rspec, run \fBguard init rspec\fR\.
+.
+.SS "list"
+Lists Guard plugins that can be used with the \fBinit\fR command\.
+.
+.SS "\-T, show"
+List defined groups and Guard plugins for the current Guardfile\.
+.
+.SS "\-h, help [COMMAND]"
+List all of Guard\'s available commands\.
+.
+.P
+If \fICOMMAND\fR is given, displays a specific help for \fITASK\fR\.
+.
+.SH "EXAMPLES"
+Initialize Guard and a specific Guard plugin at the same time:
+.
+.P
+\fB[bundle exec] guard init [rspec]\fR
+.
+.P
+Run Guard:
+.
+.P
+\fB[bundle exec] guard [start] \-\-watchdir ~/dev \-\-guardfile ~/env/Guardfile \-\-clear \-\-group backend frontend \-\-notify false \-\-debug\fR
+.
+.P
+or in a more concise way:
+.
+.P
+\fB[bundle exec] guard [start] \-w ~/dev \-G ~/env/Guardfile \-c \-g backend frontend \-n f \-d\fR
+.
+.SH "AUTHORS / CONTRIBUTORS"
+Thibaud Guillaume\-Gentil is the main author\.
+.
+.P
+A list of contributors based on all commits can be found here: https://github\.com/guard/guard/contributors
+.
+.SH "CHANGELOG"
+The changelog can be found at: https://github\.com/guard/guard/blob/master/CHANGELOG\.md
+.
+.P
+This manual has been written by Remy Coutable\.
+.
+.SH "WWW"
+http://guardgem\.org/

data/gems/ruby/2.7.0/gems/guard-2.16.2/man/guard.1.html ADDED

@@ -0,0 +1,196 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>guard(1) - Guard keeps an eye on your file modifications.</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#COMMANDS">COMMANDS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</a>
+    <a href="#CHANGELOG">CHANGELOG</a>
+    <a href="#WWW">WWW</a>
+  </div>
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>guard(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>guard(1)</li>
+  </ol>
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>guard</code> - <span class="man-whatis">Guard keeps an eye on your file modifications.</span>
+</p>
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<p>Guard is a command line tool to easily handle events on file system modifications.</p>
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<p><code>guard &lt;COMMAND> &lt;OPTIONS></code></p>
+<h2 id="COMMANDS">COMMANDS</h2>
+<h3 id="start">start</h3>
+<p>Starts Guard. This is the default command if none is provided.</p>
+<p>The following options are available:</p>
+<p><code>-c</code>, <code>--clear</code>
+  Clears the Shell after each change.</p>
+<p><code>-n</code>, <code>--notify</code> <var>FLAG</var>
+  Disable notifications (Growl or Libnotify depending on your system).
+  Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false.
+  FLAG can be <code>true</code>/<code>false</code> or <code>t</code>/<code>f</code>.</p>
+<p><code>-g</code>, <code>--group</code> <var>GROUP1</var> <var>GROUP2</var>...
+  Scopes the Guard actions to the groups specified by GROUP1, GROUP2, etc.
+  Group names should be separated by spaces.
+  Plugins that don't belong to a group are considered global and are always run.</p>
+<p><code>-P</code>, <code>--plugin</code> <var>PLUGIN1</var> <var>PLUGIN2</var>...
+  Scopes the Guard actions to the plugins specified by PLUGIN1, PLUGIN2, etc.
+  Plugin names should be separated by spaces.</p>
+<p><code>-d</code>, <code>--debug</code>
+  Runs Guard in debug mode.</p>
+<p><code>-w</code>, <code>--watchdir</code> <var>PATH</var>
+  Tells Guard to watch PATH instead of <code>./</code>.</p>
+<p><code>-G</code>, <code>--guardfile</code> <var>FILE</var>
+  Tells Guard to use FILE as its Guardfile instead of <code>./Guardfile</code> or <code>~/.Guardfile</code>.</p>
+<p><code>-i</code>, <code>--no-interactions</code>
+  Turn off completely any Guard terminal interactions.</p>
+<p><code>-B</code>, <code>--no-bundler-warning</code>
+  Turn off warning when Bundler is not present.</p>
+<p><code>-l</code>, <code>--latency</code>
+  Overwrite Listen's default latency.</p>
+<p><code>-p</code>, <code>--force-polling</code>
+  Force usage of the Listen polling listener.</p>
+<p><code>-y</code>, <code>--wait-for-delay</code>
+  Overwrite Listen's default <code>wait_for_delay</code>, useful for kate-like editors through ssh access.</p>
+<h3 id="init-GUARDS-">init [GUARDS]</h3>
+<p>If no Guardfile is present in the current directory, creates an empty Guardfile.</p>
+<p>If <var>GUARDS</var> are present, add their default Guardfile configuration to the current Guardfile.
+Note that <var>GUARDS</var> is a list of the Guard plugin names without the <code>guard-</code> prefix.
+For instance to initialize guard-rspec, run <code>guard init rspec</code>.</p>
+<h3 id="list">list</h3>
+<p>Lists Guard plugins that can be used with the <code>init</code> command.</p>
+<h3 id="-T-show">-T, show</h3>
+<p>List defined groups and Guard plugins for the current Guardfile.</p>
+<h3 id="-h-help-COMMAND-">-h, help [COMMAND]</h3>
+<p>List all of Guard's available commands.</p>
+<p>If <var>COMMAND</var> is given, displays a specific help for <var>TASK</var>.</p>
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<p>Initialize Guard and a specific Guard plugin at the same time:</p>
+<p><code>[bundle exec] guard init [rspec]</code></p>
+<p>Run Guard:</p>
+<p><code>[bundle exec] guard [start] --watchdir ~/dev --guardfile ~/env/Guardfile --clear --group backend frontend --notify false --debug</code></p>
+<p>or in a more concise way:</p>
+<p><code>[bundle exec] guard [start] -w ~/dev -G ~/env/Guardfile -c -g backend frontend -n f -d</code></p>
+<h2 id="AUTHORS-CONTRIBUTORS">AUTHORS / CONTRIBUTORS</h2>
+<p>Thibaud Guillaume-Gentil is the main author.</p>
+<p>A list of contributors based on all commits can be found here:
+https://github.com/guard/guard/contributors</p>
+<h2 id="CHANGELOG">CHANGELOG</h2>
+<p>The changelog can be found at: https://github.com/guard/guard/blob/master/CHANGELOG.md</p>
+<p>This manual has been written by Remy Coutable.</p>
+<h2 id="WWW">WWW</h2>
+<p>http://guardgem.org/</p>
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>November 2014</li>
+    <li class='tr'>guard(1)</li>
+  </ol>
+  </div>
+</body>
+</html>

data/gems/ruby/2.7.0/gems/guard-yard-2.2.1/LICENSE ADDED

@@ -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/gems/ruby/2.7.0/gems/guard-yard-2.2.1/README.markdown ADDED

@@ -0,0 +1,59 @@
+# 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!
+## Requirements
+* The [YARD](http://yardoc.org) documentation tool.
+* The [Guard](https://github.com/guard/guard) rubygem.
+* Ruby 1.9.2 or higher.
+## Install
+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:
+    :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.
+## 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.
+## Build Status [![Build Status](https://secure.travis-ci.org/panthomakos/guard-yard.svg?branch=master)](http://travis-ci.org/panthomakos/guard-yard)

data/gems/ruby/2.7.0/gems/guard-yard-2.2.1/lib/guard/yard.rb ADDED

@@ -0,0 +1,74 @@
+require 'guard'
+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'
+    attr_accessor :server
+    def initialize(options = {})
+      super
+      options[:server] = true unless options.key?(:server)
+      @server = options[:server] ? Server.new(options) : NoServer.new
+    end
+    def start
+      boot
+    end
+    def stop
+      server.kill
+    end
+    def reload
+      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_changes(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.exist?('.yardoc')
+      UI.info '[Guard::Yard] Documentation missing.'
+      run_all && true
+    end
+    def boot
+      check && server.kill && server.spawn && server.verify
+    end
+    def document(files)
+      ::YARD::Registry.load!
+      ::YARD::Registry.load(files, true)
+      ::YARD::Registry.load_all
+      yardoc = ::YARD::CLI::Yardoc.new
+      yardoc.parse_arguments
+      options = yardoc.options
+      objects = ::YARD::Registry.all(:root, :module, :class).reject do |object|
+        (!options[:serializer] || options[:serializer].exists?(object)) \
+          && object.files.none? { |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