Class: Voidable::Generators::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/voidable/install/install_generator.rb

Instance Method Summary collapse

Instance Method Details

#add_js_import ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/generators/voidable/install/install_generator.rb', line 107

def add_js_import
  js_entrypoint = "app/javascript/application.js"
  return unless File.exist?(js_entrypoint)
  contents = File.read(js_entrypoint)
  unless contents.include?("@voidable/ui")
    header = if vite?
      <<~JS
        // For smaller bundles, replace the bulk import below with
        // per-component imports for only the elements you use, e.g.:
        //   import "@voidable/ui/button";
        //   import "@voidable/ui/input";
        // See the available components under @voidable/ui's exports.
        import "@voidable/ui";
        import "@voidable/ui-hotwire";

      JS
    else
      <<~JS
        import "@voidable/ui";
        import "@voidable/ui-hotwire";

      JS
    end
    prepend_to_file js_entrypoint, header
  end
  if vite? && !contents.include?("voidable-layout.js")
    css_imports = %w[./application.css]
    case options[:layout]
    when "switching"
      css_imports << "./voidable-layout-topbar.css"
      css_imports << "./voidable-layout-sidebar.css"
    else
      css_imports << "./voidable-layout.css"
    end
    css_imports << "./voidable-devise.css"

    imports = css_imports.map { |f| "import \"#{f}\";" }.join("\n")
    imports += "\nimport \"@voidable/theme\";"
    imports += "\nimport \"./voidable-layout.js\";"
    append_to_file js_entrypoint, "\n#{imports}\n"
  end
  if vite? && !contents.include?("VoidEventController")
    append_to_file js_entrypoint, <<~JS

      import { VoidEventController, VoidTurbo } from "@voidable/ui-hotwire";
      const app = Application.start();
      app.register("void-event", VoidEventController);
      VoidTurbo.start();
    JS
  end
  say "Added Voidable imports to application.js", :green
end

#configure_pagy ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/generators/voidable/install/install_generator.rb', line 200

def configure_pagy
  if defined?(Pagy)
    create_file "config/initializers/pagy.rb", "require \"pagy\"\nrequire \"pagy/toolbox/paginators/method\"\n" unless File.exist?("config/initializers/pagy.rb")
    inject_into_class "app/controllers/application_controller.rb", "ApplicationController", "  include Pagy::Method\n" unless File.read("app/controllers/application_controller.rb").include?("Pagy::Method")
    say "Configured Pagy::Method on ApplicationController for scaffold pagination", :green
  else
    say "", :yellow
    say "Voidable scaffolds use Pagy for pagination. To enable:", :yellow
    say "  bundle add pagy", :yellow
    say "  rails generate voidable:install   # re-run to wire it up", :yellow
    say "", :yellow
  end
end

#create_initializer ⇒ Object 



12
13
14
 
# File 'lib/generators/voidable/install/install_generator.rb', line 12

def create_initializer
  template "initializer.rb.tt", "config/initializers/voidable.rb"
end

#create_layout ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/generators/voidable/install/install_generator.rb', line 30

def create_layout
  copy_file "_settings_menu.html.erb", "app/views/layouts/_settings_menu.html.erb"

  case options[:layout]
  when "sidebar"
    template "application_sidebar.html.erb.tt", "app/views/layouts/application.html.erb", force: true
  when "switching"
    template "application_topbar.html.erb.tt", "app/views/layouts/application.html.erb", force: true
    template "topbar.html.erb.tt", "app/views/layouts/topbar.html.erb"
    template "sidebar.html.erb.tt", "app/views/layouts/sidebar.html.erb"
  else
    template "application_topbar.html.erb.tt", "app/views/layouts/application.html.erb", force: true
  end
  say "Created Voidable application layout (#{options[:layout]})", :green
end

#create_layout_assets ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/generators/voidable/install/install_generator.rb', line 46

def create_layout_assets
  if vite?
    copy_file "voidable-layout.js", "app/javascript/voidable-layout.js"
    copy_file "voidable-devise.css", "app/javascript/voidable-devise.css"

    case options[:layout]
    when "sidebar"
      copy_file "voidable-layout-sidebar.css", "app/javascript/voidable-layout.css", force: true
    when "switching"
      copy_file "voidable-layout-topbar.css", "app/javascript/voidable-layout-topbar.css"
      copy_file "voidable-layout-sidebar.css", "app/javascript/voidable-layout-sidebar.css"
    else
      copy_file "voidable-layout-topbar.css", "app/javascript/voidable-layout.css", force: true
    end
  else
    copy_file "voidable-layout.js", "app/assets/javascripts/voidable-layout.js"
    copy_file "voidable-devise.css", "app/assets/stylesheets/voidable-devise.css"

    assets_init = "config/initializers/assets.rb"
    if File.exist?(assets_init) && !File.read(assets_init).include?("javascripts")
      append_to_file assets_init, <<~RUBY

        # Voidable layout scripts
        Rails.application.config.assets.paths << Rails.root.join("app/assets/javascripts")
      RUBY
    end

    case options[:layout]
    when "sidebar"
      copy_file "voidable-layout-sidebar.css", "app/assets/stylesheets/voidable-layout.css", force: true
    when "switching"
      copy_file "voidable-layout-topbar.css", "app/assets/stylesheets/voidable-layout-topbar.css"
      copy_file "voidable-layout-sidebar.css", "app/assets/stylesheets/voidable-layout-sidebar.css"
    else
      copy_file "voidable-layout-topbar.css", "app/assets/stylesheets/voidable-layout.css", force: true
    end
  end
  say "Created Voidable layout assets", :green
end

#create_vite_helper ⇒ Object 



176
177
178
179
180
 
# File 'lib/generators/voidable/install/install_generator.rb', line 176

def create_vite_helper
  return unless vite?
  template "vite_helper.rb.tt", "app/helpers/vite_helper.rb"
  say "Created ViteHelper for asset path resolution", :green
end

#install_active_storage ⇒ Object 



214
215
216
217
218
 
# File 'lib/generators/voidable/install/install_generator.rb', line 214

def install_active_storage
  return if File.exist?("db/migrate") && Dir.glob("db/migrate/*active_storage*").any?
  rails_command "active_storage:install"
  say "Installed Active Storage migrations (run `bin/rails db:migrate` to apply)", :green
end

#install_devise_views ⇒ Object 



194
195
196
197
198
 
# File 'lib/generators/voidable/install/install_generator.rb', line 194

def install_devise_views
  return unless defined?(Devise)
  generate "voidable:devise_views"
  say "Installed Voidable-styled Devise views", :green
end

#pin_packages ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/generators/voidable/install/install_generator.rb', line 16

def pin_packages
  return if vite?
  importmap = "config/importmap.rb"
  return unless File.exist?(importmap)
  return if File.read(importmap).include?("@voidable/ui")
  append_to_file importmap, <<~RUBY

    # Voidable UI
    pin "@voidable/ui", to: "https://cdn.jsdelivr.net/npm/@voidable/ui@0.5.3/+esm"
    pin "@voidable/ui-hotwire", to: "https://cdn.jsdelivr.net/npm/@voidable/ui-hotwire@0.3.1/dist/index.js"
  RUBY
  say "Pinned @voidable/ui and @voidable/ui-hotwire in importmap", :green
end

#setup_layout_switching ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/generators/voidable/install/install_generator.rb', line 86

def setup_layout_switching
  return unless options[:layout] == "switching"

  template "settings_controller.rb.tt", "app/controllers/settings_controller.rb"

  route 'post "toggle_layout", to: "settings#toggle_layout"'

  inject_into_class "app/controllers/application_controller.rb", "ApplicationController", <<-RUBY

  layout :resolve_layout

  private

  def resolve_layout
    cookies[:layout] || "topbar"
  end
  RUBY

  say "Configured layout switching (topbar/sidebar toggle)", :green
end

#wire_stimulus_controllers ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/generators/voidable/install/install_generator.rb', line 160

def wire_stimulus_controllers
  return if vite?
  controllers_js = "app/javascript/controllers/application.js"
  return unless File.exist?(controllers_js)
  return if File.read(controllers_js).include?("VoidEventController")
  inject_into_file controllers_js, after: /window\.Stimulus\s*=\s*application\n/ do
    <<~JS

      import { VoidEventController, VoidTurbo } from "@voidable/ui-hotwire"
      application.register("void-event", VoidEventController)
      VoidTurbo.start()
    JS
  end
  say "Registered VoidEventController and started VoidTurbo in controllers/application.js", :green
end