view_component-scoped_styles 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4518c4426e35b342ba212fb90ab4d5e4692d7427fdf5fdbe5ced923a71cc1e42
-  data.tar.gz: 601433c85c4aad6602831f8c53e662f73080d8bb40f9104f28fc8842411e0569
+  metadata.gz: c2f015fce0d3e52a95641a3a394e7d348c90db92e29b0d023f7a26990806a544
+  data.tar.gz: a856272767f5b7d5a882d6e8576bb0fe5195d94cacc3b11220f718cbdfa9123c
 SHA512:
-  metadata.gz: 8e9a1ab80bf24d000347be17e22d19e684a1ec1f70a08cf95952618c20891b84b8c50d34ab3f08e595c622659d77f5aa423eb5f2f11ebe0213aefa9af75cd9dc
-  data.tar.gz: 3846bc856b99e9be1f416e6616e33e4f0fa9388ddd7a253c714bc56198218543a68e17d5872a3aa1dbe92993691adf4257068f4f6e512aede4015d6c6296bdf1
+  metadata.gz: b2bb1e1106aa4fdb8c0d44df137c60d21680c050f9a9a9eef0f9b64bb6c05509f6a4f40bc40f9708806833d7a7d757317299417b64c7fb4834bbd8b98d725a32
+  data.tar.gz: 9f78813f81df45c463411cb5f3b1079b84c8f3745fbc870fd84e8512e1692eb71f98523a526bff2ad55964c26f2d190eccb57cbfc38d6ffea2da7a337d0a3620

data/README.md

@@ -206,7 +206,7 @@ or via the `component_class` helper:
 
 ### Using the scoped CSS
 
-All scoped CSS will be compiled into `app/assets/stylesheets/components.scoped.css`.
+All scoped CSS will be compiled into a single bundled stylesheet. By default that is `app/assets/stylesheets/components.scoped.css`; both the directory and filename are configurable (see [Configuration](#configuration)).
 
 You should import this stylesheet within your app:
 
@@ -233,7 +233,13 @@ ViewComponent::ScopedStyles.configure do |config|
   # Where ViewComponent classes live (relative to Rails.root). Default: "app/components"
   config.components_path = File.join("app", "components")
 
-  # Optional @layer name for components.scoped.css (e.g. "components"). Default: nil.
+  # Where the bundled scoped stylesheet is written (relative to Rails.root). Default: "app/assets/stylesheets"
+  config.assets_path = File.join("app", "assets", "stylesheets")
+
+  # Filename of the bundled scoped stylesheet. Default: "components.scoped.css"
+  config.stylesheet_name = "components.scoped.css"
+
+  # Optional @layer name for the bundled scoped stylesheet (e.g. "components"). Default: nil.
   config.components_layer = nil
 
   # Prefix for scoped class names (e.g. "c-" produces "c-a1b2c3d4"). Default: "c-"
@@ -244,6 +250,8 @@ end
 | Option | Default | Description |
 | --- | --- | --- |
 | `components_path` | `"app/components"` | Where ViewComponent classes live, relative to `Rails.root`. |
+| `assets_path` | `"app/assets/stylesheets"` | Directory where the bundled scoped stylesheet is written, relative to `Rails.root`. |
+| `stylesheet_name` | `"components.scoped.css"` | Filename of the bundled scoped stylesheet within `assets_path`. |
 | `components_layer` | `nil` | When set, wraps generated CSS in `@layer <name> { ... }` for cascade control. |
 | `css_class_prefix` | `"c-"` | Prefix prepended to scoped class names (e.g. `"vc-"` → `"vc-a1b2c3d4"`). |
 

data/lib/generators/view_component/scoped_styles/install_generator.rb

@@ -27,8 +27,15 @@ module ViewComponent
         end
 
         def components_path_expression
-          segments = Pathname(configuration_defaults.components_path).each_filename.to_a
-          "File.join(#{segments.map { |segment| %("#{segment}") }.join(", ")})"
+          path_expression_for(configuration_defaults.components_path)
+        end
+
+        def assets_path_expression
+          path_expression_for(configuration_defaults.assets_path)
+        end
+
+        def stylesheet_name_value
+          configuration_defaults.stylesheet_name.inspect
         end
 
         def components_layer_value
@@ -38,6 +45,11 @@ module ViewComponent
         def css_class_prefix_value
           configuration_defaults.css_class_prefix.inspect
         end
+
+        def path_expression_for(path)
+          segments = Pathname(path).each_filename.to_a
+          "File.join(#{segments.map { |segment| %("#{segment}") }.join(", ")})"
+        end
       end
     end
   end

data/lib/generators/view_component/scoped_styles/templates/view_component_scoped_styles.rb.tt

@@ -4,7 +4,13 @@ ViewComponent::ScopedStyles.configure do |config|
   # Where ViewComponent classes live (relative to Rails.root). Default: "app/components"
   config.components_path = <%= components_path_expression %>
 
-  # Optional @layer name for components.scoped.css (e.g. "components"). Default: nil.
+  # Where the bundled scoped stylesheet is written (relative to Rails.root). Default: "app/assets/stylesheets"
+  config.assets_path = <%= assets_path_expression %>
+
+  # Filename of the bundled scoped stylesheet. Default: "components.scoped.css"
+  config.stylesheet_name = <%= stylesheet_name_value %>
+
+  # Optional @layer name for the bundled scoped stylesheet (e.g. "components"). Default: nil.
   config.components_layer = <%= components_layer_value %>
 
   # Prefix for scoped class names (e.g. "c-" produces "c-a1b2c3d4"). Default: "c-"

data/lib/view_component/scoped_styles/configuration.rb

@@ -8,6 +8,8 @@ module ViewComponent
     #
     #   ViewComponent::ScopedStyles.configure do |config|
     #     config.components_path = File.join("app", "view_components")
+    #     config.assets_path = File.join("app", "assets", "stylesheets")
+    #     config.stylesheet_name = "components.scoped.css"
     #     config.components_layer = "components"
     #   end
     class Configuration
@@ -16,8 +18,17 @@ module ViewComponent
       # @return [String] default: +"app/components"+
       attr_accessor :components_path
 
-      # Optional CSS cascade layer name for generated styles in
-      # +app/assets/stylesheets/components.scoped.css+.
+      # Directory where the bundled scoped stylesheet is written, relative to {Rails.root}.
+      #
+      # @return [String] default: +"app/assets/stylesheets"+
+      attr_accessor :assets_path
+
+      # Filename of the bundled scoped stylesheet within {assets_path}.
+      #
+      # @return [String] default: +"components.scoped.css"+
+      attr_accessor :stylesheet_name
+
+      # Optional CSS cascade layer name for the bundled scoped stylesheet.
       #
       # When set, the bundled stylesheet is wrapped in +@layer <name> { ... }+ so
       # you can control specificity relative to other layers in your app.
@@ -32,6 +43,8 @@ module ViewComponent
 
       def initialize
         @components_path = File.join("app", "components")
+        @assets_path = File.join("app", "assets", "stylesheets")
+        @stylesheet_name = "components.scoped.css"
         @components_layer = nil
         @css_class_prefix = "c-"
       end

data/lib/view_component/scoped_styles/stylist/writer.rb

@@ -48,7 +48,7 @@ module ViewComponent
         end
 
         def write_atomically(content)
-          if ViewComponent::ScopedStyles.configuration.components_layer
+          if config.components_layer
             content = content.rstrip + "\n}\n"
           end
 
@@ -84,7 +84,7 @@ module ViewComponent
         def initial_content
           content = "/* Generated by ViewComponent::ScopedStyles - Do not edit manually */\n"
 
-          if (layer = ViewComponent::ScopedStyles.configuration.components_layer)
+          if (layer = config.components_layer)
             content += "@layer #{layer} {\n"
           end
 
@@ -92,7 +92,13 @@ module ViewComponent
         end
 
         def stylesheet_path
-          @stylesheet_path ||= Rails.root.join("app/assets/stylesheets/components.scoped.css")
+          @stylesheet_path ||= begin
+            Rails.root.join(config.assets_path, config.stylesheet_name)
+          end
+        end
+
+        def config
+          @config ||= ViewComponent::ScopedStyles.configuration
         end
       end
     end

data/lib/view_component/scoped_styles/version.rb

@@ -2,6 +2,6 @@
 
 module ViewComponent
   module ScopedStyles
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component-scoped_styles
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Edwards