RubyGems - term_utils - Versions diffs - 0.1.1 → 0.4.0 - Mend

term_utils 0.1.1 → 0.4.0

Files changed (64) hide show

checksums.yaml +4 -4
data/AUTHORS +1 -0
data/CHANGELOG.md +51 -0
data/COPYING +674 -0
data/README.md +99 -0
data/Rakefile +55 -0
data/doc/TermUtils.html +138 -0
data/doc/TermUtils/AP.html +394 -0
data/doc/TermUtils/AP/Article.html +993 -0
data/doc/TermUtils/AP/ArticleResult.html +584 -0
data/doc/TermUtils/AP/Flag.html +756 -0
data/doc/TermUtils/AP/NoSuchValueError.html +217 -0
data/doc/TermUtils/AP/Parameter.html +1592 -0
data/doc/TermUtils/AP/ParameterResult.html +980 -0
data/doc/TermUtils/AP/ParameterWalkerHooks.html +409 -0
data/doc/TermUtils/AP/ParseError.html +217 -0
data/doc/TermUtils/AP/Parser.html +604 -0
data/doc/TermUtils/AP/Result.html +837 -0
data/doc/TermUtils/AP/Syntax.html +761 -0
data/doc/TermUtils/AP/SyntaxError.html +217 -0
data/doc/TermUtils/AP/Walker.html +686 -0
data/doc/TermUtils/FF.html +128 -0
data/doc/TermUtils/FF/Config.html +774 -0
data/doc/TermUtils/FF/Context.html +585 -0
data/doc/TermUtils/FF/Entry.html +626 -0
data/doc/TermUtils/FF/Query.html +1085 -0
data/doc/TermUtils/PropertyTreeNode.html +2113 -0
data/doc/TermUtils/Tab.html +1486 -0
data/doc/TermUtils/Tab/Column.html +1263 -0
data/doc/TermUtils/Tab/Header.html +536 -0
data/doc/TermUtils/Tab/Holder.html +1210 -0
data/doc/TermUtils/Tab/Printer.html +967 -0
data/doc/TermUtils/Tab/Table.html +1966 -0
data/doc/TermUtils/Tab/TableError.html +217 -0
data/doc/_index.html +387 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.README.html +170 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +170 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1539 -0
data/doc/top-level-namespace.html +110 -0
data/lib/term_utils.rb +11 -0
data/lib/term_utils/ap.rb +70 -0
data/lib/term_utils/ap/article.rb +74 -0
data/lib/term_utils/ap/flag.rb +65 -0
data/lib/term_utils/ap/parameter.rb +144 -0
data/lib/term_utils/ap/parser.rb +211 -0
data/lib/term_utils/ap/result.rb +244 -0
data/lib/term_utils/ap/syntax.rb +96 -0
data/lib/term_utils/ff.rb +27 -0
data/lib/term_utils/ff/config.rb +55 -0
data/lib/term_utils/ff/entry.rb +45 -0
data/lib/term_utils/ff/query.rb +145 -0
data/lib/term_utils/property_tree_node.rb +228 -0
data/lib/term_utils/tab.rb +338 -88
data/term_utils.gemspec +16 -0
metadata +69 -7

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.25
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  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</a> &raquo;
+    <span class="title">Top Level Namespace</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>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="TermUtils.html" title="TermUtils (module)">TermUtils</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Sun Aug  2 18:35:09 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.25 (ruby-2.6.5).
+</div>
+    </div>
+  </body>
+</html>

data/lib/term_utils.rb CHANGED

@@ -1,3 +1,7 @@
+# frozen-string-literal: true
+# Copyright (C) 2020 Thomas Baron
+#
 # This file is part of term_utils.
 #
 # term_utils is free software: you can redistribute it and/or modify
@@ -11,4 +15,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
+# Utilities for terminal application.
+module TermUtils
+end
+require 'term_utils/ap'
+require 'term_utils/ff'
 require 'term_utils/tab'

data/lib/term_utils/ap.rb ADDED

@@ -0,0 +1,70 @@
+# frozen-string-literal: true
+# Copyright (C) 2020 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 Argument Parser module provides a way to parse arguments.
+  module AP
+    # NoSuchValueError.
+    class NoSuchValueError < StandardError
+      def initialize(msg)
+        super
+      end
+    end
+    # ParseError.
+    class ParseError < StandardError
+      def initialize(msg)
+        super
+      end
+    end
+    # SyntaxError.
+    class SyntaxError < StandardError
+      def initialize(msg)
+        super
+      end
+    end
+    # Creates a new Syntax.
+    # @return [TermUtils::AP::Syntax]
+    def self.create_syntax(&block)
+      new_syntax = TermUtils::AP::Syntax.new
+      block.call(new_syntax) if block
+      new_syntax
+    end
+    # Parses a given list of arguments.
+    # @param syntax [Syntax]
+    # @param arguments [Array<String>]
+    # @param opts [Hash]
+    # @option opts [Boolean] :strict Whether the Syntax must be considered strict.
+    # @return [Result]
+    # @raise [ParseError]
+    # @raise [SyntaxError]
+    def self.parse_arguments(syntax, arguments, opts = {}, &block)
+      TermUtils::AP::Parser.new.parse_arguments(syntax, arguments, opts, &block)
+    end
+  end
+end
+require 'term_utils/ap/article'
+require 'term_utils/ap/flag'
+require 'term_utils/ap/parameter'
+require 'term_utils/ap/syntax'
+require 'term_utils/ap/result'
+require 'term_utils/ap/parser'

data/lib/term_utils/ap/article.rb ADDED

@@ -0,0 +1,74 @@
+# frozen-string-literal: true
+# Copyright (C) 2020 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 Article.
+    class Article
+      # @return [Symbol]
+      attr_accessor :id
+      # @return [Integer]
+      attr_accessor :min_occurs
+      # @return [Integer]
+      attr_accessor :max_occurs
+      # @return [Symbol] `:integer`, `:string`
+      attr_accessor :type
+      # @return [String] `%d`, `%s`.
+      attr_accessor :format
+      # Constructs a new Article.
+      # @param opts [Hash]
+      # @option opts [Symbol] :id
+      # @option opts [Integer] :min_occurs Default value is `1`.
+      # @option opts [Integer] :max_occurs Default value is `1`.
+      # @option opts [Symbol] :type `:integer`, `:string`.
+      # @option opts [Symbol] :format
+      def initialize(opts = {})
+        @id = opts.fetch(:id, nil)
+        @min_occurs = opts.fetch(:min_occurs, 1)
+        @max_occurs = opts.fetch(:max_occurs, 1)
+        @type = opts.fetch(:type, :string)
+        @format = opts.fetch(:format, '%s')
+      end
+      # Finalizes this one. Internal use.
+      # @return [nil]
+      def finalize!(opts = {})
+        raise TermUtils::AP::SyntaxError, 'min_occurs must be equal or greater than 0' if !@min_occurs.is_a?(Integer) || (@min_occurs < 0)
+        raise TermUtils::AP::SyntaxError, 'max_occurs must be equal or greater than min_occurs' if 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.is_a?(Integer) && (@max_occurs > 1))
+      end
+      # Tests whether the number of occurs is fixed.
+      # @return [Boolean]
+      def occur_bounded?
+        (@max_occurs != nil) && @max_occurs.is_a?(Integer)
+      end
+    end
+  end
+end

data/lib/term_utils/ap/flag.rb ADDED

@@ -0,0 +1,65 @@
+# frozen-string-literal: true
+# Copyright (C) 2020 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 Flag.
+    class Flag
+      # @return [String]
+      attr_reader :label
+      # @return [Symbol] `:long`, `:short`.
+      attr_reader :flavor
+      # Constructs a new Flag.
+      # @param label [String]
+      # @param flavor [Symbol] `:short`, `:long`.
+      def initialize(label, flavor)
+        raise TermUtils::AP::SyntaxError, 'wrong flag label' if !label.is_a?(String) || /^-+$/.match?(label) || !/^-[0-9A-Za-z_-]+$/.match?(label)
+        raise TermUtils::AP::SyntaxError, '' unless %i[short long].include?(flavor)
+        @label = label
+        @flavor = flavor
+      end
+      # Tests whether this one is equal to a given Flag.
+      def ==(other)
+        return false unless other.is_a?(TermUtils::AP::Flag)
+        @label == other.label
+      end
+      # Tests whether this one represents a long flag.
+      # @return [Boolean]
+      def long?
+        @flavor == :long
+      end
+      # Tests whether this one represents a short flag.
+      # @return [Boolean]
+      def short?
+        @flavor == :short
+      end
+      # Returns the string representation of this one.
+      # @return [String]
+      def to_s
+        @label
+      end
+    end
+  end
+end

data/lib/term_utils/ap/parameter.rb ADDED

@@ -0,0 +1,144 @@
+# frozen-string-literal: true
+# Copyright (C) 2020 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 Parameter.
+    class Parameter
+      # @return [Symbol]
+      attr_accessor :id
+      # @return [Integer]
+      attr_accessor :min_occurs
+      # @return [Integer]
+      attr_accessor :max_occurs
+      # @return [Array<Flag>]
+      attr_accessor :flags
+      # @return [Array<Article>]
+      attr_accessor :articles
+      # Constructs a new Parameter.
+      # @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 = []
+        @articles = []
+      end
+      # For dup method.
+      def initialize_dup(other)
+        super(other)
+        @flags = other.flags.map(&:dup) if other.flags
+        @articles = other.articles.map(&:dup) if other.articles
+      end
+      # Finalizes this one. Internal use.
+      # @return [nil]
+      # @raise [SyntaxError]
+      def finalize!(opts = {})
+        raise TermUtils::AP::SyntaxError, 'min_occurs must be equal or greater than 0' if !@min_occurs.is_a?(Integer) || (@min_occurs < 0)
+        raise TermUtils::AP::SyntaxError, 'max_occurs must be equal or greater than min_occurs' if occur_bounded? && (@max_occurs < @min_occurs)
+        raise TermUtils::AP::SyntaxError, 'empty' if @flags.empty? && @articles.empty?
+        unless @id
+          opts[:anonymous] += 1
+          @id = "anonymous#{opts[:anonymous]}".intern
+        end
+        @flags.each do |f|
+          raise TermUtils::AP::SyntaxError, 'duplicate flag label' if opts[:flag_labels].include?(f.to_s)
+          opts[:flag_labels] << f.to_s
+        end
+        @articles.each { |a| a.finalize!(opts) }
+        nil
+      end
+      # Tests whether this one has mutiple occurs.
+      # @return [Boolean]
+      def multiple_occurs?
+        (@max_occurs == nil) || (@max_occurs.is_a?(Integer) && (@max_occurs > 1))
+      end
+      # Tests whether the number of occurs is fixed.
+      # @return [Boolean]
+      def occur_bounded?
+        (@max_occurs != nil) && @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 label [String]
+      # @return [Flag]
+      def define_flag(label, &block)
+        flavor = (label.length == 2) ? :short : :long
+        new_flag = TermUtils::AP::Flag.new(label, flavor)
+        raise TermUtils::AP::SyntaxError, 'duplicate flag label' if @flags.include? new_flag
+        @flags << new_flag
+        block.call(new_flag) if block
+        new_flag
+      end
+      # Adds a new Article to this one.
+      # @param id [Symbol, nil]
+      # @param opts [Hash]
+      # @option opts [Symbol] :id
+      # @option opts [Integer] :min_occurs Default value is `1`.
+      # @option opts [Integer] :max_occurs Default value is `1`.
+      # @option opts [Symbol] :type `:integer`, `:string`.
+      # @option opts [Symbol] :format
+      # @return [Article]
+      def define_article(id = nil, opts = {}, &block)
+        if id
+          art = @articles.find { |p| p.id == id }
+          if art
+            block.call(art) if block
+            return art
+          end
+          opts[:id] = id
+        end
+        new_article = TermUtils::AP::Article.new(opts)
+        @articles << new_article
+        block.call(new_article) if block
+        new_article
+      end
+      # Fetches all flags.
+      # @return [Array<Flag>]
+      def fetch_flags
+        @flags.dup
+      end
+      # Fetches all articles.
+      # @return [Array<Article>]
+      def fetch_articles
+        @articles.collect(&:dup)
+      end
+    end
+  end
+end