railspress-engine 0.1.0

data/lib/generators/railspress/install/install_generator.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/base"
+
+module Railspress
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install RailsPress: copy migrations, mount engine, and configure JavaScript"
+
+      def copy_railspress_migrations
+        rake "railspress:install:migrations"
+      end
+
+      def copy_action_text_migrations
+        if action_text_migration_exists?
+          say_status :skip, "ActionText migrations already exist", :yellow
+        else
+          say_status :create, "ActionText migrations", :green
+          rake "railties:install:migrations FROM=action_text"
+        end
+      end
+
+      def copy_active_storage_migrations
+        if active_storage_migration_exists?
+          say_status :skip, "ActiveStorage migrations already exist", :yellow
+        else
+          say_status :create, "ActiveStorage migrations", :green
+          rake "railties:install:migrations FROM=active_storage"
+        end
+      end
+
+      def mount_engine
+        route_content = 'mount Railspress::Engine => "/railspress"'
+
+        if File.read(rails_route_file).include?("Railspress::Engine")
+          say_status :skip, "RailsPress engine already mounted", :yellow
+        else
+          route route_content
+          say_status :mounted, "RailsPress engine at /railspress", :green
+        end
+      end
+
+      def configure_importmap
+        return unless importmap_available?
+
+        importmap_file = Rails.root.join("config", "importmap.rb")
+        importmap_content = File.read(importmap_file)
+
+        # Pin ActiveStorage (required for ActionText attachments)
+        unless importmap_content.include?("@rails/activestorage")
+          append_to_file importmap_file, <<~RUBY
+
+            # ActiveStorage for file uploads
+            pin "@rails/activestorage", to: "activestorage.esm.js"
+          RUBY
+          say_status :pinned, "@rails/activestorage in importmap", :green
+        end
+
+        # Pin Lexxy editor
+        if importmap_content.include?('"lexxy"')
+          say_status :skip, "Lexxy already pinned in importmap", :yellow
+        else
+          append_to_file importmap_file, <<~RUBY
+
+            # RailsPress rich text editor
+            pin "lexxy", to: "lexxy.js"
+          RUBY
+          say_status :pinned, "Lexxy in importmap", :green
+        end
+      end
+
+      def configure_javascript
+        return unless importmap_available?
+
+        application_js = Rails.root.join("app", "javascript", "application.js")
+        return unless File.exist?(application_js)
+
+        js_content = File.read(application_js)
+
+        if js_content.include?('import "lexxy"')
+          say_status :skip, "Lexxy already imported in application.js", :yellow
+        else
+          append_to_file application_js, <<~JS
+
+            // RailsPress rich text editor
+            import "lexxy"
+          JS
+          say_status :added, "Lexxy import to application.js", :green
+        end
+      end
+
+      def show_post_install_message
+        say ""
+        say "=" * 60, :green
+        say "  RailsPress installed successfully!", :green
+        say "=" * 60, :green
+        say ""
+        say "Next steps:", :yellow
+        say ""
+        say "  1. Run migrations:"
+        say "     $ rails db:migrate", :cyan
+        say ""
+        say "  2. Access the admin dashboard:"
+        say "     http://localhost:3000/railspress/admin", :cyan
+        say ""
+        say "  3. (Optional) Change the mount path in config/routes.rb:"
+        say "     mount Railspress::Engine => \"/blog\"", :cyan
+        say ""
+        say "JavaScript setup:", :yellow
+        say "  The installer added Lexxy (rich text editor) to your importmap"
+        say "  and application.js. If you use a custom JS entry point, add:"
+        say ""
+        say "     import \"lexxy\"", :cyan
+        say ""
+        say "=" * 60, :green
+      end
+
+      private
+
+      def rails_route_file
+        Rails.root.join("config", "routes.rb")
+      end
+
+      def migrations_dir
+        Rails.root.join("db", "migrate")
+      end
+
+      def action_text_migration_exists?
+        Dir.glob(migrations_dir.join("*_create_action_text_tables*.rb")).any?
+      end
+
+      def active_storage_migration_exists?
+        Dir.glob(migrations_dir.join("*_create_active_storage_tables*.rb")).any?
+      end
+
+      def importmap_available?
+        defined?(Importmap) && Rails.root.join("config", "importmap.rb").exist?
+      end
+    end
+  end
+end

data/lib/railspress/engine.rb

@@ -0,0 +1,14 @@
+module Railspress
+  class Engine < ::Rails::Engine
+    isolate_namespace Railspress
+
+    # Register engine assets with the asset pipeline (Propshaft)
+    initializer "railspress.assets" do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join("app", "assets", "stylesheets").to_s
+        app.config.assets.paths << root.join("app", "assets", "javascripts").to_s
+        app.config.assets.paths << root.join("app", "assets", "images").to_s
+      end
+    end
+  end
+end

data/lib/railspress/version.rb

@@ -0,0 +1,3 @@
+module Railspress
+  VERSION = "0.1.0"
+end

data/lib/railspress.rb

@@ -0,0 +1,79 @@
+require "railspress/version"
+require "railspress/engine"
+require "lexxy"
+
+module Railspress
+  class Configuration
+    attr_accessor :author_class_name,
+                  :current_author_method,
+                  :author_scope,
+                  :author_display_method
+
+    attr_reader :authors_enabled, :header_images_enabled
+
+    def initialize
+      @authors_enabled = false
+      @header_images_enabled = false
+      @author_class_name = "User"
+      @current_author_method = :current_user
+      @author_scope = nil
+      @author_display_method = :name
+    end
+
+    # Declarative setter: config.enable_authors
+    def enable_authors
+      @authors_enabled = true
+    end
+
+    # Declarative setter: config.enable_header_images
+    def enable_header_images
+      @header_images_enabled = true
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Convenience accessors
+    def authors_enabled?
+      configuration.authors_enabled
+    end
+
+    def header_images_enabled?
+      configuration.header_images_enabled
+    end
+
+    def author_class
+      configuration.author_class_name.constantize
+    end
+
+    def available_authors
+      scope = configuration.author_scope
+      klass = author_class
+
+      case scope
+      when Symbol then klass.public_send(scope)
+      when Proc   then scope.call(klass)
+      else             klass.all
+      end
+    end
+
+    def author_display_method
+      configuration.author_display_method
+    end
+
+    def current_author_method
+      configuration.current_author_method
+    end
+  end
+end

data/lib/tasks/railspress_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :railspress do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: railspress-engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Avi Flombaum
+bindir: bin
+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: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: lexxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.23.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.23.beta
+description: RailsPress provides drop-in blog functionality with categories, tags,
+  rich text editing, and an admin interface.
+email:
+- avi@flatironschool.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/railspress/admin.js
+- app/assets/stylesheets/actiontext.css
+- app/assets/stylesheets/railspress/admin.css
+- app/assets/stylesheets/railspress/application.css
+- app/controllers/railspress/admin/base_controller.rb
+- app/controllers/railspress/admin/categories_controller.rb
+- app/controllers/railspress/admin/dashboard_controller.rb
+- app/controllers/railspress/admin/posts_controller.rb
+- app/controllers/railspress/admin/tags_controller.rb
+- app/controllers/railspress/application_controller.rb
+- app/helpers/railspress/application_helper.rb
+- app/jobs/railspress/application_job.rb
+- app/mailers/railspress/application_mailer.rb
+- app/models/railspress/application_record.rb
+- app/models/railspress/category.rb
+- app/models/railspress/post.rb
+- app/models/railspress/post_tag.rb
+- app/models/railspress/tag.rb
+- app/views/active_storage/blobs/_blob.html.erb
+- app/views/layouts/action_text/contents/_content.html.erb
+- app/views/layouts/railspress/admin.html.erb
+- app/views/layouts/railspress/application.html.erb
+- app/views/railspress/admin/categories/_form.html.erb
+- app/views/railspress/admin/categories/edit.html.erb
+- app/views/railspress/admin/categories/index.html.erb
+- app/views/railspress/admin/categories/new.html.erb
+- app/views/railspress/admin/dashboard/index.html.erb
+- app/views/railspress/admin/posts/_form.html.erb
+- app/views/railspress/admin/posts/edit.html.erb
+- app/views/railspress/admin/posts/index.html.erb
+- app/views/railspress/admin/posts/new.html.erb
+- app/views/railspress/admin/posts/show.html.erb
+- app/views/railspress/admin/shared/_flash.html.erb
+- app/views/railspress/admin/shared/_sidebar.html.erb
+- app/views/railspress/admin/tags/_form.html.erb
+- app/views/railspress/admin/tags/edit.html.erb
+- app/views/railspress/admin/tags/index.html.erb
+- app/views/railspress/admin/tags/new.html.erb
+- config/routes.rb
+- db/migrate/20241218000001_create_railspress_categories.rb
+- db/migrate/20241218000002_create_railspress_tags.rb
+- db/migrate/20241218000003_create_railspress_posts.rb
+- db/migrate/20241218000004_create_railspress_post_tags.rb
+- lib/generators/railspress/authors/authors_generator.rb
+- lib/generators/railspress/authors/templates/add_author_to_railspress_posts.rb.tt
+- lib/generators/railspress/authors/templates/railspress.rb.tt
+- lib/generators/railspress/install/install_generator.rb
+- lib/railspress.rb
+- lib/railspress/engine.rb
+- lib/railspress/version.rb
+- lib/tasks/railspress_tasks.rake
+homepage: https://github.com/aviflombaum/railspress-engine
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aviflombaum/railspress-engine
+  source_code_uri: https://github.com/aviflombaum/railspress-engine
+  changelog_uri: https://github.com/aviflombaum/railspress-engine/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: |2+
+
+  ============================================================
+    RailsPress installed! Run the generator to complete setup:
+
+      $ rails generate railspress:install
+
+    This will:
+      - Copy database migrations
+      - Mount the engine in your routes
+      - Install ActionText (if needed)
+  ============================================================
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A mountable blog engine for Rails 8+
+test_files: []
+...