string_foundation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 364ff7438ace10942b553e927848df3d7ca5f99d
+  data.tar.gz: d30ac8b18e271e3176352eeae5f9e3ab5b0f0fa9
+SHA512:
+  metadata.gz: 8426ac4262df45928da1d9593e5c6189187b772999315540b73264d2e48a9ff9b1f8c6a814ec2b66fd6f493995e114d5a7d0c09b3630c50238e33bfd4ef84356
+  data.tar.gz: 304dc272d7c6ed55d7f98ffeea7604afe5e27b695f27ed3240da07eda117b9bbdf3fd3552c35ee305c2fcbc674840335d03ba58c679efdd9e68a6a87673196f2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+<!-- ======================================================================= -->
+<!-- CHANGELOG                                                               -->
+<!-- ======================================================================= -->
+# Changelog
+## 1.0.0 (2017-05-09)
+- Initial public release - [@jagaapple](https://github.com/jagaapple), [@cosmicphi](https://github.com/cosmicphi)
+
+## 0.0.1 (2017-04-04)
+- Initial private release - [@jagaapple](https://github.com/jagaapple)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+<!-- ======================================================================= -->
+<!-- CONTRIBUTOR COVENANT CODE OF CONDUCT                                    -->
+<!-- ======================================================================= -->
+# Contributor Covenant Code of Conduct
+## Our Pledge
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+
+## Our Standards
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+
+## Our Responsibilities
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+
+## Scope
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+
+## Enforcement
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at s.w.nnctj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+
+## Attribution
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,38 @@
+# ==============================================================================
+# GEM FILE
+# ==============================================================================
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in string_foundation.gemspec.
+gemspec
+
+# ------------------------------------------------------------------------------
+# For Development and Test
+# ------------------------------------------------------------------------------
+group :development, :test do
+
+  # Install bundler and rake.
+  gem 'bundler'
+  gem 'rake'
+
+end
+
+
+# ------------------------------------------------------------------------------
+# For Test
+# ------------------------------------------------------------------------------
+group :test do
+
+  # Use RSpec for unit test.
+  gem 'rspec'
+  # Use a code coverage analysis tool for Ruby.
+  gem 'simplecov'
+  # Output the result of SimpleCov to a console.
+  gem 'simplecov-console'
+  # Use Codecov to get status badges.
+  gem 'codecov'
+  # Generate random text.
+  gem 'random_token'
+
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    string_foundation (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    hirb (0.7.3)
+    json (2.0.3)
+    rake (12.0.0)
+    random_token (1.1.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    simplecov (0.14.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.1)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.0)
+    url (0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  codecov
+  rake
+  random_token
+  rspec
+  simplecov
+  simplecov-console
+  string_foundation!
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2017 Brushdown
+
+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,324 @@
+<!-- ======================================================================= -->
+<!-- README                                                                  -->
+<!-- ======================================================================= -->
+<img src="string_foundation.png" alt="String Foundation" width="600">
+
+---
+
+[![CircleCI](https://img.shields.io/circleci/project/github/brushdown/string_foundation.rb/master.svg)](https://circleci.com/gh/brushdown/string_foundation.rb)
+[![codecov](https://img.shields.io/codecov/c/github/brushdown/string_foundation.rb/master.svg)](https://codecov.io/gh/brushdown/string_foundation.rb)
+[![Gem](https://img.shields.io/gem/v/string_foundation.svg)](https://rubygems.org/gems/string_foundation/)
+[![license](https://img.shields.io/github/license/brushdown/string_foundation.rb.svg)](https://opensource.org/licenses/MIT)
+[![@jagaapple](https://img.shields.io/badge/contact-%40jagaapple-blue.svg)](https://twitter.com/jagaapple)
+
+String Foundation is a Ruby library that provides useful methods for the Ruby
+string class.
+
+
+## Table of Contents
+
+<!-- MarkdownTOC autolink="true" bracket="round" -->
+
+- [Quick Start](#quick-start)
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Basic Usage](#basic-usage)
+- [The Convertible Methods](#the-convertible-methods)
+  - [To Integer](#to-integer)
+  - [To Float](#to-float)
+  - [To TrueClass / FalseClass](#to-trueclass--falseclass)
+- [The With Methods](#the-with-methods)
+  - [Remove Leading Zeros \(Zero Padding\)](#remove-leading-zeros-zero-padding)
+- [The Convert Methods](#the-convert-methods)
+  - [To TrueClass / FalseClass](#to-trueclass--falseclass-1)
+  - [To Proper Class](#to-proper-class)
+  - [Newlines To Characters](#newlines-to-characters)
+- [The Like Methods](#the-like-methods)
+  - [Like Integer](#like-integer)
+  - [Like Float](#like-float)
+- [The Case Methods](#the-case-methods)
+- [Contributing to String Foundation](#contributing-to-string-foundation)
+- [License](#license)
+
+<!-- /MarkdownTOC -->
+
+
+## Quick Start
+### Requirements
+- Ruby version 2.1.0 or higher
+- A project that uses source control, such as Git
+
+### Installation
+String Foundation is available as a gem, to install it just install the gem:
+
+```bash
+$ gem install string_foundation
+```
+
+If you are using Bundler, add this line to your application's Gemfile:
+
+```ruby
+gem 'string_foundation'
+```
+
+And then run `bundle install` .
+
+### Basic Usage
+The following is a sample of what String Foundation provides.
+
+```ruby
+# Check for convertible.
+'123'.to_i?  #=> true
+'x123'.to_i? #=> false
+
+# Remove leading zeros.
+'00000123'.without_leading_zeros #=> '123'
+
+# Convert a value to the appropriate type.
+'false'.to_pretty #=> false
+'.5'.to_pretty    #=> 0.5
+
+# Convert to lowerCamelCase.
+'user_id'.to_lcamel #=> 'userId'
+```
+
+
+## The Convertible Methods
+The Convertible Methods enable you to check whether or not a string can be
+converted to another class object. These methods return `true` or `false` .
+
+### To Integer
+The `to_i?` method checks whether a string can be converted to an Integer
+(including Fixnum and Bignum classes). This returns `true` only if an argument
+is convertible, therefore it is not required for the argument to be an integral
+number. If you pass a floating point number as an argument to this method, it will
+return `true` because it can be converted using the `to_i` Ruby built-in method
+(for example, `'0.4'.to_i` returns `0` ).
+
+```ruby
+'123'.to_i? #=> true
+'0.3'.to_i? #=> true
+'.2'.to_i?  #=> true
+
+'abc'.to_i? #=> false
+'2x'.to_i?  #=> false
+```
+
+If an argument has leading zeros, they will be removed before checking.
+
+```ruby
+'00000123'.to_i? #=> true
+```
+
+### To Float
+The `to_f?` method is to check convertibility to the Float class. This returns
+`true` only when an argument is convertible, therefore it is not required for the
+argument to be a floating point number. If you pass an integral number as an
+argument to this method, it will return `true` because it can be converted using
+the `to_f` Ruby built-in method (for example, `'2'.to_f` returns `2.0` ).
+
+```ruby
+'0.3'.to_f? #=> true
+'2'.to_f?   #=> true
+'.2'.to_f?  #=> true
+
+'abc'.to_f?  #=> false
+'2.0x'.to_f? #=> false
+```
+
+
+### To TrueClass / FalseClass
+The `to_bool?` method checks whether a string is convertible to TrueClass or
+FalseClass. This returns `true` or `false` only when the string is `'true'` or
+`'false'` .
+
+```ruby
+'true'.to_bool?  #=> true
+'false'.to_bool? #=> true
+
+'abc'.to_bool?   #=> false
+'123'.to_bool?   #=> false
+```
+
+String Foundation also provides a check for a string's convertibility to a "Booly"
+(truthy or falsy). This returns `true` only when the string is a positive number,
+`'true'` , or an empty string. If not, it returns `false` .
+
+```ruby
+'true'.to_booly? #=> true
+'123'.to_booly?  #=> true
+''.to_booly?     #=> true
+'-3'.to_booly?   #=> true
+
+'abc'.to_booly?  #=> false
+```
+
+
+## The With Methods
+The With Methods provide you with ways to append or remove specific characters
+from a String object.
+
+### Remove Leading Zeros (Zero Padding)
+The `without_leading_zeros` method removes leading zeros (called "zero padding").
+This supports a floating point number and a string starting with a plus or minus sign.
+
+```ruby
+'00001'.without_leading_zeros   #=> '1'
+'-0000.3'.without_leading_zeros #=> '-0.3'
+
+%w(00001 00003 00008).map { |num| num.without_leading_zeros } #=> ['1', '3', '8']
+```
+
+
+## The Convert Methods
+The Convert Methods enable you to convert to a specific class object. While Ruby
+built-in methods include conversion from a String object to an Integer object or
+a Float object, they do not include conversion to a TrueClass / FalseClass object
+or a proper class object. The Convert Methods make it easy to convert to these
+excluded classes.
+
+### To TrueClass / FalseClass
+The `to_bool` method is for converting from a `'true'` or `'false'` string to `true`
+or `false` , otherwise it will raise a `TypeError` .
+
+```ruby
+'true'.to_bool  #=> true
+'false'.to_bool #=> false
+
+'1'.to_bool   #=> TypeError
+'0'.to_bool   #=> TypeError
+'-1'.to_bool  #=> TypeError
+'abc'.to_bool #=> TypeError
+''.to_bool    #=> TypeError
+```
+
+If you want to convert a Booly string, you can use the `to_booly` method. When a
+string is `'true'` or a positive number, this method will return `true` . Otherwise
+it will return `false` .
+
+```ruby
+'true'.to_booly  #=> true
+'false'.to_booly #=> false
+
+'1'.to_booly   #=> true
+'0'.to_booly   #=> false
+'-1'.to_booly  #=> false
+'abc'.to_booly #=> TypeError
+''.to_booly    #=> false
+```
+
+### To Proper Class
+The `to_pretty` method is powerful. This method can convert to a proper class,
+for example, it will return a TrueClass `true` when a string is `'true'`, or returns
+an Integer `1` when a string is `'1'`.
+Also this returns `nil` when a string is an empty string.
+
+```ruby
+'1'.to_pretty      #=> 1
+'-3'.to_pretty     #=> -3
+'0004'.to_pretty   #=> 4
+'0.1'.to_pretty    #=> 0.1
+'-.5'.to_pretty    #=> -0.5
+'00.01'.to_pretty  #=> 0.01
+
+'true'.to_pretty  #=> true
+'false'.to_pretty #=> false
+
+''.to_pretty #=> nil
+```
+
+### Newlines To Characters
+The `nl_to` method converts a string with newlines to its specific characters.
+The `nl2` method is an alias for `nl_to` .
+
+```ruby
+"Hi!\nWe are Brushdown.".nl_to(' / ') #=> 'Hi! / We are Brushdown.'
+"Hi!\nWe are Brushdown.".nl2(' / ')   #=> 'Hi! / We are Brushdown.'
+```
+
+The `nl_to_br` method replaces the newlines in a string with HTML tag `<br>` for
+break line.
+The `nl2br` method is an alias for `nl_to_br` .
+
+```ruby
+"Hi!\nWe are Brushdown.".nl_to_br #=> 'Hi!<br>We are Brushdown.'
+"Hi!\nWe are Brushdown.".nl2br    #=> 'Hi!<br>We are Brushdown.'
+```
+
+
+## The Like Methods
+The Like Methods provide to check whether a string is an integral number or a
+floating point number. These method ignore leading zeros, so the string `'000123'`
+is regarded as an integral number. These method return `true` or `false` .
+
+The Like Methods check whether a string is an integral number or a floating point
+number. These methods ignore leading zeros, so the string `000123` is regarded
+as an integral number. These methods return `true` or `false` .
+
+### Like Integer
+The `like_i?` method checks whether a string is an integral number.
+
+```ruby
+'123'.like_i? #=> true
+'00123'.like_i? #=> true
+'0.3'.like_i? #=> false
+'.2'.like_i?  #=> false
+
+'abc'.like_i? #=> false
+'2x'.like_i?  #=> false
+```
+
+### Like Float
+The `like_f?` method checks whether a string is a floating point number.
+
+```ruby
+'123'.like_f? #=> false
+'00123'.like_f? #=> false
+'0.3'.like_f? #=> true
+'.2'.like_f?  #=> true
+
+'abc'.like_f? #=> false
+'2x'.like_f?  #=> false
+```
+
+
+## The Case Methods
+The Case Methods convert to a case style, such as `lowerCamelCase` and
+`lower_snake_case` . The following methods are available.
+
+| METHOD NAME | CASE STYLE                    | EXAMPLE            |
+|:------------|:------------------------------|:-------------------|
+| `to_lcamel` | Lower Camel Case              | `weAreBrushdown`   |
+| `to_ucamel` | Upper Camel Case              | `WeAreBrushdown`   |
+| `to_lsnake` | Lower Snake Case              | `we_are_brushdown` |
+| `to_usnake` | Upper Snake Case ()           | `We_Are_Brushdown` |
+| `to_lkebab` | Lower Kebab Case (Chain Case) | `we-are-brushdown` |
+| `to_ukebab` | Upper Kebab Case (Train Case) | `We-Are-Brushdown` |
+| `to_lspace` | Lower Space Case (Lower Case) | `we are brushdown` |
+| `to_uspace` | Upper Space Case (Start Case) | `We Are Brushdown` |
+| `to_ldot`   | Lower Dot Case                | `we.are.brushdown` |
+| `to_udot`   | Upper Dot Case                | `We.Are.Brushdown` |
+
+```ruby
+'user_id'.to_lcamel   #=> 'userId'
+'createdAt'.to_lsnake #=> 'created_at'
+```
+
+
+## Contributing to String Foundation
+Bug reports and pull requests are welcome on GitHub at
+[https://github.com/brushdown/string_foundation.rb](https://github.com/brushdown/string_foundation.rb).
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org)
+code of conduct.
+
+We adhere GitHub Flow to develop this project. Anything in the `master` branch
+is deployable. To work on something new, create a descriptively named branch
+off of master, also add a prefix `feature/` to its name.
+For more details, see [GitHub Flow – Scott Chacon](http://scottchacon.com/2011/08/31/github-flow.html).
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright 2017 Jaga Apple and Brushdown. All rights reserved.

data/Rakefile

@@ -0,0 +1,13 @@
+# ==============================================================================
+# RAKE FILE
+# ==============================================================================
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# ------------------------------------------------------------------------------
+# Configure Tasks
+# ------------------------------------------------------------------------------
+# Set a RSpec task.
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# ==============================================================================
+# BIN - CONSOLE
+# ==============================================================================
+require "bundler/setup"
+require "string_foundation"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,11 @@
+# ==============================================================================
+# BIN - SETUP
+# ==============================================================================
+#!/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/circle.yml

@@ -0,0 +1,14 @@
+# ==============================================================================
+# CIRCLE
+# ==============================================================================
+# Settings for CircleCI.
+machine:
+  environment:
+    CI: true
+dependencies:
+  pre:
+    - 'case $CIRCLE_NODE_INDEX in 0) rvm use 2.1.0 --default ;; 1) rvm use 2.4.1 --default ;; esac'
+test:
+  override:
+    - ruby -v ; bundle exec rspec:
+        parallel: true