cheftacular 2.8.0 → 2.9.0

data/lib/cheftacular/stateless_actions/cheftacular_config.rb

@@ -2,20 +2,24 @@
 class Cheftacular
   class StatelessActionDocumentation
     def cheftacular_config
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft cheftacular_config [display|sync|overwrite]` this command " +
         "Allows you to interact with your complete cheftacular configuration, the union of all repository's cheftacular.ymls. ",
 
         [
           "    1. `display` will show the current overall configuration for cheftacular.",
 
-          "    2. `sync` will sync your local cheftacular yaml keys ONTO the server's keys. This happens automatically whenever a " +
-          "difference is detected between the local keys and the remote keys but can be run manually. Will send a slack notification " +
+          "    2. `diff` will show the difference between your current cheftacular.yml and the server's. Run automatically on a sync.",
+
+          "    3. `sync` will sync your local cheftacular yaml keys ONTO the server's keys. Will send a slack notification " +
           "if slack is configured (the slack notification contains the diffed keys). The sync only occurs if there are CHANGES to the file."
         ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Allows you to see the overall cheftacular config or force a sync'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 
@@ -34,7 +38,25 @@ class Cheftacular
       ap(@config['cheftacular'], {indent: 2})
     end
 
+    def cheftacular_config_diff
+      diff_hash = @config['initial_cheftacular_yml'].deep_diff(@config['default']['cheftacular_bag_hash'], true).except('mode', 'default_repository').compact
+
+      diff_hash.each_pair do |key, value|
+        diff_hash.delete(key) if value.empty? || value.nil?
+      end
+
+      if @config['helper'].running_in_mode?('devops') && !diff_hash.empty?
+        puts "Difference detected between local cheftacular.yml and data bag cheftacular.yml! Displaying..."
+
+        ap diff_hash
+      elsif @config['helper'].running_in_mode?('application') && @config['default']['cheftacular_bag_hash']['slack']['webhook'] && !diff_hash.empty?
+        @config['slack_queue'] << diff_hash.awesome_inspect({plain: true, indent: 2}).prepend('```').insert(-1, '```')
+      end
+    end
+
     def cheftacular_config_sync
+      cheftacular_config_diff
+
       parsed_cheftacular = Digest::SHA2.hexdigest(@config['helper'].get_cheftacular_yml_as_hash.to_s)
 
       return true if File.exist?(@config['filesystem'].local_cheftacular_file_cache_path) && File.read(@config['filesystem'].local_cheftacular_file_cache_path) == parsed_cheftacular

data/lib/cheftacular/stateless_actions/cheftacular_yml_help.rb

@@ -0,0 +1,31 @@
+
+class Cheftacular
+  class StatelessActionDocumentation
+    def cheftacular_yml_help
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
+        "[NYI]`cft cheftacular_yml_help KEY` this command" +
+        "allows you to get help on the meaning of each key in your cheftacular.yml overall config.",
+
+        [
+          "    1. This command can also by run with `cft yaml_help`."
+        ]
+      ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = '[NYI]Gives help on the keys in your cheftacular.yml'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
+    end
+  end
+
+  class StatelessAction
+    def cheftacular_yml_help command=''
+      raise "Not Yet Implemented"
+
+    end
+
+    alias_method :yaml_help, :cheftacular_yml_help
+
+    private
+  end
+end

data/lib/cheftacular/stateless_actions/clean_cookbooks.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def clean_cookbooks
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft clean_cookbooks [force] [remove_cookbooks]` allows you to update the internal chef-repo's cookbooks easily. " +
         "By default this script will force you to decide what to do with each cookbook individually (shows version numbers and whether to overwrite it to cookbooks or not).",
 
@@ -12,6 +13,8 @@ class Cheftacular
           "    2. If you would like to remove all the cookbooks on the chef server, run `knife cookbook bulk delete '.*' -p -c ~/.chef/knife.rb`"
         ]
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Allows you to update all cookbooks via berkshelf'
     end
   end
 
@@ -35,43 +38,9 @@ class Cheftacular
         out = `berks install`
         puts "#{out}\nFinished... Beginning directory scanning and conflict resolution..."
 
-        berkshelf_cookbooks = {}
-
-        Dir.foreach(@config['locs']['berks']) do |berkshelf_cookbook|
-          next if @config['filesystem'].is_junk_filename?(berkshelf_cookbook)
-          skip = false
-
-          berkshelf_cookbooks.keys.each do |processed_berkshelf_cookbook|
-            if processed_berkshelf_cookbook.rpartition('-').first == berkshelf_cookbook.rpartition('-').first
-              cookbook_mtime  = File.mtime(File.expand_path("#{ @config['locs']['berks'] }/#{ berkshelf_cookbook }"))
-              pcookbook_mtime = File.mtime(File.expand_path("#{ @config['locs']['berks'] }/#{ processed_berkshelf_cookbook }"))
-
-              skip = true if cookbook_mtime < pcookbook_mtime #get only the latest version, berkshelf pulls in multiple commits from git repos for SOME REASON
-            end
-          end
-
-          next if skip
-
-          berkshelf_cookbooks[berkshelf_cookbook] = if File.exists?(File.expand_path("#{ @config['locs']['berks'] }/#{ berkshelf_cookbook }/metadata.rb"))
-                                                      File.read(File.expand_path("#{ @config['locs']['berks'] }/#{ berkshelf_cookbook }/metadata.rb")).gsub('"',"'").gsub(/^version[\s]*('\d[.\d]+')/).peek[/('\d[.\d]+')/].gsub("'",'')
-                                                    else
-                                                      berkshelf_cookbook.split('-').last
-                                                    end
-        end
-
-        chef_repo_cookbooks = {}
-
-        Dir.foreach(@config['locs']['cookbooks']) do |chef_repo_cookbook|
-          next if @config['filesystem'].is_junk_filename?(chef_repo_cookbook)
-            
-          new_name = chef_repo_cookbook.rpartition('-').first
+        berkshelf_cookbooks = @config['filesystem'].parse_latest_berkshelf_cookbook_versions
 
-          chef_repo_cookbooks[chef_repo_cookbook] = if File.exists?(File.expand_path("#{ @config['locs']['cookbooks'] }/#{ chef_repo_cookbook }/metadata.rb"))
-                                                      File.read(File.expand_path("#{ @config['locs']['cookbooks'] }/#{ chef_repo_cookbook }/metadata.rb")).gsub('"',"'").gsub(/^version[\s]*('\d[.\d]+')/).peek[/('\d[.\d]+')/].gsub("'",'')
-                                                    else
-                                                      JSON.parse(File.read(File.expand_path("#{ @config['locs']['cookbooks'] }/#{ chef_repo_cookbook }/metadata.json"))).to_hash['version']
-                                                    end
-        end
+        chef_repo_cookbooks = @config['filesystem'].parse_chef_repo_cookbook_versions
 
         berkshelf_cookbooks.each_pair do |berkshelf_cookbook, version|
           new_name = berkshelf_cookbook.rpartition('-').first

data/lib/cheftacular/stateless_actions/clear_caches.rb

@@ -2,11 +2,18 @@
 class Cheftacular
   class StatelessActionDocumentation
     def clear_caches
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft clear_caches` this command allows you to clear all of your local caches.",
+
+        [
+          "    1. This command will force you to refetch all previously cached chef server data on the next `cft` run."
+        ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Clears all cheftacular caches'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/client_list.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def client_list
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft client_list` Allows you check the basic information for all the servers setup via chef. " +
         "Shows the server's short name, its public ip address and roles (run_list) by default.",
 
@@ -17,7 +18,9 @@ class Cheftacular
         ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Retrieves useful information for all servers in all environments'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/cloud.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def cloud
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft cloud <FIRST_LEVEL_ARG> [<SECOND_LEVEL_ARG>[:<SECOND_LEVEL_ARG_QUERY>]*] ` this command handles talking to various cloud APIs. " +
         "If no args are passed nothing will happen.",
 
@@ -114,6 +115,8 @@ class Cheftacular
           "exists on DigitalOcean under a different name, this specific command will fail with a generic error. Please check your keys."
         ]
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Retrieves useful information about cloud services being used'
     end
   end
 

data/lib/cheftacular/stateless_actions/cloud_bootstrap.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def cloud_bootstrap
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft cloud_bootstrap NODE_NAME FLAVOR_NAME [DESCRIPTOR] [--with-dn DOMAIN]` uses a cloud api to " +
         "create a server and attaches its DOMAIN_NAME to the TLD specified for that environment (IE: example-staging.com for staging)",
 
@@ -21,6 +22,8 @@ class Cheftacular
           "It is recommended to enter a custom repository-dependent tag here to make nodes easier to load-balance like \"lb:[CODEBASE_NAME]\""
         ]
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Uses the cloud API to setup a server and bring it to a deployable state'
     end
   end
 

data/lib/cheftacular/stateless_actions/compile_audit_log.rb

@@ -1,11 +1,14 @@
 class Cheftacular
   class StatelessActionDocumentation
     def compile_audit_log
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft compile_audit_log [clean]` compiles the audit logs in each environment's " +
         "audit data bag a audit-log-CURRENTDAY.md file in the log folder of the application. Bear in mind that the bag " +
         "can only hold 100K bytes and will need to have that data removed to store more than that."
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Compiles the audit logs for all environments'
     end
   end
 

data/lib/cheftacular/stateless_actions/compile_readme.rb

@@ -1,9 +1,18 @@
 class Cheftacular
   class StatelessActionDocumentation
     def compile_readme
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft compile_readme` compiles all documentation methods and creates a README.md file in the log folder of the application."
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Compiles and creates a readme based on all accessable commands'
+    end
+  end
+
+  class InitializationAction
+    def compile_readme
+      
     end
   end
 

data/lib/cheftacular/stateless_actions/create_git_key.rb

@@ -1,7 +1,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def create_git_key
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft create_git_key ID_RSA_FILE [OAUTH_TOKEN]` This command will update the default/authentication data bag with new credentials. " +
         "The [ID_RSA_FILE](https://help.github.com/articles/generating-ssh-keys) needs to exist beforehand.",
 
@@ -14,6 +15,8 @@ class Cheftacular
           "    3. NOTE! The ID_RSA_FILE should be in your .chef folder in the root of your home directory!"
         ]
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Adds a git key to your authentication bag so your github repos can be accessed'
     end
   end
 

data/lib/cheftacular/stateless_actions/disk_report.rb

@@ -1,11 +1,14 @@
 class Cheftacular
   class StatelessActionDocumentation
     def disk_report
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft disk_report` will fetch useful statistics from every server for every environment and output it into your log directory."
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Retrives basic info about the filesystem for your nodes'
     end
   end
 

data/lib/cheftacular/stateless_actions/environment.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def environment
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft environment boot|destroy` will boot / destroy the current environment",
 
         [
@@ -15,7 +16,9 @@ class Cheftacular
         ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Boots (or destroys) an environment based on data stored in cheftacular.yml'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/file.rb

@@ -1,7 +1,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def file
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft file NODE_NAME LOCATION_ALIAS MODE FILE_NAME` interacts with a file on the remote server",
 
         [
@@ -41,7 +42,9 @@ class Cheftacular
         ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Allows you to perform a variety of file commands on a remote file'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/fix_known_hosts.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def fix_known_hosts
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft fix_known_hosts [HOSTNAME]` this command will delete entries in your known_hosts file " +
         "for all the servers that are in our system (ip addresses AND dns names)",
 
@@ -11,7 +12,9 @@ class Cheftacular
         ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Fixes issues with the known_hosts ssh file'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/full_bootstrap.rb

@@ -2,10 +2,18 @@
 class Cheftacular
   class StatelessActionDocumentation
     def full_bootstrap
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft full_bootstrap ADDRESS ROOT_PASS NODE_NAME` This command performs both " +
-        "#{ @config['cheftacular']['preferred_cloud_os'] }_bootstrap and chef_bootstrap."
+        "#{ @config['cheftacular']['preferred_cloud_os'] }_bootstrap and chef_bootstrap.",
+
+        [
+          "    1. This command is run by `cft cloud_bootstrap` and should not be run on its own unless the " +
+          "target server is already created and not initialized."
+        ]
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Attempts to setup a server that has already been created'
     end
   end
 

data/lib/cheftacular/stateless_actions/get_active_ssh_connections.rb

@@ -1,11 +1,12 @@
 class Cheftacular
   class StatelessActionDocumentation
     def get_active_ssh_connections
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "[NYI]`cft get_active_ssh_connections` will fetch the active ssh connections from every server and output it into your log directory."
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      #@config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/get_haproxy_log.rb

@@ -2,7 +2,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def get_haproxy_log
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft get_haproxy_log` this command will generate a haproxy html file for the load balancer(s) associated with a repository in the log directory. " +
         "Opening this log file in the browser will show the status of that haproxy at the time of the log. ",
 
@@ -11,7 +12,9 @@ class Cheftacular
         ]
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Attempts to fetch haproxy load balancer logs from the remote server(s)'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/get_log_from_bag.rb

@@ -2,12 +2,15 @@
 class Cheftacular
   class StatelessActionDocumentation
     def get_log_from_bag
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft get_log_from_bag <NODE_NAME-COMMAND_TYPE>` this command grabs the latest command run log from the data bags " +
         "and saves it to your log directory. There are different types of logs saved per server depending on command."
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Fetches all the logs stored in the current environment bags'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/get_pg_pass.rb

@@ -2,12 +2,15 @@
 class Cheftacular
   class StatelessActionDocumentation
     def get_pg_pass
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft get_pg_pass ['clip']` command will output the current environment's pg_password to your terminal. " +
         "Optionally you can pass in clip like `cft get_pg_pass clip` to have it also copy the pass to your clipboard."
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = "Fetches the current environment's postgres password"
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 

data/lib/cheftacular/stateless_actions/get_shorewall_allowed_connections.rb

@@ -1,7 +1,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def get_shorewall_allowed_connections
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft get_shorewall_allowed_connections [PATH_TO_LOCAL_FILE] -n NODE_NAME` command will query a single server and return all of its ACCEPT connections " +
         "from shorewall in it's syslog and return the results in a CSV format. Useful for tracking IP activity.",
 

data/lib/cheftacular/stateless_actions/help.rb

@@ -1,13 +1,16 @@
 class Cheftacular
   class StatelessActionDocumentation
     def help
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft help COMMAND|MODE` this command returns the documentation for a specific command if COMMAND matches the name of a command. " +
         "Alternatively, it can be passed `action|arguments|application|current|devops|stateless_action` to fetch the commands for a specific mode." +
         "Misspellings of commands will display near hits."
       ]
 
-      @config['documentation']['application'] << @config['documentation']['stateless_action'].last
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Displays useful help related information based on the current context'
+
+      @config['documentation']['application'][__method__] = @config['documentation']['stateless_action'][__method__]
     end
   end
 
@@ -27,34 +30,43 @@ class Cheftacular
       when 'action'                  then inference_modes << 'action'
       when 'application' || 'devops' then inference_modes << 'both'
       when 'stateless_action'        then inference_modes << 'stateless_action'
-      when ''                        then inference_modes << 'both'
+      when ''                        then inference_modes << 'short_context_descriptions'
       end
 
       if @config['helper'].is_command? target_command
         @config['action_documentation'].send(target_command)
 
-        puts @config['documentation']['action'].flatten.join("\n\n")
-
+        puts @config['documentation']['action'][target_command.to_sym]['long_description'].flatten.join("\n\n")
       elsif @config['helper'].is_stateless_command? target_command
         @config['stateless_action_documentation'].send(target_command)
 
-        puts @config['documentation']['stateless_action'].flatten.join("\n\n")
+        puts @config['documentation']['stateless_action'][target_command.to_sym]['long_description'].flatten.join("\n\n")
       end
 
-      @config['action_documentation'].public_methods(false).each do |method|
-        @config['action_documentation'].send(method)
-
-      end if inference_modes.include?('action') || inference_modes.include?('both')
-
-      @config['stateless_action_documentation'].public_methods(false).each do |method|
-        @config['stateless_action_documentation'].send(method)
+      if inference_modes.include?('action') || inference_modes.include?('both') || inference_modes.include?('short_context_descriptions')
+        @config['action_documentation'].public_methods(false).each do |method|
+          @config['action_documentation'].send(method)
+        end
+      end
 
-      end if inference_modes.include?('stateless_action') || inference_modes.include?('both')
+      if inference_modes.include?('action') || inference_modes.include?('both') ||
+        ( inference_modes.include?('short_context_descriptions') && @config['helper'].running_in_mode?('devops') )
+ 
+        @config['stateless_action_documentation'].public_methods(false).each do |method|
+          @config['stateless_action_documentation'].send(method)
+        end
+      end
 
       puts @config['documentation']['arguments'].flatten.join("\n\n") if target_command == 'arguments'
 
-      puts @config['helper'].compile_documentation_lines('application').flatten.join("\n\n") if target_command.empty?
-
+      if inference_modes.include?('short_context_descriptions')
+        if @config['helper'].running_in_mode?('devops')
+          puts @config['helper'].compile_short_context_descriptions(@config['documentation']['action'].merge(@config['documentation']['stateless_action']), 35)
+        else
+          puts @config['helper'].compile_short_context_descriptions(@config['documentation']['action'].merge(@config['documentation']['application']))
+        end
+      end
+      
       puts @config['helper'].compile_documentation_lines(target_command).flatten.join("\n\n") if target_command =~ /action|stateless_action|application|devops/
 
       if inference_modes.empty? && @config['helper'].is_not_command_or_stateless_command?(target_command)

data/lib/cheftacular/stateless_actions/initialize_cheftacular_yml.rb

@@ -1,7 +1,8 @@
 class Cheftacular
   class StatelessActionDocumentation
     def initialize_cheftacular_yml
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft initialize_cheftacular_yml [application|TheCheftacularCookbook]` will create a cheftacular.yml " +
         "file in your config folder (and create the config folder if it does not exist). If you already have a cheftacular.yml file " +
         "in the config folder, it will create a cheftacular.example.yml file that will contain the new changes / keys in the latest " +
@@ -13,6 +14,8 @@ class Cheftacular
           "    2. If `application` is passed, the generated cheftacular.yml file will look like one you could use in an application directory."
         ]
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Sets up a cheftacular.yml file or a cheftacular.yml.example file'
     end
   end
 

data/lib/cheftacular/stateless_actions/initialize_data_bag_contents.rb

@@ -1,10 +1,13 @@
 class Cheftacular
   class StatelessActionDocumentation
     def initialize_data_bag_contents
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft initialize_data_bag_contents ENVIRONMENT_NAME` will ensure the data bags always have the correct structure before each run. " +
         "This command is run every time the gem is started and if called directly, will exit after completion."
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Ensures the data bags always contain correct initialization information'
     end
   end
 

data/lib/cheftacular/stateless_actions/knife_upload.rb

@@ -2,10 +2,13 @@
 class Cheftacular
   class StatelessActionDocumentation
     def knife_upload
-      @config['documentation']['stateless_action'] <<  [
+      @config['documentation']['stateless_action'][__method__] ||= {}
+      @config['documentation']['stateless_action'][__method__]['long_description'] = [
         "`cft knife_upload` will resync the chef-server with the local chef-repo code. " + 
         "This command is analog for `knife upload /`"
       ]
+
+      @config['documentation']['stateless_action'][__method__]['short_description'] = 'Uploads your current cookbooks to the chef server'
     end
   end