knife-attribute 0.1.2 → 1.0.0

data/README.md

@@ -15,8 +15,9 @@ gem install knife-attribute
 In this initial release, only `node attribute set` is implemented, more to
 follow in the near future.
 
-To work with attributes of type `default`, `normal`, `override` or `automatic`,
-use the `-t TYPE` flag (default if unspecified is `normal`).
+To work with attributes of type `default`, `normal` or `override`, use the
+`-t TYPE` flag (the default type if unspecified is `normal` for `nodes`, and
+`default` for all other entity types).
 
 ### node attribute set
 
@@ -74,10 +75,42 @@ The above would delete the `foo.example.org` node's `normal` attribute `tz`.
 knife node attribute delete foo.example.org apache.listen_ports -t override
 ```
 
-The above would delete the `foo.example.org` node's `override` attribute.
+The above would delete the `foo.example.org` node's `override` attribute
 `['apache']['listen_ports']`.
 
+### role attribute set
+
+Valid attribute types for roles are: `['default', 'override']`.
+
+For usage, see `node attribute set` above.
+
+### role attribute get
+
+Valid attribute types for roles are: `['default', 'override']`.
+
+For usage, see `node attribute get` above.
+
+### role attribute delete
+
+Valid attribute types for roles are: `['default', 'override']`.
+
+For usage, see `node attribute delete` above.
+
+### environment attribute set
+
+Valid attribute types for environments are: `['default', 'override']`.
+
+For usage, see `node attribute set` above.
+
+### environment attribute get
+
+Valid attribute types for environments are: `['default', 'override']`.
+
+For usage, see `node attribute get` above.
+
+### environment attribute delete
+
+Valid attribute types for environments are: `['default', 'override']`.
+
+For usage, see `node attribute delete` above.
 
-## TODO
-- Implement attribute get/set/delete for roles
-- Implement attribute get/set/delete for environments

data/lib/knife-attribute.rb

@@ -1,9 +1,19 @@
 require 'chef/knife'
 require 'knife-attribute/version'
-require 'knife-attribute/attribute_types'
-require 'knife-attribute/helpers'
 require 'knife-attribute/common_options'
+require 'knife-attribute/helpers'
+require 'knife-attribute/get'
+require 'knife-attribute/set'
+require 'knife-attribute/delete'
 require 'knife-attribute/node/helpers'
-require 'knife-attribute/node/set'
 require 'knife-attribute/node/get'
+require 'knife-attribute/node/set'
 require 'knife-attribute/node/delete'
+require 'knife-attribute/role/helpers'
+require 'knife-attribute/role/get'
+require 'knife-attribute/role/set'
+require 'knife-attribute/role/delete'
+require 'knife-attribute/environment/helpers'
+require 'knife-attribute/environment/get'
+require 'knife-attribute/environment/set'
+require 'knife-attribute/environment/delete'

data/lib/knife-attribute/common_options.rb

@@ -5,13 +5,12 @@ module KnifeAttribute
         option :attribute_type,
           short: '-t TYPE',
           long: '--type TYPE',
-          default: 'normal',
-          description: "Attribute type to set, one of: #{KnifeAttribute::ATTRIBUTE_TYPES} (default: 'normal')"
+          description: "Attribute type, one of: #{attribute_type_map.keys.map(&:to_s)} (default: '#{default_attribute_type.to_s}')"
       end
     end
 
     def check_type
-      if config[:attribute_type] and !KnifeAttribute::ATTRIBUTE_TYPES.include?(config[:attribute_type])
+      if config[:attribute_type] and !attribute_type_map.keys.include?(config[:attribute_type].to_sym)
         show_usage
         ui.fatal("Invalid attribute type: '#{config[:attribute_type]}'")
       end

data/lib/knife-attribute/delete.rb

@@ -0,0 +1,60 @@
+module KnifeAttribute
+  module Delete
+    def self.included(base)
+      base.class_eval do
+        include KnifeAttribute::CommonOptions
+
+        def run
+          check_arguments
+
+          if config[:attribute_type]
+            delete_attribute(entity.send(attribute_type_map[config[:attribute_type].to_sym]))
+          else
+            delete_attribute(entity.send(attribute_type_map[default_attribute_type]))
+          end
+        end
+
+        private
+          def check_arguments
+            if entity_name.nil?
+              show_usage
+              ui.fatal("You must specify a #{entity_type.to_s} name")
+              exit 1
+            end
+
+            if attribute.nil?
+              show_usage
+              ui.fatal('You must specify an attribute')
+              exit 1
+            end
+
+            check_type
+          end
+
+          def delete_attribute(target)
+            path = attribute.split('.')
+            key = path.pop
+
+            if path.length == 0
+              parent = target
+            else
+              parent = path.inject(target) { |obj, subkey| obj[subkey] || break }
+            end
+
+            result = false
+            if parent and parent.has_key?(key)
+              parent.delete(key)
+              result = entity.save
+            end
+
+            if result
+              ui.info("Successfully deleted #{entity_type.to_s} #{ui.color(entity_name, :cyan)} attribute #{ui.color(attribute, :green)}")
+            else
+              ui.fatal("Failed deleting #{entity_type.to_s} #{ui.color(entity_name, :magenta)} attribute #{ui.color(new_attribute, :magenta)}")
+              exit 1
+            end
+          end
+      end
+    end
+  end
+end

data/lib/knife-attribute/environment/delete.rb

@@ -0,0 +1,11 @@
+module KnifeAttribute
+  module Environment
+    class EnvironmentAttributeDelete < Chef::Knife
+      include KnifeAttribute::Environment::Helpers
+      include KnifeAttribute::Delete
+
+      banner 'knife environment attribute delete ENVIRONMENT PERIOD.SEPARATED.ATTRIBUTE (options)'
+
+    end
+  end
+end

data/lib/knife-attribute/environment/get.rb

@@ -0,0 +1,11 @@
+module KnifeAttribute
+  module Environment
+    class EnvironmentAttributeGet < Chef::Knife
+      include KnifeAttribute::Environment::Helpers
+      include KnifeAttribute::Get
+
+      banner 'knife environment attribute get ENVIRONMENT PERIOD.SEPARATED.ATTRIBUTE (options)'
+
+    end
+  end
+end

data/lib/knife-attribute/environment/helpers.rb

@@ -0,0 +1,34 @@
+module KnifeAttribute
+  module Environment
+    module Helpers
+      include KnifeAttribute::Helpers
+
+      def self.included(base)
+        base.class_eval do
+          deps do
+            require 'chef/json_compat'
+          end
+
+          def self.attribute_type_map
+            {
+              default: :default_attributes,
+              override: :override_attributes,
+            }
+          end
+
+          def self.default_attribute_type
+            :default
+          end
+        end
+      end
+
+      def environment
+        @environment ||= Chef::Environment.load(entity_name)
+      end
+
+      def entity_type
+        :environment
+      end
+    end
+  end
+end

data/lib/knife-attribute/environment/set.rb

@@ -0,0 +1,11 @@
+module KnifeAttribute
+  module Environment
+    class EnvironmentAttributeSet < Chef::Knife
+      include KnifeAttribute::Environment::Helpers
+      include KnifeAttribute::Set
+
+      banner 'knife environment attribute set ENVIRONMENT PERIOD.SEPARATED.ATTRIBUTE STRING_OR_JSON_VALUE (options)'
+
+    end
+  end
+end

data/lib/knife-attribute/get.rb

@@ -0,0 +1,43 @@
+module KnifeAttribute
+  module Get
+    def self.included(base)
+      base.class_eval do
+        include KnifeAttribute::CommonOptions
+
+        def run
+          check_arguments
+
+          if config[:attribute_type]
+            get_attribute(entity.send(attribute_type_map[config[:attribute_type].to_sym]))
+          elsif entity.respond_to?(:construct_attributes)
+            get_attribute(entity.construct_attributes)
+          else
+            get_attribute(entity.send(attribute_type_map[default_attribute_type]))
+          end
+        end
+
+        private
+          def check_arguments
+            if entity_name.nil?
+              show_usage
+              ui.fatal("You must specify a #{entity_type.to_s} name")
+              exit 1
+            end
+
+            if attribute.nil?
+              show_usage
+              ui.fatal('You must specify an attribute')
+              exit 1
+            end
+
+            check_type
+          end
+
+          def get_attribute(target)
+            result = ui.presenter.extract_nested_value(target, attribute)
+            output(format_for_display(result))
+          end
+      end
+    end
+  end
+end

data/lib/knife-attribute/helpers.rb

@@ -1,5 +1,44 @@
 module KnifeAttribute
   module Helpers
+    def self.included(base)
+      base.class_eval do
+        def self.attribute_type_map
+          fail NotImplementedError, "Missing `attribute_types` implementation for current object"
+        end
+
+        def self.default_attribute_type
+          fail NotImplementedError, "Missing `default_attribute_type` implementation for current object"
+        end
+      end
+    end
+    def attribute
+      @attribute ||= @name_args[1]
+    end
+
+    def value
+      @value ||= @name_args[2]
+    end
+
+    def entity_name
+      @entity_name ||= @name_args[0]
+    end
+
+    def entity
+      @entity = send(entity_type)
+    end
+
+    def entity_type
+      fail NotImplementedError, "Missing `entity_type` implementation for current object"
+    end
+
+    def attribute_type_map
+      self.class.attribute_type_map
+    end
+
+    def default_attribute_type
+      self.class.default_attribute_type
+    end
+
     def mapped_config
       @mapped_config ||= config[:attribute_type] == 'normal' ? {} : {all_attributes: true}
     end

data/lib/knife-attribute/node/delete.rb

@@ -1,68 +1,11 @@
 module KnifeAttribute
   module Node
     class NodeAttributeDelete < Chef::Knife
-      include KnifeAttribute::CommonOptions
       include KnifeAttribute::Node::Helpers
+      include KnifeAttribute::Delete
 
       banner 'knife node attribute delete NODE PERIOD.SEPARATED.ATTRIBUTE (options)'
 
-      def run
-        check_arguments
-
-        case config[:attribute_type]
-        when 'default'
-          delete_attribute(node.default_attrs)
-        when 'override'
-          delete_attribute(node.override_attrs)
-        when 'automatic'
-          delete_attribute(node.automatic_attrs)
-        when 'normal'
-          delete_attribute(node.normal_attrs)
-        else
-          delete_attribute(node.normal_attrs)
-        end
-      end
-
-      private
-        def check_arguments
-          if node_name.nil?
-            show_usage
-            ui.fatal('You must specify a node name')
-            exit 1
-          end
-
-          if attribute.nil?
-            show_usage
-            ui.fatal('You must specify an attribute')
-            exit 1
-          end
-
-          check_type
-        end
-
-        def delete_attribute(target)
-          path = attribute.split('.')
-          key = path.pop
-
-          if path.length == 0
-            parent = target
-          else
-            parent = path.inject(target) { |obj, item| obj[item] || break }
-          end
-
-          result = false
-          if parent and parent.has_key?(key)
-            parent.delete(key)
-            result = node.save
-          end
-
-          if result
-            ui.info("Successfully deleted node #{ui.color(node_name, :cyan)} attribute #{ui.color(attribute, :green)}")
-          else
-            ui.fatal("Failed deleting node #{ui.color(node_name, :magenta)} attribute #{ui.color(new_attribute, :magenta)}")
-            exit 1
-          end
-        end
     end
   end
 end

data/lib/knife-attribute/node/get.rb

@@ -1,49 +1,11 @@
 module KnifeAttribute
   module Node
     class NodeAttributeGet < Chef::Knife
-      include KnifeAttribute::CommonOptions
       include KnifeAttribute::Node::Helpers
+      include KnifeAttribute::Get
 
       banner 'knife node attribute get NODE PERIOD.SEPARATED.ATTRIBUTE (options)'
 
-      def run
-        check_arguments
-
-        case config[:attribute_type]
-        when 'default'
-          get_attribute(node.default_attrs)
-        when 'override'
-          get_attribute(node.override_attrs)
-        when 'automatic'
-          get_attribute(node.automatic_attrs)
-        when 'normal'
-          get_attribute(node.normal_attrs)
-        else
-          get_attribute(node.construct_attributes)
-        end
-      end
-
-      private
-        def check_arguments
-          if node_name.nil?
-            show_usage
-            ui.fatal('You must specify a node name')
-            exit 1
-          end
-
-          if attribute.nil?
-            show_usage
-            ui.fatal('You must specify an attribute')
-            exit 1
-          end
-
-          check_type
-        end
-
-        def get_attribute(target)
-          result = ui.presenter.extract_nested_value(target, attribute)
-          output(format_for_display(result))
-        end
     end
   end
 end

data/lib/knife-attribute/node/helpers.rb

@@ -9,23 +9,27 @@ module KnifeAttribute
             require 'chef/node'
             require 'chef/json_compat'
           end
-        end
-      end
 
-      def node_name
-        @node_name ||= @name_args[0]
-      end
+          def self.attribute_type_map
+            {
+              default: :default_attrs,
+              normal: :normal_attrs,
+              override: :override_attrs,
+            }
+          end
 
-      def attribute
-        @attribute ||= @name_args[1]
+          def self.default_attribute_type
+            :normal
+          end
+        end
       end
 
-      def value
-        @value ||= @name_args[2]
+      def node
+        @node ||= Chef::Node.load(entity_name)
       end
 
-      def node
-        @node ||= Chef::Node.load(node_name)
+      def entity_type
+        :node
       end
     end
   end

data/lib/knife-attribute/node/set.rb

@@ -1,65 +1,11 @@
 module KnifeAttribute
   module Node
     class NodeAttributeSet < Chef::Knife
-      include KnifeAttribute::CommonOptions
       include KnifeAttribute::Node::Helpers
+      include KnifeAttribute::Set
 
       banner 'knife node attribute set NODE PERIOD.SEPARATED.ATTRIBUTE STRING_OR_JSON_VALUE (options)'
 
-      def run
-        check_arguments
-
-        case config[:attribute_type]
-        when 'default'
-          set_attribute(node.default_attrs)
-        when 'override'
-          set_attribute(node.override_attrs)
-        when 'automatic'
-          set_attribute(node.automatic_attrs)
-        when 'normal', nil
-          set_attribute(node.normal_attrs)
-        end
-      end
-
-      private
-        def check_arguments
-          if node_name.nil?
-            show_usage
-            ui.fatal('You must specify a node name')
-            exit 1
-          end
-
-          if attribute.nil?
-            show_usage
-            ui.fatal('You must specify an attribute')
-            exit 1
-          end
-
-          if value.nil?
-            show_usage
-            ui.fatal('You must specify a value')
-            exit 1
-          end
-
-          check_type
-        end
-
-        def set_attribute(target)
-          begin
-            new_value = Chef::JSONCompat.from_json(value)
-          rescue JSON::ParserError, Yajl::ParseError
-            new_value = value
-          end
-          new_attribute = attribute.split('.').reverse.inject(new_value) { |result, key| { key => result } }
-          target.merge!(new_attribute)
-
-          if node.save
-            ui.info("Successfully set node #{ui.color(node_name, :cyan)} attribute #{ui.color(attribute, :cyan)} to: #{ui.color(new_value.inspect, :green)}")
-          else
-            ui.fatal("Failed updating node #{ui.color(node_name, :magenta)} attribute #{ui.color(new_attribute, :magenta)}")
-            exit 1
-          end
-        end
     end
   end
 end

data/lib/knife-attribute/role/delete.rb

@@ -0,0 +1,11 @@
+module KnifeAttribute
+  module Role
+    class RoleAttributeDelete < Chef::Knife
+      include KnifeAttribute::Role::Helpers
+      include KnifeAttribute::Delete
+
+      banner 'knife role attribute delete ROLE PERIOD.SEPARATED.ATTRIBUTE (options)'
+
+    end
+  end
+end

data/lib/knife-attribute/role/get.rb

@@ -0,0 +1,11 @@
+module KnifeAttribute
+  module Role
+    class RoleAttributeGet < Chef::Knife
+      include KnifeAttribute::Role::Helpers
+      include KnifeAttribute::Get
+
+      banner 'knife role attribute get ROLE PERIOD.SEPARATED.ATTRIBUTE (options)'
+
+    end
+  end
+end

data/lib/knife-attribute/role/helpers.rb

@@ -0,0 +1,34 @@
+module KnifeAttribute
+  module Role
+    module Helpers
+      include KnifeAttribute::Helpers
+
+      def self.included(base)
+        base.class_eval do
+          deps do
+            require 'chef/json_compat'
+          end
+
+          def self.attribute_type_map
+            {
+              default: :default_attributes,
+              override: :override_attributes,
+            }
+          end
+
+          def self.default_attribute_type
+            :default
+          end
+        end
+      end
+
+      def role
+        @role ||= Chef::Role.load(entity_name)
+      end
+
+      def entity_type
+        :role
+      end
+    end
+  end
+end

data/lib/knife-attribute/role/set.rb

@@ -0,0 +1,11 @@
+module KnifeAttribute
+  module Role
+    class RoleAttributeSet < Chef::Knife
+      include KnifeAttribute::Role::Helpers
+      include KnifeAttribute::Set
+
+      banner 'knife role attribute set ROLE PERIOD.SEPARATED.ATTRIBUTE STRING_OR_JSON_VALUE (options)'
+
+    end
+  end
+end

data/lib/knife-attribute/set.rb

@@ -0,0 +1,59 @@
+module KnifeAttribute
+  module Set
+    def self.included(base)
+      base.class_eval do
+        include KnifeAttribute::CommonOptions
+
+        def run
+          check_arguments
+
+          if config[:attribute_type]
+            set_attribute(entity.send(attribute_type_map[config[:attribute_type].to_sym]))
+          else
+            set_attribute(entity.send(attribute_type_map[default_attribute_type]))
+          end
+        end
+
+        private
+          def check_arguments
+            if entity_name.nil?
+              show_usage
+              ui.fatal("You must specify a #{entity_type.to_s} name")
+              exit 1
+            end
+
+            if attribute.nil?
+              show_usage
+              ui.fatal('You must specify an attribute')
+              exit 1
+            end
+
+            if value.nil?
+              show_usage
+              ui.fatal('You must specify a value')
+              exit 1
+            end
+
+            check_type
+          end
+
+          def set_attribute(target)
+            begin
+              new_value = Chef::JSONCompat.from_json(value)
+            rescue JSON::ParserError, Yajl::ParseError
+              new_value = value
+            end
+            new_attribute = attribute.split('.').reverse.inject(new_value) { |result, key| { key => result } }
+            target.merge!(new_attribute)
+
+            if entity.save
+              ui.info("Successfully set #{entity_type.to_s} #{ui.color(entity_name, :cyan)} attribute #{ui.color(attribute, :cyan)} to: #{ui.color(new_value.inspect, :green)}")
+            else
+              ui.fatal("Failed updating #{entity_type.to_s} #{ui.color(entity_name, :magenta)} attribute #{ui.color(new_attribute, :magenta)}")
+              exit 1
+            end
+          end
+      end
+    end
+  end
+end

data/lib/knife-attribute/version.rb

@@ -1,3 +1,3 @@
 module KnifeAttribute
-  VERSION = "0.1.2"
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-attribute
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -75,13 +75,23 @@ files:
 - knife-attribute.gemspec
 - lib/chef/knife/attribute.rb
 - lib/knife-attribute.rb
-- lib/knife-attribute/attribute_types.rb
 - lib/knife-attribute/common_options.rb
+- lib/knife-attribute/delete.rb
+- lib/knife-attribute/environment/delete.rb
+- lib/knife-attribute/environment/get.rb
+- lib/knife-attribute/environment/helpers.rb
+- lib/knife-attribute/environment/set.rb
+- lib/knife-attribute/get.rb
 - lib/knife-attribute/helpers.rb
 - lib/knife-attribute/node/delete.rb
 - lib/knife-attribute/node/get.rb
 - lib/knife-attribute/node/helpers.rb
 - lib/knife-attribute/node/set.rb
+- lib/knife-attribute/role/delete.rb
+- lib/knife-attribute/role/get.rb
+- lib/knife-attribute/role/helpers.rb
+- lib/knife-attribute/role/set.rb
+- lib/knife-attribute/set.rb
 - lib/knife-attribute/version.rb
 homepage: https://github.com/pdf/knife-attribute
 licenses:
@@ -98,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2202112453603936614
+      hash: -2632599109379407878
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2202112453603936614
+      hash: -2632599109379407878
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/knife-attribute/attribute_types.rb

@@ -1,4 +0,0 @@
-module KnifeAttribute
-  ATTRIBUTE_TYPES = %w{default normal override automatic}
-end
-