require 'set' require 'date' require 'time' module Lotus module Utils # Kernel utilities # @since 0.1.1 module Kernel # Coerces the argument to be an array. # # It's similar to Ruby's Kernel.Array, but it applies further # transformations: # # * flatten # * compact # * uniq # # @param arg [Object] the input # # @return [Array] the result of the coercion # # @raise [NoMethodError] if arg doesn't implement #nil? # # @since 0.1.1 # # @see http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-Array # # @see http://www.ruby-doc.org/core-2.1.1/Array.html#method-i-flatten # @see http://www.ruby-doc.org/core-2.1.1/Array.html#method-i-compact # @see http://www.ruby-doc.org/core-2.1.1/Array.html#method-i-uniq # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Array(nil) # => nil # Lotus::Utils::Kernel.Array(true) # => [true] # Lotus::Utils::Kernel.Array(false) # => [false] # Lotus::Utils::Kernel.Array(1) # => [1] # Lotus::Utils::Kernel.Array([1]) # => [1] # Lotus::Utils::Kernel.Array([1, [2]]) # => [1,2] # Lotus::Utils::Kernel.Array([1, [2, nil]]) # => [1,2] # Lotus::Utils::Kernel.Array([1, [2, nil, 1]]) # => [1,2] # # @example Array Interface # require 'lotus/utils/kernel' # # ResultSet = Struct.new(:records) do # def to_a # records.to_a.sort # end # end # # Response = Struct.new(:status, :headers, :body) do # def to_ary # [status, headers, body] # end # end # # set = ResultSet.new([2,1,3]) # Lotus::Utils::Kernel.Array(set) # => [1,2,3] # # response = Response.new(200, {}, 'hello') # Lotus::Utils::Kernel.Array(response) # => [200, {}, "hello"] def self.Array(arg) super(arg).flatten.compact.uniq unless arg.nil? end # Coerces the argument to be a set. # # @param arg [Object] the input # # @return [Set] the result of the coercion # # @raise [NoMethodError] if arg doesn't implement #respond_to? # # @since 0.1.1 # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Set(nil) # => nil # Lotus::Utils::Kernel.Set(true) # => # # Lotus::Utils::Kernel.Set(false) # => # # Lotus::Utils::Kernel.Set(1) # => # # Lotus::Utils::Kernel.Set([1]) # => # # Lotus::Utils::Kernel.Set([1, 1]) # => # # Lotus::Utils::Kernel.Set([1, [2]]) # => # # Lotus::Utils::Kernel.Set([1, [2, nil]]) # => # # Lotus::Utils::Kernel.Set({a: 1}) # => # # # @example Set Interface # require 'securerandom' # require 'lotus/utils/kernel' # # UuidSet = Class.new do # def initialize(*uuids) # @uuids = uuids # end # # def to_set # Set.new.tap do |set| # @uuids.each {|uuid| set.add(uuid) } # end # end # end # # uuids = UuidSet.new(SecureRandom.uuid) # Lotus::Utils::Kernel.Set(uuids) # # => # # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Set(BasicObject.new) # => NoMethodError def self.Set(arg) if arg.respond_to?(:to_set) arg.to_set else Set.new(::Kernel.Array(arg)) end unless arg.nil? end # Coerces the argument to be an hash. # # @param arg [Object] the input # # @return [Hash, nil] the result of the coercion # # @raise [NoMethodError] if arg doesn't implement #nil? # @raise [NoMethodError] if arg doesn't implement #respond_to? # @raise [TypeError] if arg can't be coerced # # @since 0.1.1 # # @see http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-Hash # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Hash(nil) # => nil # Lotus::Utils::Kernel.Hash({a: 1}) # => { :a => 1 } # Lotus::Utils::Kernel.Hash([[:a, 1]]) # => { :a => 1 } # Lotus::Utils::Kernel.Hash(Set.new([[:a, 1]])) # => { :a => 1 } # # @example Hash Interface # require 'lotus/utils/kernel' # # Room = Class.new do # def initialize(*args) # @args = args # end # # def to_h # Hash[*@args] # end # end # # Record = Class.new do # def initialize(attributes = {}) # @attributes = attributes # end # # def to_hash # @attributes # end # end # # room = Room.new(:key, 123456) # Lotus::Utils::Kernel.Hash(room) # => { :key => 123456 } # # record = Record.new(name: 'L') # Lotus::Utils::Kernel.Hash(record) # => { :name => "L" } # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # input = BasicObject.new # Lotus::Utils::Kernel.Hash(input) # => NoMethodError if RUBY_VERSION >= '2.1' def self.Hash(arg) if arg.respond_to?(:to_h) arg.to_h else super(arg) end unless arg.nil? end else def self.Hash(arg) case arg when NilClass then nil when ::Hash then arg when ::Array, ::Set then Hash[*self.Array(arg)] when ->(a) { a.respond_to?(:to_h) } then arg.to_h else super(arg) end rescue ArgumentError raise TypeError end end # Coerces the argument to be an integer. # # It's similar to Ruby's Kernel.Integer, but it doesn't stop at the first # error and tries to be less "whiny". # # @param arg [Object] the argument # # @return [Fixnum,nil] the result of the coercion # # @raise [TypeError] if the argument can't be coerced # @raise [NoMethodError] if the argument doesn't implenent #nil? # @raise [TypeError,FloatDomainError,RangeError] if the argument it's too # big. # # @since 0.1.1 # # @see http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-Integer # # @example Basic Usage # require 'bigdecimal' # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Integer(1) # => 1 # Lotus::Utils::Kernel.Integer(1.2) # => 1 # Lotus::Utils::Kernel.Integer(011) # => 9 # Lotus::Utils::Kernel.Integer(0xf5) # => 245 # Lotus::Utils::Kernel.Integer("1") # => 1 # Lotus::Utils::Kernel.Integer(Rational(0.3)) # => 0 # Lotus::Utils::Kernel.Integer(Complex(0.3)) # => 0 # Lotus::Utils::Kernel.Integer(BigDecimal.new(12.00001)) # => 12 # Lotus::Utils::Kernel.Integer(176605528590345446089) # # => 176605528590345446089 # # Lotus::Utils::Kernel.Integer(Time.now) # => 1396947161 # # @example Integer Interface # require 'lotus/utils/kernel' # # UltimateAnswer = Struct.new(:question) do # def to_int # 42 # end # end # # answer = UltimateAnswer.new('The Ultimate Question of Life') # Lotus::Utils::Kernel.Integer(answer) # => 42 # # @example Error Handling # require 'lotus/utils/kernel' # # # nil # Kernel.Integer(nil) # => TypeError # Lotus::Utils::Kernel.Integer(nil) # => nil # # # float represented as a string # Kernel.Integer("23.4") # => ArgumentError # Lotus::Utils::Kernel.Integer("23.4") # => 23 # # # rational represented as a string # Kernel.Integer("2/3") # => ArgumentError # Lotus::Utils::Kernel.Integer("2/3") # => 2 # # # complex represented as a string # Kernel.Integer("2.5/1") # => ArgumentError # Lotus::Utils::Kernel.Integer("2.5/1") # => 2 # # @example Unchecked Exceptions # require 'date' # require 'bigdecimal' # require 'lotus/utils/kernel' # # # Missing #to_int and #to_i # input = OpenStruct.new(color: 'purple') # Lotus::Utils::Kernel.Integer(input) # => TypeError # # # When true # input = true # Lotus::Utils::Kernel.Integer(input) # => TypeError # # # When false # input = false # Lotus::Utils::Kernel.Integer(input) # => TypeError # # # When Date # input = Date.today # Lotus::Utils::Kernel.Integer(input) # => TypeError # # # When DateTime # input = DateTime.now # Lotus::Utils::Kernel.Integer(input) # => TypeError # # # Missing #nil? # input = BasicObject.new # Lotus::Utils::Kernel.Integer(input) # => NoMethodError # # # bigdecimal infinity # input = BigDecimal.new("Infinity") # Lotus::Utils::Kernel.Integer(input) # => FloatDomainError # # # bigdecimal NaN # input = BigDecimal.new("NaN") # Lotus::Utils::Kernel.Integer(input) # => FloatDomainError # # # big rational # input = Rational(-8) ** Rational(1, 3) # Lotus::Utils::Kernel.Integer(input) # => RangeError # # # big complex represented as a string # input = Complex(2, 3) # Lotus::Utils::Kernel.Integer(input) # => RangeError def self.Integer(arg) super(arg) unless arg.nil? rescue ArgumentError arg.to_i end # Coerces the argument to be a float. # # It's similar to Ruby's Kernel.Float, but it doesn't stop at the first # error and tries to be less "whiny". # # @param arg [Object] the argument # # @return [Float,nil] the result of the coercion # # @raise [TypeError] if the argument can't be coerced # @raise [NoMethodError] if the argument doesn't implenent #nil? # @raise [TypeError,FloatDomainError,RangeError] if the argument it's too # big. # # @since 0.1.1 # # @see http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-Float # # @example Basic Usage # require 'bigdecimal' # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Float(1) # => 1.0 # Lotus::Utils::Kernel.Float(1.2) # => 1.2 # Lotus::Utils::Kernel.Float(011) # => 9.0 # Lotus::Utils::Kernel.Float(0xf5) # => 245.0 # Lotus::Utils::Kernel.Float("1") # => 1.0 # Lotus::Utils::Kernel.Float(Rational(0.3)) # => 0.3 # Lotus::Utils::Kernel.Float(Complex(0.3)) # => 0.3 # Lotus::Utils::Kernel.Float(BigDecimal.new(12.00001)) # => 12.00001 # Lotus::Utils::Kernel.Float(176605528590345446089) # # => 176605528590345446089.0 # # Lotus::Utils::Kernel.Float(Time.now) # => 397750945.515169 # # @example Float Interface # require 'lotus/utils/kernel' # # class Pi # def to_f # 3.14 # end # end # # pi = Pi.new # Lotus::Utils::Kernel.Float(pi) # => 3.14 # # @example Error Handling # require 'bigdecimal' # require 'lotus/utils/kernel' # # # nil # Kernel.Float(nil) # => TypeError # Lotus::Utils::Kernel.Float(nil) # => nil # # # float represented as a string # Kernel.Float("23.4") # => ArgumentError # Lotus::Utils::Kernel.Float("23.4") # => 23.4 # # # rational represented as a string # Kernel.Float("2/3") # => ArgumentError # Lotus::Utils::Kernel.Float("2/3") # => 2.0 # # # complex represented as a string # Kernel.Float("2.5/1") # => ArgumentError # Lotus::Utils::Kernel.Float("2.5/1") # => 2.5 # # # bigdecimal infinity # input = BigDecimal.new("Infinity") # Lotus::Utils::Kernel.Float(input) # => Infinity # # # bigdecimal NaN # input = BigDecimal.new("NaN") # Lotus::Utils::Kernel.Float(input) # => NaN # # @example Unchecked Exceptions # require 'date' # require 'bigdecimal' # require 'lotus/utils/kernel' # # # Missing #to_f # input = OpenStruct.new(color: 'purple') # Lotus::Utils::Kernel.Float(input) # => TypeError # # # When true # input = true # Lotus::Utils::Kernel.Float(input) # => TypeError # # # When false # input = false # Lotus::Utils::Kernel.Float(input) # => TypeError # # # When Date # input = Date.today # Lotus::Utils::Kernel.Float(input) # => TypeError # # # When DateTime # input = DateTime.now # Lotus::Utils::Kernel.Float(input) # => TypeError # # # Missing #nil? # input = BasicObject.new # Lotus::Utils::Kernel.Float(input) # => NoMethodError # # # big rational # input = Rational(-8) ** Rational(1, 3) # Lotus::Utils::Kernel.Float(input) # => RangeError # # # big complex represented as a string # input = Complex(2, 3) # Lotus::Utils::Kernel.Float(input) # => RangeError def self.Float(arg) super(arg) unless arg.nil? rescue ArgumentError arg.to_f end # Coerces the argument to be a string. # # It's similar to Ruby's Kernel.String, but it's less "whiny". # # @param arg [Object] the argument # # @return [String,nil] the result of the coercion # # @raise [TypeError] if the argument can't be coerced # @raise [NoMethodError] if the argument doesn't implement #nil? # # @since 0.1.1 # # @see http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-String # # @example Basic Usage # require 'date' # require 'bigdecimal' # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.String('') # => "" # Lotus::Utils::Kernel.String('ciao') # => "ciao" # # Lotus::Utils::Kernel.String(true) # => "true" # Lotus::Utils::Kernel.String(false) # => "false" # # Lotus::Utils::Kernel.String(:lotus) # => "lotus" # # Lotus::Utils::Kernel.String(Picture) # => "Picture" # class # Lotus::Utils::Kernel.String(Lotus) # => "Lotus" # module # # Lotus::Utils::Kernel.String([]) # => "[]" # Lotus::Utils::Kernel.String([1,2,3]) # => "[1, 2, 3]" # Lotus::Utils::Kernel.String(%w[a b c]) # => "[\"a\", \"b\", \"c\"]" # # Lotus::Utils::Kernel.String({}) # => "{}" # Lotus::Utils::Kernel.String({a: 1, 'b' => 'c'}) # => "{:a=>1, \"b\"=>\"c\"}" # # Lotus::Utils::Kernel.String(Date.today) # => "2014-04-11" # Lotus::Utils::Kernel.String(DateTime.now) # => "2014-04-11T10:15:06+02:00" # Lotus::Utils::Kernel.String(Time.now) # => "2014-04-11 10:15:53 +0200" # # Lotus::Utils::Kernel.String(1) # => "1" # Lotus::Utils::Kernel.String(3.14) # => "3.14" # Lotus::Utils::Kernel.String(013) # => "11" # Lotus::Utils::Kernel.String(0xc0ff33) # => "12648243" # # Lotus::Utils::Kernel.String(Rational(-22)) # => "-22/1" # Lotus::Utils::Kernel.String(Complex(11, 2)) # => "11+2i" # Lotus::Utils::Kernel.String(BigDecimal.new(7944.2343, 10)) # => "0.79442343E4" # Lotus::Utils::Kernel.String(BigDecimal.new('Infinity')) # => "Infinity" # Lotus::Utils::Kernel.String(BigDecimal.new('NaN')) # => "Infinity" # # @example String interface # require 'lotus/utils/kernel' # # SimpleObject = Class.new(BasicObject) do # def nil? # false # end # # def to_s # 'simple object' # end # end # # Isbn = Struct.new(:code) do # def to_str # code.to_s # end # end # # simple = SimpleObject.new # isbn = Isbn.new(123) # # Lotus::Utils::Kernel.String(simple) # => "simple object" # Lotus::Utils::Kernel.String(isbn) # => "123" # # @example Error Handling # require 'lotus/utils/kernel' # # # nil # Kernel.String(nil) # => "" # Lotus::Utils::Kernel.String(nil) # => nil # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # BaseObject = Class.new(BasicObject) do # def nil? # false # end # end # # # Missing #nil? # input = BasicObject.new # Lotus::Utils::Kernel.String(input) # => NoMethodError # # # Missing #to_s or #to_str # input = BaseObject.new # Lotus::Utils::Kernel.Integer(input) # => TypeError def self.String(arg) super(arg) unless arg.nil? end # Coerces the argument to be a Date. # # @param arg [Object] the argument # # @return [Date,nil] the result of the coercion # # @raise [NoMethodError] if the argument doesn't implement #respond_to? or #to_s # @raise [ArgumentError] if the argument can't be coerced # # @since 0.1.1 # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Date(nil) # => nil # # Lotus::Utils::Kernel.Date(Date.today) # # => # # # Lotus::Utils::Kernel.Date(DateTime.now) # # => # # # Lotus::Utils::Kernel.Date(Time.now) # # => # # # Lotus::Utils::Kernel.Date('2014-04-17') # # => # # # Lotus::Utils::Kernel.Date('2014-04-17 22:37:15') # # => # # # @example Date Interface # require 'lotus/utils/kernel' # # class Christmas # def to_date # Date.parse('Dec, 25') # end # end # # Lotus::Utils::Kernel.Date(Christmas.new) # # => # # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # # Missing #nil? # input = BasicObject.new # Lotus::Utils::Kernel.Date(input) # => NoMethodError def self.Date(arg) if arg.respond_to?(:to_date) arg.to_date else Date.parse(arg.to_s) end unless arg.nil? end # Coerces the argument to be a DateTime. # # @param arg [Object] the argument # # @return [DateTime,nil] the result of the coercion # # @raise [NoMethodError] if the argument doesn't implement #respond_to? or #to_s # @raise [ArgumentError] if the argument can't be coerced # # @since 0.1.1 # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.DateTime(nil) # => nil # # Lotus::Utils::Kernel.DateTime(3483943) # # => Time.at(3483943).to_datetime # # # Lotus::Utils::Kernel.DateTime(DateTime.now) # # => # # # Lotus::Utils::Kernel.DateTime(Date.today) # # => # # # Lotus::Utils::Kernel.Date(Time.now) # # => # # # Lotus::Utils::Kernel.DateTime('2014-04-18') # # => # # # Lotus::Utils::Kernel.DateTime('2014-04-18 09:35:42') # # => # # # @example DateTime Interface # require 'lotus/utils/kernel' # # class NewYearEve # def to_datetime # DateTime.parse('Jan, 1') # end # end # # Lotus::Utils::Kernel.Date(NewYearEve.new) # # => # # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # # Missing #nil? # input = BasicObject.new # Lotus::Utils::Kernel.DateTime(input) # => NoMethodError def self.DateTime(arg) case arg when ->(a) { a.respond_to?(:to_datetime) } then arg.to_datetime when Numeric then DateTime(Time.at(arg)) when NilClass then nil else DateTime.parse(arg.to_s) end end # Coerces the argument to be a Time. # # @param arg [Object] the argument # # @return [Time,nil] the result of the coercion # # @raise [NoMethodError] if the argument doesn't implement #respond_to? or #to_s # @raise [ArgumentError] if the argument can't be coerced # # @since 0.1.1 # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Time(nil) # => nil # # Lotus::Utils::Kernel.Time(Time.now) # # => 2014-04-18 15:56:39 +0200 # # Lotus::Utils::Kernel.Time(DateTime.now) # # => 2014-04-18 15:56:39 +0200 # # Lotus::Utils::Kernel.Time(Date.today) # # => 2014-04-18 00:00:00 +0200 # # Lotus::Utils::Kernel.Time('2014-04-18') # # => 2014-04-18 00:00:00 +0200 # # Lotus::Utils::Kernel.Time('2014-04-18 15:58:02') # # => 2014-04-18 15:58:02 +0200 # # @example Time Interface # require 'lotus/utils/kernel' # # class Epoch # def to_time # Time.at(0) # end # end # # Lotus::Utils::Kernel.Time(Epoch.new) # # => 1970-01-01 01:00:00 +0100 # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # # Missing #nil? # input = BasicObject.new # Lotus::Utils::Kernel.Time(input) # => NoMethodError def self.Time(arg) case arg when ->(a) { a.respond_to?(:to_time) } then arg.to_time when Numeric then Time.at(arg) when NilClass then nil else Time.parse(arg.to_s) end end # Coerces the argument to be a boolean. # # @param arg [Object] the argument # # @return [true,false,nil] the result of the coercion # # @raise [NoMethodError] if the argument doesn't implenent #respond_to? # # @since 0.1.1 # # @example Basic Usage # require 'lotus/utils/kernel' # # Lotus::Utils::Kernel.Boolean(nil) # => nil # Lotus::Utils::Kernel.Boolean(0) # => false # Lotus::Utils::Kernel.Boolean(1) # => true # Lotus::Utils::Kernel.Boolean('0') # => false # Lotus::Utils::Kernel.Boolean('1') # => true # Lotus::Utils::Kernel.Boolean(Object.new) # => true # # @example Boolean Interface # require 'lotus/utils/kernel' # # Answer = Struct.new(:answer) do # def to_bool # case answer # when 'yes' then true # else false # end # end # end # # answer = Answer.new('yes') # Lotus::Utils::Kernel.Boolean(answer) # => true # # @example Unchecked Exceptions # require 'lotus/utils/kernel' # # # Missing #respond_to? # input = BasicObject.new # Lotus::Utils::Kernel.Boolean(input) # => NoMethodError def self.Boolean(arg) case arg when Numeric then arg > 0 && arg <= 1 when String, '0' then Boolean(arg.to_i) when NilClass then nil when ->(a) { a.respond_to?(:to_bool) } then arg.to_bool else !!arg end end end end end