hoodie 0.5.5 → 1.0.1

data/lib/hoodie/stash/mem_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.
@@ -17,13 +17,14 @@
 # limitations under the License.
 #
 
-module MemStash
+module Hoodie
   # Basic cache object stash store (uses a Hash)
-  class Cache
+  #
+  class MemStash
     include Enumerable
 
-    # @return [Hash] of the mem stash cache hash store
-    #
+    # @!attribute [r] :store
+    #   @return [Stash::MemStash] location of Stash::DiskStore store.
     attr_reader :store
 
     # Initializes a new store object.
@@ -124,7 +125,7 @@ module MemStash
     #
     # @param key [Symbol, String] a string or symbol representing the key
     #
-    # @return [TrueClass, FalseClass]
+    # @return [Boolean]
     #
     def include?(key)
       @store.include? key
@@ -135,7 +136,7 @@ module MemStash
     #
     # @param value [String] a string representing the value
     #
-    # @return [TrueClass, FalseClass]
+    # @return [Boolean]
     #
     def value?(value)
       @store.value? value

data/lib/hoodie/stash/memoizable.rb

@@ -0,0 +1,46 @@
+# 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 'hoodie/stash' unless defined?(Stash)
+
+module Hoodie
+  # Memoization is an optimization that saves the return value of a
+  # method so it doesn't need to be re-computed every time that method
+  # is called.
+  #
+  module Memoizable
+    # Create a new memoized method. To use, extend class with Memoizable,
+    # then, in initialize, call memoize
+    #
+    # @return [undefined]
+    #
+    def memoize(methods, cache = nil)
+      cache ||= Hoodie::Stash.new
+      methods.each do |name|
+        uncached_name = "#{name}_uncached".to_sym
+        singleton_class.class_eval do
+          alias_method uncached_name, name
+          define_method(name) do |*a, &b|
+            cache.cache(name) { send uncached_name, *a, &b }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hoodie/utils.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,183 +17,13 @@
 # limitations under the License.
 #
 
-require 'securerandom'
-require 'time'
-
-module Hoodie
-  module Utils
-    def self.included(base)
-      include(ClassMethods)
-
-      base.send(:include, ClassMethods)
-    end
-    private_class_method :included
-
-    module ClassMethods
-      def callable(call_her)
-        call_her.respond_to?(:call) ? call_her : lambda { call_her }
-      end
-
-      def camelize(underscored_word)
-        underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
-      end
-
-      def classify(table_name)
-        camelize singularize(table_name.to_s.sub(/.*\./, ''))
-      end
-
-      def class_name
-        demodulize(self.class)
-      end
-
-      def caller_name(position = 0)
-        caller[position][/`.*'/][1..-2]
-      end
-
-      def demodulize(class_name_in_module)
-        class_name_in_module.to_s.sub(/^.*::/, '')
-      end
-
-      def pluralize(word)
-        word.to_s.sub(/([^s])$/, '\1s')
-      end
-
-      def singularize(word)
-        word.to_s.sub(/s$/, '').sub(/ie$/, 'y')
-      end
-
-      def underscore(camel_cased_word)
-        word = camel_cased_word.to_s.dup
-        word.gsub!(/::/, '/')
-        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-        word.tr! '-', '_'
-        word.downcase!
-        word
-      end
-
-      # Return the date and time in "HTTP-date" format as defined by RFC 7231.
-      #
-      # @return [Date,Time] in "HTTP-date" format
-      def utc_httpdate
-        Time.now.utc.httpdate
-      end
-
-      def request_id
-        SecureRandom.uuid
-      end
-
-      def twenty_four_hours_ago
-        Time.now - ( 60 * 60 * 24)
-      end
-
-      def verify_options(accepted, actual) # @private
-        return unless debug || $DEBUG
-        unless (act=Set[*actual.keys]).subset?(acc=Set[*accepted])
-          raise Croesus::Errors::UnknownOption,
-            "\nDetected unknown option(s): #{(act - acc).to_a.inspect}\n" <<
-            "Accepted options are: #{accepted.inspect}"
-        end
-        yield if block_given?
-      end
-
-      # Returns the columns and lines of the current tty.
-      #
-      # @return [Integer]
-      #   number of columns and lines of tty, returns [0, 0] if no tty present.
-      #
-      # @api public
-      def terminal_dimensions
-        [0, 0] unless  STDOUT.tty?
-        [80, 40] if OS.windows?
-
-        if ENV['COLUMNS'] && ENV['LINES']
-          [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
-        elsif ENV['TERM'] && command_in_path?('tput')
-          [`tput cols`.to_i, `tput lines`.to_i]
-        elsif command_in_path?('stty')
-          `stty size`.scan(/\d+/).map {|s| s.to_i }
-        else
-          [0, 0]
-        end
-      rescue
-        [0, 0]
-      end
-
-      # Checks in PATH returns true if the command is found
-      def command_in_path?(command)
-        found = ENV['PATH'].split(File::PATH_SEPARATOR).map do |p|
-          File.exist?(File.join(p, command))
-        end
-        found.include?(true)
-      end
-
-      # Runs a code block, and retries it when an exception occurs. Should the
-      # number of retries be reached without success, the last exception will be
-      # raised.
-      #
-      # @param opts [Hash{Symbol => Value}]
-      # @option opts [Fixnum] :tries
-      #   number of attempts to retry before raising the last exception
-      # @option opts [Fixnum] :sleep
-      #   number of seconds to wait between retries, use lambda to exponentially
-      #   increasing delay between retries
-      # @option opts [Array(Exception)] :on
-      #   the type of exception(s) to catch and retry on
-      # @option opts [Regex] :matching
-      #   match based on the exception message
-      # @option opts [Block] :ensure
-      #   ensure a block of code is executed, regardless of whether an exception
-      #   is raised
-      #
-      # @return [Block]
-      #
-      def retrier(opts = {}, &block)
-        defaults = {
-          tries:    2,
-          sleep:    1,
-          on:       StandardError,
-          matching: /.*/,
-          :ensure => Proc.new {}
-        }
-
-        check_for_invalid_options(opts, defaults)
-        defaults.merge!(opts)
-
-        return if defaults[:tries] == 0
-
-        on_exception, tries = [defaults[:on]].flatten, defaults[:tries]
-        retries = 0
-        retry_exception = nil
-
-        begin
-          yield retries, retry_exception
-        rescue *on_exception => exception
-          raise unless exception.message =~ defaults[:matching]
-          raise if retries+1 >= defaults[:tries]
-
-          # Interrupt Exception could be raised while sleeping
-          begin
-            sleep defaults[:sleep].respond_to?(:call) ?
-              defaults[:sleep].call(retries) : defaults[:sleep]
-          rescue *on_exception
-          end
-
-          retries += 1
-          retry_exception = exception
-          retry
-        ensure
-          defaults[:ensure].call(retries)
-        end
-      end
-
-      private #   P R O P R I E T À   P R I V A T A   Vietato L'accesso
-
-      def check_for_invalid_options(custom_options, defaults)
-        invalid_options = defaults.merge(custom_options).keys - defaults.keys
-        raise ArgumentError.new('[Retrier] Invalid options: ' \
-          "#{invalid_options.join(", ")}") unless invalid_options.empty?
-      end
-    end
-  end
-end
+require 'hoodie/utils/ansi'
+require 'hoodie/utils/crypto'
+require 'hoodie/utils/equalizer'
+require 'hoodie/utils/file_helper'
+require 'hoodie/utils/konstruktor'
+require 'hoodie/utils/machine'
+require 'hoodie/utils/os'
+require 'hoodie/utils/retry'
+require 'hoodie/utils/timeout'
+require 'hoodie/utils/url_helper'

data/lib/hoodie/utils/ansi.rb

@@ -0,0 +1,199 @@
+# 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
+
+  # ANSI Mixin Module
+  #
+  # Standard use is to mix this module into String.
+  #
+  # @example Mix this module into String to enable easy ANSI coloring methods
+  # like:
+  #   "bold red".red.bold
+  #
+  # @example Or
+  #   "green".green
+  #
+  module ANSI
+    extend self
+
+    # Defines our ANSI color codes
+    ANSI_COLORS = {
+      black:   30,
+      red:     31,
+      green:   32,
+      yellow:  33,
+      blue:    34,
+      magenta: 35,
+      cyan:    36,
+      white:   37
+    }
+
+    # @!method black(string=nil, &block)
+    #   Sets the foreground color to black for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method red(string=nil, &block)
+    #   Sets the foreground color to red for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method green(string=nil, &block)
+    #   Sets the foreground color to green for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method yellow(string=nil, &block)
+    #   Sets the foreground color to yellow for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method blue(string=nil, &block)
+    #   Sets the foreground color to blue for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method magenta(string=nil, &block)
+    #   Sets the foreground color to magenta for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method cyan(string=nil, &block)
+    #   Sets the foreground color to cyan for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method white(string=nil, &block)
+    #   Sets the foreground color to white for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+
+    # Defines our ANSI attribute codes
+    ANSI_ATTRIBUTES = {
+      normal: 0,
+      bold:   1
+    }
+
+    # @!method normal(string=nil, &block)
+    #   Sets the foreground color to normal for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+    #
+    # @!method bold(string=nil, &block)
+    #   Sets the foreground color to bold for the supplied string.
+    #   @param [String] string The string to operate on.
+    #   @yieldreturn [String] The string to operate on.
+    #   @return [String] The colored string.
+
+    # Defines a RegEx for stripping ANSI codes from strings
+    ANSI_REGEX = /\e\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/
+
+    # Dynamicly constructs ANSI methods for the color methods based on the ANSI
+    # code hash passed in.
+    #
+    # @param [Hash] hash
+    #   A hash where the keys represent the method names and the values are the
+    #   ANSI codes.
+    #
+    # @return [Boolean]
+    #   True if successful.
+    #
+    def build_ansi_methods(hash)
+      hash.each do |key, value|
+
+        define_method(key) do |string=nil, &block|
+          result = Array.new
+
+          result << %(\e[#{value}m)
+          if block_given?
+            result << block.call
+          elsif string.respond_to?(:to_str)
+            result << string.to_str
+          elsif respond_to?(:to_str)
+            result << to_str
+          else
+            return result
+          end
+          result << %(\e[0m)
+
+          result.join
+        end
+      end
+
+      true
+    end
+
+    # Removes ANSI code sequences from a string.
+    #
+    # @param [String] string
+    #   The string to operate on.
+    #
+    # @yieldreturn [String]
+    #   The string to operate on.
+    #
+    # @return [String]
+    #   The supplied string stripped of ANSI codes.
+    #
+    def uncolor(string = nil, &block)
+      if block_given?
+        block.call.to_str.gsub(ANSI_REGEX, '')
+      elsif string.respond_to?(:to_str)
+        string.to_str.gsub(ANSI_REGEX, '')
+      elsif respond_to?(:to_str)
+        to_str.gsub(ANSI_REGEX, '')
+      else
+        ''
+      end
+    end
+
+    def reset(string = nil, &block)
+      result = Array.new
+
+      result << %(\e[2J)
+      if block_given?
+        result << block.call
+      elsif string.respond_to?(:to_str)
+        result << string.to_str
+      elsif respond_to?(:to_str)
+        result << to_str
+      else
+        return result
+      end
+
+      result.join
+    end
+
+    def goto(x=0, y=0)
+      %(\e[#{x};#{y}H)
+    end
+
+    build_ansi_methods(ANSI_COLORS)
+    build_ansi_methods(ANSI_ATTRIBUTES)
+  end
+end