Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matsumotory/mruby-mrbgem-template
mrbgem template generater
https://github.com/matsumotory/mruby-mrbgem-template
Last synced: about 2 months ago
JSON representation
mrbgem template generater
- Host: GitHub
- URL: https://github.com/matsumotory/mruby-mrbgem-template
- Owner: matsumotory
- License: other
- Created: 2013-12-15T03:37:49.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-02-20T14:17:28.000Z (almost 2 years ago)
- Last Synced: 2024-10-18T18:23:56.928Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 87.9 KB
- Stars: 35
- Watchers: 4
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mruby-mrbgem-template
MrbgemTemplate class
## CLI tool
```sh
# Build mrbgem-template cli
$ git clone https://github.com/matsumoto-r/mruby-mrbgem-template.git
$ cd mruby-mrbgem-template
$ rake
# Generate mrbgem using mrbgem-template
$ ./mruby/bin/mrbgem-template -h # see usage
$ ./mruby/bin/mrbgem-template --github-user myusername --author 'My Name' --mruby-version 3.1.0 --bin-name sample-bin mruby-sample # generate sample mrbgem
$ cd mruby-sample
$ rake # build binary
$ ./mruby/bin/sample-bin # execute built binary
```
## Generate mrbgem using template_config.rb
```
git clone https://github.com/matsumoto-r/mruby-mrbgem-template.git && cd mruby-mrbgem-template/
```
- edit `template_config.rb`
```ruby
params = {
:mrbgem_name => 'mruby-example',
:license => 'MIT',
:github_user => 'your-github-username',
:mrbgem_prefix => File.expand_path('.'),
:class_name => 'Example',
:author => 'your-name',
}
c = MrbgemTemplate.new params
c.create
```
- run `rake`
```
rake
```
- created template files
```
ls -l ./mruby-example
```
## install by mrbgems
- add conf.gem line to `build_config.rb`
```ruby
MRuby::Build.new do |conf|
# ... (snip) ...
conf.gem :git => 'https://github.com/matsumoto-r/mruby-mrbgem-template.git'
end
```
## example
- input create.rb
```ruby
params = {
:mrbgem_name => 'mruby-sample',
:license => 'MIT',
:github_user => 'matsumoto-r',
:mrbgem_prefix => '..',
:class_name => 'Sample',
:author => 'MATSUMOTO Ryosuke',
}
c = MrbgemTemplate.new params
c.create
```
- output mrbgem template
```
$ ./bin/mruby create.rb
Generate all files of mruby-sample
create dir : ../mruby-sample
create dir : ../mruby-sample/src
create file: ../mruby-sample/src/mrb_sample.c
create file: ../mruby-sample/src/mrb_sample.h
create dir : ../mruby-sample/mrblib
create file: ../mruby-sample/mrblib/mrb_sample.rb
create dir : ../mruby-sample/test
create file: ../mruby-sample/test/mrb_sample.rb
create file: ../mruby-sample/mrbgem.rake
create file: ../mruby-sample/mruby-sample.gem
create file: ../mruby-sample/.github/workflows/ci.yml
create file: ../mruby-sample/.github_actions_build_config.rb
create file: ../mruby-sample/README.md
create file: ../mruby-sample/LICENSE
> create matsumoto-r/mruby-sample repository on github.
> turn on GitHub Actions on matsumoto-r/mruby-sample repository.
> edit your mruby-sample code, then run the following command:
cd ../mruby-sample
git init
git add .
git commit -m "first commit"
git remote add origin [email protected]:matsumoto-r/mruby-sample.git
git push -u origin main
> finally, pull-request mruby-sample.gem to mgem-list https://github.com/bovi/mgem-list
```
- all methods
```ruby
params = {
:mrbgem_name => 'mruby-sample',
:license => 'MIT',
:github_user => 'matsumoto-r',
:mrbgem_prefix => '/usr/local/mrbgems',
:class_name => 'Sample',
:author => 'MATSUMOTO Ryosuke',
}
c = MrbgemTemplate.new params
# Create all data
c.create
# Create root dir
#c.create_root
# Create src dir and .c .h
#c.create_src
# Create mrblib dir and .rb
#c.create_mrblib
# Create mrbgem.rake
#c.create_rake
# Create gem file
#c.create_mgem
# Create test dir and .rb
#c.create_test
# Create .github/workflows/ci.yml and ci.yml config
#c.create_ci
# Create README.md
#c.create_readme
# Create LICENS
#c.create_license
# Output github information
#c.git_info
# Get data
#puts c.mrblib_data
#puts c.src_c_data
#puts c.src_h_data
#puts c.rake_data
#puts c.mgem_data
#puts c.test_data
#puts c.github_actions_data
#puts c.github_actions_build_config_data
#puts c.readme_data
#puts c.license_data
# Set data
#c.mrblib_data = "hogehoge"
#.
#.
#.
# Get init data
#c.mrblib_data = c.mrblib_data_init
#.
#.
#.
```
## License
under the MIT License:
- see LICENSE file