gemwork 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d3241df9423a54841f11171d2fbeff4bb63b22085bc187a18fedae95b74ee2f
-  data.tar.gz: 7a5dea7187011408054ec03e82ec39613db139d40187db044f115a35a3b65133
+  metadata.gz: 16eb6be5f4d3df33580263ae99993955fc2a23c375da90bc0918992bad91c9f3
+  data.tar.gz: 485e472747f3666a3e861809531b888696353da68f38ca0c1cb8d9305fee398b
 SHA512:
-  metadata.gz: d0f5e9c142694babd902734ef36ccdee43439ca13a79b3d276a488136e42dfa1a8a2dd6ea2dc38ce727937bbede0e5c94d1e0da04b0508876be932af8cf5e9dd
-  data.tar.gz: c996bc46e4a8d3b96daeb73d4d3c8ccbf9905267dc3f238de1d2cc3d4d55b500d08945591728e7065a2bbd8a50892e54e568f2d22a7c4544a20f04ca46b06aa9
+  metadata.gz: d82f6082fb2a0d2eb48089950f9940ddab4724d1dfc5685cdfee2771294766c758ae692f383d058c98368bcd02c19f9b7545795b4a826190f1f085f55ebb84a5
+  data.tar.gz: 0175bacca5b9cdb35d9c8c26a44b3dabb1c322cb3355549e7b263dc5e9f284aeacffbc0ef1744623775e706929de54441db484cff971cb35c39e2433d7d7893b

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+
+## [0.2.0] - 2023-11-25
+
+- Add gem dependencies to Gemwork, to be installed by including child gems.
+- Add testing support files for more easily setting up and maintaining dependencies in the test/test_helper.rb file of child gems.
+
 ## [0.1.1] - 2023-11-24
 
+- Recommend adding a `REBUILD_GEMWORK` flag to README, for use when running `bin/setup` from a child gem.
+
+## [0.1.0] - 2023-11-24
+
 - Initial release

data/README.md

@@ -77,6 +77,46 @@ inherit_gem:
 
 See also: [RuboCop's Configuration Guide on Inheritance](https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/configuration.adoc#inheriting-configuration-from-a-dependency-gem).
 
+## Testing Support
+
+The following requires may be added to `./test/test_helper.rb` to simplify test configuration. These requires support the gem dependencies mentioned in the following section.
+
+
+```ruby
+# frozen_string_literal: true
+
+require "gemwork/test/support/simplecov"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "say"
+
+require "minitest/autorun"
+
+require "gemwork/test/support/reporters"
+require "gemwork/test/support/much_stub"
+require "gemwork/test/support/spec_dsl"
+
+# ...
+```
+
+## Gem Dependencies
+
+Gemwork depends on the following gems. None of these are actually used by Gemwork, itself, but are included for use by child gems. This is meant to ease dependency management for child gems as these things evolve over time.
+
+#### Unit Testing
+- [minitest](https://github.com/minitest/minitest)
+- [minitest-reporters](https://github.com/minitest-reporters/minitest-reporters) -- Create customizable MiniTest output formats.
+- [much-stub](https://github.com/redding/much-stub) -- Stubbing API for replacing method calls on objects in test runs.
+- [simplecov](https://github.com/simplecov-ruby/simplecov) -- Code coverage for Ruby.
+
+#### Linters
+- [reek](https://github.com/troessner/reek) -- Code smell detector for Ruby.
+- [rubocop](https://github.com/rubocop/rubocop)  -- A Ruby static code analyzer and formatter, based on the community Ruby style guide.
+- [rubocop-minitest](https://github.com/rubocop/rubocop-minitest) -- Code style checking for Minitest files.
+- [rubocop-performance](https://github.com/rubocop/rubocop-performance/) -- An extension of RuboCop focused on code performance checks.
+- [rubocop-rake](https://github.com/rubocop/rubocop-rake) -- A RuboCop plugin for Rake.
+- [yard](https://github.com/lsegal/yard) -- YARD is a Ruby Documentation tool. The Y stands for "Yay!".
+
 ## Development
 
 Development of Gemwork often requires making updates to its code and then testing them in another child gem that uses Gemwork.
@@ -84,17 +124,28 @@ Development of Gemwork often requires making updates to its code and then testin
 Even if the child gem already has the `gemwork` gem installed from RubyGems, local changes to Gemwork can be compiled and installed as a local gem, which the child gem will then immediately utilize. To facilitate this, it is recommended to add this compile/local-install step to the child gem's `bin/setup` executable:
 
 ```bash
-# ./bin/setup for your child gem:
+# Example ./bin/setup for your child gem:
 
-# ...
+#!/usr/bin/env bash
 
 # Recompile and install Gemwork locally.
-( cd ~/dev/gemwork && rake install:local )
+if [ -n "$REBUILD_GEMWORK" ]; then
+  ( cd ~/dev/gemwork && bin/setup && rake install:local )
+fi
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
 
-# The above code should be placed above this line in your bin/setup:
 bundle install
 
-# ...
+# Do any other automated setup that you need to do here
+```
+
+With the above, you can opt in to using a locally built and installed Gemwork gem from your child gem:
+
+```bash
+REBUILD_GEMWORK=1 bin/setup
 ```
 
 ### Releases

data/lib/gemwork/test/support/much_stub.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "much-stub"
+
+class Minitest::Spec
+  after do
+    MuchStub.unstub!
+  end
+end

data/lib/gemwork/test/support/reporters.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "minitest/reporters"
+
+Minitest::Test.make_my_diffs_pretty!
+
+reporter_options = { color: true }
+# Minitest::Reporters.use!(
+#   Minitest::Reporters::DefaultReporter.new(reporter_options))
+
+Minitest::Reporters.use!(
+  Minitest::Reporters::ProgressReporter.new(reporter_options))

data/lib/gemwork/test/support/simplecov.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+SimpleCov.start do
+  enable_coverage :branch
+  enable_coverage_for_eval
+  add_filter "/bin/"
+  add_filter "/test/"
+end

data/lib/gemwork/test/support/spec_dsl.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def context(...)
+  describe(...)
+end

data/lib/gemwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gemwork
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/gemwork.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "version"
-
 # Gemwork is the top-level namespace/module for this gem.
 module Gemwork
 end
+
+require "gemwork/version"

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: gemwork
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-25 00:00:00.000000000 Z
+date: 2023-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: much-stub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +175,10 @@ files:
 - LICENSE.txt
 - README.md
 - lib/gemwork.rb
+- lib/gemwork/test/support/much_stub.rb
+- lib/gemwork/test/support/reporters.rb
+- lib/gemwork/test/support/simplecov.rb
+- lib/gemwork/test/support/spec_dsl.rb
 - lib/gemwork/version.rb
 - lib/reek/.reek.yml
 - lib/rubocop/.rubocop.yml