assistant 0.0.2 → 0.1.0

data/assistant.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.description = 'Simple, composable services'
   spec.homepage = 'https://github.com/ramongr/assistant'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.6'
+  spec.required_ruby_version = '>= 3.4'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri'] = 'https://github.com/ramongr/assistant/blob/main/CODE_OF_CONDUCT.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/ramongr/assistant/blob/main/CHANGELOG.md'
   spec.metadata['homepage_uri'] = 'https://github.com/ramongr/assistant'
   spec.metadata['rubygems_mfa_required'] = 'true'
   spec.metadata['source_code_uri'] = 'https://github.com/ramongr/assistant'
@@ -33,19 +33,15 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = 'lib'
 
-  spec.add_development_dependency 'brakeman', '~> 5.2', '>= 5.2.3'
-  spec.add_development_dependency 'bundler', '~> 2.3', '>= 2.3.19'
-  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
-  spec.add_development_dependency 'colorize', '~> 0.8.1'
-  spec.add_development_dependency 'factory_bot', '~> 6.2', '>= 6.2.1'
-  spec.add_development_dependency 'fasterer', '~> 0.10.1'
-  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rspec-collection_matchers', '~> 1.2'
-  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.6.0'
-  spec.add_development_dependency 'rubocop', '~> 1.51'
-  spec.add_development_dependency 'rubocop-faker', '~> 1.1'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.17', '>= 1.17.1'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.22'
+  spec.add_development_dependency 'brakeman', '~> 8.0'
+  spec.add_development_dependency 'bundler', '~> 4.0'
+  spec.add_development_dependency 'byebug', '~> 13.0'
+  spec.add_development_dependency 'colorize', '~> 1.1'
+  spec.add_development_dependency 'fasterer', '~> 0.11.0'
+  spec.add_development_dependency 'minitest', '~> 5.25'
+  spec.add_development_dependency 'rake', '~> 13.4'
+  spec.add_development_dependency 'rubocop', '~> 1.86'
+  spec.add_development_dependency 'rubocop-minitest', '~> 0.39'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.26'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.7'
 end

data/lib/assistant/input_builder.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'assistant/refinements/string_blankness'
+
+module Assistant
+  # This module has the building blocks for the input validation.
+  # The building blocks of listing inputs with the #input and #inputs methods
+  # and the building blocks of validating inputs with the methods that are called within those methods.
+  module InputBuilder
+    using Assistant::Refinements::StringBlankness
+
+    # Lists all inputs that have the same type and options.
+    def inputs(attr_names, type:, **)
+      attr_names.each do |attr_name|
+        input(attr_name, type:, **)
+      end
+    end
+
+    # Individual input with a specific type or options
+    def input(attr_name, type:, **options)
+      # Base Methods
+      input_getter_meth(attr_name)
+      input_checker_meth(attr_name)
+
+      # Input type validation method, simple and conditional requirement validation methods
+      input_type_validator_meth(attr_name, type)
+      input_require_validator_meth(attr_name, **options) if options[:required] == true
+      input_require_conditional_meth(attr_name, **options) if options[:required] == true && options[:if]
+    end
+
+    def input_getter_meth(attr_name)
+      define_method(attr_name) do
+        @inputs[attr_name]
+      end
+    end
+
+    def input_checker_meth(attr_name)
+      define_method("#{attr_name}?") do
+        val = @inputs[attr_name]
+        return false if val.nil? || val == false
+        return !val.whitespace? if val.is_a?(String)
+
+        val.respond_to?(:empty?) ? !val.empty? : true
+      end
+    end
+
+    def input_require_validator_meth(attr_name, **options)
+      define_method("valid_require_#{attr_name}?") do |log = true|
+        return true if options[:required] == true && send("#{attr_name}?") == true
+
+        log && send(
+          :log_item_error_initialize, attr_name:, message: "Service is missing argument with name #{attr_name}"
+        )
+        false
+      end
+    end
+
+    def input_require_conditional_meth(attr_name, **options)
+      define_method("valid_require_conditional_#{attr_name}?") do
+        return false if send("valid_require_#{attr_name}?", false) == false
+        return true if options[:if].call(send(attr_name))
+
+        send(
+          :log_item_error_initialize,
+          attr_name:, message: "Service argument conditional requirement not met properly for #{attr_name}"
+        )
+        false
+      end
+    end
+
+    def input_type_validator_meth(attr_name, type)
+      define_method("valid_type_#{attr_name}?") do
+        return true if @inputs[attr_name].is_a?(type)
+
+        send("#{attr_name}?") &&
+          send(
+            :log_item_error_initialize,
+            attr_name:, message: "Service argument with name #{attr_name} is not a #{type} but #{send(attr_name).class}"
+          )
+        false
+      end
+    end
+  end
+end

data/lib/assistant/log_item.rb

@@ -20,7 +20,7 @@ module Assistant
     end
 
     def item
-      { level: level, source: source, detail: detail, message: message, trace: trace }
+      { level:, source:, detail:, message:, trace: }
     end
 
     VALID_LEVELS.each do |valid_level|

data/lib/assistant/log_list.rb

@@ -4,13 +4,19 @@ module Assistant
   # Service level list of logs
   module LogList
     def add_log(level:, source:, detail:, message:, trace: nil)
-      @logs << Assistant::LogItem.new(level: level, source: source, detail: detail, message: message, trace: trace)
+      @logs << Assistant::LogItem.new(level:, source:, detail:, message:, trace:)
     end
 
     def merge_logs(other_logs)
       @logs.concat(other_logs)
     end
 
+    # Convenience used by InputBuilder-generated validators to record an
+    # initialization-time error for a specific input attribute.
+    def log_item_error_initialize(attr_name:, message:)
+      @logs << Assistant::LogItem.new(detail: attr_name, level: :error, message:, source: :initialize)
+    end
+
     ::Assistant::LogItem::VALID_LEVELS.each do |level|
       define_method("#{level}s") do
         @logs.select { |log| log.send("#{level}?") }

data/lib/assistant/refinements/string_blankness.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Assistant
+  module Refinements
+    # Refines String with `#whitespace?`, true when a string is empty or
+    # contains only whitespace characters. Used by `InputBuilder` validators
+    # to treat whitespace-only strings as missing input without depending on
+    # ActiveSupport's `String#blank?`.
+    module StringBlankness
+      refine String do
+        # True when the string is empty or contains only whitespace.
+        def whitespace?
+          strip.empty?
+        end
+      end
+    end
+  end
+end

data/lib/assistant/service.rb

@@ -1,31 +1,62 @@
 # frozen_string_literal: true
 
+require_relative 'input_builder'
+require_relative 'log_list'
+
 module Assistant
   # Base class for the Assistant gem
   class Service
-    include ::Assistant::LogList
+    include LogList
 
     class << self
-      def run(*args)
-        new(*args).run
+      include InputBuilder
+
+      def run(**)
+        new(**).run
       end
     end
 
-    def initialize(*args)
+    def initialize(**args)
       @inputs = args
       @logs = []
     end
 
     def run
+      validate_inputs
       validate
-      { result: execute, status: status, warnings: warnings } if errors.empty?
+
+      if errors.empty?
+        { result:, status:, warnings: }
+      else
+        { errors:, result: nil, status: :with_errors }
+      end
+    end
+
+    def result
+      @result ||= execute
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def failure?
+      errors.any?
     end
 
     def status
       warnings.empty? ? :ok : :with_warnings
     end
 
-    protected
+    private
+
+    def validate_inputs
+      methods.grep(/valid_(require|type|require_conditional)_\w+\?$/).each do |validation_method|
+        send(validation_method)
+      end
+    end
+
+    attr_reader :inputs
 
     def execute; end
 

data/lib/assistant/service.rbs

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Assistant::Service
+
+end

data/lib/assistant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Assistant
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/assistant.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'assistant/log_item'
-require 'assistant/log_list'
 require 'assistant/service'
 require 'assistant/version'
 

data/mise.toml

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: assistant
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Ramon Rodrigues
-autorequire: 
 bindir: bin
 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
@@ -16,246 +15,154 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: '8.0'
   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
+        version: '8.0'
 - !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
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.1
-- !ruby/object:Gem::Dependency
-  name: factory_bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.2.1
+        version: '1.1'
   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: '1.1'
 - !ruby/object:Gem::Dependency
   name: fasterer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '5.25'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '13.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '13.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.51'
+        version: '1.86'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.51'
+        version: '1.86'
 - !ruby/object:Gem::Dependency
-  name: rubocop-faker
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.39'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: '1.26'
   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: '1.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '0.7'
 description: Simple, composable services
 email:
 - cerberus.ramon@gmail.com
@@ -263,14 +170,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".editorconfig"
 - ".fasterer.yml"
 - ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
-- ".rspec"
+- ".markdownlint.json"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -282,20 +192,23 @@ files:
 - bin/setup
 - bin/version
 - lib/assistant.rb
+- lib/assistant/input_builder.rb
 - lib/assistant/log_item.rb
 - lib/assistant/log_list.rb
+- lib/assistant/refinements/string_blankness.rb
 - lib/assistant/service.rb
+- lib/assistant/service.rbs
 - lib/assistant/version.rb
+- mise.toml
 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
+  changelog_uri: https://github.com/ramongr/assistant/blob/main/CHANGELOG.md
   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 +216,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.6
 specification_version: 4
 summary: Simple, soft fail enabled, composable services
 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/.rspec

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