robin_cms 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a49ee1ef9d638a300e82352bba65071dc6dfffecfb4cb409fbf8cbb8fbdd69
-  data.tar.gz: 928887dfc693144ebaaf9f2233a08b161faa7146ab7a037501098052d046fe74
+  metadata.gz: 6a9634aa2592fdf851123491cc53c9b1b347b6e6ca3f7f37d4adbd9e0fb494c7
+  data.tar.gz: 3885036d121802207eb4ae9cf80c372211ee199f60fa30c7e11f5b916af5c570
 SHA512:
-  metadata.gz: 17bcd5f6cc1d057c6740fb3d7cf393432cd823956fcf4e78421b085cfc1ec3ef382c40b776b5f570cfb295af6cae71fd8a0711e5accc118641509bc519947bd9
-  data.tar.gz: e7f2f736f7535dce94edbe15a41c24201959e1231d0827c542ec3b4560215d1285e49f1d94321a57bdca50c1cfd85015f8a11f74cbd952b967081e7f5b3291a3
+  metadata.gz: f38e98b366edb3294b56e2b97c80819149163020d41dd565e893ec3d4d8c84f2332f108de62858a9d55bf135176bf8f042ee28980bd1eb6f6d6ddaf7d330f210
+  data.tar.gz: 29d90d7896c8366dbe5373bdd89193d4dcd336577cd8c517d2b5b5082b1aa65ffef18c0b733b5387bb9bf53405c8fcf77b8afdb700e1a682c98bc37ae1c51540

data/README.md

@@ -4,7 +4,7 @@
 > This software is currently in beta. There may be bugs and breaking changes.
 > If you find a bug, I'd love to hear about it.
 
-![Robin CMS logo](./assets/robin-logo.png)
+![Robin CMS logo](./doc/assets/robin-logo.png)
 
 Robin CMS is a minimalist flat-file CMS built with Ruby and Sinatra. It is
 designed to be used by developers for creating custom built websites where the
@@ -61,125 +61,53 @@ that are commonly found in CMS software have been omitted.
   content. You can however add richtext fields to your content models (see
   example below).
 
-## Installation
-
-Just the usual incantation:
-
-```sh
-gem install robin_cms
-```
-
-## Configuring
-
-You can define your content model in a `_cms.yml` file like this:
-
-```yml
-url: https://example.com
-title: Example
-libraries:
-  - id: poem
-    type: collection
-    label: Poem
-    location: poems
-    filetype: html
-    fields:
-      - { label: Title, id: title, type: input }
-      - { label: Author, id: author_name, type: input }
-      - { label: Content, id: content, type: richtext }
-  - id: book
-    type: data
-    label: Book
-    location: books
-    filetype: yml
-    fields:
-      - { label: Title, id: title, type: input }
-      - { label: Author, id: author_name, type: input }
-```
-
-The admin username and password needs to be set in a `.htpasswd` file in the
-root directory of the project. Obviously make sure you `.gitignore` that file.
-Also make sure your static site generator is ignoring it because you don't want
-it in your public directory! Each line of the `.htpasswd` file should follow
-the format `<username>:<password>`, but note that only a single
-username/password is supported for now. The password needs to be encrypted with
-bcrypt. You can do this in Ruby with the `bcrypt` gem:
-
-```sh
-ruby -r bcrypt -e "puts BCrypt::Password.create('mypassword')"
-```
-
-Another thing to note is that if no `.htpasswd` file is found, it will
-automatically create one with username "admin" and password "admin". This lets
-you play around with it locally without configuring a password. So make sure
-you create a `.htpasswd` file before running it in production!
-
-You'll also need to expose a `SESSION_SECRET` environment variable. If you
-don't, it will create one for you, but it creates a new secret each time
-the server starts, meaning you will have to log in again whenever you restart
-the server. It is recommended to create one via Ruby's SecureRandom package.
-
-```sh
-ruby -r securerandom -e "puts SecureRandom.hex(64)"
-```
-
-See the [examples](./examples) folder for a full example. I haven't written any
-documentation yet, but the example `_cms.yml` file is thoroughly commented to
-explain each of the fields.
-
 ## Usage
 
-You have a few options for using this gem in your project. Firstly, you can use
-it directly as a CMS for any Static Site Generator with the following
-`config.ru`:
-
-```ruby
-require 'robin_cms'
-map "/admin" { run RobinCMS::CMS.new }
-```
+Robin CMS is packaged as a Ruby gem, so installation is as simple as
 
-Now you should be able to run `rackup`, and go to `http://localhost:9292/admin`
-in your browser.
+    gem install robin_cms
 
-Alternatively, you can embed it into your own Sinatra project like this:
+It's possible to use the CMS in a few different ways. You can use it as a
+standalone CMS for any Static Site Generator, you can embed it in a dynamic
+Sinatra app, or you can use it as a Jekyll plugin. If you're already using
+Jekyll as your SSG, this is the simplest approach.
 
-```ruby
-require 'robin_cms'
-require 'sinatra'
+See the [documentation](./docs/index.adoc) for further information on usage.
 
-use RobinCMS::CMS
-
-get '/' do
-  'Hello, world!'
-end
-
-run Sinatra::Application.new
-```
-
-Yet another option is to use it as a [Jekyll](https://jekyllrb.com/) plugin. To
-do this, you just need to pop `robin_cms` in the `:jekyll_plugins` group of
-your `Gemfile` like so:
-
-```
-gem "jekyll"
-
-group :jekyll_plugins do
-  gem "robin_cms"
-end
-```
+## Configuring
 
-After running `bundle exec jekyll serve`, the CMS should be available on your
-website under `/admin`. Note that if using it as a Jekyll plugin, you can put
-your config in Jekyll's `_config.yml` file under the `cms` field. You also
-don't need to specify the `url` and `title` fields, as these are taken from the
-Jekyll config.
+Your content model is defined in a single YAML file. It acts as a sort of
+schema for your content. An example YAML file looks like this:
+
+    url: https://example.com
+    title: Example
+    libraries:
+      - id: poem
+        type: collection
+        label: Poem
+        location: poems
+        filetype: html
+        fields:
+          - { label: Title, id: title, type: input }
+          - { label: Author, id: author_name, type: input }
+          - { label: Content, id: content, type: richtext }
+      - id: book
+        type: data
+        label: Book
+        location: books
+        filetype: yml
+        fields:
+          - { label: Title, id: title, type: input }
+          - { label: Author, id: author_name, type: input }
+
+See the [docs](./docs/index.adoc) for more details on configuration. You can
+also find some examples [here](./examples).
 
 ## Testing
 
 Unit test are written in RSpec. To run them:
 
-```
-rspec
-```
+    rake test
 
 ## Roadmap
 

data/lib/robin_cms/cms.rb

@@ -18,25 +18,18 @@ module RobinCMS
     set :session_secret, ENV.fetch("SESSION_SECRET", SecureRandom.hex(64))
 
     before do
-      if %w[/login /logout].include?(request.path_info)
-        pass
-      end
+      pass if %w[/login /logout].include?(request.path_info)
 
       redirect to("/login") unless session[:auth_user]
     end
 
     before /\/libraries\/(.*).*/ do
       kind = params[:captures].first.split("/").first
-      library_schema = @config.find_library(kind)
+      library_schema = @config.get_schema(kind)
 
       halt 404 unless library_schema
 
-      @library = case library_schema[:type]
-                 when "collection"
-                   CollectionLibrary.new(library_schema)
-                 when "data"
-                   DataLibrary.new(library_schema)
-                 end
+      @library = Library.new(library_schema)
     end
 
     after do

data/lib/robin_cms/collection_library.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RobinCMS
-  class CollectionLibrary < Library
+  module CollectionLibrary
     def create(attributes)
       id = make_slug(attributes[:title], @schema[:pattern])
       item = Item.new(id, attributes, **@schema)

data/lib/robin_cms/configuration-schema.json

@@ -69,6 +69,7 @@
 							"options": { "$ref": "#/$defs/options_schema" },
 							"dimensions": { "$ref": "#/$defs/image_dimensions_schema" },
 							"filetype": { "$ref": "#/$defs/image_filetype_schema" },
+							"description": { "type": "string" },
 							"order": { "type": "number" }
 						}
 					}
@@ -108,7 +109,8 @@
 							"readonly": { "type": "boolean" },
 							"options": { "$ref": "#/$defs/options_schema" },
 							"dimensions": { "$ref": "#/$defs/image_dimensions_schema" },
-							"filetype": { "$ref": "#/$defs/image_filetype_schema" }
+							"filetype": { "$ref": "#/$defs/image_filetype_schema" },
+							"description": { "type": "string" }
 						}
 					}
 				}

data/lib/robin_cms/configuration.rb

@@ -42,6 +42,7 @@ module RobinCMS
       id: "title",
       type: "text",
       required: true,
+      description: "Provide a short, descriptive title.",
       order: 1
     }, {
       label: "Published date",
@@ -65,6 +66,9 @@ module RobinCMS
         label: "Published",
         value: true
       }],
+      description: "Set this to draft if you're not ready to publish this item
+        just yet. Draft items won't appear on your website, even after clicking
+        'Publish site'.",
       order: 2
     }].freeze
 
@@ -74,7 +78,9 @@ module RobinCMS
     }, {
       id: "image_alt",
       type: "text",
-      label: "Alt text"
+      label: "Alt text",
+      description: "Provide a descriptive and concise description of your
+        image. This helps to improve the accessibility of your website."
     }].freeze
 
     def self.parse(config_file: "_cms.yml", jekyll_plugin: false)
@@ -101,7 +107,7 @@ module RobinCMS
       hash.each_with_object(new) { |(k, v), h| h[k] = v }
     end
 
-    def find_library(kind)
+    def get_schema(kind)
       self[:libraries].find { |library| library[:id] == kind }
     end
 

data/lib/robin_cms/data_library.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RobinCMS
-  class DataLibrary < Library
+  module DataLibrary
     def create(attributes)
       item = Item.new(nil, attributes, **@schema)
       write(item)

data/lib/robin_cms/item.rb

@@ -2,20 +2,20 @@
 
 module RobinCMS
   class Item
-    attr_reader :id, :attributes
+    attr_reader :id, :attributes, :schema
 
     DATETIME_FORMAT = "%Y-%m-%d"
 
     # The keys which we don't want to serialize.
     FRONTMATTER_IGNORE_KEYS = [:id, :content, :image, :captures].freeze
 
-    def initialize(id, attrs = {}, **opts)
+    def initialize(id, attrs = {}, **schema)
       if !attrs.empty? && !attrs.has_key?(:title)
         raise TypeError, "Missing required field `title'"
       end
 
       @id = id
-      @opts = opts
+      @schema = schema
 
       # Be sure to use the setter here so the keys get converted to symbols.
       self.attributes = attrs
@@ -71,9 +71,9 @@ module RobinCMS
     end
 
     def display_name
-      return @attributes[:title] unless @opts[:display_name_pattern]
+      return @attributes[:title] unless @schema[:display_name_pattern]
 
-      @opts[:display_name_pattern].clone.tap do |name|
+      @schema[:display_name_pattern].clone.tap do |name|
         @attributes.each { |key, value| name.gsub!(":#{key}", value) }
       end
     end
@@ -96,9 +96,14 @@ module RobinCMS
       frontmatter.to_h.transform_keys(&:to_s)
     end
 
-    def field_value_or_default(field)
+    def field_value_or_default(field_id)
+      field = @schema[:fields].find { |f| f[:id] == field_id }
       value = @attributes[field[:id].to_sym] || field[:default]
       value.to_s
     end
+
+    def can_delete?
+      @id && @schema[:can_delete]
+    end
   end
 end

data/lib/robin_cms/library.rb

@@ -8,38 +8,27 @@ module RobinCMS
 
     attr_reader :schema
 
+    def self.of_kind(kind, **opts)
+      config = Configuration.parse(**opts)
+      schema = config.get_schema(kind)
+      new(schema)
+    end
+
     def initialize(schema)
       @schema = schema.freeze
+
+      case schema[:type]
+      when "collection"
+        extend CollectionLibrary
+      when "data"
+        extend DataLibrary
+      end
     end
 
     def blank
       Item.new(nil, **@schema)
     end
 
-    def create(attributes)
-      raise NotImplementedError
-    end
-
-    def find_one(id)
-      raise NotImplementedError
-    end
-
-    def all
-      raise NotImplementedError
-    end
-
-    # Writes the specified item to disk.
-    #
-    # Returns the path where the item was written.
-    def write(item)
-      raise NotImplementedError
-    end
-
-    # Delete the item specified by +id+.
-    def delete(id)
-      raise NotImplementedError
-    end
-
     def create_static(filename, tempfile)
       path = File.join(@schema[:static_location], File.basename(make_slug(filename)))
       FileUtils.mkdir_p(File.dirname(path))

data/lib/robin_cms/version.rb

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

data/lib/robin_cms/views/field_label.erb

@@ -0,0 +1,9 @@
+<label for="<%= safe_id(field[:id], 'field') %>">
+  <%= field[:label] %>
+  <% unless field[:required] %>
+    <small>(optional)</small>
+  <% end %>
+</label>
+<% if field[:description] %>
+  <small><%= field[:description] %></small>
+<% end %>

data/lib/robin_cms/views/hidden_field.erb

@@ -2,5 +2,5 @@
   id="<%= safe_id(field[:id], 'field') %>"
   type="hidden"
   name="<%= field[:id] %>"
-  value="<%= @item.field_value_or_default(field) %>"
+  value="<%= @item.field_value_or_default(field[:id]) %>"
 />

data/lib/robin_cms/views/image_field.erb

@@ -1,9 +1,12 @@
-<label for="<%= safe_id('image', 'field') %>"><%= field[:label] %></label>
+<%= erb :field_label, locals: { field: field } %>
 <%#
   There is a bug here where if you upload a different image with the
   same name, it shows the old image due to caching. This is a very
   low priority because a) the user should be naming things in a
   reasonable way and b) you can always just do a hard refresh.
+
+  Also required does nothing here as we're not populating the field with any
+  initial values. This one probably needs to be fixed.
 %>
 <img
   id="image-preview"
@@ -15,6 +18,5 @@
   id="<%= safe_id('image', 'field') %>"
   type="file"
   name="image"
-  accept="image/png, image/jpeg"
-  <% if field[:required] %>required<% end %>
+  accept="image/png,image/jpeg"
 />

data/lib/robin_cms/views/input_field.erb

@@ -1,9 +1,9 @@
-<label for="<%= safe_id(field[:id], 'field') %>"><%= field[:label] %></label>
+<%= erb :field_label, locals: { field: field } %>
 <input
   id="<%= safe_id(field[:id], 'field') %>"
   type="<%= field[:type] %>"
   name="<%= field[:id] %>"
-  value="<%= @item.field_value_or_default(field) %>"
+  value="<%= @item.field_value_or_default(field[:id]) %>"
   <% if field[:required] %>required<% end %>
   <% if field[:readonly] %>readonly<% end %>
 />

data/lib/robin_cms/views/library.erb

@@ -28,12 +28,12 @@
   <table>
     <thead>
       <tr>
-        <th class="grow-column">Name</th>
+        <th>Name</th>
         <% if @library.drafts_enabled? %>
           <th>Status</th>
         <% end %>
-        <th>Created</th>
-        <th>Last updated</th>
+        <th class="date">Created</th>
+        <th class="date">Last updated</th>
       </tr>
     </thead>
     <tbody>
@@ -53,12 +53,12 @@
               </a>
             </td>
           <% end %>
-          <td>
+          <td class="date">
             <a href='<%= url("/libraries/#{@library.kind}/item/#{item.id}") %>'>
               <%= item.created_at.strftime("%b %d, %Y") %>
             </a>
           </td>
-          <td>
+          <td class="date">
             <a href='<%= url("/libraries/#{@library.kind}/item/#{item.id}") %>'>
               <%= item.updated_at.strftime("%b %d, %Y") %>
             </a>

data/lib/robin_cms/views/library_actions.erb

@@ -1,6 +1,6 @@
 <span class="controls">
   <a href='<%= url("/libraries/#{@library.kind}") %>'>Back</a>
-  <button type="submit">Save</button>
+  <button form="<%= safe_id(@item.id, 'edit_item') %>" type="submit">Save</button>
   <% if has_delete %>
     <%= erb :delete_dialog %>
   <% end %>

data/lib/robin_cms/views/library_item.erb

@@ -2,9 +2,10 @@
   <h2>
     <% if @item.id %>Edit<% else %>New<% end %> <%= @library[:label_singular].downcase %>
   </h2>
-  <%= erb :library_actions, locals: { has_delete: @library[:can_delete] && @item.id } %>
+  <%= erb :library_actions, locals: { has_delete: @item.can_delete? } %>
 </header>
 <form
+  id="<%= safe_id(@item.id, 'edit_item') %>"
   class="card"
   <% if @item.id %>
     action='<%= url("/libraries/#{@library.kind}/item/#{@item.id}") %>'

data/lib/robin_cms/views/richtext_field.erb

@@ -1,10 +1,10 @@
 <link rel="stylesheet" type="text/css" href="https://unpkg.com/trix@2.0.8/dist/trix.css">
 <script type="text/javascript" src="https://unpkg.com/trix@2.0.8/dist/trix.umd.min.js"></script>
-<label for="<%= safe_id(field[:id], 'field') %>"><%= field[:label] %></label>
+<%= erb :field_label, locals: { field: field } %>
 <input
   id="richtext-content"
   type="hidden"
   name="<%= field[:id] %>"
-  value="<%= @item.field_value_or_default(field) %>"
+  value="<%= @item.field_value_or_default(field[:id]) %>"
 >
 <trix-editor input="richtext-content"></trix-editor>

data/lib/robin_cms/views/select_field.erb

@@ -1,8 +1,8 @@
-<label for="<%= safe_id(field[:id], 'field') %>"><%= field[:label] %></label>
+<%= erb :field_label, locals: { field: field } %>
 <select
   id="<%= safe_id(field[:id], 'field') %>"
   name="<%= field[:id] %>"
-  value="<%= @item.field_value_or_default(field) %>"
+  value="<%= @item.field_value_or_default(field[:id]) %>"
 >
   <% for option in field[:options] %>
     <option
@@ -12,7 +12,7 @@
           selected
         <% end %>
       <% else %>
-        <% if option[:value].to_s == @item.field_value_or_default(field) %>
+        <% if option[:value].to_s == @item.field_value_or_default(field[:id]) %>
           selected
         <% end %>
       <% end %>

data/lib/robin_cms/views/stylesheet.css.erb

@@ -3,6 +3,7 @@
   --border-radius: 8px;
   --bg-color: rgb(246, 246, 247);
   --font-color: #141414;
+  --font-color-light: #44474a;
   --link-color: rgb(71, 95, 145);
   --accent-color: <%= @config[:accent_color] %>;
   --accent-color-light: <%= @config[:accent_color] %>1e;
@@ -24,10 +25,6 @@
   --box-shadow-input: inset rgba(0, 0, 0, 0.1) 0px 1px 0px 0px;
 }
 
-test {
-  te
-}
-
 @media only screen and (max-width: 1250px) {
   :root {
     --content-left-margin: 3rem;
@@ -80,11 +77,10 @@ th {
   font-weight: 500;
 }
 
-th,
-td {
-  white-space: nowrap;
-  overflow: hidden;
-  text-overflow: ellipsis;
+th.date,
+td.date > * {
+  width: 7rem;
+  text-align: right;
 }
 
 td a {
@@ -153,7 +149,10 @@ tbody tr:hover td {
 
 label {
   display: block;
-  margin-bottom: var(--padding-xs);
+}
+
+small {
+  color: var(--font-color-light);
 }
 
 input {
@@ -190,6 +189,14 @@ select {
   box-shadow: var(--box-shadow-input);
 }
 
+input,
+select,
+trix-toolbar,
+img#image-preview {
+  display: block;
+  margin-top: var(--padding-xs);
+}
+
 button {
   padding: var(--padding-xxs) var(--padding-xs);
   color: var(--accent-color);
@@ -405,10 +412,6 @@ hr {
   padding: 2rem;
 }
 
-.grow-column {
-  width: 100%;
-}
-
 .image-preview {
   width: 8rem;
   height: 8rem;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robin_cms
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Aron Lebani
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-17 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description:
+description: Robin CMS is a simple, flat-file CMS for Static Site Generators.
 email:
 - aron@lebani.dev
 executables: []
@@ -94,6 +94,7 @@ files:
 - lib/robin_cms/views/change_password.erb
 - lib/robin_cms/views/delete_dialog.erb
 - lib/robin_cms/views/error.erb
+- lib/robin_cms/views/field_label.erb
 - lib/robin_cms/views/filter_form.erb
 - lib/robin_cms/views/flash.erb
 - lib/robin_cms/views/hidden_field.erb
@@ -111,11 +112,11 @@ files:
 - lib/robin_cms/views/richtext_field.erb
 - lib/robin_cms/views/select_field.erb
 - lib/robin_cms/views/stylesheet.css.erb
-homepage: https://codeberg.org/evencuriouser/robin_cms
+homepage: https://robincms.org
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://codeberg.org/evencuriouser/robin_cms
+  homepage_uri: https://robincms.org
   source_code_uri: https://codeberg.org/evencuriouser/robin_cms
 post_install_message:
 rdoc_options: []
@@ -135,5 +136,5 @@ requirements: []
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: A minimalist, headless, rack-based flat-file CMS.
+summary: A simple, flat-file CMS for Static Site Generators.
 test_files: []