charming 0.1.0

data/lib/charming/generators/app_generator/basic_templates.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module BasicTemplates
+        def gemfile
+          %(# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+)
+        end
+
+        def rakefile
+          %(# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+)
+        end
+
+        def readme
+          %(# #{name.class_name}
+
+A Charming terminal user interface.
+
+Run it with:
+
+```sh
+bundle exec #{name.snake_name}
+```
+)
+        end
+
+        def gemspec
+          %(# frozen_string_literal: true
+
+require_relative "lib/#{name.snake_name}/version"
+
+Gem::Specification.new do |spec|
+#{gemspec_attributes}
+#{gemspec_dependencies}
+end
+)
+        end
+
+        def gemspec_attributes
+          %(  spec.name = "#{name.snake_name}"
+  spec.version = #{name.class_name}::VERSION
+  spec.summary = "A Charming terminal user interface."
+  spec.authors = ["TODO: Your name"]
+  spec.email = ["TODO: Your email"]
+  spec.files = Dir.glob("{app,config,exe,lib}/**/*") + %w[README.md]
+  spec.bindir = "exe"
+  spec.executables = ["#{name.snake_name}"]
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 4.0.0"
+  spec.metadata["rubygems_mfa_required"] = "true")
+        end
+
+        def gemspec_dependencies
+          %(
+  spec.add_dependency "charming")
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator/component_templates.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module ComponentTemplates
+        def component
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class AppFrameComponent < Charming::Component
+    def render
+      column(title_line, help_line, gap: 1)
+    end
+#{component_helpers}
+  end
+end
+)
+        end
+
+        def component_helpers
+          %(
+    private
+
+    def title_line
+      text title, style: theme.title
+    end
+
+    def help_line
+      text "Press p for commands, q to quit.", style: theme.muted
+    end)
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator/controller_template.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module ControllerTemplate
+        def application_controller
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class ApplicationController < Charming::Controller
+    layout Layouts::Application
+    focus_ring :sidebar, :content
+
+    key "p", :open_command_palette, scope: :global
+    key "q", :quit, scope: :global
+
+    command "Home" do
+      navigate_to "/"
+    end
+
+    command "Theme", :open_theme_palette
+    command "Close palette", :close_command_palette
+    command "Quit app", :quit
+  end
+end
+)
+        end
+
+        def controller
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class HomeController < ApplicationController
+#{controller_actions}
+#{controller_helpers}
+  end
+end
+)
+        end
+
+        def controller_actions
+          %(
+    def show
+      render_home
+    end)
+        end
+
+        def controller_helpers
+          %(
+
+    private
+#{render_helpers})
+        end
+
+        def render_helpers
+          %(
+    def render_home
+      render HomeView.new(home: home, palette: command_palette, screen: screen, theme: theme)
+    end
+
+    def home
+      model(:home, HomeModel)
+    end)
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator/layout_template.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module LayoutTemplate
+        def layout
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  module Layouts
+    class Application < Charming::View
+      def render
+        body = Charming::UI.place(app_frame, width: screen.width, height: screen.height)
+        return body unless palette
+
+        Charming::UI.overlay(body, command_palette_modal)
+      end
+#{layout_helpers}
+    end
+  end
+end
+)
+        end
+
+        def layout_helpers
+          %(
+      private
+#{layout_frame_helpers}
+#{layout_navigation_helpers}
+#{layout_modal_helpers}
+#{layout_style_helpers})
+        end
+
+        def layout_frame_helpers
+          %(
+      def app_frame
+        narrow? ? column(sidebar, main_content, gap: 1) : row(sidebar, main_content, gap: 1)
+      end
+
+      def sidebar
+        box(column(app_title, navigation, shortcuts, gap: 1), style: sidebar_style)
+      end
+
+      def main_content
+        box(yield_content, style: main_content_style)
+      end)
+        end
+
+        def layout_navigation_helpers
+          %(
+
+      def app_title
+        text "#{name.class_name}", style: theme.header_accent.align(:center).width(sidebar_width)
+      end
+
+      def navigation
+        column(*nav_items)
+      end
+
+      def nav_items
+        controller.application.routes.all.each_with_index.map do |route, index|
+          text nav_label(route, index), style: nav_style(route, index)
+        end
+      end
+
+      def nav_label(route, index)
+        cursor = sidebar_focused? && index == sidebar_index ? ">" : " "
+        active = current_route?(route) ? "●" : " "
+        "\#{cursor} \#{active} \#{route.title}"
+      end
+
+      def nav_style(route, index)
+        return theme.selected if sidebar_focused? && index == sidebar_index
+        return theme.title if current_route?(route)
+
+        theme.muted
+      end
+
+      def shortcuts
+        text "tab focus\\np commands\\nq quit", style: theme.muted
+      end
+
+      def sidebar_focused?
+        controller.sidebar_focused?
+      end
+
+      def content_focused?
+        controller.content_focused?
+      end
+
+      def sidebar_index
+        controller.sidebar_index
+      end
+
+      def current_route?(route)
+        route.controller_class == controller.class && route.action == :show
+      end)
+        end
+
+        def layout_modal_helpers
+          %(
+
+      def command_palette_modal
+        render_component Charming::Components::Modal.new(
+          content: palette,
+          title: "Command palette",
+          help: "Type to filter. Enter selects. Escape closes.",
+          width: 52,
+          theme: theme
+        )
+      end)
+        end
+
+        def layout_style_helpers
+          %(
+#{layout_frame_style_helpers}
+#{layout_dimension_helpers})
+        end
+
+        def layout_frame_style_helpers
+          %(
+      def sidebar_style
+        base = sidebar_focused? ? theme.title : theme.border
+        base = base.border(:rounded).padding(1, 2).width(sidebar_width).height(panel_height)
+        palette ? base.faint : base
+      end
+
+      def main_content_style
+        base = content_focused? ? theme.title : theme.border
+        base = base.border(:rounded).padding(1, 2).width(main_content_width).height(panel_height)
+        palette ? base.faint : base
+      end)
+        end
+
+        def layout_dimension_helpers
+          %(
+
+      def narrow?
+        screen.width < 72 && screen.height >= 20
+      end
+
+      def sidebar_width
+        narrow? ? [screen.width - 6, 20].max : 22
+      end
+
+      def main_content_width
+        narrow? ? [screen.width - 6, 20].max : [screen.width - sidebar_width - 13, 20].max
+      end
+
+      def panel_height
+        return nil if narrow?
+
+        [screen.height - 4, 5].max
+      end)
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator/model_templates.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module ModelTemplates
+        def application_model
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class ApplicationModel < Charming::ApplicationModel
+  end
+end
+)
+        end
+
+        def home_model
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class HomeModel < ApplicationModel
+    attribute :title, :string, default: "#{name.class_name}"
+  end
+end
+)
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator/screen_spec_templates.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module ScreenSpecTemplates
+        def spec_model
+          %(# frozen_string_literal: true
+
+require "#{app_name.snake_name}"
+
+RSpec.describe #{app_name.class_name}::#{name.class_name}Model do
+  describe "#title" do
+    it "has the correct default string value" do
+      instance = described_class.new
+      expect(instance.title).to eq("#{name.class_name}")
+    end
+
+    it "accepts overridden title values" do
+      instance = described_class.new(title: "Alternative")
+      expect(instance.title).to eq("Alternative")
+    end
+  end
+end
+)
+        end
+
+        def spec_controller
+          %(# frozen_string_literal: true
+
+require "#{app_name.snake_name}"
+
+RSpec.describe #{app_name.class_name}::#{name.controller_class_name} do
+  let(:application) { #{app_name.class_name}::Application.new }
+
+  subject(:controller) { described_class.new(application: application) }
+
+  describe "#show" do
+    it "renders the view with the model" do
+      response = controller.dispatch(:show)
+
+      expect(response).to respond_to(:body)
+    end
+  end
+end
+)
+        end
+
+        def spec_view
+          %(# frozen_string_literal: true
+
+require "#{app_name.snake_name}"
+
+RSpec.describe #{app_name.class_name}::#{name.view_class_name} do
+  describe "#render" do
+    it "renders the model title" do
+      view = described_class.new(
+        #{name.snake_name}: double(title: "#{name.class_name}")
+       )
+
+      expect(view.render).to eq("#{name.class_name}")
+    end
+  end
+end
+)
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator/view_template.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator
+      module ViewTemplate
+        def executable
+          %(#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "#{name.snake_name}"
+
+Charming.run(#{name.class_name}::Application.new)
+)
+        end
+
+        def root_file
+          %(# frozen_string_literal: true
+
+require "charming"
+require "zeitwerk"
+
+module #{name.class_name}
+end
+
+loader = Zeitwerk::Loader.new
+loader.tag = "#{name.snake_name}"
+loader.inflector.inflect("version" => "VERSION")
+loader.push_dir(File.expand_path("#{name.snake_name}", __dir__), namespace: #{name.class_name})
+loader.push_dir(File.expand_path("../app/models", __dir__), namespace: #{name.class_name})
+loader.push_dir(File.expand_path("../app/components", __dir__), namespace: #{name.class_name})
+loader.push_dir(File.expand_path("../app/views", __dir__), namespace: #{name.class_name})
+loader.push_dir(File.expand_path("../app/controllers", __dir__), namespace: #{name.class_name})
+loader.setup
+
+require_relative "../config/routes"
+)
+        end
+
+        def application
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class Application < Charming::Application
+    Charming::UI::Theme.built_in_names.each do |theme_name|
+      theme theme_name.to_sym, built_in: theme_name
+    end
+
+    default_theme :phosphor
+  end
+end
+)
+        end
+
+        def version
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  VERSION = "0.1.0"
+end
+)
+        end
+
+        def view
+          %(# frozen_string_literal: true
+
+module #{name.class_name}
+  class HomeView < Charming::View
+    def render
+      app_frame
+    end
+#{view_helpers}
+  end
+end
+)
+        end
+
+        def view_helpers
+          %(
+    private
+
+    def app_frame
+      render_component AppFrameComponent.new(title: home.title, theme: theme)
+    end)
+        end
+      end
+    end
+  end
+end

data/lib/charming/generators/app_generator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class AppGenerator < Base
+      include BasicTemplates
+      include ComponentTemplates
+      include ControllerTemplate
+      include LayoutTemplate
+      include ModelTemplates
+      include ScreenSpecTemplates
+      include ViewTemplate
+      include AppSpecTemplates
+
+      FILE_TEMPLATES = [
+        ["Gemfile", :gemfile],
+        ["Rakefile", :rakefile],
+        ["README.md", :readme],
+        ["%<name>s.gemspec", :gemspec],
+        ["exe/%<name>s", :executable],
+        ["lib/%<name>s.rb", :root_file],
+        ["lib/%<name>s/application.rb", :application],
+        ["lib/%<name>s/version.rb", :version],
+        ["config/routes.rb", :routes],
+        ["app/models/application_model.rb", :application_model],
+        ["app/models/home_model.rb", :home_model],
+        ["app/controllers/application_controller.rb", :application_controller],
+        ["app/controllers/home_controller.rb", :controller],
+        ["app/views/layouts/application.rb", :layout],
+        ["app/views/home_view.rb", :view],
+        ["app/components/app_frame_component.rb", :component],
+        ["spec/spec_helper.rb", :spec_helper],
+        ["spec/models/home_model_spec.rb", :spec_model],
+        ["spec/controllers/home_controller_spec.rb", :spec_controller],
+        ["spec/views/home_view_spec.rb", :spec_view],
+        ["spec/components/app_frame_component_spec.rb", :spec_component]
+      ].freeze
+
+      def initialize(name, out:, destination:, force: false)
+        super(out: out, destination: File.join(destination, name), force: force)
+        @name = Name.new(name)
+      end
+
+      def generate
+        FILE_TEMPLATES.each do |path, template|
+          create_file(file_path(path), send(template), executable: template == :executable)
+        end
+      end
+
+      private
+
+      attr_reader :name
+      alias_method :app_name, :name
+
+      def file_path(path)
+        format(path, name: name.snake_name)
+      end
+
+      def routes
+        %(# frozen_string_literal: true
+
+#{name.class_name}::Application.routes do
+  root "home#show"
+end
+)
+      end
+
+      def spec_helper
+        %(# frozen_string_literal: true
+
+require "#{name.snake_name}"
+)
+      end
+    end
+  end
+end

data/lib/charming/generators/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Charming
+  module Generators
+    class Base
+      def initialize(out:, destination:, force: false)
+        @out = out
+        @destination = destination
+        @force = force
+      end
+
+      private
+
+      attr_reader :out, :destination
+
+      def create_file(path, content, executable: false)
+        absolute_path = File.join(destination, path)
+        raise Error, "File already exists: #{path}" if File.exist?(absolute_path) && !@force
+
+        FileUtils.mkdir_p(File.dirname(absolute_path))
+        File.write(absolute_path, content)
+        FileUtils.chmod("u+x,go+rx", absolute_path) if executable
+        out.puts "create #{path}"
+      end
+    end
+  end
+end

data/lib/charming/generators/component_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class ComponentGenerator < AppFileGenerator
+      def generate
+        create_file(app_path("app", "components"), component)
+      end
+
+      private
+
+      def suffix
+        "component"
+      end
+
+      def component
+        %(# frozen_string_literal: true
+
+module #{app_name.class_name}
+  class #{name.component_class_name} < Charming::Component
+    def render
+      text "#{name.class_name}"
+    end
+  end
+end
+)
+      end
+    end
+  end
+end

data/lib/charming/generators/controller_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Charming
+  module Generators
+    class ControllerGenerator < AppFileGenerator
+      def initialize(name, args, out:, destination:, force: false)
+        super
+        @actions = args
+      end
+
+      def generate
+        create_file(app_path("app", "controllers"), controller)
+      end
+
+      private
+
+      attr_reader :actions
+
+      def suffix
+        "controller"
+      end
+
+      def controller
+        %(# frozen_string_literal: true
+
+module #{app_name.class_name}
+  class #{name.controller_class_name} < ApplicationController
+#{action_methods}  end
+end
+)
+      end
+
+      def action_methods
+        return action_method("show") if actions.empty?
+
+        actions.map { |action| action_method(action) }.join("\n")
+      end
+
+      def action_method(action)
+        %(    def #{action}
+      render #{name.view_class_name}.new(
+        palette: command_palette,
+        screen: screen
+      )
+    end
+)
+      end
+    end
+  end
+end