RubyGems - term_utils - Versions diffs - 0.3.2 → 0.5.0 - Mend

term_utils 0.3.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (70) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +16 -2
data/COPYING +3 -3
data/README.md +51 -16
data/Rakefile +6 -0
data/doc/TermUtils/AP/Article.html +57 -55
data/doc/TermUtils/AP/ArticleResult.html +584 -0
data/doc/TermUtils/AP/Flag.html +295 -78
data/doc/TermUtils/AP/Parameter.html +891 -103
data/doc/TermUtils/AP/ParameterResult.html +980 -0
data/doc/TermUtils/{FF/Cursor/Context.html → AP/ParameterWalkerHooks.html} +60 -60
data/doc/TermUtils/AP/ParseError.html +651 -19
data/doc/TermUtils/AP/Parser.html +181 -121
data/doc/TermUtils/AP/Result.html +201 -528
data/doc/TermUtils/AP/Syntax.html +103 -393
data/doc/TermUtils/AP/SyntaxError.html +9 -91
data/doc/TermUtils/AP/Walker.html +686 -0
data/doc/TermUtils/AP.html +49 -160
data/doc/TermUtils/FF/Config.html +203 -35
data/doc/TermUtils/FF/Context.html +585 -0
data/doc/TermUtils/FF/Entry.html +626 -0
data/doc/TermUtils/FF/Finder.html +850 -0
data/doc/TermUtils/FF/{Cursor.html → FinderEntry.html} +473 -211
data/doc/TermUtils/FF/FinderQuery.html +946 -0
data/doc/TermUtils/FF/Query.html +402 -70
data/doc/TermUtils/FF.html +135 -11
data/doc/TermUtils/PropertyTreeNode.html +304 -190
data/doc/TermUtils/Tab/Column.html +98 -96
data/doc/TermUtils/Tab/Header.html +30 -30
data/doc/TermUtils/Tab/Holder.html +81 -81
data/doc/TermUtils/Tab/Printer.html +43 -43
data/doc/TermUtils/Tab/Table.html +124 -128
data/doc/TermUtils/Tab/TableError.html +7 -89
data/doc/TermUtils/Tab.html +93 -86
data/doc/TermUtils.html +10 -10
data/doc/_index.html +62 -42
data/doc/class_list.html +3 -3
data/doc/css/style.css +3 -2
data/doc/file.README.html +63 -26
data/doc/file_list.html +2 -2
data/doc/frames.html +2 -2
data/doc/index.html +63 -26
data/doc/js/app.js +14 -3
data/doc/method_list.html +708 -236
data/doc/top-level-namespace.html +7 -7
data/lib/term_utils/ap/article.rb +15 -9
data/lib/term_utils/ap/flag.rb +37 -20
data/lib/term_utils/ap/parameter.rb +88 -19
data/lib/term_utils/ap/parser.rb +143 -116
data/lib/term_utils/ap/result.rb +208 -161
data/lib/term_utils/ap/syntax.rb +53 -69
data/lib/term_utils/ap.rb +79 -24
data/lib/term_utils/ff/config.rb +22 -10
data/lib/term_utils/{ap/no_such_value_error.rb → ff/entry.rb} +26 -8
data/lib/term_utils/ff/finder.rb +255 -0
data/lib/term_utils/ff/query.rb +94 -17
data/lib/term_utils/ff.rb +12 -2
data/lib/term_utils/property_tree_node.rb +47 -19
data/lib/term_utils/tab.rb +106 -61
data/lib/term_utils.rb +8 -1
data/term_utils.gemspec +4 -4
metadata +18 -17
data/doc/TermUtils/AP/Element.html +0 -1025
data/doc/TermUtils/AP/Level.html +0 -638
data/doc/TermUtils/AP/NoSuchValueError.html +0 -217
data/lib/term_utils/ap/element.rb +0 -78
data/lib/term_utils/ap/level.rb +0 -57
data/lib/term_utils/ap/parse_error.rb +0 -27
data/lib/term_utils/ap/syntax_error.rb +0 -27
data/lib/term_utils/ff/cursor.rb +0 -153

data/doc/TermUtils/AP/NoSuchValueError.html DELETED Viewed

@@ -1,217 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Exception: TermUtils::AP::NoSuchValueError
-    &mdash; Documentation by YARD 0.9.20
-</title>
-  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "TermUtils::AP::NoSuchValueError";
-  relpath = '../../';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../../_index.html">Index (N)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../AP.html" title="TermUtils::AP (module)">AP</a></span></span>
-     &raquo;
-    <span class="title">NoSuchValueError</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Exception: TermUtils::AP::NoSuchValueError
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">StandardError</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">StandardError</li>
-            <li class="next">TermUtils::AP::NoSuchValueError</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/term_utils/ap/no_such_value_error.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>No such value error.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(msg)  &#x21d2; NoSuchValueError </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>
-<p>A new instance of NoSuchValueError.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    #<strong>initialize</strong>(msg)  &#x21d2; <tt><span class='object_link'><a href="" title="TermUtils::AP::NoSuchValueError (class)">NoSuchValueError</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns a new instance of NoSuchValueError</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-22
-23
-24</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/term_utils/ap/no_such_value_error.rb', line 22</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
-  <span class='kw'>super</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-</div>
-      <div id="footer">
-  Generated on Fri Feb  7 18:54:42 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.5).
-</div>
-    </div>
-  </body>
-</html>

data/lib/term_utils/ap/element.rb DELETED Viewed

@@ -1,78 +0,0 @@
-# frozen-string-literal: true
-#
-# Copyright (C) 2019 Thomas Baron
-#
-# This file is part of term_utils.
-#
-# term_utils is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# term_utils is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
-module TermUtils
-  module AP
-    # Represents a syntax element (abstract).
-    class Element
-      # @return [Symbol]
-      attr_accessor :id
-      # @return [Integer]
-      attr_accessor :min_occurs
-      # @return [Integer]
-      attr_accessor :max_occurs
-      # @return [Array<TermUtils::AP::Flag>]
-      attr_accessor :flags
-      # For dup method.
-      def initialize_dup(other)
-        if other.flags
-          @flags = []
-          other.flags.each do |f|
-            @flags << f.dup
-          end
-        end
-        super
-      end
-      # Finalizes this one. Internal use.
-      # @return [nil]
-      def finalize!(opts = {})
-        raise TermUtils::AP::SyntaxError, "min_occurs must be equal or greater than 0" unless (@min_occurs.is_a? Integer) && (@min_occurs >= 0)
-        raise TermUtils::AP::SyntaxError, "max_occurs must be equal or greater than min_occurs" unless !occur_bounded? || (@max_occurs >= @min_occurs)
-        unless @id
-          opts[:anonymous] += 1
-          @id = "anonymous#{opts[:anonymous]}".intern
-        end
-      end
-      # Tests whether this one has mutiple occurs.
-      # @return [Boolean]
-      def multiple_occurs?
-        (@max_occurs == nil) || (@max_occurs == :infinity) || ((@max_occurs.is_a? Integer) && (@max_occurs > 1))
-      end
-      # Tests whether the number of occurs are fixed.
-      # @return [Boolean]
-      def occur_bounded?
-        (@max_occurs != nil) && (@max_occurs != :infinity) && (@max_occurs.is_a? Integer)
-      end
-      # Tests whether this one is flagged.
-      # @return [Boolean]
-      def flagged?
-        !@flags.empty?
-      end
-      # Adds a new Flag to this one.
-      # @param opts [Hash]
-      # @option opts [String] :label
-      # @option opts [Symbol] :flavor `:anchor`, `:long`, `:short`.
-      # @return [TermUtils::AP::Flag]
-      def define_flag(opts = {}, &block)
-        new_flag = TermUtils::AP::Flag.new(opts)
-        @flags << new_flag
-        block.call(new_flag) if block
-        new_flag
-      end
-    end
-  end
-end

data/lib/term_utils/ap/level.rb DELETED Viewed

@@ -1,57 +0,0 @@
-# frozen-string-literal: true
-#
-# Copyright (C) 2019 Thomas Baron
-#
-# This file is part of term_utils.
-#
-# term_utils is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# term_utils is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
-module TermUtils
-  module AP
-    # Represents an argument list subset. It must lead with a Flag. It has its
-    # own syntax.
-    class Level < TermUtils::AP::Element
-      # @return [TermUtils::AP::Syntax]
-      attr_accessor :syntax
-      # Constructs a new Level.
-      # @param opts [Hash]
-      # @option opts [Symbol] :id
-      # @option opts [Integer] :min_occurs Default value is `0`.
-      # @option opts [Integer] :max_occurs Default value is `1`.
-      def initialize(opts = {})
-        @id = opts.fetch(:id, nil)
-        @min_occurs = opts.fetch(:min_occurs, 0)
-        @max_occurs = opts.fetch(:max_occurs, 1)
-        @flags = []
-        @syntax = TermUtils::AP::Syntax.new
-      end
-      # For dup method.
-      def initialize_dup(other)
-        @syntax = other.syntax.dup
-        super
-      end
-      # Finalizes this one. Internal use.
-      # @return [nil]
-      def finalize!(opts = {})
-        super
-        raise TermUtils::AP::SyntaxError, "level must contain at least one flag" if @flags.empty?
-        @syntax.finalize!(opts)
-      end
-      # Defines the syntax.
-      # @return [TermUtils::AP::Syntax]
-      def define_syntax(&block)
-        block.call(@syntax) if block
-        @syntax
-      end
-    end
-  end
-end

data/lib/term_utils/ap/parse_error.rb DELETED Viewed

@@ -1,27 +0,0 @@
-# frozen-string-literal: true
-#
-# Copyright (C) 2019 Thomas Baron
-#
-# This file is part of term_utils.
-#
-# term_utils is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# term_utils is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
-module TermUtils
-  module AP
-    # Parse error.
-    class ParseError < StandardError
-      def initialize(msg)
-        super
-      end
-    end
-  end
-end

data/lib/term_utils/ap/syntax_error.rb DELETED Viewed

@@ -1,27 +0,0 @@
-# frozen-string-literal: true
-#
-# Copyright (C) 2019 Thomas Baron
-#
-# This file is part of term_utils.
-#
-# term_utils is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# term_utils is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
-module TermUtils
-  module AP
-    # Syntax error.
-    class SyntaxError < StandardError
-      def initialize(msg)
-        super
-      end
-    end
-  end
-end

data/lib/term_utils/ff/cursor.rb DELETED Viewed

@@ -1,153 +0,0 @@
-# frozen-string-literal: true
-#
-# Copyright (C) 2019 Thomas Baron
-#
-# This file is part of term_utils.
-#
-# term_utils is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 of the License.
-#
-# term_utils is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
-module TermUtils
-  # The ff module provides a way to find files.
-  module FF
-    # Represents a query cursor.
-    class Cursor
-      # Represents a directory context.
-      Context = Struct.new(:path, :components, :entries)
-      # @return [Integer]
-      attr_reader :index
-      # @param config [TermUtils::FF::Config]
-      # @param path [String]
-      def initialize(config, path)
-        @config = config
-        @path = path
-        @contexts = []
-        push_context(path)
-        @index = 0
-      end
-      # Starts the query.
-      # @return [TermUtils::FF::Cursor, nil]
-      def bootstrap
-        res = self
-        if @config.min_depth
-          while depth < @config.min_depth
-            res = following0
-            break unless res
-          end
-        end
-        res
-      end
-      # Returns the next cursor.
-      # @return [TermUtils::FF::Cursor, nil]
-      def following
-        res = nil
-        loop do
-          res = following0
-          break unless res
-          if @config.min_depth
-            next if depth < @config.min_depth
-          end
-          if @config.max_depth
-            next if depth > @config.max_depth
-          end
-          @index += 1
-          break
-        end
-        res
-      end
-      # Returns the result associated to this one.
-      # @return [String]
-      def result
-        @contexts.last.path
-      end
-      # @return [Integer]
-      def depth
-        @contexts.last.components.length
-      end
-      # @return [String]
-      def relative_path
-        @contexts.last.components.join("/")
-      end
-      # @return [String]
-      def name
-        @contexts.last.components[-1]
-      end
-      # Returns the path components.
-      # @return [Array<String>]
-      def components
-        @contexts.last.components.dup
-      end
-      private
-      # Returns the next cursor.
-      # @return [TermUtils::FF::Cursor, nil]
-      def following0
-        ctx = @contexts.last
-        if ctx
-          if ctx.entries
-            # Directory.
-            until ctx.entries.empty?
-              name = ctx.entries.first
-              break if accept_name(name)
-              ctx.entries.shift
-            end
-            if ctx.entries.empty?
-              # Walked through every entry of directory.
-              @contexts.pop
-              following0
-            else
-              # Directory entry.
-              new_path = StringIO.new
-              new_path << ctx.path
-              new_path << "/" if ctx.path[-1] != "/"
-              new_path << ctx.entries.first
-              new_components = ctx.components.dup
-              new_components << ctx.entries.first
-              push_context(new_path.string, new_components)
-              ctx.entries.shift
-              self
-            end
-          else
-            # Not directory.
-            @contexts.pop
-            following0
-          end
-        end
-      end
-      # Pushes a new context on the stask.
-      # @param path [String]
-      def push_context(path, components = [])
-        entries = nil
-        if File.directory? path
-          entries = Dir.entries(path)
-          entries.sort! if @config.sorted
-        end
-        @contexts.push(Context.new(path, components, entries))
-      end
-      # Tests whether a given name shall be accepted.
-      # @param name [String]
-      # @return [Boolean]
-      def accept_name(name)
-        if (name != ".") and (name != "..")
-          ret = true
-          @config.ignore_list.each do |i|
-            if i.match? name
-              ret = false
-              break
-            end
-          end
-          ret
-        else
-          false
-        end
-      end
-    end
-  end
-end