tailwind_theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e46f95b20a0a3dcbd2d84b08c6a5bb4c64a4647b9dbbb52062cb8b99d3cd9d97
+  data.tar.gz: d99001bb8cb8c02c4cec4379b4674dc1777ce90e9a08459cbb181edc541e9510
+SHA512:
+  metadata.gz: 210f53e3e2a6bfd0be2f274876843824a74b4c76769dbbe207f5f9395c0c175a9a5266c98dcc2c8a5c5ff8326ad03b4e5e6e17aa3767261802818c28ce0261be
+  data.tar.gz: cf9f9d1bdf9d56ba98741ad908d2175c93f2f4376ba1d739c995b471fdcacc1ac347adadbac24b3053111327aac6064fe5282976e1428f4dd92c843018587fb5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 James Fawks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,334 @@
+# TailwindTheme
+
+Tailwind Theme makes it easy to DRY up your Tailwind CSS components by storing the css classnames in a single YAML file.
+
+Tailwind Theme uses [`tailwind_merge`](https://github.com/gjtorikian/tailwind_merge) to merge the resulting
+Tailwind CSS classes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add tailwind_theme
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install tailwind_theme
+
+```ruby
+require "tailwind_theme"
+
+theme = TailwindTheme.load_file("theme.yml")
+theme.css("button", object: button)
+
+```
+
+Add your theme file location to your `tailwind.config.js` file.
+
+```javascript
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  content: [
+      // Rest of content configuration
+      'path/to/theme/files/**/*.yml'
+  ],
+  // Rest of tailwind configuration
+}
+```
+
+## What is it for?
+
+If you use Tailwind with your Rails application, you know Tailwind cannot process runtime configurations like 
+`"bg-#{color}"`, making it difficult to have dynamic yet predefined components. 
+
+So you are left with two options:
+
+1. CSS Abstraction for components, like Buttons, Alerts, etc., which Tailwind **does not** recommend doing too early.
+   (See https://tailwindcss.com/docs/reusing-styles#compared-to-css-abstractions)
+2. Or, create a partial for each Button variation (that is just a mess).
+
+This is where `tailwind-theme` comes in by keeping your component themes consistent, dynamic, and in one place.
+
+Rending a button dynamically is as simple as:
+
+```ruby
+@theme = TailwindTheme.load_file("theme.yml")
+classnames = @theme.css("button", attributes: { variant: :outline, color: :blue, size: :base })
+
+content_tag :button, content, class: classnames 
+```
+
+Or if you have a button object or using View Components, you can do:
+
+```ruby
+class ButtonComponent < ViewComponent::Base
+  def initialize(theme:, size: :base, color: :blue, variant: :solid)
+    @theme = theme
+    @size = size
+    @color = color
+    @variant = variant
+  end
+  
+  def call
+    content_tag :button, content, class: @theme.css("button", object: self)
+  end
+end
+
+```
+
+```erb
+<%= render(ButtonComponent.new(variant: :outline, color: :blue)) %>
+```
+
+## Example Theme File 
+
+```yaml
+text:
+  truncated: truncate whitespace-nowrap
+button:
+  base: >-
+    text-center font-medium rounded-lg 
+    focus:ring-4 focus:outline-none
+  pill: rounded-full
+  size:
+    xs: px-3 py-2 text-xs
+    sm: px-3 py-2 text-sm
+    base: px-5 py-2.5 text-sm
+    lg: px-5 py-3 text-base
+    xl: px-6 py-3.5 text-base
+  variant:
+    solid:
+      color:
+        blue: >-
+          text-white bg-blue-700 dark:bg-blue-600
+          hover:bg-blue-800 dark:hover:bg-blue-700
+          focus:ring-blue-300 dark:focus:ring-blue-800
+        red: >-
+          text-white bg-red-700 dark:bg-red-600
+          hover:bg-red-800 dark:hover:bg-red-700
+          focus:ring-red-300 dark:focus:ring-red-800
+        green: >-
+          text-white bg-green-700 dark:bg-green-600
+          hover:bg-green-800 dark:hover:bg-green-700
+          focus:ring-green-300 dark:focus:ring-green-800
+        yellow: >- 
+          text-white bg-yellow-400 hover:bg-yellow-500
+          focus:ring-yellow-300 dark:focus:ring-yellow-900
+        indigo: >-
+          text-white bg-indigo-700 dark:bg-indigo-600
+          hover:bg-indigo-800 dark:hover:bg-indigo-700
+          focus:ring-indigo-300 dark:focus:ring-indigo-800
+        purple: >-
+          text-white bg-purple-700 dark:bg-purple-600
+          hover:bg-purple-800 dark:hover:bg-purple-700
+          focus:ring-purple-300 dark:focus:ring-purple-800
+        pink: >-
+          text-white bg-pink-700 dark:bg-pink-600
+          hover:bg-pink-800 dark:hover:bg-pink-700
+          focus:ring-pink-300 dark:focus:ring-pink-800
+    outline:
+      base: border
+      color:
+        blue: >-
+          text-blue-700 border-blue-700 dark:text-blue-500 dark:border-blue-500
+          hover:text-white hover:bg-blue-800 dark:hover:text-white dark:hover:bg-blue-500 
+          focus:ring-blue-300 dark:focus:ring-blue-800
+        red: >-
+          text-red-700 border-red-700 dark:text-red-500 dark:border-red-500
+          hover:text-white hover:bg-red-800 dark:hover:text-white dark:hover:bg-red-500 
+          focus:ring-red-300 dark:focus:ring-red-800
+        green: >-
+          text-green-700 border-green-700 dark:text-green-500 dark:border-green-500
+          hover:text-white hover:bg-green-800 dark:hover:text-white dark:hover:bg-green-500 
+          focus:ring-green-300 dark:focus:ring-green-800
+        yellow: >-
+          text-yellow-700 border-yellow-700 dark:text-yellow-500 dark:border-yellow-500
+          hover:text-white hover:bg-yellow-800 dark:hover:text-white dark:hover:bg-yellow-500 
+          focus:ring-yellow-300 dark:focus:ring-yellow-800
+        indigo: >-
+          text-indigo-700 border-indigo-700 dark:text-indigo-500 dark:border-indigo-500
+          hover:text-white hover:bg-indigo-800 dark:hover:text-white dark:hover:bg-indigo-500 
+          focus:ring-indigo-300 dark:focus:ring-indigo-800
+        purple: >-
+          text-purple-700 border-purple-700 dark:text-purple-500 dark:border-purple-500
+          hover:text-white hover:bg-purple-800 dark:hover:text-white dark:hover:bg-purple-500 
+          focus:ring-purple-300 dark:focus:ring-purple-800
+        pink: >-
+          text-pink-700 border-pink-700 dark:text-pink-500 dark:border-pink-500
+          hover:text-white hover:bg-pink-800 dark:hover:text-white dark:hover:bg-pink-500 
+          focus:ring-pink-300 dark:focus:ring-pink-800
+```
+
+## Loading a Tailwind CSS theme
+
+From a YAML file:
+
+```ruby
+@theme = TailwindTheme.load_file("path/to/theme.yaml")
+```
+
+From a hash object (string keys):
+
+```ruby
+@theme = TailwindTheme::Theme.new({
+  "button" => {
+    # Button Component 
+  },
+  "alert" => {
+    # Alert Component
+  }
+})
+```
+
+## Basic Usage
+
+Retrieving a CSS class:
+
+```ruby
+@theme.css("text.truncated")
+```
+
+Applying a theme to an object:
+
+```ruby
+@theme.css(:button, object: button)
+```
+
+Applying a theme based on some attributes:
+
+```ruby
+@theme.css(:button, attributes: { color: :blue })
+```
+
+Combining multiple themes from different paths:
+
+```ruby
+@theme.merge_css([:modal, :dialog], attributes: modal_attributes)
+```
+
+## Methods
+
+### `css(path, options=)`
+
+Resolves the `path` and merges the Tailwind CSS classnames using `tailwind_merge`.
+If `path` resolves to a [Hash], the methods and attributes from `options[:object]` and/or `options[:attributes]` will
+be used to generate the classnames.
+
+Arguments:
+- **`path`** *[String, Symbol, Array<String, Symbol>]* - the path to use to extract the Tailwind CSS classnames.
+- **`options[:raise]**` [Boolean] - raise a `IndexError` exception when the path is not defined in the theme.
+- **`options[:object]** [Object] - the object to apply the theme to based on the object's methods.
+- **`options[:attributes]**` [Hash<String, Symbol>] - the attribute hash to apply the theme to; `options[:attributes]`
+ overrides `options[:object]` method values if both are defined.
+
+Raises:
+- `IndexError` if `options[:raise]` is `true` and the `path` cannot be found.
+- `ArgumentError` if `path` resolves to a [Hash] and `options[:object]` or `options[:attributes]` is not defined.
+
+Returns:
+- The theme classnames if `path` exists.
+- `"missing-[path seperated by '-']` if `path` does not exist. 
+
+### `css!(path, options = {})`
+
+The same as [`css`](#csspath-options), except raise an `IndexError` if the `path` cannot be found.
+
+### `merge_css(paths, options = {})`
+
+Resolves multiple paths and merges them together.
+
+Arguments:
+- **`paths`** [Array<String, Symbol, Array<String, Symbol>>] - the paths to use to extract the Tailwind CSS classnames.
+- **`options[:raise]**` [Boolean] - raise a `IndexError` exception when the path is not defined in the theme.
+- **`options[:object]** [Object] - the object to apply the theme to based on the object's methods.
+- **`options[:attributes]**` [Hash<String, Symbol>] - the attribute hash to apply the theme to; `options[:attributes]`
+  overrides `options[:object]` method values if both are defined.
+
+Raises:
+- `IndexError` if `options[:raise]` is `true` and the `path` cannot be found.
+- `ArgumentError` if `path` resolves to a [Hash] and `options[:object]` or `options[:attributes]` is not defined.
+
+Returns a string of all the classnames that resolved to the paths given.
+
+### `merge_css!(paths, options = {})`
+
+The same as [`merge_css`](#merge_csspaths-options--), except raise an `IndexError` if a path cannot be found.
+
+### `key?(path)`
+
+Get if a `path` exists.
+
+Arguments:
+- **`path`** [String, Symbol, Array<String, Symbol] - the path defined in the theme.
+
+Returns `true` if the `path` exists.
+
+### `[](path)`
+
+Return the value at the path without processing or merging the classnames.
+
+Arguments:
+- **`path`** [String, Symbol, Array<String, Symbol] - the path defined in the theme.
+
+Returns:
+- [String, Hash] if the `path` can be found.
+- [NilClass] if the `path` cannot be found.
+
+## Configuration
+
+### Override the missing classname if a path cannot be found
+
+Using a string:
+
+```ruby
+TailwindTheme.missing_classname = "missing"
+```
+
+Using a Proc:
+
+```ruby
+TailwindTheme.missing_classname = ->(paths) { "oops-#{paths.join("-")}-missing" }
+```
+
+Disabling:
+
+```ruby
+TailwindTheme.missing_classname = false
+```
+
+### Using a custom `tailwind_merge` instance
+
+```ruby
+@merger = TailwindMerge::Merger.new
+TailwindTheme.merger = @merger
+```
+
+### Using a custom `tailwind_merge` configuration
+
+```ruby
+TailwindTheme.merger_config = {
+  # Configuration
+}
+
+```
+
+See https://github.com/gjtorikian/tailwind_merge?tab=readme-ov-file#configuration for more details.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 
+which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jefawks3/tailwind_theme.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/tailwind_theme/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TailwindTheme
+  VERSION = "0.1.0"
+end

data/lib/tailwind_theme.rb

@@ -0,0 +1,281 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "erb"
+require "tailwind_merge"
+
+require_relative "tailwind_theme/version"
+
+# Namespace for the tailwind_theme code
+module TailwindTheme
+  class << self
+    # Writers for shared global objects
+    attr_writer :merger, :merger_config, :missing_classname
+  end
+
+  def self.merger_config
+    @merger_config ||= {}
+  end
+
+  # Returns the global [TailwindMerge::Merge](https://github.com/gjtorikian/tailwind_merge) merge object
+  # using the global `merge_config` object.
+  def self.merger
+    @merger ||= TailwindMerge::Merger.new(config: merger_config)
+  end
+
+  # Loads the YAML theme file.
+  #
+  # @example
+  #     TailwindTheme.load_file("path/to/theme.yml")
+  #
+  # @example
+  #     TailwindTheme.load_file("path/to/theme.yml.erb")
+  #
+  # @return [TailwindTheme::Theme]
+  def self.load_file(path)
+    contents = File.read path
+    contents = ERB.new(contents).result if path.end_with?(".erb")
+    Theme.new YAML.safe_load(contents)
+  end
+
+  # Generate the missing CSS class name from the path
+  # @param [Array<String>] path the missing CSS path
+  # @return [Nil, String] returns a nil if the global missing_classname is false, otherwise returns a string
+  def self.missing_classname(path)
+    if @missing_classname.nil? || @missing_classname == true
+      "missing-#{path.join "-"}"
+    elsif @missing_classname.is_a? Proc
+      @missing_classname.call path
+    elsif !!@missing_classname
+      @missing_classname.to_s
+    end
+  end
+
+  # The Tailwind CSS Theme object
+  #
+  # @example
+  #     TailwindTheme::Theme.new({ button: "rounded p-8 bg-blue-600 text-white hover:bg-blue-500" })
+  #
+  class Theme
+    # The base key name for the sub theme
+    BASE_KEY = "base"
+    # The key to use for a nil value
+    NIL_KEY = "nil"
+
+    def initialize(theme_hash = {})
+      @theme = theme_hash
+    end
+
+    # Get the merged Tailwind CSS classes
+    #
+    # @param [String, Symbol, Array<String, Symbol>] path the path to the css classes or sub theme
+    # @param [Hash<Symbol, Object>] options the options to use when parsing the css theme
+    # @option options [Boolean] raise raise an `IndexError` if the `path` does not exist
+    # @option options [Object] object the object to apply the sub theme
+    # @option options [Hash<String, Object>] attributes the attributes to apply the sub theme. Overrides
+    #   the attributes defined in `options[:object]`.
+    #
+    # Default options are:
+    #   :raise => false
+    #
+    # @return [String] the merged Tailwind CSS classes
+    #
+    # @raise [IndexError] if the :raise options is true and the path cannot be found
+    # @raise [ArgumentError] if processing an object theme and the object or attributes option is not defined
+    def css(path, options = {})
+      classnames = build path, options
+      merge classnames
+    end
+
+    # Get the merged Tailwind CSS classes. Raises an IndexError if the path cannot be found.
+    #
+    # @param [String, Symbol, Array<String, Symbol>] path the path to the css classes or sub theme
+    # @param [Hash<Symbol, Object>] options the options to use when parsing the css theme
+    # @option options [Object] object the object to apply the sub theme
+    # @option options [Hash<String, Object>] attributes the attributes to apply the sub theme. Overrides
+    #   the attributes defined in `options[:object]`.
+    #
+    # @return [String] the merged Tailwind CSS classes
+    #
+    # @raise [IndexError] if the :raise options is true and the path cannot be found
+    # @raise [ArgumentError] if processing an object theme and the object or attributes option is not defined
+    def css!(path, options = {})
+      css path, options.merge(raise: true)
+    end
+
+    # Combine multiple paths and merging the combined Tailwind CSS classes.
+    #
+    # @param [Array<String, Symbol, Array<String, Symbol>>] paths the array of paths to combine
+    # @param [Hash<Symbol, Object>] options the options to use when parsing the css theme
+    # @option options [Boolean] raise raise an `IndexError` if the a path does not exist
+    # @option options [Object] object the object to apply the sub theme
+    # @option options [Hash<String, Object>] attributes the attributes to apply the sub theme. Overrides
+    #   the attributes defined in `options[:object]`.
+    #
+    # Default options are:
+    #   :raise => false
+    #
+    # @return [String] the merged Tailwind CSS classes
+    #
+    # @raise [IndexError] if the :raise options is true and a path cannot be found
+    # @raise [ArgumentError] if processing an object theme and the object or attributes option is not defined
+    def merge_css(paths, options = {})
+      classnames = paths.map { |path| build path, options }.compact.join(" ")
+      merge classnames
+    end
+
+    # Combine multiple paths and merging the combined Tailwind CSS classes. Raises an IndexError if a path
+    #   cannot be found.
+    #
+    # @param [Array<String, Symbol, Array<String, Symbol>>] paths the array of paths to combine
+    # @param [Hash<Symbol, Object>] options the options to use when parsing the css theme
+    # @option options [Object] object the object to apply the sub theme
+    # @option options [Hash<String, Object>] attributes the attributes to apply the sub theme. Overrides
+    #   the attributes defined in `options[:object]`.
+    #
+    # @return [String] the merged Tailwind CSS classes
+    #
+    # @raise [IndexError] if the :raise options is true and a path cannot be found
+    # @raise [ArgumentError] if processing an object theme and the object or attributes option is not defined
+    def merge_css!(paths, options = {})
+      merge_css paths, options.merge(raise: true)
+    end
+
+    # Returns if the path exists
+    # @return [Boolean] returns true if the path exists
+    def key?(path)
+      path = normalize_path path
+      !!lookup_path(path, raise: false)
+    end
+
+    # Lookup the raw value of the path
+    # @param [String, Symbol, Array[String, Symbol]] path the path to the css classes
+    # @return [String, Hash, NilClass]
+    def [](path)
+      path = normalize_path path
+      lookup_path path, raise: false
+    end
+
+    private
+
+    def normalize_path(path)
+      Array(path).map { |k| k.to_s.split "." }.flatten.map(&:to_s)
+    end
+
+    def normalize_options(options)
+      options.transform_keys!(&:to_sym)
+      options[:attributes]&.transform_keys!(&:to_s)
+      options
+    end
+
+    def lookup_path(path, options)
+      theme = path.empty? ? @theme : @theme.dig(*path)
+      raise IndexError, "theme key missing: \"#{path.join "."}\"" if options[:raise] && theme.nil?
+
+      theme
+    end
+
+    def build(path, options)
+      path = normalize_path path
+      options = normalize_options options
+      value = lookup_path path, options
+      return TailwindTheme.missing_classname(path) unless value
+
+      process value, options
+    end
+
+    def process(value, options)
+      case value
+      when Array
+        process_array value, options
+      when Hash
+        process_object_theme value, options
+      else
+        value
+      end
+    end
+
+    def process_array(themes, options)
+      themes.map { |theme| process theme, options }
+    end
+
+    def process_object_theme(object_theme, options)
+      unless options[:object] || options[:attributes]
+        raise ArgumentError, "Must pass the 'object' or 'attributes' option when applying an object theme."
+      end
+
+      object_theme.each_with_object([object_theme[BASE_KEY]]) do |(key, value), classname_list|
+        if (classnames = process_object_theme_attr(key, value, options))
+          classname_list << classnames
+        end
+      end
+    end
+
+    def process_object_theme_attr(attribute, object_theme, options)
+      case object_theme
+      when Array
+        process_object_theme_array_attr(attribute, object_theme, options)
+      when Hash
+        process_object_theme_hash_attr(attribute, object_theme, options)
+      else
+        process_object_theme_string_attr(attribute, object_theme, options)
+      end
+    end
+
+    def process_object_theme_array_attr(attribute, object_theme, options)
+      object_theme.map { |item| process_object_theme_attr attribute, item, options }
+    end
+
+    def process_object_theme_hash_attr(attribute, object_theme, options)
+      if process_from_attributes?(attribute, options)
+        process_attr_value(object_theme, attributes_value(attribute, options), options)
+      elsif process_from_object?(attribute, options)
+        process_attr_value(object_theme, object_value(attribute, options), options)
+      end
+    end
+
+    def process_object_theme_string_attr(attribute, object_theme, options)
+      if process_from_attributes?(attribute, options)
+        object_theme if attributes_value(attribute, options)
+      elsif process_from_object?(attribute, options)
+        object_theme if object_value(attribute, options)
+      end
+    end
+
+    def process_from_attributes?(attribute, options)
+      options[:attributes]&.key?(attribute)
+    end
+
+    def process_from_object?(attribute, options)
+      options[:object].respond_to?(attribute, true)
+    end
+
+    def attributes_value(attribute, options)
+      options.dig :attributes, attribute
+    end
+
+    def object_value(attribute, options)
+      options[:object].send attribute
+    end
+
+    def process_attr_value(object_theme, value, options)
+      key = value_to_key value
+      [object_theme[BASE_KEY], process(object_theme[key], options)]
+    end
+
+    def value_to_key(value)
+      if value.nil?
+        NIL_KEY
+      elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        value
+      else
+        value.to_s
+      end
+    end
+
+    def merge(classnames)
+      classnames = Array(classnames).flatten.compact.join(" ")
+      TailwindTheme.merger.merge classnames
+    end
+  end
+end

data/spec/fixtures/test-theme.yml

@@ -0,0 +1,23 @@
+basic: "basic-classes"
+multipart:
+  key: "multi-part-key"
+complex:
+  base: "complex-base"
+  value_with_theme:
+    base: "variant-base"
+    default:
+      base: "variant-default-base"
+      disabled: "variant-default-disabled"
+  missing_style:
+    base: "missing-style-base"
+    foo: "missing-foo"
+  values:
+    base: "values-base"
+    test: "values-test"
+    foo: "values-foo"
+    bar: "values-bar"
+  boolean:
+    base: "boolean"
+    true: "boolean-true"
+    false: "boolean-false"
+  missing: "missing-attribute"

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "tailwind_theme"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/tailwind_theme/theme_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "ostruct"
+
+RSpec.describe TailwindTheme::Theme do
+  subject(:theme) { TailwindTheme.load_file theme_file }
+
+  let(:theme_file) { File.expand_path("../fixtures/test-theme.yml", __dir__) }
+
+  let(:test_object) do
+    OpenStruct.new values: :foo, value_with_theme: :missing, boolean: false, foo: :bar
+  end
+
+  describe ".css" do
+    it "raises an IndexError on not found and raise options is true" do
+      expect { theme.css!("test.path", raise: true) }.to raise_error IndexError
+    end
+
+    it "resolves an array path" do
+      expect(theme.css(%i[multipart key])).to eq "multi-part-key"
+    end
+
+    it "resolves an string path" do
+      expect(theme.css("multipart.key")).to eq "multi-part-key"
+    end
+
+    context "when string css path" do
+      it "returns a css string" do
+        expect(theme.css("basic")).to eq "basic-classes"
+      end
+
+      it "returns a missing css string" do
+        expect(theme.css("foo.bar")).to eq "missing-foo-bar"
+      end
+    end
+
+    context "when object theme path" do
+      it "raises ArgumentError when object and attribute option is not defined" do
+        expect { theme.css(:complex) }.to raise_error ArgumentError
+      end
+
+      it "returns the css classnames for an object" do
+        expect(theme.css(:complex, object: test_object))
+          .to eq "complex-base variant-base values-base values-foo boolean boolean-false"
+      end
+
+      it "returns the css classnames for given attributes" do
+        expect(theme.css(:complex, attributes: { boolean: false }))
+          .to eq "complex-base boolean boolean-false"
+      end
+
+      it "does not have the missing attribute classname" do
+        expect(theme.css(:complex, object: test_object)).not_to include("missing-attribute")
+      end
+
+      it "overrides the object attribute value" do
+        expect(theme.css(:complex, object: test_object, attributes: { boolean: true }))
+          .to eq "complex-base variant-base values-base values-foo boolean boolean-true"
+      end
+    end
+  end
+
+  describe ".css!" do
+    it "calls the css method with raise: true option" do
+      expect { theme.css!("test.path") }.to raise_error IndexError
+    end
+  end
+
+  describe ".merge_css" do
+    it "returns the merged paths" do
+      expect(theme.merge_css(%w[basic complex], object: test_object))
+        .to eq "basic-classes complex-base variant-base values-base values-foo boolean boolean-false"
+    end
+  end
+
+  describe ".merge_css!" do
+    it "calls the css method with raise: true option" do
+      expect { theme.merge_css!(["test.path", :complex]) }.to raise_error IndexError
+    end
+  end
+
+  describe ".key?" do
+    it "returns true when key is defined" do
+      expect(theme).to be_key :complex
+    end
+
+    it "returns false when key is not defined" do
+      expect(theme).not_to be_key %i[foo bar]
+    end
+  end
+end

data/spec/tailwind_theme_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+RSpec.describe TailwindTheme do
+  it "has a version number" do
+    expect(TailwindTheme::VERSION).not_to be nil
+  end
+
+  describe "#load_file" do
+    let(:theme_file) { File.expand_path("fixtures/test-theme.yml", __dir__) }
+
+    it "returns the Theme from a file" do
+      expect(described_class.load_file(theme_file)).to be_kind_of(TailwindTheme::Theme)
+    end
+  end
+
+  describe "#missing_classname" do
+    subject(:missing_classname) { described_class.missing_classname %w[test path] }
+
+    context "when self.missing_classname = nil" do
+      before { described_class.missing_classname = nil }
+
+      it "returns the default missing classname" do
+        expect(missing_classname).to eq "missing-test-path"
+      end
+    end
+
+    context "when self.missing_classname = true" do
+      before { described_class.missing_classname = true }
+
+      it "returns the default missing classname" do
+        expect(missing_classname).to eq "missing-test-path"
+      end
+    end
+
+    context "when self.missing_classname = false" do
+      before { described_class.missing_classname = false }
+
+      it "returns the default missing classname" do
+        expect(missing_classname).to be_nil
+      end
+    end
+
+    context "when self.missing_classname = :custom_class" do
+      before { described_class.missing_classname = :custom_class }
+
+      it "returns 'custom_class'" do
+        expect(missing_classname).to eq "custom_class"
+      end
+    end
+
+    context "when self.missing_classname = 'custom-class'" do
+      before { described_class.missing_classname = "custom-class" }
+
+      it "returns 'custom_class'" do
+        expect(missing_classname).to eq "custom-class"
+      end
+    end
+
+    context "when self.missing_classname = Proc" do
+      before { described_class.missing_classname = ->(path) { "oops-#{path.join "-"}-missing" } }
+
+      it "returns 'custom_class'" do
+        expect(missing_classname).to eq "oops-test-path-missing"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: tailwind_theme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Fawks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tailwind_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description:
+email:
+- hello@jfawks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/tailwind_theme.rb
+- lib/tailwind_theme/version.rb
+- spec/fixtures/test-theme.yml
+- spec/spec_helper.rb
+- spec/tailwind_theme/theme_spec.rb
+- spec/tailwind_theme_spec.rb
+homepage: https://github.com/jefawks3
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jefawks3
+  source_code_uri: https://github.com/jefawks3
+  changelog_uri: https://github.com/jefawks3/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A small Tailwind CSS theme utility to read and apply themes stored in a YAML
+  file.
+test_files:
+- spec/fixtures/test-theme.yml
+- spec/spec_helper.rb
+- spec/tailwind_theme/theme_spec.rb
+- spec/tailwind_theme_spec.rb