term_utils 0.1.1 → 0.2.0

data/lib/term_utils/ff/config.rb

@@ -0,0 +1,43 @@
+# 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 configuration.
+    class Config
+      # @return [Array<Regexp>]
+      attr_accessor :ignore_list
+      # @return [Integer]
+      attr_accessor :min_depth
+      # @return [Integer]
+      attr_accessor :max_depth
+      # @return [Boolean]
+      attr_accessor :sorted
+      def initialize
+        @ignore_list = []
+        @min_depth = nil
+        @max_depth = nil
+        @sorted = false
+      end
+      def initialize_copy(other)
+        @ignore_list = other.ignore_list.dup
+        super
+      end
+    end
+  end
+end

data/lib/term_utils/ff/cursor.rb

@@ -0,0 +1,153 @@
+# 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

data/lib/term_utils/ff/query.rb

@@ -0,0 +1,66 @@
+# 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 file system query.
+    class Query
+      def initialize
+        @config = TermUtils::FF::Config.new
+      end
+      def initialize_copy(other)
+        @config = other.config.dup
+        super
+      end
+      # Adds a Regexp to ignore.
+      # @param regexp [Regexp]
+      # @return [TermUtils::FF::Query]
+      def ignore(regexp)
+        @config.ignore_list << regexp
+        self
+      end
+      # Sets a minimum depth.
+      # @param depth [Integer]
+      # @return [TermUtils::FF::Query]
+      def min_depth(depth)
+        @config.min_depth = depth
+        self
+      end
+      # Sets a maximum depth.
+      # @param depth [Integer]
+      # @return [TermUtils::FF::Query]
+      def max_depth(depth)
+        @config.max_depth = depth
+        self
+      end
+      # Sets whether results shall be sorted.
+      # @param sorted [Boolean]
+      # @return [TermUtils::FF::Query]
+      def sort(sorted = true)
+        @config.sorted = sorted
+        self
+      end
+      # Executes this one.
+      # @param path [String]
+      # @return [TermUtils::FF::Cursor]
+      def exec(path)
+        TermUtils::FF::Cursor.new(@config.dup, path).bootstrap
+      end
+    end
+  end
+end

data/lib/term_utils/ff.rb

@@ -0,0 +1,18 @@
+# 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/>.
+require 'term_utils/ff/config'
+require 'term_utils/ff/cursor'
+require 'term_utils/ff/query'

data/lib/term_utils/tab.rb

@@ -1,3 +1,5 @@
+# Copyright (C) 2019 Thomas Baron
+#
 # This file is part of term_utils.
 #
 # term_utils is free software: you can redistribute it and/or modify
@@ -12,6 +14,7 @@
 # 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 tab module provides a way to print formatted tables.
   module Tab
     # Represents a table.
     class Table
@@ -53,7 +56,6 @@ module TermUtils
       end
       # Creates a new table printer.
       # @param io [IO]
-      # @param values [Array<Object>, Hash<Symbol, Object>]
       # @param opts [Hash]
       # @option opts [Integer] :offset
       # @option opts [Integer] :column_separator_width
@@ -250,12 +252,25 @@ module TermUtils
         @io = io
         @options = options
       end
+      # Prints an empty line.
       def line
         @io.puts ""
       end
+      # Prints a header row.
+      # @param values [Array<Object>, Hash<Symbol, Object>]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [nil]
       def header(values = nil, opts = {})
         @table.print_header(@io, values, @options.merge(opts))
       end
+      # Prints a data row.
+      # @param values [Array<Object>, Hash<Symbol, Object>]
+      # @param opts [Hash]
+      # @option opts [Integer] :offset
+      # @option opts [Integer] :column_separator_width
+      # @return [nil]
       def data(values, opts = {})
         @table.print_data(@io, values, @options.merge(opts))
       end
@@ -299,7 +314,6 @@ module TermUtils
       # Creates a new table printer.
       # @param id [Symbol]
       # @param io [IO]
-      # @param values [Array<Object>, Hash<Symbol, Object>]
       # @param opts [Hash]
       # @option opts [Integer] :offset
       # @option opts [Integer] :column_separator_width
@@ -316,10 +330,15 @@ module TermUtils
     def self.define_table(id, opts = {}, &block)
       @@default_holder.define_table(id, opts = {}, &block)
     end
+    # Finds a table.
+    # @param id [Symbol]
+    # @return [Tab::Table, nil]
+    def self.find_table(id)
+      @@default_holder.find_table(id)
+    end
     # Creates a new table printer.
     # @param id [Symbol]
     # @param io [IO]
-    # @param values [Array<Object>, Hash<Symbol, Object>]
     # @param opts [Hash]
     # @option opts [Integer] :offset
     # @option opts [Integer] :column_separator_width

data/lib/term_utils.rb

@@ -1,3 +1,5 @@
+# Copyright (C) 2019 Thomas Baron
+#
 # This file is part of term_utils.
 #
 # term_utils is free software: you can redistribute it and/or modify
@@ -11,4 +13,5 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
+require 'term_utils/ff'
 require 'term_utils/tab'

data/term_utils.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name         = "term_utils"
+  s.version      = "0.2.0"
+  s.date         = "2019-10-17"
+  s.summary      = "Terminal utilities."
+  s.description  = <<-EOS
+Provides terminal utilities like table formatting.
+EOS
+  s.authors      = ["Thomas Baron"]
+  s.email        = "tvbaron at gmail dot com"
+  s.files        = Dir["lib/**/*.rb", "doc/**/*"] + ["AUTHORS", "CHANGELOG.md", "COPYING", "Rakefile", "README.md", "term_utils.gemspec"]
+  s.homepage     = "https://git.yellowcube.net/tvb/term_utils"
+  s.license      = "GPL-3.0-only"
+  s.required_ruby_version = '>= 2.2.0'
+  s.metadata["yard.run"] = "yri"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: term_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Baron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies: []
 description: 'Provides terminal utilities like table formatting.
 
@@ -18,12 +18,48 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AUTHORS
+- CHANGELOG.md
+- COPYING
+- README.md
+- Rakefile
+- doc/TermUtils.html
+- doc/TermUtils/FF.html
+- doc/TermUtils/FF/Config.html
+- doc/TermUtils/FF/Cursor.html
+- doc/TermUtils/FF/Cursor/Context.html
+- doc/TermUtils/FF/Query.html
+- doc/TermUtils/Tab.html
+- doc/TermUtils/Tab/Column.html
+- doc/TermUtils/Tab/Holder.html
+- doc/TermUtils/Tab/Printer.html
+- doc/TermUtils/Tab/Table.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/term_utils.rb
+- lib/term_utils/ff.rb
+- lib/term_utils/ff/config.rb
+- lib/term_utils/ff/cursor.rb
+- lib/term_utils/ff/query.rb
 - lib/term_utils/tab.rb
+- term_utils.gemspec
 homepage: https://git.yellowcube.net/tvb/term_utils
 licenses:
 - GPL-3.0-only
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -32,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="