utility_palettes 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f92d00ec4bd6d39c2ff8c063ee872df11c97e4cd6f35bcef13f3e2384bd5b4e0
-  data.tar.gz: bd9a68478305db2c062a1eaa55241ac07f580531199a2f8a2225a6e6c65b68ae
+  metadata.gz: 4dd0760b2f72cc78a687afcbf878d4e88a936cc4503bba60d46c73e1df21467c
+  data.tar.gz: a85e503c4b282647c6001446950e58ebcf32bef6549e0f68a8e226264fb8e14f
 SHA512:
-  metadata.gz: b78ff43e849a7bb275d46ee96bbf26462ca6a1ef62739482168cfb162bca577a4f5a937f3b120d7abaaba1ba7f94a4535f58bb4782c7a9a67d9c59aa5a2b33d0
-  data.tar.gz: 94a65dbd6eea0880b16ff285168046a602a1612a1ceb18133098708809cec13d094f0c4f525ed52e54c3545d0cb92a939c566bd203eb887b117bd7ccf754e539
+  metadata.gz: 4c5569c8bc1bc5eb3eb2916dd45b29fc211eb4bae211c10d7aeae20c933e79b7efc4dc9e0af27a6654ecc256890645758949c66424f46573df18f1e4f3003aff
+  data.tar.gz: ff3a66f8ed5839f3b25608ecf6836aaeae7ba99ae02bd67dccfb3b2f2797a5f5d3f98456d557ac22efbe521fb4769e67fdd59cebaf2c5a09a51913629ad96ff8

data/README.md

@@ -1,5 +1,8 @@
 # UtilityPalettes
 
+![Static Badge](https://img.shields.io/badge/Gem_Version-1.0.1-blue)
+[![Static Badge](https://img.shields.io/badge/RubyGems-red)](https://rubygems.org/gems/utility_palettes)
+
 > Generate your own colour palettes in an instance.
 
 Utility Palettes is an ruby gem package for use in ruby or other projects that generates palettes and shades based on supplied colours.
@@ -22,13 +25,13 @@ gem install utility_palettes
 
 ## Usage
 
-To get the config full of
+To get the config file:
 
 ```bash
 rails generate utility_palettes:config
 ```
 
-to generate the palettes
+To generate the palettes:
 
 ```bash
 rails generate utility_palettes:generate
@@ -63,15 +66,14 @@ Should the default colours be included for the palette generator. Even if they a
 
 How the output file and values should be written:
 
-| Option        | Description                                                                             | Default  | Value Type | Possible Values                                         |
-| :------------ | :-------------------------------------------------------------------------------------- | :-----:  | :--------: | :-----------------------------------------------------: |
-| ouput_dated   | Should a timestamp be included in the filenames                                         | false    | Boolean    | true / false                                            |
-| ouput_files   | The types of files the palette should be output in                                      | ['json'] | Array      | json, scss, css                                         |
-| ouput_format  | The colour syntax the output colours should be written in                               | hex      | String     | rgb, hsl, hsv, hsb, cmyk, cielab, lab, cielch, lch, hex |
-| ouput_prefix  | A string that is appended to the start of all colour names, i.e. 'tw-'                  | nil      | String     | <any string>                                            |
-| ouput_suffix  | A string that is appended to the end of all colour names, i.e. '-col'                   | nil      | String     | <any string>                                            |
-
-The JSON output file will appear at the top-level of your project, while SCSS and CSS are defined to go to `app/assets/stylesheets`.
+| Option         | Description                                                                       | Default            | Value Type | Possible Values                                         |
+| :------------  | :-------------------------------------------------------------------------------- | :----------------: | :--------: | :-----------------------------------------------------: |
+| ouput_filename | Where the file should be output to including filename, without the file extension | 'utility_palettes' | String     | <any filepath string>                                   |
+| ouput_dated    | Should a timestamp be included in the filenames                                   | false              | Boolean    | true / false                                            |
+| ouput_files    | The types of files the palette should be output in                                | ['scss']           | Array      | json, scss, css                                         |
+| ouput_format   | The colour syntax the output colours should be written in                         | hex                | String     | rgb, hsl, hsv, hsb, cmyk, cielab, lab, cielch, lch, hex |
+| ouput_prefix   | A string that is appended to the start of all colour names, i.e. 'up-'            | nil                | String     | <any string>                                            |
+| ouput_suffix   | A string that is appended to the end of all colour names, i.e. '-col'             | nil                | String     | <any string>                                            |
 
 ### Method (WIP)
 

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

@@ -10,8 +10,9 @@ UtilityPalettes.configure do |config|
   # config.default_singles = true
 
   # Output
+  # config.output_filename = 'utility_palettes'
   # config.output_dated = false
-  # config.output_files = ['json']
+  # config.output_files = ['scss']
   # config.output_format = 'hex'
   # config.output_prefix = nil
   # config.output_suffix = nil

data/lib/utility_palettes/configuration.rb

@@ -4,7 +4,7 @@ module UtilityPalettes
   class Configuration
     attr_accessor :enable_environments,
                   :use_default_absolutes, :use_default_relatives, :use_default_singles,
-                  :output_dated, :output_files, :output_format, :output_prefix, :output_suffix,
+                  :output_filename, :output_dated, :output_files, :output_format, :output_prefix, :output_suffix,
                   :method, :steps_h, :steps_s, :steps_l, :steps_r, :steps_g, :steps_b,
                   :absolutes, :relatives, :singles
 
@@ -18,8 +18,9 @@ module UtilityPalettes
       @use_default_singles = true
 
       # Output
+      @output_filename = 'utility_palettes'
       @output_dated = false
-      @output_files = ['json']
+      @output_files = ['scss']
       @output_format = 'hex'
       @output_prefix = ''
       @output_suffix = ''

data/lib/utility_palettes/outputs.rb

@@ -53,40 +53,44 @@ module UtilityPalettes
         end
       end
 
-      output_palettes
+      # TODO: sort by non-ASCII so that -50 is before -100 -> `naturally` gem
+      output_palettes.sort.to_h
     end
 
     def self.json(filename, output_palettes)
-      file = Tempfile.new([filename, '.json'])
+      content = JSON.pretty_generate(output_palettes)
+      filepath = "#{filename}.json"
 
-      File.open(file, 'w') do |f|
-        f.write(JSON.pretty_generate(output_palettes))
-      end
+      # Create directory if it doesn't exist
+      FileUtils.mkdir_p(File.dirname(filepath))
+      File.write(filepath, content)
 
       puts 'Exporting utility palettes JSON...'
-      file
+      true
     end
 
     def self.scss(filename, output_palettes)
-      file = Tempfile.new([filename, '.scss'])
+      content = output_palettes.collect { |label, hex| "$#{label}: #{hex};" }.join("\n")
+      filepath = "#{filename}.scss"
 
-      File.open(file, 'w') do |f|
-        f.write(output_palettes.collect { |label, hex| "$#{label}: #{hex};" }.join("\n"))
-      end
+      # Create directory if it doesn't exist
+      FileUtils.mkdir_p(File.dirname(filepath))
+      File.write(filepath, content)
 
       puts 'Exporting utility palettes SCSS...'
-      file
+      true
     end
 
     def self.css(filename, output_palettes)
-      file = Tempfile.new([filename, '.css'])
+      content = ":root {\n\t#{output_palettes.collect { |label, hex| "--#{label}: #{hex};" }.join("\n\t")}\n}"
+      filepath = "#{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
+      # Create directory if it doesn't exist
+      FileUtils.mkdir_p(File.dirname(filepath))
+      File.write(filepath, content)
 
       puts 'Exporting utility palettes CSS...'
-      file
+      true
     end
 
     def bespoke_property_variables

data/lib/utility_palettes/palettes.rb

@@ -44,22 +44,14 @@ module UtilityPalettes
       generated_palettes = self.format_palette(generated_palettes)
       output_palettes = UtilityPalettes::Outputs.generate(generated_palettes)
 
-      filename = 'utility_palettes'
+      filename = configuration.output_filename
       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?
+      UtilityPalettes::Outputs.json(filename, output_palettes) if output_files.include?('json')
+      UtilityPalettes::Outputs.scss(filename, output_palettes) if output_files.include?('scss')
+      UtilityPalettes::Outputs.css(filename, output_palettes) if output_files.include?('css')
 
       true
     end

data/lib/utility_palettes/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: utility_palettes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Louis Davis
 bindir: bin
 cert_chain: []
-date: 2025-09-02 00:00:00.000000000 Z
+date: 2025-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: color_converters
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Create broad colour palettes based on specific colour swatches, or more
   specific light/dark variant palettes. Be in control of the colours you use and shorten
   the iterative process when deciding on how to build your palettes.