Skip to content

Commit

Permalink
Remove extlib dependency, copy mash code into sources, fix CHEF-1405
Browse files Browse the repository at this point in the history
Including extlib in Chef introduces conflicts for those wanting to
access Chef via Rails applications.  Only the Mash class is used by Chef
and this functionality has been extracted from the extlib gem and added
to the Chef sources.

Thanks to Wojciech Wntrzak and Aaron Suggs for proposing and testing
this solution.
  • Loading branch information
Seth Falcon committed Mar 4, 2011
1 parent be142d2 commit 7fe0807
Show file tree
Hide file tree
Showing 14 changed files with 228 additions and 13 deletions.
6 changes: 6 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ Chef incorporates code modified from Open4 (http://www.codeforpeople.com/lib/rub
Chef incorporates code modified from Merb (http://www.merbivore.com), which is Copyright (c) 2008 Engine Yard.

Chef incorporates code modified from deep_merge (http://trac.misuse.org/science/wiki/DeepMerge), which is Copyright (c) 2008 Steve Midgley

Chef incorporates code modified from extlib
(http://github.com/datamapper/extlib), which is Copyright 2009 Dan
Kubb with some portions of mash.rb being verbatim copies of software
licensed under the MIT license and Copyright 2005-2008 David
Heinemeier Hansson
1 change: 0 additions & 1 deletion chef-server-api/README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ chef:
* ruby-openid
* json
* erubis
* extlib
* stomp
* ohai

Expand Down
2 changes: 1 addition & 1 deletion chef-server-api/config/router.rb
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def json_params
# Call Chef's JSON utility instead of the default in Merb,
# JSON.parse.
jobj = Chef::JSONCompat.from_json(raw_post)
jobj = jobj.to_mash if jobj.is_a?(Hash)
jobj = Mash.from_hash(jobj) if jobj.is_a?(Hash)
rescue JSON::ParserError
jobj = Mash.new
end
Expand Down
1 change: 0 additions & 1 deletion chef/README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Install these via your platform's preferred method; for example apt, yum, ports,
* ohai
* bunny
* erubis
* extlib
* highline
* json (1.4.4 - 1.4.6)
* mixlib-authentication
Expand Down
2 changes: 1 addition & 1 deletion chef/chef.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Gem::Specification.new do |s|
s.add_dependency "bunny", ">= 0.6.0"
s.add_dependency "json", ">= 1.4.4", "<= 1.4.6"
s.add_dependency "treetop", "~> 1.4.9"
%w{erubis extlib moneta highline uuidtools}.each { |gem| s.add_dependency gem }
%w{erubis moneta highline uuidtools}.each { |gem| s.add_dependency gem }

s.bindir = "bin"
s.executables = %w( chef-client chef-solo knife shef )
Expand Down
4 changes: 2 additions & 2 deletions chef/lib/chef.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

require 'chef/version'
require 'chef/nil_argument'
require 'extlib'
require 'chef/mash'
require 'chef/exceptions'
require 'chef/log'
require 'chef/config'
Expand All @@ -37,4 +37,4 @@
require 'chef/monkey_patches/tempfile'
require 'chef/monkey_patches/dir'
require 'chef/monkey_patches/string'
require 'chef/monkey_patches/numeric'
require 'chef/monkey_patches/numeric'
2 changes: 1 addition & 1 deletion chef/lib/chef/api_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
require 'chef/couchdb'
require 'chef/certificate'
require 'chef/index_queue'
require 'extlib'
require 'chef/mash'
require 'chef/json_compat'

class Chef
Expand Down
2 changes: 1 addition & 1 deletion chef/lib/chef/cookbook/cookbook_collection.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# limitations under the License.
#

require 'extlib'
require 'chef/mash'

class Chef
# == Chef::CookbookCollection
Expand Down
2 changes: 1 addition & 1 deletion chef/lib/chef/data_bag.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
require 'chef/couchdb'
require 'chef/data_bag_item'
require 'chef/index_queue'
require 'extlib'
require 'chef/mash'
require 'chef/json_compat'

class Chef
Expand Down
2 changes: 1 addition & 1 deletion chef/lib/chef/data_bag_item.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
require 'chef/couchdb'
require 'chef/index_queue'
require 'chef/data_bag'
require 'extlib'
require 'chef/mash'
require 'chef/json_compat'

class Chef
Expand Down
211 changes: 211 additions & 0 deletions chef/lib/chef/mash.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
# Copyright (c) 2009 Dan Kubb

# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:

# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# ---
# ---

# Some portions of blank.rb and mash.rb are verbatim copies of software
# licensed under the MIT license. That license is included below:

# Copyright (c) 2005-2008 David Heinemeier Hansson

# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:

# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# This class has dubious semantics and we only have it so that people can write
# params[:key] instead of params['key'].
class Mash < Hash

# @param constructor<Object>
# The default value for the mash. Defaults to an empty hash.
#
# @details [Alternatives]
# If constructor is a Hash, a new mash will be created based on the keys of
# the hash and no default value will be set.
def initialize(constructor = {})
if constructor.is_a?(Hash)
super()
update(constructor)
else
super(constructor)
end
end

# @param key<Object> The default value for the mash. Defaults to nil.
#
# @details [Alternatives]
# If key is a Symbol and it is a key in the mash, then the default value will
# be set to the value matching the key.
def default(key = nil)
if key.is_a?(Symbol) && include?(key = key.to_s)
self[key]
else
super
end
end

alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
alias_method :regular_update, :update unless method_defined?(:regular_update)

# @param key<Object> The key to set.
# @param value<Object>
# The value to set the key to.
#
# @see Mash#convert_key
# @see Mash#convert_value
def []=(key, value)
regular_writer(convert_key(key), convert_value(value))
end

# @param other_hash<Hash>
# A hash to update values in the mash with. The keys and the values will be
# converted to Mash format.
#
# @return [Mash] The updated mash.
def update(other_hash)
other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
self
end

alias_method :merge!, :update

# @param key<Object> The key to check for. This will be run through convert_key.
#
# @return [Boolean] True if the key exists in the mash.
def key?(key)
super(convert_key(key))
end

# def include? def has_key? def member?
alias_method :include?, :key?
alias_method :has_key?, :key?
alias_method :member?, :key?

# @param key<Object> The key to fetch. This will be run through convert_key.
# @param *extras<Array> Default value.
#
# @return [Object] The value at key or the default value.
def fetch(key, *extras)
super(convert_key(key), *extras)
end

# @param *indices<Array>
# The keys to retrieve values for. These will be run through +convert_key+.
#
# @return [Array] The values at each of the provided keys
def values_at(*indices)
indices.collect {|key| self[convert_key(key)]}
end

# @param hash<Hash> The hash to merge with the mash.
#
# @return [Mash] A new mash with the hash values merged in.
def merge(hash)
self.dup.update(hash)
end

# @param key<Object>
# The key to delete from the mash.\
def delete(key)
super(convert_key(key))
end

# @param *rejected<Array[(String, Symbol)] The mash keys to exclude.
#
# @return [Mash] A new mash without the selected keys.
#
# @example
# { :one => 1, :two => 2, :three => 3 }.except(:one)
# #=> { "two" => 2, "three" => 3 }
def except(*keys)
super(*keys.map {|k| convert_key(k)})
end

# Used to provide the same interface as Hash.
#
# @return [Mash] This mash unchanged.
def stringify_keys!; self end

# @return [Hash] The mash as a Hash with symbolized keys.
def symbolize_keys
h = Hash.new(default)
each { |key, val| h[key.to_sym] = val }
h
end

# @return [Hash] The mash as a Hash with string keys.
def to_hash
Hash.new(default).merge(self)
end

# @return [Mash] Convert a Hash into a Mash
# The input Hash's default value is maintained
def self.from_hash(hash)
mash = Mash.new(hash)
mash.default = hash.default
mash
end

protected
# @param key<Object> The key to convert.
#
# @param [Object]
# The converted key. If the key was a symbol, it will be converted to a
# string.
#
# @api private
def convert_key(key)
key.kind_of?(Symbol) ? key.to_s : key
end

# @param value<Object> The value to convert.
#
# @return [Object]
# The converted value. A Hash or an Array of hashes, will be converted to
# their Mash equivalents.
#
# @api private
def convert_value(value)
if value.class == Hash
Mash.from_hash(value)
elsif value.is_a?(Array)
value.collect { |e| convert_value(e) }
else
value
end
end
end
2 changes: 1 addition & 1 deletion chef/lib/chef/node.rb
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
require 'chef/run_list'
require 'chef/node/attribute'
require 'chef/index_queue'
require 'extlib'
require 'chef/mash'
require 'chef/json_compat'

class Chef
Expand Down
2 changes: 1 addition & 1 deletion chef/lib/chef/role.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
require 'chef/couchdb'
require 'chef/run_list'
require 'chef/index_queue'
require 'extlib'
require 'chef/mash'
require 'chef/json_compat'

class Chef
Expand Down
2 changes: 1 addition & 1 deletion chef/lib/chef/run_list/run_list_expansion.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

require 'extlib'
require 'chef/mash'

require 'chef/mixin/deep_merge'

Expand Down

0 comments on commit 7fe0807

Please sign in to comment.