Merge pull request #219 from DannyBen/add/env-to-settings

Support env value in settings.yml as an alternative to BASHLY_ENV

Author: DannyBen

lib/bashly.rb

@@ -15,15 +15,3 @@
 requires 'bashly/commands/base'
 requires 'bashly/libraries/base'
 requires 'bashly'
-
-module Bashly
-  class << self
-    def env
-      ENV['BASHLY_ENV']&.to_sym
-    end
-
-    def production?
-      env == :production
-    end
-  end
-end

lib/bashly/commands/generate.rb

@@ -30,8 +30,8 @@ class Generate < Base
 
       def run
         validate_config
-        ENV['BASHLY_ENV'] = args['--env'] if args['--env']
-        quiet_say "creating !txtgrn!production!txtrst! version" if Bashly.production?
+        Settings.env = args['--env'] if args['--env']
+        quiet_say "creating !txtgrn!production!txtrst! version" if Settings.production?
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script

lib/bashly/concerns/renderable.rb

@@ -15,7 +15,7 @@ def strings
 
     def view_marker(id = nil)
       id ||= ":#{caller_locations.first.path}"
-      "# #{id}" unless Bashly.production?
+      "# #{id}" unless Settings.production?
     end
 
   private

lib/bashly/script/command.rb

@@ -103,7 +103,7 @@ def load_user_file(file, placeholder: true)
           ''
         end
 
-        Bashly.production? ? content : "#{view_marker path}\n#{content}"
+        Settings.production? ? content : "#{view_marker path}\n#{content}"
       end
 
       # Returns an array of all parents. For example, the command 

lib/bashly/settings.rb

@@ -23,6 +23,18 @@ def tab_indent
         @tab_indent ||= get :tab_indent
       end
 
+      def env
+        @env ||= get(:env, :development)&.to_sym
+      end
+
+      def env=(value)
+        @env = value&.to_sym
+      end
+
+      def production?
+        env == :production
+      end
+
       def full_lib_dir
         "#{source_dir}/#{lib_dir}"
       end

lib/bashly/templates/settings.yml

@@ -2,8 +2,23 @@
 # can also be set with an environment variable with the same name, capitalized
 # and prefixed by `BASHLY_` - for example: BASHLY_SOURCE_DIR
 
+# The path containing the bashly configuration and source files
 source_dir: src
+
+# The path to use for creating the bash script
 target_dir: .
+
+# The path to use for upgrading library files, relative to the source dir
 lib_dir: lib
+
+# When true, enable bash strict mode (set -euo pipefail)
 strict: false
+
+# When true, the generated script will use tab indentation instead of spaces
+# (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
+
+# Set to 'production' or 'development':
+# - production    generate a smaller script, without file markers
+# - development   generate with file markers
+env: development

spec/bashly/commands/add_spec.rb

@@ -92,6 +92,7 @@
 
   context "with settings command" do
     let(:settings_file) { "#{target_dir}/settings.yml" }
+    let(:template_file) { "lib/bashly/templates/settings.yml" }
 
     before do
       reset_tmp_dir
@@ -104,6 +105,7 @@
         end
       end.to output_approval('cli/add/settings')
       expect(File).to exist(settings_file)
+      expect(File.read settings_file).to eq File.read(template_file)
     end
 
     context "when the file exists" do

spec/bashly/commands/generate_spec.rb

@@ -27,8 +27,8 @@
     end
 
     context "when BASHLY_ENV=production" do
-      before { ENV['BASHLY_ENV'] = 'production' }
-      after  { ENV['BASHLY_ENV'] = nil }
+      before { Settings.env = :production }
+      after  { Settings.env = nil }
 
       it "generates a script without view markers" do
         expect { subject.run %w[generate] }.to output_approval('cli/generate/production-env-var')
@@ -118,7 +118,7 @@
       expect(success).to be true
     end
 
-    after  { ENV['BASHLY_ENV'] = nil }
+    after  { Settings.env = nil }
 
     it "generates a script without view markers" do
       expect { subject.run %w[generate --env production] }.to output_approval('cli/generate/production')

spec/spec_helper.rb

@@ -20,16 +20,14 @@
 Settings.source_dir = 'spec/tmp/src'
 Settings.target_dir = 'spec/tmp'
 Settings.strict = '1' # generate scripts with `set -euo pipefile`
+Settings.env = :development
 reset_tmp_dir
 
 # Consistent Colsole output (for rspec_fixtures)
 ENV['TTY'] = 'off'
 ENV['COLUMNS'] = '80'
 ENV['LINES'] = '30'
 
-# Unset any user env settings
-ENV['BASHLY_ENV'] = nil
-
 RSpec.configure do |c|
   c.include SpecMixin
   c.strip_ansi_escape = true