rails_twirp 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57a19d4ec190c08eaece39ae6867d9aee3f2b83a3196384f8b0a16c03fbf9739
-  data.tar.gz: 225ce5477525001c7c401af85a98e68d3fe7543bcf20e2fa9bdcd13f34a77a4b
+  metadata.gz: 8df8457b09993d7d5c986130e724948df049c201b6797f33a7b66458bde98918
+  data.tar.gz: 0a2100cbefd37754f9dbd6cf666def1c29d0936322f72837d7e60653b5510b79
 SHA512:
-  metadata.gz: 7991a7f8707e4f6b28055808edc662c1ec93a9723b059421621cdf0cc461704bc766abeea63e9881382675280f6321b4e3cba941527a684a920733be3ce7a977
-  data.tar.gz: ea05bca838330b1526da0a6844783d7b5f9ab6cd2403050c318670f2d7a96b8c892d017c2b052b99f5063dde40331cf7b4486b084764adf85613c84c6b8e0da0
+  metadata.gz: 1b50c23cd6fa8852686ca96066c0a65a532f06ec0225b5ed04ac860218760d187e868d0b3d499855527ed23d355dacf8bf33eb1aaf2fd1b590b29aa12c8e836a
+  data.tar.gz: 461fe47bbafdd0bcf304f48b4938f307fd380d7bbce7049a703c60f7bc781b0f58b1cf06b7410c4a168e39441b1a9bd49b5091a0dbfc3472870c002bef6f51e1

data/lib/rails_twirp/mapper.rb

@@ -0,0 +1,83 @@
+require "forwardable"
+
+module RailsTwirp
+  class ServiceMapper
+    class Mapping
+      attr_reader :controller, :action
+
+      def initialize(to:, **options)
+        controller, @action = split_to(to)
+        @controller = add_controller_module(controller, options.delete(:module))
+        raise ArgumentError, "Unknown argument #{options.keys.first}" unless options.empty?
+      end
+
+      def to_s
+        "#{controller}##{action}"
+      end
+
+      private
+
+      # copied from Rails
+      def split_to(to)
+        if /#/.match?(to)
+          to.split("#").map!(&:-@)
+        else
+          []
+        end
+      end
+
+      def add_controller_module(controller, modyoule)
+        return controller unless modyoule
+
+        if controller&.start_with?("/")
+          -controller[1..]
+        else
+          -[modyoule, controller].compact.join("/")
+        end
+      end
+    end
+
+    extend Forwardable
+    def_delegator :@mapper, :scope
+
+    def initialize(service_route_set, mapper)
+      @service_route_set = service_route_set
+      @mapper = mapper
+    end
+
+    def rpc(name, to:)
+      mapping = Mapping.new(to: to, module: @mapper.send(:_module))
+      @service_route_set.add_route(name, mapping)
+    end
+  end
+
+  class Mapper
+    def initialize(route_set)
+      @route_set = route_set
+      @module = nil
+    end
+
+    def service(service_definition, **options, &block)
+      service_route_set = @route_set.services[service_definition]
+      service_mapper = ServiceMapper.new(service_route_set, self)
+      scope(**options) { service_mapper.instance_exec(&block) }
+    end
+
+    def scope(**options)
+      last_module = @module
+      if (modyoule = options.delete(:module))
+        @module = @module.nil? ? modyoule : "#{@module}/#{modyoule}"
+      end
+      raise ArgumentError, "Unknown scope argument #{options.keys.first}" unless options.empty?
+      yield
+    ensure
+      @module = last_module
+    end
+
+    private
+
+    def _module
+      @module
+    end
+  end
+end

data/lib/rails_twirp/route_set.rb

@@ -1,5 +1,7 @@
 # Most of this logic is stolen from Rails ActionDispatch::Routing::RouteSet
 
+require "rails_twirp/mapper"
+
 module RailsTwirp
   class UnknownRpcError < StandardError; end
 
@@ -66,51 +68,5 @@ module RailsTwirp
         service
       end
     end
-
-    class Mapping
-      attr_reader :controller, :action
-
-      def initialize(to:)
-        @controller, @action = split_to(to)
-      end
-
-      def to_s
-        "#{controller}##{action}"
-      end
-
-      private
-
-      # copied from Rails
-      def split_to(to)
-        if /#/.match?(to)
-          to.split("#").map!(&:-@)
-        else
-          []
-        end
-      end
-    end
-
-    class ServiceMapper
-      def initialize(service_route_set)
-        @service_route_set = service_route_set
-      end
-
-      def rpc(name, to:)
-        mapping = Mapping.new(to: to)
-        @service_route_set.add_route(name, mapping)
-      end
-    end
-
-    class Mapper
-      def initialize(route_set)
-        @route_set = route_set
-      end
-
-      def service(service_definition, &block)
-        service_route_set = @route_set.services[service_definition]
-        service_mapper = ServiceMapper.new(service_route_set)
-        service_mapper.instance_exec(&block)
-      end
-    end
   end
 end

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

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

@@ -0,0 +1,10 @@
+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/config/twirp/routes.rb

@@ -10,4 +10,12 @@ Rails.application.twirp.routes.draw do
     rpc "UncaughtError", to: "pings#uncaught_raise"
     rpc "BeforeError", to: "pings#before_error"
   end
+
+  scope module: :testmod do
+    service RPC::DummyAPI::DummyService do
+      scope module: "nested" do
+        rpc "Nested", to: "other#ping"
+      end
+    end
+  end
 end

data/test/dummy/proto/api.proto

@@ -12,6 +12,7 @@ service Dummy {
   rpc RaiseError(PingRequest) returns (PingResponse);
   rpc UncaughtError(PingRequest) returns (PingResponse);
   rpc BeforeError(PingRequest) returns (PingResponse);
+  rpc Nested(PingRequest) returns (PingResponse);
 }
 
 message PingRequest {

data/test/dummy/proto/api_twirp.rb

@@ -14,6 +14,7 @@ module RPC
       rpc :RaiseError, PingRequest, PingResponse, :ruby_method => :raise_error
       rpc :UncaughtError, PingRequest, PingResponse, :ruby_method => :uncaught_error
       rpc :BeforeError, PingRequest, PingResponse, :ruby_method => :before_error
+      rpc :Nested, PingRequest, PingResponse, :ruby_method => :nested
     end
 
     class DummyClient < Twirp::Client

data/test/other_controller_test.rb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+class OtherControllerTest < RailsTwirp::IntegrationTest
+  test "modules work" do
+    req = RPC::DummyAPI::PingRequest.new(name: "Bouke")
+    rpc RPC::DummyAPI::DummyService, "Nested", req
+    assert_equal "BoukeBouke", response.double_name
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_twirp
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Bouke van der Bijl
@@ -59,6 +59,7 @@ files:
 - lib/rails_twirp/base.rb
 - lib/rails_twirp/engine.rb
 - lib/rails_twirp/errors.rb
+- lib/rails_twirp/mapper.rb
 - lib/rails_twirp/render_pb.rb
 - lib/rails_twirp/rescue.rb
 - lib/rails_twirp/route_set.rb
@@ -76,6 +77,7 @@ files:
 - test/dummy/app/controllers/application_twirp_controller.rb
 - test/dummy/app/controllers/concerns/.keep
 - 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
@@ -126,6 +128,7 @@ files:
 - test/dummy/public/apple-touch-icon-precomposed.png
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
+- test/other_controller_test.rb
 - test/ping_controller_test.rb
 - test/rails_twirp_test.rb
 - test/test_helper.rb
@@ -163,6 +166,7 @@ test_files:
 - test/dummy/app/controllers/application_twirp_controller.rb
 - test/dummy/app/controllers/concerns/.keep
 - 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
@@ -213,6 +217,7 @@ test_files:
 - test/dummy/public/apple-touch-icon-precomposed.png
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
+- test/other_controller_test.rb
 - test/ping_controller_test.rb
 - test/rails_twirp_test.rb
 - test/test_helper.rb