railsui 3.1.0

data/lib/railsui/theme_setup.rb

@@ -0,0 +1,336 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Railsui
+  module ThemeSetup
+    # gems
+    def install_gems
+      rails_command "generate railsui_icon:install"
+      rails_command "action_text:install"
+    end
+
+    # Assets
+    def copy_theme_javascript(theme)
+      say("Adding theme-specific stimulus.js controllers", :yellow)
+
+      # Define paths
+      source_path = "themes/#{theme}/javascript/controllers/railsui"
+      destination_path = "app/javascript/controllers/railsui"
+      index_js_path = Rails.root.join("app/javascript/controllers/index.js")
+      railsui_index_js_path = Rails.root.join("app/javascript/controllers/railsui/index.js")
+
+      # Empty the railsui folder
+      remove_dir destination_path
+      empty_directory destination_path
+
+      # Copy the directory
+      directory source_path, destination_path, force: true
+
+      # Get the list of controller files
+      controller_files = Dir.children(Rails.root.join(destination_path)).select { |f| f.end_with?("_controller.js") }
+      say("Controller files: 🗄️ #{controller_files}", :cyan)
+
+      # Generate import and register statements for railsui/index.js
+      railsui_index_content = controller_files.map do |file|
+        controller_name = File.basename(file, ".js").sub("_controller", "")
+        import_name = controller_name.camelize
+        registration_name = controller_name.dasherize
+        "import #{import_name}Controller from \"./#{File.basename(file, '.js')}\";\napplication.register(\"#{registration_name}\", #{import_name}Controller);"
+      end.join("\n")
+
+      js_content = <<-JAVASCRIPT.strip_heredoc
+        import { RailsuiClipboard, RailsuiCountUp, RailsuiCombobox, RailsuiDateRangePicker, RailsuiDropdown, RailsuiModal, RailsuiRange, RailsuiReadMore,RailsuiSelectAll, RailsuiTabs, RailsuiToast, RailsuiToggle, RailsuiTooltip } from 'railsui-stimulus'
+
+        application.register('railsui-clipboard', RailsuiClipboard)
+        application.register('railsui-count-up', RailsuiCountUp)
+        application.register('railsui-combobox', RailsuiCombobox)
+        application.register('railsui-date-range-picker', RailsuiDateRangePicker)
+        application.register('railsui-dropdown', RailsuiDropdown)
+        application.register('railsui-modal', RailsuiModal)
+        application.register('railsui-range', RailsuiRange)
+        application.register('railsui-read-more', RailsuiReadMore)
+        application.register('railsui-select-all', RailsuiSelectAll)
+        application.register('railsui-tabs', RailsuiTabs)
+        application.register('railsui-toast', RailsuiToast)
+        application.register('railsui-toggle', RailsuiToggle)
+        application.register('railsui-tooltip', RailsuiTooltip)
+      JAVASCRIPT
+
+      # Add js_content to railsui_index_content
+      railsui_index_content += "\n\n#{js_content}"
+
+      # Write the railsui/index.js file
+      create_file railsui_index_js_path, "import { application } from \"../application\"\n\n#{railsui_index_content}", force: true
+
+      # Read the existing main index.js content
+      index_js_content = File.exist?(index_js_path) ? File.read(index_js_path) : ""
+
+      # Remove old import statements for railsui controllers
+      new_index_js_content = index_js_content.gsub(/import .* from "\.\/railsui\/.*";\n*/, "")
+
+      # Add the new import statement for railsui/index.js if not already present
+      unless new_index_js_content.include?('import "./railsui"')
+        new_index_js_content += "import \"./railsui\"\n"
+      end
+
+      # Write the updated content back to main index.js
+      create_file index_js_path, new_index_js_content, force: true
+      say("Updated app/javascript/controllers/index.js and created app/javascript/controllers/railsui/index.js successfully.", :green)
+    end
+
+   def copy_theme_stylesheets(theme)
+      say("Copying theme-specific stylesheets", :yellow)
+
+      # Define paths
+      source_path = "themes/#{theme}/stylesheets/railsui"
+      destination_path = "app/assets/stylesheets/railsui"
+      application_css_path = Rails.root.join("app/assets/stylesheets/application.tailwind.css")
+
+      # Empty the destination directory before copying
+      FileUtils.rm_rf(Dir.glob("#{destination_path}/*"))
+
+      # Copy the directory and overwrite if theme is modified
+      directory source_path, destination_path, force: true
+
+      # Get the list of stylesheet files
+      stylesheet_files = Dir.children(Rails.root.join(destination_path)).select { |f| f.end_with?(".css") }
+      puts "Stylesheet files: 🗄️ #{stylesheet_files}"
+
+      # Generate import statements for stylesheets
+      import_statements = stylesheet_files.map do |file|
+        "@import \"../stylesheets/railsui/#{File.basename(file, '.css')}\";"
+      end.join("\n")
+
+      # Read the existing application.tailwind.css content
+      application_css_content = File.exist?(application_css_path) ? File.read(application_css_path) : ""
+
+      # Remove old @tailwind directives and import statements for tailwindcss and railsui stylesheets
+      cleaned_css_content = application_css_content
+      cleaned_css_content = cleaned_css_content.gsub(/@import "tailwindcss";\n*/, "")
+      cleaned_css_content = cleaned_css_content.gsub(/@import "\.\.\/stylesheets\/railsui\/.*";\n*/, "")
+
+      # Add the new import statements in the correct order
+      new_application_css_content = [
+        '@import "tailwindcss";',
+        cleaned_css_content.strip,  # Preserving existing content
+        import_statements
+      ].join("\n")
+
+      # Write the updated content back to application.tailwind.css
+      File.write(application_css_path, new_application_css_content)
+      say("Updated app/assets/stylesheets/application.tailwind.css successfully.", :green)
+    end
+
+    def install_theme_dependencies(theme)
+      say("Installing dependencies", :yellow)
+      add_yarn_packages(theme_dependencies(theme))
+    end
+
+
+    def remove_action_text_defaults
+      say "Remove default ActionText CSS"
+      # remove import from application.tailwind.css if present as we add it to another imported css file.
+
+      gsub_file "app/assets/stylesheets/application.tailwind.css", /@import 'actiontext.css';/, ""
+    end
+
+    def humanize_theme(theme)
+      theme.humanize
+    end
+
+    def theme_dependencies(theme)
+      case theme
+      when "hound"
+        ["@tailwindcss/typography", "apexcharts", "railsui-stimulus", "stimulus-use","tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
+      when "shepherd"
+        ["@tailwindcss/typography", "apexcharts", "flatpickr", "hotkeys-js", "photoswipe", "railsui-stimulus", "stimulus-use", "tippy.js", "tailwindcss@latest", "@tailwindcss/cli@latest"]
+      when "retriever"
+        ["@tailwindcss/typography", "apexcharts", "autoprefixer", "flatpickr","railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
+      when "setter"
+        ["@tailwindcss/typography", "railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
+      else
+        ["@tailwindcss/typography", "railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest" "tippy.js"]
+      end
+    end
+
+    def add_yarn_packages(packages)
+      run "yarn add #{packages.join(' ')} --latest"
+    end
+
+    # Mailers
+    def generate_sample_mailers(theme)
+      say "Adding Rails UI mailers", :yellow
+
+      rails_command "generate mailer Railsui minimal promotion transactional"
+
+combined_mailer_setup = <<-RUBY
+  layout "rui/railsui_mailer"
+  helper :application
+RUBY
+
+      insert_into_file Rails.root.join("app/mailers/railsui_mailer.rb").to_s, combined_mailer_setup, after: "class RailsuiMailer < ApplicationMailer\n"
+
+      copy_sample_mailers(theme)
+    end
+
+    def copy_sample_mailers(theme)
+      source_directory = "themes/#{theme}/mail/railsui_mailer"
+      destination_directory = Rails.root.join("app/views/railsui_mailer")
+      directory source_directory, destination_directory, force: true
+    end
+
+    def update_railsui_mailer_layout(theme)
+      source_file = Rails.root.join('app/views/layouts/rui/railsui_mailer.html.erb')
+      if File.exist?(source_file)
+        remove_file source_file
+      end
+
+      copy_file "themes/#{theme}/views/layouts/rui/railsui_mailer.html.erb", source_file, force: true
+    end
+
+    def update_application_helper
+content = <<-RUBY
+  def spacer(amount = 16)
+    render "rui/shared/email_spacer", amount: amount
+  end
+
+  def email_action(action, url, options={})
+    align = options[:align] ||= "left"
+    theme = options[:theme] ||= "primary"
+    fullwidth = options[:fullwidth] ||= false
+    render "rui/shared/email_action", align: align, theme: theme, action: action, url: url, fullwidth: fullwidth
+  end
+
+  def email_callout(&block)
+    render "rui/shared/email_callout", block: block
+  end
+RUBY
+
+      insert_into_file "#{Rails.root}/app/helpers/application_helper.rb", content, after: "module ApplicationHelper\n"
+    end
+
+    # Routes
+    def copy_railsui_routes
+      routes_file = "#{Rails.root}/config/routes.rb"
+      route_content = File.read(routes_file)
+
+      content = <<-RUBY
+  if Rails.env.development?
+     # Visit the start page for Rails UI any time at /railsui/start
+    mount Railsui::Engine, at: "/railsui"
+  end
+
+      RUBY
+
+      # Check if a root route already exists
+      unless route_content.match?(/^\s*root\s+/)
+        content += <<-RUBY
+  # Inherits from Railsui::PageController#index
+  # To override, add your own page#index view or change to a new root
+  root action: :index, controller: "railsui/default"
+        RUBY
+      end
+
+      insert_into_file routes_file, "\n#{content}\n", after: "Rails.application.routes.draw do\n", force: true
+    end
+
+    def copy_railsui_pages_routes
+      routes_file = Rails.root.join('config/routes.rb')
+
+      # Define the regex pattern for the `rui` namespace block
+      namespace_pattern = /^\s*namespace :rui do.*?end\n/m
+
+      # Generate new routes content based on the active pages
+      new_routes = Railsui::Pages.theme_pages.keys.map do |page|
+        "    get \"#{page}\", to: \"pages##{page}\""
+      end.join("\n")
+
+      # Define the routes block to be inserted within the namespace
+      routes_block = "\n  namespace :rui do\n#{new_routes}\n  end\n"
+
+      # Read the current content of the routes file
+      route_content = File.read(routes_file)
+
+      # Remove the existing `rui` namespace block if present
+      updated_content = route_content.gsub(namespace_pattern, '')
+
+      # Append the new routes block after the initial `Rails.application.routes.draw do` line
+      updated_content.sub!("Rails.application.routes.draw do\n", "Rails.application.routes.draw do\n#{routes_block}")
+
+      # Write the updated content back to the routes file
+      File.open(routes_file, 'w') { |file| file.write(updated_content) }
+    end
+
+    # Pages
+    def copy_railsui_page_controller(theme)
+      copy_file "controllers/pages_controller.rb", "app/controllers/rui/pages_controller.rb", force: true
+    end
+
+    def copy_railsui_pages(theme)
+      # Copy Pages
+      directory "themes/#{theme}/views/rui", "app/views/rui", force: true
+
+      # Copy layouts
+      directory "themes/#{theme}/views/layouts/rui", "app/views/layouts/rui", force: true
+    end
+
+    def copy_railsui_head(theme)
+      layout_file = "app/views/layouts/application.html.erb"
+      return unless File.exist?(layout_file)
+
+      unless File.read(layout_file).include?('<%= railsui_head %>')
+    content = <<-ERB
+    <%= railsui_head %>
+    ERB
+        insert_into_file layout_file, "\n#{content}", before: '</head>'
+      end
+    end
+
+    def copy_railsui_launcher(theme)
+      layout_file = "app/views/layouts/application.html.erb"
+      return unless File.exist?(layout_file)
+
+      unless File.read(layout_file).include?('<%= railsui_launcher if Rails.env.development? %>')
+    content = <<-ERB
+    <%= railsui_launcher if Rails.env.development? %>
+    ERB
+        insert_into_file layout_file, "\n#{content}", before: '</body>'
+      end
+    end
+
+    def copy_railsui_images(theme)
+      # Define paths
+      theme_images_dir = "themes/#{theme}/images/railsui"
+      target_images_dir = Rails.root.join("app/assets/images/railsui")
+
+      # Remove existing target directory
+      remove_directory(target_images_dir, "images")
+      # add new images based on theme passed
+      directory theme_images_dir, target_images_dir, force: true
+    end
+
+    private
+
+    def remove_directory(directory_path, thing)
+      if Dir.exist?(directory_path)
+        FileUtils.rm_rf(directory_path)
+        say("Removed existing #{thing} in #{directory_path}")
+      end
+    rescue => e
+      say("Error removing directory #{directory_path}: #{e.message}", :red)
+      raise e
+    end
+
+    def remove_route(file, page)
+      # Read the current content of the routes file
+      route_content = File.read(file)
+
+      # Remove route associated with railsui/pages#<page>
+      route_content.gsub!(/^\s*get\s+'#{page}',\s+to:\s+'railsui\/pages##{page}'\s*$/, '')
+
+      # Write the updated content back to the file
+      File.open(file, 'w') { |f| f.write(route_content) }
+    end
+  end
+end

data/lib/railsui/themes.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Railsui
+  module Themes
+    CONFIG_FILE = Railsui::Engine.root.join("config", "theme.yml")
+
+    def self.theme_classes
+      @theme_classes ||= load_theme_config
+    end
+
+     def self.body_classes(theme_name)
+      theme_classes[theme_name]['body_classes'] if theme_classes.key?(theme_name)
+    end
+
+    private
+
+    def self.load_theme_config
+      return {} unless File.exist?(CONFIG_FILE)
+      YAML.safe_load_file(CONFIG_FILE)
+    end
+  end
+end

data/lib/railsui/version.rb

@@ -0,0 +1,3 @@
+module Railsui
+  VERSION = "3.1.0"
+end

data/lib/railsui.rb

@@ -0,0 +1,60 @@
+require "railsui/version"
+require "railsui/engine"
+require 'railsui_icon'
+require 'meta-tags'
+
+module Railsui
+  autoload :Configuration, "railsui/configuration"
+  autoload :Pages, "railsui/pages"
+  autoload :Themes, "railsui/themes"
+  autoload :ThemeHelper, "railsui/theme_helper"
+  autoload :ThemeSetup, "railsui/theme_setup"
+
+  mattr_accessor :config
+  @@config = Railsui::Configuration.new
+
+  def self.clear
+    run_command "rails tmp:clear"
+  end
+
+  def self.restart
+    run_command "rails restart"
+  end
+
+  def self.bundle
+    run_command "bundle"
+  end
+
+  def self.build_css
+    if File.exist?("#{Rails.root}/package.json")
+      package_json = JSON.parse(File.read("#{Rails.root}/package.json"))
+      if package_json["scripts"] && package_json["scripts"]["build:css"]
+        run_command "yarn build:css"
+      else
+        puts "'build:css' script not found in package.json, skipping"
+      end
+    else
+      puts "package.json not found in the application root, skipping"
+    end
+  end
+
+  def self.theme_logo_url
+    theme = Railsui.config.theme
+    file_extension = if defined?(Rails.application) && Rails.application.config.action_mailer
+                     "png"
+                   else
+                     "svg"
+                   end
+    "https://f001.backblazeb2.com/file/railsui/themes/#{theme}/logo.#{file_extension}"
+  end
+
+  def self.asset_url
+    "https://f001.backblazeb2.com/file/railsui"
+  end
+
+  def self.run_command(command)
+    Bundler.with_original_env do
+      system command
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,6 @@
+namespace :railsui do
+  desc "Install Rails UI"
+  task :install do
+    system("#{RbConfig.ruby} ./bin/rails g railsui:install")
+  end
+end

data/lib/tasks/pages.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :railsui do
+  desc "Show Rails UI theme pages"
+  task :pages, [:theme] => :environment do |t, args|
+    # Default to Railsui.config.theme if no argument is provided
+    theme = args.theme || Railsui.config.theme
+
+    # Fetch the theme colors using Railsui::Colors
+    pages = Railsui.config.pages
+
+    puts "Page list for #{theme.humanize} theme:"
+    # Output the colors in YAML format
+    puts pages.to_yaml
+  end
+end

data/lib/tasks/stimulus.rake

@@ -0,0 +1,13 @@
+namespace :stimulus do
+  namespace :manifest do
+    # Clear :update task to skip default behavior from stimulus-rails gem
+    Rake::Task[:update].clear
+    desc "Overwrite the default manifest update behavior to do nothing"
+    task update: :environment do
+      alert = %(
+        Skipping stimulus:manifest:update to avoid overwriting index.js
+      ).strip
+      puts "\e[33m#{alert}\e[0m"
+    end
+  end
+end

data/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "railsui",
+  "version": "1.0.0",
+  "description": "A Rails engine with pre-built UI/UX using popular CSS frameworks",
+  "repository": "git@github.com:justalever/railsui.git",
+  "author": "Andy Leverenz <andy@justalever.com>",
+  "private": true,
+  "dependencies": {
+    "@hotwired/stimulus": "^3.2.1",
+    "debounce": "^1.2.1",
+    "deepmerge": "^4.3.1",
+    "esbuild": "^0.17.16",
+    "flatpickr": "^4.6.13",
+    "highlight.js": "^11.6.0",
+    "railsui-stimulus": "^1.0.8",
+    "stimulus-use": "^0.52.0",
+    "tippy.js": "^6.3.7",
+    "vanilla-colorful": "^0.7.2"
+  },
+  "scripts": {
+    "build:js": "esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds/railsui"
+  },
+  "devDependencies": {}
+}

data/postcss.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  plugins: {
+    "postcss-import": {},
+    "tailwindcss/nesting": {},
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}

data/tailwind.config.js

@@ -0,0 +1,91 @@
+const execSync = require("child_process").execSync
+const outputRailsUI = execSync("bundle show railsui", { encoding: "utf-8" })
+const rails_ui_path = outputRailsUI.trim() + "/**/*.rb"
+const rails_ui_template_path = outputRailsUI.trim() + "/**/*.html.erb"
+
+const defaultTheme = require("tailwindcss/defaultTheme")
+module.exports = {
+  //important: true,
+  content: [
+    "./app/helpers/**/*.rb",
+    "./app/views/**/*.html.erb",
+    "./app/components/**/*.html.erb",
+    "./app/javascript/**/*.{js,vue,jsx}",
+    "./lib/generators/templates/**/*.html.erb.tt",
+    "./config/initializers/railsui_icon.rb",
+    rails_ui_path,
+    rails_ui_template_path,
+  ],
+  theme: {
+    extend: {
+      fontFamily: {
+        rui: ["Inter", ...defaultTheme.fontFamily.sans],
+        mono: ["Fira Code", "monospace"],
+      },
+      colors: {
+        salmon: {
+          500: "#FA8072",
+        },
+        rails: {
+          500: "#D30001",
+          600: "#9b0203",
+          700: "#800001",
+        },
+        primary: {
+          50: "rgb(var(--primary-50) / <alpha-value>)",
+          100: "rgb(var(--primary-100) / <alpha-value>)",
+          200: "rgb(var(--primary-200) / <alpha-value>)",
+          300: "rgb(var(--primary-300) / <alpha-value>)",
+          400: "rgb(var(--primary-400) / <alpha-value>)",
+          500: "rgb(var(--primary-500) / <alpha-value>)",
+          600: "rgb(var(--primary-600) / <alpha-value>)",
+          700: "rgb(var(--primary-700) / <alpha-value>)",
+          800: "rgb(var(--primary-800) / <alpha-value>)",
+          900: "rgb(var(--primary-900) / <alpha-value>)",
+          950: "rgb(var(--primary-950) / <alpha-value>)",
+        },
+        secondary: {
+          50: "rgb(var(--secondary-50) / <alpha-value>)",
+          100: "rgb(var(--secondary-100) / <alpha-value>)",
+          200: "rgb(var(--secondary-200) / <alpha-value>)",
+          300: "rgb(var(--secondary-300) / <alpha-value>)",
+          400: "rgb(var(--secondary-400) / <alpha-value>)",
+          500: "rgb(var(--secondary-500) / <alpha-value>)",
+          600: "rgb(var(--secondary-600) / <alpha-value>)",
+          700: "rgb(var(--secondary-700) / <alpha-value>)",
+          800: "rgb(var(--secondary-800) / <alpha-value>)",
+          900: "rgb(var(--secondary-900) / <alpha-value>)",
+          950: "rgb(var(--secondary-950) / <alpha-value>)",
+        },
+      },
+      animation: {
+        "fade-in": "fade-in 0.3s ease-in-out",
+        "toast-from-right":
+          "toast-from-right 0.5s cubic-bezier(0.68, -0.55, 0.27, 1.55)",
+        "toast-from-left":
+          "toast-from-left 0.5s cubic-bezier(0.68, -0.55, 0.27, 1.55)",
+      },
+
+      keyframes: {
+        "fade-in": {
+          "0%": { opacity: "0%" },
+          "100%": { opacity: "100%" },
+        },
+        "toast-from-right": {
+          "0%": { transform: "translateX(50%)", opacity: "0%" },
+          "100%": { transform: "translateX(0)", opacity: "100%" },
+        },
+        "toast-from-left": {
+          "0%": { transform: "translateX(-50%)", opacity: "0%" },
+          "100%": { transform: "translateX(0)", opacity: "100%" },
+        },
+      },
+    },
+  },
+  plugins: [
+    require("@tailwindcss/typography"),
+    require("@tailwindcss/forms"),
+    require("@tailwindcss/aspect-ratio"),
+    require("tailwind-scrollbar"),
+  ],
+}