hoodie 0.5.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff2458695208711c724a6671388e22ecd83099e8
-  data.tar.gz: 74ed7e3f9bb3872257bb65e3b5eaac1328feb91d
+  metadata.gz: cb724e1cb6507df195da226f792105ad37fc4431
+  data.tar.gz: ae69f0b9bad59fbe1b82c891a51d2bd2dcf304c9
 SHA512:
-  metadata.gz: cd2fdfb5db788a96acd63ce7d060d44b7be78d78237d3cce3f25d80f2a0a9e4d7e01781264f386ee42ddae8ea59a9527e519141998f3fe63bfb6b419039e5d29
-  data.tar.gz: 1b4f584e16a8a4aa27cfa10cc17f88cf3b20d2a8352e6e175e66e1a584f5c819719f8290b63c76f4378cc42db316f1a51c731d8a4a9b4e1654e59bf030a51564
+  metadata.gz: 68e2bfa7b4603de807849eb6ac65f95a256c2b4aad183d5f6390afe99422d306196e47da34914524bdb50c95c646b06ac55ad367277efcbd6efd5bff92370424
+  data.tar.gz: 2349207c4c7ddcf327dc8bafa1e666580b437b3df00b9bf62f71cb79242bf1dac9d731ad833f81cd57bc70ff2e7a028f4b62add255e99577d21a5d305e4360f8

data/.gitignore

@@ -191,3 +191,4 @@ cscope.po.out
 vendor/bundle
 vendor/cache
 Gemfile.lock
+repl.rb

data/Gemfile

@@ -1,3 +1,22 @@
+# encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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.
+#
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -19,28 +19,13 @@
 
 require 'bundler/gem_tasks'
 
-task default: 'test'
-
-desc 'Run all tests except `kitchen`'
-task test: [:yard, :rubocop, :spec]
-
-desc 'Run all tasks'
-task all: [:yard, :rubocop, :spec]
-
-desc 'Build documentation'
-task doc: [:yard]
-
-require 'yard'
-YARD::Config.load_plugin 'redcarpet-ext'
-YARD::Rake::YardocTask.new do |t|
-  t.files = ['**/*.rb', '-', 'README.md', 'CHANGELOG.md', 'LICENSE']
-  t.options = ['--markup-provider=redcarpet', '--markup=markdown']
+desc 'Generate Ruby documentation'
+task :yard do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['**/*.rb', '-', 'README.md', 'LICENSE']
+    t.stats_options = %w(--list-undoc)
+  end
 end
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:chefspec) do |t|
-  t.rspec_opts = '--color --format progress'
-end
+task doc: %w(yard)

data/hoodie.gemspec

@@ -37,33 +37,10 @@ Gem::Specification.new do |gem|
   gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
   gem.extra_rdoc_files = %w[LICENSE README.md]
 
-  gem.add_runtime_dependency 'anemone', '>= 0.7.2'
-  gem.add_runtime_dependency 'hitimes'
-
   # Development gems
   gem.add_development_dependency 'rake',        '~> 10.4'
   gem.add_development_dependency 'yard',        '~> 0.8'
   gem.add_development_dependency 'pry'
-
-  # Test gems
-  gem.add_development_dependency 'rspec',       '~> 3.2'
-  gem.add_development_dependency 'fuubar',      '~> 2.0'
-  gem.add_development_dependency 'simplecov',   '~> 0.9'
   gem.add_development_dependency 'inch'
   gem.add_development_dependency 'yardstick'
-  gem.add_development_dependency 'guard'
-  gem.add_development_dependency 'guard-shell'
-  gem.add_development_dependency 'guard-yard'
-  gem.add_development_dependency 'guard-rubocop'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'ruby_gntp'
-
-  # Integration gems
-  gem.add_development_dependency 'rubocop'
-  gem.add_development_dependency 'geminabox-rake'
-
-  # Versioning
-  gem.add_development_dependency 'version'
-  gem.add_development_dependency 'thor-scmversion'
-  gem.add_development_dependency 'semverse'
 end

data/lib/hoodie.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 #
-# Author: Stefano Harding <riddopic@gmail.com>
-#
-# Copyright (C) 2014-2015 Stefano Harding
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,7 +17,11 @@
 # limitations under the License.
 #
 
+require 'hoodie/core_ext/string'
+require 'hoodie/core_ext/blank'
 require 'hoodie/configuration'
+require 'hoodie/core_ext/hash'
+require 'hoodie/core_ext/try'
 
 module Hoodie
 
@@ -31,59 +35,47 @@ module Hoodie
   # Raised when an operation times out.
   TimeoutError = Class.new(StandardError)
 
-  class << self
-    # @param [TrueClass, FalseClass] sets the global logging configuration.
-    # @return [Hoodie]
-    # @api public
-    def logging=(value)
-      configuration.logging = value
-      self
-    end
+  # @param [Boolean] value
+  #   Sets the global logging configuration.
+  #
+  # @return [Hoodie]
+  #
+  def self.logging=(value)
+    configuration.logging = value
+    self
+  end
 
-    # @return [TrueClass, FalseClass] the global logging setting.
-    # @api public
-    def logging
-      configuration.logging
-    end
+  # @return [Boolean]
+  #   The global logging setting.
+  #
+  def self.logging
+    configuration.logging
+  end
 
-    # Provides access to the global configuration.
-    #
-    # @example
-    #   Hoodie.config do |config|
-    #     config.logging = true
-    #   end
-    #
-    # @return [Configuration]
-    #
-    # @api public
-    def config(&block)
-      yield configuration if block_given?
-      configuration
-    end
+  # Provides access to the global configuration.
+  #
+  # @example
+  #   Hoodie.config do |config|
+  #     config.logging = true
+  #   end
+  #
+  # @return [Configuration]
+  #
+  def self.config(&block)
+    yield configuration if block_given?
+    configuration
+  end
 
-    # @return [Configuration] global configuration instance.
-    # @api private
-    def configuration
-      @configuration ||= Configuration.new
-    end
+  # @return [Configuration]
+  #   The global configuration instance.
+  #
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 end
 
-require 'hoodie/core_ext/string'
-require 'hoodie/core_ext/blank'
-require 'hoodie/core_ext/hash'
-require 'hoodie/core_ext/try'
-
-require 'hoodie/stash/mem_store'
-require 'hoodie/stash/disk_store'
-require 'hoodie/identity_map'
 require 'hoodie/inflections'
-require 'hoodie/memoizable'
-require 'hoodie/obfuscate'
 require 'hoodie/logging'
 require 'hoodie/version'
-require 'hoodie/timers'
 require 'hoodie/utils'
-require 'hoodie/proxy'
 require 'hoodie/stash'
-require 'hoodie/os'

data/lib/hoodie/configuration.rb

@@ -1,14 +1,33 @@
 # encoding: UTF-8
+#
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
+#
+# 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.
+#
 
 module Hoodie
 
   # A Configuration instance
   class Configuration
 
-    # Access the logging setting for this instance
+    # @!attribute [rw] logging
+    #   @return [Boolean] Enable or disable logging.
     attr_accessor :logging
 
-    # Access to the logging level for this instance
+    # @!attribute [rw] level
+    #   @return [Symbol] Set the desired loging level.
     attr_accessor :level
 
     # Initialized a configuration instance
@@ -19,10 +38,28 @@ module Hoodie
     def initialize(options={})
       @logging = options.fetch(:logging, false)
       @level   = options.fetch(:level,   :info)
+      @crypto  = Crypto::Configuration.new
 
       yield self if block_given?
     end
 
+    # Access the crypto for this instance and optional configure a
+    # new crypto with the passed block.
+    #
+    # @example
+    #   Garcon.config do |c|
+    #     c.crypto.password = "!mWh0!s@y!m"
+    #     c.crypto.salt     = "9e5f851900cad8892ac8b737b7370cbe"
+    #   end
+    #
+    # @return [Crypto]
+    #
+    # @api private
+    def crypto(&block)
+      @crypto = Crypto::Configuration.new(&block) if block_given?
+      @crypto
+    end
+
     # @api private
     def to_h
       { logging: logging,

data/lib/hoodie/core_ext/blank.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 #
-# Author: Stefano Harding <riddopic@gmail.com>
-#
-# Copyright (C) 2014-2015 Stefano Harding
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ class Object
   #   [1].blank?        #=>  false
   #   [nil].blank?      #=>  false
   #
-  # @return [TrueClass, FalseClass]
+  # @return [Boolean]
   #
   def blank?
     nil? || (respond_to?(:empty?) && empty?)
@@ -37,7 +37,7 @@ class Object
   #   [1].present?        #=>  true
   #   [nil].present?      #=>  true
   #
-  # @return [TrueClass, FalseClass]
+  # @return [Boolean]
   #
   def present?
     !blank?
@@ -100,7 +100,7 @@ class String
   #   "     ".blank?    #=>  true
   #   " hey ho ".blank? #=>  false
   #
-  # @return [TrueClass, FalseClass]
+  # @return [Boolean]
   #
   def blank?
     strip.empty?

data/lib/hoodie/core_ext/hash.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 #
-# Author: Stefano Harding <riddopic@gmail.com>
-#
-# Copyright (C) 2014-2015 Stefano Harding
+# Author:    Stefano Harding <riddopic@gmail.com>
+# License:   Apache License, Version 2.0
+# Copyright: (C) 2014-2015 Stefano Harding
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,17 +17,69 @@
 # limitations under the License.
 #
 
+
 class Hash
+
+  # Turn a hash into a method arguments.
+  #
+  #   h = { :list => [1,2], :base => "HI" }
+  #
+  # Without an argument field.
+  #
+  #   h.argumentize #=> [ { :list => [1,2], :base => "HI" } ]
+  #
+  # With an argument field.
+  #
+  #   h.argumentize(:list)   #=> [ 1, 2, { :base => "HI" } ]
+  #   h.argumentize(:base)   #=> [ "HI", { :list => [1,2] } ]
+  #
+  def argumentize(args_field = nil)
+    config = dup
+    if args_field
+      args = [config.delete(args_field)].flatten.compact
+    else
+      args = []
+    end
+    args << config
+    return args
+  end
+
+  # A method to convert a Hash into a Struct.
+  #
+  #   h = { :name => "Earl", "age" => 20, "sex" => "lots", "worries" => "none" }
+  #   s = h.to_struct("Foo")
+  #
+  def to_struct(struct_name)
+    Struct.new(struct_name,*keys).new(*values)
+  end
+
+  # Get or set state of object. You can think of #object_state as an in-code
+  # form of marshalling.
+  #
+  def object_state(data=nil)
+    data ? replace(data) : dup
+  end
+
+  # A hash is blank if it's empty:
+  #
+  # @example
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @api public
+  alias_method :blank?, :empty?
+
   # Returns a compacted copy (contains no key/value pairs having
   # nil? values)
   #
   # @example
-  #     hash = { a: 100, b: nil, c: false, d: '' }
-  #     hash.compact # => { a: 100, c: false, d: '' }
-  #     hash         # => { a: 100, b: nil, c: false, d: '' }
+  #   hash = { a: 100, b: nil, c: false, d: '' }
+  #   hash.compact   # => { a: 100, c: false, d: '' }
+  #   hash           # => { a: 100, b: nil, c: false, d: '' }
   #
   # @return [Hash]
   #
+  # @api public
   def compact
     select { |_, value| !value.nil? }
   end
@@ -35,13 +87,13 @@ class Hash
   # Returns a new hash with all keys converted using the block operation.
   #
   # @example
-  #     hash = { name: 'Tiggy', age: '15' }
-  #
-  #     hash.transform_keys{ |key| key.to_s.upcase }
-  #                 # => { "AGE" => "15", "NAME" => "Tiggy" }
+  #   hash = { name: 'Tiggy', age: '15' }
+  #   hash.transform_keys{ |key| key.to_s.upcase }
+  #     # => { "AGE" => "15", "NAME" => "Tiggy" }
   #
   # @return [Hash]
   #
+  # @api public
   def transform_keys
     enum_for(:transform_keys) unless block_given?
     result = self.class.new
@@ -128,6 +180,48 @@ class Hash
     recursively_transform_keys { |key| key.to_s.capitalize rescue key }
   end
 
+  # Creates a new hash from two separate arrays, a +keys+ array and
+  # a +values+ array.
+  #
+  # @example
+  #   Hash.zip(['a','b','c'], [1,2,3])
+  #   # => { "a"=>1, "b"=>2, "c"=>3 }
+  #
+  def zip(col1, col2)
+    col1.zip(col2).inject({}) { |r, i| r[i[0]] = i[1]; r }
+  end
+
+  # Create a hash with *only* key/value pairs in receiver and +allowed+
+  #
+  #   { :one => 1, :two => 2, :three => 3 }.only(:one)    # => { :one => 1 }
+  #
+  # @param [Array[String, Symbol]] *allowed The hash keys to include.
+  #
+  # @return [Hash] A new hash with only the selected keys.
+  #
+  # @api public
+  def only(*allowed)
+    hash = {}
+    allowed.each {|k| hash[k] = self[k] if self.has_key?(k) }
+    hash
+  end
+
+  # Create a hash with all key/value pairs in receiver *except* +rejected+
+  #
+  #    { :one => 1, :two => 2, :three => 3 }.except(:one)
+  #     # => { :two => 2, :three => 3 }
+  #
+  # @param [Array[String, Symbol]] *rejected The hash keys to exclude.
+  #
+  # @return [Hash] A new hash without the selected keys.
+  #
+  # @api public
+  def except(*rejected)
+    hash = self.dup
+    rejected.each {|k| hash.delete(k) }
+    hash
+  end
+
   class UndefinedPathError < StandardError; end
   # Recursively searchs a nested datastructure for a key and returns
   # the value. If a block is provided its value will be returned if
@@ -149,7 +243,8 @@ class Hash
         obj.fetch(arg)
       rescue ArgumentError, IndexError, NoMethodError => e
         break block.call(arg) if block
-        raise UndefinedPathError, "Could not fetch path (#{args.join(' > ')}) at #{arg}", e.backtrace
+        raise UndefinedPathError,
+          "Could not fetch path (#{args.join(' > ')}) at #{arg}", e.backtrace
       end
     end
   end
@@ -173,8 +268,8 @@ class Hash
   def _recursively_transform_keys_in_object(object, &block)
     case object
     when Hash
-      object.each_with_object({}) do |(key, value), result|
-        result[yield(key)] = _recursively_transform_keys_in_object(value, &block)
+      object.each_with_object({}) do |(key, val), result|
+        result[yield(key)] = _recursively_transform_keys_in_object(val, &block)
       end
     when Array
       object.map { |e| _recursively_transform_keys_in_object(e, &block) }