Merge pull request #62 from DannyBen/add/function-wrapper

Add generate --wrap FUNCTION_NAME option to generate sourcing-friendly output

Author: DannyBen

lib/bashly/commands/generate.rb

@@ -3,14 +3,18 @@ module Commands
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force]"
+      usage "bashly generate [--force --wrap FUNCTION]"
       usage "bashly generate (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
+      option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
 
+      example "bashly generate --force"
+      example "bashly generate --wrap my_function"
+
       def run
         create_user_files
         create_master_script
@@ -54,12 +58,15 @@ def create_file(file, content)
       end
 
       def create_master_script
-        master_script = command.render('master_script').lint
-        File.write master_script_path, master_script
+        File.write master_script_path, script.code
         FileUtils.chmod "+x", master_script_path
         say "created !txtgrn!#{master_script_path}"
       end
 
+      def script
+        @script ||= Models::Script.new(command, args['--wrap'])
+      end
+
       def master_script_path
         "#{Settings.target_dir}/#{command.name}"
       end

lib/bashly/commands/preview.rb

@@ -11,7 +11,8 @@ class Preview < Base
       def run
         config = Config.new "#{Settings.source_dir}/bashly.yml"
         command = Models::Command.new(config)
-        puts command.render 'master_script'
+        script = Models::Script.new command
+        puts script.code
       end
     end
   end

lib/bashly/models/script.rb

@@ -0,0 +1,33 @@
+module Bashly
+  module Models
+    class Script
+      include Renderable
+
+      attr_reader :command, :function_name
+
+      def initialize(command, function_name = nil)
+        @command, @function_name = command, function_name
+      end
+
+      def code
+        if function_name
+          result = [header, render('wrapper')].join "\n"
+        else
+          result = [header, body].join "\n"
+        end
+
+        result.lint
+      end
+
+    private
+
+      def header
+        @header ||= render('header')
+      end
+
+      def body
+        @body ||= command.render('master_script')
+      end
+    end
+  end
+end

lib/bashly/views/command/master_script.erb

@@ -1,7 +1,3 @@
-#!/usr/bin/env bash
-# This script was generated by bashly (https://github.com/DannyBen/bashly)
-# Modifying it manually is not recommended
-
 <%= render :root_command if commands.empty? %>
 <%= render :version_command %>
 <%= render :usage %>

lib/bashly/views/script/header.erb

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# This script was generated by bashly (https://github.com/DannyBen/bashly)
+# Modifying it manually is not recommended

lib/bashly/views/script/wrapper.erb

@@ -0,0 +1,6 @@
+# :script.wrapper
+<%= function_name %>() {
+<%= body.indent 2 %>
+}
+
+(return 0 2>/dev/null) || <%= function_name %> "$@"

spec/approvals/cli/generate/help

@@ -1,13 +1,16 @@
 Generate the bash script and required files
 
 Usage:
-  bashly generate [--force]
+  bashly generate [--force --wrap FUNCTION]
   bashly generate (-h|--help)
 
 Options:
   -f --force
     Overwrite existing files
 
+  -w --wrap FUNCTION
+    Wrap the entire script in a function so it can also be sourced
+
   -h --help
     Show this help
 
@@ -17,3 +20,7 @@ Environment Variables:
 
   BASHLY_TARGET_DIR
     The path to use for creating the bash script [default: .]
+
+Examples:
+  bashly generate --force
+  bashly generate --wrap my_function

spec/approvals/cli/generate/wrap-function

@@ -0,0 +1,6 @@
+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
+run spec/tmp/cli --help to test your bash script

spec/bashly/commands/generate_spec.rb

@@ -51,4 +51,21 @@
     end
   end
 
+  context "with --wrap function" do
+    let(:cli_script) { "#{target_dir}/cli" }
+
+    before do
+      reset_tmp_dir
+      success = system "mkdir -p #{source_dir} && cp lib/bashly/templates/bashly.yml #{source_dir}/bashly.yml"
+      expect(success).to be true
+    end
+
+    it "generates the cli script wrapped in a function" do
+      expect { subject.run %w[generate -w function] }.to output_approval('cli/generate/wrap-function')
+      expect(File).to exist(cli_script)
+      lines = File.readlines cli_script
+      expect(lines[5]).to eq "function() {\n"
+    end
+  end
+
 end

spec/bashly/models/script_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Models::Script do
+  let(:command) { Models::Command.new config }
+  let(:config) { load_fixture('models/commands')[fixture] }
+  let(:fixture) { :basic_command }
+
+  context "without function name" do
+    subject { described_class.new command }
+
+    describe '#code' do
+      it "returns the complete script" do
+        lines = subject.code.split "\n"
+        expect(lines[0]).to eq '#!/usr/bin/env bash'
+        expect(lines[1]).to start_with '# This script was generated by'
+        expect(lines[5]).to eq 'root_command() {'
+        expect(lines[-1]).to eq 'run "$@"'
+      end
+    end
+  end
+
+  context "with function name" do
+    subject { described_class.new command, 'my_super_function' }
+
+    describe '#code' do
+      it "returns the complete script wrapped in a function" do
+        lines = subject.code.split "\n"
+        expect(lines[0]).to eq '#!/usr/bin/env bash'
+        expect(lines[1]).to start_with '# This script was generated by'
+        expect(lines[5]).to eq 'my_super_function() {'
+        expect(lines[6]).to eq '  # :command.root_command'
+        expect(lines[-1]).to eq '(return 0 2>/dev/null) || my_super_function "$@"'
+      end
+    end
+  end
+
+end