mimi-core 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4386bcac3a69eeb1f5a0422c445ba509e735ea4a
-  data.tar.gz: 6c583235d2e0069d255c0598b3e2cce4f4631bcb
+  metadata.gz: db5931bbbdf22818f96d2979dac52cbc4d4058ed
+  data.tar.gz: d8b666e59ec1d340233f7b9a95ca7624dc06b22d
 SHA512:
-  metadata.gz: d234685fd746173702527047e71aaa0c0d237da588e84b1de2f0fa23ecd74cca832569b91729af0e5968e53807d06d6eafb6077c73ac73d454cdfaa9ea041e92
-  data.tar.gz: db3ece3e5d363f942ebd3d98ff92b2c286fc198f74261378dcee0d1b67e38d4dd3f88fbbb443e3f2c648623dc85c2eefd679f6fc59a94f16f65bd8cf4e35533a
+  metadata.gz: bbc4fe8b0d0150fc7181d050de3c037885f90a85c12a4fa55d6e00339151a7adf93506f44026533f91ab6a9f90132a79b72ae463bd5fbe696df8ae17c6a66aad
+  data.tar.gz: 0b5e725a4844406bf1cefbd98c1e7f3bee2a358195c4041dcb0f8cf4e00b5059905845d22ef08543e663725b84e045d643d648656c78fbb0ab0e46dda4eaf040

data/lib/mimi/core/core_ext.rb

@@ -1,13 +1,31 @@
 # frozen_string_literal: true
 
-require 'hashie'
-
 class Hash
   unless instance_methods(false).include?(:only)
+    #
+    # Returns a Hash with only given keys, if present
+    #
+    # @param *keys [*] list of keys
+    # @return [Hash] a new Hash
+    #
+    # @example
+    #   h = { a: 1, b: 2, :c 3 }
+    #   h.only(:a, :b, :d) # => { a: 1, b: 2 }
+    #
     def only(*keys)
       dup.only!(*keys)
     end
 
+    # Modifies the Hash keeping only given keys, if present
+    #
+    # @param *keys [*] list of keys
+    # @return [Hash] self
+    #
+    # @example
+    #   h = { a: 1, b: 2, :c 3 }
+    #   h.only!(:a, :b, :d)
+    #   h # => { a: 1, b: 2 }
+    #
     def only!(*keys)
       if keys.size == 1 && keys.first.is_a?(Array)
         raise ArgumentError, 'Hash#only!() expects keys as list of arguments,' \
@@ -19,10 +37,30 @@ class Hash
   end
 
   unless instance_methods(false).include?(:except)
+    #
+    # Returns a Hash with given keys excluded, if present
+    #
+    # @param *keys [*] list of keys
+    # @return [Hash] a new Hash
+    #
+    # @example
+    #   h = { a: 1, b: 2, :c 3 }
+    #   h.except(:a, :b, :d) # => { c: 3 }
+    #
     def except(*keys)
       dup.except!(*keys)
     end
 
+    # Modifies the Hash excluding given keys, if present
+    #
+    # @param *keys [*] list of keys
+    # @return [Hash] self
+    #
+    # @example
+    #   h = { a: 1, b: 2, :c 3 }
+    #   h.except!(:a, :b, :d)
+    #   h # => { c: 3 }
+    #
     def except!(*keys)
       if keys.size == 1 && keys.first.is_a?(Array)
         raise ArgumentError, 'Hash#except!() expects keys as list of arguments,' \
@@ -34,10 +72,51 @@ class Hash
   end
 
   unless instance_methods(false).include?(:deep_merge)
-    include Hashie::Extensions::DeepMerge
+    #
+    # Deep merges self (left) Hash with another Hash
+    #
+    # On keys existing in both Hashes:
+    # * merges Hash values by merging left Hash with the right Hash
+    # * merges Array values by union operator
+    # * for other values overwrites left Hash value with the right Hash value
+    #
+    # @param right [Hash] the right (other) Hash
+    # @return [Hash] self
+    #
+    def deep_merge!(right)
+      right.each do |k ,v|
+        unless self.key?(k)
+          self[k] = v
+          next
+        end
+        if self[k].is_a?(Hash) && v.is_a?(Hash)
+          self[k].deep_merge!(v)
+        elsif self[k].is_a?(Array) && v.is_a?(Array)
+          self[k] = self[k] | v
+        else
+          # unmergeable values, overwrite
+          self[k] = v
+        end
+      end
+      self
+    end
+
+    # @see #deep_merge!
+    #
+    # @param right [Hash] the right (other) Hash
+    # @return [Hash] a new Hash
+    #
+    def deep_merge(right)
+      deep_dup.deep_merge!(right)
+    end
   end
 
   unless instance_methods(false).include?(:deep_dup)
+    #
+    # Duplicates a Hash with all nested values
+    #
+    # @return [Hash] a new Hash
+    #
     def deep_dup
       map do |k, v|
         v = v.respond_to?(:deep_dup) ? v.deep_dup : v.dup
@@ -47,6 +126,11 @@ class Hash
   end
 
   unless instance_methods(false).include?(:symbolize_keys)
+    #
+    # Symbolizes Hash keys
+    #
+    # @return [Hash] a new Hash
+    #
     def symbolize_keys
       map do |k, v|
         k = k.respond_to?(:to_sym) ? k.to_sym : k
@@ -54,12 +138,21 @@ class Hash
       end.to_h
     end
 
+    # Modifies the Hash symbolizing its keys
+    #
+    # @return [Hash] self
+    #
     def symbolize_keys!
       replace(symbolize_keys)
     end
   end
 
   unless instance_methods(false).include?(:deep_symbolize_keys)
+    #
+    # Symbolizes Hash keys including all nested Hashes
+    #
+    # @return [Hash] a new Hash
+    #
     def deep_symbolize_keys
       map do |k, v|
         k = k.respond_to?(:to_sym) ? k.to_sym : k
@@ -68,12 +161,21 @@ class Hash
       end.to_h
     end
 
+    # Modifies the Hash symbolizing its keys including all nested Hashes
+    #
+    # @return [Hash] self
+    #
     def deep_symbolize_keys!
       replace(deep_symbolize_keys)
     end
   end
 
   unless instance_methods(false).include?(:stringify_keys)
+    #
+    # Stringifies Hash keys
+    #
+    # @return [Hash] a new Hash
+    #
     def stringify_keys
       map do |k, v|
         k = k.respond_to?(:to_s) ? k.to_s : k
@@ -81,12 +183,21 @@ class Hash
       end.to_h
     end
 
+    # Modifies the Hash stringifying its keys
+    #
+    # @return [Hash] self
+    #
     def stringify_keys!
       replace(stringify_keys)
     end
   end
 
   unless instance_methods(false).include?(:deep_stringify_keys)
+    #
+    # Stringifies Hash keys including all nested Hashes
+    #
+    # @return [Hash] a new Hash
+    #
     def deep_stringify_keys
       map do |k, v|
         k = k.respond_to?(:to_s) ? k.to_s : k
@@ -95,6 +206,10 @@ class Hash
       end.to_h
     end
 
+    # Modifies the Hash stringifying its keys including all nested Hashes
+    #
+    # @return [Hash] self
+    #
     def deep_stringify_keys!
       replace(deep_stringify_keys)
     end
@@ -103,25 +218,65 @@ end
 
 class Array
   unless instance_methods(false).include?(:only)
-    def only(*keys)
-      dup.only!(*keys)
+    #
+    # Returns an Array with only selected values, if present
+    #
+    # @param *values [*] list of values
+    # @return [Array] a new Array
+    #
+    # @example
+    #   a = [:a, :b, :c]
+    #   a.only(:a, :b, :d) # => [:a, :b]
+    #
+    def only(*values)
+      dup.only!(*values)
     end
 
-    def only!(*keys)
-      if keys.size == 1 && keys.first.is_a?(Array)
-        raise ArgumentError, 'Array#only!() expects keys as list of arguments,' \
+    # Modifies the Array keeping only given values, if present
+    #
+    # @param *values [*] list of values
+    # @return [Array] self
+    #
+    # @example
+    #   a = [:a, :b, :c]
+    #   a.only!(:a, :b, :d)
+    #   a # => [:a, :b]
+    #
+    def only!(*values)
+      if values.size == 1 && values.first.is_a?(Array)
+        raise ArgumentError, 'Array#only!() expects values as list of arguments,' \
           ' not an Array as first argument'
       end
-      select! { |k| keys.include?(k) }
+      select! { |k| values.include?(k) }
       self
     end
   end
 
   unless instance_methods(false).include?(:except)
+    #
+    # Returns an Array with given values excluded, if present
+    #
+    # @param *values [*] list of values
+    # @return [Array] a new Array
+    #
+    # @example
+    #   a = [:a, :b, :c]
+    #   a.except(:a, :b, :d) # => [:c]
+    #
     def except(*keys)
       dup.except!(*keys)
     end
 
+    # Modifies the Array excluding given values, if present
+    #
+    # @param *values [*] list of values
+    # @return [Array] self
+    #
+    # @example
+    #   a = [:a, :b, :c]
+    #   a.except!(:a, :b, :d)
+    #   a # => [:c]
+    #
     def except!(*keys)
       if keys.size == 1 && keys.first.is_a?(Array)
         raise ArgumentError, 'Array#except!() expects keys as list of arguments,' \
@@ -133,6 +288,11 @@ class Array
   end
 
   unless instance_methods(false).include?(:deep_dup)
+    #
+    # Duplicates an Array with all nested values
+    #
+    # @return [Hash] a new Hash
+    #
     def deep_dup
       map do |v|
         v.respond_to?(:deep_dup) ? v.deep_dup : v.dup

data/lib/mimi/core/struct.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Mimi
+  module Core
+    #
+    # Mimi::Core::Struct is a simple immutable data structure.
+    #
+    # It allows instantiating an object from a set of attributes and makes them
+    # available as object methods and Hash paramaters:
+    #   my_object = Mimi::Core::Struct.new(a: 1, b: 2)
+    #
+    #   my_object.a    # => 1
+    #   my_object[:a]  # => 1
+    #   my_object['a'] # => 1
+    #
+    # It only allows access to defined attributes:
+    #   my_object.c    # => NoMethodError
+    #   my_object[:c]  # => NameError
+    #
+    class Struct
+      #
+      # Creates a Struct object from a set of attributes
+      #
+      # @param attrs [Hash]
+      #
+      def initialize(attrs = {})
+        raise ArgumentError, "Hash is expected as attrs" unless attrs.is_a?(Hash)
+        @attributes = attrs.map { |k, v| [k.to_sym, v.dup] }.to_h
+        @attributes.keys.each do |attr_name|
+          define_singleton_method(attr_name) { self[attr_name] }
+        end
+      end
+
+      # Fetches attribute by its name
+      #
+      # @param name [String,Symbol]
+      # @return [Object] attribute's value
+      #
+      def [](attr_name)
+        attr_name = attr_name.to_sym
+        unless @attributes.key?(attr_name)
+          raise NameError, "undefined attribute #{attr_name.inspect}"
+        end
+        @attributes[attr_name]
+      end
+
+      # Returns Struct attributes as a Hash
+      #
+      # @return [Hash]
+      #
+      def to_h
+        @attributes
+      end
+    end # class Struct
+  end # module Core
+end # module Mimi

data/lib/mimi/core/version.rb

@@ -1,5 +1,5 @@
 module Mimi
   module Core
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/lib/mimi/core.rb

@@ -113,3 +113,5 @@ require_relative 'core/core_ext'
 require_relative 'core/inheritable_property'
 require_relative 'core/module'
 require_relative 'core/manifest'
+require_relative 'core/struct'
+

data/mimi-core.gemspec

@@ -27,8 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'hashie', '~> 3.6'
-
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mimi-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +90,7 @@ files:
 - lib/mimi/core/manifest.rb
 - lib/mimi/core/module.rb
 - lib/mimi/core/rake.rb
+- lib/mimi/core/struct.rb
 - lib/mimi/core/version.rb
 - mimi-core.gemspec
 homepage: https://github.com/kukushkin/mimi-core