rivet_cms 0.1.0.pre → 0.1.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80cc85ed4a64302837525fa46d4c3dfa9513929ca29318db4cf6136dcb3db358
-  data.tar.gz: ca6ee6f525a26a5a480d46bfc014dce6fac1636d6da125d8ad59d010d168759a
+  metadata.gz: 876703a8ca3148fbd0c7c01cbee963fc854e37c1efbc94375205c7a22d7cc78b
+  data.tar.gz: 369344dbf9c17af9ad639509a7cb78121314f1a26f80844ba16bce5b59d6311f
 SHA512:
-  metadata.gz: 89e6857b0d727e9c83601f68186fe08344a17b73395372b30ed40b552252ecfecb5cc56e8a39cd0c332373ec4e8466fdb0cd46ee692851d516d8c3a23f91a2c2
-  data.tar.gz: 7412c588bac4bacf3841f220d55d1c1b5664c19b985f2a86ffe12fb8f7155ec409aa80097b18deeb8d3d4a4b234a2c77058053c675b090427873a6dd83f6a742
+  metadata.gz: b19547659ff8ee822a41c7a4e28d4de0e8f9a8767e2576e4334f5bde2245e6b10c7d677fa1ae238ffac55b7d68d0eff0575eef87c26504ccbf9bc5dd4feae965
+  data.tar.gz: 8447100f98fa858d23667c2d686c357fa630a08d974a6595c9da4833eb4c2e8313cbcd2453ca5df686eddd6f6c6bd493fb2afd5cf9fea0f0f9282744c254d17d

data/README.md

@@ -26,3 +26,9 @@ Contribution directions go here.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgments
+
+This project includes code adapted from or inspired by:
+
+- [Spree Commerce](https://github.com/spree/spree) - Route handling pattern for extensible engines (MIT License)

data/config/routes.rb

@@ -1,56 +1,58 @@
-RivetCms::Engine.register_routes do
-  get '/', to: "dashboard#index", as: :dashboard
+RivetCms::Engine.routes.draw do
+  RivetCms::Routes.add_routes do
+    get '/', to: "dashboard#index"
 
-  # Content Type Management
-  resources :content_types, path: 'content-types' do
-    resources :fields, except: [:show] do
-      collection do
-        post :update_positions
-      end
-      member do
-        patch :update_width
+    # Content Type Management
+    resources :content_types, path: 'content-types' do
+      resources :fields, except: [:show] do
+        collection do
+          post :update_positions
+        end
+        member do
+          patch :update_width
+        end
       end
+      resources :contents
     end
-    resources :contents
-  end
 
-  # Component Management
-  resources :components do
-    resources :fields, except: [:show] do
-      collection do
-        post :update_positions
+    # Component Management
+    resources :components do
+      resources :fields, except: [:show] do
+        collection do
+          post :update_positions
+        end
       end
     end
-  end
 
-  # API Documentation
-  namespace :api do
-    resource :docs, only: [:show]
-  end
+    # API Documentation
+    namespace :api do
+      resource :docs, only: [:show]
+    end
 
-  # Helper method to check if content type exists and matches the collection/single type
-  content_type_exists = ->(slug, is_collection) {
-    RivetCMS::ContentType.exists?(slug: slug, is_single: !is_collection)
-  }
+    # Helper method to check if content type exists and matches the collection/single type
+    content_type_exists = ->(slug, is_collection) {
+      RivetCMS::ContentType.exists?(slug: slug, is_single: !is_collection)
+    }
 
-  # API routes with versioning
-  namespace :api do
-    namespace :v1 do
-      # Dynamic routes for content types
-      get ':slug', to: 'content#index', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
-      post ':slug', to: 'content#create', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
-      get ':slug/:id', to: 'content#show', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
-      put ':slug/:id', to: 'content#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
-      patch ':slug/:id', to: 'content#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
-      delete ':slug/:id', to: 'content#destroy', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
+    # API routes with versioning
+    namespace :api do
+      namespace :v1 do
+        # Dynamic routes for content types
+        get ':slug', to: 'content#index', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
+        post ':slug', to: 'content#create', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
+        get ':slug/:id', to: 'content#show', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
+        put ':slug/:id', to: 'content#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
+        patch ':slug/:id', to: 'content#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
+        delete ':slug/:id', to: 'content#destroy', constraints: ->(req) { content_type_exists.call(req.params[:slug], true) }
 
-      # Routes for single type content
-      get ':slug', to: 'single#show', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
-      put ':slug', to: 'single#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
-      patch ':slug', to: 'single#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
-      post ':slug', to: 'single#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
+        # Routes for single type content
+        get ':slug', to: 'single#show', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
+        put ':slug', to: 'single#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
+        patch ':slug', to: 'single#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
+        post ':slug', to: 'single#update', constraints: ->(req) { content_type_exists.call(req.params[:slug], false) }
+      end
     end
   end
-end
 
-RivetCms::Engine.draw_routes
+  RivetCms::Routes.draw_routes
+end

data/lib/rivet_cms/engine.rb

@@ -4,6 +4,7 @@ require "prefixed_ids"
 require "kaminari"
 require "turbo-rails"
 require "stimulus-rails"
+require "rivet_cms/routes"
 
 module RivetCms
   class Engine < ::Rails::Engine
@@ -21,35 +22,16 @@ module RivetCms
       g.factory_bot dir: 'spec/factories'
     end
 
-    class << self
-      # Accessor for the routes storage
-      def routes_storage
-        # Use a class-level instance variable with a default empty array
-        @routes_storage ||= []
-      end
-
-      # Register route definitions to be drawn later
-      # @param block [Proc] A block containing route definitions
-      def register_routes(&block)
-        routes_storage << block  # Add the block to the storage
-      end
-
-      # Draw all registered routes into the engine's RouteSet
-      def draw_routes
-        # Capture the routes in a local variable before entering the block
-        stored_routes = routes_storage
+    def self.add_routes(&block)
+      RivetCms::Routes.add_routes(&block)
+    end
 
-        # Use the engine's routes.draw method to provide the proper routing context
-        routes.draw do
-          # Iterate over the captured routes
-          stored_routes.each do |route_block|
-            instance_eval(&route_block)
-          end
-        end
+    def self.append_routes(&block)
+      RivetCms::Routes.append_routes(&block)
+    end
 
-        # Clear the routes to prevent re-drawing if called again
-        routes_storage.clear
-      end
+    def self.draw_routes(&block)
+      RivetCms::Routes.draw_routes(&block)
     end
   end
 end

data/lib/rivet_cms/routes.rb

@@ -0,0 +1,49 @@
+# Route handling pattern adapted from Spree Commerce
+# https://github.com/spree/spree/blob/839866a32845009d8a1fdf21cb7201e99f6ff49c/core/lib/spree/core/routes.rb
+# License: MIT - https://github.com/spree/spree/blob/main/LICENSE.md
+
+module RivetCms
+  module Routes
+    def self.draw_routes(&block)
+      @rivet_routes ||= []
+      @append_routes ||= []
+
+      # Evaluate an immediate block if given
+      eval_block(block) if block_given?
+
+      # Evaluate stored main routes
+      @rivet_routes.each { |route_block| eval_block(&route_block) }
+
+      # Evaluate appended routes
+      @append_routes.each { |route_block| eval_block(&route_block) }
+
+      # Clear routes to avoid duplication on subsequent calls
+      @rivet_routes = []
+      @append_routes = []
+    end
+
+    def self.add_routes(&block)
+      @rivet_routes ||= []
+      store_route(@rivet_routes, &block)
+    end
+
+    def self.append_routes(&block)
+      @append_routes ||= []
+      store_route(@append_routes, &block)
+    end
+
+    private
+
+    # Helper method for safely storing a route block in the given collection.
+    def self.store_route(collection, &block)
+      collection << block unless collection.include?(block)
+    end
+
+    # Evaluate a block within the context of the engine's routes.
+    def self.eval_block(&block)
+      RivetCms::Engine.routes.draw do
+        instance_exec(&block)
+      end
+    end
+  end
+end

data/lib/rivet_cms/version.rb

@@ -1,3 +1,3 @@
 module RivetCms
-  VERSION = "0.1.0.pre"
+  VERSION = "0.1.2.pre"
 end

data/lib/rivet_cms.rb

@@ -1,7 +1,10 @@
 require "rivet_cms/version"
+require "rivet_cms/routes"
 require "rivet_cms/engine"
 
 module RivetCms
+  class Error < StandardError; end
+
   class << self
     def configuration
       @configuration ||= Configuration.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rivet_cms
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.2.pre
 platform: ruby
 authors:
 - Nathan Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -199,6 +199,7 @@ files:
 - db/migrate/20250317194359_create_core_tables.rb
 - lib/rivet_cms.rb
 - lib/rivet_cms/engine.rb
+- lib/rivet_cms/routes.rb
 - lib/rivet_cms/version.rb
 - lib/tasks/rivet_cms_tasks.rake
 homepage: https://github.com/narch/rivet_cms