spectre-core 1.15.2 → 2.0.1

data/lib/spectre/helpers.rb

@@ -1,26 +1,35 @@
-require_relative '../spectre'
-
 require 'securerandom'
 require 'json'
 require 'date'
 require 'ostruct'
-require 'jsonpath'
 
 class ::String
+  ##
+  # Parses the string as JSON and returns an +OpenStruct+
+  #
   def as_json
     JSON.parse(self, object_class: OpenStruct)
   end
 
+  ##
+  # Parses the string as a date time object
+  #
   def as_date
     DateTime.parse(self)
   end
 
+  ##
+  # Parses the string as a date time object and returns it as a unix timestamp
+  #
   def as_timestamp
     DateTime.parse(self).to_time.to_i
   end
 
+  ##
+  # Replaces placeholder in style of +#{placeholder}+ with the given +Hash+
+  #
   def with mapping
-    return self unless mapping and mapping.is_a? Hash
+    return self unless mapping.is_a? Hash
 
     new_string = self
 
@@ -31,28 +40,19 @@ class ::String
     new_string
   end
 
+  ##
+  # Trims the string to the given length and adds +...+ at the end
   def trim size = 50
-    if (self.length + 3) > size
-      return self[0..size-4] + '...'
-    end
+    return "#{self[0..size - 4]}..." if (length + 3) > size
 
     self
   end
 
-  def pick path
-    raise ArgumentError.new("`path' must not be nil or empty") if path.nil? or path.empty?
-
-    begin
-      JsonPath.on(self, path)
-    rescue MultiJson::ParseError
-      # do nothing and return nil
-    end
-  end
-
-  # File helpers
-
+  ##
+  # Interprets the string as a file path and reads its content
+  #
   def content with: nil
-    fail "'#{self}' is not a file path, or the file does not exist." unless File.exist? self
+    raise "'#{self}' is not a file path, or the file does not exist." unless File.exist? self
 
     file_content = File.read(self)
 
@@ -63,77 +63,74 @@ class ::String
     end
   end
 
+  ##
+  # Interprets the string as a file path and returns its size
+  #
   def file_size
-    fail "'#{self}' is not a file path, or the file does not exist." unless File.exist? self
+    raise "'#{self}' is not a file path, or the file does not exist." unless File.exist? self
 
     File.size(self)
   end
 
+  ##
+  # Interprets the string as a file path and returns +true+ if is exists, +false+ otherwise
+  #
   def exists?
     File.exist? self
   end
 
+  ##
+  # Interprets the string as a file path and removes it
+  #
   def remove!
-    fail "'#{self}' is not a file path, or the file does not exist." unless File.exist? self
+    raise "'#{self}' is not a file path, or the file does not exist." unless File.exist? self
 
     File.delete self
   end
 end
 
 class ::OpenStruct
-  def to_json *args, **kwargs
-    self.to_h.inject({}) { |memo, (k,v)| memo[k] = v.is_a?(OpenStruct) ? v.to_h : v; memo }.to_json(*args, **kwargs)
+  def each(&)
+    to_h.each(&)
   end
 
-  def pick path
-    raise ArgumentError.new("`path' must not be nil or empty") if path.nil? or path.empty?
-
-    JsonPath.on(self, path)
+  def to_json(*, **)
+    to_h
+      .transform_values { |x| x.is_a?(OpenStruct) ? x.to_h : x }
+      .to_json(*, **)
   end
 
-  def default_to! defaults
+  def default_to! defaults = {}, **kwargs
+    defaults = kwargs if kwargs.any?
+
     defaults.each_key do |key|
-      unless self[key] != nil
-        self[key] = defaults[key]
-      end
+      self[key] = defaults[key] unless to_h.key? key
     end
   end
-
-  alias :defaults_to! :default_to!
 end
 
 class ::Hash
-  def symbolize_keys
-    self.inject({}) { |memo, (k,v)| memo[k.to_sym] = v; memo }
-  end
+  def default_to! defaults = {}, **kwargs
+    defaults = kwargs if kwargs.any?
 
-  def default_to! defaults
     defaults.each_key do |key|
-      unless self[key] != nil
-        self[key] = defaults[key]
-      end
+      self[key] = defaults[key] unless key? key
     end
   end
-
-  alias :defaults_to! :default_to!
-end
-
-class ::Array
-  def first_element
-    self[0]
-  end
-
-  def last_element
-    self[-1]
-  end
 end
 
-def uuid length = nil
-  return SecureRandom.hex(length/2) if length
+module Spectre
+  module Helpers
+    class << self
+      def uuid length = niL
+        return SecureRandom.hex(length / 2) if length
 
-  SecureRandom.uuid
-end
+        SecureRandom.uuid
+      end
 
-def now
-  Time.now
+      def now
+        Time.now
+      end
+    end
+  end
 end

data/lib/spectre/version.rb

@@ -0,0 +1,3 @@
+module Spectre
+  VERSION = '2.0.1'.freeze
+end