tektite_ruby_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ced93f4b862080bb3a4cd663847b1edef5d5c187
+  data.tar.gz: 9de3e436c331aaa6f78b47a3fe1461c060df472f
+SHA512:
+  metadata.gz: 4d2b2e35f9018b6681e1675a6de3a6e5cee8426aa9374bb37f4e7f7dfc113f239a27188e46725cdb8bd47a4bac151596aeed0838dbd15328e0615eec8d3beb03
+  data.tar.gz: 3d11e63dcd249bbb0f1804c6cd779da24707c45f29810c86bacf88eb0343049a298dd7b034617325ea812098747c738f2cf74a2d15e14179adb238e6a8b8c2ec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Xavier Bick
+
+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,111 @@
+# Tektite's Ruby Utils
+
+[![Gem Version](https://badge.fury.io/rb/ttektite_ruby_utils.svg)](https://badge.fury.io/rb/tektite_ruby_utils) [![Build Status](https://travis-ci.org/tektite-software/ruby_utils.svg?branch=master)](https://travis-ci.org/tektite-software/ruby_utils) [![Code Climate](https://codeclimate.com/github/tektite-software/ruby_utils/badges/gpa.svg)](https://codeclimate.com/github/tektite-software/ruby_utils) [![Test Coverage](https://codeclimate.com/github/tektite-software/ruby_utils/badges/coverage.svg)](https://codeclimate.com/github/tektite-software/ruby_utils/coverage) [![Inline docs](http://inch-ci.org/github/tektite-software/ruby_utils.svg?branch=master)](http://inch-ci.org/github/tektite-software/ruby_utils)
+
+
+
+This gem contains a number of utilities, extensions, and helpers for Ruby to make developing applications easier and to enable better security and integration with other services.  Enjoy!  Suggestions are most welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tektite_ruby_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tektite_ruby_utils
+
+## Usage
+
+Below is a list of everything this gem includes.
+
+### PresentClass and `present`
+
+`PresentClass` adds a new class and related helpers designed to be the opposite of `NilClass`, and includes `present` in the global namespace as the opposite of `nil`.  It is used to represent that a value is __not nil__ without exposing the value itself.  Unlike simple using `!nil?`, PresentClass returns an object that can be configured to carry variable amounts of data about the value behind it, such as the object's type and class.  `PRESENT` is also included as a constant, which is a frozen instance of PresentClass that `present` returns.
+
+Furthermore, the extensions includes several helpers for working with any object, Hashes, and Arrays.
+
+This is extremely useful if for example you would like to pass information about whether certain data _exists_ to a method without telling the method what the actual values of that data are.
+
+For any object, you can use the `present?` method:
+
+    class MyObject
+      attr_accessor :my_value
+      ...
+    end
+
+    my_object = MyObject.new my_value: "test"
+
+    my_object.my_value.present?
+    # => true
+
+    nil.present?
+    # => false
+
+    present.present?
+    # => true
+
+    present.nil?
+    # => false
+
+    nil
+    # => nil
+
+    present
+    # => present
+
+For Arrays and Hashes, the `all_present?`, `each_present?`, and `mask_present` helper methods are available:
+
+    array = [1, 2, nil]
+    array.all_present?
+    # => false
+    array.each_present?
+    # => [true, true, false]
+    array.mask_present
+    # => [present, present, nil]
+
+    hash = {one: 1, two: 2, three: 3}
+    hash.all_present?
+    # => true
+    hash.each_present?
+    # => {one: true, two: true, three: true}
+    hash.mask_present
+    # => {one: present, two: present, three: present}
+
+If you would like to return an instance of PresentClass that includes the type of the original value, just create a new instance of PresentClass directly specifying the `:type` attribute as a Class.  For all other users, simply set a variable to `present` as if you were using `nil`.  As a helper for this, the `present_with_type` method is available:
+
+    test_array = [1, 'two', :three]
+    test_array.each do |e|
+      puts e.present_with_type.type
+      puts "\n"
+    end
+
+    # => Fixnum
+    # => String
+    # => Symbol
+
+## Documentation
+
+Documentation for this gem can be found here: http://www.rubydoc.info/github/tektite-software/ruby_utils/
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tektite-software/ruby_utils.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tektite_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/tektite_ruby_utils.rb

@@ -0,0 +1,6 @@
+require 'tektite_ruby_utils/version'
+require 'tektite_ruby_utils/present'
+
+# module TektiteRubyUtils
+#   # Your code goes here...
+# end

data/lib/tektite_ruby_utils/present.rb

@@ -0,0 +1,142 @@
+# PresentClass should behave just as NilClass, but the opposite.  It represents
+# that a value exists but does not represent any specific vallue or type; it
+# is ambiguous.  present should be seen as the opposite of nil.
+class PresentClass
+  attr_reader :type
+
+  # +type+ should be either nil (for ambiguous) or
+  # the class of the object represented.
+  def initialize(type = nil)
+    @type = type
+  end
+
+  # Makes present appear and behave like nil in the console.  To see the
+  # object id, use +.object_id+.  To see the value of an attribute
+  # such as +@type+, use the attribute getter method, such as .type.
+  def inspect
+    'present'
+  end
+
+  # To avoid confusing the present Object with the value of the
+  # object represented, attempting to convert the present Object
+  # to any other type raises an error.
+
+  # present can not be converted to an Integer.
+  def to_i
+    raise AmbiguousValueError
+  end
+
+  # present can not be converted to an Array.
+  def to_a
+    raise AmbiguousValueError
+  end
+
+  # present can not be converted to a String.
+  def to_s
+    raise AmbiguousValueError
+  end
+
+  # Return true if the object type is defined.
+  def type_known?
+    @type.nil? ? false : true
+  end
+end
+
+# Error class communicating that because PresentClass is ambiguous, it should
+# not be converted to other data types to avoid confusion between `present`
+# and the actual value represented.
+class AmbiguousValueError < StandardError
+  def initialize(msg = 'Value exists, but is unspecified, unknown, or secret.')
+    super
+  end
+end
+
+# Add some methods concerning present and PresentClass
+# to all objects by extending Object.
+class Object
+  # Allow .present? method on all objects
+  def present?
+    !nil?
+  end
+
+  # Return a new PresentClass object with @type defined
+  # as the type of the object.
+  def present_with_type
+    PresentClass.new(self.class)
+  end
+
+  # Aliases :present_with_class to :present_with_type
+  alias present_with_class present_with_type
+end
+
+# Extend Array with some helper methods.
+class Array
+  # Returns true if all elements are present, false if one is nil
+  def all_present?
+    each do |e|
+      return false if e.nil?
+    end
+    true
+  end
+
+  # Returns an array with a boolean representing each element's presence
+  def each_present?
+    result = []
+    each_with_index do |e, i|
+      result[i] = if e.nil?
+                    false
+                  else
+                    true
+                  end
+    end
+    result
+  end
+
+  # Replaces non-nil elements with present
+  def mask_present
+    result = []
+    each_with_index do |e, i|
+      result[i] = (present if e.present?)
+    end
+    result
+  end
+end
+
+# Extend Hash with some helper methods.
+class Hash
+  # Returns true if all values are present, otherwise false
+  def all_present?
+    each do |_key, value|
+      return false if value.nil?
+    end
+    true
+  end
+
+  # Returns a hash with the values of the original hash replaced with
+  # true if the value is present and false if nil.
+  def each_present?
+    result = {}
+    each do |key, value|
+      result[key] = value.present?
+    end
+    result
+  end
+
+  # Returns a hash with non-nil values of the original hash
+  # replaced with present.
+  def mask_present
+    result = {}
+    each do |key, value|
+      result[key] = value.present? ? present : nil
+    end
+    result
+  end
+end
+
+# Initializes a new constant with a frozen instance of PresentClass.
+PRESENT = PresentClass.new.freeze
+
+# +present+ returns PRESENT constant.
+def present
+  PRESENT
+end

data/lib/tektite_ruby_utils/version.rb

@@ -0,0 +1,3 @@
+module TektiteRubyUtils
+  VERSION = '0.1.0'.freeze
+end

data/tektite_ruby_utils.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tektite_ruby_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tektite_ruby_utils'
+  spec.version       = TektiteRubyUtils::VERSION
+  spec.authors       = ['Tektite Software', 'Xavier Bick']
+  spec.email         = ['fxb9500@gmail.com']
+
+  spec.summary       = 'Extensions and utilities for Ruby'
+  spec.description   = 'Adds additional functionality to Ruby,
+                       such as PresentClass (opposite of NilClass).'
+  spec.homepage      = 'https://github.com/tektite-software/ruby_utils'
+  spec.license       = 'MIT'
+
+  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 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: tektite_ruby_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tektite Software
+- Xavier Bick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-05 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  Adds additional functionality to Ruby,
+                         such as PresentClass (opposite of NilClass).
+email:
+- fxb9500@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tektite_ruby_utils.rb
+- lib/tektite_ruby_utils/present.rb
+- lib/tektite_ruby_utils/version.rb
+- tektite_ruby_utils.gemspec
+homepage: https://github.com/tektite-software/ruby_utils
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Extensions and utilities for Ruby
+test_files: []
+has_rdoc: