site_settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 559fcd3fc3894bbef8aaa9c7d87d6dbd8fcd78c28eca87c8d760322c84dea82b
+  data.tar.gz: 03fb2dcd31dece52505f37e1e43e4ae9f67992b1bd84171bb5cec4773a2985ec
+SHA512:
+  metadata.gz: 5caccf1bf71d0d23bf514e773e20b28d377192d7a4576e980ff0f1b7d5868330c9620aa8c4a4eceb083beebd36b5d2f3bfb3884a9639e77c480ac443bb9bcecf
+  data.tar.gz: f6bf50e73b6d2b374ce0d97f1874fa730059b92fc0aa573481846f393dccbd62edebe314b3aefee6fd52a7f7f21b327964f81d25bc6304a0f67d9efc36766f8b

data/README.md

@@ -0,0 +1,28 @@
+# SiteSettings
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "site_settings"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install site_settings
+```
+
+## 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("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/site_settings/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/components/site_settings/form_component.html.erb

@@ -0,0 +1,17 @@
+<%= form_with url: settings_path, local: true, class: "primer-form" do |form| %>
+  <div class="d-flex flex-column flex-md-row flex-wrap gutter-md-spacious">
+    <% settings.each_slice(2) do |setting_pair| %>
+      <% setting_pair.each do |key, value| %>
+        <div class="col-md-6 mb-0">
+          <div class="form-group">
+            <%= form.label key, class: "form-label f5 text-bold d-block mb-1" %>
+            <%= form.text_field key, value: value, class: "form-control input-block width-full" %>
+          </div>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+  <div class="col-12 mt-3">
+    <%= form.submit "Save Settings", class: "btn btn-primary" %>
+  </div>
+<% end %>

data/app/components/site_settings/form_component.rb

@@ -0,0 +1,14 @@
+module SiteSettings
+  class FormComponent < ViewComponent::Base
+    def initialize(settings:, settings_path:)
+      @settings = settings
+      @settings_path = settings_path
+    end
+
+    attr_reader :settings, :settings_path
+
+    def render?
+      @settings.present?
+    end
+  end
+end

data/app/controllers/site_settings/application_controller.rb

@@ -0,0 +1,17 @@
+# site_settings/app/controllers/site_settings/application_controller.rb
+module SiteSettings
+  class ApplicationController < ::ApplicationController
+    layout :determine_layout
+
+    private
+
+    def determine_layout
+      # Use the main app's layout if it exists, otherwise fall back to the engine's layout
+      layout_exists_in_main_app? ? "application" : "site_settings/application"
+    end
+
+    def layout_exists_in_main_app?
+      File.exist?(Rails.root.join("app", "views", "layouts", "application.html.erb"))
+    end
+  end
+end

data/app/controllers/site_settings/settings_controller.rb

@@ -0,0 +1,14 @@
+module SiteSettings
+  class SettingsController < ApplicationController
+    def index
+      @settings = Manager.all
+    end
+
+    def update
+      params.except(:action, :controller).each do |key, value|
+        Manager.set(key, value)
+      end
+      redirect_to settings_path, notice: "Settings updated successfully."
+    end
+  end
+end

data/app/helpers/site_settings/application_helper.rb

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

data/app/jobs/site_settings/application_job.rb

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

data/app/mailers/site_settings/application_mailer.rb

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

data/app/models/site_settings/application_record.rb

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

data/app/models/site_settings/setting.rb

@@ -0,0 +1,15 @@
+module SiteSettings
+  class Setting < ApplicationRecord
+    validates :key, presence: true, uniqueness: true
+    validates :value, presence: true
+
+    def self.get(key)
+      find_by(key: key)&.value
+    end
+
+    def self.set(key, value)
+      setting = find_or_initialize_by(key: key)
+      setting.update(value: value)
+    end
+  end
+end

data/app/services/site_settings/manager.rb

@@ -0,0 +1,37 @@
+module SiteSettings
+  class Manager
+    DEFAULT_SETTINGS = {
+      app_name: "The Artisans Company",
+      app_short_name: "Artisans Company",
+      app_url: "artisans.company",
+      business_name: "Artisan Company Inc",
+      business_address: "2261 Market Street",
+      business_phone: "2099044448",
+      business_email: "hey@artisan.company",
+      description: "Build a different outcome.",
+      default_language: "EN",
+      default_country: "NG",
+      default_currency: "NGN",
+      meta_title: "Artisans Company",
+      meta_keywords: "venture studio, venture capital",
+      meta_description: "Build a different outcome.",
+      meta_author: "Artisans Company",
+      logo: "logo.png",
+      favicon: "favicon.ico",
+      default_timezone: "WAT",
+      app_version: "0.0.1"
+    }
+
+    def self.get(key)
+      Setting.get(key) || DEFAULT_SETTINGS[key.to_sym]
+    end
+
+    def self.set(key, value)
+      Setting.set(key, value)
+    end
+
+    def self.all
+      DEFAULT_SETTINGS.keys.map { |key| [ key, get(key) ] }.to_h
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Site settings</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+  <%= stylesheet_link_tag    "site_settings/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/site_settings/settings/index.html.erb

@@ -0,0 +1,14 @@
+<div class="Box">
+  <div class="Box-header d-flex flex-column flex-md-row">
+    <div class="col-12 col-md-8">
+      <h1 class="h2 mb-2 mb-md-0">Site Settings</h1>
+      <p class="color-fg-muted mb-0">Manage the default settings for your site.</p>
+    </div>
+    <div class="col-12 col-md-4 mt-3 mt-md-0 d-flex flex-items-center flex-justify-end">
+      <!-- You can add action buttons here if needed -->
+    </div>
+  </div>
+  <div class="Box-body">
+    <%= render(SiteSettings::FormComponent.new(settings: @settings, settings_path: site_settings.settings_path)) %>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,5 @@
+SiteSettings::Engine.routes.draw do
+  root "settings#index"
+  get "settings", to: "settings#index"
+  post "settings", to: "settings#update"
+end

data/db/migrate/20241009155632_create_site_settings_settings.rb

@@ -0,0 +1,11 @@
+class CreateSiteSettingsSettings < ActiveRecord::Migration[8.0]
+  def change
+    create_table :site_settings_settings do |t|
+      t.string :key, null: false
+      t.text :value
+
+      t.timestamps
+    end
+    add_index :site_settings_settings, :key, unique: true
+  end
+end

data/lib/site_settings/engine.rb

@@ -0,0 +1,8 @@
+module SiteSettings
+  class Engine < ::Rails::Engine
+    isolate_namespace SiteSettings
+
+    config.autoload_paths << root.join("app", "components")
+    config.view_component.preview_paths << root.join("spec", "components", "previews")
+  end
+end

data/lib/site_settings/version.rb

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

data/lib/site_settings.rb

@@ -0,0 +1,8 @@
+require "site_settings/version"
+require "site_settings/engine"
+
+module SiteSettings
+  class Engine < ::Rails::Engine
+    isolate_namespace SiteSettings
+  end
+end

data/lib/tasks/site_settings_tasks.rake

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: site_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- usman@artisans.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-11 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.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0.beta1
+description: Site Settings for Artisans
+email:
+- usman@artisans.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/stylesheets/site_settings/application.css
+- app/components/site_settings/form_component.html.erb
+- app/components/site_settings/form_component.rb
+- app/controllers/site_settings/application_controller.rb
+- app/controllers/site_settings/settings_controller.rb
+- app/helpers/site_settings/application_helper.rb
+- app/jobs/site_settings/application_job.rb
+- app/mailers/site_settings/application_mailer.rb
+- app/models/site_settings/application_record.rb
+- app/models/site_settings/setting.rb
+- app/services/site_settings/manager.rb
+- app/views/layouts/site_settings/application.html.erb
+- app/views/site_settings/settings/index.html.erb
+- config/routes.rb
+- db/migrate/20241009155632_create_site_settings_settings.rb
+- lib/site_settings.rb
+- lib/site_settings/engine.rb
+- lib/site_settings/version.rb
+- lib/tasks/site_settings_tasks.rake
+homepage: https://artisans.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://artisans.com
+  source_code_uri: https://github.com/artisanscompany/artisans-site-settings
+  changelog_uri: https://github.com/artisanscompany/artisans-site-settings/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.21
+signing_key:
+specification_version: 4
+summary: Site Settings for Artisans
+test_files: []