coolkit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5824a5224b213f0f640864757a042cddff2994a46450066b5cbb7438604a95b
-  data.tar.gz: 43a8a6ea69ae91e8389f0b730c5d88544004821d6494926bc0e5c618f853c2c1
+  metadata.gz: 9ad36bff0a52088342ecb08344d0de312ff5c3a0b9c9ef9c48284dc6c920152c
+  data.tar.gz: b907315cb342b131b2b7dffaec5b8b1e757396999e0b8d500f9c327a9d252913
 SHA512:
-  metadata.gz: 5c6c1b58118ec3b4ab741bcdd5fefc5cc9b5f3005c884a8a8826616b306792817137d9a25f0e161f6e2c3c3d63726b1bf295adc42ab63bf6015d9931280984f0
-  data.tar.gz: 607c920e59c12184e2fb16cd42166556b3951f8f6740f812e13fb0932ee7b4fa633f02afa29f0e57bb49080ad2161441cb28b039680dbf63abf3c8a395c057df
+  metadata.gz: 7f92f5384b3e470fea659e3718752c5e92c6758d0f45f2bb3331d3dcb8bd71818e38e4e232aa8e1833ff1c37069a438f62f3c06e6d6fd3cfa33e69a360ba5faa
+  data.tar.gz: bd1a2364ac6a2132a91e4c08f737e99b4f147bab2438df1e722da9148f1944e520582bc8c6344b079a2a964df0bce4f42e3ef04117943edbea3b209cdf47a91a

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /ignore/
+.rake_tasks

data/.yardopts

@@ -0,0 +1,2 @@
+--charset utf-8
+--markup markdown

data/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## [Unreleased] -->
 
+## 0.2.0 (2019-11-17)
+
+### Added
+
+- `JSON.read` to replace `JSON.parse(File.read(path))`. Inspired by `CSV.read`.
+
 ## 0.1.0 (2019-11-17)
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coolkit (0.1.0)
+    coolkit (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,10 @@
 # Coolkit
 
+[![Gem](https://img.shields.io/gem/v/coolkit)](https://rubygems.org/gems/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)
+[![Documentation](http://img.shields.io/badge/docs-rubydoc.org-blue.svg)](https://www.rubydoc.info/gems/coolkit)
 
 Useful ruby code with no dependencies.
 

data/bin/docs

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Rebuild project documentation and serve it locally.
+rm -rf .yardoc && yard server -r

data/coolkit.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     "homepage_uri" => spec.homepage,
     "source_code_uri" => spec.homepage,
-    "changelog_uri" => spec.homepage,
+    "changelog_uri" => "https://github.com/tcd/coolkit/blob/master/CHANGELOG.md",
+    "yard.run" => "yri", # use "yard" to build full HTML docs.
   }
 
   # Specify which files should be added to the gem when it is released.

data/lib/coolkit/json.rb

@@ -0,0 +1,16 @@
+module JSON
+  # Parse JSON data from a file at the given path.
+  #
+  # TODO: Test this on [ruby 2.7][1]
+  #
+  # @param path [String]
+  # @param opts [Hash] Options to pass to [`JSON.parse`][2].
+  # @param (see #parse)
+  # @return [Hash]
+  #
+  # [1]: https://blog.saeloun.com/2019/10/07/ruby-2-7-keyword-arguments-redesign.html
+  # [2]: https://ruby-doc.org/stdlib-2.6.3/libdoc/json/rdoc/JSON.html#method-i-parse
+  def self.read(path, opts = {})
+    return self.parse(File.read(path), opts)
+  end
+end

data/lib/coolkit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coolkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Clay Dunston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-17 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -125,12 +126,14 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/docs
 - bin/setup
 - coolkit.gemspec
 - lib/coolkit.rb
 - lib/coolkit/array/remove_first.rb
 - lib/coolkit/error.rb
 - lib/coolkit/filesystem.rb
+- lib/coolkit/json.rb
 - lib/coolkit/paths.rb
 - lib/coolkit/string/comment.rb
 - lib/coolkit/string/indent.rb
@@ -144,7 +147,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tcd/coolkit
   source_code_uri: https://github.com/tcd/coolkit
-  changelog_uri: https://github.com/tcd/coolkit
+  changelog_uri: https://github.com/tcd/coolkit/blob/master/CHANGELOG.md
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths: