reloader_interceptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f38b4d1966eb68ac82bb3f0e2a54b0f3838aae47b3b0ebd63dbd1cda4595a680
+  data.tar.gz: f039be6691bf07498be7a7828398ffae6975df1a2eced716df74e29e0294bd1a
+SHA512:
+  metadata.gz: ff4697f459848a0c520c98c42b9910cd3f2d6d800fd95675840db70dea7ec33ccb931a742ab0daad0b27999dc3f51e0c969e060d14123ffa6d7c4aa097eca1af
+  data.tar.gz: 2e717dc1d1df328f50b3267217690ac322fa35288acd5703f5f06bd54ee9c7d0f87bc34d25b5066ec47d509e03ef4ff3a04bd6fed4cb87809097740adaee594b

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at south37777@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in reloader_interceptor.gemspec
+gemspec
+
+gem "pry"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    reloader_interceptor (0.0.1)
+      activesupport
+      grpc
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    google-protobuf (3.13.0)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    grpc (1.31.1)
+      google-protobuf (~> 3.12)
+      googleapis-common-protos-types (~> 1.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (~> 12.0)
+  reloader_interceptor!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nao Minami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# ReloaderInterceptor
+
+A gRPC interceptor for using [ActiveSupport::Reloader](https://guides.rubyonrails.org/threading_and_code_execution.html#reloader).
+
+This gem enables hot-reloading feature when used with Ruby on Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reloader_interceptor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install reloader_interceptor
+
+## Usage
+
+If you use this gem with Ruby on Rails, I recommend you to write the code like this. This code also uses [grpc_server](https://github.com/south37/grpc_server).
+
+```ruby
+# Initialization of rails here
+APP_PATH = File.expand_path('./config/application', Dir.pwd)
+require './config/boot'
+require 'rails'
+require './config/environment'
+
+# Setup ReloaderInterceptor
+require "reloader_interceptor"
+ReloaderInterceptor.enabled = Rails.env.development?  # Enable only in development
+
+# Setup gRPC server
+require "grpc_server"
+server = GrpcServer.new(
+  port:         3000,
+  threads:      30,
+  interceptors: [
+    ReloaderInterceptor::ServerInterceptor.new(
+      reloader: Rails.application.reloader
+    )  # Set interceptor here
+  ]
+)
+server.set_handler(
+  ReloaderInterceptor::Wrapper.wrap(XXX)  # Wrap gRPC service here
+)
+server.run
+```
+
+## Architecture
+There are 2 components in `ReloaderInterceptor`.
+
+### `ReloaderInterceptor::Wrapper`
+
+`Reloaderinterceptor::Wrapper` is used to wrap the original gRPC server class. For using [ActiveSupport::Reloader](https://guides.rubyonrails.org/threading_and_code_execution.html#reloader), gRPC server classes must be accessed by its name. `Wrapper` enables this.
+
+### `ReloaderInterceptor::ServerInterceptor`
+
+`ReloaderInterceptor::ServerInterceptor` is used to intercept each gRPC request. If code is changed, then constants are automatically erased in each request. You should set up an autoload environment by using [Zeitwork](https://github.com/fxn/zeitwerk) or [Ruby on Rails](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html).
+
+## 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 tags, 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/south37/reloader_interceptor. 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/south37/reloader_interceptor/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ReloaderInterceptor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/south37/reloader_interceptor/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reloader_interceptor"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -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/lib/reloader_interceptor.rb

@@ -0,0 +1,23 @@
+require_relative "./reloader_interceptor/version"
+require_relative "./reloader_interceptor/server_interceptor"
+require_relative "./reloader_interceptor/wrapper"
+
+module ReloaderInterceptor
+  @enabled = true  # Enabled by default
+
+  class << self
+    def enabled?
+      @enabled
+    end
+
+    def enable!
+      @enabled = true
+    end
+
+    def disable!
+      @enabled = false
+    end
+
+    attr_writer :enabled
+  end
+end

data/lib/reloader_interceptor/server_interceptor.rb

@@ -0,0 +1,19 @@
+require "grpc"
+
+module ReloaderInterceptor
+  class ServerInterceptor < GRPC::ServerInterceptor
+    def initialize(reloader:)
+      @reloader = reloader
+    end
+
+    def request_response(request:, call:, method:, &block)
+      return yield unless ReloaderInterceptor.enabled?
+
+      @reloader.wrap do
+        yield
+      end
+    end
+
+    # NOTE: For now, we don't support server_streamer, client_streamer and bidi_streamer
+  end
+end

data/lib/reloader_interceptor/version.rb

@@ -0,0 +1,3 @@
+module ReloaderInterceptor
+  VERSION = "0.0.1"
+end

data/lib/reloader_interceptor/wrapper.rb

@@ -0,0 +1,79 @@
+require "active_support/core_ext"
+
+module ReloaderInterceptor
+  class Wrapper
+    module DSL
+      # @param [Class] dst Wrapping class
+      # @param [String] src Wrapped class
+      def define_singleton_methods_using_class_name(dst, src)
+        src_name = src.name
+
+        src_singleton_class = src.singleton_class
+        dst_singleton_class = dst.singleton_class
+
+        public_methods    = src_singleton_class.public_instance_methods(false)
+        protected_methods = src_singleton_class.protected_instance_methods(false)
+        private_methods   = src_singleton_class.private_instance_methods(false)
+
+        [*public_methods, *protected_methods, *private_methods].each do |method|
+          dst_singleton_class.define_method method do |*args|
+            klass = src_name.constantize
+            klass.send(method, *args)
+          end
+        end
+
+        dst_singleton_class.send(:protected, *protected_methods) if protected_methods.size > 0
+        dst_singleton_class.send(:private,   *private_methods)   if private_methods.size > 0
+      end
+
+      # @param [Class] dst Wrapping class
+      # @param [String] src Wrapped class
+      def define_instance_methods_using_class_name(dst, src)
+        src_name = src.name
+
+        public_methods    = src.public_instance_methods(false)
+        protected_methods = src.protected_instance_methods(false)
+        private_methods   = src.private_instance_methods(false)
+
+        [*public_methods, *protected_methods, *private_methods].each do |method|
+          dst.define_method method do |*args|
+            klass = src_name.constantize
+            klass.new(*@options).send(method, *args)
+          end
+        end
+
+        dst.send(:protected, *protected_methods) if protected_methods.size > 0
+        dst.send(:private,   *private_methods)   if private_methods.size > 0
+      end
+    end
+
+    class << self
+      # @param [Class] klass An original class.
+      # @return [Class] A wrapping class. Return the original one if
+      #     `ReloaderInterceptor` is disabled.
+      def wrap(klass)
+        return klass unless ReloaderInterceptor.enabled?
+
+        klass_name = klass.name
+        Class.new(klass.superclass) do
+          extend Wrapper::DSL
+
+          # Define `.name` and `.inspect` to mimic the original class.
+          self.define_singleton_method :name do
+            klass_name
+          end
+          self.define_singleton_method :inspect do
+            klass_name
+          end
+
+          def initialize(*options)
+            @options = options
+          end
+
+          define_instance_methods_using_class_name(self, klass)
+          define_singleton_methods_using_class_name(self, klass)
+        end
+      end
+    end
+  end
+end

data/reloader_interceptor.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/reloader_interceptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reloader_interceptor"
+  spec.version       = ReloaderInterceptor::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{A gRPC interceptor for using ActiveSupport::Reloader.}
+  spec.description   = %q{A gRPC interceptor for using ActiveSupport::Reloader.}
+  spec.homepage      = "https://github.com/south37/reloader_interceptor"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/south37/reloader_interceptor"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "grpc"
+  spec.add_runtime_dependency "activesupport"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: reloader_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nao Minami
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gRPC interceptor for using ActiveSupport::Reloader.
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reloader_interceptor.rb
+- lib/reloader_interceptor/server_interceptor.rb
+- lib/reloader_interceptor/version.rb
+- lib/reloader_interceptor/wrapper.rb
+- reloader_interceptor.gemspec
+homepage: https://github.com/south37/reloader_interceptor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/south37/reloader_interceptor
+  source_code_uri: https://github.com/south37/reloader_interceptor
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A gRPC interceptor for using ActiveSupport::Reloader.
+test_files: []