term_utils 0.1.1 → 0.4.0

data/lib/term_utils/ap/parser.rb

@@ -0,0 +1,211 @@
+# 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 the argument list parser.
+    class Parser
+      # Constructs a new Parser.
+      def initialize
+      end
+
+      # Parses a given list of arguments.
+      # @param syntax [Syntax]
+      # @param arguments [Array<String>]
+      # @param opts [Hash]
+      # @return [Result]
+      # @raise [ParseError]
+      # @raise [SyntaxError]
+      def parse_arguments(syntax, arguments, opts = {}, &block)
+        syntax = syntax.dup
+        syntax.finalize!
+        arguments = arguments.dup
+        res = TermUtils::AP::Result.new(syntax)
+        catch :done do
+          parse0(res, syntax, arguments, opts)
+        end
+        res.remaining_arguments = arguments
+        res.walk(&block) if block
+        res
+      end
+
+      # Tests whether a given sample matches a shortcut flag.
+      # @param shortcut_flags [Hash<String, Flag>]
+      # @param arg [String]
+      # @return [Array<String>, nil] Replacements on success, nil otherwise.
+      def self.match_shortcut_flag(shortcut_flags, arg)
+        shortcut_flags.each do |label, flag|
+          next unless arg.start_with? label
+
+          return [flag.label, arg[label.length..-1]]
+        end
+
+        nil
+      end
+
+      # Evaluates the added number of min occurs of a given array of articles.
+      # @param articles [Array<TermUtils::AP::Article>]
+      # @return [Integer]
+      def self.eval_article_min_occurs(articles)
+        articles.inject(0) { |acc, a| acc + a.min_occurs }
+      end
+
+      private
+
+      # Parses a given argument list.
+      # @param result [Result]
+      # @param syntax [Syntax]
+      # @param arguments [Array<String>]
+      # @raise [ParseError]
+      def parse0(result, syntax, arguments, opts = {})
+        unflagged_params, flagged_params, shortcut_flags = syntax.fetch_parameters
+        fp_occ = {}
+        syntax.parameters.each { |p| fp_occ[p.id] = 0 if p.flagged? }
+        up_occ = 0
+        loop do
+          break if arguments.empty?
+
+          if arguments.first.start_with?('-') && !%w[- --].include?(arguments.first)
+            # Flagged
+            unless flagged_params.key? arguments.first
+              # Unknown flag
+              # Try shortcut flag
+              flag, arg = self.class.match_shortcut_flag(shortcut_flags, arguments.first)
+              if flag && arg
+                # Shortcut match
+                arguments.shift
+                arguments.unshift arg
+                arguments.unshift flag
+              end
+            end
+            unless flagged_params.key? arguments.first
+              # Unknown flag
+              # End of parsing
+              raise TermUtils::AP::ParseError, 'flagged parameter unexpected' if opts.fetch(:strict, false)
+
+              break
+            end
+
+            param = flagged_params[arguments.first]
+            if param.occur_bounded? && (fp_occ[param.id] >= param.max_occurs)
+              # Max occurs reached
+              raise TermUtils::AP::ParseError, "occur limit reached (#{param.id})" if opts.fetch(:strict, false)
+
+              break
+            end
+
+            fp_occ[param.id] += 1
+            arguments.shift
+            param_res = TermUtils::AP::ParameterResult.new(result, param)
+            parse0_param(param_res, param, arguments)
+          else
+            # Unflagged
+            if unflagged_params.empty?
+              # End of parsing
+              raise TermUtils::AP::ParseError, 'unflagged parameter unexpected' if opts.fetch(:strict, false)
+
+              break
+            end
+
+            param = unflagged_params.first
+            if arguments.first == '--'
+              # End of parameter
+              raise TermUtils::AP::ParseError, "parameter not consumed (#{param.id})" if up_occ < param.min_occurs
+
+              arguments.shift
+              unflagged_params.shift
+              up_occ = 0
+              next
+            end
+
+            up_occ += 1
+            param_res = TermUtils::AP::ParameterResult.new(result, param)
+            case parse0_param(param_res, param, arguments)
+            when :esc_param
+              raise TermUtils::AP::ParseError, "parameter not consumed (#{param.id})" if up_occ < param.min_occurs
+
+              unflagged_params.shift
+              up_occ = 0
+            else
+              if !param.multiple_occurs? || (param.occur_bounded? && (up_occ >= param.max_occurs))
+                unflagged_params.shift
+                up_occ = 0
+              end
+            end
+          end
+        end # loop
+        # Check min occurs
+        syntax.parameters.each do |p|
+          next if result.find_parameters(p.id).length >= p.min_occurs
+
+          raise TermUtils::AP::ParseError, "parameter not consumed (#{p.id})"
+        end
+      end
+
+      # Parses with a given Parameter.
+      # @param result [ParameterResult]
+      # @param param [Parameter]
+      # @param arguments [Array<String>]
+      # @return [Symbol, nil] `:esc_param`, or nil.
+      def parse0_param(result, param, arguments)
+        arts = param.fetch_articles
+        occ = 0
+        loop do
+          break if arts.empty?
+
+          if arguments.empty?
+            # End of arguments
+            raise TermUtils::AP::ParseError, 'article not consumed' if occ < arts.first.min_occurs
+            raise TermUtils::AP::ParseError, 'article not consumed' if self.class.eval_article_min_occurs(arts[1..-1]) > 0
+
+            break
+          end
+
+          if arguments.first == '-'
+            # End of article
+            raise TermUtils::AP::ParseError, 'article not consumed' if occ < arts.first.min_occurs
+
+            arguments.shift
+            arts.shift
+            occ = 0
+            next
+          elsif arguments.first.start_with? '-'
+            # End of parameter
+            raise TermUtils::AP::ParseError, 'article not consumed' if occ < arts.first.min_occurs
+            raise TermUtils::AP::ParseError, 'article not consumed' if self.class.eval_article_min_occurs(arts[1..-1]) > 0
+
+            if arguments.first == '--'
+              arguments.shift
+              return :esc_param
+            end
+
+            break
+          end
+          art = arts.first
+          TermUtils::AP::ArticleResult.new(result, art, arguments.shift)
+          occ += 1
+          if !art.multiple_occurs? || (art.occur_bounded? && (occ >= art.max_occurs))
+            arts.shift
+            occ = 0
+          end
+        end # loop
+        nil
+      end
+    end
+  end
+end

data/lib/term_utils/ap/result.rb

@@ -0,0 +1,244 @@
+# 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 an argument parsing Result.
+    class Result
+      # @return [Syntax]
+      attr_reader :parameter
+      # @return [Array<ParameterResult>]
+      attr_reader :results
+      # @return [Array<String>]
+      attr_accessor :remaining_arguments
+
+      # Constructs a new Result.
+      # @param syntax [Syntax]
+      def initialize(syntax)
+        @syntax = syntax
+        @results = []
+        @remaining_arguments = nil
+      end
+
+      # Adds a ParameterResult.
+      # @param result [ParameterResult]
+      def add_result(result)
+        @results << result
+      end
+
+      # Returns the first ParameterResult for a given parameter id.
+      # @param id [Symbol]
+      # @return [ParameterResult]
+      def find_parameter(id)
+        @results.find { |r| r.param_id == id }
+      end
+
+      # Returns all ParameterResult(s) for a given parameter id.
+      # @param id [Symbol]
+      # @return [Array<ParameterResult>]
+      def find_parameters(id)
+        @results.find_all { |r| r.param_id == id }
+      end
+
+      # Walks through this one.
+      def walk(&block)
+        walker = TermUtils::AP::Walker.new
+        block.call(walker)
+        @results.each do |p|
+          p.results.each do |a|
+            walker.notify_article(a)
+          end
+          walker.notify_parameter(p)
+        end
+        walker.notify_finished(@remaining_arguments)
+      end
+    end
+
+    # Represents a result for a parameter.
+    class ParameterResult
+      # @return [Parameter]
+      attr_accessor :parameter
+      # @return [Array<ArticleResult>]
+      attr_accessor :results
+
+      # Constructs a new ParameterResult.
+      # @param parent [Result]
+      # @param parameter [Parameter]
+      def initialize(parent, parameter)
+        @parent = parent
+        @parent.add_result(self)
+        @parameter = parameter
+        @results = []
+      end
+
+      # Adds an ArticleResult.
+      # @param result [ArticleResult]
+      def add_result(result)
+        @results << result
+      end
+
+      # @return [Symbol]
+      def param_id
+        @parameter.id
+      end
+
+      # Returns the first ArticleResult for a given article id.
+      # @param id [Symbol]
+      # @return [ArticleResult]
+      def find_article(id)
+        @results.find { |r| r.art_id == id }
+      end
+
+      # Returns all ArticleResult(s) for a given article id.
+      # @param id [Symbol]
+      # @return [Array<Result>]
+      def find_articles(id)
+        @results.find_all { |r| r.art_id == id }
+      end
+
+      # Returns the value of the first ArticleResult.
+      # @param id [Symbol] Filter of article id.
+      # @return [Object]
+      def value(id = nil)
+        return @results.first.value unless id
+
+        find_article(id).value
+      end
+
+      # Returns the value of all ArticleResult(s).
+      # @param id [Symbol] Filter of article id.
+      # @return [Array<Object>]
+      def values(id = nil)
+        return @results.map(&:value) unless id
+
+        vals = []
+        @results.each do |r|
+          next if r.art_id != id
+
+          vals << r.values
+        end
+        vals
+      end
+    end
+
+    # Represents a result for an article.
+    class ArticleResult
+      # @return [ParameterResult]
+      attr_accessor :parent
+      # @return [Article]
+      attr_accessor :article
+      # @return [Object]
+      attr_accessor :value
+
+      # Constructs a new ArticleResult.
+      # @param parent [ParameterResult]
+      # @param article [Article]
+      # @param value [Object]
+      def initialize(parent, article, value)
+        @parent = parent
+        @parent.add_result(self)
+        @article = article
+        @value = value
+      end
+
+      # @return [Symbol]
+      def art_id
+        @article.id
+      end
+    end
+
+    # Represents a Result Walker.
+    class Walker
+      # Constructs a new Walker.
+      def initialize
+        @anonymous_parameter_hook = nil
+        @anonymous_article_hook = nil
+        @parameter_hooks = {}
+        @finished_hook = nil
+      end
+
+      # Registers a parameter hook.
+      def parameter(param_id = nil, &block)
+        unless param_id
+          # Anonymous parameter hook
+          @anonymous_parameter_hook = block
+          return
+        end
+
+        @parameter_hooks[param_id] = TermUtils::AP::ParameterWalkerHooks.new unless @parameter_hooks.key?(param_id)
+        @parameter_hooks[param_id].hook = block
+      end
+
+      # Registers an article hook.
+      def article(param_id = nil, art_id = nil, &block)
+        unless param_id
+          # Anonymous article hook
+          @anonymous_article_hook = block
+          return
+        end
+
+        unless art_id
+          # Anonymous article hook
+          @parameter_hooks[param_id] = TermUtils::AP::ParameterWalkerHooks.new unless @parameter_hooks.key?(param_id)
+          @parameter_hooks[param_id].anonymous_article_hook = block
+          return
+        end
+
+        @parameter_hooks[param_id] = TermUtils::AP::ParameterWalkerHooks.new unless @parameter_hooks.key?(param_id)
+        @parameter_hooks[param_id].article_hooks ||= {}
+        @parameter_hooks[param_id].article_hooks[art_id] = block
+      end
+
+      # Registers a walk finished hook.
+      def finished(&block)
+        @finished_hook = block
+      end
+
+      # Calls parameter hooks.
+      def notify_parameter(parameter)
+        # (1of2) ID parameter hook
+        param_hooks = @parameter_hooks[parameter.param_id]
+        param_hooks.hook.call(parameter) if param_hooks && param_hooks.hook
+        # (2of2) Anonymous parameter hook
+        @anonymous_parameter_hook.call(parameter) if @anonymous_parameter_hook
+      end
+
+      # Calls article hooks.
+      def notify_article(article)
+        # (1of2) ID article hook
+        param_hooks = @parameter_hooks[article.parent.param_id]
+        if param_hooks
+          # ID article hook
+          param_hooks.article_hooks[article.art_id].call(article) if param_hooks.article_hooks && param_hooks.article_hooks.key?(article.art_id)
+          # Anonymous article hook
+          param_hooks.anonymous_article_hook.call(article) if param_hooks.anonymous_article_hook
+        end
+        # (2of2) Anonymous article hook
+        @anonymous_article_hook.call(article) if @anonymous_article_hook
+      end
+
+      # Calls finished hook.
+      def notify_finished(remaining_arguments)
+        @finished_hook.call(remaining_arguments) if @finished_hook
+      end
+    end
+
+    # Parameter hooks for Walker.
+    ParameterWalkerHooks = Struct.new('ParameterWalkerHooks', :hook, :anonymous_article_hook, :article_hooks)
+  end
+end