- Add --watch to the generate command

Author: DannyBen

bashly.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'completely', '~> 0.4.2'
   s.add_runtime_dependency 'mister_bin', '~> 0.7'
   s.add_runtime_dependency 'requires', '~> 0.2'
+  s.add_runtime_dependency 'filewatcher', '~> 1.1'
 
   s.metadata = {
     "bug_tracker_uri"   => "https://github.com/DannyBen/bashly/issues",

lib/bashly/commands/generate.rb

@@ -1,3 +1,5 @@
+require 'filewatcher'
+
 module Bashly
   module Commands
     class Generate < Base
@@ -9,7 +11,8 @@ class Generate < Base
       option "-f --force", "Overwrite existing files"
       option "-q --quiet", "Disable on-screen progress report"
       option "-u --upgrade", "Upgrade all added library functions"
-      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
+      option "-w --watch", "Watch the source directory for changes and regenerate on change"
+      option "-r --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
       option "-e --env ENV", "Force the generation environment (see BASHLY_ENV)"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
@@ -27,17 +30,50 @@ class Generate < Base
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
+      example "bashly g -uw"
+
+      attr_reader :watching
 
       def run
+        Settings.env = args['--env'] if args['--env']
+        @watching = args['--watch']
+
+        generate
+        watch if watching
+      end
+
+    private
+
+      def watch
+        quiet_say "!txtgrn!watching!txtrst! #{Settings.source_dir}\n"
+
+        Filewatcher.new([Settings.source_dir]).watch do
+          reset
+          generate
+
+        rescue Bashly::ConfigurationError => e
+          say! "!undred!#{e.class}!txtrst!\n#{e.message}"
+
+        ensure
+          quiet_say "!txtgrn!waiting\n"
+        
+        end
+      end
+
+      def generate
         with_valid_config do
-          Settings.env = args['--env'] if args['--env']
           quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
           generate_all_files
-          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+          quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script" unless watching
         end
       end
 
-    private
+      def reset
+        @config = nil
+        @config_validator = nil
+        @command = nil
+        @script = nil
+      end
 
       def quiet_say(message)
         say message unless args['--quiet']

spec/approvals/cli/generate/help

@@ -14,7 +14,10 @@ Options:
   -u --upgrade
     Upgrade all added library functions
 
-  -w --wrap FUNCTION
+  -w --watch
+    Watch the source directory for changes and regenerate on change
+
+  -r --wrap FUNCTION
     Wrap the entire script in a function so it can also be sourced
 
   -e --env ENV
@@ -51,3 +54,4 @@ Environment Variables:
 Examples:
   bashly generate --force
   bashly generate --wrap my_function
+  bashly g -uw

spec/approvals/cli/generate/watch

@@ -0,0 +1,14 @@
+creating user files in spec/tmp/src
+created spec/tmp/src/initialize.sh
+created spec/tmp/src/download_command.sh
+created spec/tmp/src/upload_command.sh
+created spec/tmp/cli
+watching spec/tmp/src
+
+creating user files in spec/tmp/src
+skipped spec/tmp/src/initialize.sh (exists)
+skipped spec/tmp/src/download_command.sh (exists)
+skipped spec/tmp/src/upload_command.sh (exists)
+created spec/tmp/cli
+waiting
+

spec/approvals/cli/generate/watch-stderr

@@ -0,0 +1,2 @@
+Bashly::ConfigurationError
+root contains invalid options: invalid_option

spec/bashly/commands/generate_spec.rb

@@ -98,7 +98,7 @@
     end
 
     it "generates the cli script wrapped in a function without bash3 bouncer" do
-      expect { subject.run %w[generate -w function] }.to output_approval('cli/generate/wrap-function')
+      expect { subject.run %w[generate --wrap function] }.to output_approval('cli/generate/wrap-function')
       expect(File).to exist(cli_script)
       lines = File.readlines cli_script
       expect(lines[0..10].join).to match_approval('cli/generate/wrap-script').except(/\d+\.\d+\.\d+/)
@@ -201,6 +201,40 @@
     end
   end
 
+  context "with --watch" do
+    before do
+      reset_tmp_dir create_src: true
+      cp "lib/bashly/templates/bashly.yml", bashly_config_path
+    end
+
+    let(:bashly_config_path) { "#{source_dir}/bashly.yml" }
+    let(:bashly_config) { YAML.load_file bashly_config_path }
+
+    it "generates immediately and on change" do
+      expect do
+        expect_any_instance_of(Filewatcher).to receive(:watch) do |watcher, &block|
+          block.call
+        end
+
+        subject.run %W[generate --watch]
+      end.to output_approval('cli/generate/watch')
+    end
+
+    context "when ConfigurationError is raised during watch" do
+      it "shows the error gracefully and continues to watch" do
+        expect do
+          expect_any_instance_of(Filewatcher).to receive(:watch) do |watcher, &block|
+            bashly_config['invalid_option'] = 'error this'
+            File.write bashly_config_path, bashly_config.to_yaml
+            block.call
+          end
+
+          subject.run %W[generate --watch]
+        end.to output_approval('cli/generate/watch-stderr').to_stderr
+      end
+    end
+  end
+
   # DEPRECATION 0.8.0
   context "with deprecated command.short option" do
     before do