tabry 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8531aa56c6c59a5d678e280ccb39fa8fd891aadac1d4fd194d73cacee20aaa47
-  data.tar.gz: ab532e18804f52824ccebf21667aa8da6416324eaa428d58140b758e22160b6a
+  metadata.gz: 1b1cb912ae500805787b62500d1c4995215bc9e3c8a4ccf32b7224bc4fa227c6
+  data.tar.gz: 68244bb100b3a262527b723b02fd6e73e9158f756bf44df960f8e5bd3d7e4679
 SHA512:
-  metadata.gz: 62d4481040a2c2e06e5f16e0c5ef559fddf4cb6330d61d9962af8295c940d56c40bce23df662dbb168c83c48ed929fe30e1f2bf7e91ddc6fda06595c9576b63c
-  data.tar.gz: 1447eb824ec57c40b4dcc4eaeaefbd1488f514bd10535c7035f3439558f03a1368c1cf1cc7674804d2976ab9dadede3d0a818ff9e87e140cd58f67e983026ffb
+  metadata.gz: 0d6e9694ca66c39e5627eed4e8159ad95510ae1f146221529d068ca92c32d3e9d3d3208d7da59909467f2833fcf0a064735e49c75816e3b11741fe659bf8d92f
+  data.tar.gz: 0572051e1da3fa757609b2c5e956f745f434487e089268db318c1410f72e32a5bf906d4a4a4277cc23a40b77ed64ac8d41b1ebcb9fa0a78c0d0cff3c382c81f9

data/bin/tabry-bash

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Run by the tabry_bash_core.sh bash tab completion function to plug into Tabry
+# to get completion options.
+
 require "shellwords"
 require "yaml"
 require_relative "../lib/tabry/util"

data/bin/tabry-help

@@ -5,7 +5,7 @@ require_relative "../lib/tabry/runner"
 
 # Show usage information stored in a tabry configuration.
 #
-# For ease of use, source sh/tabry_bash_help.sh so you can just do
+# For ease of use, source sh/bash/tabry_bash_help.sh so you can just do
 # "help mycmd"
 
 raise "Usage: tabry-help config_name [arg1 [arg2]]..." unless ARGV.length >= 1

data/lib/tabry/config_loader.rb

@@ -21,9 +21,16 @@ module Tabry
     def load
       return load_from_file(name) if name =~ /\.json$/i || name =~ /\.ya?ml$/i
 
-      load_paths.each do |dir|
+      load_paths.each do |path|
         EXTENSIONS.each do |extension|
-          filename = "#{dir}/#{name}.#{extension}"
+          basename = "/#{name}.#{extension}"
+
+          # First check if the path _is_ the file "mycmd.json", "mycmd.yml" we are looking for
+          return load_from_file(path) if path.end_with?(basename) && File.exist?(path)
+
+          # Then look for a file "mycmd.json", "mycmd.yml" etc. in the
+          # directory (assuming it is a directory)
+          filename = "#{path}/#{basename}"
           return load_from_file(filename) if File.exist?(filename)
         end
       end

data/lib/tabry/shells/bash.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Used to generate a tab-completion function for a Tabry CLI using absolute
+# paths to the tabry-bash script in this repo and to the Tabry JSON/YML file.
+# Using uniquely-named tab-completion functions and absolute paths means you can
+# have different Tabry-based CLIs using different versions of Tabry without any
+# conflicts.
+# See sh/bash/README.md and "Adding Tab Completion to your CLI" in main README
+
+module Tabry
+  module Shells
+    module Bash
+      # NOTE! This code uses sh/bash/tabry_bash_core.sh and is described in
+      # sh/bash/README.md; see that README for more info
+      def self.generate(cmd_name, tabry_file_path)
+        capitalized_cmd_name = cmd_name.upcase.gsub(/[^a-zA-Z0-9_]/, "_")
+        tabry_file = Shellwords.escape(File.expand_path(tabry_file_path))
+        path_to_tabry = Shellwords.escape(File.expand_path("#{__dir__}/../../../"))
+
+        core = File.read("#{__dir__}/../../../sh/bash/tabry_bash_core.sh")
+        core.gsub! "_tabry_completions_internal()", "_tabry_#{capitalized_cmd_name}_completions_internal()"
+
+        <<~END_BASH_CODE_TEMPLATE + core
+          # The following Autocomplete is for a Tabry-powered command. It was
+          # generated by the command itself. See the documentation located in
+          # #{path_to_tabry}/sh/bash/README.md
+          _tabry_#{capitalized_cmd_name}_completions() {
+            TABRY_IMPORTS_PATH=#{tabry_file} _tabry_#{capitalized_cmd_name}_completions_internal #{path_to_tabry}/bin/tabry-bash
+          }
+          complete -F _tabry_#{capitalized_cmd_name}_completions #{Shellwords.escape cmd_name}
+        END_BASH_CODE_TEMPLATE
+      end
+    end
+  end
+end

data/lib/tabry/usage_generator.rb

@@ -97,11 +97,11 @@ module Tabry
         lines << ""
         lines << "FLAGS".green.bold
         if sub != sub_stack.last
-          lines.last << if full_sub_name == ""
-                          " (global)".green.bold
-                        else
-                          " (#{full_sub_name})".green.bold
-                        end
+          lines[-1] += if full_sub_name == ""
+                         " (global)".green.bold
+                       else
+                         " (#{full_sub_name})".green.bold
+                       end
         end
 
         sub.flags.map(&:name).sort.each do |name|

data/sh/bash/README.md

@@ -0,0 +1,36 @@
+# Tabry Bash glue
+
+This directory contains code needed to make Tabry autocomplete work with bash.
+The code here is basically glue code needed to connect bash's autocomplete
+framework with Tabry (which does all the work of generating tab completion
+options). Additionally, `tabry_bash_help.sh` is provided to override bash's
+help command to provide help to commands that have tabry completion.
+
+# Quickstart for adding Tab completion
+* To add Tabry to non-tabry based CLIs, follow the instructions in `tabry_bash.sh`
+* For Tabry-based CLIs, run "mycmd completion bash" and add the code to your `~/.bash_profile`
+
+# Tabry Bash autocompletion technical overview
+The main bash function which calls out to tabry to provide tab completion options is in
+`tabry_bash_core.sh`. This defines a function called
+`_tabry_completions_internal`. **If editing the file, it is important you
+do not rename this function or add lines starting with this function name
+without understanding the substitution as mentioned below.**
+
+This file and bash function contained within is used in two ways:
+* For Ruby CLIs written using tabry, this is renamed to to
+  `_tabry_MYCOMMAND_completions_internal`, and a bit of extra bash code is
+  added on, to make tab completion specific for the program. This is generated
+  for each command when the user runs "mycommand completion bash", which calls
+  `Tabry::Shells::Bash.generate`. A new function for each CLI so different CLIs
+  can use different versions of tabry without interfering with each other.
+  The name `_tabry_completions_internal_` is replaced in
+  `lib/tabry/shells/bash.rb` in the `generate` method, so if modifying
+  `tabry_bash_core.sh`, you should if make sure the substitution still works
+  properly.
+  See also "Adding Tab Completion to your CLI" in the main README.
+* You can also use Tabry to add tab completion to other non-Tabry CLIs. In this
+  case, the `_tabry_completions_internal_` function is used as-is; it is
+  sourced from `tabry_bash.sh`. See `tabry_bash.sh` for details and
+  instructions on how to use it.
+

data/sh/bash/tabry_bash.sh

@@ -0,0 +1,22 @@
+# Use this file to use Tabry tab completion with non-Tabry CLIs. To do this,
+# source this file in your bash_profile and add lines like
+# `complete -F _tabry_completions somecli` for each CLI. You will also
+# need the tabry JSON/YML files in ~/.tabry/ or in a path in your
+# TABRY_IMPORTS_PATH. For instance, to add tab completion to vaulted and
+# rapture, you can add this to your ~/.bash_profile:
+#
+#   source /path/to/tabry/sh/bash/tabry_bash.sh
+#   complete -F _tabry_completions rapture
+#   complete -F _tabry_completions vaulted
+#
+# Then be sure to either copy tabry/examples/tabry/vaulted.json and rapture.json to ~/.tabry/,
+# or set TABRY_IMPORTS_PATH in ~/.bash_profile like so:
+#
+#   TABRY_IMPORTS_PATH=$TABRY_IMPORTS_PATH:/path/to/tabry/examples/tabry/
+#
+
+source "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/tabry_bash_core.sh
+_tabry_completions() {
+  _tabry_completions_internal "$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/../../bin/tabry-bash
+}
+

data/sh/{tabry_bash.sh → bash/tabry_bash_core.sh}

@@ -1,19 +1,14 @@
-#/usr/bin/env bash
-
-# Bash completion
-# _tabry_completions function is same for any command you use with tabry, you just need
-# to do `complete -F _tabry_completions mycmd` for your command. This calls the tabry-bash
-# ruby script. For more info see LANGUAGE_REFERENCE.md
-
-_tabry_bash="$( dirname "${BASH_SOURCE[0]:-${(%):-%x}}" )"/../bin/tabry-bash
-
-_tabry_completions()
+# For more information, or before editing the tabry_bash_core.sh source file,
+# See sh/bash/README.md and sh/bash/tabry_bash.sh in the tabry gem
+_tabry_completions_internal()
 {
+  local tabry_bash="$1"
+
   [[ -n "$TABRY_DEBUG" ]] && echo && echo -n tabry start bash: && date +%s.%N >&2
   local saveifs="$IFS"
   IFS=$'\n'
 
-  local result=`"$_tabry_bash" "$COMP_LINE" "$COMP_POINT"`
+  local result=`ruby "$tabry_bash" "$COMP_LINE" "$COMP_POINT"`
   local specials
 
   if [[ $result == *$'\n'$'\n'* ]]; then
@@ -54,8 +49,3 @@ _tabry_completions()
   [[ -n "$TABRY_DEBUG" ]] && echo -n tabry end bash: && date +%s.%N >&2
 }
 
-# To use: put a .json/.yml tabry config file in ~/.tabry (e.g. ~/.aws.json)
-# Then, run this script in your shell startup scripts, plus (e.g.)
-#
-# complete -F _tabry_completions aws
-

data/sh/{tabry_bash_help.sh → bash/tabry_bash_help.sh}

@@ -1,7 +1,7 @@
 # 'help mycommand' -> show tabry help for a tabry-CLI or command you have a
 # tabry tab completion config for
 
-_tabry_help="$( dirname "${BASH_SOURCE[0]}" )"/../bin/tabry-help
+_tabry_help="$( dirname "${BASH_SOURCE[0]}" )"/../../bin/tabry-help
 help() {
   tabry-help "$@" 2>/dev/null || command help "$@"
 }

data/spec/tabry/config_loader_spec.rb

@@ -24,22 +24,28 @@ describe Tabry::ConfigLoader do
   describe "use of $TABRY_IMPORTS_PATH" do
     before { ENV["TABRY_IMPORTS_PATH"] = "#{__dir__}/../fixtures/" }
 
-    it "looks for yaml files in TABRY_IMPORTS_PATH" do
+    it "looks for yaml files in directories in TABRY_IMPORTS_PATH" do
       config = described_class.load(name: "vehicles")
       expect(config.main.subs.map(&:name)).to eq(
         %w[build list-vehicles move sub-with-sub-or-arg sub-with-mandatory-flag]
       )
     end
 
-    it "looks for json files in TABRY_IMPORTS_PATH" do
+    it "looks for json files in directories in TABRY_IMPORTS_PATH" do
       config = described_class.load(name: "basiccli")
       expect(config.main.subs.map(&:name)).to eq(%w[foo])
     end
 
-    it "looks for yml files in TABRY_IMPORTS_PATH" do
+    it "looks for yml files in directories in TABRY_IMPORTS_PATH" do
       config = described_class.load(name: "basiccli2")
       expect(config.main.subs.map(&:name)).to eq(%w[waz])
     end
+
+    it "looks for json files in TABRY_IMPORTS_PATH" do
+      ENV["TABRY_IMPORTS_PATH"] = "#{__dir__}/../fixtures/basiccli.json"
+      config = described_class.load(name: "basiccli")
+      expect(config.main.subs.map(&:name)).to eq(%w[foo])
+    end
   end
 
   describe "use of $HOME" do

data/tabry.gemspec

@@ -6,18 +6,38 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "tabry"
-  s.version     = "0.1.0"
+  s.version     = "0.1.3"
   s.summary     = "Tab completion and CLIs extraordinaire"
   s.authors     = ["Evan Battaglia"]
   s.email       = "battaglia.evan@gmail.com"
   s.homepage    = "https://github.com/evanbattaglia/tabry"
   s.license     = "MIT"
 
-  s.files         = Dir.glob("{lib,bin,sh,spec}/**/*") + %w[tabry.gemspec]
+  treesitter_files = %w[
+    binding.gyp
+    bindings/**/*
+    Cargo.toml
+    corpus/**/*
+    grammar.js
+    jest_fixtures/**/*
+    package.json
+    parser_compile.sh
+    README.md
+    src/**/*
+    tabry-compile.js
+    tabry-compile.test.js
+  ]
+
+  s.files         = Dir.glob("{lib,bin,sh,spec}/**/*") + %w[tabry.gemspec] +
+                    treesitter_files.map { |path| Dir.glob("treesitter/#{path}") }
+
   # TODO: more cargo cult possibly:
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  # Currently, to get tab completions, we run tabry without bundler. This makes
+  # it much faster, but requires it have no dependencies.
+
   s.add_development_dependency "pry-byebug", "~> 3.10"
   s.add_development_dependency "rspec", "~> 3.10"
   s.add_development_dependency "rubocop", "~> 1.22"

data/treesitter/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "tree-sitter-tabry"
+description = "tabry grammar for the tree-sitter parsing library"
+version = "0.0.1"
+keywords = ["incremental", "parsing", "tabry"]
+categories = ["parsing", "text-editors"]
+repository = "https://github.com/tree-sitter/tree-sitter-tabry"
+edition = "2018"
+license = "MIT"
+
+build = "bindings/rust/build.rs"
+include = [
+  "bindings/rust/*",
+  "grammar.js",
+  "queries/*",
+  "src/*",
+]
+
+[lib]
+path = "bindings/rust/lib.rs"
+
+[dependencies]
+tree-sitter = "~0.20.0"
+
+[build-dependencies]
+cc = "1.0"

data/treesitter/README.md

@@ -0,0 +1,4 @@
+This directory contains the compiler which compiles `*.tabry` files -- Tabry's
+mini-language for describing tab-completion/CLIs, into the JSON format used by
+the tabry gem. See the [main Tabry README](../README.md) for more info on
+compiling and using configs.

data/treesitter/binding.gyp

@@ -0,0 +1,19 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_tabry_binding",
+      "include_dirs": [
+        "<!(node -e \"require('nan')\")",
+        "src"
+      ],
+      "sources": [
+        "bindings/node/binding.cc",
+        "src/parser.c",
+        # If your language uses an external scanner, add it here.
+      ],
+      "cflags_c": [
+        "-std=c99",
+      ]
+    }
+  ]
+}

data/treesitter/bindings/node/binding.cc

@@ -0,0 +1,28 @@
+#include "tree_sitter/parser.h"
+#include <node.h>
+#include "nan.h"
+
+using namespace v8;
+
+extern "C" TSLanguage * tree_sitter_tabry();
+
+namespace {
+
+NAN_METHOD(New) {}
+
+void Init(Local<Object> exports, Local<Object> module) {
+  Local<FunctionTemplate> tpl = Nan::New<FunctionTemplate>(New);
+  tpl->SetClassName(Nan::New("Language").ToLocalChecked());
+  tpl->InstanceTemplate()->SetInternalFieldCount(1);
+
+  Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
+  Local<Object> instance = constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
+  Nan::SetInternalFieldPointer(instance, 0, tree_sitter_tabry());
+
+  Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("tabry").ToLocalChecked());
+  Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
+}
+
+NODE_MODULE(tree_sitter_tabry_binding, Init)
+
+}  // namespace

data/treesitter/bindings/node/index.js

@@ -0,0 +1,19 @@
+try {
+  module.exports = require("../../build/Release/tree_sitter_tabry_binding");
+} catch (error1) {
+  if (error1.code !== 'MODULE_NOT_FOUND') {
+    throw error1;
+  }
+  try {
+    module.exports = require("../../build/Debug/tree_sitter_tabry_binding");
+  } catch (error2) {
+    if (error2.code !== 'MODULE_NOT_FOUND') {
+      throw error2;
+    }
+    throw error1
+  }
+}
+
+try {
+  module.exports.nodeTypeInfo = require("../../src/node-types.json");
+} catch (_) {}

data/treesitter/bindings/rust/build.rs

@@ -0,0 +1,40 @@
+fn main() {
+    let src_dir = std::path::Path::new("src");
+
+    let mut c_config = cc::Build::new();
+    c_config.include(&src_dir);
+    c_config
+        .flag_if_supported("-Wno-unused-parameter")
+        .flag_if_supported("-Wno-unused-but-set-variable")
+        .flag_if_supported("-Wno-trigraphs");
+    let parser_path = src_dir.join("parser.c");
+    c_config.file(&parser_path);
+
+    // If your language uses an external scanner written in C,
+    // then include this block of code:
+
+    /*
+    let scanner_path = src_dir.join("scanner.c");
+    c_config.file(&scanner_path);
+    println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
+    */
+
+    c_config.compile("parser");
+    println!("cargo:rerun-if-changed={}", parser_path.to_str().unwrap());
+
+    // If your language uses an external scanner written in C++,
+    // then include this block of code:
+
+    /*
+    let mut cpp_config = cc::Build::new();
+    cpp_config.cpp(true);
+    cpp_config.include(&src_dir);
+    cpp_config
+        .flag_if_supported("-Wno-unused-parameter")
+        .flag_if_supported("-Wno-unused-but-set-variable");
+    let scanner_path = src_dir.join("scanner.cc");
+    cpp_config.file(&scanner_path);
+    cpp_config.compile("scanner");
+    println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
+    */
+}

data/treesitter/bindings/rust/lib.rs

@@ -0,0 +1,52 @@
+//! This crate provides tabry language support for the [tree-sitter][] parsing library.
+//!
+//! Typically, you will use the [language][language func] function to add this language to a
+//! tree-sitter [Parser][], and then use the parser to parse some code:
+//!
+//! ```
+//! let code = "";
+//! let mut parser = tree_sitter::Parser::new();
+//! parser.set_language(tree_sitter_tabry::language()).expect("Error loading tabry grammar");
+//! let tree = parser.parse(code, None).unwrap();
+//! ```
+//!
+//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
+//! [language func]: fn.language.html
+//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
+//! [tree-sitter]: https://tree-sitter.github.io/
+
+use tree_sitter::Language;
+
+extern "C" {
+    fn tree_sitter_tabry() -> Language;
+}
+
+/// Get the tree-sitter [Language][] for this grammar.
+///
+/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
+pub fn language() -> Language {
+    unsafe { tree_sitter_tabry() }
+}
+
+/// The content of the [`node-types.json`][] file for this grammar.
+///
+/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
+pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");
+
+// Uncomment these to include any queries that this grammar contains
+
+// pub const HIGHLIGHTS_QUERY: &'static str = include_str!("../../queries/highlights.scm");
+// pub const INJECTIONS_QUERY: &'static str = include_str!("../../queries/injections.scm");
+// pub const LOCALS_QUERY: &'static str = include_str!("../../queries/locals.scm");
+// pub const TAGS_QUERY: &'static str = include_str!("../../queries/tags.scm");
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_can_load_grammar() {
+        let mut parser = tree_sitter::Parser::new();
+        parser
+            .set_language(super::language())
+            .expect("Error loading tabry language");
+    }
+}

data/treesitter/corpus/arg.txt

@@ -0,0 +1,96 @@
+==============
+Arg with two opts
+==============
+
+arg {
+  opts const "hello \"world\""
+  opts const abc
+}
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (block
+      (opts_const_statement (string))
+      (opts_const_statement (string)))))
+
+==============
+Named args
+==============
+
+arg foo
+arg foo @whatever
+arg foo @whatever {
+  opts const abc
+}
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string)))
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string))
+    (at_identifier))
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string))
+    (at_identifier)
+    (block
+      (opts_const_statement (string)))))
+
+============
+Name and description
+============
+
+arg foo "my description"
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string))
+    (string)))
+
+============
+Names and description
+============
+
+arg (foo bar) "my description"
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string) (string))
+    (string)))
+
+============
+Optional arg
+============
+
+opt arg
+opt arg foo @whatever {
+  opts const abc
+}
+
+---
+
+(source_file
+  (arg_statement
+    (arg_modifier)
+    (arg_type))
+  (arg_statement
+    (arg_modifier)
+    (arg_type)
+    (arg_name_list (string))
+    (at_identifier)
+    (block
+      (opts_const_statement (string)))))
+

data/treesitter/corpus/at.txt

@@ -0,0 +1,79 @@
+==========
+At include
+==========
+
+sub ok {
+  arg {
+    include @foo
+    opts const abc
+  }
+}
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list (string))
+    (block
+      (arg_statement
+        (arg_type)
+        (block
+          (include_statement
+            (at_identifier))
+          (opts_const_statement
+            (string)))))))
+
+=============
+At definition
+=============
+
+defopts @bar {
+  opts const def
+}
+
+defargs @foo {
+  arg
+}
+
+---
+
+(source_file
+  (defopts_statement
+    (at_identifier)
+    (block
+      (opts_const_statement (string))))
+  (defargs_statement
+    (at_identifier)
+    (block
+      (arg_statement
+        (arg_type)))))
+
+=================
+Inline at include
+=================
+
+sub whatever @foo {
+  flagarg foo @wombat
+  arg @bar {
+    opts const abc
+  }
+}
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list (string))
+    (at_identifier)
+    (block
+      (flagarg_statement
+        (flag_name_list (string))
+        (at_identifier))
+      (arg_statement
+        (arg_type)
+        (at_identifier)
+        (block
+          (opts_const_statement
+            (string)))))))
+
+

data/treesitter/corpus/comment.txt

@@ -0,0 +1,13 @@
+========
+Comments
+========
+
+# hello
+sub foo # ok
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list
+      (string))))