rails_site_engine 0.6.2

data/lib/rails_site_engine/site_profiles.rb

@@ -0,0 +1,166 @@
+require "pathname"
+require "yaml"
+
+module RailsSiteEngine
+  class SiteProfiles
+    DEFAULT_PATH = File.expand_path("../../config/site_profiles.yml", __dir__)
+
+    def initialize(path: DEFAULT_PATH)
+      @path = Pathname.new(path)
+      @profiles = load_profiles
+    end
+
+    def profile_keys
+      @profiles.keys
+    end
+
+    def profile(profile_key)
+      @profiles[normalize_key(profile_key)]
+    end
+
+    def profile_label(profile_key)
+      entry = profile(profile_key)
+      return normalize_key(profile_key) if entry.nil?
+
+      label = string_value(entry["label"])
+      label.empty? ? normalize_key(profile_key) : label
+    end
+
+    def specialty_keys(profile_key)
+      specialties_for(profile_key).keys
+    end
+
+    def specialty_label(profile_key, specialty_key)
+      entry = specialties_for(profile_key)[normalize_key(specialty_key)]
+      return normalize_key(specialty_key) if entry.nil?
+
+      label = string_value(entry["label"])
+      label.empty? ? normalize_key(specialty_key) : label
+    end
+
+    def default_specialty(profile_key)
+      profile_key = normalize_key(profile_key)
+      keys = specialty_keys(profile_key)
+      return nil if keys.empty?
+
+      configured = string_value(profile(profile_key)&.dig("default_specialty"))
+      return configured if keys.include?(configured)
+
+      keys.first
+    end
+
+    def requires_specialty?(profile_key)
+      specialty_keys(profile_key).any?
+    end
+
+    def concrete_profile_keys
+      profile_keys.each_with_object([]) do |key, memo|
+        entry = profile(key)
+        next unless entry.is_a?(Hash)
+
+        specialties = normalize_hash(entry["specialties"])
+        if specialties.empty?
+          template = string_value(entry["template"])
+          memo << template unless template.empty?
+          next
+        end
+
+        specialties.each_value do |specialty|
+          next unless specialty.is_a?(Hash)
+
+          template = string_value(specialty["template"])
+          memo << template unless template.empty?
+        end
+      end.uniq
+    end
+
+    def valid_concrete_profile?(key)
+      concrete_profile_keys.include?(normalize_key(key))
+    end
+
+    def fallback_concrete_profile
+      concrete_profile_keys.first
+    end
+
+    def template_root_for(concrete_profile_key)
+      key = normalize_key(concrete_profile_key)
+      return nil unless valid_concrete_profile?(key)
+
+      Pathname.new(DEFAULT_PATH)
+        .dirname
+        .join("../lib/generators/rails_site_engine/install/templates/site_profiles", key)
+        .expand_path
+    end
+
+    def resolve_concrete_profile(site_profile:, trade_specialty: nil)
+      profile_key = normalize_key(site_profile)
+      entry = profile(profile_key)
+      return nil unless entry.is_a?(Hash)
+
+      specialties = normalize_hash(entry["specialties"])
+      if specialties.any?
+        specialty_key = normalize_key(trade_specialty)
+        specialty_key = default_specialty(profile_key) if specialty_key.empty?
+        specialty = specialties[specialty_key]
+        return nil unless specialty.is_a?(Hash)
+
+        template = string_value(specialty["template"])
+        return nil if template.empty?
+
+        return template
+      end
+
+      template = string_value(entry["template"])
+      return nil if template.empty?
+
+      template
+    end
+
+    private
+
+    def specialties_for(profile_key)
+      entry = profile(profile_key)
+      return {} unless entry.is_a?(Hash)
+
+      normalize_hash(entry["specialties"])
+    end
+
+    def load_profiles
+      payload = load_yaml
+      profiles = normalize_hash(payload["profiles"])
+
+      profiles.each_with_object({}) do |(key, value), memo|
+        memo[normalize_key(key)] = normalize_hash(value)
+      end
+    end
+
+    def load_yaml
+      return {} unless @path.file?
+
+      YAML.safe_load(
+        @path.read,
+        permitted_classes: [],
+        permitted_symbols: [],
+        aliases: false
+      ) || {}
+    rescue Psych::SyntaxError
+      {}
+    end
+
+    def normalize_hash(value)
+      return {} unless value.is_a?(Hash)
+
+      value.each_with_object({}) do |(key, nested_value), memo|
+        memo[normalize_key(key)] = nested_value
+      end
+    end
+
+    def normalize_key(value)
+      value.to_s.strip
+    end
+
+    def string_value(value)
+      normalize_key(value)
+    end
+  end
+end

data/lib/rails_site_engine/sitemap_xml.rb

@@ -0,0 +1,26 @@
+require "erb"
+
+module RailsSiteEngine
+  module SitemapXml
+    def self.build(base_url:, paths:)
+      base_url = base_url.to_s.sub(%r{/\z}, "")
+      paths = Array(paths).map(&:to_s).reject(&:empty?)
+
+      urls = paths.map do |path|
+        loc = path == "/" ? "#{base_url}/" : "#{base_url}#{path}"
+        <<~XML
+          <url>
+            <loc>#{ERB::Util.html_escape(loc)}</loc>
+          </url>
+        XML
+      end.join
+
+      <<~XML
+        <?xml version="1.0" encoding="UTF-8"?>
+        <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+        #{urls}
+        </urlset>
+      XML
+    end
+  end
+end

data/lib/rails_site_engine/theme.rb

@@ -0,0 +1,54 @@
+require "pathname"
+require "yaml"
+
+module RailsSiteEngine
+  class Theme
+    DEFAULT_DAISYUI_THEME = "corporate"
+
+    def initialize(
+      path: nil,
+      host_config: RailsSiteEngine::SiteEngineConfig.new
+    )
+      if path
+        @override_path = Pathname.new(path)
+      else
+        @override_path = host_config.override_theme_path
+      end
+    end
+
+    def daisyui_light_theme
+      config.dig("daisyui", "theme").to_s.strip.presence || DEFAULT_DAISYUI_THEME
+    end
+
+    def daisyui_dark_theme
+      config.dig("daisyui", "dark_theme").to_s.strip.presence
+    end
+
+    def daisyui_dark_mode_enabled?
+      daisyui_dark_theme.present?
+    end
+
+    def daisyui_theme
+      daisyui_light_theme
+    end
+
+    private
+
+    def config
+      @config ||= load_yaml(@override_path)
+    end
+
+    def load_yaml(path)
+      return {} unless path.file?
+
+      YAML.safe_load(
+        path.read,
+        permitted_classes: [],
+        permitted_symbols: [],
+        aliases: false
+      ) || {}
+    rescue Psych::SyntaxError
+      {}
+    end
+  end
+end

data/lib/rails_site_engine/version.rb

@@ -0,0 +1,3 @@
+module RailsSiteEngine
+  VERSION = "0.6.2"
+end

data/lib/rails_site_engine.rb

@@ -0,0 +1,13 @@
+require "rails_site_engine/version"
+require "rails_site_engine/engine"
+require "rails_site_engine/content/store"
+require "rails_site_engine/markdown_renderer"
+require "rails_site_engine/profile_defaults"
+require "rails_site_engine/site_engine_config"
+require "rails_site_engine/site_profiles"
+require "rails_site_engine/theme"
+require "rails_site_engine/sitemap_xml"
+
+module RailsSiteEngine
+  # Your code goes here...
+end

data/lib/tasks/rails_site_engine_tasks.rake

@@ -0,0 +1,7 @@
+namespace :rails_site_engine do
+  desc "Install Rails Site Engine scaffolding into the host app"
+  task install: :environment do
+    require "rails/generators"
+    Rails::Generators.invoke("rails_site_engine:install", [], behavior: :invoke, destination_root: Rails.root.to_s)
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: rails_site_engine
+version: !ruby/object:Gem::Version
+  version: 0.6.2
+platform: ruby
+authors:
+- Nicholas Ladefoged
+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.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.1
+- !ruby/object:Gem::Dependency
+  name: commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+description: Rails engine providing layout, section rendering, content loading, SEO
+  defaults, and contact forms for high-velocity business websites.
+email:
+- ladefoged1991@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_site_engine/application.css
+- app/assets/stylesheets/rails_site_engine/engine.css
+- app/assets/stylesheets/rails_site_engine/engine.tailwind.css
+- app/controllers/rails_site_engine/application_controller.rb
+- app/controllers/rails_site_engine/contacts_controller.rb
+- app/controllers/rails_site_engine/meta_controller.rb
+- app/controllers/rails_site_engine/pages_controller.rb
+- app/helpers/rails_site_engine/application_helper.rb
+- app/javascript/controllers/rails_site_engine/color_mode_controller.js
+- app/javascript/controllers/rails_site_engine/form_submit_controller.js
+- app/javascript/controllers/rails_site_engine/mobile_nav_controller.js
+- app/javascript/rails_site_engine/application.js
+- app/jobs/rails_site_engine/application_job.rb
+- app/mailers/rails_site_engine/application_mailer.rb
+- app/mailers/rails_site_engine/contact_mailer.rb
+- app/models/rails_site_engine/application_record.rb
+- app/models/rails_site_engine/contact_message.rb
+- app/views/layouts/mailer.html.erb
+- app/views/layouts/mailer.text.erb
+- app/views/layouts/rails_site_engine/application.html.erb
+- app/views/rails_site_engine/contact_mailer/notify.text.erb
+- app/views/rails_site_engine/contacts/new.html.erb
+- app/views/rails_site_engine/pages/show.html.erb
+- app/views/rails_site_engine/sections/_contact_form.html.erb
+- app/views/rails_site_engine/sections/_cta_band.html.erb
+- app/views/rails_site_engine/sections/_faq.html.erb
+- app/views/rails_site_engine/sections/_feature_cards.html.erb
+- app/views/rails_site_engine/sections/_hero.html.erb
+- app/views/rails_site_engine/sections/_pricing_cards.html.erb
+- app/views/rails_site_engine/sections/_process_steps.html.erb
+- app/views/rails_site_engine/sections/_project_cards.html.erb
+- app/views/rails_site_engine/sections/_proof_strip.html.erb
+- app/views/rails_site_engine/sections/_rich_text.html.erb
+- app/views/rails_site_engine/sections/_stats.html.erb
+- app/views/rails_site_engine/sections/_testimonials.html.erb
+- app/views/rails_site_engine/sections/_unknown.html.erb
+- app/views/rails_site_engine/shared/_flash.html.erb
+- app/views/rails_site_engine/shared/_footer.html.erb
+- app/views/rails_site_engine/shared/_navbar.html.erb
+- config/importmap.rb
+- config/locales/en.yml
+- config/routes.rb
+- config/site_profiles.yml
+- lib/generators/rails_site_engine/install/install_generator.rb
+- lib/generators/rails_site_engine/install/templates/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/content/pages/services.md
+- lib/generators/rails_site_engine/install/templates/content/site.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/content/pages/services.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-carpentry/content/site.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/content/pages/services.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-electrician/content/site.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/content/pages/services.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-general/content/site.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/content/pages/services.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/home-services-plumbing/content/site.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/content/pages/work.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/portfolio/content/site.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/config/theme.yml
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/pages/about.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/pages/contact.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/pages/home.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/pages/pricing.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/pages/privacy.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/pages/projects.md
+- lib/generators/rails_site_engine/install/templates/site_profiles/software-contracting/content/site.yml
+- lib/rails_site_engine.rb
+- lib/rails_site_engine/content/store.rb
+- lib/rails_site_engine/engine.rb
+- lib/rails_site_engine/markdown_renderer.rb
+- lib/rails_site_engine/profile_defaults.rb
+- lib/rails_site_engine/site_engine_config.rb
+- lib/rails_site_engine/site_profiles.rb
+- lib/rails_site_engine/sitemap_xml.rb
+- lib/rails_site_engine/theme.rb
+- lib/rails_site_engine/version.rb
+- lib/tasks/rails_site_engine_tasks.rake
+homepage: https://github.com/your-org/rails_site_engine
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/your-org/rails_site_engine
+  source_code_uri: https://github.com/your-org/rails_site_engine
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Reusable Rails engine for business sites.
+test_files: []