asciisourcerer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ed8f8523d54a5f1627241552ea3ed79513e7721d4b615622f37c149f797b236
-  data.tar.gz: 8a926eac14aa811b7b573bd61cd5eb209900fa77551c5330c4581133148a3faa
+  metadata.gz: abee321c7941006227f85f6a006a9b6ea795f8bcfd0e5c3a5837b11400e43a23
+  data.tar.gz: 92dc5d0bfb4435f1d1a42a558ed1aa975d297aff3201a4cd40266da21e86f816
 SHA512:
-  metadata.gz: 5467d009399728b3e251ee96cace5279a99c27aa5eaa45605dddbdd10ec2758da39e741212fb9d193db9480ad7029d429150832c8d33391839e5fa2ad719e38d
-  data.tar.gz: c592774a5427067c102ade751fbbc8e77e899afec0d327bce0ae8a2c0101d684f0b27e818f778fa4a065a93a756bb887e976d1e7352ba1eae21a8bbb6cd9fd96
+  metadata.gz: 70c932c2a7875d27cec949952bc413dce9c240fe19f8fabbcd756bfa1c94d970d0d9d217538d68c2fb7325b4040dc9cae4ad71fa4c595ab89a8ffa6b650aab1d
+  data.tar.gz: 39b7c3e368ed5149012f4e07d6c33809d6b11e5e82e75f8562ab5edae9fde98b32928407801cdd6941951d375ac488c008b2857d3378a2115c4767b398194f1a

data/README.adoc

@@ -39,7 +39,7 @@ endif::[]
 :this_prod_vrsn_major: 0
 :this_prod_vrsn_minor: 2
 :this_prod_vrsn_majmin: {this_prod_vrsn_major}.{this_prod_vrsn_minor}
-:this_prod_vrsn_patch: 0
+:this_prod_vrsn_patch: 1
 :this_prod_vrsn: {this_prod_vrsn_majmin}.{this_prod_vrsn_patch}
 :next_prod_vrsn: 0.3.0
 // end::global-settings[]
@@ -482,7 +482,7 @@ Merges a user-supplied list into a default list using `+`/`-` amendment tokens.
 .Require
 [source,ruby]
 ----
-require 'sourcerer/util/list_amendment'
+require 'sourcerer/util/list_amend'
 ----
 
 .API
@@ -545,15 +545,15 @@ result = Sourcerer::Util::Pathifier.match(input, recursive: true, include_dirs:
 ----
 
 Classification rules::
-  `:file`:::    `File.file?(input)` is true.
-  `:dir`:::     `File.directory?(input)` is true.
-  `:glob`:::    Input contains glob metacharacters (`* ? [ ] { }`).
-  `:missing`::: None of the above.
+`:file`:::    `File.file?(input)` is true.
+`:dir`:::     `File.directory?(input)` is true.
+`:glob`:::    Input contains glob metacharacters (`* ? [ ] { }`).
+`:missing`::: None of the above.
 
 Options::
-  `recursive`:::       Traverse directories recursively via `Find.find` (default: `true`).
-  `include_dirs`:::    Also yield directory paths during traversal (default: `false`).
-  `follow_symlinks`::: Follow symlink directories during recursion (default: `false`).
+`recursive`:::       Traverse directories recursively via `Find.find` (default: `true`).
+`include_dirs`:::    Also yield directory paths during traversal (default: `false`).
+`follow_symlinks`::: Follow symlink directories during recursion (default: `false`).
 
 .Examples
 [source,ruby]
@@ -669,18 +669,24 @@ The link:{docopslab_src_www_url}/lab/tree/main/gems/docopslab-dev/README.adoc[Do
 === API Design
 
 The API is designed to be stable and backward-compatible, with a clear deprecation path for any breaking changes.
-The top-level `Sourcerer.*` methods are deprecated in favor of direct namespace usage (`Sourcerer::Yaml`, `Sourcerer::AsciiDoc`, `Sourcerer::Rendering`, `Sourcerer::Sync`), which will be removed in version 1.0.
+The top-level `Sourcerer.*` methods are deprecated in favor of direct namespace usage (`Sourcerer::Yaml`, `Sourcerer::AsciiDoc`, `Sourcerer::Rendering`), which will be removed in version 1.0.
 
 Do not add new public methods directly to the `Sourcerer` namespace;
 instead, add them to the appropriate submodule.
 
-Ruby API shape policy::
+[[api-shape-policy]]
+==== Ruby API shape policy
+
 Use singleton methods (`def self.*`) on namespace modules for stateless primitives.
+
 Use classes when behavior is naturally stateful or lifecycle-driven.
+
 Use mixin modules for host-integration surfaces (for example, Liquid filters/tags) where the host expects instance methods.
-For mixin modules, keep public entrypoints as thin wrappers and place transformation logic in an internal helper module/object.
+Keep public entrypoints as thin wrappers and place transformation logic in an internal helper module/object.
+
+[[visibility-policy]]
+==== Visibility policy
 
-Visibility policy::
 Use `private_class_method` for singleton helper methods defined with `def self.*`.
 Use `private` for instance helper methods in classes or mixins.
 Avoid exporting helper methods as accidental public API.
@@ -705,6 +711,36 @@ Run the PR/CI test suite:
 [.prompt]
  bundle exec rake pr_test
 
+[[release-process]]
+=== Release Process and History
+
+AsciiSourcerer is intended to be the most primal gem in the DocOps Lab pool.
+As such, its development is less formal.
+
+Each release is tested against all downstream gems and tools, but we are somewhat less formal about issue tracking and development branch management, at least in early stages.
+
+Standard release flow:
+
+. Update version in `lib/sourcerer/version.rb` and `README.adoc` attributes.
+
+. Commit to Git.
+
+. Push to GitHub.
+
+. Run `./scripts/build.sh` to validate the environment, run tests, and build the gem file to `pkg/`.
+
+. Publish to RubyGems. 
++
+ RUBYGEMS_API_KEY=<rubygems.org key> ./scripts/publish.sh
+
+. Tag the release in Git:
++
+[.prompt,subs=+attributes]
+ git tag v{this_prod_vrsn} && git push origin v{this_prod_vrsn}`.
+
+[NOTE]
+AsciiSourcerer does not yet publish a release history document.
+
 
 [[legal]]
 == Legal

data/lib/sourcerer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sourcerer
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciisourcerer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - DocOps Lab