envo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54f5c8282f4d3219db6e7a5384316ed1f3fdd3e43d0e99fdfbb6d768436c8445
-  data.tar.gz: a9b2e63f76ae3dd5844694365f8dbdff259c3dcb485374583cbc258b3547a94e
+  metadata.gz: d4cec2ad575a0169c6dacbf43e31fd020f782223a90f18e4e5f88c773e584d8f
+  data.tar.gz: 5d88e738f7b0f1d2c183d1ce420b10e0c4456b94ef9dcededd59f05f8ff75386
 SHA512:
-  metadata.gz: 8638df6a7acbd3bd61c7ea2d717308e3369091f96585367c6fcb2c7b3c88724efc9acb93a14d3e82f9b8808a6e82cb263957290a818da64c65b16d7e945f973b
-  data.tar.gz: 63e000afd0bf3f69394c02f221b92f910714e7e29e2f53fe2d0973e9fa201b552a514f3f68ca03f84c236db0f89ffb4fc7c8c107d5e709a129bd6f3297e9a037
+  metadata.gz: 0ff617b289561c7cfbd31dc75be388b370f5170e8103dc6603be2e58f95e8e6178dc7f1824bf295cc7abe82d8681c80fe16aa7842c13230d0265ab84059309b7
+  data.tar.gz: 739f0a9d752398a92accb8e5ed2c53c3fcbec2b5486ac6c7598fdc1fff777ecf2a0b2a1f5ca7b5e12e90e9a8648d3f71f7747d65336d186a19e544d7880afb03

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Borislav Stanimirov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Envo
+
+A command-line environment variable manager for the current shell session. It works with bash and Windows cmd.
+
+Envo offers several commands to view and change environment variables and also to execute simple scripts composed of those commands, thus allowing the same script for a particular env-var configuration on all supported platforms.
+
+*Envo is still an alpha version. Not all features are complete and not everything is thoroughly tested.*
+
+## Features
+
+A screenshot of `envo path` which displays the path in a "pretty" way. Note the tags, `D` for an entry which is duplicated, and `N` for an entry which is a non-existing path
+
+![Image](doc/screen/bash-path.png)
+
+Use envo with `envo <command> <args>` in your terminal
+
+### Commands
+
+These are select envo commands. For a full list, check the [command reference](doc/commands.md)
+
+* `show <name> ...` - show values of environment variables in a "pretty" format
+* `set <name> = [<value>]` - set a value to an environment variable
+* `unset <name> ...` - unset (delete) an environment variabls
+* `list <name> add <value>` - add an element to an list environment variable (such as `PATH`)
+* `clean <name>` - cleans environment variables. Unsets empty strings, non-existing paths, empty lists. Removes duplicates from lists and non-existing paths from path lists.
+* `run <script>` - runs a simple script of commands. See the [script reference](doc/envoscript.md) on how to write scripts
+
+## Installation
+
+* You need a Ruby interpeter version 2.5 or higher
+    * To check, type `ruby --version` in your terminal
+* Install the ruby gem
+
+```
+$ gem install envo
+```
+
+* Install the envo command
+
+```
+$ envo-install
+```
+
+* *If you're using bash, after the last step you'll need to either restart the session, or source the file in which envo was installed (it will be logged after the installation)*
+
+After this you can type
+
+```
+$ envo --help
+```
+
+... and see the commands and options supported by envo in your terminal.
+
+## Contributing
+
+Issues and pull requests are welcome.
+
+Part of why I created this tool was to refresh my ruby-foo. I hadn't done much ruby programming for years before this. Because of this, envo is not great (not terrible) ruby code. I would welcome PRs or issues which improve the code style and introduce good practices and dev-tooling into the repo.
+
+Please take a look at [the implementation notes](doc/impl-notes.md) and [the roadmap](doc/roadmap.md) if you want to contribute.
+
+## License
+
+This software is distributed under the MIT Software License. See accompanying LICENSE file or copy [here](https://opensource.org/licenses/MIT).
+
+Copyright &copy; 2020 [Borislav Stanimirov](http://github.com/iboB)

data/lib/envo/cmd_clean.rb

@@ -31,7 +31,7 @@ module Envo
       @names = names
     end
 
-    attr_reader :names, :show_names
+    attr_reader :names
 
     def execute(ctx)
       @names.each do |name|

data/lib/envo/cmd_list.rb

@@ -12,6 +12,7 @@ module Envo
         remove a value from a list
         if the provided value is an integer, it's interpreted as an index in the list
       EOF
+      help.add_cmd "list <name> clean", "the same as 'clean <name>' (convenience command)"
     end
 
     def self.register_cli_parser(parser)
@@ -27,6 +28,11 @@ module Envo
       cmd = args.shift
       return CmdListAdd.parse_cli_args(name, args, opts) if cmd == 'add'
       return CmdListDel.parse_cli_args(name, args, opts) if cmd == 'del'
+      if cmd == 'clean'
+        opts += CliParser.filter_opts_back(args)
+        raise Envo::Error.new "list-clean: no args needed. Use 'list <name> clean'" if !args.empty?
+        return CmdClean.parse_tokens([name], opts)
+      end
 
       raise Envo::Error.new "list: unkonwn subcommand #{cmd}"
     end
@@ -43,6 +49,7 @@ module Envo
       cmd = tokens.shift
       return CmdListAdd.parse_script(name, tokens, opts) if cmd == 'add'
       return CmdListDel.parse_tokens(name, tokens, opts) if cmd == 'del'
+      return CmdClean.parse_tokens([name], opts) if cmd == 'clean'
 
       raise Envo::Error.new "list: unkonwn subcommand #{cmd}"
     end

data/lib/envo/version.rb

@@ -1,4 +1,4 @@
 module Envo
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   VERSION_TYPE = 'alpha'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: envo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Borislav Stanimirov
@@ -10,8 +10,9 @@ bindir: bin
 cert_chain: []
 date: 2020-11-14 00:00:00.000000000 Z
 dependencies: []
-description: View, set, unset and manage environment variables (strings, lists, paths)
-  on all platforms.
+description: |
+  A CLI environment variable manager.
+  View, set, unset and manage environment variables (strings, lists, paths) on bash and on cmd.
 email: b.stanimirov@abv.bg
 executables:
 - envo-install
@@ -19,6 +20,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - bin/envo-install
 - bin/envo_gen_tmp_helper.rb
 - bin/envo_run
@@ -65,9 +68,12 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |
-  Thanks for installing envo!
-  For this tool to work, you must also run the installation program: 'envo-install'.
+  Thanks for installing envo v0.1.1 alpha!
+  For the tool to work you must also run the installation program:
+  $ envo-install
   Running it will complete the setup and 'envo' should be available as a command.
+  For help run:
+  $ envo --help
 rdoc_options: []
 require_paths:
 - lib