hoodie 0.5.5 → 1.0.1

data/lib/hoodie/core_ext/string.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.
@@ -41,6 +41,8 @@ class String
   def mustard;    colorize(self, "\e[1;35m"); end
   def cyan;       colorize(self, "\e[0;36m"); end
   def cyan2;      colorize(self, "\e[1;36m"); end
+  def light_gray; colorize(self, "\e[2;37m"); end
+  def bright_red; colorize(self, "\e[1;41m"); end
   def white;      colorize(self, "\e[0;97m"); end
   def on_black;   colorize(self, "\e[40m");   end
   def on_red;     colorize(self, "\e[41m");   end

data/lib/hoodie/core_ext/try.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,6 +17,7 @@
 # limitations under the License.
 #
 
+
 # Add #try and #try!
 class Object
   # Invokes the public method whose name goes as first argument just like

data/lib/hoodie/inflections.rb

@@ -1,3 +1,21 @@
+# 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.
+#
 
 require 'set'
 

data/lib/hoodie/inflections/defaults.rb

@@ -1,4 +1,21 @@
 # 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.
+#
 
 Hoodie::Inflections.inflections do |inflect|
   inflect.plural(/$/, 's')

data/lib/hoodie/inflections/inflections.rb

@@ -1,4 +1,21 @@
 # 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
   module Inflections

data/lib/hoodie/inflections/rules_collection.rb

@@ -1,4 +1,21 @@
 # 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
   module Inflections

data/lib/hoodie/logging.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,6 +17,7 @@
 # limitations under the License.
 #
 
+require 'hoodie/core_ext/string'
 require 'logger'
 require 'time'
 
@@ -95,7 +96,7 @@ module Hoodie
     def call(severity, time, progname, msg)
       format % [
         format_datetime(time).blue,
-        severity.green,
+        format_severity(severity),
         msg2str(msg).strip.orange
       ]
     end
@@ -106,6 +107,23 @@ module Hoodie
       "[%s] %5s: %s\n"
     end
 
+    def format_severity(severity)
+      case severity
+      when 'FATAL'
+        severity.bright_red
+      when 'ERROR'
+        severity.red
+      when 'WARN'
+        severity.yellow
+      when 'DEBUG'
+        severity.light_gray
+      when 'INFO'
+        severity.green
+      else
+        severity
+      end
+    end
+
     def format_datetime(time)
       if @datetime_format.nil?
         time.strftime("%Y-%m-%dT%H:%M:%S.") << "%06d " % time.usec

data/lib/hoodie/stash.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 #
-# Author: Stefano Harding <riddopic@gmail.com>
-#
-# Copyright (C) 2014 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,102 +17,105 @@
 # limitations under the License.
 #
 
-require 'hoodie/stash/disk_store' unless defined?(DiskStash)
-require 'hoodie/stash/mem_store'  unless defined?(MemStash)
-require 'hoodie/memoizable'       unless defined?(Memoizable)
+require 'hoodie/stash/disk_stash'
+require 'hoodie/stash/mem_stash'
+require 'hoodie/stash/memoizable'
+require 'hoodie/utils/os'
 
-# Define the basic cache and default store objects
-module Stash
-  # check if we're using a version if Ruby that supports caller_locations
-  NEW_CALL = Kernel.respond_to? 'caller_locations'
+module Hoodie
+  # Define the basic cache and default store objects
+  #
+  module Stash
+    # check if we're using a version if Ruby that supports caller_locations
+    NEW_CALL = Kernel.respond_to? 'caller_locations'
 
-  class << self
     # insert a helper .new() method for creating a new object
     #
-    def new(*args)
+    def self.new(*args)
       self::Cache.new(*args)
     end
 
     # helper to get the calling function name
     #
-    def caller_name
+    def self.caller_name
       NEW_CALL ? caller_locations(2, 1).first.label : caller[1][/`([^']*)'/, 1]
     end
-  end
 
-  # Default store type
-  DEFAULT_STORE = MemStash::Cache
+    # Default store type
+    DEFAULT_STORE = MemStash
 
-  # Key/value cache store
-  class Cache
-    # @return [Hash] of the mem stash cache hash store
-    #
-    attr_reader :store
+    # Key/value cache store
+    class Cache
 
-    # Initializes a new empty store
-    #
-    def initialize(params = {})
-      params = { store: params } unless params.is_a? Hash
-      @store = params.fetch(:store) { Stash::DEFAULT_STORE.new }
-    end
+      # @!attribute [r] :store
+      #   @return [Stash::DiskStore] location of Stash::DiskStore store.
+      attr_reader :store
 
-    # Clear the whole stash store or the value of a key
-    #
-    # @param key [Symbol, String] (optional) representing the key to
-    # clear.
-    #
-    # @return nothing.
-    #
-    def clear!(key = nil)
-      key = key.to_sym unless key.nil?
-      @store.clear! key
-    end
+      # Initializes a new empty store
+      #
+      def initialize(params = {})
+        params = { store: params } unless params.is_a? Hash
+        @store = params.fetch(:store) { Hoodie::DEFAULT_STORE.new }
+      end
 
-    # Retrieves the value for a given key, if nothing is set,
-    # returns KeyError
-    #
-    # @param key [Symbol, String] representing the key
-    #
-    # @raise [KeyError] if no such key found
-    #
-    # @return [Hash, Array, String] value for key
-    #
-    def [](key = nil)
-      key ||= Stash.caller_name
-      fail KeyError, 'Key not cached' unless include? key.to_sym
-      @store[key.to_sym]
-    end
+      # Clear the whole stash store or the value of a key
+      #
+      # @param key [Symbol, String] (optional) representing the key to
+      # clear.
+      #
+      # @return nothing.
+      #
+      def clear!(key = nil)
+        key = key.to_sym unless key.nil?
+        @store.clear! key
+      end
 
-    # Retrieves the value for a given key, if nothing is set,
-    # run the code, cache the result, and return it
-    #
-    # @param key [Symbol, String] representing the key
-    # @param block [&block] that returns the value to set (optional)
-    #
-    # @return [Hash, Array, String] value for key
-    #
-    def cache(key = nil, &code)
-      key ||= Stash.caller_name
-      @store[key.to_sym] ||= code.call
-    end
+      # Retrieves the value for a given key, if nothing is set,
+      # returns KeyError
+      #
+      # @param key [Symbol, String] representing the key
+      #
+      # @raise [KeyError] if no such key found
+      #
+      # @return [Hash, Array, String] value for key
+      #
+      def [](key = nil)
+        key ||= Stash.caller_name
+        fail KeyError, 'Key not cached' unless include? key.to_sym
+        @store[key.to_sym]
+      end
 
-    # return the size of the store as an integer
-    #
-    # @return [Fixnum]
-    #
-    def size
-      @store.size
-    end
+      # Retrieves the value for a given key, if nothing is set,
+      # run the code, cache the result, and return it
+      #
+      # @param key [Symbol, String] representing the key
+      # @param block [&block] that returns the value to set (optional)
+      #
+      # @return [Hash, Array, String] value for key
+      #
+      def cache(key = nil, &code)
+        key ||= Stash.caller_name
+        @store[key.to_sym] ||= code.call
+      end
 
-    # return a boolean indicating presence of the given key in the store
-    #
-    # @param key [Symbol, String] a string or symbol representing the key
-    #
-    # @return [TrueClass, FalseClass]
-    #
-    def include?(key = nil)
-      key ||= Stash.caller_name
-      @store.include? key.to_sym
+      # return the size of the store as an integer
+      #
+      # @return [Fixnum]
+      #
+      def size
+        @store.size
+      end
+
+      # return a boolean indicating presence of the given key in the store
+      #
+      # @param key [Symbol, String] a string or symbol representing the key
+      #
+      # @return [Boolean]
+      #
+      def include?(key = nil)
+        key ||= Stash.caller_name
+        @store.include? key.to_sym
+      end
     end
   end
 end

data/lib/hoodie/stash/disk_store.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.
@@ -12,140 +12,164 @@
 #
 # 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.
+# 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 'tmpdir'
 
-module DiskStash
+module Hoodie
   # Disk stashing method variable caching hash, string, array store.
-  class Cache
-    include Enumerable
-
-    # @return [String] location of DiskStash::Cache.store
-    #
-    attr_reader :store
-
-    # Initializes a new disked backed stash hash cache store.
-    #
-    # @param path [String] location for stash store cache.
-    #
-    # @return nothing.
-    #
-    def initialize(store = file_store)
-      @store = store
-      _ensure_store_directory
-    end
+  #
+  class Stash
+    class DiskStash
+
+      # @!attribute [r] :store
+      #   @return [Stash::DiskStore] location of Stash::DiskStore store.
+      attr_reader :store
+
+      # Initializes a new disked backed stash hash cache store.
+      #
+      # @param path [String] location for stash store cache.
+      #
+      # @return nothing.
+      #
+      def initialize(store = file_store)
+        @store = store
+      end
+
+      # Retrieves a value from the cache, if available and not expired, or
+      # yields to a block that calculates the value to be stored in the cache.
+      #
+      # @param [Object] key
+      #   The key to look up or store at.
+      #
+      # @yield yields when the value is not present.
+      #
+      # @yieldreturn [Object]
+      #   The value to store in the cache.
+      #
+      # @return [Object]
+      #   The value at the key.
+      #
+      def cache(key = nil, &code)
+        key ||= Stash.caller_name
+        @store[key.to_sym] ||= code.call
+      end
 
-    # Clear the whole stash or the value of a key
-    #
-    # @param key [Symbol, String] (optional) string or symbol
-    # representing the key to clear
-    #
-    # @return [Hash] with a key, return the value it had, without
-    # returns {}
-    #
-    def clear!(key = nil)
-      if key.nil?
-        ::Dir[::File.join(store, '*.cache')].each do |file|
-          ::File.delete(file)
+      # Clear the whole stash or the value of a key.
+      #
+      # @param [Symbol, String] key
+      #   String or symbol representing the key to clear.
+      #
+      # @return [Hash]
+      #   Previously stored Key/Value pair before the delete operation.
+      #
+      def clear!(key = nil)
+        if key.nil?
+          Dir[File.join(store, '*.cache')].each do |file|
+            File.delete(file)
+          end
+        else
+          File.delete(cache_file(key)) if File.exist?(cache_file(key))
         end
-      else
-        ::File.delete(cache_file(key)) if ::File.exist?(cache_file(key))
       end
-    end
 
-    # Retrieves the value for a given key, if nothing is set,
-    # returns nil
-    #
-    # @param key [Symbol, String] representing the key
-    #
-    # @return [Hash, Array, String] value for key
-    #
-    def [](key)
-      if key.is_a? Array
-        hash = {}
-        key.each do |k|
-          hash[k] = Marshal.load(_read_cache_file(k))
+      # Retrieves the value for a given key, if nothing is set returns nil.
+      #
+      # @param [Symbol, String] key
+      #   String or symbol representing the key.
+      #
+      # @return [Hash]
+      #   The value for the key.
+      #
+      def [](key)
+        if key.is_a? Array
+          hash = {}
+          key.each do |k|
+            hash[k] = Marshal.load(read_cache_file(k))
+          end
+          hash unless hash.empty?
+        else
+          Marshal.load(read_cache_file(key))
         end
-        hash unless hash.empty?
-      else
-        Marshal.load(_read_cache_file(key))
+      rescue Errno::ENOENT
+        nil # key hasn't been created
       end
-    rescue Errno::ENOENT
-      nil # key hasn't been created
-    end
 
-    # Store the given value with the given key, either an an argument
-    # or block. If a previous value was set it will be overwritten
-    # with the new value.
-    #
-    # @param key [Symbol, String] representing the key
-    # @param value [Object] that represents the value (optional)
-    # @param block [&block] that returns the value to set (optional)
-    #
-    # @return nothing.
-    #
-    def []=(key, value)
-      _write_cache_file(key, Marshal.dump(value))
-    end
+      # Store the given value with the given key, either an an argument or
+      # block. If a previous value was set it will be overwritten with the new
+      # value.
+      #
+      # @param [Symbol, String] key
+      #   String or symbol representing the key.
+      #
+      # @param [Object] value
+      #   That represents the value (optional)
+      #
+      # @param [&block] block
+      #   That returns the value to set (optional)
+      #
+      # @return [undefined]
+      #
+      def []=(key, value)
+        write_cache_file(key, Marshal.dump(value))
+      end
 
-    # returns path to cache file with 'key'
-    def cache_file(key)
-      ::File.join(store, key.to_s + '.cache')
-    end
+      # returns path to cache file with 'key'
+      def cache_file(key)
+        File.join(store, key.to_s + '.cache')
+      end
 
-    private #   P R O P R I E T À   P R I V A T A   divieto di accesso
-
-    # return Chef tmpfile path if running under Chef, else return OS
-    # temp path. On Winders Dir.tmpdir returns the correct path.
-    #
-    def file_store
-      if OS.windows?
-        win_friendly_path('/chef/._stash_')
-      elsif OS.mac?
-        ::File.join(::File::SEPARATOR, 'var', 'tmp', '._stash')
-      else
-        ::File.join(::File::SEPARATOR, 'var', 'lib', '._stash')
+      private #   P R O P R I E T À   P R I V A T A   divieto di accesso
+
+      def file_store
+        if Hoodie::OS.windows?
+          win_friendly_path('/chef/._stash_')
+        elsif Hoodie::OS.mac?
+          File.join(File::SEPARATOR, 'var', 'tmp', '._stash')
+        else
+          File.join(File::SEPARATOR, 'var', 'lib', '._stash')
+        end
       end
-    end
 
-    # returns windows friendly version of the provided path, ensures
-    # backslashes are used everywhere
-    #
-    def win_friendly_path(path)
-      system_drive = ENV['SYSTEMDRIVE'] ? ENV['SYSTEMDRIVE'] : ''
-      path = ::File.join(system_drive, path)
-      path.gsub!(::File::SEPARATOR, (::File::ALT_SEPARATOR || '\\'))
-    end
+      # returns windows friendly version of the provided path, ensures
+      # backslashes are used everywhere
+      #
+      def win_friendly_path(path)
+        system_drive = ENV['SYSTEMDRIVE'] ? ENV['SYSTEMDRIVE'] : ''
+        path = File.join(system_drive, path)
+        path.gsub!(File::SEPARATOR, (File::ALT_SEPARATOR || '\\'))
+      end
 
-    def _write_cache_file(key, content)
-      mode = OS.windows? ? 'wb' : 'w+'
-      f = ::File.open(cache_file(key), mode)
-      f.flock(::File::LOCK_EX)
-      f.write(content)
-      f.close
-      content
-    end
+      def write_cache_file(key, content)
+        mode = OS.windows? ? 'wb' : 'w+'
+        file = File.open(cache_file(key), mode)
+        ensure_enclosing_dir(File.dirname file)
+        file.flock(File::LOCK_EX)
+        file.write(content)
+        file.close
+        content
+      end
 
-    def _read_cache_file(key)
-      mode = OS.windows? ? 'rb' : 'r'
-      f = ::File.open(cache_file(key), mode)
-      f.flock(::File::LOCK_SH)
-      out = f.read
-      f.close
-      out
-    end
+      def read_cache_file(key)
+        mode = OS.windows? ? 'rb' : 'r'
+        f = File.open(cache_file(key), mode)
+        f.flock(File::LOCK_SH)
+        out = f.read
+        f.close
+        out
+      end
 
-    def read_cache_mtime(key)
-      nil unless ::File.exist?(cache_file(key))
-      ::File.mtime(cache_file(key))
-    end
+      def read_cache_mtime(key)
+        nil unless File.exist?(cache_file(key))
+        File.mtime(cache_file(key))
+      end
 
-    def _ensure_store_directory
-      ::Dir.mkdir(store) unless ::File.directory?(store)
-     end
+      def ensure_enclosing_dir(dir)
+        FileUtils.mkdir_p(file_store) unless File.directory?(dir)
+      end
+    end
   end
 end