Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tcd/ginny
🏗️ Generate ruby code
https://github.com/tcd/ginny
automation code-generation ruby yard
Last synced: 5 days ago
JSON representation
🏗️ Generate ruby code
- Host: GitHub
- URL: https://github.com/tcd/ginny
- Owner: tcd
- License: mit
- Created: 2019-11-14T17:18:19.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-28T04:55:03.000Z (over 4 years ago)
- Last Synced: 2024-08-09T03:25:56.825Z (3 months ago)
- Topics: automation, code-generation, ruby, yard
- Language: Ruby
- Homepage:
- Size: 104 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Ginny
[][rubygems]
[][travis-ci]
[][coveralls-ci]
[][rubydoc-gem]
[][license]
[rubygems]: https://rubygems.org/gems/ginny
[travis-ci]: https://travis-ci.org/tcd/ginny
[coveralls-ci]: https://coveralls.io/github/tcd/ginny?branch=master
[rubydoc-gem]: https://www.rubydoc.info/gems/ginny/0.6.3
[license]: https://github.com/tcd/ginny/blob/master/LICENSE.txt
## Installation
Add this line to your application's Gemfile:
```ruby
gem "ginny"
```
And then execute:
```ruby
bundle
```
Or install it yourself as:
```ruby
gem install ginny
```
## Usage
### From the command line
```yaml
# person.yml
---
name: Human
description: This class models a person.
modules: [MilkyWay, Earth]
parent: Mammal
default_constructor: true
attrs:
- name: Name
type: String
- name: Age
description: Number of years the human has been alive.
type: Integer
read_only: true
```
```shell
$ ginny person.yml
```
### From Ruby code
```ruby
require "ginny"
data = {
name: "Human",
description: "This class models a person.",
modules: ["MilkyWay", "Earth"],
parent: "Mammal",
default_constructor: true,
attrs: [
{ name: "name", type: "String" },
{ name: "age", type: "Integer" read_only: true, description: "Number of years the human has been alive." },
],
}
c = Ginny::Class.create(data)
c.render() #=> Returns the generated code as a string.
c.generate() #=> Writes the generated code to a given folder, or the current directory if no argument is passed.
```
```ruby
# human.rb
module MilkyWay
module Earth
# This class models a person.
class Human < Mammal
# @return [String]
attr_accessor :name
# Number of years the human has been alive.
# @return [Integer]
attr_reader :age
# @param params [Hash]
# @return [self]
def self.create(params = {})
h = Human.new
h.name = params[:name]
h.age = params[:age]
return h
end
end
end
end
```
## Supported Arguments
### `Ginny::Class`
| Name | Type | Description |
| ------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name (required) | `String` | Name of the class. |
| description | `String` | Description of the class. [Markdown][markdown] is supported. |
| body | `String` | String to write into the body of the class. |
| parent | `String` | Name of a class to inherit from. (Ex: `YourNewClass < Parent`) |
| modules | `Array` | List of modules to declare the class inside of |
| default_constructor | `Boolean` | If `true`, a method similar to [ActiveRecord::Base.create][create_method_link] will be generated for the class. |
| attrs | `Array` | An array of instance attributes. |
| classify_name | `Boolean` | By default, names are *classified* using [Dry::Inflector#classify](https://github.com/dry-rb/dry-inflector#usage). Set this to `false` to disable *classification* and use raw `name` input. |
[create_method_link]: https://apidock.com/rails/ActiveRecord/Persistence/ClassMethods/create
### `Ginny::Attr`
| Name | Type | Description |
| --------------- | --------- | ------------------------------------------------------------------------------------------------------------------------ |
| name (required) | `String` | Name of the attribute. |
| description | `String` | Description of the attribute. [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is supported. |
| type | `String` | [Type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the attribute. |
| default | `Any` | Default value for the attribute; set in it's Class's `initialize` function. |
| read_only | `Boolean` | If `true`, an `attr_reader` will be generated for the attribute instead of an `attr_accessor`. |
### `Ginny::Func`
| Name | Type | Description |
| --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------- |
| name (required) | `String` | Name of the function. |
| description | `String` | Description of the function. [Markdown][markdown] is supported. |
| return_type | `String` | Return [type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the function. |
| body | `String` | String to write into the body of the function. |
| modules | `Array` | List of modules to declare the function inside of |
| params | `Array` | An array of Params. |
### `Ginny::Param`
| Name | Type | Description |
| --------------- | --------- | -------------------------------------------------------------------------------------------------------------------- |
| name (required) | `String` | Name of the param. |
| description | `String` | Description of the param. [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is supported. |
| type | `String` | [Type](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Declaring_Types) of the param. |
| default | `Any` | Default value for the param. Set `optional` as `true` for a default `nil` value. |
| optional | `Boolean` | If `true`, the default value will be `nil`. |
| keyword | `Boolean` | If `true`, the param will be generated as a [keyword argument](https://bugs.ruby-lang.org/issues/14183). |
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tcd/ginny.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).