filepress 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e03605fd0950c7f477b42f3c7e0a1945fb36beb2e36712d07b3f3afea0589174
-  data.tar.gz: bb918105f4fcfd3e0c69c0c989a6be41894e364f86243f42ec609f251548cf66
+  metadata.gz: cd4430ee794157675a4edeeb36bf4d09ca137300f1ca4b6dc3f1f1b1dd23c387
+  data.tar.gz: 6a164c8673b1cd8d1be639f6ff03955bee8f3306a6e25ad8bc4f0274c6fd93ed
 SHA512:
-  metadata.gz: 340b5ac2730761c80eb9c7168ba034df36c99035cb9fce1dc6ced9fab58535c81983c49386141e03c824765f0962810249e75abb485df445aedf288aad8038fd
-  data.tar.gz: 80ed126ff2e59a217d061f88f183d7ea2fde0d5f352547061f0b30dbf5c325862534ef8b0e995367fd19ee2694c83c2ad4b7df75dac53aa6111a2b767c53ce5c
+  metadata.gz: b707d65fb21ec3d1621705e63c7d7bd1707fb4804982f4029e93946ddc15ada6b155c2bc434aae8e60a16f2d13990815743b6c6d2ab413d1395949a0287d6a10
+  data.tar.gz: 1577478c2cbcbfb39931ef4cd00ad920802646da96ba0cdd2d40548bc8d883519b80abd7a3d5fefaf1fbdaa2b02313a07e51deb400ca3a675d7e1ba9101d62a9

data/README.md

@@ -1,17 +1,114 @@
 # Filepress
 
-**Write content as flat files. Use it anywhere in your Rails app.**
+Filepress is a minimal Rails plugin that offers the best of both worlds for content management:
+- Write and version control your content in Markdown (or a similar format)
+- Sync it seamlessly to ActiveRecord models so you can harness the full power of a Rails backend.
 
-Filepress lets you manage content in plain text files with frontmatter — like Markdown, HTML, or anything else — and sync them directly into your ActiveRecord models. It's the simplicity of static files, with the full power of a Rails backend.
+Ideal for blogs, documentation, or any content-driven Rails app where you want the flexibility of flat files and the structure of a database.
 
----
+## Getting Started
+
+1. Install the gem
+
+Add it to your Gemfile:
+
+```ruby
+gem "filepress"
+```
+
+2. Create a model to represent your content
+
+Be sure to include a field that can serve as a unique identifier (e.g. `slug`):
+
+```bash
+rails g model Post title:string slug:string body:text
+```
+
+3. Enable Filepress for your model
+
+Use the `filepress` method in your model class:
 
-## ✨ Why use Filepress?
+```ruby
+class Post < ApplicationRecord
+  filepress
+end
+```
 
-- 📝 Write content in any editor — no CMS required
-- 🔁 Keep content version-controlled with Git
-- ⚡ Instantly available in your Rails app via ActiveRecord
-- 🧠 Works with any file type (Markdown, HTML, plain text, etc.)
-- 🧹 Automatically adds, updates, and deletes records
+4. Add some content
 
+Create Markdown files in `app/content/posts`. The filename becomes the slug, and YAML frontmatter maps to your model's attributes:
+
+```markdown
+---
+title: My First Post
+published: true
 ---
+
+Hello, this is my first post!
+```
+
+That's it! Filepress syncs your content to the database automatically — on boot, on deploy, and whenever files change in development. No rake tasks, no deploy hooks.
+
+You're free to query your content via ActiveRecord like any other model. Filepress doesn't dictate how you render the body — use a Markdown parser like Kramdown, Redcarpet, or similar.
+
+## How it works
+
+Filepress reads your content files, extracts YAML frontmatter, and uses the values to populate or update model attributes. The rest of the file becomes the value of the body attribute (or another field, if configured).
+
+- Syncs are wrapped in a transaction — if any file fails, nothing changes
+- Unknown frontmatter keys (that don't match a column) are silently ignored
+- In development, Rails' built-in file watcher picks up live edits without a server restart
+
+## Configuration
+
+You can customize how Filepress behaves by passing options to `filepress`:
+
+### `from:` — Set a custom content directory
+
+```ruby
+class Post < ApplicationRecord
+  filepress from: "app/my_custom_content_folder"
+end
+```
+
+### `extensions:` — Use filetypes besides Markdown
+
+```ruby
+class Post < ApplicationRecord
+  filepress extensions: ["html", "txt"]
+end
+```
+
+### `key:` — Use a unique identifier other than `slug`
+
+```ruby
+class Post < ApplicationRecord
+  filepress key: :name
+end
+```
+
+### `body:` — Set which attribute stores the main content
+
+```ruby
+class Post < ApplicationRecord
+  filepress body: :content
+end
+```
+
+### `destroy_stale:` — Prevent deletion of records when files are removed
+
+By default, Filepress deletes records when the corresponding file is removed. Disable this behaviour with:
+
+```ruby
+class Post < ApplicationRecord
+  filepress destroy_stale: false
+end
+```
+
+## Why Filepress?
+
+Filepress is for you if:
+
+- You prefer writing content in files
+- You want the convenience of version control for content
+- And you still want powerful querying, associations, validations and all the other Rails goodness

data/lib/filepress/engine.rb

@@ -0,0 +1,22 @@
+module Filepress
+  class Engine < ::Rails::Engine
+    initializer "filepress.model" do
+      ActiveSupport.on_load(:active_record) do
+        extend Filepress::Model
+      end
+    end
+
+    initializer "filepress.file_watcher" do |app|
+      content_path = app.root.join("app", "content")
+
+      app.config.after_initialize do
+        if content_path.exist?
+          extensions = Filepress.watched_extensions
+          app.reloaders << app.config.file_watcher.new([], { content_path.to_s => extensions }) do
+            Filepress.sync
+          end
+        end
+      end
+    end
+  end
+end

data/lib/filepress/file_parser.rb

@@ -0,0 +1,27 @@
+require "yaml"
+
+module Filepress
+  class FileParser
+    FRONTMATTER_PATTERN = /\A---\s*\n(.*?\n?)---\s*\n?(.*)\z/m
+
+    attr_reader :attributes, :body
+
+    def initialize(raw_content)
+      @attributes, @body = parse(raw_content)
+    end
+
+    private
+
+    def parse(raw_content)
+      if (match = raw_content.match(FRONTMATTER_PATTERN))
+        attributes = YAML.safe_load(match[1], permitted_classes: [Date, Time, Symbol]) || {}
+        body = match[2].strip
+      else
+        attributes = {}
+        body = raw_content.strip
+      end
+
+      [attributes.symbolize_keys, body]
+    end
+  end
+end

data/lib/filepress/model.rb

@@ -1,15 +1,17 @@
 module Filepress
   module Model
-    def filepress(from: nil, glob: "*.md", key: :slug, body: :body, destroy_stale: true)
-      class_attribute :filepress_options, instance_accessor: false, default: {}
+    def filepress(from: nil, extensions: ["md"], key: :slug, body: :body, destroy_stale: true)
+      class_attribute :filepress_options, instance_accessor: false
 
       self.filepress_options = {
-        from: from || "app/content/#{name.underscore.pluralize}",
-        glob: glob,
+        from: from || Rails.root.join("app", "content", model_name.plural).to_s,
+        extensions: extensions,
         key: key,
         body: body,
         destroy_stale: destroy_stale
       }
+
+      Filepress.register(self, filepress_options)
     end
   end
 end

data/lib/filepress/sync.rb

@@ -0,0 +1,58 @@
+module Filepress
+  class Sync
+    def initialize(config)
+      @model_class = config[:model_class]
+      @from = config[:from]
+      @extensions = config[:extensions]
+      @key = config[:key]
+      @body = config[:body]
+      @destroy_stale = config[:destroy_stale]
+    end
+
+    def perform
+      return unless table_exists?
+      return unless File.directory?(@from)
+
+      synced_identifiers = []
+
+      @model_class.transaction do
+        content_files.each do |file_path|
+          identifier_value = File.basename(file_path, ".*")
+          parsed = FileParser.new(File.read(file_path))
+
+          record = @model_class.find_or_initialize_by(@key => identifier_value)
+          record.assign_attributes(permitted_attributes(record, parsed.attributes))
+          record.public_send(:"#{@body}=", parsed.body)
+          record.save!
+
+          synced_identifiers << identifier_value
+        end
+
+        if @destroy_stale
+          @model_class.where.not(@key => synced_identifiers).destroy_all
+        end
+      end
+    end
+
+    private
+
+    def table_exists?
+      @model_class.connection_pool.with_connection do
+        @model_class.table_exists?
+      end
+    rescue ActiveRecord::NoDatabaseError, ActiveRecord::StatementInvalid
+      false
+    end
+
+    def permitted_attributes(record, attributes)
+      known_columns = record.class.column_names.map(&:to_sym)
+      attributes.select { |key, _| known_columns.include?(key) }
+    end
+
+    def content_files
+      @extensions.flat_map do |ext|
+        Dir[File.join(@from, "*.#{ext}")]
+      end.sort
+    end
+  end
+end

data/lib/filepress/version.rb

@@ -1,3 +1,3 @@
 module Filepress
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/filepress.rb

@@ -1,39 +1,29 @@
 require "filepress/version"
-require "filepress/railtie"
+require "filepress/engine"
+require "filepress/file_parser"
 require "filepress/model"
+require "filepress/sync"
 
 module Filepress
   class << self
-    def sync
-      Rails.application.eager_load!
-      models = ActiveRecord::Base.descendants.select { |model| model.respond_to? :filepress_options }
-
-      models.each do |model|
-        options = model.filepress_options
-        raise "Filepress options missing for #{model.name}" unless options
-
-        path = Rails.root.join(options[:from])
-        key = options[:key]
-        body_attribute = options[:body]
-
-        keys = Dir.glob("#{path}/#{options[:glob]}").map do |file|
-          raw = File.read(file)
-          frontmatter, body = raw.split(/^---\s*$/, 3).reject(&:empty?)
-          data = YAML.safe_load(frontmatter, symbolize_names: true)
-          content = body.strip
-
-          identifier = data[key]
-          raise "Missing key `#{key}` in frontmatter for #{file}" unless identifier
+    def registry
+      @registry ||= {}
+    end
 
-          record = model.find_or_initialize_by(key => identifier)
-          record.assign_attributes(data)
-          record.send("#{body_attribute}=", content)
-          record.save!
+    def register(model_class, options)
+      config = options.merge(model_class: model_class)
+      registry[model_class.name] = config
+      Sync.new(config).perform
+    end
 
-          identifier
-        end
+    def watched_extensions
+      exts = registry.values.flat_map { |config| config[:extensions] }.uniq
+      exts.empty? ? ["md"] : exts
+    end
 
-        model.where.not(key => keys).destroy_all if options[:destroy_stale]
+    def sync
+      registry.each_value do |config|
+        Sync.new(config).perform
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filepress
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Carl Dawson
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
 description: Filepress lets you manage content as simple flat files, with all the
   power of ActiveRecord.
 email:
@@ -35,17 +35,18 @@ files:
 - README.md
 - Rakefile
 - lib/filepress.rb
+- lib/filepress/engine.rb
+- lib/filepress/file_parser.rb
 - lib/filepress/model.rb
-- lib/filepress/railtie.rb
+- lib/filepress/sync.rb
 - lib/filepress/version.rb
-- lib/tasks/filepress_tasks.rake
 homepage: https://github.com/carldaws/filepress
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/carldaws/filepress
-  source_code_uri: https://github.com/carldawson/filepress
+  source_code_uri: https://github.com/carldaws/filepress
 rdoc_options: []
 require_paths:
 - lib
@@ -53,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Write content as flat files, use it anywhere in your Rails app.
 test_files: []

data/lib/filepress/railtie.rb

@@ -1,11 +0,0 @@
-module Filepress
-  class Railtie < ::Rails::Railtie
-    ActiveSupport.on_load(:active_record) do
-      extend Filepress::Model
-    end
-
-    rake_tasks do
-      Dir[File.expand_path("../tasks/**/*.rake", __dir__)].each { |f| load f }
-    end
-  end
-end

data/lib/tasks/filepress_tasks.rake

@@ -1,6 +0,0 @@
-namespace :filepress do
-  desc "Synchronise Filepress models"
-  task sync: :environment do
-    Filepress.sync
-  end
-end