hanami-sprockets 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c506dbf07d8b95e741306b6511182bc1428913b4f081f09a5727143de9f27ba3
-  data.tar.gz: d307f243f6ea655eeeafbddf4b326cd75307ea25321b75215a933563543a456a
+  metadata.gz: 423164431eeaf7e1c3809ab78f15b9322b458644726fb505f610be3db9b03981
+  data.tar.gz: 341808d42f74242bd36cb147c575752054e5e4f4feefdac6d3b0cac1e5016c43
 SHA512:
-  metadata.gz: cff9adcbec8df4c221ab3df289b7f33d8065dc12e98f6cb959c0e7828ea1cc01e9208ebba5c7f18d14338244b55160b04fde1e6fabd183b5a2b3beae26163815
-  data.tar.gz: cddf52b5cd2a4c5c968c3d11504f19bae75249239685f4a92664ea93264ed410f2ac625ce1f0954c69759f302bec0d21cfa9b03a055b521c3568b9fe40609f5d
+  metadata.gz: a775a3d136a96f5abeed83864d19f3e7b72461b528f2e1ab4af10e8559cbbac2a9fc02f77a1060e7d0c8a7ebb78518c59bc52518e8d95c1edf26e3466c1ca0d3
+  data.tar.gz: 6969306f684ae65c55b8f6c3464152c00cf3514d21164a7d9dc1686fc62ef44e51ac50d9cfc651416a0dc82c057a2191d34b3c0153227db01affe44b85633317

data/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2025-10-01
+### Added
+- CLI commands: `hanami-sprockets compile` and `hanami-sprockets watch`
+- Hanami CLI integration: `hanami assets compile` and `hanami assets watch`
+- Asset watch mode with file monitoring and auto-recompilation
+
+### Fixed
+- CSS custom properties test failures
+
 ## [0.1.0] - 2025-09-29
 ### Added
 - Initial release

data/README.md

@@ -1,5 +1,7 @@
 # Hanami::Sprockets
 
+[![Gem Version](https://badge.fury.io/rb/hanami-sprockets.svg)](https://badge.fury.io/rb/hanami-sprockets)
+
 Drop-in replacement for hanami-assets that uses Sprockets (like Rails) instead of npm/Node.js.
 
 If you want the Rails asset pipeline in your Hanami app without dealing with npm, this is for you.
@@ -24,7 +26,7 @@ gem 'hanami-sprockets'
 And then execute:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
 ## Basic Usage
@@ -52,7 +54,7 @@ assets = Hanami::Assets.new(
 
 Follow Rails conventions:
 
-```
+```text
 app/
 ├── assets/
 │   ├── stylesheets/
@@ -153,6 +155,63 @@ manifest = assets.precompile("/path/to/public/assets")
 puts "Compiled assets:", manifest.assets.keys
 ```
 
+### Command Line Interface
+
+The gem includes CLI commands similar to Hanami's asset commands:
+
+#### Compile Assets
+
+Compile assets for production deployment:
+
+```bash
+bundle exec hanami-sprockets compile
+```
+
+With custom output directory:
+
+```bash
+bundle exec hanami-sprockets compile -o public/dist
+```
+
+#### Watch Assets
+
+Watch assets for changes during development:
+
+```bash
+bundle exec hanami-sprockets watch
+```
+
+The watch command monitors your asset directories for changes and automatically recompiles when files are modified. Requires the `listen` gem to be available.
+
+#### CLI Options
+
+```bash
+Usage: hanami-sprockets [COMMAND] [OPTIONS]
+
+Commands:
+  compile    Compile assets for production
+  watch      Watch assets for changes and recompile
+
+Options:
+  -r, --root ROOT      Application root directory
+  -o, --output OUTPUT  Output directory for compiled assets
+  -h, --help           Show help message
+```
+
+### Integration with Hanami CLI
+
+When used within a Hanami application, hanami-sprockets provides command classes that can be automatically discovered by Hanami's CLI system. This allows you to use:
+
+```bash
+# Instead of hanami-sprockets compile
+hanami assets compile
+
+# Instead of hanami-sprockets watch
+hanami assets watch
+```
+
+These commands integrate seamlessly with Hanami's application structure and automatically discover your app's configuration. The gem provides compatible command classes in the `Hanami::CLI::Commands::App::Assets` namespace that follow Hanami's CLI conventions.
+
 ## Advanced Configuration
 
 ```ruby
@@ -209,7 +268,7 @@ Main class for asset management.
 
 Represents a single asset.
 
-#### Methods
+#### Asset Methods
 
 - `#url` - Full URL to asset
 - `#path` - Path to asset (without base URL)
@@ -221,7 +280,7 @@ Represents a single asset.
 
 Template helpers for generating asset HTML tags.
 
-#### Methods
+#### Helper Methods
 
 - `stylesheet_tag(*sources, **options)` - Generate `<link>` tags
 - `javascript_tag(*sources, **options)` - Generate `<script>` tags

data/bin/hanami-sprockets

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hanami/sprockets"
+require "hanami/sprockets/cli"
+
+Hanami::Assets::CLI.start(ARGV)

data/hanami-sprockets.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack-test", "~> 1.1"
   spec.add_development_dependency "dry-configurable", "~> 1.1"
   spec.add_development_dependency "dry-inflector", "~> 1.0"
+  spec.add_development_dependency "listen", "~> 3.8"
 end

data/lib/hanami/cli/commands/app/assets/command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+          class Command
+            def initialize(out: $stdout)
+              @out = out
+            end
+
+            def call(app: nil)
+              assets = create_assets_instance(app)
+              output_dir = default_output_dir(app)
+
+              execute_assets_command(assets, output_dir)
+            end
+
+            protected
+
+            attr_reader :out
+
+            def create_assets_instance(app)
+              root = app ? app.root : Pathname.pwd
+              config = Hanami::Assets::Config.new(digest: true)
+              Hanami::Assets.new(config: config, root: root.to_s)
+            end
+
+            def default_output_dir(app)
+              root = app ? app.root : Pathname.pwd
+              root.join("public", "assets").to_s
+            end
+
+            def execute_assets_command(assets, output_dir)
+              raise NotImplementedError, "Subclasses must implement #execute_assets_command"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/assets/compile.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "command"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+          class Compile < Command
+            def execute_assets_command(assets, output_dir)
+              out.puts "Compiling assets using Sprockets..."
+
+              manifest = assets.precompile(output_dir)
+
+              out.puts "Assets compiled successfully:"
+              manifest.assets.each do |logical_path, digest_path|
+                out.puts "  #{logical_path} -> #{digest_path}"
+              end
+
+              out.puts "Output directory: #{output_dir}"
+            rescue => e
+              out.puts "Error compiling assets: #{e.message}"
+              raise
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/assets/watch.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "command"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+          class Watch < Command
+            def execute_assets_command(assets, output_dir)
+              out.puts "Starting Sprockets asset watch mode..."
+              out.puts "Press Ctrl+C to stop"
+
+              require "listen"
+
+              asset_paths = find_asset_paths(assets)
+
+              if asset_paths.empty?
+                out.puts "No asset directories found. Looking for:"
+                %w[app/assets lib/assets vendor/assets].each do |path|
+                  out.puts "  #{path}"
+                end
+                return
+              end
+
+              out.puts "Watching directories:"
+              asset_paths.each { |path| out.puts "  #{path}" }
+
+              listener = Listen.to(*asset_paths, only: /\.(css|js|scss|sass|coffee|erb)$/) do |modified, added, removed|
+                out.puts "\nChanges detected:"
+                (modified + added + removed).each { |file| out.puts "  #{file}" }
+
+                begin
+                  out.puts "Recompiling assets..."
+                  assets.precompile(output_dir)
+                  out.puts "Assets recompiled successfully"
+                rescue => e
+                  out.puts "Error recompiling assets: #{e.message}"
+                end
+              end
+
+              listener.start
+
+              trap("INT") { listener.stop; exit }
+
+              sleep
+            rescue LoadError
+              out.puts "Error: 'listen' gem is required for watch mode."
+              out.puts "Add 'gem \"listen\"' to your Gemfile and run 'bundle install'"
+              raise
+            rescue => e
+              out.puts "Error in watch mode: #{e.message}"
+              raise
+            end
+
+            private
+
+            def find_asset_paths(assets)
+              root = Pathname(assets.root)
+              paths = []
+              %w[app/assets lib/assets vendor/assets].each do |relative_path|
+                path = root.join(relative_path)
+                paths << path.to_s if path.exist?
+              end
+              paths
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/app/assets.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "assets/compile"
+require_relative "assets/watch"
+
+module Hanami
+  module CLI
+    module Commands
+      module App
+        module Assets
+        end
+      end
+    end
+  end
+end

data/lib/hanami/sprockets/cli.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "pathname"
+require "fileutils"
+
+module Hanami
+  class Assets
+    class CLI
+      class << self
+        def start(args)
+          new(args).call
+        end
+      end
+
+      def initialize(args)
+        @args = args
+        @command = nil
+        @options = {}
+        @root = Pathname.pwd
+      end
+
+      def call
+        parse_options
+
+        case @command
+        when "compile"
+          compile
+        when "watch"
+          watch
+        else
+          show_help
+        end
+      end
+
+      private
+
+      def parse_options
+        parser = OptionParser.new do |opts|
+          opts.banner = "Usage: hanami-sprockets [COMMAND] [OPTIONS]"
+          opts.separator ""
+          opts.separator "Commands:"
+          opts.separator "  compile    Compile assets for production"
+          opts.separator "  watch      Watch assets for changes and recompile"
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on("-r", "--root ROOT", "Application root directory") do |root|
+            @options[:root] = root
+            @root = Pathname(root)
+          end
+
+          opts.on("-o", "--output OUTPUT", "Output directory for compiled assets") do |output|
+            @options[:output] = output
+          end
+
+          opts.on("-h", "--help", "Show this help message") do
+            puts opts
+            exit
+          end
+        end
+
+        begin
+          parser.parse!(@args)
+          @command = @args.shift
+        rescue OptionParser::InvalidOption => e
+          puts "Error: #{e.message}"
+          puts parser
+          exit(1)
+        end
+      end
+
+      def compile
+        puts "Compiling assets..."
+
+        output_dir = @options[:output] || @root.join("public", "assets").to_s
+
+        assets = create_assets_instance
+        manifest = assets.precompile(output_dir)
+
+        puts "Assets compiled successfully:"
+        manifest.assets.each do |logical_path, digest_path|
+          puts "  #{logical_path} -> #{digest_path}"
+        end
+
+        puts "Output directory: #{output_dir}"
+      rescue => e
+        puts "Error compiling assets: #{e.message}"
+        exit(1)
+      end
+
+      def watch
+        puts "Starting asset watch mode..."
+        puts "Press Ctrl+C to stop"
+
+        require "listen"
+
+        assets = create_assets_instance
+        asset_paths = find_asset_paths
+
+        if asset_paths.empty?
+          puts "No asset directories found. Looking for:"
+          %w[app/assets lib/assets vendor/assets].each do |path|
+            puts "  #{@root.join(path)}"
+          end
+          exit(1)
+        end
+
+        puts "Watching directories:"
+        asset_paths.each { |path| puts "  #{path}" }
+
+        listener = Listen.to(*asset_paths, only: /\.(css|js|scss|sass|coffee|erb)$/) do |modified, added, removed|
+          puts "\nChanges detected:"
+          (modified + added + removed).each { |file| puts "  #{file}" }
+
+          begin
+            puts "Recompiling assets..."
+            output_dir = @options[:output] || @root.join("public", "assets").to_s
+            assets.precompile(output_dir)
+            puts "Assets recompiled successfully"
+          rescue => e
+            puts "Error recompiling assets: #{e.message}"
+          end
+        end
+
+        listener.start
+
+        trap("INT") { listener.stop; exit }
+
+        sleep
+      rescue LoadError
+        puts "Error: 'listen' gem is required for watch mode."
+        puts "Add 'gem \"listen\"' to your Gemfile and run 'bundle install'"
+        exit(1)
+      rescue => e
+        puts "Error in watch mode: #{e.message}"
+        exit(1)
+      end
+
+      def show_help
+        puts "Usage: hanami-sprockets [COMMAND] [OPTIONS]"
+        puts ""
+        puts "Commands:"
+        puts "  compile    Compile assets for production"
+        puts "  watch      Watch assets for changes and recompile"
+        puts ""
+        puts "Options:"
+        puts "  -r, --root ROOT      Application root directory"
+        puts "  -o, --output OUTPUT  Output directory for compiled assets"
+        puts "  -h, --help           Show this help message"
+        puts ""
+        puts "Examples:"
+        puts "  hanami-sprockets compile"
+        puts "  hanami-sprockets compile -o public/assets"
+        puts "  hanami-sprockets watch"
+        puts "  hanami-sprockets watch -r /path/to/app"
+      end
+
+      def create_assets_instance
+        config = Hanami::Assets::Config.new(digest: true)
+        Hanami::Assets.new(config: config, root: @root.to_s)
+      end
+
+      def find_asset_paths
+        paths = []
+        %w[app/assets lib/assets vendor/assets].each do |relative_path|
+          path = @root.join(relative_path)
+          paths << path.to_s if path.exist?
+        end
+        paths
+      end
+    end
+  end
+end

data/lib/hanami/sprockets/version.rb

@@ -4,6 +4,6 @@ module Hanami
   class Assets
     # @api private
     # @since 0.1.0
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/hanami/sprockets.rb

@@ -22,7 +22,9 @@ module Hanami
         loader.ignore(
           "#{root}/hanami-sprockets.rb",
           "#{root}/hanami/sprockets/version.rb",
-          "#{root}/hanami/sprockets/errors.rb"
+          "#{root}/hanami/sprockets/errors.rb",
+          "#{root}/hanami/sprockets/cli.rb",
+          "#{root}/hanami/cli"
         )
         loader.enable_reloading if loader.respond_to?(:enable_reloading)
         loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-sprockets.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-sprockets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Nesbitt
@@ -183,22 +183,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: Alternative to hanami-assets that uses Sprockets for asset compilation
   and management, compatible with existing Sprockets gems
 email:
 - andrewnez@gmail.com
-executables: []
+executables:
+- hanami-sprockets
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
+- bin/hanami-sprockets
 - hanami-sprockets.gemspec
 - lib/hanami-sprockets.rb
+- lib/hanami/cli/commands/app/assets.rb
+- lib/hanami/cli/commands/app/assets/command.rb
+- lib/hanami/cli/commands/app/assets/compile.rb
+- lib/hanami/cli/commands/app/assets/watch.rb
 - lib/hanami/sprockets.rb
 - lib/hanami/sprockets/asset.rb
 - lib/hanami/sprockets/base_url.rb
+- lib/hanami/sprockets/cli.rb
 - lib/hanami/sprockets/config.rb
 - lib/hanami/sprockets/errors.rb
 - lib/hanami/sprockets/helpers.rb