rest_framework 0.3.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5065eb969e4616e6a0e22717a4398940b3696a43182d6e8b526e225f6c81f3
-  data.tar.gz: 3efcfdfa6abfe7343770c8241e83d34bc1e02bcbd145826bc8a9709514b8b5f7
+  metadata.gz: 1e654cef83c3cf4505697e0417d637489a248b691ca157100b6a12dc3e0f3f9e
+  data.tar.gz: b656446d2fd724e2b91708e4df6248cd5e6676a311e8cd23d76f07951758bffd
 SHA512:
-  metadata.gz: 170b7b9ebb18b9527d1e9216a0456af154284ab8935d1ddcc367815bf73c86379ae83340f6a259f6b4324d5c4cf32eae740a28210a1ce963427ef96a870ae016
-  data.tar.gz: a6148d463fa2eda9dc6f19dc89646a78b922a93bdcf6f147707343d218a9501e8bebe67d8182d75a946968d59b27a0f030d08349268297799bc4886b780f6aa4
+  metadata.gz: 3a9ee1d172c5e33813352b2190f2f38540226d93d84bf77cca34fab326231f6215a702c66e3965f5239d652e35eeb36a7286210826608e11ab9a35c8edf65704
+  data.tar.gz: e132e15651e2c9fd0cd9d1338ec2c5a795d369a6a001c2e4a957c7912dfd5539ea940945ea48c011e1c4be6e3b1feaf55b63934fdff5608135c2ac089fd83486

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Gregory N. Schmit
+Copyright (c) 2021 Gregory N. Schmit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 # Rails REST Framework
 
 [![Gem Version](https://badge.fury.io/rb/rest_framework.svg)](https://badge.fury.io/rb/rest_framework)
-[![Build Status](https://travis-ci.org/gregschmit/rails-rest-framework.svg?branch=master)](https://travis-ci.org/gregschmit/rails-rest-framework)
+[![Build Status](https://travis-ci.com/gregschmit/rails-rest-framework.svg?branch=master)](https://travis-ci.com/gregschmit/rails-rest-framework)
 [![Coverage Status](https://coveralls.io/repos/github/gregschmit/rails-rest-framework/badge.svg?branch=master)](https://coveralls.io/github/gregschmit/rails-rest-framework?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ba5df7706cb544d78555/maintainability)](https://codeclimate.com/github/gregschmit/rails-rest-framework/maintainability)
 

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.1

data/app/views/layouts/rest_framework.html.erb

@@ -29,14 +29,14 @@
               <ul class="nav nav-tabs">
                 <% if @json_payload %>
                   <li class="nav-item">
-                    <a class="nav-link active" href="#tab-json" data-toggle="tab" role="tab">
+                    <a class="nav-link active" href="#tab-json" data-bs-toggle="tab" role="tab">
                       .json
                     </a>
                   </li>
                 <% end %>
                 <% if @xml_payload %>
                   <li class="nav-item">
-                    <a class="nav-link" href="#tab-xml" data-toggle="tab" role="tab">
+                    <a class="nav-link" href="#tab-xml" data-bs-toggle="tab" role="tab">
                       .xml
                     </a>
                   </li>
@@ -57,7 +57,7 @@
             </div>
           </div>
         <% end %>
-        <% unless @routes.blank? %>
+        <% unless @route_groups.blank? %>
           <div class="row">
             <h2>Routes</h2>
             <%= render partial: 'rest_framework/routes' %>

data/app/views/rest_framework/_head.html.erb

@@ -1,11 +1,12 @@
 <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+<meta name="viewport" content="width=device-width, initial-scale=1">
 <%= csrf_meta_tags %>
 <%= csp_meta_tag rescue nil %>
 
-<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/styles/vs.min.css" integrity="sha512-aWjgJTbdG4imzxTxistV5TVNffcYGtIQQm2NBNahV6LmX14Xq9WwZTL1wPjaSglUuVzYgwrq+0EuI4+vKvQHHw==" crossorigin="anonymous" />
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/css/bootstrap.min.css" integrity="sha384-F3w7mX95PdgyTmZZMECAngseQB83DfGTowi0iMjiWaeVhAn4FJkqJByhZMI3AhiU" crossorigin="anonymous">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/styles/vs.min.css" integrity="sha512-aWjgJTbdG4imzxTxistV5TVNffcYGtIQQm2NBNahV6LmX14Xq9WwZTL1wPjaSglUuVzYgwrq+0EuI4+vKvQHHw==" crossorigin="anonymous">
 <style>
+  /* Adjust headers to always take up their entire row, and tweak the sizing. */
   h1,h2,h3,h4,h5,h6 { width: 100%; font-weight: normal; }
   h1 { font-size: 2rem; }
   h2 { font-size: 1.7rem; }
@@ -13,11 +14,27 @@
   h4 { font-size: 1.3rem; }
   h5 { font-size: 1.1rem; }
   h6 { font-size: 1rem; }
+
+  /* Make route group expansion obvious to the user. */
+  .rrf-routes .rrf-route-group-header {
+    background-color: #f8f8f8;
+  }
+  .rrf-routes .rrf-route-group-header:hover {
+    background-color: #f0f0f0;
+  }
+  .rrf-routes .rrf-route-group-header td {
+    cursor: pointer;
+  }
+
+  /* Disable bootstrap's collapsing animation because in tables it causes delayed jerkiness. */
+  .rrf-routes .collapsing {
+    -webkit-transition: none;
+    transition: none;
+    display: none;
+  }
 </style>
 
-<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
-<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
-<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.1/dist/js/bootstrap.bundle.min.js" integrity="sha384-/bQdsTh/da6pkI1MST/rWKFNjaCP5gBSY4sEBT38Q/9RBh9AH40zEOg7Hlq2THRZ" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/highlight.min.js" integrity="sha512-TDKKr+IvoqZnPzc3l35hdjpHD0m+b2EC2SrLEgKDRWpxf2rFCxemkgvJ5kfU48ip+Y+m2XVKyOCD85ybtlZDmw==" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/languages/json.min.js" integrity="sha512-FoN8JE+WWCdIGXAIT8KQXwpiavz0Mvjtfk7Rku3MDUNO0BDCiRMXAsSX+e+COFyZTcDb9HDgP+pM2RX12d4j+A==" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.2.0/languages/xml.min.js" integrity="sha512-dICltIgnUP+QSJrnYGCV8943p3qSDgvcg2NU4W8IcOZP4tdrvxlXjbhIznhtVQEcXow0mOjLM0Q6/NvZsmUH4g==" crossorigin="anonymous"></script>

data/app/views/rest_framework/_route.html.erb

@@ -0,0 +1,9 @@
+<tr>
+  <td><%= route[:path] %></td>
+  <td><%= route[:verb] %></td>
+  <% if route[:controller] && route[:action] %>
+    <td><%= route[:controller] %>#<%= route[:action] %></td>
+  <% else %>
+    <td><%= route[:route_app] %></td>
+  <% end %>
+</tr>

data/app/views/rest_framework/_routes.html.erb

@@ -1,18 +1,28 @@
-<table class="table">
-  <thead>
-    <tr>
-      <th scope="col">Verb</th>
-      <th scope="col">Path</th>
-      <th scope="col">Action</th>
-    </tr>
-  </thead>
-  <tbody>
-    <% @routes.each do |r| %>
-    <tr>
-      <td><%= r[:verb] %></td>
-      <td><%= r[:path] %></td>
-      <td><%= r[:action] %></td>
-    </tr>
+<div class="table-responsive">
+  <table class="table table-responsive rrf-routes">
+    <thead>
+      <tr>
+        <th scope="col">Path</th>
+        <th scope="col">Verb</th>
+        <th scope="col">Controller#Action</th>
+      </tr>
+    </thead>
+    <%# Render first group of routes directly. %>
+    <tbody>
+      <% @route_groups.values[0].each do |route| %>
+        <%= render partial: "rest_framework/route", locals: {route: route} %>
+      <% end %>
+    </tbody>
+    <%# Render any other groups under dropdowns. %>
+    <% @route_groups.drop(1).each_with_index do |(name, route_group), index| %>
+      <tr data-bs-toggle="collapse" data-bs-target="#route-group-<%= index %>" class="rrf-route-group-header">
+        <td colspan="3" class="text-center user-select-none"><%= name %></td>
+      </tr>
+      <tbody id="route-group-<%= index %>" class="collapse">
+        <% route_group.each do |route| %>
+          <%= render partial: "rest_framework/route", locals: {route: route} %>
+        <% end %>
+      </tbody>
     <% end %>
-  </tbody>
-</table>
+  </table>
+</div>

data/lib/rest_framework/controller_mixins/base.rb

@@ -1,5 +1,6 @@
 require_relative '../errors'
 require_relative '../serializers'
+require_relative '../utils'
 
 
 # This module provides the common functionality for any controller mixins, a `root` action, and
@@ -121,22 +122,6 @@ module RESTFramework::BaseControllerMixin
     }, status: 406)
   end
 
-  # Helper for showing routes under a controller action, used for the browsable API.
-  def _get_routes
-    begin
-      formatter = ActionDispatch::Routing::ConsoleFormatter::Sheet
-    rescue NameError
-      # :nocov:
-      formatter = ActionDispatch::Routing::ConsoleFormatter
-      # :nocov:
-    end
-    return ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes).format(
-      formatter.new
-    ).lines.drop(1).map { |r| r.split.last(3) }.map { |r|
-      {verb: r[0], path: r[1], action: r[2]}
-    }.select { |r| r[:path].start_with?(request.path) }
-  end
-
   # Helper to render a browsable API for `html` format, along with basic `json`/`xml` formats, and
   # with support or passing custom `kwargs` to the underlying `render` calls.
   def api_response(payload, html_kwargs: nil, **kwargs)
@@ -178,7 +163,7 @@ module RESTFramework::BaseControllerMixin
         end
         @template_logo_text ||= "Rails REST Framework"
         @title ||= self.controller_name.camelize
-        @routes ||= self._get_routes
+        @route_groups ||= RESTFramework::Utils::get_routes(Rails.application.routes, request)
         hkwargs = kwargs.merge(html_kwargs)
         begin
           render(**hkwargs)

data/lib/rest_framework/errors.rb

@@ -14,15 +14,3 @@ class RESTFramework::NilPassedToAPIResponseError < RESTFramework::Error
     MSG
   end
 end
-
-
-class RESTFramework::UnserializableError < RESTFramework::Error
-  def initialize(object)
-    @object = object
-    return super
-  end
-
-  def message
-    return "Unable to serialize `#{@object.inspect}` (of type `#{@object.class}`)."
-  end
-end

data/lib/rest_framework/routers.rb

@@ -1,43 +1,8 @@
 require 'action_dispatch/routing/mapper'
-
+require_relative 'utils'
 
 module ActionDispatch::Routing
   class Mapper
-    # Internal helper to take extra_actions hash and convert to a consistent format.
-    protected def _parse_extra_actions(extra_actions)
-      return (extra_actions || {}).map do |k,v|
-        kwargs = {action: k}
-        path = k
-
-        # Convert structure to path/methods/kwargs.
-        if v.is_a?(Hash)  # allow kwargs
-          v = v.symbolize_keys
-
-          # Ensure methods is an array.
-          if v[:methods].is_a?(String) || v[:methods].is_a?(Symbol)
-            methods = [v.delete(:methods)]
-          else
-            methods = v.delete(:methods)
-          end
-
-          # Override path if it's provided.
-          if v.key?(:path)
-            path = v.delete(:path)
-          end
-
-          # Pass any further kwargs to the underlying Rails interface.
-          kwargs = kwargs.merge(v)
-        elsif v.is_a?(Symbol) || v.is_a?(String)
-          methods = [v]
-        else
-          methods = v
-        end
-
-        # Return a hash with keys: :path, :methods, :kwargs.
-        {path: path, methods: methods, kwargs: kwargs}
-      end
-    end
-
     # Internal interface to get the controller class from the name and current scope.
     protected def _get_controller_class(name, pluralize: true, fallback_reverse_pluralization: true)
       # get class name
@@ -92,13 +57,13 @@ module ActionDispatch::Routing
       if controller.is_a?(Class)
         controller_class = controller
       else
-        controller_class = _get_controller_class(controller, pluralize: !default_singular)
+        controller_class = self._get_controller_class(controller, pluralize: !default_singular)
       end
 
       # Set controller if it's not explicitly set.
       kwargs[:controller] = name unless kwargs[:controller]
 
-      # determine plural/singular resource
+      # Determine plural/singular resource.
       force_singular = kwargs.delete(:force_singular)
       force_plural = kwargs.delete(:force_plural)
       if force_singular
@@ -118,14 +83,16 @@ module ActionDispatch::Routing
       public_send(resource_method, name, except: skip, **kwargs) do
         if controller_class.respond_to?(:extra_member_actions)
           member do
-            actions = self._parse_extra_actions(controller_class.extra_member_actions)
-            _route_extra_actions(actions)
+            actions = RESTFramework::Utils::parse_extra_actions(
+              controller_class.extra_member_actions
+            )
+            self._route_extra_actions(actions)
           end
         end
 
         collection do
-          actions = self._parse_extra_actions(controller_class.extra_actions)
-          _route_extra_actions(actions)
+          actions = RESTFramework::Utils::parse_extra_actions(controller_class.extra_actions)
+          self._route_extra_actions(actions)
         end
 
         yield if block_given?
@@ -160,14 +127,14 @@ module ActionDispatch::Routing
       kwargs[:controller] = name unless kwargs[:controller]
 
       # Route actions using the resourceful router, but skip all builtin actions.
-      actions = self._parse_extra_actions(controller_class.extra_actions)
+      actions = RESTFramework::Utils::parse_extra_actions(controller_class.extra_actions)
       public_send(:resource, name, only: [], **kwargs) do
         # Route a root for this resource.
         if route_root_to
           get '', action: route_root_to
         end
 
-        _route_extra_actions(actions, &block)
+        self._route_extra_actions(actions, &block)
       end
     end
 

data/lib/rest_framework/serializers.rb

@@ -105,18 +105,12 @@ class RESTFramework::NativeSerializer < RESTFramework::BaseSerializer
 
   # Convert the object (record or recordset) to Ruby primitives.
   def serialize
-    if @object
-      begin
-        if @object.is_a?(Enumerable)
-          return @object.map { |r| r.serializable_hash(self.get_serializer_config) }
-        end
-        return @object.serializable_hash(self.get_serializer_config)
-      rescue NoMethodError
-      end
-    end
+    raise "No object available to serialize!" unless @object
 
-    # Raise an error if we cannot serialize the object.
-    raise RESTFramework::UnserializableError.new(@object)
+    if @object.is_a?(Enumerable)
+      return @object.map { |r| r.serializable_hash(self.get_serializer_config) }
+    end
+    return @object.serializable_hash(self.get_serializer_config)
   end
 
   # Allow a serializer instance to be used as a hash directly in a nested serializer config.

data/lib/rest_framework/utils.rb

@@ -0,0 +1,64 @@
+module RESTFramework::Utils
+  # Helper to take extra_actions hash and convert to a consistent format:
+  # `{paths:, methods:, kwargs:}`.
+  def self.parse_extra_actions(extra_actions)
+    return (extra_actions || {}).map do |k,v|
+      kwargs = {action: k}
+      path = k
+
+      # Convert structure to path/methods/kwargs.
+      if v.is_a?(Hash)  # allow kwargs
+        v = v.symbolize_keys
+
+        # Ensure methods is an array.
+        if v[:methods].is_a?(String) || v[:methods].is_a?(Symbol)
+          methods = [v.delete(:methods)]
+        else
+          methods = v.delete(:methods)
+        end
+
+        # Override path if it's provided.
+        if v.key?(:path)
+          path = v.delete(:path)
+        end
+
+        # Pass any further kwargs to the underlying Rails interface.
+        kwargs = kwargs.merge(v)
+      elsif v.is_a?(Symbol) || v.is_a?(String)
+        methods = [v]
+      else
+        methods = v
+      end
+
+      # Return a hash with keys: :path, :methods, :kwargs.
+      {path: path, methods: methods, kwargs: kwargs}
+    end
+  end
+
+  # Helper to get the current route pattern, stripped of the `(:format)` segment.
+  def self.get_route_pattern(application_routes, request)
+    application_routes.router.recognize(request) do |route, _, _|
+      return route.path.spec.to_s.gsub(/\(\.:format\)$/, '')
+    end
+  end
+
+  # Helper for showing routes under a controller action, used for the browsable API.
+  def self.get_routes(application_routes, request)
+    current_pattern = self.get_route_pattern(application_routes, request)
+    current_subdomain = request.subdomain.presence
+
+    # Return routes that match our current route subdomain/pattern, grouped by controller.
+    return application_routes.routes.map { |r|
+      {
+        verb: r.verb,
+        path: r.path.spec.to_s,
+        action: r.defaults[:action].presence,
+        controller: r.defaults[:controller].presence,
+        subdomain: r.defaults[:subdomain].presence,
+        route_app: r.app&.app&.inspect&.presence,
+      }
+    }.select { |r|
+      r[:subdomain] == current_subdomain && r[:path].start_with?(current_pattern)
+    }.group_by { |r| r[:controller] }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.1
 platform: ruby
 authors:
 - Gregory N. Schmit
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,6 +36,7 @@ files:
 - VERSION
 - app/views/layouts/rest_framework.html.erb
 - app/views/rest_framework/_head.html.erb
+- app/views/rest_framework/_route.html.erb
 - app/views/rest_framework/_routes.html.erb
 - lib/rest_framework.rb
 - lib/rest_framework/controller_mixins.rb
@@ -49,6 +50,7 @@ files:
 - lib/rest_framework/paginators.rb
 - lib/rest_framework/routers.rb
 - lib/rest_framework/serializers.rb
+- lib/rest_framework/utils.rb
 - lib/rest_framework/version.rb
 homepage: https://rails-rest-framework.com
 licenses:
@@ -56,7 +58,7 @@ licenses:
 metadata:
   homepage_uri: https://rails-rest-framework.com
   source_code_uri: https://github.com/gregschmit/rails-rest-framework
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -73,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A framework for DRY RESTful APIs in Ruby on Rails.
 test_files: []