functions_framework 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3617730e13cd2afd38e965af84113775a0e86912534f7df9e7f86f9cc2ea5a
-  data.tar.gz: b690b2ca31e48c07a175d6f452e6877e3fdedc4ee2d808457991de3ae32e9595
+  metadata.gz: 7dc90045c947a92ef29d14a88cccc1a31c82969912b7eca410ff7423bea52cc1
+  data.tar.gz: f678ef25e7883451be774b9dffacb8538971cd6d2211dfeac6a9f7886803ca5f
 SHA512:
-  metadata.gz: 107994559b7e92c7f07d7b5fbfbc34d8dcb82552fbc68edf93c3c577305a7a07c23fdc2300105b7e5c5738265a17cd61fa7ac652019853f962ba00d0f470919d
-  data.tar.gz: 0b1f96299d973e999e48a3d9ba94d9bbed4cecf3d4909387aa2ccb57fa85360991e82caa1507f415fd798f936869b06df4a421770a21fde8d741263ecdcc42c4
+  metadata.gz: c148723f894e7b341780fd43f32938e96fa8de48fca7e8e60f25def589de0fcd05433508e25c756617bcf7bcd58a98793cd0a8112974fd4d4c9cc65aceaa728f
+  data.tar.gz: b0913575ae419000ca0ea74b9f70cea6ecd96126955b27ffb27887b55d90f3abf5f84e5bfafd87c419f960cb683a92118c62252394c79be631cd407057ae43d9

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+### 1.5.0 (2025-01-03)
+
+#### Features
+
+* Support pidfile in CLI & Server (defaults to puma.pid) ([#178](https://github.com/GoogleCloudPlatform/functions-framework-ruby/issues/178)) 
+
+### 1.4.2 (2024-09-18)
+
+#### Bug Fixes
+
+* typo in cli help ([#196](https://github.com/GoogleCloudPlatform/functions-framework-ruby/issues/196)) 
+#### Documentation
+
+* fix a broken link to the rack SPEC 
+
 ### 1.4.1 (2023-06-27)
 
 #### Bug Fixes

data/README.md

@@ -4,8 +4,7 @@ An open source framework for writing lightweight, portable Ruby functions that
 run in a serverless environment. Functions written to this Framework will run
 in many different environments, including:
 
- *  [Google Cloud Functions](https://cloud.google.com/functions)
- *  [Google Cloud Run](https://cloud.google.com/run)
+ *  [Google Cloud Run functions](https://cloud.google.com/functions)
  *  Any other [Knative](https://github.com/knative)-based environment
  *  Your local development machine
 
@@ -113,8 +112,7 @@ These guides provide additional getting-started information.
     functions server.
  *  **[Deploying Functions](https://googlecloudplatform.github.io/functions-framework-ruby/latest/file.deploying-functions.html)**
     : How to deploy functions to
-    [Google Cloud Functions](https://cloud.google.com/functions) or
-    [Google Cloud Run](https://cloud.google.com/run).
+    [Google Cloud Run functions](https://cloud.google.com/functions)
 
 The library reference documentation can be found at:
 https://googlecloudplatform.github.io/functions-framework-ruby

data/lib/functions_framework/cli.rb

@@ -36,6 +36,7 @@ module FunctionsFramework
       @source = ::ENV["FUNCTION_SOURCE"] || ::FunctionsFramework::DEFAULT_SOURCE
       @env = nil
       @port = nil
+      @pidfile = nil
       @bind = nil
       @min_threads = nil
       @max_threads = nil
@@ -67,6 +68,12 @@ module FunctionsFramework
     #
     attr_reader :error_message
 
+    ##
+    # @return [String] The pidfile.
+    # @return [nil] if not running.
+    #
+    attr_reader :pidfile
+
     ##
     # Parse the given command line arguments.
     # Exits if argument parsing failed.
@@ -89,6 +96,9 @@ module FunctionsFramework
               "Supported values are 'http' and 'cloudevent'." do |val|
           @signature_type = val
         end
+        op.on "-P", "--pidfile PIDFILE", "Set the pidfile for the server (defaults to puma.pid)" do |val|
+          @pidfile = val
+        end
         op.on "-p", "--port PORT", "Set the port to listen to (defaults to 8080)" do |val|
           @port = val.to_i
         end
@@ -98,10 +108,10 @@ module FunctionsFramework
         op.on "-e", "--environment ENV", "Set the Rack environment" do |val|
           @env = val
         end
-        op.on "--min-threads NUM", "Set the minimum threead pool size" do |val|
+        op.on "--min-threads NUM", "Set the minimum thread pool size" do |val|
           @min_threads = val
         end
-        op.on "--max-threads NUM", "Set the maximum threead pool size" do |val|
+        op.on "--max-threads NUM", "Set the maximum thread pool size" do |val|
           @max_threads = val
         end
         op.on "--[no-]detailed-errors", "Set whether to show error details" do |val|
@@ -218,6 +228,7 @@ module FunctionsFramework
       ::FunctionsFramework.start function do |config|
         config.rack_env = @env
         config.port = @port
+        config.pidfile = @pidfile
         config.bind_addr = @bind
         config.show_error_details = @detailed_errors
         config.min_threads = @min_threads

data/lib/functions_framework/server.rb

@@ -152,6 +152,24 @@ module FunctionsFramework
       @server&.thread&.alive?
     end
 
+    ##
+    # Returns pidfile if server is currently running
+    #
+    # @return [String, nil]
+    #
+    def pidfile
+      @config.pidfile if running?
+    end
+
+    ##
+    # Returns whether pidfile is present.
+    #
+    # @return [Boolean]
+    #
+    def pidfile?
+      !!@config.pidfile && running?
+    end
+
     ##
     # Cause this server to respond to SIGTERM, SIGINT, and SIGHUP by shutting
     # down gracefully.
@@ -214,6 +232,7 @@ module FunctionsFramework
         self.rack_env = nil
         self.bind_addr = nil
         self.port = nil
+        self.pidfile = nil
         self.min_threads = nil
         self.max_threads = nil
         self.show_error_details = nil
@@ -245,6 +264,14 @@ module FunctionsFramework
         @port = (port || ::ENV["PORT"] || 8080).to_i
       end
 
+      ##
+      # Set the pidfile string, or `nil` to use the default.
+      # @param path [String,nil]
+      #
+      def pidfile= path
+        @pidfile = (path || ::ENV["PIDFILE"] || "puma.pid").to_s
+      end
+
       ##
       # Set the minimum number of worker threads, or `nil` to use the default.
       # @param min_threads [Integer,nil]
@@ -306,6 +333,14 @@ module FunctionsFramework
         @port
       end
 
+      ##
+      # Returns the current pidfile string.
+      # @return [String]
+      #
+      def pidfile
+        @pidfile
+      end
+
       ##
       # Returns the minimum number of worker threads in the thread pool.
       # @return [Integer]

data/lib/functions_framework/version.rb

@@ -17,5 +17,5 @@ module FunctionsFramework
   # Version of the Ruby Functions Framework
   # @return [String]
   #
-  VERSION = "1.4.1".freeze
+  VERSION = "1.5.0".freeze
 end

data/lib/functions_framework.rb

@@ -121,7 +121,7 @@ module FunctionsFramework
     # function. The block should take a single `Rack::Request` argument. It
     # should return one of the following:
     #  *  A standard 3-element Rack response array. See
-    #     https://github.com/rack/rack/blob/master/SPEC
+    #     https://github.com/rack/rack/blob/main/SPEC.rdoc
     #  *  A `Rack::Response` object.
     #  *  A simple String that will be sent as the response body.
     #  *  A Hash object that will be encoded as JSON and sent as the response

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: functions_framework
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cloud_events
@@ -106,10 +106,10 @@ homepage: https://github.com/GoogleCloudPlatform/functions-framework-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.4.1/file.CHANGELOG.html
+  changelog_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.5.0/file.CHANGELOG.html
   source_code_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby
   bug_tracker_uri: https://github.com/GoogleCloudPlatform/functions-framework-ruby/issues
-  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.4.1
+  documentation_uri: https://googlecloudplatform.github.io/functions-framework-ruby/v1.5.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Functions Framework for Ruby