robin_cms 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a49ee1ef9d638a300e82352bba65071dc6dfffecfb4cb409fbf8cbb8fbdd69
-  data.tar.gz: 928887dfc693144ebaaf9f2233a08b161faa7146ab7a037501098052d046fe74
+  metadata.gz: 667498a061c442f90e57b20fdd7a12db60e76f447e0a948be22276620c5532ef
+  data.tar.gz: 4e6317eee498285fc39f939cb86b80847ab9e5c629ad7864efe8c2761ff17bb7
 SHA512:
-  metadata.gz: 17bcd5f6cc1d057c6740fb3d7cf393432cd823956fcf4e78421b085cfc1ec3ef382c40b776b5f570cfb295af6cae71fd8a0711e5accc118641509bc519947bd9
-  data.tar.gz: e7f2f736f7535dce94edbe15a41c24201959e1231d0827c542ec3b4560215d1285e49f1d94321a57bdca50c1cfd85015f8a11f74cbd952b967081e7f5b3291a3
+  metadata.gz: a5ae9452f1da1b65f19f21798d5036109e88114af97bdf1c3d10d453992034361cedf22805e660b380b0b2cbcd5083b2ec005ea900b4666b436e58a78078395f
+  data.tar.gz: 15395c440febd9fd0dea69bc7cf99c9338a3d97eef5a039662e46670e1d1dfe0b259a4004c3378d595d2b1398a23a860980a8476c79959696fd69edbe5471942

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/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)

data/lib/robin_cms/item.rb

@@ -100,5 +100,9 @@ module RobinCMS
       value = @attributes[field[:id].to_sym] || field[:default]
       value.to_s
     end
+
+    def can_delete?
+      @id && @opts[:can_delete]
+    end
   end
 end

data/lib/robin_cms/version.rb

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

data/lib/robin_cms/views/image_field.erb

@@ -1,4 +1,7 @@
 <label for="<%= safe_id('image', 'field') %>"><%= field[:label] %></label>
+<% if field[:description] %>
+  <small><%= field[:description] %></small>
+<% end %>
 <%#
   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

data/lib/robin_cms/views/input_field.erb

@@ -1,4 +1,7 @@
 <label for="<%= safe_id(field[:id], 'field') %>"><%= field[:label] %></label>
+<% if field[:description] %>
+  <small><%= field[:description] %></small>
+<% end %>
 <input
   id="<%= safe_id(field[:id], 'field') %>"
   type="<%= field[:type] %>"

data/lib/robin_cms/views/library_item.erb

@@ -2,7 +2,7 @@
   <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
   class="card"

data/lib/robin_cms/views/richtext_field.erb

@@ -1,6 +1,9 @@
 <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>
+<% if field[:description] %>
+  <small><%= field[:description] %></small>
+<% end %>
 <input
   id="richtext-content"
   type="hidden"

data/lib/robin_cms/views/select_field.erb

@@ -1,4 +1,7 @@
 <label for="<%= safe_id(field[:id], 'field') %>"><%= field[:label] %></label>
+<% if field[:description] %>
+  <small><%= field[:description] %></small>
+<% end %>
 <select
   id="<%= safe_id(field[:id], 'field') %>"
   name="<%= field[:id] %>"

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;
@@ -153,7 +150,10 @@ tbody tr:hover td {
 
 label {
   display: block;
-  margin-bottom: var(--padding-xs);
+}
+
+small {
+  color: var(--font-color-light);
 }
 
 input {
@@ -190,6 +190,13 @@ select {
   box-shadow: var(--box-shadow-input);
 }
 
+input,
+select,
+trix-toolbar {
+  display: block;
+  margin-top: var(--padding-xs);
+}
+
 button {
   padding: var(--padding-xxs) var(--padding-xs);
   color: var(--accent-color);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robin_cms
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Aron Lebani
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-17 00:00:00.000000000 Z
+date: 2025-10-30 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: []
@@ -111,11 +111,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 +135,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: []