finishing_moves 0.1.1

data/Vagrantfile

@@ -0,0 +1,44 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+NAME = "finishing-moves"
+FQDN = "#{NAME}.example.com"
+
+Vagrant.configure("2") do |config|
+  # "trusty" is 14.04
+  config.vm.box       = "trusty32"
+  config.vm.box_url   = "https://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-i386-vagrant-disk1.box"
+
+  config.vm.provider :virtualbox do |vb|
+    vb.customize ["modifyvm", :id,
+      # Basics.
+      "--name",       NAME,
+      "--memory",     4096,
+      # I/O APIC must be enabled to support a multi-core guest.
+      "--cpus",       4,
+      "--ioapic",     "on",
+      # Enable native host virtualization features (yields better performance).
+      "--pae",        "on",
+      "--hwvirtex",   "on",
+      "--largepages", "on",
+      "--vtxvpid",    "on",
+      # This causes the virtual machine to proxy DNS requests through the host
+      # via NAT. Without this, the default resolver on the guest will introduce
+      # a 5 second latency on every HTTP request... which is a real downer.
+      "--natdnshostresolver1", "on"
+    ]
+  end
+
+  config.vm.hostname = FQDN
+  config.vm.provision :shell, path: "provision.sh"
+end
+
+#
+# DONT FORGET!
+#
+# Force update VirtualBox Guest Additions
+# Run the following command inside same directory as Vagrantfile
+# Must be done once on your dev system
+#
+#   vagrant plugin install vagrant-vbguest
+#

data/finishing_moves.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "finishing_moves/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = "finishing_moves"
+  s.version     = FinishingMoves::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Frank Koehl", "Chris Tonkinson"]
+  s.email       = ["frank@forgecrafted.com", "chris@forgecrafted.com"]
+  s.summary     = %q{Small, focused, incredibly useful methods added to core Ruby classes.}
+  s.description = <<-EOF
+    Ruby includes a huge amount of default awesomeness that tackles most common development challenges. But every now and then, you find yourself in a situation where an elaborate-yet-precise coding maneuver wins the day. Finishing Moves is a collection of methods designed to assist in those just-typical-enough-to-be-annoying scenarios.
+
+    In gamer terms, if standard Ruby methods are your default actions, finishing_moves would be mana-consuming techniques. Your cooldown spells. Your grenades (there's never enough grenades). In the right situation, they kick serious cyclomatic butt.
+  EOF
+  s.homepage    = "https://github.com/forgecrafted/finishing_moves"
+  s.license     = "MIT"
+
+  s.files       = `git ls-files -z`.split("\x0")
+  s.test_files  = Dir["spec/**/*"]
+
+  s.add_development_dependency 'rb-readline', '>= 0'
+  s.add_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'priscilla', '>= 0'
+  s.add_development_dependency 'pry-byebug', '>= 0'
+  s.add_development_dependency 'fuubar', '>= 0'
+
+  s.required_ruby_version = '>= 2.0'
+end

data/lib/finishing_moves.rb

@@ -0,0 +1,7 @@
+module FinishingMoves
+
+  Dir[File.dirname(__FILE__) + '/finishing_moves/*.rb'].each do |file|
+    require file
+  end
+
+end

data/lib/finishing_moves/fixnum.rb

@@ -0,0 +1,23 @@
+class Fixnum
+  def length
+    Math.log10(self.abs).to_i + 1
+  end
+end
+
+class Bignum
+  def length
+    Math.log10(self.abs).to_i + 1
+  end
+end
+
+class Float
+  def length
+    raise ArgumentError.new("Cannot get length: \"#{self}\" is not an integer")
+  end
+end
+
+class BigDecimal
+  def length
+    raise ArgumentError.new("Cannot get length: \"#{self}\" is not an integer")
+  end
+end

data/lib/finishing_moves/hash.rb

@@ -0,0 +1,27 @@
+class Hash
+
+  # When deleting a value from a hash, return the remaining hash, instead of the deleted value
+  def delete!(key)
+    self.delete(key)
+    return self
+  end
+
+  # Delete all records according to the keys passed in as an array, and return a hash of deleted
+  # entries. Silently ignores any keys which are not found.
+  def delete_each(*hash_keys)
+    deleted_entries = {}
+    hash_keys.each do |hash_key|
+      value = self.delete(hash_key)
+      deleted_entries[hash_key] = value unless value.nil?
+    end
+    return deleted_entries unless deleted_entries.empty?
+    nil
+  end
+
+  # Delete all records according to the keys passed in as array, and return the remaining hash.
+  def delete_each!(*keys)
+    self.delete_each(*keys)
+    return self
+  end
+
+end

data/lib/finishing_moves/object.rb

@@ -0,0 +1,42 @@
+class Object
+
+  def nil_chain(ret_val = nil, &block)
+    begin
+      result = yield
+      return ret_val if result.nil?
+      result
+    rescue NoMethodError
+    rescue NameError
+      return ret_val
+    end
+  end
+  alias_method :chain, :nil_chain
+  alias_method :method_chain, :nil_chain
+
+  def bool_chain(&block)
+    result = nil_chain(&block)
+    return false if result.nil?
+    result
+  end
+
+  def class_exists?(class_name)
+    klass = Module.const_get(class_name.to_s)
+    return klass.is_a?(Class)
+  rescue NameError
+    return false
+  end
+
+  def not_nil?
+    !self.nil?
+  end
+
+  def same_as(compare)
+    if compare.respond_to? :to_s
+      self.to_s == compare.to_s
+    else
+      raise ArgumentError.new("Cannot compare \"#{self.class.name}\" to \"#{compare.class.name}\", no string conversion")
+    end
+  end
+
+
+end

data/lib/finishing_moves/to_bool.rb

@@ -0,0 +1,33 @@
+class String
+  def to_bool
+    return true if self == true || self =~ (/^(1|t(rue)?|y(es)?|on)$/i)
+    return false if self == false || self == "" || self =~ /\A[[:space:]]*\z/ || self =~ (/^(0|f(alse)?|no?|off)$/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+end
+
+class Fixnum
+  def to_bool
+    return true if self == 1
+    return false if self == 0
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+end
+
+class TrueClass
+  def to_bool; self; end
+  def to_i; 1; end
+  def to_sym; :true; end
+end
+
+class FalseClass
+  def to_bool; self; end
+  def to_i; 0; end
+  def to_sym; :false; end
+end
+
+class NilClass
+  def to_bool; false; end
+  def to_i; 0; end
+  def to_sym; :nil; end
+end

data/lib/finishing_moves/version.rb

@@ -0,0 +1,3 @@
+module FinishingMoves
+  VERSION = "0.1.1"
+end

data/provision.sh

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# Shell user settings.
+USER_NAME=vagrant
+USER_HOME=/home/$USER_NAME
+DEFAULT_RUBY='2.1.5'
+
+###############################################################################
+# Functions
+###############################################################################
+# Most of the time we can get by with this DRY wrapper for sudo commands.
+as_user() {
+  echo "$USER_NAME:~$ > ${*}"
+  su -l $USER_NAME -c "$*"
+}
+
+# Install the requested version of Ruby, with Bundler.
+install_ruby() {
+  as_user "rbenv install -s $1"
+  as_user "RBENV_VERSION=$1 gem install bundler"
+  as_user "rbenv rehash"
+}
+
+###############################################################################
+# Base System
+###############################################################################
+apt-get -y update
+apt-get -yfV dist-upgrade
+
+###############################################################################
+# rbenv & ruby-build, and Rubies
+# From https://github.com/sstephenson/rbenv
+# and https://github.com/sstephenson/ruby-build
+###############################################################################
+
+# Install dependencies.
+apt-get install -yfV         \
+  build-essential            \
+  curl                       \
+  git-core                   \
+  libcurl4-openssl-dev       \
+  libreadline-dev            \
+  libsqlite3-dev             \
+  libssl-dev                 \
+  libxml2-dev                \
+  libxslt1-dev               \
+  libyaml-dev                \
+  python-software-properties \
+  sqlite3                    \
+  wget                       \
+  zlib1g-dev                 \
+
+# Install rbenv and ruby-build.
+as_user "git clone https://github.com/sstephenson/rbenv.git $USER_HOME/.rbenv"
+as_user "git clone https://github.com/sstephenson/ruby-build.git $USER_HOME/.rbenv/plugins/ruby-build"
+
+# Setup bash to use rbenv for $USER_NAME.
+echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> $USER_HOME/.bashrc
+echo 'eval "$(rbenv init -)"'               >> $USER_HOME/.bashrc
+echo 'cd /vagrant'                          >> $USER_HOME/.bashrc
+echo 'gem: --no-document'                   >> $USER_HOME/.gemrc
+
+# Install Ruby for $USER_NAME.
+install_ruby $DEFAULT_RUBY
+echo $DEFAULT_RUBY > $USER_HOME/.ruby-version
+
+###############################################################################
+# EDIT HERE!
+# Install any Rubies (other than $DEFAULT_RUBY) required for individual apps.
+###############################################################################
+# e.g. `install_ruby 2.1.4`

data/spec/fixnum_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe "Count number length" do
+
+  it "Fixnum#length" do
+    expect(1.length).to eq 1
+    expect(5.length).to eq 1
+    expect(9.length).to eq 1
+    expect(90.length).to eq 2
+    expect(900.length).to eq 3
+    expect(9000.length).to eq 4
+    expect(-9000.length).to eq 4
+  end
+
+  it "Bignum#length" do
+    expect(12356469787881584554556.length).to eq 23
+    expect(-12356469787881584554556.length).to eq 23
+  end
+
+  it "Float#length" do
+    expect{ 0.0.length }.to raise_error(ArgumentError)
+    expect{ 1.0.length }.to raise_error(ArgumentError)
+    expect{ -1.0.length }.to raise_error(ArgumentError)
+    expect{ 3.14.length }.to raise_error(ArgumentError)
+    expect{ 12356469.987.length }.to raise_error(ArgumentError)
+  end
+
+  it "BigDecimal#length" do
+    expect{ 1265437718438866624512.123.length }.to raise_error(ArgumentError)
+    expect{ -1265437718438866624512.123.length }.to raise_error(ArgumentError)
+    expect{ 0.9999999999999062.length }.to raise_error(ArgumentError)
+    expect{ -0.9999999999999062.length }.to raise_error(ArgumentError)
+  end
+
+end

data/spec/hash_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Hash do
+
+  let :test_hash do
+    { :foo => :bar, :baz => :bin, :flo => :bie }
+  end
+
+  it "#delete!" do
+    expect(test_hash.delete!(:bogus)).to eq({ :foo => :bar, :baz => :bin, :flo => :bie })
+    expect(test_hash.delete!(:baz)).to eq({ :foo => :bar, :flo => :bie })
+  end
+
+  it "#delete_each" do
+    expect(test_hash.delete_each(:bogus, :bar)).to eq nil
+    expect(test_hash).to eq({ :foo => :bar, :baz => :bin, :flo => :bie })
+    expect(test_hash.delete_each(:flo)).to eq({ :flo => :bie })
+    expect(test_hash).to eq({ :foo => :bar, :baz => :bin })
+    expect(test_hash.delete_each(:foo, :baz, :bogus)).to eq({ :foo => :bar, :baz => :bin })
+    expect(test_hash).to eq({ })
+  end
+
+  it "#delete_each!" do
+    expect(test_hash.delete_each!(:bogus, :bar)).to eq({ :foo => :bar, :baz => :bin, :flo => :bie })
+    expect(test_hash.delete_each!(:flo)).to eq({ :foo => :bar, :baz => :bin })
+    expect(test_hash.delete_each!(:bogus, :flo, :foo)).to eq({ :baz => :bin })
+    expect(test_hash.delete_each!(:baz)).to eq({ })
+  end
+
+end

data/spec/object_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Object do
+
+  it "#nil_chain" do
+    expect(nil_chain{bogus_variable}).to eq nil
+    expect(nil_chain{bogus_hash[:foo]}).to eq nil
+    params = { :foo => 'bar' }
+    expect(nil_chain{ params[:bogus_key] }).to eq nil
+    expect(nil_chain{ params[:foo] }).to eq 'bar'
+    var = 'a simple string'
+    expect(nil_chain{ var.transmogrify }).to eq nil
+
+    c = C.new
+    b = B.new c
+    a = A.new b
+    expect(a.b.c.hello).to eq "Hello, world!"
+    b.c = nil
+    expect(method_chain{a.b.c.hello}).to eq nil
+    a = nil
+    expect(method_chain{a.b.c.hello}).to eq nil
+
+    expect( chain(true) { bogus_variable } ).to equal true
+    expect( chain(false) { bogus_variable } ).to equal false
+    expect( chain('gotcha!') { bogus_variable } ).to eq 'gotcha!'
+    expect( chain('gotcha!') { params[:bogus_key] } ).to eq 'gotcha!'
+    expect( chain('gotcha!') { params[:foo] } ).to eq 'bar'
+  end
+
+  it "#bool_chain" do
+    expect(bool_chain{bogus_variable}).to equal false
+    var = true
+    expect(bool_chain{var}).to equal true
+    var = 'foo'
+    expect(bool_chain{var}).to eq 'foo'
+    result = bool_chain{ var.transmogrify }
+    expect(result).to equal false
+  end
+
+  it "#class_exists?" do
+    expect(class_exists? :Symbol).to eq true
+    expect(class_exists? :Symbology).to eq false
+    expect(class_exists? 'Symbol').to eq true
+    expect(class_exists? 'Symbology').to eq false
+    expect(class_exists? :Array).to eq true
+    expect(class_exists? :aRRay).to eq false
+    expect(class_exists? :ARRAY).to eq false
+  end
+
+  it "#not_nil?" do
+    var = nil
+    expect(var.not_nil?).to eq false
+    var = 'foobar'
+    expect(var.not_nil?).to eq true
+  end
+
+  it "#same_as" do
+    expect(:symbol.same_as 'symbol').to eq true
+    expect('symbol'.same_as :symbol).to eq true
+    expect('1'.same_as 1).to eq true
+    expect(2.same_as '2').to eq true
+    expect(3.same_as 3).to eq true
+    expect(:symbol.same_as :SYMBOL).to eq false
+
+    user = User.new
+    expect(:faceless_one.same_as(user)).to eq true
+    expect(user.same_as(:faceless_one)).to eq true
+    expect(user.same_as(:FACELESS_ONE)).to eq false
+  end
+
+end
+
+# test classes
+
+class A
+  attr_accessor :b
+  def initialize(b)
+    @b = b
+  end
+end
+
+class B
+  attr_accessor :c
+  def initialize(c)
+    @c = c
+  end
+end
+
+class C
+  def hello
+    "Hello, world!"
+  end
+end
+
+class User
+  attr_writer :handle
+
+  def handle
+    @handle || "faceless_one"
+  end
+
+  def to_s
+    handle.to_s
+  end
+end