kern 0.5.0

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

@@ -0,0 +1,48 @@
+require "generators/kern/helpers"
+
+module Kern
+  class InstallGenerator < Rails::Generators::Base
+    include Helpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :skip_migrations, type: :boolean, default: false
+
+    def copy_migrations
+      return if options[:skip_migrations]
+
+      rails_command "railties:install:migrations FROM=kern", inline: true
+    end
+
+    def inject_authentication
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        "  include Authentication\n"
+      end
+    end
+
+    def inject_kern_layout
+      inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
+        "  layout \"kern/application\"\n"
+      end
+    end
+
+    def copy_urls_configuration
+      template "configurations/urls.yml", "config/configurations/urls.yml"
+      template "configurations/README.md", "config/configurations/README.md"
+    end
+
+    def enable_bcrypt
+      if File.read(File.expand_path("Gemfile", destination_root)).include?('gem "bcrypt"')
+        uncomment_lines "Gemfile", /gem "bcrypt"/
+
+        bundle_command("install --quiet")
+      else
+        bundle_command("add bcrypt", {}, quiet: true)
+      end
+    end
+
+    def mount_engine
+      route 'mount Kern::Engine => "/"'
+    end
+  end
+end

data/lib/generators/kern/install/templates/configurations/README.md

@@ -0,0 +1,33 @@
+# Configuration
+
+Load all YAML files from `config/configurations/` into `Config` constants.
+
+
+## Usage
+
+Each YAML file in this directory becomes a `Config` constant. For example:
+- `config/configurations/urls.yml` becomes `Config::Urls`
+- `config/configurations/features.yml` becomes `Config::Features`
+
+Access values using dot notation:
+```ruby
+Config::Urls.app
+Config::Urls.site
+```
+
+
+## Environment variables
+
+You can override any configuration value using environment variables. For example, in `urls.yml`:
+```yaml
+shared:
+  app: <%= ENV.fetch("URLS_APP", "http://localhost:3000") %>
+  site: <%= ENV.fetch("URLS_SITE", "https://example.com") %>
+```
+
+The `URLS_` prefix is a recommended convention but not required. Use any naming convention that works for your application.
+
+
+## How it works
+
+Under the hood, this uses `Rails.application.config_for` which automatically handles environment-specific configurations and ERB processing.

data/lib/generators/kern/install/templates/configurations/urls.yml

@@ -0,0 +1,9 @@
+shared:
+  app: <%= ENV.fetch("URLS_APP", "http://localhost:3000") %>
+  site: <%= ENV.fetch("URLS_SITE", "https://saas.railsdesigner.com") %>
+  docs: <%= ENV.fetch("URLS_DOCS", "https://example.com/docs/") %>
+  terms: <%= ENV.fetch("URLS_TERMS", "https://example.com/legal/terms/") %>
+  privacy: <%= ENV.fetch("URLS_PRIVACY", "https://example.com/legal/privacy/") %>
+
+production:
+  app: <%= ENV.fetch("URLS_APP", "https://app.example.com") %>

data/lib/generators/kern/views/USAGE

@@ -0,0 +1,22 @@
+Description:
+  Generates Kern view templates in your application.
+
+Example:
+  rails generate kern:views
+
+  This will generate all available Kern views.
+
+  rails generate kern:views sessions
+
+  This will generate only the sessions views.
+
+  rails generate kern:views sessions passwords
+
+  This will generate sessions and passwords views.
+
+Available views:
+  passwords   Password reset views
+  sessions    Sign in views
+  settings    User settings views
+  signups     Sign up views
+  layouts     Kern layout files

data/lib/generators/kern/views/views_generator.rb

@@ -0,0 +1,42 @@
+module Kern
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../../../app/views", __FILE__)
+
+    AVAILABLE_VIEWS = %w[passwords sessions settings signups layouts]
+
+    argument :views, type: :array, default: [], banner: "view view", desc: "Select specific view directories to generate (#{AVAILABLE_VIEWS.join(", ")}). Leave empty for all."
+
+    def copy_views
+      views_to_generate.map(&:inquiry).each do |view|
+        verify_view_exists!(view)
+
+        if view.layouts?
+          generate_layouts
+        else
+          directory "kern/#{view}", "app/views/#{view}", recursive: true
+        end
+      end
+    end
+
+    private
+
+    def views_to_generate
+      views.any? ? views : AVAILABLE_VIEWS
+    end
+
+    def verify_view_exists!(view)
+      return if AVAILABLE_VIEWS.include?(view)
+
+      say "View `#{view}` not found. Available views: #{AVAILABLE_VIEWS.join(", ")}", :red
+
+      exit(1)
+    end
+
+    def generate_layouts
+      template "layouts/kern/application.html.erb.tt", "app/views/layouts/application.html.erb"
+      copy_file "layouts/kern/application/_navigation.html.erb", "app/views/layouts/application/_navigation.html.erb"
+
+      copy_file "layouts/kern/auth.html.erb", "app/views/layouts/auth.html.erb"
+    end
+  end
+end

data/lib/kern/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Kern
+  module Config
+    module_function
+
+    def load!
+      configurations_path = Rails.root.join("config", "configurations")
+
+      return unless File.directory?(configurations_path)
+
+      Dir.glob(configurations_path.join("*.yml")).each do |path|
+        file_name = File.basename(path, ".yml")
+
+        ::Config.const_set(
+          file_name.camelize,
+          Rails.application.config_for("configurations/#{file_name}")
+        )
+      end
+    end
+  end
+end
+
+module Config
+end

data/lib/kern/engine.rb

@@ -0,0 +1,17 @@
+module Kern
+  class Engine < ::Rails::Engine
+    isolate_namespace Kern
+
+    initializer "kern.load_config", before: :load_config_initializers do
+      require "kern/config"
+
+      Kern::Config.load!
+    end
+
+    initializer "kern.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        helper Kern::Engine.helpers
+      end
+    end
+  end
+end

data/lib/kern/form_builder/input.rb

@@ -0,0 +1,100 @@
+module Kern
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    module Input
+      if Gem.loaded_specs.key?("rails_icons")
+        require "rails_icons"
+
+        include RailsIcons::Helpers::IconHelper
+      end
+
+      FIELD_TYPES = {
+        string: :text_field,
+        email: :email_field,
+        password: :password_field,
+        url: :url_field,
+        text: :text_area,
+        integer: :number_field,
+        float: :number_field,
+        decimal: :number_field,
+        datetime: :datetime_local_field,
+        date: :date_field
+      }.freeze
+
+      def input(attribute, options = {})
+        label_suffix = options.delete(:label_suffix)
+        hint = options.delete(:hint)
+
+        @template.content_tag(:div, data: {slot: "field"}, class: options[:field_css] || field_css) do
+          label_html = label(attribute, options)
+
+          @template.safe_join([
+            (if label_suffix
+               @template.content_tag(:div, class: "flex items-center justify-between") do
+                 @template.safe_join([label_html, @template.content_tag(:span, label_suffix.html_safe, class: "text-xs font-medium text-gray-500")].compact)
+               end
+             end),
+
+            (label_html unless label_suffix),
+
+            input_field(attribute, options),
+
+            (@template.content_tag(:p, hint.html_safe, class: "flex items-center gap-x-1 mt-0.5 px-0.5 text-xs font-light text-gray-500") if hint)
+          ].compact)
+        end
+      end
+
+      def label(attribute, text = nil, options = {}, &block)
+        text, options = nil, text if text.is_a?(Hash)
+        label_options = options[:label] || {}
+        field_errors = @object&.errors&.where(attribute)
+
+        label_options[:class] = class_names("flex items-center gap-1 text-sm font-medium", {"text-gray-700": field_errors&.none?, "text-red-600": field_errors&.any?})
+        label_text = text || I18n.t("labels.#{attribute}", default: attribute.to_s.humanize)
+
+        super(attribute, label_options) do
+          safe_join([
+            begin
+              icon("warning-circle", class: "size-3.5 scale-100 transition ml-0 ease-in-out duration-300 starting:ml-3.5 starting:scale-0") if field_errors&.any?
+            rescue
+              nil
+            end,
+            label_text.html_safe? ? label_text : label_text.to_s
+          ].compact)
+        end
+      end
+
+      def toggle_wrapper(&block)
+        content_tag(:div, yield, data: {slot: "toggle-field"}, class: "flex items-start gap-x-2 [&>input]:mt-[0.15em]")
+      end
+
+      def toggle_label(method, text)
+        label(method, text.html_safe, class: toggle_label_css)
+      end
+
+      private
+
+      def input_field(attribute, options)
+        return select(attribute, options[:collection], {}, options.except(:as, :label, :collection)) if options[:collection]
+
+        send(FIELD_TYPES.fetch(options[:as] || type_for(attribute), :text_field), attribute, options.except(:as, :label, :collection))
+      end
+
+      def type_for(attribute)
+        return :email if attribute.to_s.end_with?("email")
+        return :password if attribute.to_s.include?("password")
+        return :url if attribute.match?(/url|website|site/)
+        return :string unless valid?(attribute)
+
+        @object.type_for_attribute(attribute.to_s).type
+      rescue NoMethodError
+        :string
+      end
+
+      def valid?(attribute)
+        @object.respond_to?(attribute) &&
+          @object.respond_to?(:has_attribute?) &&
+          @object.has_attribute?(attribute)
+      end
+    end
+  end
+end

data/lib/kern/form_builder/styles.rb

@@ -0,0 +1,53 @@
+module Kern
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    module Styles
+      def field_css
+        "w-full [&[data-slot='field']+[data-slot='field']]:mt-4"
+      end
+
+      def input_css
+        <<~CSS
+          w-full px-2.5 py-1.5
+          text-sm font-normal text-gray-900
+          bg-white
+          border-0 ring ring-gray-200/80 rounded-sm
+          hover:ring-gray-300
+          disabled:opacity-50 disabled:hover:ring-gray-200/80
+          outline-none
+          focus:bg-white focus:ring focus:ring-brand-300
+        CSS
+      end
+
+      def file_field_css
+        <<~CSS
+          w-full py-1.5
+          text-sm font-normal text-gray-600
+          disabled:opacity-50
+          file:mr-2 file:py-1 file:px-4
+          file:text-xs file:font-medium
+          file:bg-gray-100 file:text-gray-700
+          file:rounded-full file:border-0
+          hover:file:bg-gray-200
+          focus:outline-hidden focus:ring-0
+        CSS
+      end
+
+      def toggle_input_css
+        <<~CSS
+          peer
+          accent-brand-500
+          border border-gray-100
+          rounded-md
+          focus:outline-hidden focus:ring focus:ring-offset-1 focus:ring-gray-300
+          disabled:opacity-25 disabled:cursor-not-allowed
+        CSS
+      end
+
+      def toggle_label_css
+        <<~CSS
+          block text-sm font-normal text-gray-800 peer-disabled:opacity-50 peer-disabled:cursor-not-allowed
+        CSS
+      end
+    end
+  end
+end

data/lib/kern/form_builder.rb

@@ -0,0 +1,101 @@
+require "kern/form_builder/styles"
+require "kern/form_builder/input"
+
+module Kern
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    include ActionView::Helpers::TagHelper
+
+    include Input
+    include Styles
+
+    %w[
+      text_field email_field password_field
+      search_field telephone_field url_field number_field
+      date_field time_field datetime_field datetime_local_field month_field week_field
+    ].each do |field_type|
+      define_method(field_type) do |method, options = {}|
+        field_classes(options, input_css)
+
+        super(method, options)
+      end
+    end
+    alias_method :phone_field, :telephone_field
+
+    def text_area(method, options = {})
+      field_classes(options, input_css)
+
+      super
+    end
+    alias_method :textarea, :text_area
+
+    def check_box(method, options = {}, checked_value = "1", unchecked_value = "0", &block)
+      field_classes(options, toggle_input_css)
+      label_text = block ? @template.capture(&block) : method.to_s.humanize
+
+      toggle_wrapper do
+        super(method, options, checked_value, unchecked_value) + label(method, label_text)
+      end
+    end
+    alias_method :checkbox, :check_box
+
+    def radio_button(method, tag_value, options = {}, &block)
+      field_classes(options, toggle_input_css)
+      label_text = block ? @template.capture(&block) : tag_value.to_s.humanize
+
+      toggle_wrapper do
+        super(method, tag_value, options) + toggle_label("#{method}_#{tag_value}", label_text)
+      end
+    end
+
+    def select(method, choices = nil, options = {}, html_options = {})
+      field_classes(html_options, input_css)
+
+      super
+    end
+
+    def file_field(method, options = {})
+      field_classes(options, file_field_css)
+
+      super
+    end
+
+    def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
+      field_classes(html_options, input_css)
+      super
+    end
+
+    def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
+      field_classes(html_options, input_css)
+
+      super
+    end
+
+    def collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {})
+      field_classes(html_options, toggle_input_css, "rounded-sm")
+
+      toggle_wrapper do
+        @template.collection_check_boxes(object_name, method, collection, value_method, text_method, options, html_options) do |template|
+          template.check_box(class: html_options[:class]) + toggle_label("#{method}_#{template.value.to_s.underscore}", template.text)
+        end
+      end
+    end
+    alias_method :collection_checkboxes, :collection_check_boxes
+
+    def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {})
+      field_classes(html_options, toggle_input_css)
+
+      toggle_wrapper do
+        @template.collection_radio_buttons(object_name, method, collection, value_method, text_method, options, html_options) do |template|
+          template.radio_button(class: html_options[:class]) + toggle_label("#{method}_#{template.value.to_s.underscore}", template.text)
+        end
+      end
+    end
+
+    private
+
+    def field_classes(options, base_css, *additional_classes)
+      options[:class] = options[:class].presence || class_names(base_css, *additional_classes, options[:additional_class])
+      options.delete(:additional_class)
+    end
+  end
+end

data/lib/kern/version.rb

@@ -0,0 +1,3 @@
+module Kern
+  VERSION = "0.5.0"
+end

data/lib/kern.rb

@@ -0,0 +1,7 @@
+require "kern/version"
+require "kern/engine"
+require "kern/form_builder"
+require "sluggable"
+
+module Kern
+end

data/lib/sluggable.rb

@@ -0,0 +1,66 @@
+# Usage
+#
+# Migration:
+# add_column :<table_name>, :slug, null: false
+# add_index :<table_name>, :slug, unique: true, # or:
+# add_index :<table_name>, [:slug, :workspace_id], unique: true
+#
+# In app/models/<name>.rb
+# include Sluggable
+#
+# In app/controller/model_name_plural_controller.rb
+# `<model_name>.sluggble.find(params[:id])`
+#
+module Sluggable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def create_slug(from:)
+      @slug_source = from
+    end
+  end
+
+  included do
+    before_create :set_slug
+
+    scope :sluggable, -> { Sluggable::Finder.new(self) }
+  end
+
+  def to_key = [slug]
+
+  def to_param = slug
+
+  private
+
+  def set_slug
+    return if slug
+
+    slug = if slug_source && send(slug_source).present?
+      send(slug_source).parameterize
+    else
+      random_slug
+    end
+
+    self.slug = slug
+  end
+
+  def random_slug
+    loop do
+      slug = SecureRandom.hex(4)
+
+      return slug unless self.class.name.constantize.where(slug: slug).exists?
+    end
+  end
+
+  def slug_source = self.class.instance_variable_get(:@slug_source)
+end
+
+class Sluggable::Finder
+  def initialize(scope)
+    @scope = scope
+  end
+
+  def find(slug) = @scope.find_by(slug: slug)
+
+  def find!(slug) = @scope.find_by!(slug: slug)
+end

data/lib/tasks/kern_tasks.rake

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

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: kern
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Rails Designer
+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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+description: 'A Rails engine that handles the SaaS essentials: authentication, team
+  invitations, subscription/billing, and common partials. Skip the boilerplate and
+  start shipping the actual product. Launch faster.'
+email: devs@railsdeigner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/assets/builds/tailwind.css
+- app/controllers/concerns/authentication.rb
+- app/controllers/concerns/authentication.rb.tt
+- app/controllers/kern/application_controller.rb
+- app/controllers/kern/pages_controller.rb
+- app/controllers/kern/passwords_controller.rb
+- app/controllers/kern/sessions_controller.rb
+- app/controllers/kern/settings/users_controller.rb
+- app/controllers/kern/settings_controller.rb
+- app/controllers/kern/signups_controller.rb
+- app/controllers/kern/signups_controller.rb.tt
+- app/helpers/kern/component_helper.rb
+- app/helpers/kern/turbo_stream_actions_helper.rb
+- app/mailers/kern/application_mailer.rb
+- app/mailers/kern/passwords_mailer.rb
+- app/models/actor.rb
+- app/models/application_form.rb
+- app/models/current.rb
+- app/models/member.rb
+- app/models/member/acting.rb
+- app/models/member/setup.rb
+- app/models/role.rb
+- app/models/session.rb
+- app/models/signup.rb
+- app/models/user.rb
+- app/models/user/workspace_member.rb
+- app/models/workspace.rb
+- app/models/workspace/members.rb
+- app/models/workspace/setup.rb
+- app/views/components/_container.html.erb
+- app/views/components/_flash.html.erb
+- app/views/components/_heading.html.erb
+- app/views/components/flash/_message.html.erb
+- app/views/kern/pages/welcome.html.erb
+- app/views/kern/passwords/edit.html.erb
+- app/views/kern/passwords/new.html.erb
+- app/views/kern/passwords_mailer/reset.html.erb
+- app/views/kern/passwords_mailer/reset.html.erb.tt
+- app/views/kern/passwords_mailer/reset.text.erb
+- app/views/kern/passwords_mailer/reset.text.erb.tt
+- app/views/kern/sessions/new.html.erb
+- app/views/kern/settings/_cards.html.erb
+- app/views/kern/settings/show.html.erb
+- app/views/kern/settings/users/show.html.erb
+- app/views/kern/signups/new.html.erb
+- app/views/layouts/kern/application.html.erb
+- app/views/layouts/kern/application.html.erb.tt
+- app/views/layouts/kern/application/_navigation.html.erb
+- app/views/layouts/kern/auth.html.erb
+- bin/dev
+- bin/rails
+- bin/release
+- config/routes.rb
+- db/migrate/20250101000001_create_users.rb
+- db/migrate/20250101000002_create_sessions.rb
+- db/migrate/20250101000003_create_workspaces.rb
+- db/migrate/20250101000004_create_members.rb
+- db/migrate/20250101000005_create_roles.rb
+- db/migrate/20250101000006_create_actors.rb
+- kern.gemspec
+- lib/generators/kern/feature/USAGE
+- lib/generators/kern/feature/feature_generator.rb
+- lib/generators/kern/helpers.rb
+- lib/generators/kern/install/USAGE
+- lib/generators/kern/install/install_generator.rb
+- lib/generators/kern/install/templates/configurations/README.md
+- lib/generators/kern/install/templates/configurations/urls.yml
+- lib/generators/kern/views/USAGE
+- lib/generators/kern/views/views_generator.rb
+- lib/kern.rb
+- lib/kern/config.rb
+- lib/kern/engine.rb
+- lib/kern/form_builder.rb
+- lib/kern/form_builder/input.rb
+- lib/kern/form_builder/styles.rb
+- lib/kern/version.rb
+- lib/sluggable.rb
+- lib/tasks/kern_tasks.rake
+homepage: https://saas.railsdesigner.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://saas.railsdesigner.com/
+  source_code_uri: https://github.com/Rails-Designer/kern/
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.1
+specification_version: 4
+summary: Rails engine with auth, billing, and common components for SaaS apps
+test_files: []