hadron 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4ca11e52b69b419fec21b50deba543360b52c44fa9fc1dbd89b37cb2941b20
-  data.tar.gz: d55188ebdc16519b0fea96d2fed192606441d05cf6648ac865cbe77cdfa3e8d1
+  metadata.gz: 836d0642c237e54d4d4282d17a161a278597de0100cecd1fa78b9f4655bd4083
+  data.tar.gz: e5bae8b65d85a3c2853dae5ea7f1d9495a1ed13f5b0b41c0f5dbd3645ba85719
 SHA512:
-  metadata.gz: 898126e184f02d412c73a6dcd341a5df9eb615df3e6ff11128ab9006a8a9abd8a96c86b312ea904944463f04848c162ae3170bb371ea9918ad16a9229db5a92b
-  data.tar.gz: 66a948bb3491226ddca6ff5fc3918562304cf4a20d3b44b50c5a2a80c19c0bc9e68e437781cebc2ae1937ce9cd9f835e9b549380d3f7c2c3597ef2d7f7b3b1f7
+  metadata.gz: 59a91ebd5dbf14b587b7f542f80494713ac2a74e538c6a708151337eb6c8bc3c96c8ea7c0f5c5adda40d16278d5e28db45950bce95536207221915384080e478
+  data.tar.gz: de4427b653f5adfa0c87dfba6efdaaeb5ec25cdaff0c4a57414cb46ccd7dbfe12b0966ab3b874a79fafc90822965339356478031f7356e3afe5f354a5e9e9fc1

data/Gemfile

@@ -5,10 +5,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in hadron.gemspec
 gemspec
 
+gem "fileutils", "~> 1.7"
 gem "pry", "~> 0.14.1"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
-
 gem "thor", "~> 1.2"
-gem "fileutils", "~> 1.7"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hadron (0.1.9)
+    hadron (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/hadron/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hadron
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/templates/.github/workflows/main.yml.erb

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.1.2'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/templates/.gitignore.erb

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/templates/.rspec.erb

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/templates/.rubocop.yml.erb

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/templates/CHANGELOG.md.erb

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-31
+
+- Initial release

data/templates/CODE_OF_CONDUCT.md.erb

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kerandisylvance@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/templates/README.md.erb

@@ -0,0 +1,54 @@
+# Project
+
+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/project`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add project
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install project
+
+## Usage
+
+### Running the Server
+To start the gRPC server, run the following command in the root directory of the project:
+
+```bash
+bundle exec server run
+```
+
+This will start the server and listen for incoming gRPC requests on port 50051.
+
+### Customizing the Server
+
+To customize the gRPC server, you can modify the helloworld.proto file in the lib/proto directory to define your own gRPC service and messages. You can then regenerate the Ruby code for the service using the grpc_tools_ruby_protoc command:
+
+```bash
+bundle exec grpc_tools_ruby_protoc -I lib/proto --ruby_out=lib --grpc_out=lib lib/proto/helloworld.proto
+```
+
+You can also modify the helloworld_services.rb file in the lib directory to define the logic for handling gRPC requests and responses.
+
+### Testing the Server
+
+To test the gRPC server, you can use a gRPC client to send requests to the server and verify the responses. You can find more information about creating gRPC clients in Ruby in the gRPC documentation.
+
+## 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 the created tag, 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/[USERNAME]/project. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/project/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Project project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/project/blob/main/CODE_OF_CONDUCT.md).

data/templates/Rakefile.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/templates/bin/console.erb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "project"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/templates/bin/setup.erb

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/templates/gemfile.erb

@@ -1,4 +1,13 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
+# Specify your gem's dependencies in project.gemspec
+gemspec
+
 gem "grpc"
 gem "grpc-tools"
+gem "pry", "~> 0.14.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/templates/lib/project/server.rb.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Project
+  class Server
+    attr_accessor :port
+
+    def initialize(port: "50051")
+      @port = port
+    end
+
+    def call
+      s = GRPC::RpcServer.new
+      http_port = "0.0.0.0:" + port
+      s.add_http2_port(http_port, :this_port_is_insecure)
+      s.handle(Project::Services::GreeterServer)
+      s.run_till_terminated_or_interrupted([1, "int", "SIGQUIT"])
+    end
+  end
+end

data/templates/lib/project/services/greeter_service.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "grpc"
+
+module Project
+  module Services
+    class GreeterService < Helloworld::Greeter::Service
+      def say_hello(hello_req, _unused_call)
+        Helloworld::HelloResponse.new(message: "Hello \#{hello_req.name}")
+      end
+    end
+  end
+end

data/templates/lib/project/version.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Project
+  VERSION = "0.1.0"
+end

data/templates/lib/project.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "project", "*.rb")].sort.each { |file| require file }
+
+module Project
+  class Error < StandardError; end
+end

data/templates/lib/proto.erb

@@ -0,0 +1,13 @@
+syntax = "proto3";
+
+service Greeter {
+  rpc SayHello (HelloRequest) returns (HelloResponse) {}
+}
+
+message HelloRequest {
+  string name = 1;
+}
+
+message HelloResponse {
+  string message = 1;
+}

data/templates/project.gemspec.erb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/project/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "project"
+  spec.version = Project::VERSION
+  spec.authors = ["project"]
+  spec.email = ["project@email.com"]
+
+  spec.summary = "Project summary."
+  spec.description = "Project description."
+  spec.homepage = "Project homepage URL."
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://example.com"
+  spec.metadata["changelog_uri"] = "https://example.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/templates/spec/project_spec.rb.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Project do
+  it "has a version number" do
+    expect(Project::VERSION).not_to be nil
+  end
+end

data/templates/spec/spec_helper.rb.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "project"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hadron
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Sylvance
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-30 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies: []
 description: Ruby framework called Hadron that allows you to work with gRPC Ruby output
   easily.
@@ -32,11 +32,26 @@ files:
 - lib/hadron.rb
 - lib/hadron/cli.rb
 - lib/hadron/version.rb
+- templates/.github/workflows/main.yml.erb
+- templates/.gitignore.erb
+- templates/.rspec.erb
+- templates/.rubocop.yml.erb
+- templates/CHANGELOG.md.erb
+- templates/CODE_OF_CONDUCT.md.erb
+- templates/README.md.erb
+- templates/Rakefile.erb
+- templates/bin/console.erb
+- templates/bin/setup.erb
 - templates/gemfile.erb
+- templates/lib/project.rb.erb
+- templates/lib/project/server.rb.erb
+- templates/lib/project/services/greeter_service.rb.erb
+- templates/lib/project/version.rb.erb
+- templates/lib/proto.erb
+- templates/project.gemspec.erb
 - templates/proto.erb
-- templates/readme.md
-- templates/server.rb.erb
-- templates/services.rb.erb
+- templates/spec/project_spec.rb.erb
+- templates/spec/spec_helper.rb.erb
 homepage: https://github.com/Sylvance/hadron
 licenses: []
 metadata:

data/templates/readme.md

@@ -1,53 +0,0 @@
-# Welcome to the gRPC Ruby Server Project
-
-This project is a template for creating a gRPC Ruby server using the [gRPC gem](https://github.com/grpc/grpc). It includes the necessary dependencies and files to get started with building a gRPC server in Ruby.
-
-## Prerequisites
-
-Before getting started, make sure you have the following installed on your machine:
-
-- [Ruby](https://www.ruby-lang.org/) (version 2.6 or higher)
-- [Bundler](https://bundler.io/) (for installing dependencies)
-
-## Installation
-
-To install the dependencies for this project, run the following command in the root directory of the project:
-
-```bash
-bundle install
-```
-
-## Running the Server
-To start the gRPC server, run the following command in the root directory of the project:
-
-```bash
-ruby server.rb
-```
-
-This will start the server and listen for incoming gRPC requests on port 50051.
-
-## Customizing the Server
-
-To customize the gRPC server, you can modify the helloworld.proto file in the lib/proto directory to define your own gRPC service and messages. You can then regenerate the Ruby code for the service using the grpc_tools_ruby_protoc command:
-
-```bash
-bundle exec grpc_tools_ruby_protoc -I lib/proto --ruby_out=lib --grpc_out=lib lib/proto/helloworld.proto
-```
-
-You can also modify the helloworld_services.rb file in the lib directory to define the logic for handling gRPC requests and responses.
-
-## Testing the Server
-
-To test the gRPC server, you can use a gRPC client to send requests to the server and verify the responses. You can find more information about creating gRPC clients in Ruby in the gRPC documentation.
-
-## Deployment
-
-To deploy the gRPC server, you can follow the steps for deploying a gRPC server in your preferred environment. You can find more information about deploying gRPC servers in the gRPC documentation.
-
-## Contributing
-
-We welcome contributions to this project! If you have an idea for how to improve the gRPC Ruby server template, please feel free to open an issue or pull request.
-
-## License
-
-This project is licensed under the MIT License. See the LICENSE file for more information.

data/templates/server.rb.erb

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "helloworld_services"
-
-def main
-  s = GRPC::RpcServer.new
-  s.add_http2_port("0.0.0.0:50051", :this_port_is_insecure)
-  s.handle(Helloworld::GreeterServer)
-  s.run_till_terminated_or_interrupted([1, "int", "SIGQUIT"])
-end
-
-main

data/templates/services.rb.erb

@@ -1,9 +0,0 @@
-require "grpc"
-
-module Helloworld
-  class GreeterServer < Helloworld::Greeter::Service
-    def say_hello(hello_req, _unused_call)
-      Helloworld::HelloResponse.new(message: "Hello \#{hello_req.name}")
-    end
-  end
-end