filepress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e18ee52d65d384ba64e31f69826907c5768e90530880e519b2e60b08c7b3792
+  data.tar.gz: d0120941b4b5808438c7003c8a8fa9652587dd26eee6ee6c4f5d78efe2fd8336
+SHA512:
+  metadata.gz: b375a0c1a6335d95df185db9c47d9b69d4366f7dd3176fb66ae0ff21fdd6ad8542019880bf68faf7f935249008991b0794570522eec79dc3c14da878f1f61770
+  data.tar.gz: dd4b78d2e56ead2fc7b4c3c9233652c90840c1f1682b6eaf1b51e651e5e2b6ab4d505dfeadd8ba68a43555731c7fecdeb13ceb06b50873490f55b0cad1430b3a

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Carl Dawson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# Filepress
+
+**Write content as flat files. Use it anywhere in your Rails app.**
+
+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.
+
+---
+
+## ✨ Why use Filepress?
+
+- 📝 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
+
+---

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/filepress/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Filepress
+  VERSION = "0.1.0"
+end

data/lib/filepress.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "active_support/concern"
+
+require_relative "filepress/version"
+
+module Filepress
+  class Syncer
+    def self.sync!(model_class)
+      opts = model_class.filepress_options
+      raise "Missing Filepress Options" unless opts
+
+      path = Rails.root.join(opts[:path])
+      key = opts[:key]
+      content_attr = opts[:content_attribute]
+
+      seen_keys = []
+
+      Dir.glob("#{path}/#{opts[:glob]}").each 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
+
+        seen_keys << identifier
+
+        record = model_class.find_or_initialize_by(key => identifier)
+        record.assign_attributes(data)
+        record.send("#{content_attr}=", content)
+        record.save!
+      end
+
+      # Clean up records whose source file no longer exists
+      model_class.where.not(key => seen_keys).destroy_all
+    end
+
+    def self.sync_all!
+      models = ActiveRecord::Base.descendants.select do |klass|
+        klass.respond_to?(:filepress_options)
+      end
+
+      models.each { |model| sync!(model) }
+    end
+  end
+
+  module ModelExt
+    def filepress_model(path: nil, glob: "*.md", key: :slug, content_attribute: :content)
+      class_attribute :filepress_options, instance_accessor: false, default: {}
+
+      self.filepress_options = {
+        path: path || "app/content/#{name.underscore.pluralize}",
+        glob: glob,
+        key: key,
+        content_attribute: content_attribute
+      }
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend Filepress::ModelExt
+end
+
+if defined?(Rake::Task)
+  namespace :filepress do
+    desc "Sync all filepress-backed models"
+    task sync: :environment do
+      Rails.application.eager_load!
+      Filepress::Syncer.sync_all!
+    end
+  end
+end

data/sig/filepress.rbs

@@ -0,0 +1,4 @@
+module Filepress
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: filepress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Dawson
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Filepress lets you manage content as simple flat files, with all the
+  power of ActiveRecord.
+email:
+- email@carldaws.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/filepress.rb
+- lib/filepress/version.rb
+- sig/filepress.rbs
+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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Write content as flat files, use it anywhere in your Rails app.
+test_files: []