kirei 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8beff5327a463020ae69872995aa9a5101e492f23fa886f6a29e45cfb173728c
-  data.tar.gz: a2ec68b1e7e7f182d42587d4e73b3736636d883b7d5f93a804956366368467d2
+  metadata.gz: b67435621f32def7ede1b291b5d0fe529125bda4dd34149afa5b7db6d2193ddd
+  data.tar.gz: fb6c0e91a22bdb8cf726f638c5a250c5245c9a2de4e662f853d2b436a865d2fe
 SHA512:
-  metadata.gz: 7bc7eef26e4ed940d91a425c69a447a585a76c2512132b1986b927652bc5331dddd6e77fc279ee65d7739e9d991bd1881c8c421023e1b4b25f70d5ae0224bd79
-  data.tar.gz: 4f1db54baab633700669e6f7d8f153e73a1f5383ebd9b4c593acd95956699c8bc6b8bafa2d4194aa9a00e13a74bea9bf106a631d48c147d9b60f3f912d75f58d
+  metadata.gz: 5529b60454e2389fb5df0ff5fad1cdc5f3b1c8385396aa3f65d977db9bb6ceccbd9e93de70de7dba4f719681f8332cc30a2dfd087117589c274b7ad5f99926ef
+  data.tar.gz: 61f28174f219f9968e59183d473a4296d0fe659e3104b4ab2debe8e7cef27de077f653279a9897f7fc71af541597b8b90c3cf8ef66c0cbbadd40984f1520d1a4

data/kirei.gemspec

@@ -13,10 +13,12 @@ Gem::Specification.new do |spec|
     "oss@dbl.works",
   ]
 
-  spec.summary = "Kirei is a strictly typed Ruby micro/REST-framework for building scaleable and performant APIs."
+  spec.summary = "Kirei is a strictly typed Ruby micro/REST-framework for building scaleable and performant microservices." # rubocop:disable Layout/LineLength
   spec.description = <<~TXT
-    Kirei's structure und developer experience is inspired by Rails, but it's not a Rails clone.
-    It's a framework that's built from the ground up to be strictly typed, performant and scaleable.
+    Kirei is a strictly typed Ruby micro/REST-framework for building scaleable and performant microservices.
+    It is built from the ground up to be clean and easy to use.
+    Kirei is based on Sequel as an ORM, Sorbet for typing, and Sinatra for routing.
+    It strives to have zero magic and to be as explicit as possible.
   TXT
   spec.homepage = "https://github.com/swiknaba/kirei"
   spec.license = "MIT"
@@ -29,6 +31,7 @@ Gem::Specification.new do |spec|
     "kirei.gemspec",
     ".irbrc",
     "lib/**/*",
+    # do not include RBIs for gems, because users might use different verions
     "sorbet/rbi/dsl/**/*.rbi",
     "sorbet/rbi/shims/**/*.rbi",
     "LICENSE",
@@ -41,7 +44,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Utilities
-  spec.add_dependency "activesupport", "~> 6.0"
   spec.add_dependency "oj", "~> 3.0"
   spec.add_dependency "rake", "~> 13.0"
   spec.add_dependency "sorbet-runtime", "~> 0.5"

data/lib/boot.rb

@@ -12,15 +12,14 @@
 require "bundler/setup"
 
 # Second: load all gems (runtime dependencies only)
+require "logger"
 require "sorbet-runtime"
 require "oj"
-require "active_support/all"
 require "puma"
 require "sinatra"
 require "sinatra/namespace" # from sinatra-contrib
 require "pg"
-require "sequel"
-# "sequel_pg" should be auto-required by "sequel"
+require "sequel" # "sequel_pg" is auto-required by "sequel"
 
 Oj.default_options = {
   mode: :compat, # required to dump hashes with symbol-keys

data/lib/cli/commands/new_app/execute.rb

@@ -1,7 +1,6 @@
 # typed: false
 
 require "fileutils"
-require "active_support/all"
 
 module Cli
   module Commands
@@ -12,7 +11,9 @@ module Cli
           Files::App.call(app_name)
           Files::Irbrc.call
 
-          puts "Kirei app '#{app_name}' scaffolded successfully!" # rubocop:disable all
+          Kirei::Logger.logger.info(
+            "Kirei app '#{app_name}' scaffolded successfully!",
+          )
         end
       end
     end

data/lib/cli/commands/start.rb

@@ -1,7 +1,6 @@
 # typed: false
 
 require "fileutils"
-require "active_support/all"
 
 module Cli
   module Commands
@@ -13,7 +12,7 @@ module Cli
           app_name = app_name.gsub(/[-\s]/, "_").classify
           NewApp::Execute.call(app_name: app_name)
         else
-          puts "Unknown command" # rubocop:disable all
+          Kirei::Logger.logger.info("Unknown command")
         end
       end
     end

data/lib/kirei/app_base.rb

@@ -29,13 +29,13 @@ module Kirei
       end
 
       sig { returns(String) }
-      def env
+      def environment
         ENV.fetch("RACK_ENV", "development")
       end
 
       sig { returns(String) }
       def default_db_name
-        @default_db_name ||= T.let("#{config.app_name}_#{env}".freeze, T.nilable(String))
+        @default_db_name ||= T.let("#{config.app_name}_#{environment}".freeze, T.nilable(String))
       end
 
       sig { returns(String) }

data/lib/kirei/base_controller.rb

@@ -8,7 +8,7 @@ module Kirei
 
     before do
       Thread.current[:request_id] = request.env["HTTP_X_REQUEST_ID"].presence ||
-                                    "req_#{AppBase.env}_#{SecureRandom.uuid}"
+                                    "req_#{AppBase.environment}_#{SecureRandom.uuid}"
     end
   end
 end

data/lib/kirei/base_model.rb

@@ -62,9 +62,16 @@ module Kirei
 
       include BaseClassInterface
 
+      # defaults to a pluralized, underscored version of the class name
       sig { override.returns(String) }
       def table_name
-        T.must(name.split("::").last).pluralize.underscore
+        @table_name ||= T.let(
+          begin
+            table_name_ = Kirei::Helpers.underscore(T.must(name.split("::").last))
+            "#{table_name_}s"
+          end,
+          T.nilable(String),
+        )
       end
 
       sig { override.returns(Sequel::Dataset) }
@@ -106,7 +113,7 @@ module Kirei
 
         query.map do |row|
           row = T.cast(row, T::Hash[Symbol, T.untyped])
-          row.stringify_keys! # sequel returns symbolized keys
+          row.transform_keys!(&:to_s) # sequel returns symbolized keys
           from_hash(row, strict_loading)
         end
       end

data/lib/kirei/helpers.rb

@@ -0,0 +1,70 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Kirei
+  module Helpers
+    class << self
+      extend T::Sig
+
+      # Simplified version from Rails' ActiveSupport::Inflector#underscore
+      sig { params(string: String).returns(String) }
+      def underscore(string)
+        string.gsub!(/([A-Z])(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do
+          T.must((::Regexp.last_match(1) || ::Regexp.last_match(2))) << "_"
+        end
+        string.tr!("-", "_")
+        string.downcase!
+        string
+      end
+
+      # Simplified version from Rails' ActiveSupport
+      sig { params(string: T.any(String, Symbol)).returns(T::Boolean) }
+      def blank?(string)
+        string.nil? || string.to_s.empty?
+      end
+
+      # Simplified version from Rails' ActiveSupport
+      sig do
+        params(
+          object: T.untyped, # could be anything due to recursive calls
+          block: Proc,
+        ).returns(T.untyped) # could be anything due to recursive calls
+      end
+      def deep_transform_keys(object, &block)
+        case object
+        when Hash
+          object.each_with_object({}) do |(key, value), result|
+            result[yield(key)] = deep_transform_keys(value, &block)
+          end
+        when Array
+          object.map { |e| deep_transform_keys(e, &block) }
+        else
+          object
+        end
+      end
+
+      sig do
+        params(
+          object: T.untyped, # could be anything due to recursive calls
+          block: Proc,
+        ).returns(T.untyped) # could be anything due to recursive calls
+      end
+      def deep_transform_keys!(object, &block)
+        case object
+        when Hash
+          # using `each_key` results in a `RuntimeError: can't add a new key into hash during iteration`
+          # which is, because the receiver here does not necessarily have a `Hash` type
+          object.keys.each do |key| # rubocop:disable Style/HashEachMethods
+            value = object.delete(key)
+            object[yield(key)] = deep_transform_keys!(value, &block)
+          end
+          object
+        when Array
+          object.map! { |e| deep_transform_keys!(e, &block) }
+        else
+          object
+        end
+      end
+    end
+  end
+end

data/lib/kirei/logger.rb

@@ -98,7 +98,7 @@ module Kirei
           label = log_data.fetch(:label)
           meta = T.let(log_data.fetch(:meta), T::Hash[Symbol, T.untyped])
           meta[:"service.version"] ||= Kirei::AppBase.version
-          meta[:timestamp] ||= Time.current.utc.iso8601
+          meta[:timestamp] ||= Time.now.utc.iso8601
           meta[:level] ||= level.to_s.upcase
           meta[:label] ||= label
 
@@ -137,13 +137,13 @@ module Kirei
     end
     def self.flatten_hash_and_mask_sensitive_values(hash, prefix = :'')
       result = T.let({}, T::Hash[Symbol, T.untyped])
-      hash.deep_symbolize_keys!
+      Kirei::Helpers.deep_transform_keys!(hash) { _1.to_sym rescue _1 } # rubocop:disable Style/RescueModifier
 
       hash.each do |key, value|
-        new_prefix = prefix.blank? ? key : :"#{prefix}.#{key}"
+        new_prefix = Kirei::Helpers.blank?(prefix) ? key : :"#{prefix}.#{key}"
 
         case value
-        when Hash then result.merge!(flatten_hash_and_mask_sensitive_values(value.symbolize_keys, new_prefix))
+        when Hash then result.merge!(flatten_hash_and_mask_sensitive_values(value.transform_keys(&:to_sym), new_prefix))
         when Array
           value.each_with_index do |element, index|
             if element.is_a?(Hash) || element.is_a?(Array)
@@ -158,7 +158,9 @@ module Kirei
           if value.respond_to?(:serialize)
             serialized_value = value.serialize
             if serialized_value.is_a?(Hash)
-              result.merge!(flatten_hash_and_mask_sensitive_values(serialized_value.symbolize_keys, new_prefix))
+              result.merge!(
+                flatten_hash_and_mask_sensitive_values(serialized_value.transform_keys(&:to_sym), new_prefix),
+              )
             else
               result[new_prefix] = serialized_value&.to_s
             end

data/lib/kirei/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Kirei
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/kirei.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-puts "Booting Kirei..." # rubocop:disable all
-
 require "boot"
 
 module Kirei
@@ -33,4 +31,4 @@ end
 
 Kirei.configure(&:itself)
 
-puts "Kirei (#{Kirei::VERSION}) booted!" # rubocop:disable all
+Kirei::Logger.logger.info("Kirei (#{Kirei::VERSION}) booted successfully!")

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kirei
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Ludwig Reinmiedl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -165,8 +151,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: |
-  Kirei's structure und developer experience is inspired by Rails, but it's not a Rails clone.
-  It's a framework that's built from the ground up to be strictly typed, performant and scaleable.
+  Kirei is a strictly typed Ruby micro/REST-framework for building scaleable and performant microservices.
+  It is built from the ground up to be clean and easy to use.
+  Kirei is based on Sequel as an ORM, Sorbet for typing, and Sinatra for routing.
+  It strives to have zero magic and to be as explicit as possible.
 email:
 - lud@reinmiedl.com
 - oss@dbl.works
@@ -193,9 +181,9 @@ files:
 - lib/kirei/base_controller.rb
 - lib/kirei/base_model.rb
 - lib/kirei/config.rb
+- lib/kirei/helpers.rb
 - lib/kirei/logger.rb
 - lib/kirei/version.rb
-- sorbet/rbi/dsl/active_support/callbacks.rbi
 - sorbet/rbi/shims/base_model.rbi
 homepage: https://github.com/swiknaba/kirei
 licenses:
@@ -222,5 +210,5 @@ rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Kirei is a strictly typed Ruby micro/REST-framework for building scaleable
-  and performant APIs.
+  and performant microservices.
 test_files: []

data/sorbet/rbi/dsl/active_support/callbacks.rbi

@@ -1,22 +0,0 @@
-# typed: true
-
-# DO NOT EDIT MANUALLY
-# This is an autogenerated file for dynamic methods in `ActiveSupport::Callbacks`.
-# Please instead update this file by running `bin/tapioca dsl ActiveSupport::Callbacks`.
-
-module ActiveSupport::Callbacks
-  include GeneratedInstanceMethods
-
-  mixes_in_class_methods GeneratedClassMethods
-
-  module GeneratedClassMethods
-    def __callbacks; end
-    def __callbacks=(value); end
-    def __callbacks?; end
-  end
-
-  module GeneratedInstanceMethods
-    def __callbacks; end
-    def __callbacks?; end
-  end
-end