robin_cms 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee6ad0de352f4750144a35a2b258d5d2da00e8fc345f269be1aeec80a45bf5ee
-  data.tar.gz: 5bed86dbdf4f9c4041e324d60284583beb1c65551b3ff15964d3950fed8c9cd3
+  metadata.gz: 26f13be1b3e97bce69e705daf56e969916467591b7c30b2877c2ce29e07e62d3
+  data.tar.gz: 7f34fbee635184285025e757e3c52ef8e25467255ed4a90647203bbfcd656756
 SHA512:
-  metadata.gz: dc0022fb5043ef5a2a640111ca650926c542cbd0a2a39f5895e6e2f6461edb4c6e4f44d1b8a9fbab01096dfb23ded529bc1458ac6923938eed8a82bcde2e2e71
-  data.tar.gz: 7cc63df15ad7619328ac1c9cf0c45c0dddf106e724081ad49a6b60d5f61645dab33dd6d7329e4b8ff39ebbfad0188aef714952e64c100b9ad59827eb0cfc69e1
+  metadata.gz: a420e205f0f06d34817b5cb1424f513051cddb7a665dcddb9d707c091088969e7031bef154542347691fe109a612f58741c229f622380281e4289a2bcfa1a268
+  data.tar.gz: 7d1e1bbd2b23d02c02a7dcca004c35015663bb2ece865f7d4ebfabbcd96e2897bc95bd758bd64145cb70d5ef2f7819717d195417f7121254080773b1f70a9f43

data/lib/robin_cms/cms.rb

@@ -90,6 +90,11 @@ module RobinCMS
         published: params[:published],
         q: params[:q]
       )
+
+      if @library.singular?
+        redirect to("/libraries/#{params[:kind]}/item/0")
+      end
+
       erb :library
     end
 

data/lib/robin_cms/configuration.rb

@@ -31,6 +31,17 @@ module RobinCMS
       fields: []
     }.freeze
 
+    SINGULAR_DEFAULTS = {
+      type: "singular",
+      location: "_data",
+      static_location: "uploads",
+      filetype: "yml",
+      description: "",
+      can_create: false,
+      can_delete: false,
+      fields: []
+    }.freeze
+
     FIELD_DEFAULTS = {
       type: "text",
       default: nil,
@@ -55,7 +66,7 @@ module RobinCMS
       type: "hidden"
     }].freeze
 
-    AUTOMATIC_DRAFT_FIELDS = [{
+    AUTOMATIC_COLLECTION_FIELDS = [{
       label: "Published",
       id: "published",
       type: "select",
@@ -72,6 +83,14 @@ module RobinCMS
       order: 2
     }].freeze
 
+    AUTOMATIC_SINGULAR_FIELDS = [{
+      label: "Title",
+      id: "title",
+      type: "hidden",
+      required: true,
+      order: 1
+    }]
+
     AUTOMATIC_IMAGE_FIELDS = [{
       id: "image_src",
       type: "hidden"
@@ -94,10 +113,7 @@ module RobinCMS
         YAML.load_file(config_file, symbolize_names: true)
       end
 
-      # TODO: use a ruby schema instead of a json file. Makes it easier to
-      # reuse elements and what not.
-      schema_file = File.join(__dir__, "configuration-schema.json")
-      schema = JSON.parse(File.read(schema_file))
+      schema = ConfigurationSchema.schema
       errors = JSON::Validator.fully_validate(schema, data)
 
       unless errors.empty?
@@ -122,11 +138,24 @@ module RobinCMS
       library[:type].nil? || library[:type] == "collection"
     end
 
+    def data?(library)
+      library[:type] == "data"
+    end
+
+    def singular?(library)
+      library[:type] == "singular"
+    end
+
     def merge_config(config)
       merge(config, {
         libraries: config[:libraries].map do |library|
-          library_defaults =
-            collection?(library) ? COLLECTION_DEFAULTS : DATA_DEFAULTS
+          library_defaults = if collection?(library)
+            COLLECTION_DEFAULTS
+          elsif data?(library)
+            DATA_DEFAULTS
+          elsif singular?(library)
+            SINGULAR_DEFAULTS
+          end
 
           library_defaults.merge(library, {
             fields: library[:fields].map do |field|
@@ -144,7 +173,15 @@ module RobinCMS
         library[:fields].append(*AUTOMATIC_FIELDS)
 
         if collection?(library)
-          library[:fields].append(*AUTOMATIC_DRAFT_FIELDS)
+          library[:fields].append(*AUTOMATIC_COLLECTION_FIELDS)
+        end
+
+        # Replace the automatic title field with a hidden one. The title is not
+        # used for singular fields, but every item is required to have one, so
+        # hide it in the UI.
+        if singular?(library)
+          # Using prepend ensures this one stays when we call uniq! below.
+          library[:fields].prepend(*AUTOMATIC_SINGULAR_FIELDS)
         end
 
         # Ensure the automatic image fields are inserted directly after the

data/lib/robin_cms/configuration_schema.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal => true
+
+module RobinCMS
+  module ConfigurationSchema
+    def self.field_schema(kind)
+      field_types = [
+        "text",
+        "date",
+        "hidden",
+        "number",
+        "color",
+        "email",
+        "url",
+        "select",
+        "image"
+      ]
+
+      if kind == "collection"
+        field_types << "richtext"
+        field_types << "array"
+      end
+
+      {
+        "type" => "object",
+        "required" => ["id", "label"],
+        "properties" => {
+          "id" => { "type" => "string" },
+          "label" => { "type" => "string" },
+          "type" => { "type" => "string", "enum" => field_types },
+          "default" => { "type" => "string" },
+          "required" => { "type" => "boolean" },
+          "readonly" => { "type" => "boolean" },
+          "option" => {
+            "type" => "array",
+            "items" => {
+              "type" => "object",
+              "required" => ["label", "value"],
+              "properties" => {
+                "label" => { "type" => "string" },
+                "value" => { "type" => "string" }
+              }
+            }
+          },
+          "dimensions" => { "type" => "string", "pattern" => "^[0-9]+x[0-9]+$" },
+          "filetype" => { "type" => "string", "enum" => ["png", "jpg"] },
+          "description" => { "type" => "string" },
+          "order" => { "type" => "number" }
+        }
+      }
+    end
+
+    def self.library_schema(kind)
+      filetypes = case kind
+      when "collection"
+        ["html"]
+      when "data", "singular"
+        ["yml"]
+      end
+
+      {
+        "type" => "object",
+        "required" => ["id", "label", "label_singular"],
+        "properties" => {
+          "id" => { "type" => "string" },
+          "type" => { "type" => "string", "const" => kind },
+          "filetype" => { "type" => "string", "enum" => filetypes },
+          "label" => { "type" => "string" },
+          "label_singular" => { "type" => "string" },
+          "location" => { "type" => "string" },
+          "static_location" => { "type" => "string" },
+          "description" => { "type" => "string" },
+          "can_create" => { "type" => "boolean" },
+          "can_delete" => { "type" => "boolean" },
+          "pattern" => { "type" => "string" },
+          "display_name_pattern" => { "type" => "string" },
+          "fields" => { "type" => "array", "items" => field_schema(kind) }
+        }
+      }
+    end
+
+    def self.schema
+      {
+        "$schema" => "http://json-schema.org/draft-06/schema#",
+        "title" => "RobinCMS configuration schema",
+        "type" => "object",
+        "required" => ["url", "libraries"],
+        "properties" => {
+          "title" => { "type" => "string" },
+          "url" => { "type" => "string" },
+          "build_command" => { "type" => "string" },
+          "accent_color" => {
+            "type" => "string",
+            "pattern" => '^\\#{1}[a-fA-F0-9]{6}'
+          },
+          "libraries" => {
+            "type" => "array",
+            "items" => {
+              "anyOf" => [
+                library_schema("collection"),
+                library_schema("data"),
+                library_schema("singular")
+              ]
+            }
+          }
+        }
+      }
+    end
+  end
+end

data/lib/robin_cms/library.rb

@@ -29,6 +29,8 @@ module RobinCMS
         extend CollectionLibrary
       when "data"
         extend DataLibrary
+      when "singular"
+        extend SingularLibrary
       end
     end
 
@@ -86,5 +88,21 @@ module RobinCMS
     def kind
       @schema[:id]
     end
+
+    def type
+      @schema[:type]
+    end
+
+    def collection?
+      type == "collection"
+    end
+
+    def data?
+      type == "data"
+    end
+
+    def singular?
+      type == "singular"
+    end
   end
 end

data/lib/robin_cms/singular_library.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RobinCMS
+  module SingularLibrary
+    # Since there is only one of these, give it the special id 0.
+    ID = 0
+
+    def self.extended(target)
+      # Since singular files can't be created or delete by users, create an
+      # empty one automatically if it doesn't already exist.
+
+      filename = target.schema[:id]
+      filetype = target.schema[:filetype]
+      filepath = File.join(target.schema[:location], "#{filename}.#{filetype}")
+
+      return if File.exist?(filepath)
+
+      FileUtils.mkdir_p(File.dirname(filepath))
+      item = Item.new(nil, {title: target.schema[:label]}, **target.schema)
+      item.update_timestamps!
+      serialized = YAML.dump(item.frontmatter, stringify_names: true)
+      File.write(filepath, serialized)
+    end
+
+    def create(_attributes = nil)
+      raise InvalidOperationError, "Invalid operation for Singular item"
+    end
+
+    def find_one(_id = nil)
+      # Ignore the id parameter. For singular libraries, there is only a single
+      # item. The id parameter is left for API compatibility with the other
+      # library types.
+
+      item = YAML.load_file(filepath, symbolize_names: true, permitted_classes: [Date])
+
+      return nil unless item
+
+      Item.new(ID, item, **@schema)
+    end
+
+    def all
+      # Returns an array of the only item. For API compatibility with the other
+      # library types.
+      [find_one].compact
+    end
+
+    def write(item)
+      FileUtils.mkdir_p(File.dirname(filepath))
+      FileUtils.touch(filepath)
+
+      item.update_timestamps!
+      serialized = YAML.dump(item.frontmatter, stringify_names: true)
+      File.write(filepath, serialized)
+
+      filepath
+    end
+
+    def delete(_id = nil)
+      raise InvalidOperationError, "Invalid operation for Singular item"
+    end
+
+    private
+
+    def filepath
+      File.join(@schema[:location], "#{@schema[:id]}.#{@schema[:filetype]}")
+    end
+  end
+end

data/lib/robin_cms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RobinCMS
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/robin_cms/views/layout.erb

@@ -35,7 +35,13 @@
         </span>
       </header>
     <% end %>
+
     <main id="site-content">
+      <% if session[:auth_user] %>
+        <header class="card --clear">
+          <%= erb :nav %>
+        </header>
+      <% end %>
       <%= yield %>
       <footer id="site-footer" class="card --clear">
         <%= erb :"logo.svg" %>
@@ -46,6 +52,7 @@
         </p>
       </footer>
     </main>
+
     <dialog id="successdialog" class="card">
       <h2>Success!</h2>
       <p><%= flash[:success_dialog] %></p>
@@ -55,6 +62,7 @@
         </form>
       </div>
     </dialog>
+
     <dialog id="errordialog" class="card">
       <h2>Oops, something went wrong.</h2>
       <p><%= flash[:error_dialog] %></p>
@@ -65,6 +73,7 @@
       </div>
     </dialog>
   </body>
+
   <script>
     const image = document.getElementById("__field_image")
     if (image) {

data/lib/robin_cms/views/library.erb

@@ -1,6 +1,3 @@
-<header class="card --clear">
-  <%= erb :nav %>
-</header>
 <div class="card">
   <% if @library[:description] %>
     <p><%= @library[:description] %></p>
@@ -13,7 +10,9 @@
     </form>
   <% end %>
 </div>
+
 <%= erb :filter_form %>
+
 <% if @items.empty? %>
   <div class="no-items">
     Nothing to show.

data/lib/robin_cms/views/library_actions.erb

@@ -1,5 +1,7 @@
 <span class="controls">
-  <a href="<%= library_url(@library) %>">Back</a>
+  <% unless @library.singular? %>
+    <a href="<%= library_url(@library) %>">Back</a>
+  <% end %>
   <button form="<%= safe_id(@item.id, 'edit_item') %>" type="submit">Save</button>
   <%= erb :delete_dialog if has_delete %>
 </span>

data/lib/robin_cms/views/library_item.erb

@@ -4,6 +4,7 @@
   </h2>
   <%= erb :library_actions, locals: { has_delete: @item.can_delete? } %>
 </header>
+
 <form
   id="<%= safe_id(@item.id, 'edit_item') %>"
   class="card"

data/lib/robin_cms.rb

@@ -23,10 +23,14 @@ module RobinCMS
 
   class ConversionError < StandardError
   end
+
+  class InvalidOperationError < StandardError
+  end
 end
 
 require_relative "robin_cms/version"
 require_relative "robin_cms/configuration"
+require_relative "robin_cms/configuration_schema"
 require_relative "robin_cms/editable"
 require_relative "robin_cms/sluggable"
 require_relative "robin_cms/queryable"
@@ -34,6 +38,7 @@ require_relative "robin_cms/item"
 require_relative "robin_cms/library"
 require_relative "robin_cms/collection_library"
 require_relative "robin_cms/data_library"
+require_relative "robin_cms/singular_library"
 require_relative "robin_cms/item"
 require_relative "robin_cms/auth"
 require_relative "robin_cms/flash"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robin_cms
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aron Lebani
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-11 00:00:00.000000000 Z
+date: 2026-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -80,8 +80,8 @@ files:
 - lib/robin_cms/auth.rb
 - lib/robin_cms/cms.rb
 - lib/robin_cms/collection_library.rb
-- lib/robin_cms/configuration-schema.json
 - lib/robin_cms/configuration.rb
+- lib/robin_cms/configuration_schema.rb
 - lib/robin_cms/data_library.rb
 - lib/robin_cms/editable.rb
 - lib/robin_cms/flash.rb
@@ -89,6 +89,7 @@ files:
 - lib/robin_cms/item.rb
 - lib/robin_cms/library.rb
 - lib/robin_cms/queryable.rb
+- lib/robin_cms/singular_library.rb
 - lib/robin_cms/sluggable.rb
 - lib/robin_cms/version.rb
 - lib/robin_cms/views/change_password.erb

data/lib/robin_cms/configuration-schema.json

@@ -1,120 +0,0 @@
-{
-	"$schema": "http://json-schema.org/draft-06/schema#",
-	"title": "RobinCMS configuration schema",
-	"type": "object",
-	"required": ["url", "libraries"],
-	"properties": {
-		"title": { "type": "string" },
-		"url": { "type": "string" },
-		"build_command": { "type": "string" },
-		"accent_color": {
-			"type": "string",
-			"pattern": "^\\#{1}[a-fA-F0-9]{6}"
-		},
-		"libraries": {
-			"type": "array",
-			"items": {
-				"anyOf": [
-					{ "$ref": "#/$defs/library_schema" },
-					{ "$ref": "#/$defs/data_schema" }
-				]
-			}
-		}
-	},
-	"$defs": {
-		"options_schema": {
-			"type": "array",
-			"items": {
-				"type": "object",
-				"required": ["label", "value"],
-				"properties": {
-					"label": { "type": "string" },
-					"value": { "type": "string" }
-				}
-			}
-		},
-		"image_dimensions_schema": { "type": "string", "pattern": "^[0-9]+x[0-9]+$" },
-		"image_filetype_schema": { "type": "string", "enum": ["png", "jpg"] },
-		"library_schema": {
-			"type": "object",
-			"required": ["id", "label", "label_singular"],
-			"properties": {
-				"id": { "type": "string" },
-				"type": { "type": "string", "const": "collection" },
-				"filetype": { "type": "string", "enum": ["html"] },
-				"label": { "type": "string" },
-				"label_singular": { "type": "string" },
-				"location": { "type": "string" },
-				"static_location": { "type": "string" },
-				"description": { "type": "string" },
-				"can_create": { "type": "boolean" },
-				"can_delete": { "type": "boolean" },
-				"pattern": { "type": "string" },
-				"display_name_pattern": { "type": "string" },
-				"fields": {
-					"type": "array",
-					"items": {
-						"type": "object",
-						"required": ["id", "label"],
-						"properties": {
-							"id": { "type": "string" },
-							"label": { "type": "string" },
-							"type": {
-								"type": "string",
-								"enum": ["text", "richtext", "date", "hidden", "number", "color", "email", "url", "select", "image", "array"]
-							},
-							"default": { "type": "string" },
-							"required": { "type": "boolean" },
-							"readonly": { "type": "boolean" },
-							"options": { "$ref": "#/$defs/options_schema" },
-							"dimensions": { "$ref": "#/$defs/image_dimensions_schema" },
-							"filetype": { "$ref": "#/$defs/image_filetype_schema" },
-							"description": { "type": "string" },
-							"order": { "type": "number" }
-						}
-					}
-				}
-			}
-		},
-		"data_schema": {
-			"type": "object",
-			"required": ["id", "label", "label_singular"],
-			"properties": {
-				"id": { "type": "string" },
-				"type": { "type": "string", "const": "data" },
-				"filetype": { "type": "string", "enum": ["yml"] },
-				"label": { "type": "string" },
-				"label_singular": { "type": "string" },
-				"location": { "type": "string" },
-				"static_location": { "type": "string" },
-				"description": { "type": "string" },
-				"can_create": { "type": "boolean" },
-				"can_delete": { "type": "boolean" },
-				"pattern": { "type": "string" },
-				"display_name_pattern": { "type": "string" },
-				"fields": {
-					"type": "array",
-					"items": {
-						"type": "object",
-						"required": ["id", "label"],
-						"properties": {
-							"id": { "type": "string" },
-							"label": { "type": "string" },
-							"type": {
-								"type": "string",
-								"enum": ["text", "date", "hidden", "number", "color", "email", "url", "select", "image"]
-							},
-							"default": { "type": "string" },
-							"required": { "type": "boolean" },
-							"readonly": { "type": "boolean" },
-							"options": { "$ref": "#/$defs/options_schema" },
-							"dimensions": { "$ref": "#/$defs/image_dimensions_schema" },
-							"filetype": { "$ref": "#/$defs/image_filetype_schema" },
-							"description": { "type": "string" }
-						}
-					}
-				}
-			}
-		}
-	}
-}