Macros for Trailblazer operations.

• several predefined macros organized in namespaces
• custom macros

For contributing, install docker to use the provided dockerized development environment.

Add this line to your application's Gemfile:

gem 'ff-tbl-macros'

Use the macros in the operation steps:

class User::Delete < Trailblazer::Operation
  step Macros::Model::Destroy()
end

Warning! Rarely some macros may require some gem(s) to be included. Find respective macro down in this file in Macros Types section.

Use the provided dockerized development environment. For more information check the CONTRIBUTING file.

The project includes a dockerized development environment.

# build the docker containers
docker-compose build

# run the specs
docker-compose run --rm app bundle exec rspec

There are several types of macros organized in namespaces.

• Macros::Auth::Authenticate
• Macros::Auth::SignIn
• Macros::Auth::SignOut
• Macros::Auth::SignOutAllScopes
• Macros::Auth::ExpireSessionData

• Macros::Contract::ExtractParams
• Macros::Contract::Prepopulate

• Macros::Ctx::Copy
• Macros::Ctx::Inspect
• Macros::Ctx::ValidatePresence

• Macros::CurrentUser::Set

• Macros::Error::SetFromContract

• Macros::Model::Build
• Macros::Model::Copy
• Macros::Model::Destroy
• Macros::Model::Persist

• Macros::Search::Query

Warning ! If you want to use Macros::Search::Query you have to include pagy gem into ypur Gemfile

• Macros::VeriryParams::Date

You can create your own custom macros specific to your application. Just put them in the lib/macros folder of your Rails app following this convention:

lib/macros/lorem.rb

module Macros
  class Lorem < Macros::Base
    register :print_ipsum
  end
end

lib/macros/lorem/print_ipsum.rb

module Macros
  class Lorem
    # Some info what your macro does
    #
    # @examples
    #   step Macros::Lorem::PrintIpsum(count:)
    #
    class PrintIpsum < Macros::Base
      def initialize(count:)
        @count = count
      end

      def call(ctx, **)
        @count.times { print 'Ipsum' }
      end
    end
  end
end

The gem is available as open source under the terms of the MIT License.

Gem used https://github.com/coditsu/macros as the base.