utilise 0.4.0.pre.27 → 0.4.0.pre.29

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGM5MTE4M2VhMWJiY2FlMTkyZjE2YjA3MDcwOGM0YjM3MTQ3ZTYyNQ==
+    MTdlZWEzMGYyZmJmMDU0M2I1YzZiOGY2M2Q2MWUyNjEzOTZjYTBkYg==
   data.tar.gz: !binary |-
-    ZWIxZjZjNDUzYWU4YmQwMzQzYjU4NzhiZWY5OGE5ZmMwZDhhMmE4NA==
+    ZWZhZTkzMThkNzZlMzIxMTFkYzcyNzM2YmUwNzMyOTY1NGY2YWU3MQ==
 SHA512:
   metadata.gz: !binary |-
-    MzVjZjgyNzk0MWU3YTgzNzdlNWI0ZjczNjI1ZTExODExYWY1ODAyNjJlNTNm
-    ZTU2YzM4NGFmMzExODJlMmU2Yzg3MzVlMzRkZGI1MDQzYjgxMTkxYTMxZmJj
-    ZjdhY2YyOGM5YzRlM2MyNDJlYTIxZDQ3MjI0NzdhOTgyMmUyZDk=
+    NjNjMmRhZWZlY2I2NmVlNjQ4ZmQzYmEzY2MyNzVhNWJmM2VjNGZkZGNkZDlm
+    ZGEzOTVlYmQ3NDY3YjNjMDEyNTM4ZjYyZjdhYTAzZDliMDEzNDQxODUwMzNk
+    YzAzZWU5ZmZkZTg3NzQwMzdjMzQ0NTkyNWY5ZTYwNWIyZDAwMWU=
   data.tar.gz: !binary |-
-    N2U4NTRmMjdlZDFlNzM5YzJlNDQ2ODFiZTVlYjc5YjllNDlkMjllM2RkZTBm
-    NTRiMTFkMzQ5NTM0YWY3Y2Y1ZjdlODhhNDFlM2U5MThjYzczYWNjYmNjN2Q5
-    MTNjMThkZjkxNDI5YWI3NWY2NGUxMGFjMzJmOTZjZTE0MmYzZWY=
+    YTEzNzM1NjY1NGI4NjYzODUxYjI0Y2QxZTFhYmE4NDRjNWFlNzJkZGMwYTlm
+    NTE4ZTMyMWQzNzMxZmVjOTY2N2VjMGFiZGQyZWNmYjcyMWE5MzU2YTZjODE5
+    Y2I1NWYzNWExOGNiODIwZGFlZTQ1ZjM4ZjNjMmM1NDQwMWQ5N2Y=

data/README.md

@@ -67,15 +67,15 @@ Time.unique
 ```
 
 ```ruby
-true.is_bool?
+true.bool?
 => true
 
-false.is_bool?
+false.bool?
 => true
 
-1.is_bool?
+1.bool?
 => false
 
-"true".is_bool?
+"true".bool?
 => false
-```
+```

data/lib/utilise/augment/bool.rb

@@ -1,12 +1,12 @@
 module Utilise
   module Augment
+    # Extends classes that could be treated as a boolean
     module Bool
-
       # Returns bool based on object passed
       #
       # @param object [Object] the object
       # @return [Object] returns object boolean
-      def to_bool object = self
+      def to_bool(object = self)
         case object
         when String, Fixnum, Symbol
           bool_it object
@@ -21,10 +21,10 @@ module Utilise
       # value to a boolean if it matches rules
       #
       # @param hash [Hash] the hash
-      def bool_hash hash
-        hash.each do |k,v|
-          val = to_bool(hash[k])
-          hash[k] = val unless val.nil?
+      def bool_hash(hash)
+        hash.each do |key, val|
+          val = to_bool(val)
+          hash[key] = val unless val.nil?
         end
       end
 
@@ -32,10 +32,10 @@ module Utilise
       # element to a boolean if it matches rules
       #
       # @param array [Array] the array
-      def bool_array array
-        array.each_index do |i|
-          val = to_bool(array[i])
-          array[i] = val unless val.nil?
+      def bool_array(array)
+        array.each_index do |index|
+          val = to_bool(array[index])
+          array[index] = val unless val.nil?
         end
       end
 
@@ -43,7 +43,7 @@ module Utilise
       #
       # @param array [Array] the array
       # @returns [Boolean] true/false returned
-      def bool_it object
+      def bool_it(object)
         case object.to_s
         when /^true$/i, /^yes$/i, /^t$/i, /^1$/i
           true

data/lib/utilise/augment/matchers.rb

@@ -1,9 +1,13 @@
 module Utilise
   module Augment
+    # Extends classes that could be queried as a boolean
     module Matchers
-      def is_bool?
+      def bool?
         self.is_a?(TrueClass) || self.is_a?(FalseClass)
       end
+
+      # NOTE: This keeps backwards compatability
+      alias_method :is_bool?, :bool?
     end
   end
 end

data/lib/utilise/augment/time.rb

@@ -1,8 +1,9 @@
 module Utilise
   module Augment
+    # Extends time class to return a unique idetifier
     module Time
       def unique
-        self.now.strftime("%s%3N")[-8..-1]
+        now.strftime('%s%3N')[-8..-1]
       end
     end
   end

data/lib/utilise/augment.rb

@@ -2,30 +2,37 @@ require 'utilise/augment/bool.rb'
 require 'utilise/augment/matchers.rb'
 require 'utilise/augment/time.rb'
 
+# Extend existing ruby class String
 class String
   include Utilise::Augment::Bool
 end
 
+# Extend existing ruby class Fixnum
 class Fixnum
   include Utilise::Augment::Bool
 end
 
+# Extend existing ruby class Symbol
 class Symbol
   include Utilise::Augment::Bool
 end
 
+# Extend existing ruby class Object
 class Object
   include Utilise::Augment::Matchers
 end
 
+# Extend existing ruby class Time
 class Time
   extend Utilise::Augment::Time
 end
 
+# Extend existing ruby class Hash
 class Hash
   include Utilise::Augment::Bool
 end
 
+# Extend existing ruby class Array
 class Array
   include Utilise::Augment::Bool
 end

data/lib/utilise/version.rb

@@ -1,4 +1,5 @@
+# Utilise
 module Utilise
-  VERSION = "0.4.0".freeze
-  DATE = "2014-07-04".freeze
+  VERSION = '0.4.0'.freeze
+  DATE = '2014-07-04'.freeze
 end

data/spec/augment/object_spec.rb

@@ -1,27 +1,27 @@
 require 'helper'
 
 describe TrueClass do
-  describe "#is_bool?" do
+  describe "#bool?" do
     it "returns true when matching" do
-      expect(true.is_bool?).to be true
+      expect(true.bool?).to be true
     end
   end
 end
 
 describe FalseClass do
-  describe "#is_bool?" do
+  describe "#bool?" do
     it "returns true when matching" do
-      expect(false.is_bool?).to be true
+      expect(false.bool?).to be true
     end
   end
 end
 
 describe Object do
-  describe "#is_bool?" do
+  describe "#bool?" do
     it "returns false when not matching" do
-      expect("true".is_bool?).to be false
-      expect(0.is_bool?).to be false
-      expect(:false.is_bool?).to be false
+      expect("true".bool?).to be false
+      expect(0.bool?).to be false
+      expect(:false.bool?).to be false
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utilise
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre.27
+  version: 0.4.0.pre.29
 platform: ruby
 authors:
 - Ben Slaughter
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
 description: ! 'Extends a few ruby classes with helpful tools, currently: X.to_bool'
 email: b.p.slaughter@gmail.com
 executables: []
@@ -113,11 +113,11 @@ signing_key:
 specification_version: 4
 summary: Utilises a few extra tools
 test_files:
-- spec/augment/object_spec.rb
 - spec/augment/string_spec.rb
-- spec/augment/symbol_spec.rb
 - spec/augment/time_spec.rb
-- spec/augment/hash_spec.rb
+- spec/augment/symbol_spec.rb
 - spec/augment/array_spec.rb
+- spec/augment/hash_spec.rb
 - spec/augment/fixnum_spec.rb
+- spec/augment/object_spec.rb
 - spec/helper.rb