hotstepper 0.1.0

data/lib/hotstepper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "boot/setup"
+
+module Hotstepper
+  extend Dry::Configurable
+
+  # @abstract
+  class Error < StandardError; end
+
+  class MissingDatabaseConnectionClassError < Error
+    def initialize
+      super("Database connection class not configured. Please set `Hotstepper.config.db.connection_class` to your application's database connection class, e.g. `ActiveRecord::Base`.")
+    end
+  end
+
+  # Raised when the common container is not configured.
+  class MissingCommonContainerError < Error
+    def initialize
+      super("Container not configured. Please set `Hotstepper.config.common.container` to your application's container.")
+    end
+  end
+
+  class << self
+    def loader
+      @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|
+        loader.ignore("#{__dir__}/boot")
+        loader.ignore("#{__dir__}/generators")
+        loader.ignore("#{__dir__}/tasks")
+        loader.ignore("#{__dir__}/testing")
+        loader.do_not_eager_load("#{__dir__}/hotstepper/testing")
+      end
+    end
+  end
+
+  loader.setup
+
+  setting :common do
+    setting :container
+  end
+
+  setting :db do
+    setting :connection_class, default: ActiveRecord::Base, constructor: ->(klass) { ::Hotstepper::Support::Types::DatabaseConnectionClass[klass] }
+  end
+end
+
+require_relative "../app/validators/unique_items_validator"
+require "hotstepper/typespace"
+require "hotstepper/monadic"
+require "hotstepper/support/types"
+require "hotstepper/operation"
+require "hotstepper/service"
+require "hotstepper/struct"
+require "hotstepper/typing"
+require "hotstepper/version"
+require "hotstepper/engine"

data/lib/tasks/hotstepper_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :hotstepper do
+#   # Task goes here
+# end

data/lib/testing/contexts/operations.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "hotstepper/testing/operations"
+
+RSpec.shared_context "an operation" do
+  subject(:operation) { described_class.new }
+end
+
+RSpec.configure do |config|
+  config.include Hotstepper::Testing::Operations::ExampleHelpers, type: :operation
+
+  config.include_context "an operation", type: :operation
+end

data/lib/testing/matchers/00_disable_with.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# ActiveSupport 7.1 introduces an aggrsessively annoying new monkeypatch
+# on Object called `with`. This conflicts with methods that we use.
+
+begin
+  RSpec::Matchers::MatcherDelegator.undef_method(:with)
+rescue StandardError
+  nil
+end
+
+begin
+  RSpec::Matchers::DSL::Matcher.undef_method(:with)
+rescue StandardError
+  nil
+end
+
+begin
+  RSpec::Matchers::BuiltIn::BaseMatcher.undef_method(:with)
+rescue StandardError
+  nil
+end

data/lib/testing/matchers/dry_validation.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_validation_error do
+  match do |actual|
+    next false unless actual.kind_of?(Dry::Validation::Result)
+
+    @actual = @result = actual
+
+    @errors = actual.errors.to_h
+
+    failure? && error_on_path? && message_matches?
+  end
+
+  chain :on do |*path|
+    case path
+    in [String]
+      @path = Dry::Schema::Path[path.first]
+    else
+      @path = Dry::Schema::Path[path]
+    end
+  end
+
+  chain :with_message, :message
+
+  chain :with_scope, :scope
+
+  def failure? = @result.kind_of?(Dry::Validation::Result) && @result.failure?
+
+  def error_on_path? = @path.blank? || @result.error?(@path)
+
+  def message_matches?
+    # :nocov:
+    return true if @message.blank?
+    # :nocov:
+
+    @matcher = derive_message_matcher
+
+    @messages = derive_messages
+
+    @messages.any?(&@matcher)
+  end
+
+  def derive_messages
+    if @path.blank?
+      # :nocov:
+      @result.errors.to_h.values.flatten
+      # :nocov:
+    else
+      @result.errors.to_h.dig(*@path.to_a) || []
+    end
+  end
+
+  def derive_message_matcher
+    @scope ||= "dry_validation.errors"
+
+    case @message
+    when Symbol
+      transliterated = I18n.t(@message, scope: @scope, raise: true)
+
+      ->(msg) { msg == transliterated }
+    when Regexp
+      # :nocov:
+      ->(msg) { msg.match?(@message) }
+      # :nocov:
+    else
+      # :nocov:
+      ->(msg) { msg == @message }
+      # :nocov:
+    end
+  end
+
+  failure_message do |actual|
+    [].tap do |parts|
+      case @result
+      when Dry::Validation::Result
+        parts << "expected the result to be a failure"
+
+        if @result.failure?
+          # :nocov:
+          parts << " with an error at #{@path.keys.inspect}" if @path.present?
+
+          parts << " with a message matching #{message.inspect}" if message.present?
+          # :nocov:
+
+          parts << ", errors were: #{@errors.inspect}"
+        else
+          parts << ", but it was a success."
+        end
+      else
+        parts << "expected a Dry::Validation::Result, got #{@result.class}"
+      end
+    end.join
+  end
+end

data/lib/testing/matchers/monadic.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :be_a_monadic_success do
+  match do |actual|
+    # Handle dry-validation, dry-types pseudo-monads.
+    actual.then do |v|
+      # :nocov:
+      monadic_result = v.to_monad.try(:to_result)
+
+      @actual = monadic_result if monadic_result.kind_of?(Dry::Monads::Result)
+      # :nocov:
+    end if actual.respond_to?(:to_monad)
+
+    @actual ||= actual
+
+    next false unless @actual.kind_of?(Dry::Monads::Result)
+
+    if @actual.success? && instance_variable_defined?(:@expected_value)
+      values_match? @expected_value, @actual.value!
+    else
+      @actual.success?
+    end
+  end
+
+  chain :with do |value|
+    @expected_value = value
+  end
+
+  description do
+    "be a monadic success".then do |desc|
+      if instance_variable_defined?(:@expected_value)
+        "#{desc}, with a value matching #{@expected_value.inspect}"
+      else
+        desc
+      end
+    end
+  end
+
+  failure_message do |actual|
+    if !actual.kind_of?(Dry::Monads::Result)
+      "expected that #{actual.inspect} would be a monadic result"
+    elsif actual.success? && instance_variable_defined?(:@expected_value)
+      "expected that the successful result (#{actual.value!.inspect}) would match #{@expected_value.inspect}"
+    else
+      "expected that the result would be a success: #{actual.inspect}"
+    end
+  end
+end
+
+RSpec::Matchers.alias_matcher :succeed, :be_a_monadic_success
+
+RSpec::Matchers.define :be_a_monadic_failure do
+  match do |actual|
+    # Handle dry-validation, dry-types pseudo-monads.
+    actual.then do |v|
+      # :nocov:
+      monadic_result = v.to_monad.try(:to_result)
+
+      @actual = monadic_result if monadic_result.kind_of?(Dry::Monads::Result)
+      # :nocov:
+    end if actual.respond_to?(:to_monad)
+
+    @actual ||= actual
+
+    next false unless @actual.kind_of?(Dry::Monads::Result)
+
+    if @actual.failure?
+      if instance_variable_defined?(:@key)
+        @matched_actual = Array(@actual.failure).first
+
+        values_match? @key, @matched_actual
+      elsif instance_variable_defined?(:@value)
+        @matched_actual = @actual.failure
+
+        values_match? @value, @matched_actual
+      else
+        true
+      end
+    else
+      false
+    end
+  end
+
+  chain :with_key do |key|
+    @key = key
+  end
+
+  chain :with do |value|
+    @value = value
+  end
+
+  failure_message do |actual|
+    if !actual.kind_of?(Dry::Monads::Result)
+      "expected that #{actual.inspect} would be a monadic result"
+    elsif actual.failure? && instance_variable_defined?(:@key)
+      "expected that the failed result (#{@matched_actual.inspect}) would have a key matching #{@key.inspect}"
+    elsif actual.failure? && instance_variable_defined?(:@value)
+      "expected that the failed result (#{@matched_actual.inspect}) would match #{@value.inspect}"
+    else
+      "expected that the result would be a failure: #{actual.inspect}"
+    end
+  end
+
+  diffable
+end
+
+RSpec::Matchers.alias_matcher :monad_fail, :be_a_monadic_failure

data/lib/testing/matchers/negated.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Common negated matchers that I always want defined.
+
+RSpec::Matchers.define_negated_matcher :keep_the_same, :change
+RSpec::Matchers.define_negated_matcher :execute_safely, :raise_error
+RSpec::Matchers.define_negated_matcher :exclude, :include
+RSpec::Matchers.define_negated_matcher :have_enqueued_no_jobs, :have_enqueued_job

metadata

@@ -0,0 +1,377 @@
+--- !ruby/object:Gem::Specification
+name: hotstepper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexa Grey
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  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: dry-configurable
+  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: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: dry-logic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  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: pathname
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: uri
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Hotstepper is a somewhat opinionated service object framework that connects
+  dry-initializer with dry-system operations for use in Rails.
+email:
+- devel@mouse.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/validators/unique_items_validator.rb
+- config/locales/custom-predicates.en.yml
+- config/locales/dry-validation-errors.en.yml
+- config/locales/en.yml
+- config/routes.rb
+- lib/boot/setup.rb
+- lib/generators/hotstepper/service/USAGE
+- lib/generators/hotstepper/service/service_generator.rb
+- lib/generators/hotstepper/service/templates/operation.rb.tt
+- lib/generators/hotstepper/service/templates/service.rb.tt
+- lib/generators/hotstepper/typespace/USAGE
+- lib/generators/hotstepper/typespace/templates/types.rb.tt
+- lib/generators/hotstepper/typespace/typespace_generator.rb
+- lib/hotstepper.rb
+- lib/hotstepper/arel_ext/array_encoding.rb
+- lib/hotstepper/arel_ext/base_helpers.rb
+- lib/hotstepper/arel_ext/helpers.rb
+- lib/hotstepper/arel_ext/json_encoding.rb
+- lib/hotstepper/arel_ext/ltree_encoding.rb
+- lib/hotstepper/arel_ext/postgres_helpers.rb
+- lib/hotstepper/arel_ext/types.rb
+- lib/hotstepper/arel_ext/value_select_query.rb
+- lib/hotstepper/common.rb
+- lib/hotstepper/engine.rb
+- lib/hotstepper/models/association_helpers.rb
+- lib/hotstepper/models/checks_before_destruction.rb
+- lib/hotstepper/models/id_quoting.rb
+- lib/hotstepper/models/lazy_ordering.rb
+- lib/hotstepper/models/limit_to_one.rb
+- lib/hotstepper/models/lookup_helpers.rb
+- lib/hotstepper/models/materialized_view.rb
+- lib/hotstepper/models/model.rb
+- lib/hotstepper/models/querying.rb
+- lib/hotstepper/models/timestamp_scopes.rb
+- lib/hotstepper/models/view.rb
+- lib/hotstepper/models/where_matches.rb
+- lib/hotstepper/monadic.rb
+- lib/hotstepper/monadic/coercion.rb
+- lib/hotstepper/monadic/decorators.rb
+- lib/hotstepper/monadic/do_for.rb
+- lib/hotstepper/operation.rb
+- lib/hotstepper/patterns.rb
+- lib/hotstepper/query_building.rb
+- lib/hotstepper/service.rb
+- lib/hotstepper/steps/abstract_module.rb
+- lib/hotstepper/steps/implementation.rb
+- lib/hotstepper/steps/step.rb
+- lib/hotstepper/steps/watcher.rb
+- lib/hotstepper/steps/wrapper.rb
+- lib/hotstepper/struct.rb
+- lib/hotstepper/support/file_wrapper.rb
+- lib/hotstepper/support/generators/common.rb
+- lib/hotstepper/support/generators/namespaced.rb
+- lib/hotstepper/support/generators/service_operations.rb
+- lib/hotstepper/support/generators/step_definition.rb
+- lib/hotstepper/support/namespace_wrapper.rb
+- lib/hotstepper/support/null_service.rb
+- lib/hotstepper/support/types.rb
+- lib/hotstepper/testing.rb
+- lib/hotstepper/testing/do_for.rb
+- lib/hotstepper/testing/operations.rb
+- lib/hotstepper/testing/typing.rb
+- lib/hotstepper/typespace.rb
+- lib/hotstepper/typing.rb
+- lib/hotstepper/version.rb
+- lib/tasks/hotstepper_tasks.rake
+- lib/testing/contexts/operations.rb
+- lib/testing/matchers/00_disable_with.rb
+- lib/testing/matchers/dry_validation.rb
+- lib/testing/matchers/monadic.rb
+- lib/testing/matchers/negated.rb
+homepage: https://github.com/scryptmouse/hotstepper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/scryptmouse/hotstepper
+  source_code_uri: https://github.com/scryptmouse/hotstepper
+  changelog_uri: https://github.com/scryptmouse/hotstepper/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.23
+specification_version: 4
+summary: A simple™ service object framework built atop dry.rb & Rails
+test_files: []