activefunction-core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a64c7260d306142ff9c0b5e48d0cd34c9258e65af3e19bbd7aa6b1121a8a3eff
+  data.tar.gz: 14514dbbad34d5f8b64fadd0b146c5a1f90a955578cbf5e51fe161af4d5939ad
+SHA512:
+  metadata.gz: 13038598288b048965d93d6299bc7fe1feda28f28bcee220c87d5361f59060e43c07d44089279840da2c3877dd8a100aacad5b32216a692b9497f431ebab0cdc
+  data.tar.gz: 3522dd0d9db78ac518093fc9b7f4bf9be48da2593ef63fe0766e7a51b04ab729b63ef521fdc5a0f115fabac0f7207268d02cb586f3aabd50561408adabd47464

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0]
+
+- Introduce ruby-next integration

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 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,154 @@
+# 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/lib/active_function_core/version.rb

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

data/lib/active_function_core.rb

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

data/sig/active_function_core.rbs

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

data/sig/manifest.yml

@@ -0,0 +1,2 @@
+dependencies:
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: activefunction-core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nerbyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-20 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.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.3
+description: Provides core functionality, plugins and ruby-next integration for ActiveFunction
+email:
+- danil.maximov2000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/active_function_core.rb
+- lib/active_function_core/version.rb
+- sig/active_function_core.rbs
+- sig/manifest.yml
+homepage: https://github.com/DanilMaximov/activefunction
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DanilMaximov/activefunction-core
+  source_code_uri: https://github.com/DanilMaximov/activefunction-core
+  changelog_uri: https://github.com/DanilMaximov/activefunction-core/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.1.6
+signing_key: 
+specification_version: 4
+summary: ActiveFunction core gem
+test_files: []