coolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5824a5224b213f0f640864757a042cddff2994a46450066b5cbb7438604a95b
+  data.tar.gz: 43a8a6ea69ae91e8389f0b730c5d88544004821d6494926bc0e5c618f853c2c1
+SHA512:
+  metadata.gz: 5c6c1b58118ec3b4ab741bcdd5fefc5cc9b5f3005c884a8a8826616b306792817137d9a25f0e161f6e2c3c3d63726b1bf295adc42ab63bf6015d9931280984f0
+  data.tar.gz: 607c920e59c12184e2fb16cd42166556b3951f8f6740f812e13fb0932ee7b4fa633f02afa29f0e57bb49080ad2161441cb28b039680dbf63abf3c8a395c057df

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/ignore/

data/.rubocop.yml

@@ -0,0 +1,149 @@
+AllCops:
+  TargetRubyVersion: 2.3.0
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/DocumentationMethod:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+# Don't leave calls to pry lying around.
+Lint/Debugger:
+  Enabled: true
+
+# ==============================================================================
+# Layout
+# ==============================================================================
+
+Metrics/LineLength:
+  Max: 150
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+# https://unix.stackexchange.com/a/18789
+Layout/TrailingBlankLines:
+  EnforcedStyle: final_newline
+
+# ==============================================================================
+# Strings
+# ==============================================================================
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+# ==============================================================================
+# Numbers
+# ==============================================================================
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+# ==============================================================================
+# Braces, Brackets, & Parens
+# ==============================================================================
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+# Only use braces if the function expects a hash argument. [different in Ruby 2.7+](https://blog.saeloun.com/2019/10/07/ruby-2-7-keyword-arguments-redesign.html)
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# ==============================================================================
+# Unsorted
+# ==============================================================================
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# Explicit, not redundant
+Style/RedundantReturn:
+  Enabled: false
+
+# Explicit, not redundant
+Style/RedundantSelf:
+  Enabled: false
+
+# `x&.y&.[](:argument)` isn't what I'd call "readable".
+# https://stackoverflow.com/questions/34794697/using-with-the-safe-navigation-operator-in-ruby
+Style/SafeNavigation:
+  Enabled: false
+
+# TODO: File issue to ignore enums when using `EnforcedStyle: assign_inside_condition`.
+Style/ConditionalAssignment:
+  Enabled: false
+
+Lint/HandleExceptions:
+  AllowComments: true
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: False
+

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!-- ## [Unreleased] -->
+
+## 0.1.0 (2019-11-17)
+
+### Added
+
+- `Coolkit::Error` and `Coolkit::VERSION`.
+- `root_dir`, `data_dir`, `data_dir` for finding your way without `Rails.root`
+- `symbolize_keys` to get by without .
+- `to_est` to convert UCT time to EST.
+- `write_to_file` to write to a given path and not worry if parent folders exist yet.
+- `Array#remove_first` to remove the first *x* from an array.
+- `String#indent` from ActiveSupport. (Because it's excessive to require it for just that)
+- `String#comment` to comment ruby code in strings.
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# See util.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    coolkit (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.2)
+    json (2.2.0)
+    minitest (5.13.0)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.5.0)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.22.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coolkit!
+  coveralls (~> 0.8.23)
+  minitest (~> 5.0)
+  minitest-focus (~> 1.1)
+  minitest-reporters (~> 1.4)
+  rake (~> 10.0)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Clay Dunston
+
+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,41 @@
+# Coolkit
+
+[![Build Status](https://travis-ci.org/tcd/coolkit.svg?branch=master)](https://travis-ci.org/tcd/coolkit)
+[![Coverage Status](https://coveralls.io/repos/github/tcd/coolkit/badge.svg?branch=master)](https://coveralls.io/github/tcd/coolkit?branch=master)
+[![GitHub](https://img.shields.io/github/license/tcd/coolkit)](https://github.com/tcd/coolkit/blob/master/LICENSE.txt)
+
+Useful ruby code with no dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "coolkit"
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```
+gem install util
+```
+
+## Usage
+
+```ruby
+require "coolkit"
+```
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tcd/coolkit.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task(default: :test)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coolkit"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,9 @@
+#!/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/coolkit.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coolkit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coolkit"
+  spec.version       = Coolkit::VERSION
+  spec.authors       = ["Clay Dunston"]
+  spec.email         = ["dunstontc@gmail.com"]
+
+  spec.summary       = "Useful ruby code with no dependencies."
+  spec.homepage      = "https://github.com/tcd/coolkit"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => spec.homepage,
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.23"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-focus", "~> 1.1"
+  spec.add_development_dependency "minitest-reporters", "~> 1.4"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov"
+end

data/lib/coolkit/array/remove_first.rb

@@ -0,0 +1,21 @@
+class Array
+  # Remove the first instance of an item from an array.
+  # **Note**: this will mutate the reciever.
+  #
+  # @param item [Object]
+  # @return [self]
+  def remove_first!(item)
+    return self if self.length == 0
+    index = self.index(item)
+    self.delete_at(index) if index
+    return self
+  end
+
+  # Return a copy of an array the first instance of a given item removed.
+  #
+  # @param item [Object]
+  # @return [self]
+  def remove_first(item)
+    return self.dup.tap { |s| s.remove_first!(item) }
+  end
+end

data/lib/coolkit/error.rb

@@ -0,0 +1,5 @@
+module Coolkit
+  # Exceptions raised by Coolkit inherit from {Error}.
+  # @abstract
+  class Error < StandardError; end
+end

data/lib/coolkit/filesystem.rb

@@ -0,0 +1,14 @@
+require "fileutils"
+
+module Coolkit
+  # Append data to the end of a file.
+  # The file is created if it doesn"t exist.
+  #
+  # @param file [String] Path to the file.
+  # @param data [String,#to_s] Data to write to the file.
+  # @return [void]
+  def self.write_to_file(file, data)
+    FileUtils.mkdir_p(File.dirname(file))
+    File.open(file, "a") { |f| f.write(data) }
+  end
+end

data/lib/coolkit/paths.rb

@@ -0,0 +1,19 @@
+module Coolkit
+  # Directory where the gem is located.
+  # @return [String]
+  def self.root_dir
+    return File.expand_path("../../..", __FILE__)
+  end
+
+  # Directory for writing out files.
+  # @return [String]
+  def self.data_dir
+    return File.join(self.root_dir, "data")
+  end
+
+  # Directory for writing out files.
+  # @return [String]
+  def self.tmp_dir
+    return File.join(self.root_dir, "tmp")
+  end
+end

data/lib/coolkit/string/comment.rb

@@ -0,0 +1,20 @@
+class String
+
+  # Adds a comment string (`"# "`) after every newline in a string.
+  #
+  # @param indent_empty_lines [Boolean]
+  # @return [void]
+  def comment!(indent_empty_lines = true)
+    re = indent_empty_lines ? /^/ : /^(?!$)/
+    gsub!(re, "# ")
+  end
+
+  # Returns a copy of a string with a comment (`"# "`) after every newline in a string.
+  #
+  # @param indent_empty_lines [Boolean]
+  # @return [String]
+  def comment(indent_empty_lines = true)
+    dup.tap { |s| s.comment!(indent_empty_lines) }
+  end
+
+end

data/lib/coolkit/string/indent.rb

@@ -0,0 +1,42 @@
+# Straight from [ActiveSupport][1]
+#
+# [1]:https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/string/indent.rb
+class String
+
+  # Same as {indent}, except it indents the receiver in-place.
+  #
+  # Returns the indented string, or `nil` if there was nothing to indent.
+  #
+  # @param amount [Integer] The level of indentation to add.
+  # @param indent_string [String] Defaults to tab if a tab is present in the string, and `" "` otherwise.
+  # @param indent_empty_lines [Boolean]
+  #
+  # @return [void]
+  def indent!(amount, indent_string = nil, indent_empty_lines = false)
+    indent_string = indent_string || self[/^[ \t]/] || " "
+    re = indent_empty_lines ? /^/ : /^(?!$)/
+    gsub!(re, indent_string * amount)
+  end
+
+  # Indents the lines in the receiver.
+  #
+  # The second argument, `indent_string`, specifies which indent string to
+  # use. The default is `nil`, which tells the method to make a guess by
+  # peeking at the first indented line, and fallback to a space if there is
+  # none.
+  #
+  # While `indent_string` is typically one space or tab, it may be any string.
+  #
+  # The third argument, `indent_empty_lines`, is a flag that says whether
+  # empty lines should be indented. Default is `false`.
+  #
+  # @param amount [Integer] The level of indentation to add.
+  # @param indent_string [String] Defaults to tab if a tab is present in the string, and `" "` otherwise.
+  # @param indent_empty_lines [Boolean]
+  #
+  # @return [String]
+  def indent(amount, indent_string = nil, indent_empty_lines = false)
+    dup.tap { |s| s.indent!(amount, indent_string, indent_empty_lines) }
+  end
+
+end

data/lib/coolkit/string/titleize.rb

@@ -0,0 +1,24 @@
+# class String
+#
+#   # Returns a copy of a string with the first letter of each word capitalized.
+#   # @return [String]
+#   def titleize()
+#     return self.split(" ")
+#                .map(&:capitalize!)
+#                .join(" ")
+#   end
+#
+#   # @return [String]
+#   def titleize2(string)
+#     words = self.split(" ")
+#     skips = ["and", "of", "the", "in", "to", "over", "an", "a"]
+#     words.each do |word|
+#       if word == words[0] || !skips.include?(word)
+#         element.capitalize!
+#       end
+#     end
+#     answer = array.join(" ")
+#     return answer
+#   end
+#
+# end

data/lib/coolkit/symbolize.rb

@@ -0,0 +1,31 @@
+module Coolkit
+  # Recursively convert keys in a Hash or Array to symbols.
+  #
+  # See:
+  # - [original code](https://avdi.codes/recursively-symbolize-keys/)
+  # - [array support](https://gist.github.com/neektza/8585746)
+  #
+  # @param arg [Hash,Array]
+  # @return [Hash,Array]
+  def self.symbolize_keys(arg)
+    if arg.is_a?(Hash)
+      arg.inject({}) do |result, (key, value)|
+        new_key = case key
+                  when String then key.to_sym()
+                  else key
+                  end
+        new_value = case value
+                    when Hash then symbolize_keys(value)
+                    when Array then symbolize_keys(value)
+                    else value
+                    end
+        result[new_key] = new_value
+        result
+      end
+    elsif arg.is_a?(Array)
+      arg.map { |e| symbolize_keys(e) }
+    else
+      x
+    end
+  end
+end

data/lib/coolkit/time.rb

@@ -0,0 +1,13 @@
+require "time"
+
+module Coolkit
+  # Convert a `UTC` {Time} object to `EST`.
+  #
+  # @raise [ArgumentError] Unless passed a `UTC` formatted time.
+  # @param time [Time]
+  # @return [Time]
+  def self.to_est(time)
+    raise ArgumentError "argument is not in UTC format" unless time.utc?()
+    return time + Time.zone_offset("EST")
+  end
+end

data/lib/coolkit/version.rb

@@ -0,0 +1,3 @@
+module Coolkit
+  VERSION = "0.1.0".freeze
+end

data/lib/coolkit.rb

@@ -0,0 +1,4 @@
+# Useful ruby code with no dependencies
+module Coolkit; end
+
+Dir.glob(File.join(__dir__, "coolkit", "/**/*.rb")).sort.each { |file| require file }

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: coolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Clay Dunston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dunstontc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coolkit.gemspec
+- lib/coolkit.rb
+- lib/coolkit/array/remove_first.rb
+- lib/coolkit/error.rb
+- lib/coolkit/filesystem.rb
+- lib/coolkit/paths.rb
+- lib/coolkit/string/comment.rb
+- lib/coolkit/string/indent.rb
+- lib/coolkit/string/titleize.rb
+- lib/coolkit/symbolize.rb
+- lib/coolkit/time.rb
+- lib/coolkit/version.rb
+homepage: https://github.com/tcd/coolkit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tcd/coolkit
+  source_code_uri: https://github.com/tcd/coolkit
+  changelog_uri: https://github.com/tcd/coolkit
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Useful ruby code with no dependencies.
+test_files: []