Project

yomikomu

0.07
No commit activity in last 3 years
No release in over 3 years
yomikomuko1/yomikomuHomepageDocumentationSource CodeBug TrackerWiki
Dump compiled iseq by binary (kakidasu) and load binary (yomidasu).
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
21,961
Stars
181
Forks
13
Watchers
12
 Releases
Current version
0.4.1
Total releases
5
First release
2015-12-12
Latest release
2017-02-16
 Issues
Open Issues
2
Closed Issues
1
Total Issues
3
Issue Closure Rate
33%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
1
Merged Pull Requests
3
Pull Request Acceptance Rate
60%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-11-15
Reverse Dependencies
1

 Dependencies

Development

bundler
~> 1.10
minitest
>= 0
mmapped_string
>= 0
rake
~> 10.0

Runtime

mmapped_string
>= 0
 Project Readme

Yomikomu

  • yomikomu gem enables to load compiled instruction sequences (bytecodes).
  • kakidasu command compiles and stores compiled instruction sequences (bytecodes).

This gem requires Ruby 2.3.0. Most of code is ported from ruby/sample/iseq_load.rb.

Installation

Add this line to your application's Gemfile:

gem 'yomikomu'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yomikomu

Usage

Configuration

You can use the following configuration with environment variables.

  • YOMIKOMU_STORAGE (default: fs): choose storage type.
    • 'fs' (default) stores binaries in the same directory (for examlple, x.rb will be compiled to x.rb.yarb in the same directory).
    • 'fs2' stores binaries in specific directory.
    • 'fsgz' stores files same as 'fs', but gz compressed.
    • 'fs2gz' stores files same as 'fs2', but gz compressed.
    • 'dbm' stores binaries using dbm.
    • 'flatfile' stores binaries in one flat file. Updating is not supported. Use with YOMIKOMU_AUTO_COMPILE.
  • YOMIKOMU_STORAGE_DIR (default: "~/.ruby_binaries"): choose directory where binary files are stored.
  • YOMIKOMU_AUTO_COMPILE (default: false): if this value is true, then compile all required scripts implicitly.
  • YOMIKOMU_YOMIKOMANAI (default: not defined): disable all YOMIKOMU features.
  • YOMIKOMU_INFO (default: not defined): show some information.
  • YOMIKOMU_DEBUG (default: not defined): show more information.

Compile and store instruction sequences

You only need to use the following command.

$ kakidasu [file or dir] ...

Compile specified file or files (*.rb) in specified directory. If no files or directories are specified, then use "libdir" of installed Ruby.

Load compiled binary

You only need to require yomikomu.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ko1/yomikomu.

License

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