ruby_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d43510375fc15c6420ccfadbfebba96d7e0727a
+  data.tar.gz: c7065fb2cb96f74f6101ee62d75b6c1414e6c882
+SHA512:
+  metadata.gz: 63c5a576af4dbc6b3ce10b9103d03993e23dbe8989ae357b0c8f2f51714cd1f594e9462f86af4d2c4875a3d986206989c04227888799dfcd0b28ee2ae51b1578
+  data.tar.gz: 44ff4f5a46fdce4b0ec0819e1351456e1665fc696220116b915dbe3c7656a0176071e71d50e9218b71ea5d5c7b3c86826b407c824b3108b7492531f8cddf8bce

data/.gitignore

@@ -0,0 +1,59 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Laertis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# ruby-utils
+
+Various ruby core extensions and class utilities.
+
+## Status
+TBD
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-utils'
+```
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install hanami-utils
+
+## Usage
+TBD
+
+
+## Features
+
+### Ruby::Utils::Param
+
+### Ruby::Utils::Hash

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruby_utils.rb

@@ -0,0 +1,13 @@
+require "ruby_utils/version"
+require 'ruby_utils/param'
+require 'ruby_utils/core_ext/hash'
+
+module Ruby
+  module Utils
+
+    module_function
+    def Param(original = {})
+      Param.new(original || {})
+    end
+  end
+end

data/lib/ruby_utils/core_ext/hash.rb

@@ -0,0 +1,25 @@
+class Hash
+  def deep_fetch *args, &block
+    raise ArgumentError.new("wrong number of arguments (0 for 1..n)") if args.empty?
+
+    value = fetch(args.shift, &block)
+    if args.size > 0
+      if value.kind_of?(Hash)
+        value.deep_fetch(*args, &block)
+      elsif value.kind_of?(Array)
+        value = value[args.shift]
+        if args.size > 0
+          value.deep_fetch(*args, &block)
+        else
+          value
+        end
+      else
+        {}.fetch(args.shift, &block)
+      end
+    else
+      value
+    end
+  end
+end
+
+

data/lib/ruby_utils/param.rb

@@ -0,0 +1,216 @@
+module Ruby::Utils
+  class Param
+    def initialize(hash = {})
+      @original_hash = hash
+
+      define_methods(@original_hash)
+    end
+
+    def define_methods(h)
+      h.each do |k, v|
+        h.define_singleton_method(k) do
+          v
+        end
+
+        define_methods(v) if v.is_a?(Hash)
+      end
+    end
+
+    def respond_to?(name)
+      if @original_hash.respond_to?(name)
+        true
+      else
+        super
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      if @original_hash.respond_to?(name)
+        @original_hash.send(name)
+      else
+        super
+      end
+    end
+
+    # Returns the value of the hash given a delimited key
+    # If not key is found an error is raised
+    #
+    # @param[String] key A delimited string key to find the value of the hash
+    #
+    # @return [Object, Exception] Exception if no key is found or else the value
+    #
+    # => params.get(".poll.user.profile.email")
+    #
+    def get(key)
+      methods = key.scan(/[\w'-]+/)
+      _get(methods, self)
+    end
+
+    def _get(methods, obj)
+      current = methods.shift
+      res = obj.send(current)
+
+      return res if methods.empty?
+      _get(methods, res)
+    end
+    private :_get
+
+    # Get a value from hash. If it's not set, return default value. If default value 
+    # is not provided, return nil. Never throw exception.
+    #
+    # ex:
+    # params.getOrElse(":user:location:address", "Street address") # => "Betonimiehenkuja 5"
+    # params.getOrElse(":user:location:zipcode", "00000")          # => "00000"
+    # params.getOrElse(":user:location:zipcode", params.getOrElse(":user:location:address", "N/A")) # => "Betonimiehenkuja 5"
+    #
+    # TODO Add more args for fallbacks:
+    #
+    # getOrElse(locator, [fallback_locator_1, ... , fallback_locator_n], default)]
+    # params.getOrElse(":user:location:zipcode", ":user:location:address", "N/A") # => "Betonimiehenkuja 5"
+    # params.getOrElse(":user:location:zipcode", ":user:location:state", "N/A") # => "N/A"
+    # params.getOrElse(":user:location:zipcode", ":user:location:state", ":user:location:country", "N/A") # => "Finland"
+    #
+    def getOrElse(locator, default=nil)
+      get(locator)
+    rescue NoMethodError
+      default
+    end
+
+    # Get a value from hash and map the value with block.
+    # If value is not set, do nothing.
+    #
+    # =>  mappedParams = params.map(":user:location:city", &:upcase)
+    # =>  mappedParams.get(:city) # => "HELSINKI"
+    def map(key, &block)
+      result = getOrElse(key)
+      block.call(result) if result
+    end
+
+    def map_keys(h, &block)
+      Hash[h.map { |(k, v)| [block.call(k), v] }]
+    end
+
+    def map_values(h, &block)
+      h.inject({}) do |memo, (k, v)|
+        memo[k] = block.call(v)
+        memo
+      end
+    end
+
+    # Select a subset of the hash h using given set of keys.
+    # Only include keys that are present in h.
+    # Usage:
+    #   sub({first: "First", last: "Last", age: 55}, :first, :age, :sex)
+    #   => {first: "First", age: 55}
+    def sub(h, *keys)
+      keys.reduce({}) do |sub_hash, k|
+        sub_hash[k] = h[k] if h.has_key?(k)
+        sub_hash
+      end
+    end
+
+    # Select values by given keys from array of hash
+    # Usage:
+    # pluck([{name: "John", age: 15}, {name: "Joe"}], :name, :age) => ["John", "Joe", 15]
+    def pluck(array_of_hashes, *keys)
+      array_of_hashes.map { |h|
+        keys.map { |key| h[key] }
+      }.flatten.compact
+    end
+
+    # Return true if given subset of fields in both hashes are equal
+    # Usage:
+    #   suq_eq({a: 1, b: 2, c: 3}, {a: 1, b: 2, c: 4}, :a, :b) => true
+    def sub_eq(a, b, *keys)
+      a.slice(*keys) == b.slice(*keys)
+    end
+
+    # deep_contains({a: 1}, {a: 1, b: 2}) => true
+    # deep_contains({a: 2}, {a: 1, b: 2}) => false
+    # deep_contains({a: 1, b: 1}, {a: 1, b: 2}) => false
+    # deep_contains({a: 1, b: 2}, {a: 1, b: 2}) => true
+    def deep_contains(needle, haystack)
+      needle.all? do |key, val|
+        haystack_val = haystack[key]
+        if val.is_a?(Hash) && haystack_val.is_a?(Hash)
+          deep_contains(val, haystack_val)
+        else
+          val == haystack_val
+        end
+      end
+    end
+
+    # wrap_if_present(:wrap, {a: 1}} -> {wrap: {a: 1}}
+    # wrap_if_present(:wrap, {}} -> {}
+    # wrap_if_present(:wrap, nil) -> {}
+    def wrap_if_present(key, value)
+      Maybe(value).map { |v|
+        Hash[key, v]
+      }.or_else({})
+    end
+
+    # { a: b: 1 } -> { :"a.b" => 1 }"}
+    def flatten(h)
+      # use helper lambda 
+      acc = ->(prefix, hash) {
+        hash.inject({}) { |memo, (k, v)|
+          key_s = k.to_s
+          if !k.is_a?(Symbol) || key_s.include?(".")
+            raise ArgumentError.new("Key must be a Symbol and must not contain dot (.). Was: '#{k.to_s}', (#{k.class.name})")
+          end
+          prefixed_key = prefix.nil? ? k : [prefix.to_s, key_s].join(".")
+          if v.is_a? Hash
+            memo.merge(acc.call(prefixed_key, v))
+          else
+            memo.merge(prefixed_key.to_sym => v)
+          end
+        }
+      }
+
+      acc.call(nil, h)
+    end
+
+    # p = Person.new({name: "Foo", email: "foo@example.com"})
+    # object_to_hash(p) => {name: "Foo" , email: "foo@example.com"}
+    def object_to_hash(object)
+      object.instance_variables.inject({}) do |hash, var|
+        hash[var.to_s.delete("@")] = object.instance_variable_get(var)
+        hash
+      end
+    end
+
+    # Return true if the value is set.
+    #
+    # has_address = params.defined?(":user:location:address")
+    # has_address # => true
+    #
+    def defined?(locator)
+      !getOrElse(locator).nil?
+    end
+
+    # Return true if all of the values are set.
+    #
+    # can_show_fullname = params.all?(":user:name:first", ":user:name:last")
+    #
+    def all?(*locators)
+      locators.all? { |locator| getOrElse(locator) }
+    end
+
+    # Run a given block only if value is defined.
+    #
+    # params.with(":user:location:address") { |address| puts "Address: #{address}"} } # => "Address: Betonimiehenkuja 5"
+    # params.with(":user:location:city") { |city| puts "City: #{}"}
+    #
+    def with(key, &block)
+      result = getOrElse(key)
+      yield(result) if result
+    end
+
+    def to_h
+      @original_hash
+    end
+    alias_method :to_hash, :to_h
+    alias_method :as_hash, :to_h
+  end # End Param
+end
+

data/lib/ruby_utils/version.rb

@@ -0,0 +1,5 @@
+module Ruby
+  module Utils
+    VERSION = "0.1.0"
+  end
+end

data/ruby_utils.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_utils"
+  spec.version       = Ruby::Utils::VERSION
+  spec.authors       = ["Laertis Pappas"]
+  spec.email         = ["laertis.pappas@gmail.com"]
+
+  spec.summary       = %q{Ruby core extensions and class utilities}
+  spec.description   = %q{Ruby core extensions and class utilities}
+  spec.homepage      = "https://www.github.com/laertispappas/ruby_utils"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ruby_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laertis Pappas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby core extensions and class utilities
+email:
+- laertis.pappas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_utils.rb
+- lib/ruby_utils/core_ext/hash.rb
+- lib/ruby_utils/param.rb
+- lib/ruby_utils/version.rb
+- ruby_utils.gemspec
+homepage: https://www.github.com/laertispappas/ruby_utils
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby core extensions and class utilities
+test_files: []
+has_rdoc: