decko 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495ff18be09fd0a855ba73e7f838c9cbc1d507b829b141f34f85dc857329abc6
-  data.tar.gz: 251b5ebedf62755d618cbc86dba4b22679c73a2196e5a833e240459b9c89b136
+  metadata.gz: b56b11720b70b74485415b9e281118737e4badaa8a0a5bd96b85382f2cd5f08f
+  data.tar.gz: a45cd70c209878b062bf0e202b066eb6e51deddf88f529e058401c55dc7e682d
 SHA512:
-  metadata.gz: 93147d66836e565aa102f0dd21d647e879d4df23977cb7e60339543519528a199a6436b5e540169d24848aab1a9e629584ef780e6367c376138f605e045ff9d8
-  data.tar.gz: dad7ee2230dda1e05f2cc707872753212ce5ac787bf56233207155f62d475f03eb518cab32cc48a1cba342db8f3403ad5ff48ee8cc08771e467f5ed2a9559d4a
+  metadata.gz: ab76c77af818df10f4a00add8382f2dd631bc849146c86db004a3285b9aad4e557e518222b746b01e04160b49fe392c4945dfb7459848749b60e7d23906d7eab
+  data.tar.gz: cc14006108a5a0c5da298dd4dcae1b558aa57252d3247d3440e341df9254d3f401be28a1f1b740600d3eb338a3c5711e451a92d897daefc729343a79d003dbfa

data/config/engine_routes.rb

@@ -16,7 +16,7 @@ Decko::Engine.routes.draw do
   end
 
   # Standard GET requests
-  get "(/decko)/:mark(.:format)" => "card#read"  # /decko is deprecated
+  get "/:mark(.:format)" => "card#read"  # /decko is deprecated
 
   # Alternate GET requests
   get "new/:type" => "card#read", view: "new" # common case for card without mark

data/config/initializers/session_store.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+
 # Be sure to restart your server when you modify this file.
 
 # Uncomment this if we can show that cookies are not secure in production

data/lib/card_controller/response.rb

@@ -92,7 +92,7 @@ class CardController
 
     def load_format status
       request.format = :html if implicit_html?
-      card.format(response_format).tap { |fmt| fmt.error_status = status }
+      @format = card.format(response_format).tap { |fmt| fmt.error_status = status }
     end
 
     def implicit_html?
@@ -100,13 +100,16 @@ class CardController
     end
 
     def format_name_from_params
-      return :file if explicit_file_format?
+      rf = requested_format
+      explicit_file_format?(rf) ? :file : rf.to_sym
+    end
 
-      (params[:format].present? ? params[:format] : request.format).to_sym
+    def explicit_file_format? rf
+      params[:explicit_file] || !Card::Format.registered.member?(rf)
     end
 
-    def explicit_file_format?
-      params[:explicit_file] || !Card::Format.registered.member?(request.format)
+    def requested_format
+      params[:format].present? ? params[:format].to_s : request.format
     end
   end
 end

data/lib/card_controller/rest.rb

@@ -90,10 +90,10 @@ class CardController
 
     def show view=nil, status=200
       card.action = :read
-      format = load_format status
-      result = render_page format, view
-      status = format.error_status || status
-      respond format, result, status
+      load_format status
+      result = render_page @format, view
+      status = @format.error_status || status
+      respond @format, result, status
     end
 
     def render_page format, view

data/lib/card_controller.rb

@@ -15,7 +15,7 @@ class CardController < ActionController::Base
   include ::Card::Env::Location
 
   layout nil
-  attr_reader :card
+  attr_reader :card, :format
 
   before_action :setup, except: [:asset]
   before_action :authenticate, except: [:asset]

data/lib/decko/commands.rb

@@ -10,7 +10,7 @@ module Decko
     def map
       @map ||= super.merge(
         server: { desc: "start a local web server", group: :shark, alias: :s },
-        cucumber: { desc: "run cucumber tests", group: :monkey, alias: :cc, via: :call}
+        cucumber: { desc: "run cucumber tests", group: :monkey, alias: :cc, via: :call }
       )
     end
 

data/lib/decko/rest_spec_helper.rb

@@ -18,6 +18,7 @@ module Decko
         routes { Decko::Engine.routes }
         include Capybara::DSL
         include RestSpecMethods
+
         instance_eval(&block)
       end
     end

data/lib/decko/swagger/input_yml/layout.yml

@@ -170,8 +170,8 @@ components:
         request will be redirected.  Eg, `success[mark]=mycardname`
 
   schemas:
-    "nucleus view":
-      name: "nucleus view"
+    nucleus_view:
+      name: nucleus view
       type: object
       properties:
         id:
@@ -186,8 +186,8 @@ components:
         codename:
           type: string
 
-    "atom view":
-      name: "atom view"
+    atom_view:
+      name: atom view
       type: object
       properties:
         id:
@@ -204,7 +204,7 @@ components:
         content:
           type: string
 
-    "molecule view":
+    molecule_view:
       type: object
       properties:
         id:
@@ -214,7 +214,7 @@ components:
         url:
           type: string
         type:
-          $ref: '#/components/schemas/nucleus%20view'
+          $ref: '#/components/schemas/nucleus_view'
         codename:
           type: string
         content:
@@ -224,7 +224,7 @@ components:
         items:
           type: array
           items:
-            $ref: '#/components/schemas/atom%20view'
+            $ref: '#/components/schemas/atom_view'
         links:
           type: array
           items:
@@ -232,9 +232,9 @@ components:
         ancestors:
           type: array
           items:
-            $ref: "#/components/schemas/atom%20view"
+            $ref: "#/components/schemas/atom_view"
 
-    "errors view":
+    errors_view:
       type: object
       properties:
         error_status:
@@ -245,20 +245,20 @@ components:
             type: string
 
   responses:
-    200:
+    "200":
       description: |-
         Card data. Defaults to molecule view.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/molecule%20view'
-    404:
+            $ref: '#/components/schemas/molecule_view'
+    "404":
       description: "Could not find the card requested."
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/errors%20view'
-    302:
+            $ref: '#/components/schemas/errors_view'
+    "302":
       description: |-
         Successful non-idempotent requests redirect to idempotent GET
         requests.

data/lib/decko/swagger/output.yml

@@ -1,105 +1,120 @@
----
 openapi: 3.0.0
 info:
-  description: |-
+  description: >-
     Decko organizes data into "cards." Decko's API supports retrieval and alteration of card data.
+
     To get the JSON responses as described below, do _any_ of the following:
       1. Set the http Accept header to `application/json` in your request
       2. Add `.json` to the url, or
       3. Add `format=json` to the query params.
-  version: 0.8.0
+
+  version: "0.8.0"
   title: Decko API
   contact:
     email: info@decko.org
   license:
     name: GPL-2.0
-    url: https://opensource.org/licenses/GPL-2.0
+    url: 'https://opensource.org/licenses/GPL-2.0'
 tags:
-- name: create
-- name: read
-- name: update
-- name: delete
+  - name: create
+  - name: read
+  - name: update
+  - name: delete
+
 paths:
-  "/{mark}":
+  /{mark}:
     get:
       tags:
-      - read
-      summary: get specified view of card
+        - Decko
+      summary: "get specified view of card"
       description: |-
         All read operations involve producing a _view_ of a card.
+
         The request can come in several variants, eg\:
           1. /{mark}?view={view} (standard)
           1. /{mark}/{view}
           1. /?mark={mark}&view={view}
+
       parameters:
-      - "$ref": "#/components/parameters/cardmark"
-      - "$ref": "#/components/parameters/view"
+        - $ref: '#/components/parameters/cardmark'
+        - $ref: '#/components/parameters/view'
       responses:
         200:
-          "$ref": "#/components/responses/200"
+          $ref: '#/components/responses/200'
         404:
-          "$ref": "#/components/responses/404"
+          $ref: '#/components/responses/404'
     put:
       tags:
-      - update
-      summary: update a card
+        - Decko
+      summary: "update a card"
+      description: |-
+        Update a card's name, type, and/or content. It's also possible to use
+        a GET request with /update/{mark}
       parameters:
-      - "$ref": "#/components/parameters/cardmark"
-      - "$ref": "#/components/parameters/card"
-      - "$ref": "#/components/parameters/success"
+        - $ref: '#/components/parameters/cardmark'
+        - $ref: '#/components/parameters/card'
+        - $ref: '#/components/parameters/success'
       responses:
-        200:
-          "$ref": "#/components/responses/200"
+        302:
+          $ref: '#/components/responses/302'
         404:
-          "$ref": "#/components/responses/404"
+          $ref: '#/components/responses/404'
+    # TODO: add patch
     delete:
       tags:
-      - delete
-      summary: delete a card
+        - Decko
+      summary: "delete a card"
       parameters:
-      - "$ref": "#/components/parameters/cardmark"
-      - "$ref": "#/components/parameters/success"
+        - $ref: '#/components/parameters/cardmark'
+        - $ref: '#/components/parameters/success'
       responses:
-        200:
-          "$ref": "#/components/responses/200"
+        302:
+          $ref: '#/components/responses/302'
         404:
-          "$ref": "#/components/responses/404"
-  "/":
+          $ref: '#/components/responses/404'
+  /:
     post:
       tags:
-      - create
-      summary: create a card
+        - Decko
+      summary: "create a card"
+      description: |-
+        Create a card, setting its name, type, and/or content. It's also possible to use
+        a GET request with /card/create
       parameters:
-      - "$ref": "#/components/parameters/cardmark"
-      - "$ref": "#/components/parameters/card"
-      - "$ref": "#/components/parameters/success"
+        - $ref: '#/components/parameters/cardmark'
+        - $ref: '#/components/parameters/card'
+        - $ref: '#/components/parameters/success'
       responses:
-        200:
-          "$ref": "#/components/responses/200"
-        404:
-          "$ref": "#/components/responses/404"
+        302:
+          $ref: '#/components/responses/302'
+
 externalDocs:
   description: Find out more about Decko
-  url: http://decko.org
+  url: 'http://decko.org'
 servers:
-- url: http://decko.org
+  - url: 'http://decko.org'
+
 components:
   parameters:
     cardmark:
       name: mark
       in: path
       required: true
-      description: |-
+      description: >-
         A card's "mark" can be a name, an id, or a codename. Prefix ids with a tilde (~) and codenames with a colon (\:).
+
         - **name:** Every card has a unique name. A name can have many variants. For example, `Berlin`, `berlin`, and `BERLIN!` all refer to the same card. The singularized, lower-cased, underscored variant of a name is called its "key."
+
         - **id:** Every card stored in the database has a unique numerical id. _Note: some cards, called 'virtual cards', are not stored in the database and therefore do not have a numerical id. For example, the name `Menu+*refer to` identifies a virtual Search card that finds all the cards that refer to the `Menu` card.Because it is based on patterns that apply to all cards with names ending in `+*refer to`, there is no need to store each instance of that pattern._
+
         - **codename:** Some cards also have special identifiers called "codenames". Card names can be edited by Decko users. If these names were used directly in code, then renaming would break that code. Codename identifiers solve this problem by providing persistent readable identifiers. Only cards referred to directly in code have codenames.
+
       schema:
         type: string
         enum:
-        - "{name}"
-        - "~{id}"
-        - ":{codename}"
+          - '{name}'
+          - '~{id}'
+          - ':{codename}'
     view:
       name: view
       in: query
@@ -107,18 +122,17 @@ components:
       schema:
         type: string
         enum:
-        - nucleus
-        - atom
-        - molecule
-        - id
-        - codename
-        - name
-        - key
-        - content
-        - type
+          - nucleus
+          - atom
+          - molecule
+          - id
+          - codename
+          - name
+          - key
+          - content
+          - type
         default: molecule
-      description: The view determines the contents of the response JSON.  See the
-        corresponding schema for more details.
+      description: The view determines the contents of the response JSON.  See the corresponding schema for more details.
     card:
       name: card
       in: header
@@ -131,24 +145,32 @@ components:
             type: string
           content:
             type: string
-      description: |-
-        The card parameter contains card field data, subcard field data. It follows RubyOnRails hash parameter pattern; for example, a card's name is represented as `card[name]=foobar`.
+      description: >-
+        The card parameter contains card field data, subcard field data.
+        It follows RubyOnRails hash parameter pattern; for example, a card's name is represented as `card[name]=foobar`.
+
         The most common fields are:
+
         - **name:** Every card has a unique name.
+
         - **type:** The card\'s type.  Note that every card has a type, and the value of this field should be the type card\'s name. You can alternatively use **type_id** or **type_code** with the type card\s id
           or mark respectively.
 
         - **content:** The card\'s content (in string form)
+
         - **subcards** A hash that contains information about additional cards to be handled in the same transaction.  Each key is a card name, and each value is a card hash. Eg `cards[subcards][+color][content]=red`
+
     success:
       name: success
       in: header
       schema:
         type: object
-      description: parameters hash to pass on to the GET request to which a successful
+      description: >-
+        parameters hash to pass on to the GET request to which a successful
         request will be redirected.  Eg, `success[mark]=mycardname`
+
   schemas:
-    nucleus view:
+    nucleus_view:
       name: nucleus view
       type: object
       properties:
@@ -163,7 +185,8 @@ components:
           type: string
         codename:
           type: string
-    atom view:
+
+    atom_view:
       name: atom view
       type: object
       properties:
@@ -180,7 +203,8 @@ components:
           type: string
         content:
           type: string
-    molecule view:
+
+    molecule_view:
       type: object
       properties:
         id:
@@ -190,7 +214,7 @@ components:
         url:
           type: string
         type:
-          "$ref": "#/components/schemas/nucleus%20view"
+          $ref: '#/components/schemas/nucleus_view'
         codename:
           type: string
         content:
@@ -200,7 +224,7 @@ components:
         items:
           type: array
           items:
-            "$ref": "#/components/schemas/atom%20view"
+            $ref: '#/components/schemas/atom_view'
         links:
           type: array
           items:
@@ -208,8 +232,9 @@ components:
         ancestors:
           type: array
           items:
-            "$ref": "#/components/schemas/atom%20view"
-    errors view:
+            $ref: "#/components/schemas/atom_view"
+
+    errors_view:
       type: object
       properties:
         error_status:
@@ -218,16 +243,22 @@ components:
           type: array
           items:
             type: string
+
   responses:
-    200:
-      description: card data
+    "200":
+      description: |-
+        Card data. Defaults to molecule view.
       content:
         application/json:
           schema:
-            "$ref": "#/components/schemas/molecule%20view"
-    404:
-      description: Could not find the card requested.
+            $ref: '#/components/schemas/molecule_view'
+    "404":
+      description: "Could not find the card requested."
       content:
         application/json:
           schema:
-            "$ref": "#/components/schemas/errors%20view"
+            $ref: '#/components/schemas/errors_view'
+    "302":
+      description: |-
+        Successful non-idempotent requests redirect to idempotent GET
+        requests.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decko
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.109.0
+        version: 1.110.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.109.0
+        version: 1.110.0
 - !ruby/object:Gem::Dependency
   name: card-mod-defaults
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.0
 description: a wiki approach to structured data, dynamic interaction,  and web design
 email:
 - info@decko.org
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.2
 specification_version: 4
 summary: structured wiki web platform
 test_files: []