mk_framework 0.2.0

data/lib/mk_framework/sequel.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'sequel'
+require_relative '../mk_framework'
+
+module MK
+  # Shared by automatic resource actions and explicit application transactions.
+  module Persistence
+    def persist(record)
+      record.save || raise(ValidationError.new(details: record.errors))
+    rescue Sequel::ValidationFailed => error
+      raise ValidationError.new(details: error.model.errors)
+    rescue Sequel::UniqueConstraintViolation, Sequel::ForeignKeyConstraintViolation, Sequel::HookFailed
+      raise Conflict
+    end
+
+    def destroy(record)
+      record.destroy || raise(Conflict, 'Resource could not be deleted')
+    rescue Sequel::HookFailed, Sequel::ForeignKeyConstraintViolation
+      raise Conflict, 'Resource could not be deleted'
+    end
+
+    def paginate(dataset, request, order: :id)
+      page = request.page
+      dataset.order(order).limit(page[:limit], page[:offset]).all
+    end
+  end
+
+  class Application
+    include Persistence
+
+    private
+
+    def prepare_result(value, action:)
+      if value.is_a?(Sequel::Model)
+        case action
+        when :create, :update then persist(value)
+        when :delete then destroy(value)
+        end
+      end
+      raw_result(value)
+    end
+
+    # Materialize all data before the handler. Associations must be selected by
+    # the controller; inspecting a record's values never lazy-loads them.
+    def raw_result(value)
+      case value
+      when Sequel::Model then raw_result(value.values)
+      when Sequel::Dataset then raw_result(value.all)
+      when Array then value.map { |item| raw_result(item) }
+      when Hash then value.transform_values { |item| raw_result(item) }
+      else value
+      end
+    end
+  end
+end

data/lib/mk_framework/testing.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rack/test'
+
+module MK
+  module Framework
+    module Spec
+      class StrictHash < Hash
+        def [](key) = fetch(key)
+      end
+
+      include Rack::Test::Methods
+
+      # Parsing on demand keeps this correct for every Rack::Test request method,
+      # including custom_request and follow_redirect!, with no monkey patches.
+      def resp
+        body = last_response.body
+        body.empty? ? StrictHash.new : symbolize(JSON.parse(body))
+      end
+
+      private
+
+      def symbolize(value)
+        case value
+        when Hash
+          value.each_with_object(StrictHash.new) { |(key, item), result| result[key.to_sym] = symbolize(item) }
+        when Array
+          value.map { |item| symbolize(item) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/mk_framework/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MK
+  VERSION = '0.2.0'
+end

data/lib/mk_framework.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'json'
+require 'logger'
+require 'stringio'
+require 'securerandom'
+require_relative 'mk_framework/version'
+require_relative 'mk_framework/errors'
+require_relative 'mk_framework/request'
+require_relative 'mk_framework/controller'
+require_relative 'mk_framework/router'
+require_relative 'mk_framework/application'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: mk_framework
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Francesco Canessa
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.92'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.92'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Resource routing, controllers, and response handlers with optional Sequel
+  persistence.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- docs/deployment.md
+- docs/routing.md
+- docs/upgrading.md
+- lib/mk_framework.rb
+- lib/mk_framework/application.rb
+- lib/mk_framework/controller.rb
+- lib/mk_framework/errors.rb
+- lib/mk_framework/request.rb
+- lib/mk_framework/router.rb
+- lib/mk_framework/sequel.rb
+- lib/mk_framework/testing.rb
+- lib/mk_framework/version.rb
+homepage: https://github.com/makevoid/mk_framework2
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/makevoid/mk_framework2
+  changelog_uri: https://github.com/makevoid/mk_framework2/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.8
+specification_version: 4
+summary: Small, explicit JSON APIs on Roda
+test_files: []