lotus-utils 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d04858b6a58f09fa11b7067a9f10b4b936e724b
-  data.tar.gz: 0e7c601a620a91a58516869b34de12013c86d599
+  metadata.gz: 3bdc8a61bce6ac30e4889fc50aa7272f14b8b960
+  data.tar.gz: 22817bdd0799c56964c5a27c74df73ee268ed073
 SHA512:
-  metadata.gz: 50dd0f5ae40cec11a6e3b06275988fb1a1535ce42007aaccdf84ba6ec12ff000f9e6ddc67bfb90dab041e5565769cf8c116ffd227f3cdff804cdfeb4ce13101a
-  data.tar.gz: 4136424d1f2efa2082b58adc347ffecedbc4f14200e7cf03609222364a870722e50c2f1e891bddf154bb075fdd0ac1d5072ab67718ca1920430010d52ad29e96
+  metadata.gz: d13c9c20d2c91da1c235b9feb742c8bca7baed56de1cc9f7e2f96213ea452b7df77160190e3d1c69a4170fd0829af3377f212e9530756c0212e7025ff1ee6eeb
+  data.tar.gz: 8913ccc6cc7d62dd996071112054380a9454f8f1b4a8a37451b602c3568c2107b0c735646822398b4a585619a9d73b571e5270b236c885f84b936e4ac6547dd7

data/CHANGELOG.md

@@ -1,123 +1,97 @@
-## v0.3.0
-### Oct 23, 2014
-
-4f7a8cf 2014-10-22 **Luca Guidi** Use 1/3 less objects when using Lotus::Utils::Kernel.Array
-
-a82437d 2014-10-20 **Luca Guidi** Improved error message for Utils::Class.load!
-
-2a7134d 2014-10-17 **Tom Kadwill** Improved error NameError message by passing in the whole constant name
-
-52c9fe2 2014-10-16 **Luca Guidi** Utils::Hash#to_h return instances of ::Hash in case of nested symbolized data structure
-
-6b9ba7b 2014-09-23 **Luca Guidi** Raise TypeError if nil is passed for PathPrefix#relative_join
-
-28d119f 2014-08-19 **Celso Fernandes** Add BigDecimal coercion to Lotus::Utils::Kernel
-
-a1b7213 2014-08-18 **Luca Guidi** Ensure PathPrefix#relative_join will raise a meaningful error
-
-139c4d5 2014-08-03 **Luca Guidi** Define Boolean, if missing :airplane:
-
-520c021 2014-07-29 **Peter Suschlik** Speedup Lotus::Utils::String#tokenize
-
-2380d62 2014-07-29 **Peter Suschlik** Define Lotus::Utils::Hash#respond_to_missing?
-
-1c300af 2014-07-29 **Peter Suschlik** Define Lotus::Utils::String#responds_to_missing?
-
-46b39e3 2014-07-25 **Luca Guidi** Let Utils::Hash#inspect output to be the same of ::Hash#inspect
-
-5b3e790 2014-07-25 **Luca Guidi** Use composition over inheritance for Lotus::Utils::PathPrefix
-
-6333287 2014-07-09 **Luca Guidi** Specify ::Hash in Lotus::Utils::Kernel.Hash
-
-25e101e 2014-07-09 **Luca Guidi** Use composition over inheritance for Lotus::Utils::Hash
-
-dea7e6b 2014-07-07 **Luca Guidi** Lotus::Utils::String is now a wrapper around a string, instead of inheriting from String.
-
-## v0.2.0
-### Jun 23, 2014
-
-a969fda 2014-06-12 **Luca Guidi** Implemented Lotus::Utils::Kernel.Symbol
-
-13532f5 2014-06-13 **Luca Guidi** [breaking] Implemented Lotus::Utils::Callbacks::Chain#freeze in order to prevent modification after the object has been frozen
-
-e438da8 2014-06-13 **Luca Guidi** [breaking] All the Utils::Kernel methods will raise TypeError in case of failed coercion.
-
-7fd90d1 2014-06-13 **Luca Guidi** Make Kernel.Pathname to raise an error when nil is passed as argument
-
-6437791 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Time to raise an error when nil is passed as argument
-
-c7f428b 2014-06-13 **Luca Guidi** [breaking] Make Kernel.DateTime to raise an error when nil is passed as argument
-
-ab0dc0c 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Date to raise an error when nil is passed as argument
-
-11d5c1c 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Boolean to return false when nil is passed as argument
-
-c3bcaea 2014-06-13 **Luca Guidi** [breaking] Make Kernel.String to return an empty string when nil is passed as argument
-
-0bd3826 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Float to return 0.0 when nil is passed as argument
-
-7ce8018 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Integer to return 0 when nil is passed as argument
-
-0377326 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Hash to return an empty hash when nil is passed as argument
-
-d3b0e2a 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Set to return an empty set when nil is passed as argument
-
-cd2d1b8 2014-06-13 **Luca Guidi** [breaking] Make Kernel.Array to return an empty array when nil is passed as argument
-
-32c15d6 2014-06-09 **Luca Guidi** Implemented Lotus::Utils::LoadPaths#freeze in order to prevent modification after the object has been frozen
-
-2b8d8d5 2014-06-09 **Luca Guidi** Implemented Lotus::Utils::LoadPaths#initialize_copy in order to safely dup and clone
-
-9a91222 2014-06-09 **Luca Guidi** Implemented Lotus::Utils::LoadPaths#push, also aliased as #<<
-
-1d3d986 2014-06-08 **Luca Guidi** Use composition over inheritance for Lotus::Utils::LoadPaths
-
-82d0af3 2014-06-08 **Luca Guidi** [breaking] Use composition over inheritance for Lotus::Utils::Callbacks::Chain
-
-442175b 2014-06-04 **Luca Guidi** Introduced Lotus::Utils::LoadPaths
-
-2734a87 2014-05-28 **Luca Guidi** Introduced Lotus::Utils::String#namespace, in order to return the top level Ruby namespace for the given string
-
-a2a19e9 2014-05-10 **Luca Guidi** Support for Ruby 2.1.2
-
-07146a1 2014-05-08 **Luca Guidi** Implemented Lotus::Utils::Kernel.Pathname
-
-## v0.1.1
-### Apr 23, 2014
-
-c125e0c _2014-04-18_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Time
-
-b366672 _2014-04-18_ **Luca Guidi** Implemented Lotus::Utils::Kernel.DateTime
-
-37a010f _2014-04-17_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Date
-
-484ec9d _2014-04-17_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Float
-
-69dd6eb _2014-04-16_ **Christopher Keele** Add missing stdlib Set require to ClassAttribute.
-
-82c0f54 _2014-04-12_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Boolean
-
-48ba6fb _2014-04-11_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Hash
-
-c10d561 _2014-04-11_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Set
-
-5582e72 _2014-04-11_ **Karl Freeman** add Github contributing guidelines
-
-012f266 _2014-04-11_ **Luca Guidi** Implemented Lotus::Utils::Kernel.String
-
-e1a35e2 _2014-04-08_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Integer
-
-152c856 _2014-04-08_ **Luca Guidi** Implemented Lotus::Utils::Kernel.Array
-
-## v0.1.0
-### Jan 23, 2014
-
-1212e9d _2014-01-16_ **Luca Guidi** Introduced Lotus::Utils::String#demodulize
-
-f9badc2 _2014-01-16_ **Luca Guidi** Fix for ClassAttribute: ensure class attributes to be inherited even the subclass is defined into a different namespace
-
-c19d26b _2014-01-07_ **Luca Guidi** Introducing Lotus::Utils::IO
-
-0453716 _2013-08-08_ **Luca Guidi** Added Class loading mechanism
-
-272304b _2013-08-07_ **Luca Guidi** Initial mess
+# Lotus::Utils
+Ruby core extentions and class utilities for Lotus
+
+## v0.3.1 - 2014-11-23
+### Added
+- [Luca Guidi] Allow `Utils::Class.load!` to accept any object that implements `#to_s`
+- [Trung Lê] Allow `Utils::Class.load!` to accept a class
+- [Luca Guidi] Introduced `Utils::Class.load_from_pattern!`
+- [Luca Guidi] Introduced `Utils.jruby?` and `Utils.rubinius?`
+- [Luca Guidi] Introduced `Utils::Deprecation`
+- [Luca Guidi] Official support for Rubinius 2.3+
+- [Luca Guidi] Official support for JRuby 1.7+ (with 2.0 mode)
+- [Janko Marohnić] Implemented `Utils::PathPrefix` relativness and absolutness
+- [Luca Guidi] Made `Utils::PathPrefix` `#join` and `#relative_join` to return a new instance of that class
+- [Luca Guidi] Implemented `Utils::Hash#deep_dup`
+- [Luca Guidi] Made `Utils::PathPrefix#join` to accept multiple argument
+
+### Fixed
+- [Luca Guidi] Made `Utils::PathPrefix#join` remove trailing occurrences for `@separator` from the output
+- [Luca Guidi] Made `Utils::PathPrefix#relative_join` to correctly replace all the instances of `@separator` from the output
+
+### Deprecated
+- [Luca Guidi] Deprecated `Utils::Class.load!` with a pattern like `Articles(Controller|::Controller)`, use `Utils::Class.load_from_pattern!` instead
+
+## v0.3.0 - 2014-10-23
+### Added
+- [Celso Fernandes] Add BigDecimal coercion to Lotus::Utils::Kernel
+- [Luca Guidi] Define `Boolean` constant, if missing
+- [Luca Guidi] Use composition over inheritance for `Lotus::Utils::PathPrefix`
+- [Luca Guidi] Use composition over inheritance for `Lotus::Utils::Hash`
+- [Luca Guidi] Use composition over inheritance for `Lotus::Utils::String`
+
+### Fixed
+- [Luca Guidi] Improved error message for `Utils::Class.load!`
+- [Tom Kadwill] Improved error `NameError` message by passing in the whole constant name to `Utils::Class.load!`
+- [Luca Guidi] `Utils::Hash#to_h` return instances of `::Hash` in case of nested symbolized data structure
+- [Luca Guidi] Raise `TypeError` if `nil` is passed to `PathPrefix#relative_join`
+- [Peter Suschlik] Define `Lotus::Utils::Hash#respond_to_missing?`
+- [Peter Suschlik] Define `Lotus::Utils::String#responds_to_missing?`
+- [Luca Guidi] Ensure `Utils::Hash#inspect` output to be the same of `::Hash#inspect`
+
+## v0.2.0 - 2014-06-23
+### Added
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Symbol`
+- [Luca Guidi] Made `Kernel.Pathname` to raise an error when `nil` is passed as argument
+- [Luca Guidi] Implemented `Lotus::Utils::LoadPaths#freeze` in order to prevent modification after the object has been frozen
+- [Luca Guidi] Implemented Lotus::Utils::LoadPaths#push, also aliased as #<<
+- [Luca Guidi] Use composition over inheritance for `Lotus::Utils::LoadPaths`
+- [Luca Guidi] Introduced `Lotus::Utils::LoadPaths`
+- [Luca Guidi] Introduced `Lotus::Utils::String#namespace`, in order to return the top level Ruby namespace for the given string
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Pathname`
+
+### Fixed
+- [Luca Guidi] Implemented `Lotus::Utils::LoadPaths#initialize_copy` in order to safely `#dup` and `#clone`
+
+### Changed
+- [Luca Guidi] Implemented `Lotus::Utils::Callbacks::Chain#freeze` in order to prevent modification after the object has been frozen
+- [Luca Guidi] All the `Utils::Kernel` methods will raise `TypeError` in case of failed coercion.
+- [Luca Guidi] Made `Kernel.Time` to raise an error when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.DateTime` to raise an error when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Date` to raise an error when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Boolean` to return false when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.String` to return an empty string when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Float` to return `0.0` when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Integer` to return `0` when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Hash` to return an empty `Hash` when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Set` to return an empty `Set` when `nil` is passed as argument
+- [Luca Guidi] Made `Kernel.Array` to return an empty `Array` when `nil` is passed as argument
+- [Luca Guidi] Use composition over inheritance for `Lotus::Utils::Callbacks::Chain`
+
+## v0.1.1 - 2014-04-23
+### Added
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Time`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.DateTime`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Date`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Float`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Boolean`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Hash`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Set`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.String`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Integer`
+- [Luca Guidi] Implemented `Lotus::Utils::Kernel.Array`
+
+### Fixed
+- [Christopher Keele] Add missing stdlib `Set` require to `Utils::ClassAttribute`
+
+## v0.1.0 - 2014-01-23
+### Added
+- [Luca Guidi] Introduced `Lotus::Utils::String#demodulize`
+- [Luca Guidi] Introduced `Lotus::Utils::IO.silence_warnings` 
+- [Luca Guidi] Introduced class loading mechanism from a string: `Utils::Class.load!`
+- [Luca Guidi] Introduced callbacks support for classes
+- [Luca Guidi] Introduced inheritable class level attributes
+- [Luca Guidi] Introduced `Utils::Hash`
+- [Luca Guidi] Introduced `Utils::String`
+- [Luca Guidi] Introduced `Utils::PathPrefix`
+- [Luca Guidi] Official support for MRI 2.0+

data/README.md

@@ -22,7 +22,7 @@ Ruby core extentions and class utilities for [Lotus](http://lotusrb.org)
 
 ## Rubies
 
-__Lotus::Utils__ supports Ruby (MRI) 2+ and JRuby 1.7 (with 2.0 mode).
+__Lotus::Utils__ supports Ruby (MRI) 2+, JRuby 1.7+ (with 2.0 mode) and Rubinius 2.3.0+.
 
 ## Installation
 

data/lib/lotus/utils/class.rb

@@ -1,22 +1,64 @@
 require 'lotus/utils/string'
+require 'lotus/utils/deprecation'
 
 module Lotus
   module Utils
     # Class utilities
     # @since 0.1.0
     class Class
-      # Loads a class for the given string or pattern.
-      #
-      # @param name [String] the specific class name or pattern for the class that we want to load
+      # Loads a class for the given name.
       #
+      # @param name [String, Class] the specific class name
       # @param namespace [Class, Module] the Ruby namespace where we want to perform the lookup.
-      #
       # @return [Class, Module] the found Ruby constant.
       #
       # @raise [NameError] if no constant can be found.
       #
       # @since 0.1.0
       #
+      # @example
+      #   require 'lotus/utils/class'
+      #
+      #   module App
+      #     module Service
+      #       class Endpoint
+      #       end
+      #     end
+      #
+      #     class ServiceEndpoint
+      #     end
+      #   end
+      #
+      #   # basic usage
+      #   Lotus::Utils::Class.load!('App::Service') # => App::Service
+      #   Lotus::Utils::Class.load!(App::Service)   # => App::Service
+      #
+      #   # with explicit namespace
+      #   Lotus::Utils::Class.load!('Service', App) # => App::Service
+      #
+      #   # with missing constant
+      #   Lotus::Utils::Class.load!('Unknown') # => raises NameError
+      def self.load!(name, namespace = Object)
+        name = name.to_s
+
+        if name.match(/\|/)
+          Utils::Deprecation.new("Using Lotus::Utils::Class.load! with a pattern is deprecated, please use Lotus::Utils::Class.load_from_pattern!: #{ name }, #{ namespace }")
+          return load_from_pattern!(name, namespace)
+        end
+
+        namespace.const_get(name)
+      end
+
+      # Loads a class from the given pattern name and namespace
+      #
+      # @param pattern [String] the class name pattern
+      # @param namespace [Class, Module] the Ruby namespace where we want to perform the lookup.
+      # @return [Class, Module] the found Ruby constant.
+      #
+      # @raise [NameError] if no constant can be found.
+      #
+      # @since x.x.x
+      #
       # @see Lotus::Utils::String#tokenize
       #
       # @example
@@ -44,15 +86,15 @@ module Lotus
       #
       #   # with missing constant
       #   Lotus::Utils::Class.load!('Unknown') # => raises NameError
-      def self.load!(name, namespace = Object)
-        String.new(name).tokenize do |token|
+      def self.load_from_pattern!(pattern, namespace = Object)
+        String.new(pattern).tokenize do |token|
           begin
             return namespace.const_get(token)
           rescue NameError
           end
         end
 
-        full_name = [ (namespace == Object ? nil : namespace), name ].compact.join('::')
+        full_name = [ (namespace == Object ? nil : namespace), pattern ].compact.join('::')
         raise NameError.new("uninitialized constant #{ full_name }")
       end
     end

data/lib/lotus/utils/deprecation.rb

@@ -0,0 +1,70 @@
+require 'lotus/utils'
+
+module Lotus
+  module Utils
+    # Prints a deprecation warning when initialized
+    #
+    # @since x.x.x
+    class Deprecation
+      # Initialize a deprecation message and prints it to standard error.
+      #
+      # @param message [#to_s] a deprecation message
+      #
+      # @since x.x.x
+      #
+      # @example Direct usage
+      #   require 'lotus/utils/deprecation'
+      #
+      #   class Engine
+      #     def old_method
+      #       Lotus::Utils::Deprecation.new('old_method is deprecated, please use new_method')
+      #       new_method
+      #     end
+      #
+      #     def new_method
+      #       puts 'started'
+      #     end
+      #   end
+      #
+      #   Engine.new.old_method
+      #     # => old_method is deprecated, please use new_method - called from: test.rb:14:in `<main>'.
+      #     # => started
+      #
+      # @example Indirect usage
+      #   require 'lotus/utils/deprecation'
+      #
+      #   class Engine
+      #     def old_method
+      #       Lotus::Utils::Deprecation.new('old_method is deprecated, please use new_method')
+      #       new_method
+      #     end
+      #
+      #     def new_method
+      #       puts 'started'
+      #     end
+      #   end
+      #
+      #   class Car
+      #     def initialize
+      #       @engine = Engine.new
+      #     end
+      #
+      #     def start
+      #       @engine.old_method
+      #     end
+      #   end
+      #
+      #   Car.new.start
+      #     # => old_method is deprecated, please use new_method - called from: test.rb:20:in `start'.
+      #     # => started
+      def initialize(message)
+        ::Kernel.warn("#{ message } - called from: #{ caller[caller_index] }.")
+      end
+
+      private
+      def caller_index
+        Utils.jruby? || Utils.rubinius? ? 1 : 2
+      end
+    end
+  end
+end

data/lib/lotus/utils/hash.rb

@@ -57,6 +57,73 @@ module Lotus
         self
       end
 
+      # Return a deep copy of the current Lotus::Utils::Hash
+      #
+      # @return [Hash] a deep duplicated self
+      #
+      # @since x.x.x
+      #
+      # @example
+      #   require 'lotus/utils/hash'
+      #
+      #   hash = Lotus::Utils::Hash.new(
+      #     'nil'        => nil,
+      #     'false'      => false,
+      #     'true'       => true,
+      #     'symbol'     => :foo,
+      #     'fixnum'     => 23,
+      #     'bignum'     => 13289301283 ** 2,
+      #     'float'      => 1.0,
+      #     'complex'    => Complex(0.3),
+      #     'bigdecimal' => BigDecimal.new('12.0001'),
+      #     'rational'   => Rational(0.3),
+      #     'string'     => 'foo bar',
+      #     'hash'       => { a: 1, b: 'two', c: :three },
+      #     'u_hash'     => Lotus::Utils::Hash.new({ a: 1, b: 'two', c: :three })
+      #   )
+      #
+      #   duped = hash.deep_dup
+      #
+      #   hash.class  # => Lotus::Utils::Hash
+      #   duped.class # => Lotus::Utils::Hash
+      #
+      #   hash.object_id  # => 70147385937100
+      #   duped.object_id # => 70147385950620
+      #
+      #   # unduplicated values
+      #   duped['nil']        # => nil
+      #   duped['false']      # => false
+      #   duped['true']       # => true
+      #   duped['symbol']     # => :foo
+      #   duped['fixnum']     # => 23
+      #   duped['bignum']     # => 176605528590345446089
+      #   duped['float']      # => 1.0
+      #   duped['complex']    # => (0.3+0i)
+      #   duped['bigdecimal'] # => #<BigDecimal:7f9ffe6e2fd0,'0.120001E2',18(18)>
+      #   duped['rational']   # => 5404319552844595/18014398509481984)
+      #
+      #   # it duplicates values
+      #   duped['string'].reverse!
+      #   duped['string'] # => "rab oof"
+      #   hash['string']  # => "foo bar"
+      #
+      #   # it deeply duplicates Hash, by preserving the class
+      #   duped['hash'].class # => Hash
+      #   duped['hash'].delete(:a)
+      #   hash['hash'][:a]    # => 1
+      #
+      #   duped['hash'][:b].upcase!
+      #   duped['hash'][:b] # => "TWO"
+      #   hash['hash'][:b]  # => "two"
+      #
+      #   # it deeply duplicates Lotus::Utils::Hash, by preserving the class
+      #   duped['u_hash'].class # => Lotus::Utils::Hash
+      def deep_dup
+        Hash.new.tap do |result|
+          @hash.each {|k, v| result[k] = duplicate(v) }
+        end
+      end
+
       # Returns a new array populated with the keys from this hash
       #
       # @return [Array] the keys
@@ -182,6 +249,22 @@ module Lotus
       def respond_to_missing?(m, include_private=false)
         @hash.respond_to?(m, include_private)
       end
+
+      private
+      # @api private
+      # @since x.x.x
+      def duplicate(value)
+        case value
+        when NilClass, FalseClass, TrueClass, Symbol, Numeric
+          value
+        when Hash
+          value.deep_dup
+        when ::Hash
+          Hash.new(value).deep_dup.to_h
+        else
+          value.dup
+        end
+      end
     end
   end
 end

data/lib/lotus/utils/kernel.rb

@@ -3,6 +3,7 @@ require 'date'
 require 'time'
 require 'pathname'
 require 'bigdecimal'
+require 'lotus/utils'
 
 # Define top level constant Boolean, so it can be easily used by other libraries
 # in coercions DSLs
@@ -623,11 +624,26 @@ module Lotus
       #   # Missing #to_s or #to_str
       #   input = BaseObject.new
       #   Lotus::Utils::Kernel.String(input) # => TypeError
-      def self.String(arg)
-        arg = arg.to_str if arg.respond_to?(:to_str)
-        super(arg)
-      rescue NoMethodError
-        raise TypeError.new "can't convert into String"
+      if Utils.rubinius?
+        def self.String(arg)
+          case arg
+          when ->(a) { a.respond_to?(:to_str) }
+            arg.to_str
+          when ->(a) { a.respond_to?(:to_s) }
+            arg.to_s
+          else
+            super(arg)
+          end
+        rescue NoMethodError
+          raise TypeError.new "can't convert into String"
+        end
+      else
+        def self.String(arg)
+          arg = arg.to_str if arg.respond_to?(:to_str)
+          super(arg)
+        rescue NoMethodError
+          raise TypeError.new "can't convert into String"
+        end
       end
 
       # Coerces the argument to be a Date.

data/lib/lotus/utils/path_prefix.rb

@@ -1,9 +1,18 @@
+require 'lotus/utils/string'
+require 'lotus/utils/kernel'
+
 module Lotus
   module Utils
     # Prefixed string
     #
     # @since 0.1.0
-    class PathPrefix
+    class PathPrefix < Lotus::Utils::String
+      # Path separator
+      #
+      # @since x.x.x
+      # @api private
+      DEFAULT_SEPARATOR = '/'.freeze
+
       # Initialize the path prefix
       #
       # @param string [::String] the prefix value
@@ -12,9 +21,11 @@ module Lotus
       # @return [PathPrefix] self
       #
       # @since 0.1.0
-      def initialize(string = nil, separator = '/')
+      #
+      # @see Lotus::Utils::PathPrefix::DEFAULT_SEPARATOR
+      def initialize(string = nil, separator = DEFAULT_SEPARATOR)
+        super(string)
         @separator = separator
-        @string    = string.to_s
       end
 
       # Joins self with the given token.
@@ -22,22 +33,29 @@ module Lotus
       #
       # @param string [::String] the token we want to join
       #
-      # @return [::String] the joined string
+      # @return [Lotus::Utils::PathPrefix] the joined string
       #
       # @since 0.1.0
       #
-      # @example
+      # @example Single string
       #   require 'lotus/utils/path_prefix'
       #
-      #   path_prefix = Lotus::Utils::PathPrefix.new '/posts'
-      #   path_prefix.join 'new'  # => '/posts/new'
-      #   path_prefix.join '/new' # => '/posts/new'
+      #   path_prefix = Lotus::Utils::PathPrefix.new('/posts')
+      #   path_prefix.join('new').to_s  # => "/posts/new"
+      #   path_prefix.join('/new').to_s # => "/posts/new"
       #
-      #   path_prefix = Lotus::Utils::PathPrefix.new 'posts'
-      #   path_prefix.join 'new'  # => '/posts/new'
-      #   path_prefix.join '/new' # => '/posts/new'
-      def join(string)
-        absolutize relative_join(string)
+      #   path_prefix = Lotus::Utils::PathPrefix.new('posts')
+      #   path_prefix.join('new').to_s  # => "/posts/new"
+      #   path_prefix.join('/new').to_s # => "/posts/new"
+      #
+      # @example Multiple strings
+      #   require 'lotus/utils/path_prefix'
+      #
+      #   path_prefix = Lotus::Utils::PathPrefix.new('myapp')
+      #   path_prefix.join('/assets', 'application.js').to_s
+      #     # => "/myapp/assets/application.js"
+      def join(*strings)
+        relative_join(strings).absolute!
       end
 
       # Joins self with the given token, without prefixing it with `separator`.
@@ -46,7 +64,7 @@ module Lotus
       # @param string [::String] the token we want to join
       # @param separator [::String] the separator used between tokens
       #
-      # @return [::String] the joined string
+      # @return [Lotus::Utils::PathPrefix] the joined string
       #
       # @raise [TypeError] if one of the argument can't be treated as a
       #   string
@@ -57,62 +75,69 @@ module Lotus
       #   require 'lotus/utils/path_prefix'
       #
       #   path_prefix = Lotus::Utils::PathPrefix.new 'posts'
-      #   path_prefix.relative_join 'new'      # => 'posts/new'
-      #   path_prefix.relative_join 'new', '_' # => 'posts_new'
-      def relative_join(string, separator = @separator)
+      #   path_prefix.relative_join('new').to_s      # => 'posts/new'
+      #   path_prefix.relative_join('new', '_').to_s # => 'posts_new'
+      def relative_join(strings, separator = @separator)
         raise TypeError if separator.nil?
-        relativize [@string, string].join(separator), separator
+        prefix = @string.gsub(@separator, separator)
+
+        self.class.new(
+          Utils::Kernel.Array([prefix, strings]).join(separator),
+          separator
+        ).relative!
       end
 
-      # Returns the hash of the internal string
+      protected
+
+      # Modifies the path prefix to have a prepended separator.
+      #
+      # @return [self]
       #
-      # @return [Fixnum]
+      # @since x.x.x
+      # @api private
       #
-      # @since 0.3.0
-      def hash
-        @string.hash
+      # @see #absolute
+      def absolute!
+        @string.prepend(separator) unless absolute?
+
+        self
       end
 
-      # Returns a string representation
+      # Returns whether the path prefix starts with its separator.
+      #
+      # @return [TrueClass,FalseClass]
       #
-      # @return [String]
+      # @since x.x.x
+      # @api private
       #
-      # @since 0.3.0
-      def to_s
-        @string
+      # @example
+      #   require 'lotus/utils/path_prefix'
+      #
+      #   Lotus::Utils::PathPrefix.new('/posts').absolute? #=> true
+      #   Lotus::Utils::PathPrefix.new('posts').absolute?  #=> false
+      def absolute?
+        @string.start_with?(separator)
       end
 
-      alias_method :to_str,  :to_s
-
-      # Equality
+      # Modifies the path prefix to remove the leading separator.
       #
-      # @return [TrueClass,FalseClass]
+      # @return [self]
       #
-      # @since 0.3.0
-      def ==(other)
-        to_s == other
-      end
+      # @since x.x.x
+      # @api private
+      #
+      # @see #relative
+      def relative!
+        @string.gsub!(%r{(?<!:)#{ separator * 2 }}, separator)
+        @string.sub!(%r{\A#{ separator }}, '')
 
-      alias_method :eql?, :==
+        self
+      end
 
       private
+      # @since 0.1.0
+      # @api private
       attr_reader :separator
-
-      def absolutize(string)
-        string.tap do |s|
-          s.prepend(separator) unless absolute?(s)
-        end
-      end
-
-      def absolute?(string)
-        string.start_with?(separator)
-      end
-
-      def relativize(string, separator = @separator)
-        string.
-          gsub(%r{(?<!:)#{ separator * 2 }}, separator).
-          gsub(%r{\A#{ separator }}, '')
-      end
     end
   end
 end

data/lib/lotus/utils/version.rb

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

data/lib/lotus/utils.rb

@@ -2,6 +2,35 @@ require 'lotus/utils/version'
 
 module Lotus
   # Ruby core extentions and Lotus utilities
+  #
+  # @since 0.1.0
   module Utils
+    # @since x.x.x
+    # @api private
+    LOTUS_JRUBY = 'java'.freeze
+
+    # @since x.x.x
+    # @api private
+    LOTUS_RUBINIUS = 'rbx'.freeze
+
+    # Checks if the current VM is JRuby
+    #
+    # @return [TrueClass,FalseClass] return if the VM is JRuby or not
+    #
+    # @since x.x.x
+    # @api private
+    def self.jruby?
+      RUBY_PLATFORM == LOTUS_JRUBY
+    end
+
+    # Checks if the current VM is Rubinius
+    #
+    # @return [TrueClass,FalseClass] return if the VM is Rubinius or not
+    #
+    # @since x.x.x
+    # @api private
+    def self.rubinius?
+      RUBY_ENGINE == LOTUS_RUBINIUS
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - lib/lotus/utils/callbacks.rb
 - lib/lotus/utils/class.rb
 - lib/lotus/utils/class_attribute.rb
+- lib/lotus/utils/deprecation.rb
 - lib/lotus/utils/hash.rb
 - lib/lotus/utils/io.rb
 - lib/lotus/utils/kernel.rb