activefunction 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed2b67a8be1601c72b18a3be2f053a183be0a59b56b344176487ab4e628f6241
+  data.tar.gz: 48256c3c954462a328993f71897c4413bb9df5f738a48f27c221eabf9ce74b4e
+SHA512:
+  metadata.gz: f34764a21c44e461f65eaf467393316ba73119199b9c86f0d8936e8b42927858a2363528030f1e6dd420c56cc853b68f8f6a0ee7d6f2116c166aefb304890821
+  data.tar.gz: cd748cf2973a364d34000c696a638e230c333c88d4aab632544a047a5b4c339f80dd19d93142127c9d7e44528240435c249fe97c75633a268b2ddc00ebccd723

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-28
+
+- Add `before_action` and `after_action` callbacks with `:only` and `:if` options
+- Add `ActiveFunction::Base#params` with `require`, `permit`, `[]` and `to_h` public methods
+- Add specs for `ActiveFunction::Base.params` module
+- Add `ActiveFunction::Base#render` with `:status`, `:json` and `:head` options
+- Add RBS signature
+- Add RBS Aws Event Types
+- Add public interface type `steep` checking
+- Add `ruby-next` transpiler
+
+## [0.2.0] - 2023-01-08
+
+- Add unit tests
+- Fix Steep pipeline & add better RBS type signatures 
+- Refactor `::Functions` module
+- Add `Response` class
+
+## [0.3.0] - 2023-01-12
+
+- cleanup
+- add ActiveFunction::Functions::Response#commit!
+- extract action processing to separate method to handle ActiveFunction::Functions::Callbacks#process overriding
+- add test for ActiveFunction::Base.process
+
+
+# [0.3.1] - 2023-02-09
+
+- Updated readme
+- Make callbacks inheritable
+- `include` -> `prepend` Core module
+
+# [0.3.2] - 2023-02-10
+
+- Finish readme
+- Fix callbacks broken by `prepend` change
+- Add more tests for `#process` public interface

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nerbyk
+
+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,155 @@
+# ActiveFunction
+
+rails/action_controller like gem which provides lightweight callbacks, strong parameters & rendering features. It's designed to be used with AWS Lambda functions, but can be also used with any Ruby application. 
+
+Implemented with some of ruby 3.x features, but also supports ruby 2.6.x thanks to [RubyNext](https://github.com/ruby-next/ruby-next) transpiler. Type safety achieved by RBS and [Steep](https://github.com/soutaro/steep).
+
+
+
+## A Short Example
+
+Here's a simple example of a function that uses ActiveFunction:
+
+```ruby
+require 'active_function'
+
+class AppFunction < ActiveFunction::Base
+  def index 
+    render json: SomeTable.all
+  end 
+end
+```
+
+Use `#process` method to proceed the request:
+
+```ruby 
+AppFunction.process(:index) # processes index action of AppFunction instance
+```
+Also check extended [example](https://github.com/DanilMaximov/activefunction/tree/master/active_function_example)
+## Callbacks 
+ActiveFunction supports simple callbacks `:before` and `:after` which runs around provided action in `#process`. 
+
+```ruby
+class AppFunction < ActiveFunction::Base
+  before_action :set_user 
+  after_action :log_response
+  
+  # some action ...
+
+  private 
+
+  def set_user 
+    @user = User.first
+  end 
+
+  def log_response 
+    Logger.info @response 
+  end
+end
+```
+
+Callbacks also can be user  with `only: Array[Symbol]` and `if: Symbol` options.
+
+```ruby
+class AppFunction < ActiveFunction::Base
+  before_action :set_user, only: %i[show update destroy], if: :request_valid?
+  
+  # some actions ...
+  
+  private def request_valid? = true
+end
+```
+
+Callbacks are inheritable so all callbacks calls will be inherited from base class
+```ruby
+class BaseFunction < ActiveFunction::Base
+  before_action :set_current_user
+
+  def set_current_user
+    @current_user = User.first
+  end 
+end
+
+class PostsFunction < BaseFunction
+  def index
+    render json: @current_user
+  end
+end
+```
+## Strong Parameters
+ActiveFunction supports strong parameters which can be accessed by `#params` instance method. Strong parameters hash can be passed in `#process` as second argument.
+
+```ruby
+PostFunction.process(:index, data: { id: 1, name: "Pupa" })
+```
+
+Simple usage:
+```ruby
+class PostsFunction < ActiveFunction::Base
+  def index 
+    render json: permitted_params
+  end 
+
+  def permitted_params = params
+    .require(:data)
+    .permit(:id, :name)
+    .to_h
+end 
+```
+Strong params supports nested attributes
+```ruby 
+params.permit(:id, :name, :address => [:city, :street])
+```
+
+## Rendering
+ActiveFunction supports rendering of JSON. Rendering is obligatory for any function naction and can be done by `#render` method.
+```ruby
+class PostsFunction < ActiveFunction::Base
+  def index 
+    render json: { id: 1, name: "Pupa" }
+  end 
+end
+```
+default status code is 200, but it can be changed by `:status` option
+```ruby
+class PostsFunction < ActiveFunction::Base
+  def index 
+    render json: { id: 1, name: "Pupa" }, status: 201
+  end 
+end
+```
+Headers can be passed by `:headers` option. Default headers are `{"Content-Type" => "application/json"}`.
+```ruby
+class PostsFunction < ActiveFunction::Base
+  def index 
+    render json: { id: 1, name: "Pupa" }, headers: { "X-Request-Id" => "123" }
+  end 
+end
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activefunction', git: "https://github.com/DanilMaximov/activefunction.git"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake test` to run the tests and `bin/rake steep` to run type checker. 
+
+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 the created tag, 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/DanilMaximov/activefunction. 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/DanilMaximov/activefunction/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 ActiveFunction::Functions project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DanilMaximov/activefunction/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "active_function"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

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/active_function/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveFunction
+  class Base
+    require "active_function/functions/core"
+    require "active_function/functions/callbacks"
+    require "active_function/functions/strong_parameters"
+    require "active_function/functions/rendering"
+    require "active_function/functions/response"
+
+    include Functions::Core
+    include Functions::Callbacks
+    include Functions::Rendering
+    include Functions::StrongParameters
+
+    def self.process(action_name, request = {}, response = Functions::Response.new)
+      new.dispatch(action_name, request, response)
+    end
+  end
+end

data/lib/active_function/functions/callbacks.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ActiveFunction
+  class MissingCallbackContext < Error
+    MESSAGE_TEMPLATE = "Missing callback context: %s"
+
+    attr_reader :message
+
+    def initialize(context)
+      @message = MESSAGE_TEMPLATE % context
+    end
+  end
+
+  module Functions
+    module Callbacks
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      private
+
+      def process(*)
+        _run_callbacks :before
+
+        super
+
+        _run_callbacks :after
+      end
+
+      def _run_callbacks(type)
+        self.class.callbacks[type].each do |callback_method, options|
+          raise MissingCallbackContext, callback_method unless respond_to?(callback_method, true)
+
+          send(callback_method) if _executable?(options)
+        end
+      end
+
+      def _executable?(options)
+        return false if options[:only] && !options[:only].include?(@action_name)
+        return false if options[:if] && !send(options[:if])
+        true
+      end
+
+      module ClassMethods
+        def inherited(subclass)
+          subclass.instance_variable_set(:@__callbacks, @__callbacks)
+        end
+
+        def before_action(method, options = {})
+          set_callback :before, method, options
+        end
+
+        def after_action(method, options = {})
+          set_callback :after, method, options
+        end
+
+        def set_callback(type, method, options = {})
+          callbacks[type][method] = options
+        end
+
+        def callbacks
+          @__callbacks ||= {before: {}, after: {}}
+
+          @__callbacks
+        end
+      end
+    end
+  end
+end

data/lib/active_function/functions/core.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActiveFunction
+  class MissingRouteMethod < Error
+    MESSAGE_TEMPLATE = "Missing function route: %s"
+
+    attr_reader :message
+
+    def initialize(context)
+      @message = MESSAGE_TEMPLATE % context
+    end
+  end
+
+  class NotRenderedError < Error
+    MESSAGE_TEMPLATE = "render was not called: %s"
+
+    attr_reader :message
+
+    def initialize(context)
+      @message = MESSAGE_TEMPLATE % context
+    end
+  end
+
+  module Functions
+    module Core
+      attr_reader :action_name, :request, :response
+
+      def dispatch(action_name, request, response)
+        @action_name = action_name
+        @request     = request
+        @response    = response
+
+        raise MissingRouteMethod, @action_name unless respond_to?(action_name)
+
+        process(@action_name)
+
+        raise NotRenderedError, @action_name unless performed?
+
+        @response.to_h
+      end
+
+      private
+
+      def process(action) = public_send(action)
+
+      def performed? = @response.committed?
+    end
+  end
+end

data/lib/active_function/functions/rendering.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "json"
+
+module ActiveFunction
+  class DoubleRenderError < Error
+    MESSAGE_TEMPLATE = "#render was called multiple times in action: %s"
+
+    attr_reader :message
+
+    def initialize(context)
+      @message = MESSAGE_TEMPLATE % context
+    end
+  end
+
+  module Functions
+    module Rendering
+      DEFAULT_HEADER = {"Content-Type" => "application/json"}.freeze
+
+      def render(status: 200, json: {}, head: {})
+        raise DoubleRenderError, @action_name if performed?
+
+        @response.status     = status
+        @response.headers    = head.merge(Hash[DEFAULT_HEADER])
+        @response.body       = JSON.generate(json)
+
+        @response.commit!
+      end
+    end
+  end
+end

data/lib/active_function/functions/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActiveFunction
+  module Functions
+    class Response
+      attr_accessor :status, :headers, :body
+
+      def initialize(status: 200, headers: {}, body: nil)
+        @status     = status
+        @headers    = headers
+        @body       = body
+        @committed  = false
+      end
+
+      def to_h
+        {
+          statusCode: status,
+          headers:    headers,
+          body:       body
+        }
+      end
+
+      def commit!
+        @committed = true
+      end
+
+      def committed? = @committed
+    end
+  end
+end

data/lib/active_function/functions/strong_parameters.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module ActiveFunction
+  class ParameterMissingError < Error
+    MESSAGE_TEMPLATE = "Missing parameter: %s"
+
+    attr_reader :message
+
+    def initialize(param)
+      MESSAGE_TEMPLATE % param
+    end
+  end
+
+  class UnpermittedParameterError < Error
+    MESSAGE_TEMPLATE = "Unpermitted parameter: %s"
+
+    attr_reader :message
+
+    def initialize(param)
+      MESSAGE_TEMPLATE % param
+    end
+  end
+
+  module Functions
+    module StrongParameters
+      def params
+        @_params ||= Parameters.new(@request)
+      end
+
+      class Parameters
+        extend Forwardable
+        def_delegators :@parameters, :each, :map
+        include Enumerable
+
+        def initialize(parameters, permitted: false)
+          @parameters = parameters
+          @permitted  = permitted
+        end
+
+        def [](attribute)
+          nested_attribute(parameters[attribute])
+        end
+
+        def require(attribute)
+          value = self[attribute]
+
+          raise ParameterMissingError, attribute if value.nil?
+
+          value
+        end
+
+        def permit(*attributes)
+          pparams = {}
+
+          attributes.each do |attribute|
+            if attribute.is_a? Hash
+              attribute.each do |k, v|
+                pparams[k] = process_nested(self[k], :permit, v)
+              end
+            else
+              next unless parameters.key?(attribute)
+
+              pparams[attribute] = self[attribute]
+            end
+          end
+
+          Parameters.new(pparams, permitted: true)
+        end
+
+        def to_h
+          raise UnpermittedParameterError, parameters.keys unless @permitted
+
+          parameters.transform_values { process_nested(_1, :to_h) }
+        end
+
+        private
+
+        def nested_attribute(attribute)
+          if attribute.is_a? Hash
+            Parameters.new(attribute)
+          elsif attribute.is_a?(Array) && attribute[0].is_a?(Hash)
+            attribute.map { Parameters.new(_1) }
+          else
+            attribute
+          end
+        end
+
+        def process_nested(attribute, method, options = [])
+          if attribute.is_a? Parameters
+            attribute.send(method, *options)
+          elsif attribute.is_a?(Array) && attribute[0].is_a?(Parameters)
+            attribute.map { _1.send(method, *options) }
+          else
+            attribute
+          end
+        end
+
+        attr_reader :parameters
+      end
+    end
+  end
+end

data/lib/active_function/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveFunction
+  VERSION = "0.3.3"
+end

data/lib/active_function.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "ruby-next"
+require "ruby-next/language/setup"
+
+RubyNext::Language.setup_gem_load_path(transpile: true)
+
+module ActiveFunction
+  class Error < StandardError; end
+
+  require "active_function/version"
+  require "active_function/base"
+end

data/sig/active_function.rbs

@@ -0,0 +1,4 @@
+module ActiveFunction
+  class Error < StandardError
+  end
+end

data/sig/manifest.yml

@@ -0,0 +1,3 @@
+dependencies:
+  - name: json
+  - name: forwardable

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: activefunction
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+platform: ruby
+authors:
+- Nerbyk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-next-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: ruby-next
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.15.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+description: "\n    rails/action_controller like gem which provides lightweight callbacks,\n
+  \   strong parameters & rendering features. It's designed to be used with\n    AWS
+  Lambda functions, but can be also used with any Ruby application.\n\n    Implemented
+  with some of ruby 3.x features, but also supports\n    ruby 2.6.x thanks to RubyNext
+  transpiler. Type safety achieved\n    by RBS and Steep.\n  "
+email:
+- danil.maximov2000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/rake
+- bin/setup
+- lib/active_function.rb
+- lib/active_function/base.rb
+- lib/active_function/functions/callbacks.rb
+- lib/active_function/functions/core.rb
+- lib/active_function/functions/rendering.rb
+- lib/active_function/functions/response.rb
+- lib/active_function/functions/strong_parameters.rb
+- lib/active_function/version.rb
+- sig/active_function.rbs
+- sig/manifest.yml
+homepage: https://github.com/DanilMaximov/acitvefunction
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DanilMaximov/activefunction
+  source_code_uri: https://github.com/DanilMaximov/activefunction
+  changelog_uri: https://github.com/DanilMaximov/activefunction/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: rails/action_controller like gem which provides callbacks, strong parameters
+  & rendering features.
+test_files: []