bravura_template_base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ffbbc8ddafcfc768e0f7931aa3836319dd8b8766c10cc67f12221e95e338ded
+  data.tar.gz: 6d81f3eb5d57241104d7978682b0a61d94c8bd640565b97d067adb9070508c0b
+SHA512:
+  metadata.gz: cbc602c95cf0e9d90aec2192bf197db082e56d5d39276d26ee2d9e140da42b40515ef8e629fad7ce83450c66ebb86080a867d8febfdc73841fe82050c5f4d48d
+  data.tar.gz: 7a7a833d6b477d24222c1c162803e26b6b1b8d7d7dfeeff666cea844f04dcd4b2a2b4d4bb0e950a0bc9d16bf8cc13eb88ecdafc7cd5e62544dd626761e649fb5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright captproton
+
+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,60 @@
+# BravuraTemplateBase
+What the `bravura_template_base` gem does:
+
+1. Template Management:
+   - The gem provides a system for managing and loading different blog templates.
+   - It defines a set of available templates and a default template.
+
+2. Dynamic Template Loading:
+   - The `load_template` method dynamically loads a template based on the account's settings.
+   - It handles the loading of template-specific assets (JavaScript and CSS) into the Rails asset pipeline.
+
+3. Fallback Mechanism:
+   - If a specified template doesn't exist, it falls back to the default template.
+   - It logs a warning when falling back to the default template.
+
+4. Error Handling:
+   - It raises an error if the default template is not found.
+   - It validates that the account object has the necessary attributes.
+
+5. Flexible Configuration:
+   - The gem allows for different templates to be defined and used without modifying the main application code.
+
+6. Asset Management:
+   - It adds template-specific asset paths to the Rails asset pipeline.
+   - It adds template-specific CSS to the precompile list.
+
+In essence, this gem serves as a foundation for a multi-template blog system. It allows different accounts to use different blog templates, all managed through a central system. The main benefits are:
+
+1. Modularity: Templates can be developed and managed separately from the main application.
+2. Flexibility: Accounts can easily switch between different templates.
+3. Consistency: It provides a standard way to handle different blog templates across the application.
+4. Error Handling: It gracefully handles cases where a template might be missing or incorrectly specified.
+
+The gem is designed to work within a larger Rails application, where it can be used to dynamically load and manage different blog templates based on account settings. It's a key component in creating a flexible, multi-tenant blogging platform where different users or accounts can have different looking blogs all running on the same underlying system.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bravura_template_base"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bravura_template_base
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/bravura_template_base_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/bravura_template_base .css

data/app/assets/stylesheets/bravura_template_base/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/bravura_template_base/application_controller.rb

@@ -0,0 +1,4 @@
+module BravuraTemplateBase
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/bravura_template_base/application_helper.rb

@@ -0,0 +1,4 @@
+module BravuraTemplateBase
+  module ApplicationHelper
+  end
+end

data/app/jobs/bravura_template_base/application_job.rb

@@ -0,0 +1,4 @@
+module BravuraTemplateBase
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/bravura_template_base/application_mailer.rb

@@ -0,0 +1,6 @@
+module BravuraTemplateBase
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/bravura_template_base/application_record.rb

@@ -0,0 +1,5 @@
+module BravuraTemplateBase
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/bravura_template_base/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Bravura template base</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "bravura_template_base/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+BravuraTemplateBase::Engine.routes.draw do
+end

data/lib/bravura_template_base/engine.rb

@@ -0,0 +1,11 @@
+module BravuraTemplateBase
+  class Engine < ::Rails::Engine
+    isolate_namespace BravuraTemplateBase
+
+    initializer "bravura_template_base.assets" do |app|
+      BravuraTemplateBase::AVAILABLE_TEMPLATES.each do |template_name|
+        BravuraTemplateBase.load_template(app, template_name)
+      end
+    end
+  end
+end

data/lib/bravura_template_base/version.rb

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

data/lib/bravura_template_base.rb

@@ -0,0 +1,28 @@
+module BravuraTemplateBase
+  AVAILABLE_TEMPLATES = [ "bravura_template_normal", "bravura_template_product_updates" ]
+  DEFAULT_TEMPLATE = "bravura_template_normal"
+
+  def self.load_template(app, account)
+    raise ArgumentError, "account must respond to :settings and :id" unless account.respond_to?(:settings) && account.respond_to?(:id)
+
+    template_name = account.settings.design.blog_template_gem
+
+    begin
+      engine_class = "#{template_name.camelize}::Engine".constantize
+      app.config.assets.paths << engine_class.root.join("app/javascript")
+      app.config.assets.precompile << "#{template_name}/application.css"
+    rescue NameError => e
+      logger.warn "Template #{template_name} not found for account #{account.id}, falling back to default"
+      if template_name != DEFAULT_TEMPLATE
+        account.settings.design.blog_template_gem = DEFAULT_TEMPLATE
+        load_template(app, account)
+      else
+        raise "Default template #{DEFAULT_TEMPLATE} not found: #{e.message}"
+      end
+    end
+  end
+
+  def self.logger
+    Rails.logger || Logger.new(STDOUT)
+  end
+end

data/lib/tasks/bravura_template_base_tasks.rake

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: bravura_template_base
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Tanner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.3
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+description: This gem is designed to work within a larger Rails application, where
+  it can be used to dynamically load and manage different blog templates based on
+  account settings. It's a key component in creating a flexible, multi-tenant blogging
+  platform where different users or accounts can have different looking blogs all
+  running on the same underlying system.
+email:
+- carl@wdwhub.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bravura_template_base_manifest.js
+- app/assets/stylesheets/bravura_template_base/application.css
+- app/controllers/bravura_template_base/application_controller.rb
+- app/helpers/bravura_template_base/application_helper.rb
+- app/jobs/bravura_template_base/application_job.rb
+- app/mailers/bravura_template_base/application_mailer.rb
+- app/models/bravura_template_base/application_record.rb
+- app/views/layouts/bravura_template_base/application.html.erb
+- config/routes.rb
+- lib/bravura_template_base.rb
+- lib/bravura_template_base/engine.rb
+- lib/bravura_template_base/version.rb
+- lib/tasks/bravura_template_base_tasks.rake
+homepage: https://github.com/yourusername/bravura_template_base
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/bravura_template_base
+  source_code_uri: https://github.com/yourusername/bravura_template_base
+  changelog_uri: https://github.com/yourusername/bravura_template_base/blob/main/CHANGELOG.md
+post_install_message:
+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.5.6
+signing_key:
+specification_version: 4
+summary: Base gem for Bravura blog templates
+test_files: []