corelib_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81f43b9d5997a0a97fca28b30170a3daa80cf85e
+  data.tar.gz: 03b01a6f4b0bc6945b778c9f6ffe1cca7533e648
+SHA512:
+  metadata.gz: d91a73b06d6927c3505d9edfc1b8d26eb8f07ad38fe63b795856a2e67e973270aaa59fd51aeafd9e226f7f9291f5d36fb2eb776c9d54df8a9a5446d397bd9852
+  data.tar.gz: c0c99f36a9ca23451a6ccabde0437ffb8958eb27330092e0653a21c82b6e814a92dd8b143ce768c0d5624ff7b41d55fe489cb567333139690b0bf12302dee6f0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  Exclude:  # skip all of the following....
+    - db/**/*  # schema files are auto generated
+    - db/seeds/**/*  # skip seed files
+    - db/seeds/seed_data/**/*  # skip seed data
+    - bin/**/*  # bin files are auto generated
+    - /**/*.gemspec
+  RunRailsCops: true
+Documentation:
+  Enabled: false  # don't require docs @ top level of class
+Style/StringLiterals:
+  Enabled: false # TODO (Bobby): Disabled by Bobby.  Need to decide if we care about enforcing single or double quoted strings.
+Style/HashSyntax:
+  Enabled: false
+Style/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+Metrics/LineLength:
+  Max: 130
+# Ignore the "Use nested module/class definitions instead of compact style" cop
+#   because Rails, by default, generates the compact style.
+#
+#   TODO: (Jay) Consider adopting the nested at some point
+Style/ClassAndModuleChildren:
+  Enabled: false
+# Ignore the annotation keywords in comments. This allows use of something like
+#   `TODO (Foo):` which we would use, but breaks rubocop. Need to replace with
+#   `TODO: (Jay)` to make compatibile.
+#
+# TODO: (Jay) Consider re-enabling this to comply with the standard ruby
+#   conventions
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Metrics/AbcSize:
+  Max: 17

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+## 0.0.1 (Oct 9, 2015)
+
+1. (New) Added **String** methods: `#first, #first_or_nil, #last, #last_or_nil, #first_words, #force_leading_space, #all_spaces?`
+2. (New) Added **Hash** methods: `#extract`

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in corelib_ruby.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# corelib_ruby
+
+Many languages provide a vast library of methods or functions for developers to use, whereas Ruby only provides basic (albeit powerful) building blocks. At best, this leads to more complex applications and time wasted writing code another developer has probably already written; at worst it results in core class extensions being placed in helper methods or on objects that have no business owning the methods. The lack of a good strategy for managing Ruby extentions really becomes apparent when a developer needs to share his extensions across multiple projects.
+
+Corelib aims to solve this problem by providing a central gem for developers to share extensions & additions to the Ruby core. Corelib focuses on:
+
+1. Reducing Code Duplication
+2. Improving Code Readability
+3. Sharing Developer Knowledge
+4. Reducing Errors
+5. Saving Developers Time
+6. Improving Code Quality & Performance
+
+We invite all like minded developers to join us in growing the corelib library of extensions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'corelib_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install corelib_ruby
+
+## Usage
+
+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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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).
+
+Open a console with either command
+
+    $ bin/console
+    $ rake console
+
+Run rspec tests
+
+    $ rspec
+
+Run rubocop
+
+    $ bin/rubocop
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/corlewsolutions/corelib_ruby.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+# Adds the ability to run 'rake console' in the terminal and have a console
+# that already knows about the gem
+task :console do
+  exec "pry -r corelib_ruby -I ./lib"
+  # exec "irb -r corelib_ruby -I ./lib"
+end

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "corelib_ruby"
+
+# 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.
+
+# require "irb"
+# IRB.start
+
+require "pry"
+Pry.start

data/bin/rubocop

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  print "Running rubocop ... "
+
+  # Style Checks
+
+  command = "rubocop"
+  command += " --format simple --out rubocop/style-issues.txt"
+  command += " --format html --out rubocop/style-issues.html"
+  command += " --format offenses --out rubocop/style-counts.txt"
+  system command
+
+  # Lint Checks
+
+  command = "rubocop -l"
+  command += " --format simple --out rubocop/lint-issues.txt"
+  command += " --format html --out rubocop/lint-issues.html"
+  command += " --format offenses --out rubocop/lint-counts.txt"
+  system command
+
+  puts "done (results can be found in the 'rubocop' folder)"
+end

data/bin/setup

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # Remove Gemfile.lock and suppress output if it doesn't exist
+  system "rm Gemfile.lock 2> /dev/null"
+  system "bundle install"
+end

data/corelib_ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'corelib_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "corelib_ruby"
+  spec.version       = CorelibRuby::VERSION
+  spec.authors       = ["roberts1000"]
+  spec.email         = ["roberts@corlewsolutions.com"]
+
+  spec.summary       = %q{Useful extensions to ruby core.}
+  spec.description   = %q{Useful extensions to ruby core.}
+  spec.homepage      = "https://github.com/corlewsolutions/corelib_ruby"
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_development_dependency "rubocop", "~> 0.34.2"
+end

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

@@ -0,0 +1 @@
+require "corelib_ruby/core_ext/hash/extract"

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

@@ -0,0 +1,24 @@
+class Hash
+  # This method mimics the fetch method except it also deletes the key from the
+  # hash once it has been fetched.
+  #
+  # 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 exists, there is no default, but a block is given, then
+  # that block will be executed with the key.
+  def 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
+
+    return yield key if block_given?
+    (args.length == 2) ? args[1] : fail(KeyError, "key not found #{key.inspect}", caller)
+  end
+end

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

@@ -0,0 +1,41 @@
+class String
+  def first
+    empty? ? "" : self[0, 1]
+  end
+
+  def first_or_nil
+    empty? ? nil : self[0, 1]
+  end
+
+  def last
+    empty? ? "" : self[-1, 1]
+  end
+
+  def last_or_nil
+    empty? ? nil : self[-1, 1]
+  end
+
+  # Retreive the fist n words of a string as a new string.  Attach an optional
+  # ellipses what will display smartly
+  #
+  # Examples
+  #    "This is a test".first_words(2)
+  #    # => "This is"
+  #    "This is a test".first_words(2, ellipses: true)
+  #    # => "This is ..."
+  #    "This is a test".first_words(2, ellipses: " +++")
+  #    # => "This is +++"
+  def first_words(n=nil, ellipses: false)
+    new_str = n.nil? ? self : split[0...n].join(' ')
+    elip = determine_ellipses(new_str, ellipses)
+    new_str + "#{elip}"
+  end
+
+  private
+
+  def determine_ellipses(str, ellipses)
+    return "" if empty? || !ellipses
+    return "" if str == self
+    ellipses === true ? " ..." : ellipses.to_s
+  end
+end

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

@@ -0,0 +1,3 @@
+require "corelib_ruby/core_ext/string/accessors"
+require "corelib_ruby/core_ext/string/questions"
+require "corelib_ruby/core_ext/string/conversions"

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

@@ -0,0 +1,6 @@
+class String
+  def force_leading_space(even_when_empty: false)
+    (return even_when_empty ? " " : "") if empty?
+    all_spaces? ? dup : " #{lstrip}"
+  end
+end

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

@@ -0,0 +1,10 @@
+class String
+  # Returns true if a non empty string contains all strict 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 all_spaces?(when_empty: false)
+    return when_empty if empty?
+    each_byte { |x| return false unless x == 32 }
+    true
+  end
+end

data/lib/corelib_ruby/version.rb

@@ -0,0 +1,3 @@
+module CorelibRuby
+  VERSION = "0.0.1"
+end

data/lib/corelib_ruby.rb

@@ -0,0 +1,6 @@
+require "corelib_ruby/version"
+require "corelib_ruby/core_ext/string/base"
+require "corelib_ruby/core_ext/hash/base"
+
+# module CorelibRuby
+# end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: corelib_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- roberts1000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
+description: Useful extensions to ruby core.
+email:
+- roberts@corlewsolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rubocop
+- bin/setup
+- corelib_ruby.gemspec
+- lib/corelib_ruby.rb
+- lib/corelib_ruby/core_ext/hash/base.rb
+- lib/corelib_ruby/core_ext/hash/extract.rb
+- lib/corelib_ruby/core_ext/string/accessors.rb
+- lib/corelib_ruby/core_ext/string/base.rb
+- lib/corelib_ruby/core_ext/string/conversions.rb
+- lib/corelib_ruby/core_ext/string/questions.rb
+- lib/corelib_ruby/version.rb
+homepage: https://github.com/corlewsolutions/corelib_ruby
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Useful extensions to ruby core.
+test_files: []