+29
.github/workflows/main.yml
+29
.github/workflows/main.yml
···
···
1
+
name: Ruby
2
+
3
+
on:
4
+
push:
5
+
branches:
6
+
- master
7
+
8
+
pull_request:
9
+
10
+
jobs:
11
+
build:
12
+
runs-on: ubuntu-latest
13
+
name: Ruby ${{ matrix.ruby }}
14
+
strategy:
15
+
matrix:
16
+
ruby:
17
+
- '3.4.2'
18
+
19
+
steps:
20
+
- uses: actions/checkout@v4
21
+
with:
22
+
persist-credentials: false
23
+
- name: Set up Ruby
24
+
uses: ruby/setup-ruby@v1
25
+
with:
26
+
ruby-version: ${{ matrix.ruby }}
27
+
bundler-cache: true
28
+
- name: Run the default task
29
+
run: bundle exec rake
+11
.gitignore
+11
.gitignore
+5
CHANGELOG.md
+5
CHANGELOG.md
+11
Gemfile
+11
Gemfile
+35
README.md
+35
README.md
···
···
1
+
# Ratproto
2
+
3
+
TODO: Delete this and the text below, and describe your gem
4
+
5
+
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ratproto`. To experiment with that code, run `bin/console` for an interactive prompt.
6
+
7
+
## Installation
8
+
9
+
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
10
+
11
+
Install the gem and add to the application's Gemfile by executing:
12
+
13
+
```bash
14
+
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
15
+
```
16
+
17
+
If bundler is not being used to manage dependencies, install the gem by executing:
18
+
19
+
```bash
20
+
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
21
+
```
22
+
23
+
## Usage
24
+
25
+
TODO: Write usage instructions here
26
+
27
+
## Development
28
+
29
+
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.
30
+
31
+
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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+
## Contributing
34
+
35
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ratproto.
+8
Rakefile
+8
Rakefile
+11
bin/console
+11
bin/console
···
···
1
+
#!/usr/bin/env ruby
2
+
# frozen_string_literal: true
3
+
4
+
require "bundler/setup"
5
+
require "ratproto"
6
+
7
+
# You can add fixtures and/or initialization code here to make experimenting
8
+
# with your gem easier. You can also use a different console, if you like.
9
+
10
+
require "irb"
11
+
IRB.start(__FILE__)
+8
bin/setup
+8
bin/setup
+8
lib/ratproto.rb
+8
lib/ratproto.rb
+5
lib/ratproto/version.rb
+5
lib/ratproto/version.rb
+39
ratproto.gemspec
+39
ratproto.gemspec
···
···
1
+
# frozen_string_literal: true
2
+
3
+
require_relative "lib/ratproto/version"
4
+
5
+
Gem::Specification.new do |spec|
6
+
spec.name = "ratproto"
7
+
spec.version = Ratproto::VERSION
8
+
spec.authors = ["Kuba Suder"]
9
+
spec.email = ["jakub.suder@gmail.com"]
10
+
11
+
spec.summary = "TODO: Write a short summary, because RubyGems requires one."
12
+
spec.description = "TODO: Write a longer description or delete this line."
13
+
spec.homepage = "TODO: Put your gem's website or public repo URL here."
14
+
spec.required_ruby_version = ">= 3.2.0"
15
+
16
+
spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
17
+
spec.metadata["homepage_uri"] = spec.homepage
18
+
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
19
+
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
20
+
21
+
# Specify which files should be added to the gem when it is released.
22
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
+
gemspec = File.basename(__FILE__)
24
+
spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
25
+
ls.readlines("\x0", chomp: true).reject do |f|
26
+
(f == gemspec) ||
27
+
f.start_with?(*%w[bin/ Gemfile .gitignore .rspec spec/ .github/])
28
+
end
29
+
end
30
+
spec.bindir = "exe"
31
+
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
32
+
spec.require_paths = ["lib"]
33
+
34
+
# Uncomment to register a new dependency of your gem
35
+
# spec.add_dependency "example-gem", "~> 1.0"
36
+
37
+
# For more information and examples about making a new gem, check out our
38
+
# guide at: https://bundler.io/guides/creating_gem.html
39
+
end
+4
sig/ratproto.rbs
+4
sig/ratproto.rbs
+11
spec/ratproto_spec.rb
+11
spec/ratproto_spec.rb
+15
spec/spec_helper.rb
+15
spec/spec_helper.rb
···
···
1
+
# frozen_string_literal: true
2
+
3
+
require "ratproto"
4
+
5
+
RSpec.configure do |config|
6
+
# Enable flags like --only-failures and --next-failure
7
+
config.example_status_persistence_file_path = ".rspec_status"
8
+
9
+
# Disable RSpec exposing methods globally on `Module` and `main`
10
+
config.disable_monkey_patching!
11
+
12
+
config.expect_with :rspec do |c|
13
+
c.syntax = :expect
14
+
end
15
+
end