utility_palettes 0.1.0 → 1.0.0

data/lib/utility_palettes/defaults.rb

@@ -1,46 +1,48 @@
-# frozen_string_literal: true
-
-module UtilityPalettes
-  class Defaults
-    def self.absolutes
-      {
-        'red' => 'hsl(2, 78%, 64%)',
-        'rust' => 'hsl(16, 82%, 62%)',
-        'orange' => 'hsl(31, 90%, 65%)',
-        'gold' => 'hsl(46, 93%, 54%)',
-        'yellow' => 'hsl(58, 87%, 55%)',
-        'pear' => 'hsl(80, 74%, 57%)',
-        'green' => 'hsl(110, 69%, 58%)',
-        'seaside' => 'hsl(156, 78%, 57%)',
-        'cyan' => 'hsl(180, 69%, 37%)',
-        'capri' => 'hsl(197, 90%, 46%)',
-        'blue' => 'hsl(214, 78%, 36%)',
-        'iris' => 'hsl(265, 87%, 57%)',
-        'purple' => 'hsl(279, 85%, 56%)',
-        'magenta' => 'hsl(300, 64%, 66%)',
-        'pink' => 'hsl(320, 74%, 66%)',
-        'satin' => 'hsl(348, 74%, 57%)',
-        'cement' => 'hsl(42, 6%, 87%)',
-        'grey' => 'hsl(0, 3%, 46%)',
-        'base' => 'hsl(0, 3%, 46%)'
-      }
-    end
-
-    def self.relatives
-      {
-        'success' => 'hsl(110, 69%, 58%)',
-        'danger' => 'hsl(2, 78%, 64%)',
-        'information' => 'hsl(214, 78%, 36%)',
-        'warning' => 'hsl(46, 93%, 54%)'
-      }
-    end
-
-    def self.singles
-      {
-        'white' => '#fff',
-        'black' => '#000',
-        'translucent' => 'rgba(0, 0, 0, 0.45)'
-      }
-    end
-  end
-end
+# frozen_string_literal: true
+
+module UtilityPalettes
+  class Defaults
+    def self.absolutes
+      {
+        'red' => 'hsl(2, 78%, 64%)',
+        'rust' => 'hsl(16, 82%, 62%)',
+        'orange' => 'hsl(31, 90%, 65%)',
+        'gold' => 'hsl(46, 93%, 54%)',
+        'yellow' => 'hsl(58, 87%, 55%)',
+        'pear' => 'hsl(80, 74%, 57%)',
+        'green' => 'hsl(110, 69%, 58%)',
+        'seaside' => 'hsl(156, 78%, 57%)',
+        'cyan' => 'hsl(180, 69%, 37%)',
+        'capri' => 'hsl(197, 90%, 46%)',
+        'blue' => 'hsl(214, 78%, 36%)',
+        'iris' => 'hsl(265, 87%, 57%)',
+        'purple' => 'hsl(279, 85%, 56%)',
+        'magenta' => 'hsl(300, 64%, 66%)',
+        'pink' => 'hsl(320, 74%, 66%)',
+        'satin' => 'hsl(348, 74%, 57%)',
+        'cement' => 'hsl(42, 6%, 87%)',
+        'grey' => 'hsl(0, 3%, 46%)',
+        'base' => 'hsl(0, 3%, 46%)'
+      }
+    end
+
+    def self.relatives
+      {
+        'success' => 'hsl(110, 69%, 58%)',
+        'danger' => 'hsl(2, 78%, 64%)',
+        'information' => 'hsl(214, 78%, 36%)',
+        'warning' => 'hsl(46, 93%, 54%)'
+      }
+    end
+
+    def self.singles
+      {
+        'white' => '#fff',
+        'black' => '#000',
+        'translucent' => 'rgba(0, 0, 0, 0.45)'
+      }
+    end
+
+    # TODO: add tailwind v4 absolutes
+  end
+end

data/lib/utility_palettes/outputs.rb

@@ -1,122 +1,122 @@
-# frozen_string_literal: true
-
-module UtilityPalettes
-  class Outputs
-    def self.generate(generated_palettes, config)
-      output_format = config.dig(:output, :format).to_s.downcase.presence
-      output_palettes = {}
-
-      generated_palettes.each do |label, colourize_colour|
-        case output_format
-        when 'rgb'
-          values = colourize_colour.rgb.values
-        when 'hsl'
-          values = colourize_colour.hsl.values
-          values[1] = self.append_percentage(values[1])
-          values[2] = self.append_percentage(values[2])
-        when 'hsv'
-          values = colourize_colour.hsv.values
-          values[1] = self.append_percentage(values[1])
-          values[2] = self.append_percentage(values[2])
-        when 'hsb'
-          values = colourize_colour.hsb.values
-          values[1] = self.append_percentage(values[1])
-          values[2] = self.append_percentage(values[2])
-        when 'cmyk'
-          values = colourize_colour.cmyk.values
-          values[1] = self.append_percentage(values[1])
-          values[2] = self.append_percentage(values[2])
-          values[3] = self.append_percentage(values[3])
-          output_format = 'device-cmyk'
-        when 'cielab', 'lab'
-          values = colourize_colour.cielab.values
-          values[0] = self.append_percentage(values[0])
-          output_format = 'lab'
-        when 'cielch', 'lch'
-          values = colourize_colour.cielch.values
-          values[0] = self.append_percentage(values[0])
-          output_format = 'lch'
-        when 'hex'
-          values = colourize_colour.hex
-        else
-          values = colourize_colour.rgb.values
-          output_format = 'rgb'
-        end
-
-        case output_format
-        when 'hex'
-          values += (colourize_colour.alpha * 255).round.to_s(16).slice(0, 2).upcase if colourize_colour.alpha < 1.0
-          output_palettes[label] = values
-        else
-          values << self.append_alpha(colourize_colour.alpha) if colourize_colour.alpha < 1.0
-          output_palettes[label] = "#{output_format}(#{values.join(' ')})"
-        end
-      end
-
-      output_palettes
-    end
-
-    def self.json(filename, output_palettes)
-      file = Tempfile.new([filename, '.json'])
-
-      File.open(file, 'w') do |f|
-        f.write(JSON.pretty_generate(output_palettes))
-      end
-
-      puts 'Exporting utility palettes JSON...'
-      file
-    end
-
-    def self.scss(filename, output_palettes)
-      file = Tempfile.new([filename, '.scss'])
-
-      File.open(file, 'w') do |f|
-        f.write(output_palettes.collect { |label, hex| "$#{label}: #{hex};" }.join("\n"))
-      end
-
-      puts 'Exporting utility palettes SCSS...'
-      file
-    end
-
-    def self.css(filename, output_palettes)
-      file = Tempfile.new([filename, '.css'])
-
-      File.open(file, 'w') do |f|
-        f.write(":root {\n\t#{output_palettes.collect { |label, hex| "--#{label}: #{hex};" }.join("\n\t")}\n}")
-      end
-
-      puts 'Exporting utility palettes CSS...'
-      file
-    end
-
-    def bespoke_property_variables
-      # const utilities = {
-      #   bg: (value) => ({ 'background-color': value }),
-      #   text: (value) => ({ 'color': value }),
-      #   border: (value) => ({ 'border-color': value }),
-      #   'border-t': (value) => ({ '--tw-border-opacity': 1, 'border-top-color': value }),
-      #   'border-r': (value) => ({ '--tw-border-opacity': 1, 'border-right-color': value }),
-      #   'border-b': (value) => ({ '--tw-border-opacity': 1, 'border-bottom-color': value }),
-      #   'border-l': (value) => ({ '--tw-border-opacity': 1, 'border-left-color': value }),
-      #   outline: (value) => ({ 'outline-color': value }),
-      #   ring: (value) => ({ '--tw-ring-opacity': 1, '--tw-ring-color': value }),
-      #   'ring-offset': (value) => ({ '--tw-ring-offset-color': value }),
-      #   'shadow': (value) => ({ '--tw-shadow-color': value, '--tw-shadow': 'var(--tw-shadow-colored)' }),
-      #   accent: (value) => ({ 'accent-color': value }),
-      #   caret: (value) => ({ 'caret-color': value }),
-      #   fill: (value) => ({ 'fill': value }),
-      #   stroke: (value) => ({ 'stroke': value }),
-      # };
-    end
-
-    private
-
-    def self.append_percentage(value)
-      "#{value}%"
-    end
-
-    def self.append_alpha(alpha)
-      "/ #{alpha * 100}"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module UtilityPalettes
+  class Outputs
+    def self.generate(generated_palettes)
+      output_format = UtilityPalettes.configuration.output_format.to_s.downcase.presence
+      output_palettes = {}
+
+      generated_palettes.each do |label, colourize_colour|
+        case output_format
+        when 'rgb'
+          values = colourize_colour.rgb.values
+        when 'hsl'
+          values = colourize_colour.hsl.values
+          values[1] = self.append_percentage(values[1])
+          values[2] = self.append_percentage(values[2])
+        when 'hsv'
+          values = colourize_colour.hsv.values
+          values[1] = self.append_percentage(values[1])
+          values[2] = self.append_percentage(values[2])
+        when 'hsb'
+          values = colourize_colour.hsb.values
+          values[1] = self.append_percentage(values[1])
+          values[2] = self.append_percentage(values[2])
+        when 'cmyk'
+          values = colourize_colour.cmyk.values
+          values[1] = self.append_percentage(values[1])
+          values[2] = self.append_percentage(values[2])
+          values[3] = self.append_percentage(values[3])
+          output_format = 'device-cmyk'
+        when 'cielab', 'lab'
+          values = colourize_colour.cielab.values
+          values[0] = self.append_percentage(values[0])
+          output_format = 'lab'
+        when 'cielch', 'lch'
+          values = colourize_colour.cielch.values
+          values[0] = self.append_percentage(values[0])
+          output_format = 'lch'
+        when 'hex'
+          values = colourize_colour.hex
+        else
+          values = colourize_colour.rgb.values
+          output_format = 'rgb'
+        end
+
+        case output_format
+        when 'hex'
+          values += (colourize_colour.alpha * 255).round.to_s(16).slice(0, 2).upcase if colourize_colour.alpha < 1.0
+          output_palettes[label] = values
+        else
+          values << self.append_alpha(colourize_colour.alpha) if colourize_colour.alpha < 1.0
+          output_palettes[label] = "#{output_format}(#{values.join(' ')})"
+        end
+      end
+
+      output_palettes
+    end
+
+    def self.json(filename, output_palettes)
+      file = Tempfile.new([filename, '.json'])
+
+      File.open(file, 'w') do |f|
+        f.write(JSON.pretty_generate(output_palettes))
+      end
+
+      puts 'Exporting utility palettes JSON...'
+      file
+    end
+
+    def self.scss(filename, output_palettes)
+      file = Tempfile.new([filename, '.scss'])
+
+      File.open(file, 'w') do |f|
+        f.write(output_palettes.collect { |label, hex| "$#{label}: #{hex};" }.join("\n"))
+      end
+
+      puts 'Exporting utility palettes SCSS...'
+      file
+    end
+
+    def self.css(filename, output_palettes)
+      file = Tempfile.new([filename, '.css'])
+
+      File.open(file, 'w') do |f|
+        f.write(":root {\n\t#{output_palettes.collect { |label, hex| "--#{label}: #{hex};" }.join("\n\t")}\n}")
+      end
+
+      puts 'Exporting utility palettes CSS...'
+      file
+    end
+
+    def bespoke_property_variables
+      # const utilities = {
+      #   bg: (value) => ({ 'background-color': value }),
+      #   text: (value) => ({ 'color': value }),
+      #   border: (value) => ({ 'border-color': value }),
+      #   'border-t': (value) => ({ '--tw-border-opacity': 1, 'border-top-color': value }),
+      #   'border-r': (value) => ({ '--tw-border-opacity': 1, 'border-right-color': value }),
+      #   'border-b': (value) => ({ '--tw-border-opacity': 1, 'border-bottom-color': value }),
+      #   'border-l': (value) => ({ '--tw-border-opacity': 1, 'border-left-color': value }),
+      #   outline: (value) => ({ 'outline-color': value }),
+      #   ring: (value) => ({ '--tw-ring-opacity': 1, '--tw-ring-color': value }),
+      #   'ring-offset': (value) => ({ '--tw-ring-offset-color': value }),
+      #   'shadow': (value) => ({ '--tw-shadow-color': value, '--tw-shadow': 'var(--tw-shadow-colored)' }),
+      #   accent: (value) => ({ 'accent-color': value }),
+      #   caret: (value) => ({ 'caret-color': value }),
+      #   fill: (value) => ({ 'fill': value }),
+      #   stroke: (value) => ({ 'stroke': value }),
+      # };
+    end
+
+    private
+
+    def self.append_percentage(value)
+      "#{value}%"
+    end
+
+    def self.append_alpha(alpha)
+      "/ #{alpha * 100}"
+    end
+  end
+end

data/lib/utility_palettes/palettes.rb

@@ -1,133 +1,128 @@
-# frozen_string_literal: true
-
-module UtilityPalettes
-  class Palettes
-    def self.generate(config)
-      @config = config
-
-      puts 'Generating utility palettes...'
-
-      UtilityPalettes::Validations.validate_config(@config)
-      @increment_steppers = UtilityPalettes::Configuration.setup(@config)
-
-      puts 'Retrieved configuration...'
-
-      default_absolutes = @config.dig(:defaults, :absolutes) == false ? [] : UtilityPalettes::Defaults.absolutes
-      default_relatives = @config.dig(:defaults, :relatives) == false ? [] : UtilityPalettes::Defaults.relatives
-      default_singles = @config.dig(:defaults, :singles) == false ? [] : UtilityPalettes::Defaults.singles
-
-      puts 'Defined default palettes...'
-
-      user_absolutes = @config.dig(:absolutes) || {}
-      user_relatives = @config.dig(:relatives) || {}
-      user_singles = @config.dig(:singles) || {}
-
-      puts 'Retrieved user palettes...'
-
-      # merging should mean any user colours will overwrite default colours with the same key names
-      combined_absolutes = default_absolutes.merge(user_absolutes)
-      combined_relatives = default_relatives.merge(user_relatives)
-      combined_singles = {}.merge(default_absolutes, user_absolutes, default_singles, user_singles)
-
-      @combined_samples = combined_absolutes.merge(combined_relatives).merge(combined_singles)
-
-      puts 'Merged palettes...'
-
-      converted_absolutes = self.colourize_values(combined_absolutes)
-      converted_relatives = self.colourize_values(combined_relatives)
-      converted_singles = self.colourize_values(combined_singles)
-
-      puts 'Converted palettes...'
-
-      generated_absolutes = self.palette_looper(converted_absolutes, 'absolutes')
-      generated_relatives = self.palette_looper(converted_relatives, 'relatives')
-      generated_singles = converted_singles
-
-      puts 'Generated utility palettes...'
-
-      generated_palettes = {}.merge(generated_absolutes, generated_relatives, generated_singles)
-      generated_palettes = self.format_palette(generated_palettes)
-      output_palettes = UtilityPalettes::Outputs.generate(generated_palettes, @config)
-
-      filename = 'utility_palettes'
-      filename += "-#{Time.zone.now.strftime('%Y%m%d-%H%M%S')}" if @config.dig(:output, :dated) == true
-
-      output_files = (@config.dig(:output, :files) || '').split(',').map(&:strip)
-
-      file = nil
-      file = UtilityPalettes::Outputs.json(filename, output_palettes) if output_files.blank? || output_files.include?('json')
-      File.rename(file.path, "#{filename}.json") if file.present?
-      
-      file = nil
-      file = UtilityPalettes::Outputs.scss(filename, output_palettes) if output_files.include?('scss')
-      File.rename(file.path, "app/assets/stylesheets/#{filename}.scss") if file.present?
-
-      file = nil
-      file = UtilityPalettes::Outputs.css(filename, output_palettes) if output_files.include?('css')
-      File.rename(file.path, "app/assets/stylesheets/#{filename}.css") if file.present?
-
-      true
-    end
-
-    private
-
-    def self.colourize_values(colour_hash)
-      colourized_hash = {}
-
-      colour_hash.each do |label, colour|
-        begin
-          if colour.start_with?('$')
-            # if the colour label begins with $ then it is a reference to a different defined colour, so must be looked up in the main
-            colourized_hash[label] = ColorConverters::Color.new(@combined_samples.dig(colour[1..].to_sym))
-          else
-            colourized_hash[label] = ColorConverters::Color.new(colour)
-          end
-
-          # TODO
-          # provide a name if the label is left blank
-          # if label.to_s == '$blank'
-          #   hash[colourized_hash[label].name] = hash.delete(label)
-          #   puts "Blank colour #{colour} has been given the name: #{colourized_hash[label].name}"
-          # end
-        rescue ColorConverters::InvalidColorError => e
-          warn "Error processing colour #{label} with value #{colour}: #{e.message}"
-        end
-      end
-
-      colourized_hash
-    end
-
-    # * Palettes
-
-    # ? Multiple Colour's Palette
-    # a function to loop through a map of colours and create absolute or relative palettes for them all and collect this into a single map
-
-    def self.palette_looper(colour_map, method)
-      looped_generated_palettes = {}
-
-      colour_map.each do |label, base_colour|
-        # create a palette for a single colour from the providing mapping
-        if method == 'absolutes'
-          generated_swatches = UtilityPalettes::Swatch.absolute_generator(label, base_colour, @config.dig(:method), @increment_steppers)
-        elsif method == 'relatives'
-          generated_swatches = UtilityPalettes::Swatch.relative_generator(label, base_colour, @config.dig(:method), @increment_steppers)
-        end
-
-        # merge the colours absolute palette into the collective mapping
-        looped_generated_palettes = {}.merge(looped_generated_palettes, generated_swatches)
-      end
-
-      looped_generated_palettes
-    end
-
-    def self.format_palette(palettes)
-      palettes.compact_blank!
-
-      palettes.transform_keys!(&:to_s)
-      palettes.transform_keys! { |key| @config.dig(:output, :prefix) + key } if @config.dig(:output, :prefix).present?
-      palettes.transform_keys! { |key| key + @config.dig(:output, :suffix) } if @config.dig(:output, :suffix).present?
-
-      palettes
-    end
-  end
-end
+# frozen_string_literal: true
+
+module UtilityPalettes
+  class Palettes
+    def self.generate
+      configuration = UtilityPalettes.configuration
+
+      puts 'Generating utility palettes...'
+
+      default_absolutes = configuration.use_default_absolutes == true ? UtilityPalettes::Defaults.absolutes : {}
+      default_relatives = configuration.use_default_relatives == true ? UtilityPalettes::Defaults.relatives : {}
+      default_singles = configuration.use_default_singles == true ? UtilityPalettes::Defaults.singles : {}
+
+      puts 'Defined default palettes...'
+
+      user_absolutes = configuration.absolutes
+      user_relatives = configuration.relatives
+      user_singles = configuration.singles
+
+      puts 'Retrieved user palettes...'
+
+      # merging should mean any user colours will overwrite default colours with the same key names
+      combined_absolutes = default_absolutes.merge(user_absolutes)
+      combined_relatives = default_relatives.merge(user_relatives)
+      combined_singles = {}.merge(default_absolutes, user_absolutes, default_singles, user_singles)
+
+      @combined_samples = combined_absolutes.merge(combined_relatives).merge(combined_singles)
+
+      puts 'Merged palettes...'
+
+      converted_absolutes = self.colourize_values(combined_absolutes)
+      converted_relatives = self.colourize_values(combined_relatives)
+      converted_singles = self.colourize_values(combined_singles)
+
+      puts 'Converted palettes...'
+
+      generated_absolutes = self.palette_looper(converted_absolutes, 'absolutes')
+      generated_relatives = self.palette_looper(converted_relatives, 'relatives')
+      generated_singles = converted_singles
+
+      puts 'Generated utility palettes...'
+
+      generated_palettes = {}.merge(generated_absolutes, generated_relatives, generated_singles)
+      generated_palettes = self.format_palette(generated_palettes)
+      output_palettes = UtilityPalettes::Outputs.generate(generated_palettes)
+
+      filename = 'utility_palettes'
+      filename += "-#{Time.zone.now.strftime('%Y%m%d-%H%M%S')}" if configuration.output_dated == true
+
+      output_files = configuration.output_files.map(&:strip)
+
+      file = nil
+      file = UtilityPalettes::Outputs.json(filename, output_palettes) if output_files.include?('json')
+      File.rename(file.path, "#{filename}.json") if file.present?
+
+      file = nil
+      file = UtilityPalettes::Outputs.scss(filename, output_palettes) if output_files.include?('scss')
+      File.rename(file.path, "app/assets/stylesheets/#{filename}.scss") if file.present?
+
+      file = nil
+      file = UtilityPalettes::Outputs.css(filename, output_palettes) if output_files.include?('css')
+      File.rename(file.path, "app/assets/stylesheets/#{filename}.css") if file.present?
+
+      true
+    end
+
+    private
+
+    def self.colourize_values(basic_hash)
+      colourized_hash = {}
+
+      basic_hash.each do |label, colour|
+        begin
+          if colour.is_a?(String) && colour.start_with?('$')
+            # if the colour label begins with $ then it is a reference to a different defined colour, so must be looked up in the main
+            colourized_hash[label] = ColorConverters::Color.new(@combined_samples.dig(colour.slice(1..-1).to_sym))
+          else
+            colourized_hash[label] = ColorConverters::Color.new(colour)
+          end
+
+          # TODO
+          # provide a name if the label is left blank
+          # if label.to_s == '$blank'
+          #   hash[colourized_hash[label].name] = hash.delete(label)
+          #   puts "Blank colour #{colour} has been given the name: #{colourized_hash[label].name}"
+          # end
+        rescue ColorConverters::InvalidColorError => e
+          warn "Error processing colour #{label} with value #{colour}: #{e.message}"
+        end
+      end
+
+      colourized_hash
+    end
+
+    # * Palettes
+
+    # ? Multiple Colour's Palette
+    # a function to loop through a map of colours and create absolute or relative palettes for them all and collect this into a single map
+
+    def self.palette_looper(colourized_hash, palette_type)
+      looped_generated_palettes = {}
+
+      colourized_hash.each do |label, base_colour|
+        # create a palette for a single colour from the providing mapping
+        if palette_type == 'absolutes'
+          generated_swatches = UtilityPalettes::Swatch.absolute_generator(label, base_colour)
+        elsif palette_type == 'relatives'
+          generated_swatches = UtilityPalettes::Swatch.relative_generator(label, base_colour)
+        end
+
+        # merge the colours absolute palette into the collective mapping
+        looped_generated_palettes.merge!(generated_swatches)
+      end
+
+      looped_generated_palettes
+    end
+
+    def self.format_palette(generated_hash)
+      configuration = UtilityPalettes.configuration
+
+      generated_hash.transform_keys!(&:to_s)
+      generated_hash.transform_keys! { |key| configuration.output_prefix + key } if configuration.output_prefix.present?
+      generated_hash.transform_keys! { |key| key + configuration.output_suffix } if configuration.output_suffix.present?
+
+      generated_hash
+    end
+  end
+end