Project

rakeman

0.0
No commit activity in last 3 years
No release in over 3 years
This gem allow to manage your project rake tasks.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 3.32, >= 3.32.1
~> 5.1, >= 5.1.1
~> 2.11
~> 5.1, >= 5.1.1
~> 2.0, >= 2.0.1
~> 1.2, >= 1.2.3
~> 0.3.9
~> 4.0, >= 4.0.1
~> 1.2
~> 2.8, >= 2.8.1
~> 3.142, >= 3.142.7

Runtime

>= 5.1.5
 Project Readme

Rakeman

Installation

Add this line to your application's Gemfile:

gem 'rakeman'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rakeman

Then run:

$ rails g rakeman:install
$ rails rakeman:install:migrations
$ rails db:migrate

Make sure your policy is allowing to access Rakeman controllers

Usage

At first time you load /rakeman page Rakeman will fetch all your project rake tasks and save them as Rakeman::RakeTask model.

Rakeman provides several actions:

Create an instance of Rakeman::Manager and call on it:

  • #tasks to fetch all tasks in your project. The output data will be array of hashes:
    [
     {
       name: 'task1',
       description: 'Task 1 Description'
     },
     {
       name: 'task2',
       description: 'Task 2 Description'
     }
    ]
  • #persist_tasks(tasks_list: nil, destroy_old_tasks: true) to save tasks to DB. By default it destroys ALL previous tasks in DB and creates new instead from all your project tasks. tasks_list must be an array of hashes such as above.
  • #update_tasks_list to update DB with new tasks and destroy old ones that you don't have in project anymore.
  • #mark_as_done(task) to mark your task as done
  • #mark_as_undone(task) to mark your task as undone
  • #execute(task) to execute your task. It also marks your task as done
    Only rake tasks without params can be executed. Feature that allows to run tasks with params will be released in next version. Sorry =(

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/CaptainJNS/rakeman. 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 Rakeman project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.