corelib_ruby 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17b35aeb6e7fb200ffb535774468dac2d75de25f
-  data.tar.gz: 30448514a1027a1a1dcf8ed22493ce94eb2155ac
+  metadata.gz: e0e4a94e270cbb3cd956a2840be595c28a3739ad
+  data.tar.gz: 9802767a50bbee6e96ec08ed9933e59b6bec4434
 SHA512:
-  metadata.gz: 7eb5262369b395a7d9957efc9bbc54c7c4ce1b1a8b04d12dfe383d9ec969af3ceb12b72451e24cc7580f74a7c091c25452b519bbd3b2840f783d86b49865c434
-  data.tar.gz: 8dc812fae83941b43fe73ffe279e82c5195059eecb46cf689064b0f6fb9f8b390e3044b35a6bb888e8ebc0ba5b83570b76395017f5d99eee7922b815b61c2c53
+  metadata.gz: 3c541ffa32cc75af1bb4217b9288f098ae19ea10d41cd2cd57d421fb0c84aee38bbcf22dd32d6127dbcce230e138be5750bad4a25ed1e6f95741ddefddb8de94
+  data.tar.gz: 32df6e615eb9dd90002efd77376b69d0838b7cf0f10a61a8d72d37fbee52f65e19959f4edf08a847999bae5533a591c5bd134ba617b6a27be8e4384c3598bf8e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 1.0.0 (May 09, 2016)
+
+1. (Change) Change method prefix to `cl_`.  This is a major breaking change.
+2. (New) Add optional method alias `_`.
+3. (New) Add many new methods.
+4. (New) Fill out test suite on methods.
+
 ## 0.0.2 (May 06, 2016)
 
 1. (New) Add **Array** methods: `#co_delete!`

data/README.md

@@ -33,9 +33,13 @@ Or install it yourself as:
 
 Browse the `/lib/corelib_ruby/` directory to find new methods; each method provides extensive document.  All of these methods are now available inside your application without any additional configuration.
 
+## Finding Methods
+
+To find methods, read through the `lib/corelib_ruby/core_ext` folder.
+
 ## Conventions
 
-All methods are prefixed with `co_` to help prevent collisions with other libraries.
+All methods are prefixed with `cl_` to help prevent collisions with other libraries and to make it clear that the method is not part of Ruby core.  The unfortunate downside is it dirties up the up the method name.  To help clean things up, all methods have a more simple alias of just `_`.  For example, `String#cl_all_spaces?` is aliased to `String#_all_spaces?`.  Use whichever strategy you like, but we recommend that you pick one and try to be consistent.
 
 ## Development
 

data/lib/corelib_ruby/core_ext/array/base.rb

@@ -1 +1,3 @@
+require "corelib_ruby/core_ext/array/core"
 require "corelib_ruby/core_ext/array/delete"
+require "corelib_ruby/core_ext/array/iterators"

data/lib/corelib_ruby/core_ext/array/core.rb

@@ -0,0 +1,17 @@
+class Array
+  # Many methods take an optional hash argument to hold options for the method.  This method pops that hash off he arguments
+  # list if it exists or returns an empty hash.
+  def cl_extract_options!
+    last.is_a?(Hash) ? pop : {}
+  end
+
+  # A simple helper to improve readability.
+  # [].cl_not_empty?    reads better than    ![].empty?
+  def cl_not_empty?
+    !empty?
+  end
+
+  def cl_to_yes_no(options={})
+    collect {|e| e.cl_to_yes_no(options)}
+  end
+end

data/lib/corelib_ruby/core_ext/array/delete.rb

@@ -1,9 +1,8 @@
 class Array
-  # Public: Deletes items from the array, but raises an error if the item
-  # does not exist.
+  # Deletes items from the array, but raises an error if the item does not exist.
   #
   # obj: the obj to delete
-  def co_delete!(obj)
+  def cl_delete!(obj)
     # do this check first only if the obj is nil because the
     # cost of include? rises linerarly with the size of the array
     raise ArgumentError if obj.nil? && !include?(nil)

data/lib/corelib_ruby/core_ext/array/iterators.rb

@@ -0,0 +1,8 @@
+ class Array
+  # Tterates over the Array just as you would with Array#each.  However, for each iteration
+  # pass in an extra variable that will be `false` until the last iteration.
+  def cl_each_with_last_flag
+    my_size = size - 1
+    each_with_index {|item, index| yield(item, index == my_size)}
+  end
+end

data/lib/corelib_ruby/core_ext/boolean/base.rb

@@ -0,0 +1,2 @@
+require "corelib_ruby/core_ext/boolean/false"
+require "corelib_ruby/core_ext/boolean/true"

data/lib/corelib_ruby/core_ext/boolean/false.rb

@@ -0,0 +1,7 @@
+class FalseClass
+  # Convert false to "No".  This method takes the following optional arguments
+  #   if_no: A different string to show other than "No"
+  def cl_to_yes_no(options={})
+    options.fetch(:if_no, "No")
+  end
+end

data/lib/corelib_ruby/core_ext/boolean/true.rb

@@ -0,0 +1,7 @@
+class TrueClass
+  # Convert true to "Yes".  This method takes the following optional arguments
+  #   if_yes: A different string to show other than "Yes"
+  def cl_to_yes_no(options={})
+    options.fetch(:if_yes, "Yes")
+  end
+end

data/lib/corelib_ruby/core_ext/hash/base.rb

@@ -1 +1,3 @@
+require "corelib_ruby/core_ext/hash/core"
 require "corelib_ruby/core_ext/hash/extract"
+require "corelib_ruby/core_ext/hash/iterators"

data/lib/corelib_ruby/core_ext/hash/core.rb

@@ -0,0 +1,7 @@
+class Hash
+  # A simple helper to improve readability.
+  # [].cl_not_empty?    reads better than    ![].empty?
+  def cl_not_empty?
+    !empty?
+  end
+end

data/lib/corelib_ruby/core_ext/hash/extract.rb

@@ -4,20 +4,18 @@ class Hash
   #
   # If key exists in the hash, it's value will be returned.
   # If key doesn't exist, and optional default value will be returned
-  # If key doesn't exist and not default is specified, a KeyError is raised
+  # If key doesn't exist and no default is specified, a KeyError is raised
   # If key doesn't exists, there is no default, but a block is given, then
   # that block will be executed with the key.
-  def co_extract(*args)
+  def cl_extract(*args)
     arg_length = args.length
     fail ArgumentError, "wrong number of arguments #{arg_length} for 1..2" if arg_length == 0 || arg_length > 2
     key = args[0]
 
-    if key?(key)
-      val = self[key]
-      delete(key)
-      return val
-    end
+    # Just return the value if the key exists.
+    return delete(key) if key?(key)
 
+    # The key doesn't exist.  If the user gave us a block, yield to it and return the value from the block.
     return yield key if block_given?
     (args.length == 2) ? args[1] : fail(KeyError, "key not found #{key.inspect}", caller)
   end

data/lib/corelib_ruby/core_ext/hash/iterators.rb

@@ -0,0 +1,12 @@
+class Hash
+  # Tterates over the Array just as you would with Array#each.  However, for each iteration
+  # pass in an extra variable that will be `false` until the last iteration.
+  def cl_each_with_last_flag
+    my_size = size
+    index = 1
+    each_pair do |key, value|
+      yield(key, value, index == my_size)
+      index += 1
+    end
+  end
+end

data/lib/corelib_ruby/core_ext/nil/base.rb

@@ -0,0 +1 @@
+require "corelib_ruby/core_ext/nil/core"

data/lib/corelib_ruby/core_ext/nil/core.rb

@@ -0,0 +1,17 @@
+class NilClass
+  # A simple helper to improve readability.
+  # [].cl_not_nil?    reads better than    ![].nil?
+  def cl_not_nil?
+    false
+  end
+
+  def cl_to_yes_no(options={})
+    options.fetch(:if_nil, "")
+  end
+
+  # See the documenation for String#cl_combine.  This method exists so we can seamlessly call nil.cl_combine("foo") and get back
+  # "foo" (instead of an error).
+  def cl_combine(*args)
+    "".cl_combine(*args)
+  end
+end

data/lib/corelib_ruby/core_ext/numeric/base.rb

@@ -0,0 +1 @@
+require "corelib_ruby/core_ext/numeric/core"

data/lib/corelib_ruby/core_ext/numeric/core.rb

@@ -0,0 +1,5 @@
+class Numeric
+  def cl_to_yes_no(options={})
+    (self == 1 || self == 1.0).cl_to_yes_no(options)
+  end
+end

data/lib/corelib_ruby/core_ext/object/base.rb

@@ -0,0 +1 @@
+require "corelib_ruby/core_ext/object/core"

data/lib/corelib_ruby/core_ext/object/core.rb

@@ -0,0 +1,7 @@
+class Object
+  # A simple helper to improve readability.
+  # [].cl_not_nil?    reads better than    ![].nil?
+  def cl_not_nil?
+    true
+  end
+end

data/lib/corelib_ruby/core_ext/string/base.rb

@@ -1,3 +1,4 @@
-require "corelib_ruby/core_ext/string/accessors"
+require "corelib_ruby/core_ext/string/core"
 require "corelib_ruby/core_ext/string/questions"
 require "corelib_ruby/core_ext/string/conversions"
+require "corelib_ruby/core_ext/string/queries"

data/lib/corelib_ruby/core_ext/string/conversions.rb

@@ -1,6 +1,91 @@
 class String
-  def co_force_leading_space(even_when_empty: false)
+  def cl_to_yes_no(options={})
+    self.cl_to_bool(options).cl_to_yes_no(options)
+  end
+
+  # Forces a string to have at least one leading space.
+  def cl_force_leading_space(even_when_empty: false)
     (return even_when_empty ? " " : "") if empty?
-    co_all_spaces? ? dup : " #{lstrip}"
+    cl_all_spaces? ? dup : " #{lstrip}"
+  end
+
+  # Convert a string to a boolean.
+  # true will always be returned if we can clearly match one of the true cases
+  # In unstrict mode, the string is assumed false if we cannot match true
+  # In strict mode, the string must clearly match a false condition to return false
+  # otherise an error is raised
+  def cl_to_bool(options={})
+    strip = options.fetch(:strip, true)
+    strict = options.fetch(:strict, false)
+    str = strip ? self.strip : self
+    return true if str =~ /\A(true|t|yes|y|1)\Z/i
+
+    if strict
+      return false if str.empty? || str =~ /\A(false|f|no|n|0)\Z/i
+      raise ArgumentError.new("cannot convert \"#{str}\" to boolean")
+    end
+
+    false
+  end
+
+  #Does the same thing as String#contact, but allows a separator to be inserted between the
+  #two strings.
+  def cl_concat_with(str, separator="")
+    return self if str.nil? || str.empty?
+    return self.concat(str) if self.empty?
+    self.concat(separator) unless separator.empty?
+    self.concat(str)
+  end
+
+  # Combines two strings together with a little more intelligence, using a separator.   This methods reduces
+  # much of the prep you may need to do before concatenating two strings and allows you do do the concatenation on a single line.
+  # Examples
+  #   "me".cl_combine("you")  =>   "me you"
+  #   "  me     ".cl_combine("    you", separator: "-")  =>   "me-you"
+  # Options
+  #   separator: The separate to place between the strings. (" " is the default)
+  #   prefix: A string that should appear in front of the final concatenation (no default)
+  #   suffix: A string that should appear at the end of the final concatenation (no default)
+  #   wrap: A boolean which helps control whether or not the prefix and suffix should be added (true is the default)
+  #   strip: Remove whitespace at the beginning and end of the strings before concatenating (true is the default)
+  #   if_empty: An alternative string to return if the resulting concatenation is empty.  This option is considered before the
+  #             prefix or suffix is added.  ("" is the default)
+  def cl_combine(*args)
+    options = args.cl_extract_options!
+    raise ArgumentError, "You need to supply at least one string" if args.empty?
+    str = self
+    args.each { |val| str = str.cl_private_combine(val, options) }
+
+    return options.fetch(:if_empty, "") if str.nil? || str.empty?
+
+    prefix = options.fetch(:prefix, nil)
+    str = "#{prefix}#{str}"  if options.fetch(:wrap, true) && (prefix.cl_not_nil?)
+    suffix = options.fetch(:suffix, nil)
+    str = "#{str}#{suffix}" if options.fetch(:wrap, true) && (suffix.cl_not_nil?)
+    str
+  end
+
+  protected
+
+  def cl_private_combine(str, options={})
+    strip = options.fetch(:strip, true)
+    (return strip ? self.strip : self.dup) if str.nil? or str.empty?
+    (return strip ? str.strip : str.dup) if self.empty?
+    separator = options.fetch(:separator, " ")
+
+    if strip
+      pre = self.strip
+      post = str.strip
+    else
+      pre = self.dup
+      post = str.dup
+    end
+
+    return pre + post if separator.empty?
+
+    # TODO - Support other separators other than spaces.  For instance if someone wanted to join with a comma
+    # and pre ended with a comma, we could have an option to disallow repeating
+    pre + separator + post
   end
+
 end

data/lib/corelib_ruby/core_ext/string/{accessors.rb → core.rb}

@@ -1,17 +1,21 @@
 class String
-  def co_first
+  def cl_not_empty?
+    !self.empty?
+  end
+
+  def cl_first
     empty? ? "" : self[0, 1]
   end
 
-  def co_first_or_nil
+  def cl_first_or_nil
     empty? ? nil : self[0, 1]
   end
 
-  def co_last
+  def cl_last
     empty? ? "" : self[-1, 1]
   end
 
-  def co_last_or_nil
+  def cl_last_or_nil
     empty? ? nil : self[-1, 1]
   end
 
@@ -25,15 +29,15 @@ class String
   #    # => "This is ..."
   #    "This is a test".first_words(2, ellipses: " +++")
   #    # => "This is +++"
-  def co_first_words(n=nil, ellipses: false)
+  def cl_first_words(n=nil, ellipses: false)
     new_str = n.nil? ? self : split[0...n].join(' ')
-    elip = co_determine_ellipses(new_str, ellipses)
+    elip = cl_determine_ellipses(new_str, ellipses)
     new_str + "#{elip}"
   end
 
   private
 
-  def co_determine_ellipses(str, ellipses)
+  def cl_determine_ellipses(str, ellipses)
     return "" if empty? || !ellipses
     return "" if str == self
     ellipses === true ? " ..." : ellipses.to_s

data/lib/corelib_ruby/core_ext/string/queries.rb

@@ -0,0 +1,26 @@
+class String
+  #Returns the subset of a string from [0, position] if string[position] is a space.
+  #If string[max] is not a space, it is assumed we are in the middle of a word.
+  #and the logic will increase position a little bit to not break in the middle of a word.
+  def cl_excerpt_to_end_of_word(position=nil)
+    return self if position.nil? or position >= self.size
+
+    char = self[position]
+    return self[0, position].rstrip if char == " "
+
+    self[0, cl_index_of_next_space_from(position)].rstrip
+  end
+
+  #Given a position, return the position of the next space
+  def cl_index_of_next_space(position=0)
+    return nil if self.empty? or position.nil?
+    return nil if position >= self.size
+
+    idx = position
+    (self.size - position).times do
+      idx = idx + 1
+      return idx if self[idx] == " "
+    end
+    idx
+  end
+end

data/lib/corelib_ruby/core_ext/string/questions.rb

@@ -1,10 +1,23 @@
 class String
-  # Returns true if a non empty string contains all strict space characters.
-  # Tabs and new lines are not considered spaces.
+  # Returns true if a non empty string contains all space characters.  Tabs and new lines are not considered spaces.
   # Returns false for empty strings unless the when_empty: option is set to true.
-  def co_all_spaces?(when_empty: false)
+  def cl_all_spaces?(when_empty: false)
     return when_empty if empty?
-    each_byte { |x| return false unless x == 32 }
+    each_byte { |x| return false if x != 32 }
     true
   end
+
+  # Returns true if a non empty string contains all digit characters.  Tabs, new lines, line feeds and whitespace
+  # all cause the method to return false.
+  def cl_all_digits?(if_empty: false)
+    return if_empty if empty?
+    (self =~ /\A[0-9]+\z/).cl_not_nil?
+  end
+
+  # Returns true if a non empty string contains all letters.  Tabs, new lines, line feeds and whitespace
+  # all cause the method to return false.
+  def cl_all_letters?(if_empty: false)
+    return if_empty if empty?
+    (self =~ /\A[[:alpha:]]+\z/).cl_not_nil?
+  end
 end

data/lib/corelib_ruby/version.rb

@@ -1,3 +1,3 @@
 module CorelibRuby
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/lib/corelib_ruby.rb

@@ -1,7 +1,38 @@
 require "corelib_ruby/version"
+require "corelib_ruby/core_ext/nil/base"
+require "corelib_ruby/core_ext/object/base"
+require "corelib_ruby/core_ext/boolean/base"
+require "corelib_ruby/core_ext/numeric/base"
 require "corelib_ruby/core_ext/string/base"
 require "corelib_ruby/core_ext/hash/base"
 require "corelib_ruby/core_ext/array/base"
 
-# module CorelibRuby
-# end
+# Setup pry for development when running "rake console". Guard against load
+# errors in production (since pry is only loaded as a DEVELOPMENT dependency
+# in the .gemspec)
+begin
+  require "pry"
+rescue LoadError
+end
+
+module CorelibRuby
+  def self.prepare
+    [NilClass, Object, Array, String, FalseClass, TrueClass, Hash, Numeric].each do |class_name|
+      alias_methods_for_core_class(class_name)
+    end
+  end
+
+  # Alias any method starting with 'cl_' to a similiar method starting with '_'.
+  def self.alias_methods_for_core_class(class_name)
+    method_names = class_name.instance_methods.select {|m| m.to_s.start_with?("cl_") }
+    method_names.each do |method_name|
+      new_name = method_name.to_s
+      new_name.slice!(0, 3)
+      new_name = "_#{new_name}".to_sym
+      class_name.send(:alias_method, new_name, method_name)
+    end
+  end
+
+end
+
+CorelibRuby.prepare

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corelib_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,12 +101,26 @@ files:
 - corelib_ruby.gemspec
 - lib/corelib_ruby.rb
 - lib/corelib_ruby/core_ext/array/base.rb
+- lib/corelib_ruby/core_ext/array/core.rb
 - lib/corelib_ruby/core_ext/array/delete.rb
+- lib/corelib_ruby/core_ext/array/iterators.rb
+- lib/corelib_ruby/core_ext/boolean/base.rb
+- lib/corelib_ruby/core_ext/boolean/false.rb
+- lib/corelib_ruby/core_ext/boolean/true.rb
 - lib/corelib_ruby/core_ext/hash/base.rb
+- lib/corelib_ruby/core_ext/hash/core.rb
 - lib/corelib_ruby/core_ext/hash/extract.rb
-- lib/corelib_ruby/core_ext/string/accessors.rb
+- lib/corelib_ruby/core_ext/hash/iterators.rb
+- lib/corelib_ruby/core_ext/nil/base.rb
+- lib/corelib_ruby/core_ext/nil/core.rb
+- lib/corelib_ruby/core_ext/numeric/base.rb
+- lib/corelib_ruby/core_ext/numeric/core.rb
+- lib/corelib_ruby/core_ext/object/base.rb
+- lib/corelib_ruby/core_ext/object/core.rb
 - lib/corelib_ruby/core_ext/string/base.rb
 - lib/corelib_ruby/core_ext/string/conversions.rb
+- lib/corelib_ruby/core_ext/string/core.rb
+- lib/corelib_ruby/core_ext/string/queries.rb
 - lib/corelib_ruby/core_ext/string/questions.rb
 - lib/corelib_ruby/version.rb
 homepage: https://github.com/corlewsolutions/corelib_ruby