utility_palettes 0.1.1 → 1.0.0

data/lib/utility_palettes/sequences.rb

@@ -1,90 +1,88 @@
-# frozen_string_literal: true
-
-require 'color_converters'
-require 'bigdecimal'
-
-# an increase in the 'level' makes the percieved colour darker
-
-module UtilityPalettes
-  class Sequences
-    def self.hsl(colour, level_change, increment_steppers)
-      h_step = increment_steppers[:h_step]
-      s_step = increment_steppers[:s_step]
-      l_step = increment_steppers[:l_step]
-
-      # Use BigDecimal for precise decimal arithmetic
-      h_value = (BigDecimal(colour.hsl[:h].to_s) - BigDecimal((level_change * h_step).to_s)) % 360
-      s_value = (BigDecimal(colour.hsl[:s].to_s) - BigDecimal((level_change * s_step).to_s)).clamp(0, 100)
-      l_value = (BigDecimal(colour.hsl[:l].to_s) - BigDecimal((level_change * l_step).to_s)).clamp(0, 100)
-
-      ColorConverters::Color.new(h: h_value.to_f, s: s_value.to_f, l: l_value.to_f)
-    end
-
-    def self.rgb(colour, level_change, increment_steppers)
-      r_step = increment_steppers[:r_step] || increment_steppers[:rgb_step]
-      g_step = increment_steppers[:g_step] || increment_steppers[:rgb_step]
-      b_step = increment_steppers[:b_step] || increment_steppers[:rgb_step]
-
-      # Use BigDecimal for precise decimal arithmetic
-      r_value = (BigDecimal(colour.rgb[:r].to_s) - BigDecimal((level_change * r_step).to_s)).clamp(0, 255).to_f
-      g_value = (BigDecimal(colour.rgb[:g].to_s) - BigDecimal((level_change * g_step).to_s)).clamp(0, 255).to_f
-      b_value = (BigDecimal(colour.rgb[:b].to_s) - BigDecimal((level_change * b_step).to_s)).clamp(0, 255).to_f
-
-      ColorConverters::Color.new(r: r_value, g: g_value, b: b_value)
-    end
-
-    def tailwind(_colour, _step, _go_lighter, _increment_steppers)
-      # def pSBC(p, _c0, _c1, l)
-      #   r = nil
-      #   g = nil
-      #   b = nil
-      #   pP = nil
-      #   f = nil
-      #   t = nil
-
-      #   if l
-      #     pPr = pP * f[:r]
-      #     f[:g]
-      #     pPb = pP * f[:b]
-
-      #     ptr = p * t[:r]
-      #     t[:g]
-      #     ptb = p * t[:b]
-
-      #     r = (pPr + ptr).round
-      #     g = (pPb + ptb).round
-      #     b = (pPb + ptb).round
-      # else
-      #   pPr = pP * (f[:r]**2)
-      #   pPg = pP * (f[:g]**2)
-      #   pPb = pP * (f[:b]**2)
-
-      #   ptr = p * (t[:r]**2)
-      #   ptg = p * (t[:g]**2)
-      #   ptb = p * (t[:b]**2)
-
-      #   r = ((pPr + ptr)**0.5).round
-      #   g = ((pPg + ptg)**0.5).round
-      #   b = ((pPb + ptb)**0.5).round
-      # end
-
-      # a = f.a
-      # t = t.a
-      # f = a >= 0 || t >= 0
-
-      # t if f && a.negative?
-
-      # a = if f
-      #       if a.negative?
-      #         t
-      #       else
-      #         t.negative? ? a : a * pP + t * p
-      #       end
-      #     else
-      #       0
-      #     end
-
-      ColorConverters::Color.new(r: r, g: g, b: b, a: m(a * 1000) / 1000)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'color_converters'
+require 'bigdecimal'
+
+# an increase in the 'level' makes the percieved colour darker
+
+module UtilityPalettes
+  class Sequences
+    def self.hsl(colour, level_change)
+      colour_hsl = colour.hsl
+      configuration = UtilityPalettes.configuration
+
+      # Use BigDecimal for precise decimal arithmetic
+      h_value = (BigDecimal(colour_hsl[:h].to_s) - BigDecimal((level_change * configuration.steps_h).to_s)) % 360
+      s_value = (BigDecimal(colour_hsl[:s].to_s) - BigDecimal((level_change * configuration.steps_s).to_s)).clamp(0, 100)
+      l_value = (BigDecimal(colour_hsl[:l].to_s) - BigDecimal((level_change * configuration.steps_l).to_s)).clamp(0, 100)
+
+      ColorConverters::Color.new(h: h_value.to_f, s: s_value.to_f, l: l_value.to_f)
+    end
+
+    def self.rgb(colour, level_change)
+      colour_rgb = colour.rgb
+      configuration = UtilityPalettes.configuration
+
+      # Use BigDecimal for precise decimal arithmetic
+      r_value = (BigDecimal(colour_rgb[:r].to_s) - BigDecimal((level_change * configuration.steps_r).to_s)).clamp(0, 255)
+      g_value = (BigDecimal(colour_rgb[:g].to_s) - BigDecimal((level_change * configuration.steps_g).to_s)).clamp(0, 255)
+      b_value = (BigDecimal(colour_rgb[:b].to_s) - BigDecimal((level_change * configuration.steps_b).to_s)).clamp(0, 255)
+
+      ColorConverters::Color.new(r: r_value.to_f, g: g_value.to_f, b: b_value.to_f)
+    end
+
+    # def tailwind(_colour, _step, _go_lighter, _increment_steppers)
+    #   # def pSBC(p, _c0, _c1, l)
+    #   #   r = nil
+    #   #   g = nil
+    #   #   b = nil
+    #   #   pP = nil
+    #   #   f = nil
+    #   #   t = nil
+
+    #   #   if l
+    #   #     pPr = pP * f[:r]
+    #   #     f[:g]
+    #   #     pPb = pP * f[:b]
+
+    #   #     ptr = p * t[:r]
+    #   #     t[:g]
+    #   #     ptb = p * t[:b]
+
+    #   #     r = (pPr + ptr).round
+    #   #     g = (pPb + ptb).round
+    #   #     b = (pPb + ptb).round
+    #   # else
+    #   #   pPr = pP * (f[:r]**2)
+    #   #   pPg = pP * (f[:g]**2)
+    #   #   pPb = pP * (f[:b]**2)
+
+    #   #   ptr = p * (t[:r]**2)
+    #   #   ptg = p * (t[:g]**2)
+    #   #   ptb = p * (t[:b]**2)
+
+    #   #   r = ((pPr + ptr)**0.5).round
+    #   #   g = ((pPg + ptg)**0.5).round
+    #   #   b = ((pPb + ptb)**0.5).round
+    #   # end
+
+    #   # a = f.a
+    #   # t = t.a
+    #   # f = a >= 0 || t >= 0
+
+    #   # t if f && a.negative?
+
+    #   # a = if f
+    #   #       if a.negative?
+    #   #         t
+    #   #       else
+    #   #         t.negative? ? a : a * pP + t * p
+    #   #       end
+    #   #     else
+    #   #       0
+    #   #     end
+
+    #   ColorConverters::Color.new(r: r, g: g, b: b, a: m(a * 1000) / 1000)
+    # end
+  end
+end

data/lib/utility_palettes/swatch.rb

@@ -1,108 +1,107 @@
-# frozen_string_literal: true
-
-module UtilityPalettes
-  class Swatch
-    # ? Single Colour's Palette
-    # a function to create an absolute palette that incorporates a single colour input
-    def self.absolute_generator(label, base_colour, method, increment_steppers)
-      @method = method
-      @increment_steppers = increment_steppers
-
-      # colours are index inversely to their lightness
-      base_level = UtilityPalettes::Swatch.base_lightness_index(base_colour)
-      generated_absolute_swatches = {}.merge({ UtilityPalettes::Swatch.label(label, base_level) => base_colour })
-
-      # # Lighter colours
-      # # calc the space available to create lightened colours based off the base colour
-      # if base_level.positive?
-      #   (0..base_level).each do |new_level|
-      #     new_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, new_level)
-      #     generated_absolute_swatches = {}.merge(generated_absolute_swatches, { UtilityPalettes::Swatch.label(label, new_level) => new_colour })
-      #   end
-      # end
-
-      # # Darker colours
-      # # calc the space available to create darkened colours based off the base colour
-      # if base_level < 9
-      #   (base_level..9).each do |new_level|
-      #     new_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, new_level)
-      #     generated_absolute_swatches = {}.merge(generated_absolute_swatches, { UtilityPalettes::Swatch.label(label, new_level) => new_colour })
-      #   end
-      # end
-
-      if base_level.positive?
-        (0..9).each do |new_level|
-          new_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, new_level)
-          generated_absolute_swatches = {}.merge(generated_absolute_swatches, { UtilityPalettes::Swatch.label(label, new_level) => new_colour })
-        end
-      end
-
-      generated_absolute_swatches
-    end
-
-    # ? Single Colour's Relative Palette
-    # a function to create a relative palette centred on a single colour input
-    def self.relative_generator(label, base_colour, method, increment_steppers)
-      @method = method
-      @increment_steppers = increment_steppers
-
-      lighter_colour = nil
-      darker_colour = nil
-
-      # colours are index inversely to their lightness
-      base_level = UtilityPalettes::Swatch.base_lightness_index(base_colour)
-      generated_relative_swatches = {}.merge({ label => base_colour })
-
-      # Lighter Colour
-      if base_level > 1
-        lighter_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level + 2)
-      elsif base_level > 0
-        lighter_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level + 1)
-      else
-        lighter_colour = nil
-      end
-
-      # Darker Colour
-      if base_level < 8
-        darker_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level - 2)
-      elsif base_level < 9
-        darker_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level - 1)
-      else
-        darker_colour = nil
-      end
-
-      generated_relative_swatches = {}.merge(generated_relative_swatches, { "#{label}-light" => lighter_colour })
-      generated_relative_swatches = {}.merge(generated_relative_swatches, { "#{label}-dark" => darker_colour })
-
-      generated_relative_swatches
-    end
-
-    def self.base_lightness_index(colour)
-      9 - (colour.hsl[:l] / 10).floor
-    end
-
-    def self.label(label, index)
-      levels = { '0' => 50, '1' => 100, '2' => 200, '3' => 300, '4' => 400, '5' => 500, '6' => 600, '7' => 700, '8' => 800, '9' => 900 }
-
-      [label, levels.dig(index.to_s)].join('-')
-    end
-
-    # TODO: create other sequence methods
-    # ? How to Calculate the next colour in the Palette
-    def self.generate(colour, base_level, new_level)
-      case @method
-      when 'hsl'
-        UtilityPalettes::Sequences.hsl(colour, new_level - base_level, @increment_steppers)
-      when 'rgb'
-        # TODO
-      else
-        UtilityPalettes::Sequences.hsl(colour, new_level - base_level, @increment_steppers)
-      end
-    end
-
-    def build_step_check
-      # const ALL_LEVELS = [50, 100, 200, 300, 400, 600, 700, 800, 900];
-      # const levels = options.levels == null ? ALL_LEVELS : options.levels.filter(level => ALL_LEVELS.includes(level));
-    end
-  end
-end
+# frozen_string_literal: true
+
+module UtilityPalettes
+  class Swatch
+    # ? Single Colour's Palette
+    # a function to create an absolute palette that incorporates a single colour input
+    def self.absolute_generator(label, base_colour)
+      @method = UtilityPalettes.configuration.method
+
+      # colours are index inversely to their lightness
+      base_level = UtilityPalettes::Swatch.base_lightness_index(base_colour)
+      generated_absolute_swatches = { UtilityPalettes::Swatch.label(label, base_level) => base_colour }
+
+      # TODO: remove once confident the lower loop is equivalent to these
+      # # Lighter colours
+      # # calc the space available to create lightened colours based off the base colour
+      # if base_level.positive?
+      #   (0..base_level).each do |new_level|
+      #     new_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, new_level)
+      #     generated_absolute_swatches = {}.merge(generated_absolute_swatches, { UtilityPalettes::Swatch.label(label, new_level) => new_colour })
+      #   end
+      # end
+
+      # # Darker colours
+      # # calc the space available to create darkened colours based off the base colour
+      # if base_level < 9
+      #   (base_level..9).each do |new_level|
+      #     new_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, new_level)
+      #     generated_absolute_swatches = {}.merge(generated_absolute_swatches, { UtilityPalettes::Swatch.label(label, new_level) => new_colour })
+      #   end
+      # end
+
+      if base_level.positive?
+        (0..9).each do |new_level|
+          new_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, new_level)
+          generated_absolute_swatches.merge!({ UtilityPalettes::Swatch.label(label, new_level) => new_colour })
+        end
+      end
+
+      generated_absolute_swatches
+    end
+
+    # ? Single Colour's Relative Palette
+    # a function to create a relative palette centred on a single colour input
+    def self.relative_generator(label, base_colour)
+      @method = UtilityPalettes.configuration.method
+
+      lighter_colour = nil
+      darker_colour = nil
+
+      # colours are index inversely to their lightness
+      base_level = UtilityPalettes::Swatch.base_lightness_index(base_colour)
+      generated_relative_swatches = { label => base_colour }
+
+      # Lighter Colour
+      if base_level > 1
+        lighter_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level + 2)
+      elsif base_level.positive?
+        lighter_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level + 1)
+      else
+        lighter_colour = nil
+      end
+
+      # Darker Colour
+      if base_level < 8
+        darker_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level - 2)
+      elsif base_level < 9
+        darker_colour = UtilityPalettes::Swatch.generate(base_colour, base_level, base_level - 1)
+      else
+        darker_colour = nil
+      end
+
+      generated_relative_swatches.merge!({ "#{label}-light" => lighter_colour })
+      generated_relative_swatches.merge!({ "#{label}-dark" => darker_colour })
+
+      generated_relative_swatches
+    end
+
+    def self.base_lightness_index(colour)
+      9 - (colour.hsl[:l] / 10).floor
+    end
+
+    def self.label(label, index)
+      levels = { '0' => 50, '1' => 100, '2' => 200, '3' => 300, '4' => 400, '5' => 500, '6' => 600, '7' => 700, '8' => 800, '9' => 900 }
+
+      [label, levels.dig(index.to_s)].join('-')
+    end
+
+    # TODO: create other sequence methods
+    # ? How to Calculate the next colour in the Palette
+    def self.generate(colour, base_level, new_level)
+      case @method
+      when 'hsl'
+        UtilityPalettes::Sequences.hsl(colour, new_level - base_level)
+      when 'rgb'
+        # TODO
+      else
+        UtilityPalettes::Sequences.hsl(colour, new_level - base_level)
+      end
+    end
+
+    def build_step_check
+      # const ALL_LEVELS = [50, 100, 200, 300, 400, 600, 700, 800, 900];
+      # const levels = options.levels == null ? ALL_LEVELS : options.levels.filter(level => ALL_LEVELS.includes(level));
+    end
+  end
+end

data/lib/utility_palettes/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module UtilityPalettes
-  VERSION = '0.1.1'
-end
+# frozen_string_literal: true
+
+module UtilityPalettes
+  VERSION = '1.0.0'
+end

data/lib/utility_palettes.rb

@@ -1,16 +1,18 @@
-# frozen_string_literal: true
-
-require_relative 'utility_palettes/version'
-
-require_relative 'utility_palettes/configuration'
-require_relative 'utility_palettes/defaults'
-require_relative 'utility_palettes/outputs'
-require_relative 'utility_palettes/palettes'
-require_relative 'utility_palettes/sequences'
-require_relative 'utility_palettes/swatch'
-require_relative 'utility_palettes/validations'
-
-module UtilityPalettes
-  class Error < StandardError; end
-  # Your code goes here...
-end
+# frozen_string_literal: true
+
+require 'json'
+require 'tempfile'
+
+require_relative 'utility_palettes/version'
+
+require_relative 'utility_palettes/configuration'
+require_relative 'utility_palettes/defaults'
+require_relative 'utility_palettes/outputs'
+require_relative 'utility_palettes/palettes'
+require_relative 'utility_palettes/sequences'
+require_relative 'utility_palettes/swatch'
+
+module UtilityPalettes
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: utility_palettes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Louis Davis
 bindir: bin
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2025-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: color_converters
@@ -34,7 +34,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- lib/generators/templates/config/utility_palettes.yml
+- lib/generators/templates/config/utility_palettes.rb
 - lib/generators/utility_palettes/config_generator.rb
 - lib/generators/utility_palettes/generate_generator.rb
 - lib/utility_palettes.rb
@@ -44,7 +44,6 @@ files:
 - lib/utility_palettes/palettes.rb
 - lib/utility_palettes/sequences.rb
 - lib/utility_palettes/swatch.rb
-- lib/utility_palettes/validations.rb
 - lib/utility_palettes/version.rb
 homepage: https://github.com/louiswdavis/utility_palettes
 licenses:

data/lib/generators/templates/config/utility_palettes.yml

@@ -1,36 +0,0 @@
-development:
-  utility_palettes:
-    defaults:
-      absolutes: true
-      relatives: true
-      singles: true
-    output:
-      dated: false
-      files: 'json, scss, css'
-      format: 'hex'
-      prefix: ''
-      suffix: ''
-    method: 'hsl'
-    steps:
-      h: 0
-      s: 3
-      l: 8
-    absolutes:
-      teal: '#2cb1bc'
-      orange: '#e35f00'
-      green: '#28b840'
-      purple: '#4f3bbf'
-    relatives:
-      success: '#28b840'
-      information: '#2cb1bc'
-    singles:
-      grey-50: '#fafafa'
-      grey-100: '#f5f5f5'
-      grey-200: '#e5e5e5'
-      grey-300: '#d4d4d4'
-      grey-400: '#a3a3a3'
-      grey-500: '#737373'
-      grey-600: '#525252'
-      grey-700: '#404040'
-      grey-800: '#262626'
-      grey-900: '#171717'

data/lib/utility_palettes/validations.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module UtilityPalettes
-  class Validations
-    def self.validate_config(config)
-      sequence_options = ['hsl']
-      warn "ERROR: The colour sequence method you have submitted to Utility Palettes < #{config[:steps]} > is not available (#{sequence_options.to_sentence})" if !config[:method].nil? && !config[:method].to_s.in?(sequence_options)
-
-      warn "ERROR: The colour sequence steps you have submitted to Utility Palettes < #{config[:steps]} > have not been formatted as a hash" if !config[:steps].nil? && !config[:steps].is_a?(Hash)
-
-      warn "ERROR: The absolute swatches you have submitted to Utility Palettes < #{config[:absolutes]} > have not been formatted as a hash" if !config[:absolutes].nil? && !config[:absolutes].is_a?(Hash)
-
-      warn "ERROR: The relative swatches you have submitted to Utility Palettes < #{config[:relatives]} > have not been formatted as a hash" if !config[:relatives].nil? && !config[:relatives].is_a?(Hash)
-
-      warn "ERROR: The single swatches you have submitted to Utility Palettes < #{config[:singles]} > have not been formatted as a hash" if !config[:singles].nil? && !config[:singles].is_a?(Hash)
-
-      config_keys = config.keys - [:defaults, :output, :method, :steps, :absolutes, :relatives, :singles, :disabled]
-
-      warn "WARNING: Utility Palettes does not recognize the following keys; #{config_keys.join(', ')}. Please check they match the spelling of documented palette keys in order for them to be used." if config_keys.present?
-
-      true
-    end
-  end
-end