Project

usine

0.0
No commit activity in last 3 years
No release in over 3 years
Usine (french word for factory) is a wrapper around factory_girl for Trailblazer’s operations.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.12
~> 5.0
~> 10.0
>= 0

Runtime

 Project Readme

Usine

Usine (french word for factory) is a wrapper around factory_girls with two goals: simplify using Trailblazer with factory_girl, and avoid initializing models through factory_girl instead of Trailblazer.

Installation

Add this line to your application's Gemfile:

gem 'usine'

And then execute:

$ bundle

Or install it yourself as:

$ gem install usine

Usage

Usine let you reuse your factories and use them to define the params sent to your Operation.

FactoryGirl.define do
  factory :item do
    title { "Default title"}
  end

  factory :user do
    email { "xx@exxample.com"}
  end
end

# If no symbol given, Usine will try to find an existing factory with this name
Usine.operation(Item::Create) do
  item
  current_user :user
end

# Usine will transmit [call, run, present] to the operation invocation
# so you can have the kind of operation you want in your test
# for example `present` will not run process in your Operation
Usine.(Item::Create, item: {title: "Another title"})
Usine.call(Item::Create, item: {title: "Another title"})
Usine.run(Item::Create, item: {title: "Another title"})
Usine.present(Item::Create, item: {title: "Another title"})

Model less factories

If your params are not related to a model you can simply create a factory this way:

FactoryGirl.define do
  factory :search, class:Usine::NullModel do
    query { "*"}
  end
end

Factory girl features

All factory_girl features should work, sequences for example are working:

FactoryGirl.define do
  sequence(:email) do |n|
    "some_email_#{n}@example.com"
  end

  factory :user do
    contact { generate(:email) }
  end
end

Writing a test with Usine

# Without Usine
let(:item) {
  Item::Create.({
    item: {
      title: "DEFAULT_TITLE"
    },
    current_user: User::Create.(email: "some_email@example.com").model
  }).model
}

# With Usine
FactoryGirl.define do
  factory :item do
    title { "DEFAULT_TITLE" }
  end

  factory :user do
    email { "some_email@example.com" }
  end
end

Usine.operation(User::Create) do
  user
end

Usine.operation(Item::Create) do
  item
  current_user User::Create #operation used as factory, will return its model
end

let(:item) { Usine.(Item::Create).model }

# note that you can also give attributes when an Operation is used as factory
# this will assign User::Create.(email: "my_mail@example.com").model to current_user key
let(:item) { Usine.(Item::Create, current_user: {email: "my_email@example.com"}).model }

The second example might look more verbose, but you only have to define factories/operations one time. And then you can reuse it for all your tests.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jjaffeux/usine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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