rails_twirp 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e97be65f570cd7a2cecaaf0ef83d2ead287fd1fc8c556b833ae45395ee1c2b'
-  data.tar.gz: 1b30d280c8c724747b0b71ef7996ad23fd0a8e189818156602f284677ac9c637
+  metadata.gz: 6af836779332d2bcf1810379884b7ef9e219f63e81b2972b501a45ae1880f1cb
+  data.tar.gz: b0a967815e9326fa7889fdf1f3ec77b08f835921b8a919cee5cc95150407aa20
 SHA512:
-  metadata.gz: 858ea0680c3efd03f2f1fdc766f6097b6e0a7b19ff39974412207139cd28a432d4c620a7a4f9243b63b9f70eff1919cb5a92d0c3dc6b5cd73ba99eb1349ac870
-  data.tar.gz: ba6311d0b7cb64755380eff9d1168d24458d5804f36acf21c7fceab2a8b0db305722353d8c5f493bf1692225f973342e3194f825d995df286802da6958631e3a
+  metadata.gz: 139e2f8517c0e1b2664b0d264d4722ebdc74fde78bfdb9724ea03d31d80ab99eec66a304a25bfaec23e17ed032b5396406742993ebabc2fc464c3eea338dd5bd
+  data.tar.gz: 4df604dc7f1772238a2ea95b3e573aa352b354a58a92f9caa157add1889ba59dd95d8bbab9283dbf9632b807514c28fc21eca913b03f0bb254d57eadfbef200b

data/.github/workflows/test.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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.0"
 end

data/rails_twirp.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
 
   spec.files = `git ls-files`.split("\n")
-  spec.test_files = `git ls-files -- test/*`.split("\n")
 
   spec.add_dependency "rails", ">= 6.1.3"
   spec.add_dependency "twirp", ">= 1.7.2", "~> 1.9.0"

data/test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder

@@ -1 +1,3 @@
-pb.rpc_name @rpc_name
+pb.cache! "rpc-#{@rpc_name}", expire_in: 1.minute do
+	pb.rpc_name @rpc_name
+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.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,6 +73,7 @@ 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
@@ -170,71 +171,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: []