rails-blocks-cli 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a208908dfd35e07556c86dc68f85642d7f0b4428927f370898fa91611155881f
-  data.tar.gz: ea4678983d9e63e30a99450b665c3ec4be126e4b72ca1e616f0953e497345561
+  metadata.gz: 63dd443055d6116deb6a9945e9aa025d6cee699603ac48278dc56d541c567e58
+  data.tar.gz: f8f4993d4a4b63083b8644040e02bf35653cefcbb04ce9f03d319ef3820dacde
 SHA512:
-  metadata.gz: 1ea4fe353fbe84f63aa493a9040b4ac51c736f47715e4be550912b2c307c4a188cf727b2f7c7522969954f94d2bc01a42b1909cca99c2807cdbf13dcdc68415e
-  data.tar.gz: a9f560d47c9f4dae1ea9dfa3b14f43fa49287913a9bbb787ab361ae84411a8b06d3da7762898de4c4d05c63a9aa091f046426188c5f1f550567c3f38408792d2
+  metadata.gz: ae54a971c219716f16a227a27185078bc00dd33e94a6eb5d858a4e665e653b9ea921485cb3b334e36610d324fa300d8eb691bb50eb89a53d1b0fa18327b53fd6
+  data.tar.gz: 397f72909bbd30ad2e94991e59c34a25ac4e3d3f409062a3dbac3044af7bfb7ada4f22f54c0e6bab7236b446744d09c633bda996def8cecfa07c4d39ccba17af

data/README.md

@@ -16,6 +16,12 @@ rails-blocks docs accordion
 # Install one component as shared ERB partials
 rails-blocks install accordion --as erb_template
 
+# Install interactively and let the CLI ask for ERB partials or ViewComponent
+rails-blocks install accordion
+
+# Override the component destination
+rails-blocks install accordion --as erb_template --path app/views/components
+
 # Preview installing all free components as shared partials
 rails-blocks install --all --free --as partial --dry-run
 
@@ -43,3 +49,5 @@ rails-blocks install --all --pro --as view_component
 # Update all Pro-access Stimulus controllers
 rails-blocks update stimulus --all --pro
 ```
+
+Default install paths are `app/views/shared/<component>/` for ERB partials, `app/components/<component>/` for ViewComponents, and `app/javascript/controllers/` for required Stimulus controllers. Component installs automatically add missing required Stimulus controllers.

data/lib/rails_blocks/cli.rb

@@ -44,18 +44,22 @@ module RailsBlocks
     attr_reader :argv
 
     def list
-      components.each do |component|
-        next unless include_component?(component)
+      selected = components.select { |component| include_component?(component) }
+      width = selected.map { |component| component_label(component).length }.max || 0
 
-        puts "#{component['slug']}#{component['pro'] ? ' (pro)' : ''} - #{component['title']}"
+      selected.each do |component|
+        puts "#{component_label(component).ljust(width)}  #{muted('-')} #{component['title']}"
       end
     end
 
     def search(query)
       abort "Usage: rails-blocks search QUERY" if query.to_s.strip.empty?
 
-      components.select { |component| component["slug"].include?(query.tr("-", "_")) || component["title"].downcase.include?(query.downcase) }.each do |component|
-        puts "#{component['slug']}#{component['pro'] ? ' (pro)' : ''} - #{component['title']}"
+      selected = components.select { |component| component["slug"].include?(query.tr("-", "_")) || component["title"].downcase.include?(query.downcase) }
+      width = selected.map { |component| component_label(component).length }.max || 0
+
+      selected.each do |component|
+        puts "#{component_label(component).ljust(width)}  #{muted('-')} #{component['title']}"
       end
     end
 
@@ -65,12 +69,22 @@ module RailsBlocks
     end
 
     def docs(slug)
+      return docs_usage if slug.to_s.strip.empty?
+
       component = find_component(slug)
       if component["pro"]
         puts api_get("/api/v1/components/#{component['slug']}/docs")["markdown"]
       else
-        path = cached_component_file(component["slug"], "#{component['slug'].upcase}.md")
-        puts File.exist?(path) ? File.read(path) : "Docs are available at #{component['docs_path']}"
+        begin
+          path = cached_component_file(component["slug"], "#{component['slug'].upcase}.md")
+          if File.exist?(path)
+            puts File.read(path)
+          else
+            puts download(component["public_markdown_url"] || markdown_docs_url(component))
+          end
+        rescue DownloadError
+          docs_links(component)
+        end
       end
     end
 
@@ -87,12 +101,12 @@ module RailsBlocks
     end
 
     def install(slug)
-      implementation = package_implementation
+      implementation = package_implementation(prompt: true)
       dry_run = argv.include?("--dry-run")
 
       return install_all(implementation, dry_run: dry_run) if slug == "--all"
 
-      abort "Usage: rails-blocks install COMPONENT [--as erb_template|view_component|partial] [--dry-run] [--force]" if slug.to_s.empty?
+      abort "Usage: rails-blocks install COMPONENT [--as erb_template|view_component|partial] [--path PATH] [--stimulus-path PATH] [--dry-run] [--force]" if slug.to_s.empty?
 
       component = find_component(slug)
       install_component(component, implementation, dry_run: dry_run)
@@ -105,11 +119,11 @@ module RailsBlocks
       failures = []
 
       selected_components.each do |component|
-        puts "\nInstalling #{component['slug']}#{component['pro'] ? ' (pro)' : ''} as #{implementation}..."
+        say_heading("Installing #{component['slug']}#{' (pro)' if component['pro']} as #{implementation}")
         install_component(component, implementation, dry_run: dry_run)
-      rescue StandardError => error
-        failures << [component["slug"], error.message]
-        warn "Failed to install #{component['slug']}: #{error.message}"
+      rescue StandardError => e
+        failures << [component["slug"], e.message]
+        warn "Failed to install #{component['slug']}: #{e.message}"
       end
 
       puts "\nInstalled #{selected_components.size - failures.size} of #{selected_components.size} components."
@@ -125,6 +139,8 @@ module RailsBlocks
       else
         install_free(component, implementation, dry_run: dry_run)
       end
+
+      install_component_stimulus(component, dry_run: dry_run)
     end
 
     def diff(target)
@@ -155,11 +171,11 @@ module RailsBlocks
       failures = []
 
       selected_components.each do |component|
-        puts "\n#{mode_label(mode)} #{component['slug']}#{component['pro'] ? ' (pro)' : ''} as #{package_implementation}..."
+        puts "\n#{mode_label(mode)} #{component['slug']}#{' (pro)' if component['pro']} as #{package_implementation}..."
         change_component_files(component, mode: mode)
-      rescue StandardError => error
-        failures << [component["slug"], error.message]
-        warn "Failed to #{mode} #{component['slug']}: #{error.message}"
+      rescue StandardError => e
+        failures << [component["slug"], e.message]
+        warn "Failed to #{mode} #{component['slug']}: #{e.message}"
       end
 
       puts "\n#{mode_label(mode)} #{selected_components.size - failures.size} of #{selected_components.size} components."
@@ -171,7 +187,7 @@ module RailsBlocks
 
     def change_component_files(component, mode:)
       data = component["pro"] ? pro_package_data(component, package_implementation) : free_package_data(component, package_implementation)
-      process_zip(data, mode: mode) { |entry_name| Pathname.pwd.join(entry_name) }
+      process_zip(data, mode: mode) { |entry_name| component_destination(entry_name, package_implementation) }
     end
 
     def change_stimulus_files(name, mode:)
@@ -229,27 +245,32 @@ module RailsBlocks
     end
 
     def doctor
-      puts "Registry: #{registry_url}"
-      puts "API: #{api_url}"
-      puts "Token: #{api_token ? 'present' : 'missing'}"
+      say_heading("Rails Blocks CLI")
+      puts "Registry  #{muted(registry_url)}"
+      puts "API       #{muted(api_url)}"
+      puts "Token     #{api_token ? success('present') : 'missing'}"
     end
 
     def help
       puts "Usage: rails-blocks [list|search|show|docs|examples|install|diff|update|login|logout|whoami|agents|mcp|doctor]"
-      puts "       rails-blocks install COMPONENT [--as erb_template|view_component|partial] [--dry-run] [--force]"
-      puts "       rails-blocks install --all [--free|--pro] [--as erb_template|view_component|partial] [--dry-run] [--force]"
-      puts "       rails-blocks diff COMPONENT|--all [--free|--pro] [--as erb_template|view_component|partial]"
-      puts "       rails-blocks update COMPONENT|--all [--free|--pro] [--as erb_template|view_component|partial] [--dry-run]"
+      puts "       rails-blocks install COMPONENT [--as erb_template|view_component|partial] [--path PATH] [--stimulus-path PATH] [--dry-run] [--force]"
+      puts "       rails-blocks install --all [--free|--pro] [--as erb_template|view_component|partial] [--path PATH] [--stimulus-path PATH] [--dry-run] [--force]"
+      puts "       rails-blocks diff COMPONENT|--all [--free|--pro] [--as erb_template|view_component|partial] [--path PATH]"
+      puts "       rails-blocks update COMPONENT|--all [--free|--pro] [--as erb_template|view_component|partial] [--path PATH] [--dry-run]"
       puts "       rails-blocks diff stimulus NAME|--all [--free|--pro]"
       puts "       rails-blocks update stimulus NAME|--all [--free|--pro] [--dry-run]"
     end
 
     def install_free(component, implementation, dry_run:)
-      install_zip(free_package_data(component, implementation), dry_run: dry_run)
+      install_zip(free_package_data(component, implementation), dry_run: dry_run) do |entry_name|
+        component_destination(entry_name, implementation)
+      end
     end
 
     def install_pro(component, implementation, dry_run:)
-      install_zip(pro_package_data(component, implementation), dry_run: dry_run)
+      install_zip(pro_package_data(component, implementation), dry_run: dry_run) do |entry_name|
+        component_destination(entry_name, implementation)
+      end
     end
 
     def free_package_data(component, implementation)
@@ -272,18 +293,104 @@ module RailsBlocks
       download(api_url_for("/api/v1/stimulus_controllers?type=#{type}"), auth: type == "pro")
     end
 
+    def component_stimulus_package_data(component)
+      if component["stimulus_package_url"]
+        download(component["stimulus_package_url"])
+      else
+        stimulus_package_data
+      end
+    end
+
     def install_zip(data, dry_run:)
       zip_entries(data).each do |entry|
-        destination = Pathname.pwd.join(entry[:name])
-        puts "#{dry_run ? 'Would write' : 'Writing'} #{destination}"
-        next if dry_run
-        raise "#{destination} already exists. Use --force when overwrite support is enabled." if destination.exist? && !argv.include?("--force")
+        destination = block_given? ? yield(entry[:name]) : Pathname.pwd.join(entry[:name])
+        write_file(destination, entry[:content], dry_run: dry_run)
+      end
+    end
+
+    def install_component_stimulus(component, dry_run:)
+      controllers = Array(component["required_stimulus_controllers"])
+      return if controllers.empty?
+
+      say_heading("Stimulus controllers")
+      zip_entries(component_stimulus_package_data(component)).each do |entry|
+        filename = File.basename(entry[:name])
+        next unless controllers.include?(filename)
 
-        FileUtils.mkdir_p(destination.dirname)
-        File.binwrite(destination, entry[:content])
+        destination = stimulus_destination(filename)
+        if destination.exist? && !argv.include?("--force")
+          puts "#{muted('Skip')} #{display_path(destination)} #{muted('(already exists)')}"
+          next
+        end
+
+        write_file(destination, entry[:content], dry_run: dry_run)
       end
     end
 
+    def write_file(destination, content, dry_run:)
+      puts "#{dry_run ? muted('Would write') : success('Writing')} #{display_path(destination)}"
+      return if dry_run
+
+      raise "#{destination} already exists. Use --force to overwrite it." if destination.exist? && !argv.include?("--force")
+
+      FileUtils.mkdir_p(destination.dirname)
+      File.binwrite(destination, content)
+    end
+
+    def component_destination(entry_name, implementation)
+      root = Pathname.pwd.join(option_value("--path") || default_component_path(implementation))
+      root.join(entry_name)
+    end
+
+    def stimulus_destination(filename)
+      Pathname.pwd.join(option_value("--stimulus-path") || "app/javascript/controllers", filename)
+    end
+
+    def default_component_path(implementation)
+      implementation == "view_component" ? "app/components" : "app/views/shared"
+    end
+
+    def docs_usage
+      puts "Usage: rails-blocks docs COMPONENT"
+      puts "Example: rails-blocks docs accordion"
+    end
+
+    def docs_links(component)
+      puts "Docs for #{component['title']}:"
+      puts "  Web:      #{web_docs_url(component)}"
+      puts "  Markdown: #{markdown_docs_url(component)}"
+    end
+
+    def web_docs_url(component)
+      component["docs_url"] || "https://railsblocks.com/docs/#{component['slug'].tr('_', '-')}"
+    end
+
+    def markdown_docs_url(component)
+      component["markdown_url"] || "https://railsblocks.com/docs/#{component['slug'].tr('_', '-')}.md"
+    end
+
+    def say_heading(message)
+      puts "\n#{bold(message)}"
+    end
+
+    def success(message)
+      color(message, 32)
+    end
+
+    def muted(message)
+      color(message, 2)
+    end
+
+    def bold(message)
+      color(message, 1)
+    end
+
+    def color(message, code)
+      return message unless $stdout.tty? && ENV["NO_COLOR"].to_s.empty?
+
+      "\e[#{code}m#{message}\e[0m"
+    end
+
     def process_zip(data, mode:)
       counts = { changed: 0, unchanged: 0, skipped: 0 }
 
@@ -319,24 +426,28 @@ module RailsBlocks
       old_content = destination.exist? ? File.binread(destination) : ""
       if old_content == new_content
         counts[:unchanged] += 1
-        puts "No changes #{destination}"
+        puts "No changes #{display_path(destination)}"
         return
       end
 
       counts[:changed] += 1
-      puts unified_diff(old_content, new_content, destination.exist? ? destination.to_s : "/dev/null", destination.to_s)
+      puts unified_diff(old_content, new_content, destination.exist? ? display_path(destination) : "/dev/null", display_path(destination))
     end
 
     def update_file(destination, new_content, counts)
       old_content = destination.exist? ? File.binread(destination) : nil
       if old_content == new_content
         counts[:unchanged] += 1
-        puts "Unchanged #{destination}"
+        puts "Unchanged #{display_path(destination)}"
         return
       end
 
       counts[:changed] += 1
-      puts "#{argv.include?('--dry-run') ? 'Would update' : old_content.nil? ? 'Writing' : 'Updating'} #{destination}"
+      puts "#{if argv.include?('--dry-run')
+                'Would update'
+              else
+                old_content.nil? ? 'Writing' : 'Updating'
+              end} #{display_path(destination)}"
       return if argv.include?("--dry-run")
 
       FileUtils.mkdir_p(destination.dirname)
@@ -369,6 +480,13 @@ module RailsBlocks
       mode == :diff ? "Diffing" : "Updating"
     end
 
+    def display_path(path)
+      pathname = Pathname.new(path)
+      pathname.relative_path_from(Pathname.pwd).to_s
+    rescue ArgumentError
+      pathname.to_s
+    end
+
     def components
       registry.fetch("components")
     end
@@ -386,6 +504,10 @@ module RailsBlocks
       end
     end
 
+    def component_label(component)
+      component["pro"] ? "#{component['slug']} (pro)" : component["slug"]
+    end
+
     def component_filter
       return :pro if argv.include?("--pro")
       return :free if argv.include?("--free")
@@ -395,10 +517,10 @@ module RailsBlocks
 
     def registry
       @registry ||= JSON.parse(download(registry_url))
-    rescue DownloadError => error
-      abort "Could not load the Rails Blocks registry from #{registry_url}: #{error.message}"
-    rescue JSON::ParserError => error
-      abort "Could not parse the Rails Blocks registry from #{registry_url}: #{error.message}"
+    rescue DownloadError => e
+      abort "Could not load the Rails Blocks registry from #{registry_url}: #{e.message}"
+    rescue JSON::ParserError => e
+      abort "Could not parse the Rails Blocks registry from #{registry_url}: #{e.message}"
     end
 
     def download(url, auth: false, redirects: 3)
@@ -437,7 +559,7 @@ module RailsBlocks
     end
 
     def api_url_for(path)
-      return path if path.to_s.match?(/\Ahttps?:\/\//)
+      return path if path.to_s.match?(%r{\Ahttps?://})
 
       URI.join(api_url, path).to_s
     end
@@ -451,14 +573,29 @@ module RailsBlocks
       index ? argv[index + 1] : nil
     end
 
-    def package_implementation
-      implementation = option_value("--as") || "erb_template"
+    def package_implementation(prompt: false)
+      explicit = option_value("--as")
+      implementation = explicit || (prompt ? prompt_for_implementation : "erb_template")
       return "erb_template" if implementation == "partial"
       return implementation if %w[erb_template view_component].include?(implementation)
 
       abort "Unsupported implementation: #{implementation}. Use erb_template, view_component, or partial."
     end
 
+    def prompt_for_implementation
+      return "erb_template" unless $stdin.tty? && $stdout.tty?
+
+      puts bold("Choose an install format")
+      puts "  1. ERB partials      #{muted('app/views/shared/<component>/')}"
+      puts "  2. ViewComponent     #{muted('app/components/<component>/')}"
+      print "Select an option [1 by default]: "
+
+      case $stdin.gets&.strip
+      when "2", "view_component" then "view_component"
+      else "erb_template"
+      end
+    end
+
     def registry_url
       ENV.fetch("RAILS_BLOCKS_REGISTRY_URL", config.fetch("registry_url", DEFAULT_REGISTRY_URL))
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-blocks-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Rails Blocks