assistant 0.0.2 → 1.0.0.rc1

data/lib/assistant/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 module Assistant
-  VERSION = '0.0.2'
+  # Semantic version of the `assistant` gem. Follows the semver contract
+  # documented in `docs/v1/01-api-surface.md` from 1.0.0 onward.
+  #
+  # @return [String]
+  VERSION = '1.0.0.rc1'
 end

data/lib/assistant/version.rbs

@@ -0,0 +1,5 @@
+# Type signatures for `lib/assistant/version.rb`. See docs/v1/01-api-surface.md.
+
+module Assistant
+  VERSION: String
+end

data/lib/assistant.rb

@@ -1,10 +1,59 @@
 # frozen_string_literal: true
 
+# Predeclare the namespace shells that multi-segment files
+# (`module Assistant::Refinements::StringBlankness`, etc.) need to exist
+# before they load, and declare the M-S3 instrumentation notifier
+# accessor. Two sibling submodules in one wrapper avoid the
+# `Style/CompactModuleNesting` single-child collapse trigger.
+module Assistant
+  # M-S3: frozen no-op default notifier. Identity-compared by
+  # `Assistant.notifier=` so callers can detect the unconfigured state
+  # if they ever need to. See docs/v1/02-features.md (M-S3) and
+  # docs/v1/01-api-surface.md.
+  DEFAULT_NOTIFIER = ->(_event, _payload) {}
+  DEFAULT_NOTIFIER.freeze
+
+  # Namespace for the InputBuilder DSL and its submodules. Populated by
+  # `lib/assistant/input_builder*.rb`.
+  module InputBuilder; end
+
+  # Namespace for refinements bundled with the gem (`Refinements::*`).
+  module Refinements; end
+
+  @notifier = DEFAULT_NOTIFIER
+
+  class << self
+    # Reader for the configured instrumentation callable. Always returns
+    # a callable; returns `DEFAULT_NOTIFIER` when never assigned or when
+    # explicitly reset with `Assistant.notifier = nil`.
+    attr_reader :notifier
+
+    # Writer for the instrumentation callable. Accepts any object
+    # responding to `#call(event, payload)`, or `nil` to reset to the
+    # built-in no-op default. Anything else raises `ArgumentError`
+    # immediately so misconfiguration surfaces at boot rather than at
+    # the first service run.
+    def notifier=(callable)
+      @notifier =
+        if callable.nil?
+          DEFAULT_NOTIFIER
+        elsif callable.respond_to?(:call)
+          callable
+        else
+          raise ArgumentError,
+                "Assistant.notifier= expected nil or an object responding to #call, got #{callable.inspect}"
+        end
+    end
+  end
+end
+
+# Core building blocks for the Assistant gem. Listed alphabetically so the
+# top-level entry point exposes every public constant after a bare
+# `require "assistant"` (M6).
+require 'assistant/execute_callbacks'
+require 'assistant/input_builder'
 require 'assistant/log_item'
 require 'assistant/log_list'
+require 'assistant/refinements/string_blankness'
 require 'assistant/service'
 require 'assistant/version'
-
-# Main Assistant lib entry point
-module Assistant
-end

data/lib/assistant.rbs

@@ -0,0 +1,25 @@
+# Type signatures for `lib/assistant.rb` — declares the top-level
+# `Assistant` namespace, the empty namespace shells for
+# `Assistant::InputBuilder` and `Assistant::Refinements` that the
+# multi-segment submodule files reopen, and the M-S3 instrumentation
+# notifier accessor. See docs/v1/01-api-surface.md.
+
+module Assistant
+  # M-S3: instrumentation notifier. The setter accepts any object
+  # responding to `#call(event, payload)` or `nil` (reset to default).
+  # The contract is documented in docs/v1/01-api-surface.md; we use
+  # `untyped` for the setter parameter because the runtime check is
+  # `respond_to?(:call)` rather than a structural Proc type.
+  DEFAULT_NOTIFIER: ^(Symbol, Hash[Symbol, untyped]) -> void
+
+  self.@notifier: ^(Symbol, Hash[Symbol, untyped]) -> void
+
+  def self.notifier: () -> ^(Symbol, Hash[Symbol, untyped]) -> void
+  def self.notifier=: (untyped callable) -> ^(Symbol, Hash[Symbol, untyped]) -> void
+
+  module InputBuilder
+  end
+
+  module Refinements
+  end
+end

data/mise.toml

@@ -0,0 +1,6 @@
+[tools]
+opencode="latest"
+ruby="3.4"
+gh="latest"
+node="latest"
+npm="latest"

data/sig/examples/greeter.rbs

@@ -0,0 +1,14 @@
+# Generated by assistant-rbs; do not edit.
+
+module Examples
+  class Greeter < Assistant::Service
+
+    def name: () -> String
+    def name?: () -> bool
+    def age: () -> (Integer | Float)
+    def age?: () -> bool
+    def nickname: () -> String?
+    def nickname?: () -> bool
+
+  end
+end

metadata

@@ -1,301 +1,318 @@
 --- !ruby/object:Gem::Specification
 name: assistant
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Ramon Rodrigues
-autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: brakeman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.19
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.19
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.1.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.1.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: fasterer
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '13.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: '13.4'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.86'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 1.86.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.86'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 1.86.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.39'
 - !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1.26'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.51'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.51'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rubocop-faker
+  name: rubocop-style-compact_nesting
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: steep
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
-description: Simple, composable services
+        version: '0.9'
+description: |
+  Assistant is a tiny, dependency-free Ruby library for writing soft-fail,
+  composable service objects. A service declares its inputs, validates
+  them, runs its body, and returns a uniform result that always carries
+  either a value plus warnings or a list of errors — never raising for
+  expected failures. Ships with RBS signatures, a 1.0-frozen public API,
+  and zero runtime gem dependencies.
 email:
 - cerberus.ramon@gmail.com
-executables: []
+executables:
+- assistant-rbs
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".fasterer.yml"
+- ".editorconfig"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/docs.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
-- ".rspec"
+- ".markdownlint.json"
+- ".opencode/.gitignore"
+- ".opencode/opencode.json"
+- ".opencode/skills/create-pr/SKILL.md"
+- ".opencode/skills/ruby-services/SKILL.md"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
+- Steepfile
+- _config.yml
 - assistant.gemspec
 - bin/console
 - bin/setup
 - bin/version
+- docs/api-reference.md
+- docs/changelog.md
+- docs/deprecations.md
+- docs/examples/cli-handler.md
+- docs/examples/composing-services.md
+- docs/examples/execute-callbacks.md
+- docs/examples/index.md
+- docs/examples/instrumentation-notifier.md
+- docs/examples/rails-service.md
+- docs/examples/rbs-generator.md
+- docs/examples/sidekiq-worker.md
+- docs/getting-started.md
+- docs/guides/composing-services.md
+- docs/guides/index.md
+- docs/guides/inputs.md
+- docs/guides/logging-and-results.md
+- docs/guides/rbs-and-types.md
+- docs/guides/validation.md
+- docs/index.md
+- docs/roadmap.md
+- exe/assistant-rbs
 - lib/assistant.rb
+- lib/assistant.rbs
+- lib/assistant/execute_callbacks.rb
+- lib/assistant/execute_callbacks.rbs
+- lib/assistant/input_builder.rb
+- lib/assistant/input_builder.rbs
+- lib/assistant/input_builder/accessors.rb
+- lib/assistant/input_builder/accessors.rbs
+- lib/assistant/input_builder/default_option.rb
+- lib/assistant/input_builder/default_option.rbs
+- lib/assistant/input_builder/dsl.rb
+- lib/assistant/input_builder/dsl.rbs
+- lib/assistant/input_builder/optional_option.rb
+- lib/assistant/input_builder/optional_option.rbs
+- lib/assistant/input_builder/registry.rb
+- lib/assistant/input_builder/registry.rbs
+- lib/assistant/input_builder/require_validator.rb
+- lib/assistant/input_builder/require_validator.rbs
+- lib/assistant/input_builder/type_validator.rb
+- lib/assistant/input_builder/type_validator.rbs
 - lib/assistant/log_item.rb
+- lib/assistant/log_item.rbs
 - lib/assistant/log_list.rb
+- lib/assistant/log_list.rbs
+- lib/assistant/rbs_generator.rb
+- lib/assistant/rbs_generator.rbs
+- lib/assistant/rbs_generator/cli.rb
+- lib/assistant/rbs_generator/cli.rbs
+- lib/assistant/rbs_generator/renderer.rb
+- lib/assistant/rbs_generator/renderer.rbs
+- lib/assistant/rbs_generator/writer.rb
+- lib/assistant/rbs_generator/writer.rbs
+- lib/assistant/refinements/string_blankness.rb
+- lib/assistant/refinements/string_blankness.rbs
 - lib/assistant/service.rb
+- lib/assistant/service.rbs
 - lib/assistant/version.rb
+- lib/assistant/version.rbs
+- mise.toml
+- sig/examples/greeter.rbs
 homepage: https://github.com/ramongr/assistant
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/ramongr/assistant/blob/main/CODE_OF_CONDUCT.md
+  bug_tracker_uri: https://github.com/ramongr/assistant/issues
+  changelog_uri: https://github.com/ramongr/assistant/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/assistant
   homepage_uri: https://github.com/ramongr/assistant
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/ramongr/assistant
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -303,15 +320,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
-summary: Simple, soft fail enabled, composable services
+summary: Tiny, dependency-free soft-fail service objects for Ruby
 test_files: []

data/.circleci/config.yml

@@ -1,45 +0,0 @@
----
-version: 2.1 # Use 2.1 to enable using orbs and other features.
-
-commands:
-  install_ruby_deps:
-    steps:
-      - checkout
-      - ruby/install-deps:
-            key: gems-v1
-
-orbs:
-  ruby: circleci/ruby@2.0.0
-executors:
-  ruby-executor:
-    working_directory: ~/assistant
-    docker:
-      - image: cimg/ruby:2.7.6
-jobs:
-  build-ruby:
-    executor: ruby-executor
-    steps:
-      - install_ruby_deps
-  ruby-unit-test:
-    executor: ruby-executor
-    steps:
-      - install_ruby_deps
-      - run:
-          name: Run Unit Tests
-          command: bundle exec rspec
-  rubocop-check:
-    executor: ruby-executor
-    steps:
-      - install_ruby_deps
-      - ruby/rubocop-check
-
-workflows:
-  build_check_and_test:
-    jobs:
-      - build-ruby
-      - ruby-unit-test:
-          requires:
-            - build-ruby
-      - rubocop-check:
-          requires:
-            - build-ruby

data/.fasterer.yml

@@ -1,19 +0,0 @@
-speedups:
-  rescue_vs_respond_to: true
-  module_eval: true
-  shuffle_first_vs_sample: true
-  for_loop_vs_each: true
-  each_with_index_vs_while: false
-  map_flatten_vs_flat_map: true
-  reverse_each_vs_reverse_each: true
-  select_first_vs_detect: true
-  select_last_vs_reverse_detect: true
-  sort_vs_sort_by: true
-  fetch_with_argument_vs_block: true
-  keys_each_vs_each_key: true
-  hash_merge_bang_vs_hash_brackets: true
-  block_vs_symbol_to_proc: true
-  proc_call_vs_yield: true
-  gsub_vs_tr: true
-  getter_vs_attr_reader: true
-  setter_vs_attr_writer: true

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper