Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajasegar/cybertron
Cybertron is where Ruby Transformers are born!
https://github.com/rajasegar/cybertron
cli codemod codemods converters cybertron ruby
Last synced: 3 months ago
JSON representation
Cybertron is where Ruby Transformers are born!
- Host: GitHub
- URL: https://github.com/rajasegar/cybertron
- Owner: rajasegar
- License: mit
- Created: 2019-09-16T12:07:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T07:03:16.000Z (almost 2 years ago)
- Last Synced: 2024-11-02T12:12:00.423Z (3 months ago)
- Topics: cli, codemod, codemods, converters, cybertron, ruby
- Language: Ruby
- Homepage:
- Size: 32.2 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-codemods - cybertron - Codemod CLI to bootstrap Ruby codemods (transforms). (Ruby)
README
# cybertron
[](https://badge.fury.io/rb/cybertron)
[](https://travis-ci.org/rajasegar/cybertron)
[](https://coveralls.io/github/rajasegar/cybertron?branch=master)
cybertron is a command line tool for generating, testing and publishing
[converters](https://github.com/rajasegar/awesome-ruby-ast#converters) aka
[Codemods](https://github.com/facebook/codemod) for Ruby inspired by [codemod-cli](https://github.com/rwjblue/codemod-cli) for Javascript by [Robert Jackson](https://github.com/rwjblue)
**INFO**:
You can use a tool like [codeshift](https://github.com/rajasegar/codeshift) to run your codemods/transforms against your Ruby codebase.
For writing transforms you can also make use of the [Ruby AST Explorer](https://ruby-ast-explorer.herokuapp.com/)
## Installation
```sh
$ gem install cybertron
```
## Usage
### Create a new codemod project
```
$ cybertron new
```
Example:
```
$ cybertron new my_ruby_codemod
```
This will create a project structure like this:
```
my_ruby_codemod
| transforms
| spec
| | spec_helper.rb
.rspec
Rakefile
```
### Generate a new transform
```
$ cd
$ cybertron generate transform
```
Example:
```
$ cd my_ruby_codemod
$ cybertron generate transform my_transform
```
Now the project structure will be like this:
```
my_ruby_codemod
| transforms
| | my_transform
| | | fixtures
| | | | basic_input.rb
| | | | basic_output.rb
| | | transform.rb
| spec
| | my_transform_spec.rb
| | spec_helper.rb
.rspec
Rakefile
```
### Generate a new fixture for transform
```
$ cybertron generate fixture
```
Example:
```
$ cybertron generate fixture my_transform advanced_usage
```
Now the project structure will be like this:
```
my_ruby_codemod
| transforms
| | my_transform
| | | fixtures
| | | | basic_input.rb
| | | | basic_output.rb
| | | | advanced_usage_input.rb
| | | | advanced_usage_output.rb
| | | transform.rb
| spec
| | my_transform_spec.rb
| | spec_helper.rb
.rspec
Rakefile
```
### Run tests for your codemod transforms
```
$ cybertron spec
```
This will run all the specs in the spec folder, by comparing the input and output
fixtures against themselves for each and every transform.
### Finding help or usage instructions
To display the help message and usage instructions, just invoke `cybertron`
without any arguments
```sh
$ cybertron
```
To display help about any particular command,
```sh
$ cybertron help
```
For example, to know more about the `generate` command:
```sh
$ cybertron help generate
```
## Other related tools
- [ruby-ast-explorer](https://github.com/rajasegar/ruby-ast-explorer)
- [codeshift](https://github.com/rajasegar/codeshift)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/rajasegar/cybertron. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Cybertron project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cybertron/blob/master/CODE_OF_CONDUCT.md).