trailblazer-endpoint 0.0.1 → 0.0.6

data/test/rails-app/app/concepts/song/cell/create.rb

@@ -0,0 +1,4 @@
+module Song::Cell
+  class Create < Trailblazer::Cell
+  end
+end

data/test/rails-app/app/concepts/song/cell/new.rb

@@ -0,0 +1,4 @@
+module Song::Cell
+  class New < Trailblazer::Cell
+  end
+end

data/test/rails-app/app/concepts/song/operation/create.rb

@@ -0,0 +1,17 @@
+module Song::Operation
+  class Create < Trailblazer::Operation
+    step :contract
+    step :model
+    # step :validate
+    # step :save
+
+    def model(ctx, params:, **)
+      return unless params[:id]
+      ctx[:model] = Song.new(params[:id])
+    end
+
+    def contract(ctx, **)
+      ctx[:contract] = Struct.new(:errors).new()
+    end
+  end
+end

data/test/rails-app/app/concepts/song/operation/show.rb

@@ -0,0 +1,10 @@
+module Song::Operation
+  class Show < Trailblazer::Operation
+    step :model, Output(:failure) => End(:not_found)
+
+    def model(ctx, params:, **)
+      return unless params[:id] == "1"
+      ctx[:model] = Song.new(params[:id])
+    end
+  end
+end

data/test/rails-app/app/concepts/song/representer.rb

@@ -0,0 +1,5 @@
+class Song::Representer < Representable::Decorator
+  include Representable::JSON
+
+  property :id
+end

data/test/rails-app/app/concepts/song/view/create.erb

@@ -0,0 +1 @@
+<div><%= model %><%= options[:current_user] %></div>

data/test/rails-app/app/concepts/song/view/new.erb

@@ -0,0 +1 @@
+<div><%= model %></div>

data/test/rails-app/app/controllers/api/v1/songs_controller.rb

@@ -0,0 +1,41 @@
+#:controller
+module Api
+  module V1
+    #:endpoint
+    class SongsController < ApplicationController::Api
+      endpoint Song::Operation::Create
+      endpoint Song::Operation::Show do
+        {Output(:not_found) => Track(:not_found)}  # add additional wiring to {domain_activity}
+      end
+    #:endpoint end
+
+      #:create
+      def create
+        endpoint Song::Operation::Create, representer_class: Song::Representer
+      end
+      #:create end
+
+      #~empty
+      def show
+        endpoint Song::Operation::Show, representer_class: Song::Representer
+      end
+
+      def show_with_options
+        endpoint Song::Operation::Show, representer_class: Song::Representer, protocol_failure_block: ->(ctx, endpoint_ctx:, **) { head endpoint_ctx[:status] + 1 }
+      end
+
+      class WithOptionsController < ApplicationController::Api
+        endpoint Song::Operation::Show do {Output(:not_found) => Track(:not_found)} end
+
+        #:show-options
+        def show
+          endpoint Song::Operation::Show, representer_class: Song::Representer,
+            protocol_failure_block: ->(ctx, endpoint_ctx:, **) { head endpoint_ctx[:status] + 1 }
+        end
+        #:show-options end
+      end
+      #~empty end
+    end
+  end
+end
+#:controller end

data/test/rails-app/app/controllers/application_controller.rb

@@ -1,3 +1,10 @@
+require "trailblazer/endpoint/controller"
+
 class ApplicationController < ActionController::Base
-  protect_from_forgery with: :exception
+  def self.current_user_in_domain_ctx
+    ->(_ctx, ((ctx, a), b)) { ctx[:domain_ctx][:current_user] = ctx[:current_user]; [_ctx, [[ctx, a], b]] } # FIXME: extract to lib?
+  end
 end
+
+
+# directive

data/test/rails-app/app/controllers/application_controller/api.rb

@@ -0,0 +1,107 @@
+#:app-controller
+#:app-include
+class ApplicationController::Api < ApplicationController
+  include Trailblazer::Endpoint::Controller.module(api: true, application_controller: true)
+#:app-include end
+
+  def self.options_for_block_options(ctx, controller:, **)
+    response_block = ->(ctx, endpoint_ctx:, **) do
+      controller.render json: endpoint_ctx[:representer], status: endpoint_ctx[:status]
+    end
+
+    {
+      success_block:          response_block,
+      failure_block:          response_block,
+      protocol_failure_block: response_block
+    }
+  end
+
+  directive :options_for_block_options, method(:options_for_block_options)
+#:app-controller end
+
+#:options_for_endpoint
+  def self.options_for_endpoint(ctx, controller:, **)
+    {
+      request: controller.request,
+      errors_representer_class: App::Api::V1::Representer::Errors,
+      errors: Trailblazer::Endpoint::Adapter::API::Errors.new,
+    }
+  end
+
+  directive :options_for_endpoint, method(:options_for_endpoint)
+#:options_for_endpoint end
+
+#:options_for_domain_ctx
+  def self.options_for_domain_ctx(ctx, controller:, **) # TODO: move to ApplicationController
+    {
+      params: controller.params,
+    }
+  end
+
+  directive :options_for_domain_ctx,    method(:options_for_domain_ctx)
+#:options_for_domain_ctx end
+
+  #:protocol
+  class Protocol < Trailblazer::Endpoint::Protocol
+    step Auth::Operation::Policy, inherit: true, id: :policy, replace: :policy
+    step Subprocess(Auth::Operation::Authenticate), inherit: true, id: :authenticate, replace: :authenticate
+  end
+  #:protocol end
+
+  #:adapter
+  module Adapter
+    class Representable < Trailblazer::Endpoint::Adapter::API
+      step :render # added before End.success
+      step :render_errors, after: :_422_status, magnetic_to: :failure, Output(:success) => Track(:failure)
+      step :render_errors, after: :protocol_failure, magnetic_to: :fail_fast, Output(:success) => Track(:fail_fast), id: :render_protocol_failure_errors
+
+      def render(ctx, domain_ctx:, representer_class:, **) # this is what usually happens in your {Responder}.
+        ctx[:representer] = representer_class.new(domain_ctx[:model] || raise("no model found!"))
+      end
+
+      def render_errors(ctx, errors:, errors_representer_class:, **) # TODO: extract with {render}
+        ctx[:representer] = errors_representer_class.new(errors)
+      end
+
+      Trailblazer::Endpoint::Adapter::API.insert_error_handler_steps!(self)
+      include Trailblazer::Endpoint::Adapter::API::Errors::Handlers # handler methods to set an error message.
+    end # Representable
+  end
+  #:adapter end
+
+puts Trailblazer::Developer.render(Adapter::Representable)
+
+  #:endpoint
+  # app/controllers/application_controller/api.rb
+  endpoint protocol: Protocol, adapter: Adapter::Representable do
+    # {Output(:not_found) => Track(:not_found)}
+    {}
+  end
+  #:endpoint end
+end
+
+
+# header 'Authorization', "Bearer #{result['jwt_token']}" if result['jwt_token']
+
+
+# ΓΞΞ Protocol ΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˥
+# | (Start)--->[Authenticate]-->[Policy]-->[Show]----------->((success))  |
+# |                 |            |          | L------------->((failure))  |
+# |                 |            |          L------------->((not_found))  |
+# |                 |            L------------------->((not_authorized))  |
+# |                 L----------------------------->((not_authenticated))  |
+# |                                                     ((invalid_data))  |
+# LΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˩
+#--˥˩   ˪
+
+# ΓΞΞ Adapter::Representable ΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˥
+# |                                                                                                                                                                                                |
+# | (Start)---> ΓΞΞ Protocol ΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˥                                                                                                          |
+#               | (Start)--->[Authenticate]-->[Policy]-->[Show]----------->((success))  |--->[_200_status]--->[render]---------------------------------------------------------------->((success)) |
+#               |                 |            |          | L------------->((failure))  |-˥                                                                                                        |
+#               |                 |            |          L------------->((not_found))  |-|------------------------------->[_404_status]-----------v                                               |
+#               |                 |            L------------------->((not_authorized))  |-|->[handle_not_authorized]------>[_403_status]--->[protocol_failure]--->[render_errors]--->((fail_fast)) |
+#               |                 L----------------------------->((not_authenticated))  |-|->[handle_not_authenticated]--->[_401_status]-----------^                                               |
+#               |                                                     ((invalid_data))  |-┴->[handle_invalid_data]-------->[_422_status]--->[render_errors]--------------------------->((failure)) |
+#               LΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˩                                                                                                          |
+# LΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞΞ˩

data/test/rails-app/app/controllers/application_controller/web.rb

@@ -0,0 +1,44 @@
+#:app-include
+#:options
+#:protocol
+#:generic
+class ApplicationController::Web < ApplicationController
+#~pskip
+#~gskip
+  include Trailblazer::Endpoint::Controller.module(dsl: true, application_controller: true)
+#:app-include end
+
+  def self.options_for_endpoint(ctx, controller:, **)
+    {
+      session: controller.session,
+    }
+  end
+
+  directive :options_for_endpoint, method(:options_for_endpoint)
+#:options end
+
+  # directive :options_for_flow_options, method(:options_for_flow_options)
+  # directive :options_for_block_options, method(:options_for_block_options)
+#~pskip end
+  class Protocol < Trailblazer::Endpoint::Protocol
+    # provide method for {step :authenticate}
+    def authenticate(ctx, session:, **)
+      ctx[:current_user] = User.find_by(id: session[:user_id])
+    end
+
+    # provide method for {step :policy}
+    def policy(ctx, domain_ctx:, **)
+      Policy.(domain_ctx)
+    end
+  end
+#:protocol end
+  Policy = ->(domain_ctx) { domain_ctx[:params][:policy] == "false" ? false : true }
+#~gskip end
+  endpoint protocol: Protocol, adapter: Trailblazer::Endpoint::Adapter::Web,
+    domain_ctx_filter: ApplicationController.current_user_in_domain_ctx
+end
+#:generic end
+
+# do
+#   {Output(:not_found) => Track(:not_found)}
+# end

data/test/rails-app/app/controllers/auth_controller.rb

@@ -0,0 +1,44 @@
+class AuthController < ApplicationController::Web
+  # We could use a fully-fledged operation here, with a contract and whatnot.
+  def self.authenticate(ctx, request:, params:, **)
+    if params[:username] == "yogi@trb.to" && params[:password] == "secret"
+      ctx[:current_user] = User.find_by(email: params[:username])
+
+      return true
+    else
+      return false # let's be extra explicit!
+    end
+  end
+
+  endpoint("sign_in", domain_activity: Class.new(Trailblazer::Activity::Railway)) do
+    # step nil, delete: :domain_activity
+    step nil, delete: :policy
+    step AuthController.method(:authenticate), replace: :authenticate, inherit: true, id: :authenticate
+
+    {}
+  end
+
+  def self.options_for_endpoint(ctx, controller:, **)
+    {
+      params: controller.params,
+      request: controller.request,
+    }
+  end
+
+  directive :options_for_endpoint, method(:options_for_endpoint)
+
+  def sign_in
+    endpoint "sign_in" do |ctx, current_user:, **|
+      session[:user_id] = current_user.id # Working on {session} is HTTP-specific and done in the controller.
+
+      redirect_to dashboard_path
+      # render html: "Yes!"
+    end
+  end
+
+private
+
+  def dashboard_path
+    "/"
+  end
+end

data/test/rails-app/app/controllers/home_controller.rb

@@ -0,0 +1,5 @@
+class HomeController < ApplicationController
+  def dashboard
+    render html: "Yo!"
+  end
+end

data/test/rails-app/app/controllers/songs_controller.rb

@@ -1,26 +1,84 @@
-class SongsController < ApplicationController
-  require "trailblazer/endpoint/rails"
-  include Trailblazer::Endpoint::Controller
+#:endpoint
+#:or
+#:create
+class SongsController < ApplicationController::Web
+  endpoint Song::Operation::Create
 
+#:endpoint end
   def create
-    endpoint Create, path: songs_path, args: [ params, { "user.current" => ::Module } ]
+    endpoint Song::Operation::Create do |ctx, current_user:, model:, **|
+      render html: cell(Song::Cell::Create, model, current_user: current_user)
+    end.Or do |ctx, contract:, **| # validation failure
+      render html: cell(Song::Cell::New, contract)
+    end
   end
+#:create end
 
-  def update
-    endpoint Update, path: songs_path, args: [params]
+#~oskip
+  class CreateOrController < SongsController
+#~oskip end
+  def create
+    endpoint Song::Operation::Create do |ctx, current_user:, model:, **|
+      render html: cell(Song::Cell::Create, model, current_user: current_user)
+    end.Or do |ctx, contract:, **| # validation failure
+      render json: contract.errors, status: 422
+    end
   end
+end
+#:or end
 
-  def update_with_user
-    endpoint Update, path: songs_path, args: [ params, { "user.current" => ::Module } ]
+  def create_without_block
+    endpoint Song::Operation::Create
   end
 
-  def show
-    endpoint Show, path: songs_path, args: [ params, { "user.current" => ::Module } ]
+  class CreateWithOptionsController < SongsController
+    #:create-options
+    def create
+      endpoint Song::Operation::Create, session: {user_id: 2} do |ctx, current_user:, model:, **|
+        render html: cell(Song::Cell::Create, model, current_user: current_user)
+      end
+    end
+    #:create-options end
   end
 
-  def create_with_custom_handlers
-    endpoint Create, path: songs_path, args: [ params, { "user.current" => ::Module } ] do |m|
-      m.created { |result| render json: result["representer.serializer.class"].new(result["model"]), status: 999 }
+
+  class CreateWithOptionsForDomainCtxController < SongsController
+    #:domain_ctx
+    def create
+      endpoint Song::Operation::Create, options_for_domain_ctx: {params: {id: 999}} do |ctx, model:, **|
+        render html: cell(Song::Cell::Create, model)
+      end
     end
+    #:domain_ctx end
+  end
+
+  class CreateEndpointCtxController < SongsController
+    #:endpoint_ctx
+    def create
+      endpoint Song::Operation::Create do |ctx, endpoint_ctx:, **|
+        render html: "Created", status: endpoint_ctx[:status]
+      end.Or do |ctx, **| # validation failure
+        #~empty
+        #~empty end
+      end
+    end
+    #:endpoint_ctx end
+  end
+
+  # end.Or do |ctx, endpoint_ctx:, **| # validation failure
+  #       render json: endpoint_ctx.keys, status: 422
+  #     end
+
+
+  class CreateWithProtocolFailureController < SongsController
+  #:protocol_failure
+  def create_with_protocol_failure
+    endpoint Song::Operation::Create do |ctx, **|
+      redirect_to dashboard_path
+    end.protocol_failure do |ctx, **|
+      render html: "wrong login, app crashed", status: 500
+    end
+  end
+  #:protocol_failure end
   end
 end

data/test/rails-app/app/models/song.rb

@@ -0,0 +1,3 @@
+class Song < Struct.new(:id)
+
+end

data/test/rails-app/app/models/user.rb

@@ -0,0 +1,7 @@
+class User < Struct.new(:id, :email)
+  def self.find_by(id: false, email: false)
+    return User.new(1, "yogi@trb.to") if email == "yogi@trb.to"
+    return User.new(id, "yogi@trb.to") if id.to_s == "1"
+    return User.new(id, "seuros@trb.to") if id.to_s == "2"
+  end
+end

data/test/rails-app/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end