Merge pull request #231 from DannyBen/refactor/command-scopes

Revert (remove) CommandScopes

Author: DannyBen

edge/Dockerfile

@@ -0,0 +1,13 @@
+FROM dannyben/alpine-ruby
+
+ENV PS1 "\n\n>> bashly \W \$ "
+RUN apk add --no-cache git
+
+WORKDIR /bashly
+RUN git clone --depth 1 https://github.com/DannyBen/bashly.git .
+RUN gem build bashly.gemspec
+RUN gem install bashly*.gem
+
+WORKDIR /app
+VOLUME /app
+ENTRYPOINT ["bashly"]

edge/README.md

@@ -0,0 +1,22 @@
+# Testing Unreleased (Edge) Bashly Versions
+
+If you wish to try a version of bashly straight from GitHub before it is
+released, you can use one of these methods:
+
+## Using Docker
+
+```bash
+alias bashly_edge='docker run --rm -it --user $(id -u):$(id -g) --volume "$PWD:/app" dannyben/bashly:edge'
+```
+
+or build your own image with [this Dockerfile](Dockerfile).
+
+## Using Ruby
+
+```bash
+git clone --depth 1 https://github.com/DannyBen/bashly.git
+cd bashly
+gem build bashly.gemspec
+gem install bashly*.gem
+cd ..
+```

edge/op.conf

@@ -0,0 +1,2 @@
+build: docker build -t dannyben/bashly:edge . && docker images |grep bashly
+push: docker push dannyben/bashly:edge

lib/bashly/concerns/command_scopes.rb

@@ -18,6 +18,22 @@ def view_marker(id = nil)
       "# #{id}" unless Settings.production?
     end
 
+    # Reads a file from the userspace (Settings.source_dir) and returns
+    # its contents. If the file is not found, returns a string with a hint.
+    def load_user_file(file, placeholder: true)
+      path = "#{Settings.source_dir}/#{file}"
+
+      content = if File.exist? path
+        File.read(path).remove_front_matter
+      elsif placeholder
+        %q[echo "error: cannot load file"]
+      else
+        ''
+      end
+
+      Settings.production? ? content : "#{view_marker path}\n#{content}"
+    end
+
   private
 
     def view_path(view)

lib/bashly/concerns/renderable.rb

@@ -2,7 +2,6 @@ module Bashly
   module Script
     class Command < Base
       include Completions::Command
-      include CommandScopes
 
       class << self
         def option_keys
@@ -32,6 +31,16 @@ def aliases
         [name] + alt
       end
 
+      # Returns an array of all full names (including aliases and aliases of
+      # parents)
+      def all_full_names
+        if parent_command
+          parent_command.all_full_names.product(aliases).map { |a| a.join ' ' }
+        else
+          aliases
+        end
+      end
+
       # Returns an array of alternative aliases if any
       def alt
         # DEPRECATION 0.8.0
@@ -57,6 +66,33 @@ def catch_all
         @catch_all ||= CatchAll.from_config options['catch_all']
       end
 
+      # Returns a full list of the Command names and aliases combined
+      def command_aliases
+        commands.map(&:aliases).flatten
+      end
+
+      # Returns a data structure for displaying subcommands help
+      def command_help_data
+        result = {}
+
+        public_commands.each do |command|
+          result[command.group_string] ||= {}
+          result[command.group_string][command.name] = command.summary_string
+          next unless command.expose
+
+          command.public_commands.each do |subcommand|
+            result[command.group_string]["#{command.name} #{subcommand.name}"] = subcommand.summary_string
+          end
+        end
+
+        result
+      end
+
+      # Returns only the names of the Commands
+      def command_names
+        commands.map &:name
+      end
+
       # Returns an array of the Commands
       def commands
         return [] unless options["commands"]
@@ -67,6 +103,40 @@ def commands
         end
       end
 
+      # Returns a flat array containing all the commands in this tree.
+      # This includes self + children + grandchildres + ...
+      def deep_commands
+        result = []
+        commands.each do |command|
+          result << command
+          if command.commands.any?
+            result += command.deep_commands
+          end
+        end
+        result
+      end
+
+      # If any of this command's subcommands has the default option set to
+      # true, this default command will be returned, nil otherwise.
+      def default_command
+        commands.find { |c| c.default }
+      end
+
+      # Returns an array of all the default Args
+      def default_args
+        args.select &:default
+      end
+
+      # Returns an array of all the default Environment Variables
+      def default_environment_variables
+        environment_variables.select &:default
+      end
+
+      # Returns an array of all the default Flags
+      def default_flags
+        flags.select &:default
+      end
+
       # Returns an array of EnvironmentVariables
       def environment_variables
         return [] unless options["environment_variables"]
@@ -109,23 +179,6 @@ def group_string
         end
       end
 
-      # Reads a file from the userspace (Settings.source_dir) and returns
-      # its contents. 
-      # If the file is not found, returns a string with a hint.
-      def load_user_file(file, placeholder: true)
-        path = "#{Settings.source_dir}/#{file}"
-
-        content = if File.exist? path
-          File.read(path).remove_front_matter
-        elsif placeholder
-          %q[echo "error: cannot load file"]
-        else
-          ''
-        end
-
-        Settings.production? ? content : "#{view_marker path}\n#{content}"
-      end
-
       # Returns the Command instance of the direct parent
       def parent_command
         options['parent_command']
@@ -137,11 +190,31 @@ def parents
         options['parents'] || []
       end
 
+      # Returns only commands that are not private
+      def public_commands
+        commands.reject &:private
+      end
+
       # Returns true if one of the args is repeatable
       def repeatable_arg_exist?
         args.select(&:repeatable).any?
       end
 
+      # Returns an array of all the required Arguments
+      def required_args
+        args.select &:required
+      end
+
+      # Returns an array of all the required EnvironmentVariables
+      def required_environment_variables
+        environment_variables.select &:required
+      end
+
+      # Returns an array of all the required Flags
+      def required_flags
+        flags.select &:required
+      end
+
       # Returns true if this is the root command (no parents)
       def root_command?
         parents.empty?
@@ -180,6 +253,15 @@ def user_lib
         @user_lib ||= Dir["#{Settings.full_lib_dir}/**/*.sh"].sort
       end
 
+      # Returns an array of all the args with a whitelist
+      def whitelisted_args
+        args.select &:allowed
+      end
+
+      # Returns an array of all the flags with a whitelist arg
+      def whitelisted_flags
+        flags.select &:allowed
+      end
     end
   end
 end