lotus-utils 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bdc8a61bce6ac30e4889fc50aa7272f14b8b960
-  data.tar.gz: 22817bdd0799c56964c5a27c74df73ee268ed073
+  metadata.gz: e9735bda19b42820e137d3701b680744b1e31efa
+  data.tar.gz: 2f8d6bd945be961bf835f994dcf0f3337805d4d6
 SHA512:
-  metadata.gz: d13c9c20d2c91da1c235b9feb742c8bca7baed56de1cc9f7e2f96213ea452b7df77160190e3d1c69a4170fd0829af3377f212e9530756c0212e7025ff1ee6eeb
-  data.tar.gz: 8913ccc6cc7d62dd996071112054380a9454f8f1b4a8a37451b602c3568c2107b0c735646822398b4a585619a9d73b571e5270b236c885f84b936e4ac6547dd7
+  metadata.gz: bd341a626427d29d9e8785fca9eb600a171ddf1e4acc64ed72f8301276a8d2166f8ac4fc4ce41ecfa285af419e3556e88c735cdb7a29e8e53c801d601089df35
+  data.tar.gz: 4b895ccb945daeea8eb89f03ae3f77cf8e3a58d6f0b59c717fd9a8737c4239e95f2f823f7c136f01938d5d6da80a037604cfc9a60e1e53b2ee7e20badbc2485c

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Lotus::Utils
 Ruby core extentions and class utilities for Lotus
 
+## v0.3.2 - 2014-12-23
+### Added
+- [Luca Guidi] Official support for Ruby 2.2
+- [Luca Guidi] Introduced `Utils::Attributes`
+- [Luca Guidi] Added `Utils::Hash#stringify!`
+
 ## v0.3.1 - 2014-11-23
 ### Added
 - [Luca Guidi] Allow `Utils::Class.load!` to accept any object that implements `#to_s`

data/lib/lotus/utils.rb

@@ -5,11 +5,11 @@ module Lotus
   #
   # @since 0.1.0
   module Utils
-    # @since x.x.x
+    # @since 0.3.1
     # @api private
     LOTUS_JRUBY = 'java'.freeze
 
-    # @since x.x.x
+    # @since 0.3.1
     # @api private
     LOTUS_RUBINIUS = 'rbx'.freeze
 
@@ -17,7 +17,7 @@ module Lotus
     #
     # @return [TrueClass,FalseClass] return if the VM is JRuby or not
     #
-    # @since x.x.x
+    # @since 0.3.1
     # @api private
     def self.jruby?
       RUBY_PLATFORM == LOTUS_JRUBY
@@ -27,7 +27,7 @@ module Lotus
     #
     # @return [TrueClass,FalseClass] return if the VM is Rubinius or not
     #
-    # @since x.x.x
+    # @since 0.3.1
     # @api private
     def self.rubinius?
       RUBY_ENGINE == LOTUS_RUBINIUS

data/lib/lotus/utils/attributes.rb

@@ -0,0 +1,106 @@
+require 'lotus/utils/hash'
+
+module Lotus
+  module Utils
+    # A set of attributes.
+    #
+    # It internally stores the data as a Hash.
+    #
+    # All the operations convert keys to strings.
+    # This strategy avoids memory attacks due to Symbol abuses when parsing
+    # untrusted input.
+    #
+    # At the same time, this allows to get/set data with the original key or
+    # with the string representation. See the examples below.
+    #
+    # @since 0.3.2
+    class Attributes
+      # Initialize a set of attributes
+      # All the keys of the given Hash are recursively converted to strings.
+      #
+      # @param hash [#to_h] a Hash or any object that implements #to_h
+      #
+      # @return [Lotus::Utils::Attributes] self
+      #
+      # @since 0.3.2
+      #
+      # @example
+      #   require 'lotus/utils/attributes'
+      #
+      #   attributes = Lotus::Utils::Attributes.new(a: 1, b: { 2 => [3, 4] } })
+      #   attributes.to_h # => { "a" => 1, "b" => { "2" => [3, 4] } }
+      def initialize(hash = {})
+        @attributes = Utils::Hash.new(hash, &nil).stringify!
+      end
+
+      # Get the value associated with the given attribute
+      #
+      # @param attribute [#to_s] a String or any object that implements #to_s
+      #
+      # @return [Object,NilClass] the associated value, if present
+      #
+      # @since 0.3.2
+      #
+      # @example
+      #   require 'lotus/utils/attributes'
+      #
+      #   attributes = Lotus::Utils::Attributes.new(a: 1, 'b' => 2, 23 => 'foo')
+      #
+      #   attributes.get(:a)  # => 1
+      #   attributes.get('a') # => 1
+      #
+      #   attributes.get(:b)  # => 2
+      #   attributes.get('b') # => 2
+      #
+      #   attributes.get(23)   # => "foo"
+      #   attributes.get('23') # => "foo"
+      #
+      #   attributes.get(:unknown)  # => nil
+      #   attributes.get('unknown') # => nil
+      def get(attribute)
+        @attributes[attribute.to_s]
+      end
+
+      # Set the given value for the given attribute
+      #
+      # @param attribute [#to_s] a String or any object that implements #to_s
+      # @param value [Object] any value
+      #
+      # @return [NilClass]
+      #
+      # @since 0.3.2
+      #
+      # @example
+      #   require 'lotus/utils/attributes'
+      #
+      #   attributes = Lotus::Utils::Attributes.new
+      #
+      #   attributes.set(:a, 1)
+      #   attributes.get(:a)  # => 1
+      #   attributes.get('a') # => 1
+      #
+      #   attributes.set('b', 2)
+      #   attributes.get(:b)  # => 2
+      #   attributes.get('b') # => 2
+      #
+      #   attributes.set(23, 'foo')
+      #   attributes.get(23)   # => "foo"
+      #   attributes.get('23') # => "foo"
+      def set(attribute, value)
+        @attributes[attribute.to_s] = value
+        nil
+      end
+
+      # Returns a deep duplicated copy of the attributes as a Hash
+      #
+      # @return [Lotus::Utils::Hash]
+      #
+      # @since 0.3.2
+      #
+      # @see Lotus::Utils::Hash
+      def to_h
+        @attributes.deep_dup
+      end
+    end
+  end
+end

data/lib/lotus/utils/class.rb

@@ -57,7 +57,7 @@ module Lotus
       #
       # @raise [NameError] if no constant can be found.
       #
-      # @since x.x.x
+      # @since 0.3.1
       #
       # @see Lotus::Utils::String#tokenize
       #

data/lib/lotus/utils/deprecation.rb

@@ -4,13 +4,13 @@ module Lotus
   module Utils
     # Prints a deprecation warning when initialized
     #
-    # @since x.x.x
+    # @since 0.3.1
     class Deprecation
       # Initialize a deprecation message and prints it to standard error.
       #
       # @param message [#to_s] a deprecation message
       #
-      # @since x.x.x
+      # @since 0.3.1
       #
       # @example Direct usage
       #   require 'lotus/utils/deprecation'

data/lib/lotus/utils/hash.rb

@@ -57,11 +57,36 @@ module Lotus
         self
       end
 
+      # Convert in-place all the keys to Symbol instances, nested hashes are converted too.
+      #
+      # @return [Hash] self
+      #
+      # @since 0.3.2
+      #
+      # @example
+      #   require 'lotus/utils/hash'
+      #
+      #   hash = Lotus::Utils::Hash.new a: 23, b: { c: ['x','y','z'] }
+      #   hash.stringify!
+      #
+      #   hash.keys    # => [:a, :b]
+      #   hash.inspect # => {"a"=>23, "b"=>{"c"=>["x", "y", "z"]}}
+      def stringify!
+        keys.each do |k|
+          v = delete(k)
+          v = Hash.new(v).stringify! if v.is_a?(::Hash)
+
+          self[k.to_s] = v
+        end
+
+        self
+      end
+
       # Return a deep copy of the current Lotus::Utils::Hash
       #
       # @return [Hash] a deep duplicated self
       #
-      # @since x.x.x
+      # @since 0.3.1
       #
       # @example
       #   require 'lotus/utils/hash'
@@ -252,7 +277,7 @@ module Lotus
 
       private
       # @api private
-      # @since x.x.x
+      # @since 0.3.1
       def duplicate(value)
         case value
         when NilClass, FalseClass, TrueClass, Symbol, Numeric

data/lib/lotus/utils/path_prefix.rb

@@ -9,7 +9,7 @@ module Lotus
     class PathPrefix < Lotus::Utils::String
       # Path separator
       #
-      # @since x.x.x
+      # @since 0.3.1
       # @api private
       DEFAULT_SEPARATOR = '/'.freeze
 
@@ -31,7 +31,7 @@ module Lotus
       # Joins self with the given token.
       # It cleans up all the `separator` repetitions.
       #
-      # @param string [::String] the token we want to join
+      # @param strings [::String] the token(s) we want to join
       #
       # @return [Lotus::Utils::PathPrefix] the joined string
       #
@@ -61,7 +61,7 @@ module Lotus
       # Joins self with the given token, without prefixing it with `separator`.
       # It cleans up all the `separator` repetitions.
       #
-      # @param string [::String] the token we want to join
+      # @param strings [::String] the tokens we want to join
       # @param separator [::String] the separator used between tokens
       #
       # @return [Lotus::Utils::PathPrefix] the joined string
@@ -93,7 +93,7 @@ module Lotus
       #
       # @return [self]
       #
-      # @since x.x.x
+      # @since 0.3.1
       # @api private
       #
       # @see #absolute
@@ -107,7 +107,7 @@ module Lotus
       #
       # @return [TrueClass,FalseClass]
       #
-      # @since x.x.x
+      # @since 0.3.1
       # @api private
       #
       # @example
@@ -123,7 +123,7 @@ module Lotus
       #
       # @return [self]
       #
-      # @since x.x.x
+      # @since 0.3.1
       # @api private
       #
       # @see #relative

data/lib/lotus/utils/string.rb

@@ -124,7 +124,7 @@ module Lotus
         self.class.new split(NAMESPACE_SEPARATOR).first
       end
 
-      # It iterates thru the tokens and calls the given block.
+      # It iterates through the tokens and calls the given block.
       # A token is a substring wrapped by `()` and separated by `|`.
       #
       # @yield the block that is called for each token.

data/lib/lotus/utils/version.rb

@@ -1,5 +1,5 @@
 module Lotus
   module Utils
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.3.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,6 +63,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/lotus/utils.rb
+- lib/lotus/utils/attributes.rb
 - lib/lotus/utils/callbacks.rb
 - lib/lotus/utils/class.rb
 - lib/lotus/utils/class_attribute.rb