greeter-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10cbecb382247a62f7cec751c68d49bc5e9941da3b6cf58c4d448482aadd87c7
+  data.tar.gz: fdac9d0b4b33236ea3889f4cc224302df79a6438b6b0457619178b42f19b3239
+SHA512:
+  metadata.gz: 0b77ea8cef0e5a30ca2d7dcc696ee15e45f29ff23f51255f2dd66fd7b8bb794752bfba1d1eef0ce2fd004959c3cac2988975aa6726c0ae0fd70e3074754be10f
+  data.tar.gz: aea155eab6deb79fc3ab453e5d8f667415c042072ec726a7850417ee746682e94bd10aa71ad3e987ed5b6a810ccfbb6d9aec4c280d96476aefeff6fc5f39c36a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Adam Bonsu
+
+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,117 @@
+# greeter-core
+
+Pure domain core and ports for the Greeter application.
+
+## Usage
+```ruby
+require 'greeter/core'
+
+clock    = my_clock # any object responding to #now
+service  = Greeter::Core::Domain::GreetingService.new(clock: clock)
+greeting = service.greet('alice')
+greeting.guest_name.display # => "Alice"
+```
+
+## Testing helpers
+```ruby
+require 'greeter/core/testing'
+clock = Greeter::Core::Testing::FixedClock.new
+```
+
+## Install, verify, commit
+### from greeter-core root
+`bundle install`
+
+### domain + ports + testing specs
+`bundle exec rspec`
+
+### lint
+`bundle exec rubocop`
+
+### smoke-test the packaged load path resolves and behaves
+`bundle exec ruby -Ilib -e "require 'greeter/core'; puts Greeter::Core::Domain::GuestName.new('alice bonsu').display" # => Alice Bonsu
+
+## confirm the gem builds cleanly
+gem build greeter-core.gemspec
+
+
+## Publishing to RubyGems.org
+
+The `publish` job in `.github/workflows/ci.yml` publishes the gem to
+[rubygems.org](https://rubygems.org). It runs **only when a version tag is
+pushed** (a tag matching `v*`, e.g. `v0.1.0`) and **only after** the `spec`,
+`lint`, and `perf` jobs pass.
+
+Publishing uses RubyGems **trusted publishing** (OIDC): GitHub Actions proves its
+identity to RubyGems and receives a short-lived, single-use API key at run time.
+No long-lived RubyGems API key is stored in GitHub.
+
+### 1. Create the RubyGems account (one time)
+
+- Sign up / sign in at <https://rubygems.org>.
+- Enable MFA on the account (RubyGems requires it for publishing).
+
+### 2. Reserve the gem name (first release only)
+
+Trusted publishing can only be configured on a gem that already exists on
+rubygems.org. For the very first `0.1.0` release, do a one-time manual push from
+your machine so the name is registered:
+
+```bash
+gem build greeter-core.gemspec
+gem push greeter-core-0.1.0.gem   # prompts for RubyGems credentials + MFA
+```
+
+After that, all future releases go through the automated workflow below.
+
+### 3. Configure trusted publishing on RubyGems (one time)
+
+On rubygems.org, open the gem page → **Trusted publishers** → **Create**, and add
+a GitHub Actions publisher matching this repo and workflow:
+
+| Field | Value |
+| --- | --- |
+| Repository owner | your GitHub username/org |
+| Repository name | `greeter-core` |
+| Workflow filename | `ci.yml` |
+| Environment | `rubygems` |
+
+The **Environment** must match the `environment: rubygems` set on the `publish`
+job in the workflow.
+
+### 4. Create the matching GitHub environment (one time)
+
+In the GitHub repo: **Settings → Environments → New environment**, name it
+`rubygems`. No secrets are needed — trusted publishing supplies the credential.
+Optionally add a **deployment protection rule** (e.g. required reviewer, or
+restrict to tags matching `v*`) so releases require approval.
+
+There are **no repository secrets to add** for publishing.
+
+### 5. Release a new version
+
+1. Bump `VERSION` in `lib/greeter/core/version.rb` (the workflow fails if the tag
+   and gem version disagree).
+2. Commit and push to your default branch.
+3. Tag and push the tag:
+
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+
+The `publish` job runs after the test/lint/perf gate and publishes
+`greeter-core-<version>` to rubygems.org via trusted publishing.
+
+### Consuming the published gem
+
+Because it's public on rubygems.org, no special configuration is needed:
+
+```ruby
+# Gemfile
+gem "greeter-core"
+```
+
+```bash
+gem install greeter-core
+```

data/lib/greeter/core/domain/greeting.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    module Domain
+      class Greeting
+        attr_reader :guest_name, :greeted_at
+
+        def initialize(guest_name:, greeted_at:)
+          @guest_name = guest_name
+          @greeted_at = greeted_at
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/domain/greeting_service.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'greeter/core/domain/guest_name'
+require 'greeter/core/domain/greeting'
+
+module Greeter
+  module Core
+    module Domain
+      class GreetingService
+        def initialize(clock:)
+          @clock = clock
+        end
+
+        def greet(raw_name)
+          Greeting.new(
+            guest_name: GuestName.new(raw_name),
+            greeted_at: @clock.now
+          )
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/domain/guest_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    module Domain
+      class InvalidGuestName < ArgumentError; end
+
+      class GuestName
+        MAX_LENGTH = 64
+
+        attr_reader :display
+
+        def initialize(raw)
+          validate_characters!(raw.to_s)
+          stripped = raw.to_s.strip
+          validate_content!(stripped)
+          @display = titlecase(stripped)
+          freeze
+        end
+
+        def ==(other)
+          other.is_a?(GuestName) && display == other.display
+        end
+
+        private
+
+        def validate_characters!(value)
+          raise InvalidGuestName, 'Name contains invalid characters' if value.match?(/[\x00-\x1F\x7F]/)
+        end
+
+        def validate_content!(value)
+          raise InvalidGuestName, 'Name must not be empty' if value.empty?
+          raise InvalidGuestName, "Name must not exceed #{MAX_LENGTH} characters" if value.length > MAX_LENGTH
+        end
+
+        def titlecase(value)
+          value.split.map(&:capitalize).join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/ports/clock.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    module Ports
+      class Clock
+        def now
+          raise NotImplementedError, "#{self.class}#now is not implemented"
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/ports/greeting_presenter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    module Ports
+      class GreetingPresenter
+        def present(_greeting)
+          raise NotImplementedError, "#{self.class}#present is not implemented"
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/testing/fake_clock.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    module Testing
+      class FakeClock
+        def initialize(time)
+          @time = time
+        end
+
+        def now
+          @time
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/testing/fixed_clock.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    module Testing
+      class FixedClock
+        def initialize(time = Time.utc(2024, 6, 1, 9, 0, 0))
+          @time = time
+        end
+
+        def now
+          @time
+        end
+      end
+    end
+  end
+end

data/lib/greeter/core/testing.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Opt-in test doubles for consumers of greeter-core.
+# Not loaded by `require 'greeter/core'` so production stays I/O-free.
+require 'greeter/core/testing/fake_clock'
+require 'greeter/core/testing/fixed_clock'

data/lib/greeter/core/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Greeter
+  module Core
+    VERSION = '0.1.0'
+  end
+end

data/lib/greeter/core.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'greeter/core/version'
+
+# Ports (interfaces)
+require 'greeter/core/ports/clock'
+require 'greeter/core/ports/greeting_presenter'
+
+# Domain (value objects + use case)
+require 'greeter/core/domain/guest_name'
+require 'greeter/core/domain/greeting'
+require 'greeter/core/domain/greeting_service'
+
+module Greeter
+  module Core
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: greeter-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Bonsu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-28 00:00:00.000000000 Z
+dependencies: []
+description: Framework-agnostic domain logic (GuestName, Greeting, GreetingService)
+  and driving/driven ports for Greeter, with in-memory test doubles under Greeter::Core::Testing.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/greeter/core.rb
+- lib/greeter/core/domain/greeting.rb
+- lib/greeter/core/domain/greeting_service.rb
+- lib/greeter/core/domain/guest_name.rb
+- lib/greeter/core/ports/clock.rb
+- lib/greeter/core/ports/greeting_presenter.rb
+- lib/greeter/core/testing.rb
+- lib/greeter/core/testing/fake_clock.rb
+- lib/greeter/core/testing/fixed_clock.rb
+- lib/greeter/core/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Pure domain core and ports for the Greeter application.
+test_files: []