rails_twirp 0.12.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e97be65f570cd7a2cecaaf0ef83d2ead287fd1fc8c556b833ae45395ee1c2b'
-  data.tar.gz: 1b30d280c8c724747b0b71ef7996ad23fd0a8e189818156602f284677ac9c637
+  metadata.gz: d04982e98774e2a130671b2729dad6141905df3544c7cfa3900137a7cd553356
+  data.tar.gz: 650187fd3c34f30ca91885c6c1fa9b1547035a816d088e0b8c583f9ea6a0608e
 SHA512:
-  metadata.gz: 858ea0680c3efd03f2f1fdc766f6097b6e0a7b19ff39974412207139cd28a432d4c620a7a4f9243b63b9f70eff1919cb5a92d0c3dc6b5cd73ba99eb1349ac870
-  data.tar.gz: ba6311d0b7cb64755380eff9d1168d24458d5804f36acf21c7fceab2a8b0db305722353d8c5f493bf1692225f973342e3194f825d995df286802da6958631e3a
+  metadata.gz: 4021ee3e130f4647423177456c9ccfb5bcce728874b547f56c2ae52a78fc92a953f6e98e7dee7eb87c78adca37f4f42cd21c7761f3842f20859923a3a8b8096f
+  data.tar.gz: bcb8240668e0c0d59f63ad7148595fcf15142533bed252e6f55212f51a73df0f31a623ca97f675c1494712631ffb025b20f71956dbfaa71ba61d9d48e12f2512

data/.standard.yml

@@ -1,4 +1,3 @@
 ignore:
-  - 'test/dummy/proto/*'
   - '**/*':
     - Lint/RescueException

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.13.1
+* Don't include `test/` folder in a final gem distribution
+* Format dummy app code with standardrb
+
+### 0.13.0
+* Adding #controller_name methods to Metal/Base controller (used for instrumentation)
+* Include `ActionController::Caching` with Base controller/helpers
+
+
 ### 0.12.0
 
 * Allow a custom exception handling proc to be assigned using `RailsTwirp.unhandled_exception_handler`

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "sqlite3"
-gem "pbbuilder", "~> 0.12.0"
+gem "pbbuilder"
 gem "standard"
 gem "pry"
 

data/lib/rails_twirp/base.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require "abstract_controller/base"
 require "abstract_controller/rendering"
 require "action_view/rendering"
 require "rails_twirp/render_pb"
 require "rails_twirp/errors"
 require "abstract_controller/asset_paths"
-require "abstract_controller/caching"
 require "abstract_controller/logger"
 require "abstract_controller/callbacks"
 require "action_controller/metal/helpers"
@@ -13,11 +14,10 @@ require "rails_twirp/url_for"
 require "rails_twirp/implicit_render"
 require "rails_twirp/instrumentation"
 require "rails_twirp/exception_handling"
+require "rails_twirp/metal"
 
 module RailsTwirp
-  class Base < AbstractController::Base
-    abstract!
-
+  class Base < RailsTwirp::Metal
     # The order of these includes matter.
     # The rendering modules extend each other, so need to be in this order.
     include AbstractController::Rendering
@@ -26,7 +26,6 @@ module RailsTwirp
     include ActionController::Helpers
     include UrlFor
     include AbstractController::AssetPaths
-    include AbstractController::Caching
 
     include ActionView::Rendering
     include RenderPb
@@ -39,7 +38,14 @@ module RailsTwirp
     include Instrumentation
     include ExceptionHandling
 
-    attr_internal :request, :env, :response_class, :rpc_name
+    ##
+    # :attr_reader: request
+    #
+    # The ActionDispatch::Request instance for the current request.
+    attr_internal :request
+
+    attr_internal :env, :response_class, :rpc_name
+
     def initialize
       @_request = nil
       @_env = nil

data/lib/rails_twirp/engine.rb

@@ -34,7 +34,11 @@ module RailsTwirp
 
     initializer "rails_twirp.helpers" do |app|
       ActiveSupport.on_load(:rails_twirp) do
-        # Load all the application helpers into the controller
+        # Load all the application helpers into the controller.
+        # Note that helpers need to be set up here, because apparently
+        # the AbstractController::Helpers module won't be able to find
+        # the _helpers method on a reloaded controller
+        include ActionController::Caching
         include app.routes.mounted_helpers
         extend ::AbstractController::Railties::RoutesHelpers.with(app.routes, false)
         extend ::ActionController::Railties::Helpers

data/lib/rails_twirp/metal.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsTwirp
+  # This is a simplest possible controller, providing a valid
+  # Rack interfacee without the additional niceties provided by RailsTwirp.
+  #
+  # Idiologially, it's similar to Rails version of ActionController::Metal
+  class Metal < AbstractController::Base
+    abstract!
+
+    # Returns the last part of the controller's name, underscored, without the ending
+    # <tt>Controller</tt>. For instance, PostsController returns <tt>posts</tt>.
+    # Namespaces are left out, so Admin::PostsController returns <tt>posts</tt> as well.
+    #
+    # ==== Returns
+    # * <tt>string</tt>
+    def self.controller_name
+      @controller_name ||= (name.demodulize.delete_suffix("Controller").underscore unless anonymous?)
+    end
+
+    # Delegates to the class's ::controller_name.
+    def controller_name
+      self.class.controller_name
+    end
+  end
+end

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.12.0"
+  VERSION = "0.13.1"
 end

data/rails_twirp.gemspec

@@ -9,10 +9,9 @@ Gem::Specification.new do |spec|
   spec.summary = "Integrate Twirp into Rails"
   spec.license = "MIT"
 
-  spec.files = `git ls-files`.split("\n")
-  spec.test_files = `git ls-files -- test/*`.split("\n")
+  spec.files = `git ls-files | grep -v -E "test/*"`.split("\n")
 
   spec.add_dependency "rails", ">= 6.1.3"
-  spec.add_dependency "twirp", ">= 1.7.2", "~> 1.9.0"
+  spec.add_dependency "twirp", ">= 1.9", "< 1.11"
   spec.required_ruby_version = ">= 3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_twirp
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
-    - - "~>"
+        version: '1.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
-    - - "~>"
+        version: '1.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: '1.11'
 description:
 email:
 - bouke@cheddar.me
@@ -52,7 +52,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
-- ".github/workflows/test.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".standard.yml"
@@ -61,7 +60,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- bin/test
 - lib/commands/twirp/routes_command.rb
 - lib/rails_twirp.rb
 - lib/rails_twirp/application.rb
@@ -73,80 +71,13 @@ files:
 - lib/rails_twirp/instrumentation.rb
 - lib/rails_twirp/log_subscriber.rb
 - lib/rails_twirp/mapper.rb
+- lib/rails_twirp/metal.rb
 - lib/rails_twirp/render_pb.rb
 - lib/rails_twirp/rescue.rb
 - lib/rails_twirp/route_set.rb
-- lib/rails_twirp/testing/integration_test.rb
 - lib/rails_twirp/url_for.rb
 - lib/rails_twirp/version.rb
 - rails_twirp.gemspec
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/application_twirp_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/dummy_controller.rb
-- test/dummy/app/controllers/pings_controller.rb
-- test/dummy/app/controllers/testmod/nested/other_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/helpers/random_helper.rb
-- test/dummy/app/javascript/packs/application.js
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/layouts/mailer.html.erb
-- test/dummy/app/views/layouts/mailer.text.erb
-- test/dummy/app/views/pings/ping_template.pb.pbbuilder
-- test/dummy/bin/generate
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/cable.yml
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/permissions_policy.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/storage.yml
-- test/dummy/config/twirp/routes.rb
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/proto/api.proto
-- test/dummy/proto/api_pb.rb
-- test/dummy/proto/api_twirp.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/dummy_test.rb
-- test/other_controller_test.rb
-- test/ping_controller_test.rb
-- test/rails_twirp_test.rb
-- test/test_helper.rb
 homepage: https://github.com/cheddar-me/rails-twirp
 licenses:
 - MIT
@@ -170,71 +101,4 @@ rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Integrate Twirp into Rails
-test_files:
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/application_twirp_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/dummy_controller.rb
-- test/dummy/app/controllers/pings_controller.rb
-- test/dummy/app/controllers/testmod/nested/other_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/helpers/random_helper.rb
-- test/dummy/app/javascript/packs/application.js
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/layouts/mailer.html.erb
-- test/dummy/app/views/layouts/mailer.text.erb
-- test/dummy/app/views/pings/ping_template.pb.pbbuilder
-- test/dummy/bin/generate
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/cable.yml
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/permissions_policy.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/storage.yml
-- test/dummy/config/twirp/routes.rb
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/proto/api.proto
-- test/dummy/proto/api_pb.rb
-- test/dummy/proto/api_twirp.rb
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/dummy_test.rb
-- test/other_controller_test.rb
-- test/ping_controller_test.rb
-- test/rails_twirp_test.rb
-- test/test_helper.rb
+test_files: []

data/.github/workflows/test.yml

@@ -1,21 +0,0 @@
-name: Ruby Test
-on: push
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0.0
-          bundler-cache: true
-
-      - name: Run tests
-        run: bin/test
-
-      - name: Run standardrb
-        run: bundle exec standardrb

data/bin/test

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-$: << File.expand_path("../test", __dir__)
-
-require "bundler/setup"
-require "rails/plugin/test"

data/lib/rails_twirp/testing/integration_test.rb

@@ -1,106 +0,0 @@
-require "twirp/encoding"
-
-module RailsTwirp
-  class IntegrationTest < ActiveSupport::TestCase
-    DEFAULT_HOST = "www.example.com"
-    Response = Struct.new(:status, :body, :headers)
-
-    attr_reader :response, :request, :controller
-    attr_writer :mount_path
-    alias_method :mount_path!, :mount_path=
-
-    def initialize(name)
-      super
-      reset!
-      @before_rpc = []
-    end
-
-    def host
-      @host || DEFAULT_HOST
-    end
-    attr_writer :host
-    alias_method :host!, :host=
-
-    def https?
-      @https
-    end
-
-    def https!(value = true)
-      @https = value
-    end
-
-    def reset!
-      @request = nil
-      @response = nil
-      @host = nil
-      @host = nil
-      @https = false
-      @mount_path = "/twirp"
-    end
-
-    def before_rpc(&block)
-      @before_rpc << block
-    end
-
-    def rpc(service, rpc, request, headers: nil)
-      @request = request
-
-      env = build_rack_env(service, rpc, request, headers)
-      @before_rpc.each do |hook|
-        hook.call(env)
-      end
-
-      status, headers, body = app.call(env)
-      @response = decode_rack_response(service, rpc, status, headers, body)
-      set_controller_from_rack_env(env)
-
-      @response
-    end
-
-    def app
-      RailsTwirp.test_app
-    end
-
-    private
-
-    def build_rack_env(service, rpc, request, headers)
-      env = {
-        "CONTENT_TYPE" => request_content_type,
-        "HTTPS" => https? ? "on" : "off",
-        "HTTP_HOST" => host,
-        "PATH_INFO" => "#{@mount_path}/#{service.service_full_name}/#{rpc}",
-        "REQUEST_METHOD" => "POST",
-        "SERVER_NAME" => host,
-        "SERVER_PORT" => https? ? "443" : "80",
-        "rack.url_scheme" => https? ? "https" : "http"
-      }
-      if headers.present?
-        http_request = ActionDispatch::Request.new(env)
-        http_request.headers.merge! headers
-      end
-
-      input_class = service.rpcs[rpc][:input_class]
-      env["rack.input"] = StringIO.new(Twirp::Encoding.encode(request, input_class, request_content_type))
-      env
-    end
-
-    def request_content_type
-      Twirp::Encoding::PROTO
-    end
-
-    def decode_rack_response(service, rpc, status, headers, body)
-      body = body.join # body is an Enumerable
-
-      if status === 200
-        output_class = service.rpcs[rpc][:output_class]
-        Twirp::Encoding.decode(body, output_class, headers["Content-Type"])
-      else
-        Twirp::Client.error_from_response(Response.new(status, body, headers))
-      end
-    end
-
-    def set_controller_from_rack_env(env)
-      @controller = ActionDispatch::Request.new(env).controller_instance
-    end
-  end
-end

data/test/dummy/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative "config/application"
-
-Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -1,2 +0,0 @@
-//= link_tree ../images
-//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/test/dummy/app/channels/application_cable/channel.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Channel < ActionCable::Channel::Base
-  end
-end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -1,4 +0,0 @@
-module ApplicationCable
-  class Connection < ActionCable::Connection::Base
-  end
-end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::Base
-end

data/test/dummy/app/controllers/application_twirp_controller.rb

@@ -1,7 +0,0 @@
-class ApplicationTwirpController < RailsTwirp::Base
-  rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
-
-  def handle_not_found
-    error :not_found, "Not found"
-  end
-end

data/test/dummy/app/controllers/dummy_controller.rb

@@ -1,5 +0,0 @@
-class DummyController < RailsTwirp::Base
-  def rpc_name_check
-    @rpc_name = rpc_name
-  end
-end

data/test/dummy/app/controllers/pings_controller.rb

@@ -1,40 +0,0 @@
-class PingsController < ApplicationTwirpController
-  before_action :respond_error, only: :before_error
-
-  def ping
-    response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
-    self.response_body = response
-  end
-
-  def ping_render
-    url = rails_twirp_engine_url
-    response = RPC::DummyAPI::PingResponse.new(double_name: "#{url} #{helpers.does_this_work(request.name)}")
-    render pb: response
-  end
-
-  def ping_template
-    @double_name = request.name * 2
-  end
-
-  def error_response
-    error :unauthenticated, "You are not authenticated!!"
-  end
-
-  def raise_error
-    # This error is rescued in ApplicationTwirpController
-    raise ActiveRecord::RecordNotFound, "Not found"
-  end
-
-  def uncaught_raise
-    raise StandardError, "Uncaught"
-  end
-
-  def before_error
-    # This error won't be reached because of the before_action
-    raise NotImplementedError
-  end
-
-  def respond_error
-    error :malformed, "yOuR ReQuEsT Is mAlFoRmEd"
-  end
-end

data/test/dummy/app/controllers/testmod/nested/other_controller.rb

@@ -1,10 +0,0 @@
-module Testmod
-  module Nested
-    class OtherController < ApplicationTwirpController
-      def ping
-        response = RPC::DummyAPI::PingResponse.new(double_name: request.name * 2)
-        self.response_body = response
-      end
-    end
-  end
-end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy/app/helpers/random_helper.rb

@@ -1,5 +0,0 @@
-module RandomHelper
-  def does_this_work(n)
-    n * 2
-  end
-end

data/test/dummy/app/javascript/packs/application.js

@@ -1,15 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require rails-ujs
-//= require activestorage
-//= require_tree .

data/test/dummy/app/jobs/application_job.rb

@@ -1,7 +0,0 @@
-class ApplicationJob < ActiveJob::Base
-  # Automatically retry jobs that encountered a deadlock
-  # retry_on ActiveRecord::Deadlocked
-
-  # Most jobs are safe to ignore if the underlying records are no longer available
-  # discard_on ActiveJob::DeserializationError
-end

data/test/dummy/app/mailers/application_mailer.rb

@@ -1,4 +0,0 @@
-class ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/test/dummy/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end