hanami-api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671e8eab5f3b562214858055a272e049368bfce7524d639ffa63cd7003bab804
-  data.tar.gz: 461f4066a630f1a1bd66dbd52f4a977a79a4e09737f5861aeabfcc89d87aee04
+  metadata.gz: f2c7e4f7ca1d651ea24fdefb1455358b4c52682c0d1de57658ff7a8fe6253ec4
+  data.tar.gz: d900b1c2455f57e16a5f0f2044fcecd1c79f76bec3fc42fbfea13942bfa75dc5
 SHA512:
-  metadata.gz: e5398ddac6f97af3898faefd795bbb37f6be9d334163e90e0b68b004eab11e4923b366cc6b44504d06e16b7b67c2b3a3e46ca8a106ee694e65f2f83ab2ab1f41
-  data.tar.gz: 34ad6218b1001a4b66a4ec9512f320649843928afc98bcd968a347dae0d23df2989ebc46bbd407f93734f934cbd725ded04e8528e9f04e365c180d8748a73097
+  metadata.gz: c919a7b1a5f354e99aa2a34cc0189abed167e6bac9b7ba5c96da0329473b08fbfa8e0ac31913462443d874dcd99cad99db6fddf1fb9acd16254964851c0b065f
+  data.tar.gz: 160ecda952bb09ccf58f7d205f5626c80811ec3bad13e092d60d9fae64c71983b3b2121bf3c2f52eadb558d19b691269fad0e00b0cd80229e7c83128998033f1

data/.github/workflows/ci.yml

@@ -22,6 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - "3.0"
           - "2.7"
     env:
       CODACY_RUN_LOCAL: true

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Hanami::API
 Minimal, extremely fast, lightweight Ruby framework for HTTP APIs.
 
+## v0.2.0 - 2021-01-05
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 3.0
+- [Luca Guidi] Introduce `Hanami::API::DSL` which gives the ability to other Ruby web frameworks to use the `Hanami::API` DSL
+
 ## v0.1.2 - 2020-10-21
 ### Fixed
 - [Luca Guidi] Ensure to be able to instantiate an `Hanami::API` app multiple times

data/README.md

@@ -145,6 +145,7 @@ get "/", to: MyEndpoint.new
   * `post`
   * `patch`
   * `put`
+  * `delete`
   * `options`
   * `trace`
   * `link`

data/lib/hanami/api.rb

@@ -9,21 +9,15 @@ module Hanami
     require "hanami/api/error"
     require "hanami/api/router"
     require "hanami/api/middleware"
+    require "hanami/api/dsl"
 
     # @since 0.1.0
     # @api private
     def self.inherited(app)
       super
 
-      app.class_eval do
-        @router = Router.new
-      end
-    end
-
-    class << self
-      # @since 0.1.1
-      # @api private
-      attr_reader :router
+      app.extend(DSL::ClassMethods)
+      app.include(DSL::InstanceMethods)
     end
 
     # Defines a named root route (a GET route for "/")
@@ -292,29 +286,6 @@ module Hanami
       @router.use(middleware, *args, &blk)
     end
 
-    # @since 0.1.0
-    def initialize(router: self.class.router.dup)
-      @router = router
-
-      freeze
-    end
-
-    # @since 0.1.0
-    def freeze
-      @app = @router.to_rack_app
-      @url_helpers = @router.url_helpers
-      @router.remove_instance_variable(:@url_helpers)
-      remove_instance_variable(:@router)
-      @url_helpers.freeze
-      @app.freeze
-      super
-    end
-
-    # @since 0.1.0
-    def call(env)
-      @app.call(env)
-    end
-
     # TODO: verify if needed here on in block context
     #
     # @since 0.1.0

data/lib/hanami/api/dsl.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Hanami
+  class API
+    # Expose Hanami::API features to third party frameworks that need to expose
+    # a routing DSL.
+    #
+    # @since 0.2.0
+    #
+    # @example
+    #   # framework.rb
+    #    require "hanami/api"
+    #
+    #    module Framework
+    #      class App
+    #        def self.inherited(base)
+    #          super
+    #          base.extend(Hanami::API::DSL)
+    #        end
+    #      end
+    #    end
+    #
+    #    # app.rb
+    #    require "framework/app"
+    #
+    #    class MyApp < Framework::App
+    #      routes do
+    #        root { "Hello, World!" }
+    #      end
+    #    end
+    #
+    #    # config.ru
+    #    require_relative "./app"
+    #
+    #    run MyApp.new
+    module DSL
+      # @since 0.2.0
+      # @api private
+      def self.extended(app)
+        super
+
+        app.extend(ClassMethods)
+        app.extend(ClassMethods::Routes)
+        app.include(InstanceMethods)
+      end
+
+      # @since 0.2.0
+      # @api private
+      module ClassMethods
+        # @since 0.2.0
+        # @api private
+        attr_reader :router
+
+        # @since 0.2.0
+        # @api private
+        def self.extended(app)
+          super
+
+          app.class_eval do
+            @router = Router.new
+          end
+        end
+
+        # @since 0.2.0
+        # @api private
+        module Routes
+          # A block to define application routes
+          #
+          # This is ONLY available for third-party frameworks that use
+          # Hanami::API DSL.
+          #
+          # If you use Hanami::API directly, this method isn't available.
+          #
+          # @param blk [Proc] the block to define the routes
+          #
+          # @see Hanami::API::Router
+          #
+          # @since 0.2.0
+          # @api public
+          def routes(&blk)
+            router.instance_eval(&blk)
+          end
+        end
+      end
+
+      module InstanceMethods
+        # Initialize the app
+        #
+        # @param router [Hanami::API::Router] the application router
+        #
+        # @since 0.2.0
+        # @api public
+        def initialize(router: self.class.router.dup)
+          @router = router
+
+          freeze
+        end
+
+        # @since 0.2.0
+        # @api private
+        def freeze
+          @app = @router.to_rack_app
+          @url_helpers = @router.url_helpers
+          @router.remove_instance_variable(:@url_helpers)
+          remove_instance_variable(:@router)
+          @url_helpers.freeze
+          @app.freeze
+          super
+        end
+
+        # Compatibility with Rack protocol
+        #
+        # @param env [Hash] a Rack env for the current request
+        #
+        # @since 0.2.0
+        # @api public
+        def call(env)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/api/version.rb

@@ -3,6 +3,6 @@
 module Hanami
   class API
     # @since 0.1.0
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-router
@@ -100,6 +100,7 @@ files:
 - hanami-api.gemspec
 - lib/hanami/api.rb
 - lib/hanami/api/block/context.rb
+- lib/hanami/api/dsl.rb
 - lib/hanami/api/error.rb
 - lib/hanami/api/middleware.rb
 - lib/hanami/api/middleware/app.rb
@@ -129,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: Hanami API