chef-sugar 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4243d6a2e55c5d3e83160d715431a740038e4b4
-  data.tar.gz: 8f9091cee17fb78613e10c113b37ba13d247be49
+  metadata.gz: 5f284c42cb57577613febeaaaad0c92dc7da64a9
+  data.tar.gz: ec1b3ba2496d4fb0bf99bbb0003410e21fb00217
 SHA512:
-  metadata.gz: f017af9a225a646e6e3d9676d9186497d48cbc15e79a0fd4ca09d0658cd0dd2fc71432275c1b1ca586cab9a5cc53ff4f7c8ef65c104970928b6a4c8b2565c431
-  data.tar.gz: 4f93d063e15757b9ad0adf442ab4d4172862a3b18eb0c85ed26867b2556e2c1cb71d9d5c06bb92503ddad3403fa2876d7c9edac68581ec8b8a933dc12a097fa1
+  metadata.gz: ca8d21daa32329740d9e051541993eba4fa9fc76d5d01aa4b6dce6825c9184bc60013d663e03273b5379452ee30d3a8c81304e880e4e9a3e1c5dbf92de3e498e
+  data.tar.gz: 08770b8f178afd0d9838f94bfda7e5cc2ffc3361b8090c4f71d500e3c8384ee8639a6ec09c81d4b3ab84238a105b1b053b1a9c864737b8078062e50aaa575b03

data/CHANGELOG.md

@@ -2,6 +2,12 @@ Chef Sugar Changelog
 =========================
 This file is used to list changes made in each version of the chef-sugar cookbook and gem.
 
+v3.3.0 (2016-01-11)
+-------------------
+### Improvements
+- Break up `Chef::Sugar::Constraints` into a class and a dsl file
+- Add `platform_version` method with full constraints comparison support
+
 v3.2.0 (2015-12-10)
 -------------------
 ### Improvements

data/lib/chef/sugar.rb

@@ -23,6 +23,7 @@ class Chef
     require_relative 'sugar/architecture'
     require_relative 'sugar/cloud'
     require_relative 'sugar/constraints'
+    require_relative 'sugar/constraints_dsl'
     require_relative 'sugar/data_bag'
     require_relative 'sugar/docker'
     require_relative 'sugar/filters'

data/lib/chef/sugar/constraints.rb

@@ -17,34 +17,6 @@
 class Chef
   module Sugar
     module Constraints
-      extend self
-
-      #
-      # Shortcut method for creating a new {Version} object.
-      #
-      # @param [String] version
-      #   the version (as a string) to create
-      #
-      # @return [Chef::Sugar::Constraints::Version]
-      #   the new version object
-      #
-      def version(version)
-        Chef::Sugar::Constraints::Version.new(version)
-      end
-
-      #
-      # Shortcut method for creating a new {Constraint} object.
-      #
-      # @param [String, Array<String>] constraints
-      #   the list of constraints to use
-      #
-      # @return [Chef::Sugar::Constraints::Constraint]
-      #   the new constraint object
-      #
-      def constraint(*constraints)
-        Chef::Sugar::Constraints::Constraint.new(*constraints)
-      end
-
       #
       # This class is a wrapper around a version requirement that adds a nice
       # DSL for comparing constraints:
@@ -99,7 +71,7 @@ class Chef
       # @example Compare a version with constraints
       #   Chef::Sugar::Version('1.2.3').satisfies?('~> 1.3.4', '< 2.0.5')
       #
-      class Version
+      class Version < String
         #
         # Create a new version object.
         #
@@ -107,6 +79,7 @@ class Chef
         #   the version to create
         #
         def initialize(version)
+          super
           @version = Gem::Version.new(version)
         end
 
@@ -131,31 +104,5 @@ class Chef
         end
       end
     end
-
-    module DSL
-      # @see Chef::Sugar::Constraints#version
-      def version(version)
-        Chef::Sugar::Constraints::Version.new(version)
-      end
-
-      # @see Chef::Sugar::Constraints#constraint
-      def constraint(*constraints)
-        Chef::Sugar::Constraints.constraint(*constraints)
-      end
-
-      #
-      # This wrapper/convenience method is only available in the recipe DSL. It
-      # creates a new version object from the {Chef::VERSION}.
-      #
-      # @example Check if Chef 11+
-      #   chef_version.satisfies?('>= 11.0.0')
-      #
-      # @return [Chef::Sugar::Constraints::Version]
-      #   a version object, wrapping the current {Chef::VERSION}
-      #
-      def chef_version
-        version(Chef::VERSION)
-      end
-    end
   end
 end

data/lib/chef/sugar/constraints_dsl.rb

@@ -0,0 +1,83 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative 'constraints'
+
+class Chef
+  module Sugar
+    #
+    # The Constraints DSL methods were broken out into this separate
+    # file to allow projects (such as Omnibus) to consume the
+    # Chef::Sugar::Constraints classes without the DSL methods
+    # stepping on existing methods of the same name.
+    #
+    module Constraints
+      extend self
+
+      #
+      # Shortcut method for creating a new {Version} object.
+      #
+      # @param [String] version
+      #   the version (as a string) to create
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #   the new version object
+      #
+      def version(version)
+        Chef::Sugar::Constraints::Version.new(version)
+      end
+
+      #
+      # Shortcut method for creating a new {Constraint} object.
+      #
+      # @param [String, Array<String>] constraints
+      #   the list of constraints to use
+      #
+      # @return [Chef::Sugar::Constraints::Constraint]
+      #   the new constraint object
+      #
+      def constraint(*constraints)
+        Chef::Sugar::Constraints::Constraint.new(*constraints)
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Constraints#version
+      def version(version)
+        Chef::Sugar::Constraints::Version.new(version)
+      end
+
+      # @see Chef::Sugar::Constraints#constraint
+      def constraint(*constraints)
+        Chef::Sugar::Constraints.constraint(*constraints)
+      end
+
+      #
+      # This wrapper/convenience method is only available in the recipe DSL. It
+      # creates a new version object from the {Chef::VERSION}.
+      #
+      # @example Check if Chef 11+
+      #   chef_version.satisfies?('>= 11.0.0')
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #   a version object, wrapping the current {Chef::VERSION}
+      #
+      def chef_version
+        version(Chef::VERSION)
+      end
+    end
+  end
+end

data/lib/chef/sugar/platform.rb

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 
+require_relative 'constraints'
+
 class Chef
   module Sugar
     module Platform
@@ -270,6 +272,18 @@ class Chef
       def ios_xr?(node)
         node['platform'] == 'ios_xr'
       end
+
+      #
+      # Return the platform_version for the node. Acts like a String
+      # but also provides a mechanism for checking version constraints.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Chef::Sugar::Constraints::Version]
+      #
+      def platform_version(node)
+        Chef::Sugar::Constraints::Version.new(node['platform_version'])
+      end
     end
 
     module DSL

data/lib/chef/sugar/version.rb

@@ -16,6 +16,6 @@
 
 class Chef
   module Sugar
-    VERSION = '3.2.0'
+    VERSION = '3.3.0'
   end
 end

data/spec/unit/chef/sugar/constraints_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe Chef::Sugar::Constraints do
-  # it_behaves_like 'a chef sugar'
-
   describe '#version' do
     let(:version) { described_class.version('1.2.3') }
 
@@ -10,6 +8,10 @@ describe Chef::Sugar::Constraints do
       expect(version).to be_a(Chef::Sugar::Constraints::Version)
     end
 
+    it 'behaves like a String' do
+      expect(version).to be_a(String)
+    end
+
     it 'returns true with the version is satisifed' do
       expect(version).to be_satisfies('~> 1.2.0')
     end

data/spec/unit/chef/sugar/platform_spec.rb

@@ -171,6 +171,13 @@ describe Chef::Sugar::Platform do
     end
   end
 
+  describe '#platform_version' do
+    it 'returns the platform version' do
+      node = { 'platform_version' => '1.2.3' }
+      expect(described_class.platform_version(node)).to eq('1.2.3')
+    end
+  end
+
   context 'dynamic matchers' do
     describe '#ubuntu_after_lucid?' do
       it 'returns true when the version is later than 10.04' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-sugar
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ files:
 - lib/chef/sugar/architecture.rb
 - lib/chef/sugar/cloud.rb
 - lib/chef/sugar/constraints.rb
+- lib/chef/sugar/constraints_dsl.rb
 - lib/chef/sugar/core_extensions.rb
 - lib/chef/sugar/core_extensions/array.rb
 - lib/chef/sugar/core_extensions/object.rb