phlex-variants 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97bc72ef60ebb3ae5986bf833da453a8ce0f5768987cea06034ffa62bb1b087f
-  data.tar.gz: a775ea5a27cfa083a357ed37c0f35c0b62a46c58abb5626d63b4b144fffc9d7d
+  metadata.gz: e87aa83193854c3623cb503ca7931d71b0c1f1bd453c33b84d5969f3079674e3
+  data.tar.gz: '085c09e554ba5aa090127306236100a543f5f94df6e23a37adc6feb28b3ab599'
 SHA512:
-  metadata.gz: f099f9a914a18007e2afeed60747ad8e255d791874f265a2862a4e0ea2267f1333b38507bf80bac7e91cd82d039d3c27f4a88cb01e1679cb6d3d0f442a8c4325
-  data.tar.gz: b0505e878bef8b833a2f831a50c30c9d0971f68b69669179ad1f721ba3502399456e98d8e6fd62d736e158e0c1b7a33c77f79f76694a0fd332a14194e4d3b62a
+  metadata.gz: 17d3ede3de7f5aee7f68f44d774d98873570400b24c68787b7fd2b93e9c6d0218d02029232e54e3a0f0d00e4f7991013171785485a98ee1e8e4aa52315d53196
+  data.tar.gz: '087150ea587c8a93254de4fe6df98218b52fb4bdc5079c787d841d87c5718532809657f44521ebded4fe598fb0a8d1881dd6d014c9ef130d418ce7c9b0ff21c5'

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-09-29
+
+- Allow only true/false for boolean variants
+- Allow passing false for variants with only true option
+- Improved error message when variant option doesn't exist
+- Improved error message when method missing on StyleBuilder
+- Improve performance of `build_style` method
+
 ## [0.1.0] - 2024-09-25
 
 - Initial release

data/README.md

@@ -30,7 +30,7 @@ gem install phlex-variants
 ```
 
 > [!TIP]
-> If you prefer not to add another dependency to your project, you can simply copy the [Phlex::Variants](https://github.com/stephannv/phlex-variant/blob/main/lib/phlex/variants.rb) file into your project.
+> If you prefer not to add another dependency to your project, you can simply copy the [Phlex::Variants](https://github.com/stephannv/phlex-variants/blob/main/lib/phlex/variants.rb) file into your project.
 
 
 ## Usage
@@ -66,7 +66,7 @@ class Button < Phlex::HTML
     defaults color: :default, size: :md
   end
 
-  attr_reader :color, :size, :outline, :full
+  attr_reader :color, :size, :outline
 
   def initialize(color: nil, size: nil, outline: nil)
     @color = color
@@ -119,6 +119,74 @@ build_style(color: :primary, extra_classes: "disabled:hidden")
 # => "btn btn-danger btn-xs disabled:hidden"
 ```
 
+#### Generated constants
+The following code:
+```ruby
+style do
+  base "btn"
+
+  variants do
+    color do
+      default "btn-default"
+      primary "btn-primary"
+      danger "btn-danger"
+    end
+
+    size do
+      xs "btn-xs"
+      md "btn-md"
+      lg "btn-lg"
+    end
+
+    outline do
+      yes "btn-outline"
+    end
+  end
+
+  defaults color: :default, size: :md
+end
+```
+Will generate the following constants in your view class:
+```ruby
+STYLE_BASE = "btn"
+STYLE_VARIANTS = {
+  color: {
+    default: "btn-default",
+    primary: "btn-primary",
+    danger: "btn-danger"
+  },
+  size: {
+    xs: "btn-xs",
+    md: "btn-md",
+    lg: "btn-lg"
+  },
+  outline: {
+    true => "btn-outline"
+  }
+}
+STYLE_DEFAULTS = { color: :default, size: :md }
+```
+
+For example, if you're creating Lookbook previews, you can do something like this:
+```ruby
+class ButtonPreview < Lookbook::Preview
+  # @param color select :color_options
+  def playground(color: nil)
+    render Button.new(color:)
+  end
+
+  private
+
+  def color_options
+    {
+      choices: Button::STYLE_VARIANTS[:color].keys,
+      include_blank: "default",
+      value_type: "Symbol"
+    }
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/phlex/variants/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
   module Variants
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/phlex/variants.rb

@@ -27,16 +27,34 @@ module Phlex
 
       # @api private
       def build_variants_style(variants)
-        self::STYLE_DEFAULTS.merge(variants.compact).map do |variant, option|
-          value = self::STYLE_VARIANTS.dig(variant, option)
+        variants = variants.compact
+        variants = self::STYLE_DEFAULTS.merge(variants) unless self::STYLE_DEFAULTS.empty?
 
-          if value.nil?
-            raise VariantNotFoundError, "Variant `#{variant}: #{option.inspect}` doesn't exist"
+        variants.map do |variant, option|
+          options = self::STYLE_VARIANTS[variant]
+
+          if options
+            value = options[option]
+
+            next value if value
+
+            # doesn't raise error when passing false for variant with only true option
+            next if option == false && options.has_key?(true)
           end
 
-          value
+          raise_variant_not_found_error(options, variant, option)
         end
       end
+
+      def raise_variant_not_found_error(options, variant, option)
+        message = if options
+          "Option #{option.inspect} for #{variant.inspect} variant doesn't exist. Valid options are: #{options.keys}"
+        else
+          "Variant #{variant.inspect} doesn't exist. Available variants are: #{self::STYLE_VARIANTS.keys}"
+        end
+
+        raise VariantNotFoundError, message
+      end
     end
 
     private
@@ -77,6 +95,11 @@ module Phlex
       def defaults(**variants)
         view_class::STYLE_DEFAULTS.merge!(variants)
       end
+
+      def method_missing(method, *args, &) # standard:disable Style/MissingRespondToMissing
+        message = "undefined method '#{method}' for an instance of Phlex::Variants::StyleBuilder. The available methods are: 'base', 'variants' and 'defaults'"
+        raise NoMethodError, message
+      end
     end
 
     # @api private
@@ -115,12 +138,13 @@ module Phlex
 
       def method_missing(name, *args) # standard:disable Style/MissingRespondToMissing
         option = name.to_sym
-        view_class::STYLE_VARIANTS[variant_name][option] = args
 
         if option == :yes
           view_class::STYLE_VARIANTS[variant_name][true] = args
         elsif option == :no
           view_class::STYLE_VARIANTS[variant_name][false] = args
+        else
+          view_class::STYLE_VARIANTS[variant_name][option] = args
         end
       end
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: phlex-variants
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - stephann
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -52,7 +51,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/stephannv/phlex-variants
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Compose your Phlex component with style variants.
 test_files: []