robin_cms 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36e4c02115d1c4d3849376ff70e8c20fd0fb1e80c6ae806f4ae09a7a88e981bf
-  data.tar.gz: f6a86d8721ee1180221c19f7480341accfc3cf5e191f1fde4eab4a7747c757ce
+  metadata.gz: 398d0d377f476c68de1e02e504cbe7353347e1f93835d3cce55811d7a90e82a3
+  data.tar.gz: 5b253a4f07db5e5282bf879695ec96ed51d28a2b8e667f1110213b45e0c63e98
 SHA512:
-  metadata.gz: cefc9e3a84b3b19c786f2110e0baffe2ceafdea25e120320d3a0241ca4aa934775674df7157e0acb9a03dda831d5787516751ec59716ff39436e724e874a696f
-  data.tar.gz: ca16243899f791e64780e268aea3a45c54e2f4d9e6dfd160b4ba07adaf5d25e79f6d3fd7404f42fd67f0b849725963f17e879db10c0ace46dba641d5e95d5f51
+  metadata.gz: b976e15a5ca7c7af3f44f8be1ee2df5f6ddfe766ddfedafeb6c17dd41c48dc449e13d819b0dcdac17c23263a04d9c3e7e99a1f3cc5b66d97b562c7fc8d77ecfb
+  data.tar.gz: 609ed3f32088e434615486ba25da6fdb199a074b0d628ee5e58f45b13f80151b7319437bad45538d636158e6b522701e3960663b2269db5f78ea3699e233ea07

data/README.md

@@ -65,6 +65,63 @@ Just the usual incantation:
 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
@@ -107,60 +164,10 @@ end
 ```
 
 After running `bundle exec jekyll serve`, the CMS should be available on your
-website under `/admin`.
-
-## Configuring
-
-You can define your content model in a `_cms.yml` file like this:
-
-```yml
-libraries:
-  - name: "poem"
-    label: "Poem"
-    location: "poems"
-    filetype: "html"
-    fields:
-      - { label: "Title", name; "title", type: "input" }
-      - { label: "Author", name; "author_name", type: "input" }
-      - { label: "Content", name; "content", type: "richtext" }
-  - name: "book"
-    label: "Book"
-    location: "books"
-    filetype: "yml"
-    fields:
-      - { label: "Title", name; "title", type: "input" }
-      - { label: "Author", name; "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.
+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.
 
 ## Testing
 

data/lib/robin_cms/data_item.rb

@@ -68,8 +68,7 @@ module RobinCMS
       fm = frontmatter.to_h.transform_keys(&:to_s)
 
       items = if File.exist?(filepath)
-        raw = File.read(filepath)
-        YAML.load(raw)
+        YAML.load_file(filepath) || []
       else
         []
       end

data/lib/robin_cms/itemable.rb

@@ -7,10 +7,10 @@ module RobinCMS
     DATETIME_FORMAT = "%Y-%m-%d"
 
     # The keys which we don't want to serialize.
-    SERIALIZE_IGNORE_KEYS = %i[id kind content image captures].freeze
+    SERIALIZE_IGNORE_KEYS = [:id, :kind, :content, :image, :captures].freeze
 
     def initialize(id, library, attrs = {})
-      %i[id location filetype].each do |key|
+      [:id, :location, :filetype].each do |key|
         unless library.has_key?(key)
           raise TypeError, "Missing required field #{key}"
         end

data/lib/robin_cms/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robin_cms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aron Lebani
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-10 00:00:00.000000000 Z
+date: 2025-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt