trees 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21e86099694d3b6b36152f0bfa445d7baa921c4fc1b085c5d2da22fa1d2131e
-  data.tar.gz: c1320e651491ffca5053b1b04a7e797b7633c2253baad83c22fd9b798d38399a
+  metadata.gz: b8afa25fe3a28ca015098f7a3417d41ce8d4a02e80bda91889b9e656fa0df35a
+  data.tar.gz: b52883d15bcd9ebc738c269d4461b035d3bf3d527ec92267b1bbf5eabd0c4fcc
 SHA512:
-  metadata.gz: a0d86359f6a0497932b3a628544b744aeecd8ef9b5f376480e056330ea2c8c3694bfbd8e7c8a4e55634e25a3759e4ee2aec7738288fd5d68eb7c21ad7d66cfb5
-  data.tar.gz: c75011d6796a2c0a8e60061edd75e10b61aaba8649c7755453ae9cba11a2cd2d9267d8e57b494368b32db4d5ac20bba77fcd376098fe9e664e81869d59b26e7a
+  metadata.gz: 03dd4e5487d5d6d79ea979a80ac589240021bda0e71baed1a3789482b605bfbe748aef05cd1b168324e07896248bc86e24da0c956ab59edbd521cf18417819b6
+  data.tar.gz: e1cca79dfaf2810852075f1ce75f1f2bae7296cf154daaf1d85ecd791cc6dc8ddbc46e97bac122d101a655ffcbb443eb0b83442224cb2f15f26299eb71f0f2fe

data/lib/flags.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trees
+  module Flags
+    module_function
+
+    def split(tokens)
+      args = tokens.take_while { !flag?(it) }
+      flags = tokens.drop(args.length).slice_before { flag?(it) }.map { flag(*it) }
+      return if flags.include?(nil)
+
+      [args, flags.to_h]
+    end
+
+    # A dash alone, like for stdin, is an arg.
+    def flag?(token) = token.start_with?('-') && token != '-'
+
+    def flag(token, *values)
+      return if values.size > 1
+
+      name, given = token.sub(/\A--?/, '').split('=', 2)
+      [name.tr('-', '_').to_sym, given || values.first || true]
+    end
+  end
+end

data/lib/line.rb

@@ -2,16 +2,31 @@
 
 module Trees
   class Line
-    attr_reader :path, :params
+    attr_reader :path, :params, :keywords
     attr_accessor :summary, :example, :execute
 
-    def initialize(path:, params: {})
+    def initialize(path:, params: [], keywords: [])
       @path = path
       @params = params
+      @keywords = keywords
 
       @summary = nil
       @example = nil
       @execute = nil
+      @defaults = {}
+    end
+
+    # The keyword arguments' values once the line's defined, which are their defaults, kept so that a flag that isn't
+    # given on a run is its default again, rather than its value from the last run.
+    def keep_defaults
+      @defaults = keywords.to_h { [it, execute.binding.local_variable_get(it)] } if execute
+    end
+
+    # Sets the execute block's params to the values, or else the keyword arguments' defaults, then runs it.
+    def run(values)
+      values = @defaults.merge(values)
+      params.each { |param| execute.binding.local_variable_set(param, values[param]) if values.key?(param) }
+      execute.call
     end
   end
 end

data/lib/trees.rb

@@ -1,24 +1,19 @@
 # frozen_string_literal: true
 
+require_relative 'flags'
 require_relative 'line'
 require_relative 'trie'
 
 module Trees
-  attr_reader :lines, :trie
-
-  TOKEN_SEPARATOR = ' '.freeze
+  TOKEN_SEPARATOR = ' '
 
   def line(path, &block)
     current_path << path
-    current_path_joined = current_path.join(TOKEN_SEPARATOR)
-
-    @current_line = Line.new(path: current_path_joined, params: block.parameters.to_h)
-
-    lines[current_path_joined] = @current_line
-    trie.merge(line: @current_line)
+    defined = define_line(block:)
 
-    block.call if block_given?
+    block.call(**stub_required_keywords(block:)) if block_given?
 
+    defined.keep_defaults
     current_path.pop
   end
 
@@ -37,30 +32,47 @@ module Trees
   end
   alias x execute
 
+  # The tokens match a line as they are, or else its args do, and its flags, in any order, are its keyword arguments.
   def run(tokens)
-    results = trie.match(tokens:)
-    execute_block(results:)
+    return true if execute_block(results: trie.match(tokens:))
+
+    args, flags = Flags.split(tokens)
+    return false if flags.nil? || flags.empty?
+
+    execute_block(results: trie.match(tokens: args), flags:)
   end
 
   private
 
-  def execute_block(results:)
+  # The deepest line that runs, and has a keyword argument for each flag.
+  def execute_block(results:, flags: {})
     while results.count > 0
       result = results.pop
 
-      if result.line.execute
-        result.line.params.values.each do |param|
-          result.line.execute.binding.local_variable_set(param, result.params[param])
-        end
-
-        result.line.execute.call
+      next unless result.line.execute
+      next unless (flags.keys - result.line.keywords).empty?
 
-        return true
-      end
+      result.line.run(result.params.merge(flags))
+      return true
     end
 
     false
-  end  
+  end
+
+  def define_line(block:)
+    path = current_path.join(TOKEN_SEPARATOR)
+    keywords = block.parameters.filter_map { |type, name| name if %i[key keyreq].include?(type) }
+    @current_line = Line.new(path:, params: block.parameters.map(&:last), keywords:)
+
+    lines[path] = @current_line
+    trie.merge(line: @current_line)
+    @current_line
+  end
+
+  # The "line" block defines the params that the "execute" child block will use later but doesn't itself execute user input.
+  def stub_required_keywords(block:)
+    block.parameters.filter_map { |type, name| [name, nil] if type == :keyreq }.to_h
+  end
 
   def current_path
     @current_path ||= []

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trees
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trees
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - maedi
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/flags.rb
 - lib/line.rb
 - lib/trees.rb
 - lib/trie.rb
@@ -41,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A CLI framework where you write the literal terminal commands.
 test_files: []