swage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1eb99b2b002dccde7c9d242952b711e4d0fc2432b8c46c792e529b22d83e3486
+  data.tar.gz: f4eabce375c4ffe258ee251297915ba55916eeafbac9e120b1929e5c87701ae4
+SHA512:
+  metadata.gz: d409d145064d845053c9a91db02fd017877c6d745918f95ce5d59627b4ec588ce6cc6ef6414aa66050169384a10add1f694a9b20c992ac3639e62c6dd44985bf
+  data.tar.gz: 7f16fbe0f753870da630dfc455507bac3734204c0da4efc7fd420a170028ea7af8372227adf39962fdc0e2e0da8a0fbd655758c46834a72e14f3f23ced1cc24f

data/LICENSE.txt

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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,15 @@
+# Swage
+Basically a different implementation of [Superview](https://github.com/rubymonolith/superview), but with a few extra goodies and generators baked in. Use [Phlex](https://github.com/yippee-fun/phlex-rails/) for rendering views and [Superform](https://github.com/rubymonolith/superform/) for the form DSL and strong parameters. Uses [RubyUI](https://github.com/ruby-ui/ruby_ui) for the base UI components and [Phlexible](https://github.com/joelmoss/phlexible) to glue everything together (along with a lot of monkeypatching).
+
+## Installation
+Simply run `rails g swage:install`, and all of the necessary components will be generated. Please not this might take a while to run.
+
+## Usage
+By default Swage will hook into the rails scaffold engine. However, it is a drop-in replacement for the erb scaffold_controller, meaning it can be used in the exact same way.
+
+## Modification
+If you wish to modify the generators, use `rails g swage:generators` to generate all of the scaffold and install generators/templates.
+
+
+## TODO
+* Consolidate the Tailwind classes down for the non-RubyUI components

data/lib/generators/swage/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Replaces the default rails scaffold controller to generate phlex views
+
+Example:
+    bin/rails generate flex Thing

data/lib/generators/swage/base_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Swage::Generators
+  class BaseGenerator < ::Rails::Generators::NamedBase
+    include Rails::Generators::ResourceHelpers
+    def self.set_source_root(file_name, dir)
+      if File.exist?(Rails.root.join("lib/generators/swage", file_name))
+        source_root Rails.root.join("lib/generators/swage/templates")
+      else
+        source_root File.expand_path("templates", dir)
+      end
+    end
+  end
+end

data/lib/generators/swage/generators/generators_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Swage::Generators
+  class GeneratorsGenerator < ::Rails::Generators::Base
+    source_root File.expand_path __dir__
+
+    # there's probably a better way to do this, but this should probably work well enough?
+    def create_scaffold_files
+      base = File.join "generators", "swage", "scaffold"
+
+      Dir.chdir("#{source_paths.first}/../scaffold") do
+        lib File.join(base, "scaffold_generator.rb"), File.open("scaffold_generator.rb", "r").read
+      end
+
+      Dir.chdir("#{source_paths.first}/../scaffold/templates") do
+        Dir.glob("*.rb.tt").each do |template|
+          lib File.join(base, "templates", template), File.open(template, "r").read
+        end
+      end
+    end
+
+    def create_install_files
+      base = File.join "generators", "swage", "install"
+      Dir.chdir("#{source_paths.first}/../install") do
+        lib File.join(base, "install_generator.rb"), File.open("install_generator.rb", "r").read
+      end
+
+      Dir.chdir("#{source_paths.first}/../install/templates") do
+        Dir.glob("*.rb.tt").each do |template|
+          lib File.join(base, "templates", template), File.open(template, "r").read
+        end
+      end
+    end
+
+    def create_base_generator
+      base = File.join "generators", "swage"
+      Dir.chdir("#{source_paths.first}/..") do
+        lib File.join(base, "base_generator.rb"), File.open("base_generator.rb", "r").read
+      end
+    end
+  end
+end

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

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module Swage::Generators
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :engine, type: :boolean, default: false
+    class_option :override, type: :boolean, default: false
+
+    @name = nil
+
+    def check_for_engine
+      @engine = options["engine"] # set use instance variables because they look nicer
+
+      if probably_engine? && !@engine
+        if yes?("This appears to be an engine. do you wish to insatll swage as such?")
+          say "Installing in engine mode. Hint: use `rails g swage:install --engine`"
+          @engine = true
+        end
+      end
+    end
+
+    def check_for_override
+      if @engine
+        @override = options["override"]
+      else
+        @override = true
+      end
+    end
+
+    def check_for_js
+      return if @engine # engines don't have their own js ecosystem
+      unless using_importmap? || using_bun? || using_yarn? || using_npm? || using_pnpm?
+        if yes?("No javascript package manager was detected. Do you wish to exit now, or continue and install missing requirements manually?")
+          exit 0
+        end
+      end
+    end
+
+    def add_dependencies
+      deps = %W[ tailwindcss-rails phlex-rails phlexible superform ruby_ui ]
+      missing = []
+      deps.each do |d|
+        unless Gem.loaded_specs.has_key?(d)
+          say "missing #{d} in gemfile"
+          missing << d
+        end
+      end
+
+      if missing.any?
+        return if @engine && missing.length == 1 && missing[0] == "ruby_ui"
+        if yes?("would you like to automatically install the missing dependencies?")
+          add_source "https://rubygems.org" do
+            deps.each do |d|
+              gem d
+            end
+          end
+        else
+          exit 1
+        end
+      end
+
+      # because rails is silly and won't let you do stuff unless you have everything as a gem already
+      return if @engine && !@override
+      add_source "https://rubygems.org" do
+        gem "tailwindcss-rails"
+        gem "phlex"
+        gem "superform"
+        # gem "rogue"
+      end
+    end
+
+    def install_tailwind
+      if !@engine || (@engine && @override)
+        say "install tailwind"
+        execute_command "rake", "tailwindcss:install"
+      end
+    end
+
+    def install_phlex
+      return if @engine
+      say "install phlex"
+      generate "phlex:install"
+    end
+
+    def install_superform
+      return if @engine
+      say "install superform"
+      generate "superform:install"
+    end
+
+    def insatll_ruby_ui
+      if !@engine || (@engine && @override)
+        say "install rubyui"
+        generate "ruby_ui:install"
+        generate "ruby_ui:component:all"
+      end
+    end
+
+    def install_tw_animate_css # because this file is usually missing while installing ruby_ui
+      template "tw-animate-css.js.tt", File.join(destination_root, "vendor/javascript/tw-animate-css.js") unless @engine
+    end
+
+    def create_initializer
+      say "install swage"
+      template "swage.rb.tt", File.join(destination_root, "config/initializers/swage.rb"), force: true
+    end
+
+    def create_base_component
+      template "base_component.rb.tt", File.join(destination_root, "app/components/base.rb"), force: true if @override
+    end
+
+    def create_base_view
+      template "base_view.rb.tt", File.join(destination_root, "app/views/base.rb"), force: true if @override
+    end
+
+    def create_base_form
+      template "form.rb.tt", File.join(destination_root, "app/components/form.rb"), force: true if @override
+    end
+
+    def modify_application_controller
+      template "application_controller.rb.tt", File.join(destination_root, "app/controllers/application_controller.rb") if @override
+    end
+
+    def create_application_view
+      remove_file File.join(destination_root, "app/views/layouts/application.html.erb")
+      template "application_view.rb.tt", File.join(destination_root, "app/views/layouts/application.rb") if @override
+    end
+
+    def modify_engine
+      return unless @engine
+      @name ||= get_name
+      template "engine.rb.tt", File.join(destination_root, "lib", get_name, "engine.rb")
+    end
+
+    private # copied from ruby_ui installer since that's what it uses
+    def using_importmap?
+      File.exist?(Rails.root.join("config/importmap.rb")) && File.exist?(Rails.root.join("bin/importmap"))
+    end
+
+    def using_bun?
+      File.exist?(Rails.root.join("bun.lock"))
+    end
+
+    def using_npm?
+      File.exist?(Rails.root.join("package-lock.json"))
+    end
+
+    def using_pnpm?
+      File.exist?(Rails.root.join("pnpm-lock.yaml"))
+    end
+
+    def using_yarn?
+      File.exist?(Rails.root.join("yarn.lock"))
+    end
+
+    def probably_engine?
+      @name = get_name
+
+      # Dir.glob(File.join(destination_root, "test", "dummy")).empty? ||
+      # Dir.glob(File.join(destination_root, "*.gemspec")).empty? ||
+      File.exist?(File.join(destination_root, "lib", @name, "engine.rb")) ||
+      File.exist?(File.join(destination_root, "lib", @name, "railtie.rb"))
+    end
+
+    def get_name
+      destination_root.match(/\w+$/)[0] # this is gross but there seems to be no better way
+    end
+  end
+end

data/lib/generators/swage/install/templates/application_controller.rb.tt

@@ -0,0 +1,14 @@
+class ApplicationController < ActionController::Base
+  include Phlexible::Rails::ActionController::ImplicitRender
+  include Superform::Rails::StrongParameters
+
+  # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has.
+  allow_browser versions: :modern
+
+  # Changes to the importmap will invalidate the etag for HTML responses
+  stale_when_importmap_changes
+
+  def phlex_view_path(action_name)
+    "views/#{controller_path}/#{action_name}"
+  end
+end

data/lib/generators/swage/install/templates/application_view.rb.tt

@@ -0,0 +1,44 @@
+module Views
+  module Layouts
+    class Application < Phlex::HTML
+      include Phlex::Rails::Helpers::ContentFor
+      include Phlex::Rails::Helpers::CSPMetaTag
+      include Phlex::Rails::Helpers::CSRFMetaTags
+      include Phlex::Rails::Helpers::StyleSheetLinkTag
+      include Phlex::Rails::Helpers::JavaScriptImportmapTags
+
+      def initialize(view)
+        @view = view
+      end
+
+      def view_template(&block)
+        html do
+          head do
+            title { content_for(:title) || "Asdf" }
+            meta(name: "viewport", content: "width=device-width,initial-scale=1")
+            meta(name: "apple-mobile-web-app-capable", content: "yes")
+            meta(name: "application-name", content: "Asdf")
+            meta(name: "mobile-web-app-capable", content: "yes")
+
+            csrf_meta_tags
+            csp_meta_tag
+
+            # Enable PWA manifest for installable apps (make sure to enable in config/routes.rb too!)
+            # = tag.link rel: "manifest", href: pwa_manifest_path(format: :json)
+            link(rel: "icon", href: "/icon.png", type: "image/png")
+            link(rel: "icon", href: "/icon.svg", type: "image/svg+xml")
+            link(rel: "apple-touch-icon", href: "/icon.png")
+
+            # Includes all stylesheet files in app/assets/stylesheets
+            stylesheet_link_tag :app, "data-turbo-track": "reload"
+            stylesheet_link_tag "tailwind", "data-turbo-track": "reload"
+            javascript_importmap_tags
+          end
+          body do
+            div id: "body", &block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/swage/install/templates/base_component.rb.tt

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Components::Base < Phlex::HTML
+  include RubyUI
+  include Phlex::Rails::Helpers::Routes
+end

data/lib/generators/swage/install/templates/base_view.rb.tt

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Views::Base < Phlex::HTML
+  include Phlexible::Rails::AElement
+  include Phlexible::Rails::ControllerVariables
+  include Phlexible::Callbacks
+  include RubyUI
+  include Rails.application.routes.url_helpers
+
+  # More caching options at https://www.phlex.fun/components/caching
+  def cache_store = Rails.cache
+
+  # set up layout paths
+  def self.auto_layout_view_prefix = "Views::"
+  def self.auto_layout_namespace = "Views::Layouts::"
+  def self.auto_layout_default = "Views::Layouts::Application"
+end

data/lib/generators/swage/install/templates/engine.rb.tt

@@ -0,0 +1,25 @@
+module <%= @name.capitalize %>
+  class Engine < ::Rails::Engine
+    initializer "<%= @name %>.set_autoloading" do
+      module ::Views; end
+
+      Rails.autoloaders.main.push_dir root.join("app/views"), namespace: ::Views
+    end
+
+    # Uncomment to automatically include migrations into the application's migration path
+    # This avoids copying migrations to the main application
+    # initializer "<%= @name %>.add_migrations" do |app|
+    #   unless app.root.to_s == root.to_s
+    #     config.paths["db/migrate"].expanded.each do |expanded_path|
+    #       app.config.paths["db/migrate"] << expanded_path
+    #     end
+    #   end
+    # end
+
+    config.generators do |g|
+      g.scaffold_controller :swage
+
+      g.fallbacks[:swage] = :scaffold_controller
+    end
+  end
+end

data/lib/generators/swage/install/templates/form.rb.tt

@@ -0,0 +1,209 @@
+module Components
+  class Form < Superform::Rails::Form
+    include Phlexible::Callbacks
+    include Phlex::Rails::Helpers::FormAuthenticityToken
+    include RubyUI
+
+    # monkeypatch superform here because editing superform itself is gross
+    class Field < self::Field
+      include RubyUI
+      def input(**attributes)
+        attributes.merge! dom_hash(field.dom)
+        RubyUI::Input.new(**attributes)
+      end
+
+      def checkbox(index: nil, **attributes)
+        attributes.merge! dom_hash(field.dom)
+        RubyUI::Checkbox.new(**attributes)
+      end
+
+      def textarea(**attributes)
+        attributes.merge! dom_hash(field.dom)
+          RubyUI::Textarea.new(**attributes) { attributes[:value] }
+      end
+
+      def select(*options, multiple: false, **attributes, &)
+        attributes.merge! dom_hash(field.dom)
+        if mutliple
+          CheckboxGroup do
+            options.each do |opt|
+              div class: "flex flex-col gap-2" do
+                div class: "flex flex-row items-center gap-2" do
+                  RubyUI::Checkbox(*attributes, id: "select_#{opt}")
+                  FormFieldLabel(for: "select_#{opt}") { opt.capitalize }
+                end
+              end
+            end
+          end
+        else
+          RubyUI::Select(**attributes) do
+            SelectGroup do
+              options.each do |opt|
+                SelectItem(value: opt) { opt.capitalize }
+              end
+            end
+          end
+        end
+      end
+
+      # not sure if this is actually needed or if we can just use a combobox or something similar
+      # def datalist(*options, **attributes, &block)
+      #   Components::Datalist.new(field, options:, **attributes, &block)
+      # end
+
+      def errors
+        object.errors[key]
+      end
+
+      def invalid?
+        errors.any?
+      end
+
+      def valid?
+        not invalid?
+      end
+
+      def human_attribute_name
+        object.class.human_attribute_name key
+      end
+
+      def text(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :text)
+        RubyUI::Input(**attributes)
+      end
+
+      def hidden(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :hidden)
+        RubyUI::Input(**attributes)
+      end
+
+      def password(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :password)
+        RubyUI::Input(**attributes)
+      end
+
+      def email(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :email)
+        RubyUI::Input(**attributes)
+      end
+
+      def url(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :url)
+        RubyUI::Input(**attributes)
+      end
+
+      def tel(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :tel)
+        RubyUI::Input(**attributes)
+      end
+      alias_method :phone, :tel
+
+      def number(**attributes)
+        RubyUI::Input(**attributes)
+      end
+
+      def range(**attributes)
+        RubyUI::Input(**attributes)
+      end
+
+      def date(**attributes)
+        attributes.merge! dom_hash(field.dom)
+        RubyUI::DatePicker(**attributes)
+      end
+
+      def time(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :time)
+        RubyUI::Input(**attributes)
+      end
+
+      def datetime(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :"datetime-local")
+        RubyUI::Input(**attributes)
+      end
+
+      def month(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :month)
+        RubyUI::Input(**attributes)
+      end
+
+      def week(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :week)
+        RubyUI::Input(**attributes)
+      end
+
+      def color(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :color)
+        RubyUI::Input(**attributes)
+      end
+
+      def search(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :search)
+        RubyUI::Input(**attributes)
+      end
+
+      def file(**attributes)
+        attributes.merge! dom_hash(field.dom).merge(type: :file)
+        RubyUI::Input(**attributes)
+      end
+
+      def radio(value, index: value, **attributes)
+        attributes.merge! dom_hash(field.dom)
+        div class: "clex items-center space-x-2" do
+          RubyUI::RadioButton(id: index)
+          FormFieldLabel(for: index) { value }
+        end
+      end
+
+      def radios(*options, **attributes, &block)
+        options = enum_options if options.empty?
+        Components::Radios.new(field, options:, **attributes, &block)
+      end
+
+      def checkboxes(*options, **attributes, &block)
+        options = enum_options if options.empty?
+        attributes.merge! dom_hash(field.dom)
+
+        CheckboxGroup do
+          options.each do |opt|
+            div class: "flex flex-col gap-2" do
+              div class: "flex flex-row items-center gap-2" do
+                RubyUI::Checkbox(*attributes, id: "select_#{opt}")
+                FormFieldLabel(for: "select_#{opt}") { opt.capitalize }
+              end
+            end
+          end
+        end
+      end
+
+      # Rails compatibility aliases
+      alias_method :check_box, :checkbox
+      alias_method :text_area, :textarea
+
+      def title
+        key.to_s.titleize
+      end
+
+      private
+      # superform has a field with a dom that stores useful values... must convert it to usable attributes
+      def dom_hash(dom)
+        {
+          id: dom.id,
+          name: dom.name,
+          value: dom.value
+        }
+      end
+    end
+
+    def around_template(&)
+      super do
+        yield if block_given?
+      end
+    end
+
+    def submit(value = submit_value, **attributes)
+      div do
+        RubyUI::Button(name: "commit", type: "submit", **attributes) { submit_value }
+      end
+    end
+  end
+end

data/lib/generators/swage/install/templates/swage.rb.tt

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "phlexible"
+
+Rails.application.config.generators do |g|
+  g.scaffold_controller :swage
+
+  g.fallbacks[:swage] = :scaffold_controller
+end
+
+module Phlexible::Rails::ButtonToConcerns
+  # use consistent ui components
+  def view_template(&block)
+    action = url_for(@url)
+    @options = DEFAULT_OPTIONS.merge((@options || {}).symbolize_keys)
+
+    method = (@options.delete(:method).presence || method_for_options(@options)).to_s
+    form_method = method == "get" ? "get" : "post"
+
+    form action: action, method: form_method, **form_attributes do
+      method_tag method
+      form_method == "post" && token_input(action, method.empty? ? "post" : method)
+      param_inputs
+
+      block_given? ? RubyUI::Button(**button_attrs, &block) : RubyUI::Button(**button_attrs) { @name }
+    end
+  end
+end