easy_format 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5b9bc0ed74a7d7a5fd9afe9925f84e7347bc841
+  data.tar.gz: b084beea9c21fbf1bb2da066f2a2e1a173b35eb4
+SHA512:
+  metadata.gz: 1e7080e208b155e62ef8b8cee042c0fd9850e1b164c18359de0f64cec008d7ffed548a0f520c03e4173e5db644cbc27d34d9bac1bb48936e71e0b2221de81a19
+  data.tar.gz: 335450487d9c182fe0e3d3fa8329ce9e2818796208ca1709b1978796ec11d94b16a1250bc11c50845f7515be2606251852d5168f96cc8e31ee12f34b64244be3

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/lib/easy_format.rb

@@ -0,0 +1,22 @@
+#
+# Author:: Alex Munoz (<amunoz951@gmail.com>)
+# Copyright:: Copyright (c) 2020 Alex Munoz
+# License:: Apache License, Version 2.0
+#
+# 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 'time' # deprecated - Remove 11/01/2020
+require_relative 'easy_format/data_type_helper' # deprecated - Remove 11/01/2020 along with corresponding files
+require_relative 'easy_format/date_time' # deprecated - Remove 11/01/2020 along with corresponding files
+require_relative 'easy_format/file_system'
+require_relative 'easy_format/validation'

data/lib/easy_format/data_type_helper.rb

@@ -0,0 +1,175 @@
+module EasyFormat
+  module_function
+
+  module Hash
+    module_function
+
+    def log_deprecation(namespace, method_name)
+      EasyIO.logger.warn "#{namespace}.#{method_name} is deprecated! Use Hashly.#{method_name} instead (require hashly)!"
+    end
+
+    def safe_value(hash, *keys)
+      EasyFormat::Hash.log_deprecation('EasyFormat::Hash', __method__)
+      return nil if hash.nil? || hash[keys.first].nil?
+      return hash[keys.first] if keys.length == 1 # return the value if we have reached the final key
+      safe_value(hash[keys.shift], *keys) # recurse until we have reached the final key
+    end
+
+    def stringify_all_keys(hash)
+      EasyFormat::Hash.log_deprecation('EasyFormat::Hash', __method__)
+      stringified_hash = {}
+      hash.each do |k, v|
+        stringified_hash[k.to_s] = v.is_a?(::Hash) ? stringify_all_keys(v) : v
+      end
+      stringified_hash
+    end
+
+    def symbolize_all_keys(hash)
+      EasyFormat::Hash.log_deprecation('EasyFormat::Hash', __method__)
+      symbolized_hash = {}
+      hash.each do |k, v|
+        symbolized_hash[k.to_sym] = v.is_a?(::Hash) ? symbolize_all_keys(v) : v
+      end
+      symbolized_hash
+    end
+
+    # Evaluates the block on every key pair recursively. If any block is truthy, the method returns true, otherwise, false.
+    def any?(hash, &block)
+      EasyFormat::Hash.log_deprecation('EasyFormat::Hash', __method__)
+      raise 'hash is a required argument' if hash.nil?
+      raise 'A block must be provided to this method to evaluate on each key pair. The evaluation occurs recursively. Block arguments: |k, v|' if block.nil?
+      hash.each do |k, v|
+        return true if yield(k, v)
+        return true if v.is_a?(::Hash) && any?(v, &block) # recurse
+      end
+      false
+    end
+
+    # Sorts by key recursively - optionally include sorting of arrays
+    def deep_sort(hash, include_arrays: true)
+      EasyFormat::Hash.log_deprecation('EasyFormat::Hash', __method__)
+      raise "argument must be of type Hash - Actual type: #{hash.class}" unless hash.is_a?(::Hash)
+      hash.each_with_object({}) do |(k, v), child_hash|
+        child_hash[k] = case v
+                        when ::Hash
+                          deep_sort(v)
+                        when ::Array
+                          include_arrays ? v.sort : v
+                        else
+                          v
+                        end
+      end.sort.to_h
+    end
+  end
+
+  # Deep merge two structures
+  #   boolean_or: use a boolean || operator on the base and override if they are not a Hash or Array
+  #   Left outer join: Only merge keys that already exist in the base
+  def deep_merge(base, override, boolean_or: false, left_outer_join_depth: 0)
+    EasyFormat::Hash.log_deprecation('EasyFormat', __method__)
+    left_outer_join_depth -= 1 # decrement left_outer_join_depth for recursion
+    if base.nil?
+      return nil if left_outer_join_depth >= 0
+      return override.is_a?(Hash) ? override.dup : override
+    end
+
+    case override
+    when nil
+      base = base.dup if base.is_a?(Hash) # duplicate hash to avoid modification by reference issues
+      base # if override doesn't exist, simply return the existing value
+    when ::Hash
+      base = base.dup
+      override.each do |src_key, src_value|
+        next if base[src_key].nil? && left_outer_join_depth >= 0 # if this is a left outer join and the key does not exist in the base, skip it
+        base[src_key] = base[src_key] ? deep_merge(base[src_key], src_value, boolean_or: boolean_or, left_outer_join_depth: left_outer_join_depth) : src_value # Recurse if both are Hash
+      end
+      base
+    when ::Array
+      base |= override
+      base
+    when ::String, ::Integer, ::Time, ::TrueClass, ::FalseClass
+      boolean_or ? base || override : override
+    else
+      throw "Implementation for deep merge of type #{override.class} is missing."
+    end
+  end
+
+  # Identifies what keys in the comparison hash are missing from base hash.
+  # Optionally keep the values from the comparison hash, otherwise assigns the missing keys a value of :missing_key
+  def deep_diff_by_key(base, comparison, keep_values: false)
+    EasyFormat::Hash.log_deprecation('EasyFormat', __method__)
+    missing_keys = {}
+    if comparison.is_a?(::Hash)
+      compared_keys = base.is_a?(::Hash) ? comparison.keys - base.keys : comparison.keys # Determine what keys the comparison has that the base doesn't
+      compared_keys.each { |k| missing_keys[k] = keep_values ? comparison[k] : :missing_key } # Save the missing keys
+      comparison.each do |k, v|
+        missing_keys[k] = deep_diff_by_key(base[k], v, keep_values: keep_values) if v.is_a?(::Hash) # Recurse to find more missing keys if the hash goes deeper
+      end
+    end
+    missing_keys.reject { |_k, v| v.is_a?(::Hash) && v.empty? } # Remove any empty hashes as there were no missing keys in them
+  end
+
+  # Deep diff two structures
+  # For a hash, returns keys found in both hashes where the values don't match.
+  # If a key exists in the base, but NOT the comparison, it is NOT considered a difference so that it can be a one way comparison.
+  # For an array, returns an array with values found in the comparison array but not in the base array.
+  def deep_diff(base, comparison)
+    EasyFormat::Hash.log_deprecation('EasyFormat', __method__)
+    if base.nil? # if base is nil, entire comparison object is different
+      return comparison.is_a?(Hash) ? comparison.dup : comparison
+    end
+
+    case comparison
+    when nil
+      {}
+    when ::Hash
+      differing_values = {}
+      base = base.dup
+      comparison.each do |src_key, src_value|
+        difference = deep_diff(base[src_key], src_value)
+        differing_values[src_key] = difference unless difference == :no_diff
+      end
+      differing_values.reject { |_k, v| v.is_a?(::Hash) && v.empty? }
+    when ::Array
+      difference = comparison - base
+      difference.empty? ? :no_diff : difference
+    else
+      base == comparison ? :no_diff : comparison
+    end
+  end
+
+  # Reject hash keys however deep they are. Provide a block and if it evaluates to true for a given key/value pair, it will be rejected.
+  def deep_reject(hash, &block)
+    EasyFormat::Hash.log_deprecation('EasyFormat', __method__)
+    hash.each_with_object({}) do |(k, v), h|
+      next if yield(k, v) # reject the current key/value pair by skipping it if the block given evaluates to true
+      h[k] = v.is_a?(::Hash) ? deep_reject(v, &block) : v # recursively go up the hash tree or keep the value if it's not a hash.
+    end
+  end
+
+  # Deep diff two Hashes
+  # Remove any keys in the first hash also contained in the second hash
+  # If a key exists in the base, but NOT the comparison, it is kept.
+  def deep_reject_by_hash(base, comparison)
+    EasyFormat::Hash.log_deprecation('EasyFormat', __method__)
+    return nil if base.nil?
+
+    case comparison
+    when ::Hash
+      return base unless base.is_a?(::Hash) # if base is not a hash but the comparison is, return the base
+      base = base.dup
+      comparison.each do |src_key, src_value|
+        base[src_key] = deep_reject_by_hash(base[src_key], src_value) # recurse to the leaf
+        base[src_key] = nil if base[src_key].is_a?(::Hash) && base[src_key].empty? # set leaves to nil if they are empty hashes
+      end
+      base.reject { |_k, v| v.nil? } # reject any leaves that were set to nil
+    else # rubocop:disable Style/EmptyElse - for clarity
+      nil # drop the value if we have reached a leaf in the comparison hash
+    end
+  end
+
+  def reject_keys_with_nil_values(base)
+    EasyFormat::Hash.log_deprecation('EasyFormat', __method__)
+    deep_reject(base) { |_k, v| v.nil? }
+  end
+end

data/lib/easy_format/date_time.rb

@@ -0,0 +1,27 @@
+module EasyFormat
+  module DateTime
+    module_function
+
+    def log_deprecation(namespace, method_name)
+      EasyIO.logger.warn "#{namespace}.#{method_name} is deprecated! Use EasyTime.#{method_name} instead (require 'easy_time')!"
+    end
+
+    def yyyymmdd(date = Time.now)
+      log_deprecation('EasyFormat::DateTime', __method__)
+      date = ::Time.parse(date) unless date.is_a?(Time)
+      date.strftime('%Y%m%d')
+    end
+
+    def hhmmss(time = Time.now)
+      log_deprecation('EasyFormat::DateTime', __method__)
+      time = ::Time.parse(time) unless time.is_a?(Time)
+      time.strftime('%H%M%S')
+    end
+
+    def yyyymmdd_hhmmss(date_and_time = Time.now)
+      log_deprecation('EasyFormat::DateTime', __method__)
+      date_and_time = ::Time.parse(date_and_time) unless date_and_time.is_a?(Time)
+      date_and_time.strftime('%Y%m%d_%H%M%S')
+    end
+  end
+end

data/lib/easy_format/file_system.rb

@@ -0,0 +1,18 @@
+module EasyFormat
+  module File
+    module_function
+
+    def windows_friendly_name(name, type: :file) # type options: :file or :path
+      type == :file ? name.gsub(%r{[\x00/\\:\*\?\"<>\|]}, '_') : name.gsub(/[\x00\*\?\"<>\|]/, '_')
+    end
+  end
+
+  module Directory
+    module_function
+
+    def ensure_trailing_slash(directory)
+      return nil if directory.nil?
+      ::File.join(directory, '')
+    end
+  end
+end

data/lib/easy_format/validation.rb

@@ -0,0 +1,15 @@
+module EasyFormat
+  module_function
+
+  # Optional parameters should be an array of symbols or strings
+  # rubocop:disable Security/Eval
+  def validate_parameters(method, method_binding, optional_parameters = [])
+    method.parameters.each do |parameter|
+      parameter_name = parameter.last.to_s
+      next if optional_parameters.any? { |o| o.to_s.casecmp(parameter_name) == 0 }
+      parameter_value = eval(parameter_name, method_binding)
+      raise "#{parameter_name} is a required parameter for #{caller[2][/`.*'/][1..-2]}!" if parameter_value.nil? || (parameter_value.respond_to?(:empty?) && parameter_value.empty?)
+    end
+  end
+  # rubocop:enable Security/Eval
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: easy_format
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex Munoz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- amunoz951@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/easy_format.rb
+- lib/easy_format/data_type_helper.rb
+- lib/easy_format/date_time.rb
+- lib/easy_format/file_system.rb
+- lib/easy_format/validation.rb
+homepage: https://github.com/amunoz951/easy_format
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby library for ease of merging hashes recursively, conforming to OS filesystem
+  friendly names, and more.
+test_files: []