sfn-parameters 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa98393dbb5772d3b8058e38d07d604ad0bd14e4
-  data.tar.gz: 4eb0b9d98743d33e4cab470c4e0034fc6f38baa3
+  metadata.gz: a5dff19c967089f79139776c3e592a178614fb79
+  data.tar.gz: 0ba68820d8c71adc5cc6ab9fad5afaadd4e820b8
 SHA512:
-  metadata.gz: 0ab1532d9ed57477fe43dd480c91fa1cbdf047c12216be462f341b5db45265b58dc4570acb4c5b4b745df6e6f55dfb79af47ef0f76128bba51436ae5fdc1c786
-  data.tar.gz: dd16da459bc56af432aa2fa0528032f64b9210f16684ce409c21e5e32f1698f0a03a940127673ee03707a580606d41ecccc6eb9df97822211a1d849e869a0c6a
+  metadata.gz: 44869723132b17dda13a221830edda6d355efa95930f5ff54b24a78d0a2b851798b84bf47214af65862442533f341ba92885d887e00074af5b645c0f4c08002f
+  data.tar.gz: 4a1b69b524e8f040acb78365746d4c137ff36b4871608ea1654a1ed6a6873879d7b6fe50ef808ad1fa41cecb34cd3df3862760c481b28318418c7dc280417f43

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.2.2
+* Provide better UI feedback (#3)
+
 # v0.2.0
 * Add support for single stack workflow (#1)
 * Add encryption foundation with initial OpenSSL implementation (#2)

data/lib/sfn-parameters/command.rb

@@ -8,87 +8,127 @@ module Sfn
       include SfnParameters::Utils
       include Sfn::CommandModule::Base
 
+      # Default contents for new item creation
+      NEW_ITEM_DEFAULT = Smash.new(
+        :parameters => {},
+        :compile_parameters => {},
+        :apply_stacks => [],
+        :stacks => {}
+      )
+
       # Execute parameters action request
       def execute!
-        action, item = arguments[0,2]
+        action, item = arguments[0].to_s, arguments[1].to_s
         ui.info "Running parameters action #{ui.color(action.to_s, :bold)}"
-        case action.to_sym
-        when :lock
-          item = validate_item(item)
-          ui.print " Locking #{ui.color(item, :bold)}... "
-          content = load_json(File.read(item)).to_smash
-          if(content[:sfn_parameters_lock])
-            ui.puts ui.color('no-op', :yellow)
-            ui.warn "Item is already locked! (#{item})"
-          else
-            thing = lock_content(content)
-            val = format_json(thing)
-            File.write(item, val)
-            ui.puts ui.color('locked', :blue)
-          end
-        when :unlock
-          item = validate_item(item)
-          ui.print " Unlocking #{ui.color(item, :bold)}... "
-          content = load_json(File.read(item)).to_smash
-          if(content[:sfn_parameters_lock])
-            content = unlock_content(content)
-            content.delete(:sfn_lock_enabled)
-            File.write(item, format_json(content))
-            ui.puts ui.color('unlocked', :green)
-          else
-            ui.puts ui.color('no-op', :yellow)
-            ui.warn "Item is already unlocked! (#{item})"
+        if(respond_to?("run_action_#{action}"))
+          send("run_action_#{action}", item)
+        else
+          allowed_actions = public_methods.grep(/^run_action/).sort.map do |item|
+            item.to_s.sub('run_action_', '')
           end
-        when :show
+          raise ArgumentError.new "Unsupported action received `#{action}`. " \
+            "Allowed: #{allowed_actions.join(', ')}"
+        end
+      end
+
+      # Perform locking on item
+      #
+      # @param item [String] item to lock
+      def run_action_lock(item)
+        item = validate_item(item)
+        ui.print " Locking #{ui.color(item, :bold)}... "
+        content = load_json(File.read(item)).to_smash
+        if(content[:sfn_parameters_lock])
+          ui.puts ui.color('no-op', :yellow)
+          ui.warn "Item is already locked! (#{item})"
+        else
+          thing = lock_content(content)
+          val = format_json(thing)
+          File.write(item, val)
+          ui.puts ui.color('locked', :blue)
+        end
+      end
+
+      # Perform unlocking on item
+      #
+      # @param item [String] item to lock
+      def run_action_unlock(item)
+        item = validate_item(item)
+        ui.print " Unlocking #{ui.color(item, :bold)}... "
+        content = load_json(File.read(item)).to_smash
+        if(content[:sfn_parameters_lock])
+          content = unlock_content(content)
+          content.delete(:sfn_lock_enabled)
+          File.write(item, format_json(content))
+          ui.puts ui.color('unlocked', :green)
+        else
+          ui.puts ui.color('no-op', :yellow)
+          ui.warn "Item is already unlocked! (#{item})"
+        end
+      end
+
+      # Perform show on item
+      #
+      # @param item [String] item to lock
+      def run_action_show(item)
+        item = validate_item(item)
+        content = load_json(File.read(item)).to_smash
+        if(content[:sfn_parameters_lock])
+          ui.print ui.color(' *', :bold)
+          ui.print " Unlocking #{ui.color(item, :bold)} for display... "
+          content = unlock_content(content)
+          content.delete(:sfn_lock_enabled)
+          ui.puts ui.color('unlocked', :green)
+        end
+        ui.puts format_json(content)
+      end
+
+      # Perform create on item
+      #
+      # @param item [String] item to lock
+      def run_action_create(item)
+        unless(ENV['EDITOR'])
+          raise ArgumentError.new '$EDITOR must be set for create/edit commands!'
+        end
+        begin
           item = validate_item(item)
-          content = load_json(File.read(item)).to_smash
-          if(content[:sfn_parameters_lock])
-            ui.print ui.color(' *', :bold)
-            ui.print " Unlocking #{ui.color(item, :bold)} for display... "
-            content = unlock_content(content)
-            content.delete(:sfn_lock_enabled)
-            ui.puts ui.color('unlocked', :green)
-          end
-          ui.puts format_json(content)
-        when :create, :edit
-          unless(ENV['EDITOR'])
-            raise ArgumentError.new '$EDITOR must be set for create/edit commands!'
-          end
-          begin
-            item = validate_item(item)
-          rescue ArgumentError
-            new_item = true
-            item = new_item(item)
-          end
-          FileUtils.mkdir_p(File.dirname(item))
-          tmp = Bogo::EphemeralFile.new('sfn-parameters')
-          content = new_item ? Smash.new : load_json(File.read(item)).to_smash
-          if(content[:sfn_parameters_lock])
-            ui.print ui.color(' *', :bold)
-            ui.print " Unlocking #{ui.color(item, :bold)} for edit... "
-            content = unlock_content(content)
-            ui.puts ui.color('unlocked', :green)
-          end
-          lock_enabled = content.delete(:sfn_lock_enabled) || new_item
-          tmp.write(format_json(content))
-          tmp.flush
-          system("#{ENV['EDITOR']} #{tmp.path}")
-          tmp.rewind
-          content = load_json(tmp.read).to_smash
+        rescue ArgumentError
+          new_item = true
+          item = new_item(item)
+        end
+        FileUtils.mkdir_p(File.dirname(item))
+        tmp = Bogo::EphemeralFile.new('sfn-parameters')
+        content = new_item ? NEW_ITEM_DEFAULT : load_json(File.read(item)).to_smash
+        if(content[:sfn_parameters_lock])
           ui.print ui.color(' *', :bold)
-          if(lock_enabled)
-            ui.print " Locking #{ui.color(item, :bold)} for storage... "
-            content = lock_content(content)
-            ui.puts ui.color('locked', :blue)
-          else
-            ui.puts " Storing #{ui.color(item, :bold)} for storage... #{ui.color('unlocked', :yellow)}"
-          end
-          File.write(item, format_json(content))
-          tmp.close
+          ui.print " Unlocking #{ui.color(item, :bold)} for edit... "
+          content = unlock_content(content)
+          ui.puts ui.color('unlocked', :green)
+        end
+        lock_enabled = content.delete(:sfn_lock_enabled) || new_item
+        tmp.write(format_json(content))
+        tmp.flush
+        system("#{ENV['EDITOR']} #{tmp.path}")
+        tmp.rewind
+        content = load_json(tmp.read).to_smash
+        ui.print ui.color(' *', :bold)
+        if(lock_enabled)
+          ui.print " Locking #{ui.color(item, :bold)} for storage... "
+          content = lock_content(content)
+          ui.puts ui.color('locked', :blue)
         else
-          ArgumentError.new "Unsupported action received `#{action}`. " \
-            "Allowed: lock, unlock, show, create, edit"
+          ui.puts " Storing #{ui.color(item, :bold)} for storage... #{ui.color('unlocked', :yellow)}"
         end
+        File.write(item, format_json(content))
+        tmp.close
+      end
+
+      # Perform edit on item
+      #
+      # @param item [String] item to lock
+      def run_action_edit(item)
+        validate_item(item)
+        run_action_create(item)
       end
 
       # Expand path for new item if required
@@ -122,6 +162,9 @@ module Sfn
       # @param item [String]
       # @return [String]
       def validate_item(item)
+        if(item.to_s.empty?)
+          raise NameError.new 'Item name is required. No item name provided.'
+        end
         items = [
           item,
           File.join(

data/lib/sfn-parameters/version.rb

@@ -1,3 +1,3 @@
 module SfnParameters
-  VERSION = Gem::Version.new('0.2.0')
+  VERSION = Gem::Version.new('0.2.2')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn-parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfn