sfn-parameters 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d0779acdcc6b50972d76987fa3f32c743fd1e54c
-  data.tar.gz: 6c2a45b9c401f596f24768a4bc9f03898f12bbf0
+SHA256:
+  metadata.gz: 6402872602c46b70bbb1ce840268256a6a8c7a1e097093478603e5926a907c48
+  data.tar.gz: e49e01025280eedd43e763a4f0069c4df68b468ebfb75a540a672917aa6befba
 SHA512:
-  metadata.gz: c1361a2e0391db409481f56e83dbb4f36cb8ce5a8a8df94c7f0f219201667fbe702a4e3b225526dda4376dff46f0316f8a5c491a893bb4d0c9928fdb07fa5d30
-  data.tar.gz: 09f3d7c096fd47224e4dbc07e4ae03f44984ed308e049c7a2e22b3dbef232bf7baa67c11c8431fb869437a7df324b5cdb0b6d9f9ced68bb72fac45adc5cf4c1d
+  metadata.gz: 885f6c47c742135a80f27f81d761def19675ecf12411b58f490fb627f2ee4378be903ef04c95ddb9e59ae2accc3283bc915ce98de0636c063d100526093d4675
+  data.tar.gz: 3b341192e654d45aeac09a8221096ece01b76db70e02e7ae342f0ebc5e4adaa9780341c835f713cfc6ac4023b68908487e1cd3a42283d5c52a0f75eee1f95178

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.2.6
+* Support all valid format types in show subcommand (#14)
+* Apply parameters for all commands (#17)
+
 # v0.2.4
 * Include `.json` extension on temp file (#8)
 * Add support for `mappings` (#9)

data/README.md

@@ -174,7 +174,8 @@ library. This allows defining the file in a serialization format
 ### Encryption
 
 This callback also supports encrypting stack parameter information for storage. The callback
-adds a `parameters` command for handling encryption/decryption.
+adds a `parameters` command for handling encryption/decryption. Encryption is currently only
+supported when using JSON format parameter files.
 
 #### Configuration
 
@@ -235,6 +236,12 @@ $ sfn parameters lock my-test-stack
 $ sfn parameters unlock my-test-stack
 ~~~
 
+##### Show existing values (as JSON)
+
+~~~
+$ sfn parameters show my-test-stack
+~~~
+
 _NOTE: Full paths can also be used when defining parameters file._
 
 # Info

data/lib/sfn-parameters/command.rb

@@ -1,10 +1,9 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module Sfn
   class Command
     # Parameters command
     class Parameters < Command
-
       include SfnParameters::Utils
       include Sfn::CommandModule::Base
 
@@ -13,21 +12,21 @@ module Sfn
         :parameters => {},
         :compile_parameters => {},
         :apply_stacks => [],
-        :stacks => {}
+        :stacks => {},
       )
 
       # Execute parameters action request
       def execute!
         action, item = arguments[0].to_s, arguments[1].to_s
         ui.info "Running parameters action #{ui.color(action.to_s, :bold)}"
-        if(respond_to?("run_action_#{action}"))
+        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_', '')
+            item.to_s.sub("run_action_", "")
           end
           raise ArgumentError.new "Unsupported action received `#{action}`. " \
-            "Allowed: #{allowed_actions.join(', ')}"
+                                  "Allowed: #{allowed_actions.join(", ")}"
         end
       end
 
@@ -38,14 +37,14 @@ module Sfn
         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)
+        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)
+          ui.puts ui.color("locked", :blue)
         end
       end
 
@@ -56,13 +55,13 @@ module Sfn
         item = validate_item(item)
         ui.print " Unlocking #{ui.color(item, :bold)}... "
         content = load_json(File.read(item)).to_smash
-        if(content[:sfn_parameters_lock])
+        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)
+          ui.puts ui.color("unlocked", :green)
         else
-          ui.puts ui.color('no-op', :yellow)
+          ui.puts ui.color("no-op", :yellow)
           ui.warn "Item is already unlocked! (#{item})"
         end
       end
@@ -72,13 +71,13 @@ module Sfn
       # @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)
+        content = Bogo::Config.new(item).data
+        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)
+          ui.puts ui.color("unlocked", :green)
         end
         ui.puts format_json(content)
       end
@@ -87,8 +86,8 @@ module Sfn
       #
       # @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!'
+        unless ENV["EDITOR"]
+          raise ArgumentError.new "$EDITOR must be set for create/edit commands!"
         end
         begin
           item = validate_item(item)
@@ -97,26 +96,26 @@ module Sfn
           item = new_item(item)
         end
         FileUtils.mkdir_p(File.dirname(item))
-        tmp = Bogo::EphemeralFile.new(['sfn-parameters', '.json'])
+        tmp = Bogo::EphemeralFile.new(["sfn-parameters", ".json"])
         content = new_item ? NEW_ITEM_DEFAULT : load_json(File.read(item)).to_smash
-        if(content[:sfn_parameters_lock])
-          ui.print ui.color(' *', :bold)
+        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)
+          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}")
+        system("#{ENV["EDITOR"]} #{tmp.path}")
         content = load_json(File.read(tmp.path)).to_smash
-        ui.print ui.color(' *', :bold)
-        if(lock_enabled)
+        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)
+          ui.puts ui.color("locked", :blue)
         else
-          ui.puts " Storing #{ui.color(item, :bold)} for storage... #{ui.color('unlocked', :yellow)}"
+          ui.puts " Storing #{ui.color(item, :bold)} for storage... #{ui.color("unlocked", :yellow)}"
         end
         File.write(item, format_json(content))
         tmp.close
@@ -135,21 +134,21 @@ module Sfn
       # @param item [String]
       # @return [String]
       def new_item(item)
-        unless(item.include?(File::SEPARATOR))
+        unless item.include?(File::SEPARATOR)
           prefixes = [
             config.get(:sfn_parameters, :directory),
-            'infrastructure',
-            'stacks'
+            "infrastructure",
+            "stacks",
           ].compact
           prefix = prefixes.find_all do |dir|
             File.directory?(dir)
           end
-          if(prefix.size > 1)
+          if prefix.size > 1
             raise ArgumentError.new "Unable to auto-determine directory for item! Multiple directories found. " \
-              "(detected: #{prefix.join(', ')})"
-          elsif(prefix.empty?)
+                                    "(detected: #{prefix.join(", ")})"
+          elsif prefix.empty?
             raise ArgumentError.new "No existing parameter directories found. Please create required directory. " \
-              "(checked: #{prefixes.join(', ')})"
+                                    "(checked: #{prefixes.join(", ")})"
           end
           File.join(prefix.first, "#{item}.json")
         end
@@ -161,49 +160,39 @@ 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.'
+        if item.to_s.empty?
+          raise NameError.new "Item name is required. No item name provided."
         end
-        items = [
-          item,
-          File.join(
-            config.fetch(
-              :sfn_parameters, :directory, 'stacks'
-            ),
-            item
-          ),
-          File.join(
-            config.fetch(
-              :sfn_parameters, :directory, 'stacks'
+        items = [item]
+        ["", ".json", ".rb", ".xml", ".yaml", ".yml"].each do |extension|
+          items += [
+            File.join(
+              config.fetch(
+                :sfn_parameters, :directory, "stacks"
+              ),
+              "#{item}#{extension}"
             ),
-            "#{item}.json"
-          ),
-          File.join(
-            config.fetch(
-              :sfn_parameters, :directory, 'infrastructure'
+            File.join(
+              config.fetch(
+                :sfn_parameters, :directory, "infrastructure"
+              ),
+              "#{item}#{extension}"
             ),
-            item
-          ),
-          File.join(
-            config.fetch(
-              :sfn_parameters, :directory, 'infrastructure'
-            ),
-            "#{item}.json"
-          )
-        ].map{|item| File.expand_path(item) }.uniq
+          ]
+        end
+        items = items.map { |item| File.expand_path(item) }.uniq
         valid = items.find_all do |file|
           File.exist?(file)
         end
-        if(valid.empty?)
+        if valid.empty?
           raise ArgumentError.new "Failed to locate item `#{item}`!"
-        elsif(valid.size > 1)
+        elsif valid.size > 1
           raise ArgumentError.new "Multiple matches detected for item `#{item}`. " \
-            "(Matches: #{valid.join(', ')})"
+                                  "(Matches: #{valid.join(", ")})"
         else
           valid.first
         end
       end
-
     end
   end
 end

data/lib/sfn-parameters/infrastructure.rb

@@ -1,15 +1,14 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module Sfn
   class Callback
     # Auto load stack parameters for infrastructure pattern
     class ParametersInfrastructure < Callback
-
       include Sfn::Utils::JSON
       include SfnParameters::Utils
 
       # Valid file extensions for configuration file
-      VALID_EXTENSIONS = ['.rb', '.xml', '.json', '.yaml', '.yml']
+      VALID_EXTENSIONS = [".rb", ".xml", ".json", ".yaml", ".yml"]
 
       # Update configuration after configuration is loaded
       #
@@ -24,7 +23,8 @@ module Sfn
         process_information_hash(content, [])
         nil
       end
-      alias_method :after_config_create, :after_config_update
+
+      alias_method :after_config, :after_config_update
 
       protected
 
@@ -33,14 +33,14 @@ module Sfn
       # @param stack_name [String]
       # @return [Smash]
       def load_file_for(stack_name)
-        root_path = config.fetch(:sfn_parameters, :directory, 'infrastructure')
-        isolation_name = config.fetch(:sfn_parameters, :destination,
-          ENV.fetch('SFN_PARAMETERS_DESTINATION', 'default')
-        )
-        paths = Dir.glob(File.join(root_path, "#{isolation_name}{#{VALID_EXTENSIONS.join(',')}}")).map(&:to_s)
-        if(paths.size > 1)
-          raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(', ')})"
-        elsif(paths.empty?)
+        root_path = config.fetch(:sfn_parameters, :directory, "infrastructure")
+        isolation_name = config.fetch(
+          :sfn_parameters, :destination,
+          ENV.fetch("SFN_PARAMETERS_DESTINATION", "default"))
+        paths = Dir.glob(File.join(root_path, "#{isolation_name}{#{VALID_EXTENSIONS.join(",")}}")).map(&:to_s)
+        if paths.size > 1
+          raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(", ")})"
+        elsif paths.empty?
           Smash.new
         else
           unlock_content(Bogo::Config.new(paths.first).data)
@@ -52,21 +52,21 @@ module Sfn
       # @param hash [Hash]
       # @param path [Array<String>] stack name hierarchy
       # @return [TrueClass]
-      def process_information_hash(hash, path=[])
-        if(path.empty? && hash[:template])
+      def process_information_hash(hash, path = [])
+        if path.empty? && hash[:template]
           config[:file] = hash[:template]
         end
         hash.fetch(:parameters, {}).each do |key, value|
-          key = [*path, key].compact.map(&:to_s).join('__')
-          if(current_value = config[:parameters][key])
+          key = [*path, key].compact.map(&:to_s).join("__")
+          if current_value = config[:parameters][key]
             ui.debug "Not setting template parameter `#{key}`. Already set within config. (`#{current_value}`)"
           else
             config[:parameters][key] = value
           end
         end
         hash.fetch(:compile_parameters, {}).each do |key, value|
-          key = [*path, key].compact.map(&:to_s).join('__')
-          if(current_value = config[:compile_parameters][key])
+          key = [*path, key].compact.map(&:to_s).join("__")
+          if current_value = config[:compile_parameters][key]
             ui.debug "Not setting compile time parameter `#{key}`. Already set within config. (`#{current_value}`)"
           else
             config[:compile_parameters][key] = value
@@ -76,7 +76,7 @@ module Sfn
           process_information_hash(value, [*path, key].compact)
         end
         hash.fetch(:mappings, {}).each do |key, value|
-          value = [*path, Bogo::Utility.camel(value)].compact.map(&:to_s).join('__')
+          value = [*path, Bogo::Utility.camel(value)].compact.map(&:to_s).join("__")
           config[:apply_mapping][key] = value
         end
         hash.fetch(:apply_stacks, []).each do |s_name|

data/lib/sfn-parameters/stacks.rb

@@ -1,4 +1,4 @@
-require 'sfn-parameters'
+require "sfn-parameters"
 
 module Sfn
   class Callback
@@ -10,17 +10,16 @@ module Sfn
       # @param stack_name [String]
       # @return [Smash]
       def load_file_for(stack_name)
-        root_path = config.fetch(:sfn_parameters, :directory, 'stacks')
-        paths = Dir.glob(File.join(root_path, "#{stack_name}{#{VALID_EXTENSIONS.join(',')}}")).map(&:to_s)
-        if(paths.size > 1)
-          raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(', ')})"
-        elsif(paths.empty?)
+        root_path = config.fetch(:sfn_parameters, :directory, "stacks")
+        paths = Dir.glob(File.join(root_path, "#{stack_name}{#{VALID_EXTENSIONS.join(",")}}")).map(&:to_s)
+        if paths.size > 1
+          raise ArgumentError.new "Multiple parameter file matches encountered! (#{paths.join(", ")})"
+        elsif (paths.empty?)
           Smash.new
         else
           unlock_content(Bogo::Config.new(paths.first).data)
         end
       end
-
     end
   end
 end

data/lib/sfn-parameters/version.rb

@@ -1,3 +1,3 @@
 module SfnParameters
-  VERSION = Gem::Version.new('0.2.4')
+  VERSION = Gem::Version.new("0.2.6")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfn-parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-12 00:00:00.000000000 Z
+date: 2018-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfn
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SparkleFormation Parameters Callback