like_im_five

Have you ever wasted time to setting up testing context rather than focusing on the code? Have you ever had pain to reproduce a production bug in your test?

Like Im Five generate a file with factories you need to test a specific object. It use you DB development to retrieve the object you want and all associations you will have need to setup the test.

Create a complex testing context in a few seconds.

Installation

Add this line to your application's Gemfile:

gem 'like_im_five'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install like_im_five

Usage

Just open you terminal, go in your project and type:

like_im_five id_of_object table_of_object

(if you are facing somme issue try to prepend bundle exec before the commands above)

It takes two parameters.

id_of_object
The gem use your development database so you have to indicate of which one object you would like create context.

table_of_object
Then you have to specify what is the table of the id you just typed above.

Example:

In your DB development you have these objects:

=> #<DummyApp::User id: 12 name: "Jean", city: "London", age: 20, created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">

=> #<DummyApp::Article id: 1, dummy_app_user_id: 12, dummy_app_category_id: 1, title: "Subway Art 25th", body: "Anniversary Edition", created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">

=> #<DummyApp::Category id: 1, dummy_app_topic_id: 3, label: "Graffiti", created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">

=> #<DummyApp::Topic id: 3, title: "Culture", description: "Culture is beautiful", created_at: "2019-12-30 22:45:33", updated_at: "2019-12-30 22:45:33">

You want to test your article, in your terminal you have to type the following command:

like_im_five 1 "dummy_app_articles"

and it will generate a new file in your /spec folder named: name_of_your_table.txt, so in our case name_of_your_table.txt containing factories:

let(:dummy_app_article) { create :dummy_app_article, id: 1, dummy_app_user_id: 12, dummy_app_category_id: 1, title: "Subway Art 25th", body: "Anniversary Edition" }
let(:dummy_app_user) { create :dummy_app_user, id: 12, name: "Jean", city: "London", age: 20 }
let(:dummy_app_category) { create :dummy_app_category, id: 1, label: "Graffiti", dummy_app_topic_id: 3 }
let(:dummy_app_topic) { create :dummy_app_topic, id: 3, title: "Culture", description: "Culture is beautiful" }

That's it, just copy/paste it in your concerned spec.

Corner cases

• UID
  I you are using UID rather than traditional ID no worries, we handle it for you. Just type commande below:

like_im_five "ffe-230-opoifhhfru-333" "dummy_app_articles"

• Similarity detection to match table name with model
  Sometimes you have to use Inflection, especially if you are not coding in english.

If you named a table vitraux and your model vitrail we will match both to build your factory.

nb: if your model name is really to different than your table name it can fails to match.

• Namespaced table name
  If you have namespaced table name but using model name as foreign_key in association we will handle it for you.

e.g:

You have the following table with the foreign_key website_id

create_table "dummy_app_articles", force: :cascade do |t|
    t.string "title"
   ...
    t.bigint "website_id"
    t.index ["website_id"], name: "index_dummy_app_articles_on_website_id"
  end

but your website table looks like

  create_table "dummy_app_websites", force: :cascade do |t|
    t.string "url"
    t.datetime "created_at", null: false
    t.datetime "updated_at", null: false
  end

Connect website_id with dummy_app_websites can be messy but that's fine.

Testing

To run the test suite please type in your cli:

bundle exec rspec dummy_app/spec/dummy/spec

Contributing

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

License

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

Code of Conduct

Everyone interacting in the LikeImFive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.