utility_colors 0.1.8 → 1.0.0

data/lib/utility_colors/configuration.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module UtilityColors
+  class Configuration
+    attr_accessor :enable_environments,
+                  :import_palettes_filepath,
+                  :output_filename, :output_dated, :output_files, :output_prefix, :output_suffix,
+                  :regular_classes, :breakpoint_classes, :pseudo_classes, :breakpoint_pseudo_classes # :utility_palettes_configuration
+
+    def initialize
+      # Enabled Environments
+      @enable_environments = [:development]
+
+      # Use Existing Utility Palettes Result
+      @import_palettes_filepath = 'utility_palettes.scss'
+
+      # Output
+      @output_filename = 'utility_colors'
+      @output_dated = false
+      @output_files = ['scss']
+      @output_prefix = nil
+      @output_suffix = nil
+
+      # Build Other Class Types
+      @regular_classes = true
+      @breakpoint_classes = false
+      @pseudo_classes = false
+      @breakpoint_pseudo_classes = false
+
+      # Configuration instance for UtilityPalettes
+      # @utility_palettes_configuration = UtilityPalettes::Configuration.new
+    end
+
+    def reset!
+      initialize
+    end
+
+    # Nested configuration method for UtilityPalettes
+    def configure_utility_palettes
+      # yield(@utility_palettes_configuration) if block_given?
+    end
+
+    def validate_settings
+      # Validate UtilityPalettes configuration
+      # return false unless @utility_palettes_configuration.validate_settings
+
+      # Add any additional validations specific to UtilityColors
+      true
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/utility_colors/exports.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module UtilityColors
+  class Exports
+    def self.json(filename, output_classes)
+      # TODO: determine if they imported scss or css and return the variables keys in that way
+      # TODO: determine if the style value should use a syntax variable or be converted to hardcoded value
+      content = JSON.pretty_generate(output_classes.transform_values { |class_content| class_content.gsub('£$', '$').gsub('$£', '') })
+      filepath = "#{filename}.json"
+
+      # Create directory if it doesn't exist
+      FileUtils.mkdir_p(File.dirname(filepath))
+      File.write(filepath, content)
+
+      puts 'Exporting utility colour classes JSON...'
+      true
+    end
+
+    def self.scss(filename, output_classes)
+      # TODO: determine if the style value should use the syntax variable or be converted to hardcoded value
+      content = output_classes.collect { |class_name, class_content| "#{class_name} {\n\t#{class_content.gsub('£$', '$').gsub('$£', '')}\n}" }.join("\n\n")
+      filepath = "#{filename}.scss"
+
+      # Create directory if it doesn't exist
+      FileUtils.mkdir_p(File.dirname(filepath))
+      File.write(filepath, content)
+
+      puts 'Exporting utility colour classes SCSS...'
+      true
+    end
+
+    def self.css(filename, output_classes)
+      # TODO: add root for variables at top? Leave for now as this is all based off a palette file where they should exist (easy copy and paste for devs)
+      # TODO: determine if the style value should use the syntax variable or be converted to hardcoded value
+      content = output_classes.collect { |class_name, class_content| "#{class_name} {\n\t#{class_content.gsub('£$', 'var(--').gsub('$£', ')')}\n}" }.join("\n\n")
+      filepath = "#{filename}.css"
+
+      # Create directory if it doesn't exist
+      FileUtils.mkdir_p(File.dirname(filepath))
+      File.write(filepath, content)
+
+      puts 'Exporting utility colour classes CSS...'
+      true
+    end
+
+    def self.append_percentage(value)
+      "#{value}%"
+    end
+
+    def self.append_alpha(alpha)
+      "/ #{alpha * 100}"
+    end
+  end
+end

data/lib/utility_colors/imports.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module UtilityColors
+  class Imports
+    def self.import
+      import_path = UtilityColors.configuration.import_palettes_filepath
+
+      if import_path.present? && File.file?(import_path)
+        case File.extname(import_path)
+        when '.json'
+          UtilityColors::Imports.json(import_path)
+        when '.scss'
+          UtilityColors::Imports.scss(import_path)
+        when '.css'
+          UtilityColors::Imports.css(import_path)
+        else
+          warn 'WARNING: Palette file could not be imported as it is not JSON, SCSS, or CSS.'
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    private
+
+    def self.json(import_path)
+      # expecting a normal json hash of name and value
+      JSON.parse(File.read(import_path))
+    end
+
+    def self.scss(import_path)
+      # expecting a normal scss file of variables
+      File.read(import_path).scan(/\$([^:]+):\s*([^;]+);/).to_h
+    end
+
+    def self.css(import_path)
+      # expecting a normal css file of variables
+      File.read(import_path).scan(/--([^:]+):\s*([^;]+);/).to_h
+    end
+  end
+end

data/lib/utility_colors/properties.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module UtilityColors
+  class Properties
+    def self.get_property(*keys)
+      keys = [keys] unless keys.is_a?(Array)
+
+      property = UtilityColors::Properties.send(keys[0])
+      property = property.dig(*keys.slice(1..-1)) if keys.length > 1
+
+      property
+    end
+
+    def self.screen_sizes
+      {
+        'sm' => '325px',
+        'md' => '768px',
+        'lg' => '1024px',
+        'xl' => '1440px'
+      }
+    end
+
+    def self.pseudo_input
+      [
+        'checked',
+        'disabled',
+        'enabled',
+        'focus'
+      ]
+    end
+
+    # TODO: add it in
+    def self.pseudo_input_extra
+      [
+        'in-range',
+        'invalid',
+        'optional',
+        'out-of-range',
+        'read-only',
+        'read-write',
+        'require',
+        'valid'
+      ]
+    end
+
+    def self.pseudo_action
+      [
+        'active',
+        'hover',
+        'link',
+        'target',
+        'visited'
+      ]
+    end
+
+    def self.pseudo_child
+      [
+        'root',
+        'first-child',
+        'first-of-type',
+        'last-child',
+        'last-of-type',
+        'only-of-type',
+        'only-child',
+        'empty'
+        # // nth-child(n},
+        # // nth-last-child(n},
+        # // nth-last-of-type(n},
+        # // nth-of-type(n},
+      ]
+    end
+
+    def self.pseudos
+      UtilityColors::Properties.pseudo_input + UtilityColors::Properties.pseudo_action + UtilityColors::Properties.pseudo_child
+    end
+  end
+end

data/lib/utility_colors/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module UtilityColors
-  VERSION = "0.1.8"
-end
+# frozen_string_literal: true
+
+module UtilityColors
+  VERSION = '1.0.0'
+end

data/lib/utility_colors.rb

@@ -1,8 +1,15 @@
-# frozen_string_literal: true
-
-require_relative "utility_colors/version"
-
-module UtilityColors
-  class Error < StandardError; end
-  # Your code goes here...
-end
+# frozen_string_literal: true
+
+require_relative 'utility_colors/version'
+
+require_relative 'utility_colors/configuration'
+require_relative 'utility_colors/builders'
+require_relative 'utility_colors/colors'
+require_relative 'utility_colors/exports'
+require_relative 'utility_colors/imports'
+require_relative 'utility_colors/properties'
+
+module UtilityColors
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -1,49 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: utility_colors
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
-- Louis W Davis
-autorequire: 
-bindir: exe
+- Louis Davis
+bindir: bin
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2025-09-04 00:00:00.000000000 Z
 dependencies: []
-description: Creates all the color palettes classes you need from your colors
 email:
-- louiswilliamdavis@gmail.com
+- LouisWilliamDavis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".npmignore"
-- ".rspec"
-- ".rubocop.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
-- examples/v0.1.8.png
-- index.js
+- lib/generators/templates/config/utility_colors.rb
+- lib/generators/templates/palettes/_color-variables.scss
+- lib/generators/utility_colors/config_generator.rb
+- lib/generators/utility_colors/generate_generator.rb
 - lib/utility_colors.rb
+- lib/utility_colors/builders.rb
+- lib/utility_colors/colors.rb
+- lib/utility_colors/configuration.rb
+- lib/utility_colors/exports.rb
+- lib/utility_colors/imports.rb
+- lib/utility_colors/properties.rb
 - lib/utility_colors/version.rb
-- package.json
-- utility_colors/_utility_colors.scss
-- utility_colors/utility_colors_files/functions/_functions.scss
-- utility_colors/utility_colors_files/functions/_mappings.scss
-- utility_colors/utility_colors_files/functions/_palettes.scss
-- utility_colors/utility_colors_files/functions/_references.scss
-- utility_colors/utility_colors_files/functions/_sequences.scss
-- utility_colors/utility_colors_files/mixins/_mixins.scss
-- utility_colors/utility_colors_files/utilities/_color.scss
-- utility_colors/utility_colors_files/validators/_validations.scss
-- utility_colors/utility_colors_files/variables/_color-variables.scss
-- utility_colors/utility_colors_files/variables/_mod-variables.scss
-- utility_colors/utility_colors_files/variables/_user-variables.scss
-- utility_colors/utility_colors_files/variables/_variables.scss
 homepage: https://github.com/louiswdavis/utility_colors
 licenses:
 - MIT
@@ -51,7 +36,6 @@ metadata:
   homepage_uri: https://github.com/louiswdavis/utility_colors
   source_code_uri: https://github.com/louiswdavis/utility_colors
   changelog_uri: https://github.com/louiswdavis/utility_colors/blob/master/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -59,15 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
-summary: The last time to worry about color palette styles
+summary: Quickly build colour palettes classes for use in stylesheets.
 test_files: []

data/.npmignore

@@ -1,28 +0,0 @@
-.git/
-.github/
-app/
-bin/
-lib/
-spec/
-
-/node_modules/
-/node_modules/*
-
-.gitignore
-.ruby-version
-.rspec
-.rubocop.yml
-
-Gemfile
-Gemfile.lock
-
-DEPTH.md
-NOTES.md
-
-package-lock.json
-
-Rakefile
-
-*.tgz
-*.gem
-utility_colors.gemspec

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/CHANGELOG.md

@@ -1,46 +0,0 @@
-## [0.1.8] - 2022-08-20
-
-- Made utility_colors accessible as both a ruby gem and npm package
-- Added functions that create a linear, equally spaced and smooth shade palette based off any colour supplied regardless of it's hue, saturation, or lightness
-- Added ability to use default color palettes (shades & tri)
-- Added ability to create custom custom shade and tri palettes
-- Added creation of BEM style utility classes to use colour palette for styles; color, background-color, etc TODO
-  - classes that can be created include:
-    - basic styles `color--red-400`
-    - breakpoint style `md|color--red-400`
-    - pseudo-element styles `hover|color--red-400`
-    - pseudo-element breakpoint styles `hover|md|color--red-400`
-- Created function to get colour variable value based off the name of the colour `get-uc(red-400)`
-- Added configuration map to allow uses to:
-  - add custom colours to be used to create shade palettes, tri palettes, single use colours, and to overwrite the default colour options
-  - disable the creation of classes if they only want to utilize the colour palette variables created
-  - disable the creation of pseudo-element and pseudo-element breakpoint classes by setting a boolean
-  - disable the creation of breakpoint and pseudo-element breakpoint classes by setting a boolean
-  - disable the creation and use of any default colour classes or shades
-
-```scss
-$utility_colors: (
-  config: (
-    classes: BOOLEAN,
-    breakpoint: BOOLEAN,
-    pseudo: BOOLEAN,
-    defaults: BOOLEAN,
-  ),
-  colors: (
-    shades-use: (
-      'base-colour-A-name': hexcode,
-    ),
-    tri-use: (
-      'base-colour-B-name': hexcode,
-    ),
-    single-use: (
-      'base-colour-C-name': hexcode,
-    ),
-  )
-);
-```
-
-
-## [0.1.0] - 2022-08-13
-
-- Initial commits

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at louiswilliamdavis@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in utility_colors.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Louis W Davis
-
-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/index.js

@@ -1,5 +0,0 @@
-var path = require("path");
-
-module.exports = {
-  includePaths: [ path.join(__dirname, "utility_colors") ]
-};

data/package.json

@@ -1,26 +0,0 @@
-{
-  "name": "utility_colors",
-  "version": "0.1.8",
-  "description": "The last tool you'll need to create color palettes and style your applications with them",
-  "keywords": [
-    "styles",
-    "styling",
-    "utility",
-    "sass",
-    "scss",
-    "color",
-    "colour"
-  ],
-  "homepage": "https://github.com/louiswdavis/utility_colors#readme",
-  "bugs": {
-    "url": "https://github.com/louiswdavis/utility_colors/issues"
-  },
-  "license": "MIT",
-  "author": "Louis Davis <LouisWilliamDavis@gmail.com> (https://twitter.com/louiswdavis_)",
-  "main": "index.js",
-  "style": "utility_colors/_utility_colors.scss",
-  "repository": "github:louiswdavis/utility_colors",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
-}

data/utility_colors/_utility_colors.scss

@@ -1,11 +0,0 @@
-@use "sass:color";
-@use "sass:list";
-@use "sass:map";
-@use "sass:math";
-@use "sass:meta";
-
-@import 'utility_colors_files/validators/validations';
-@import 'utility_colors_files/functions/functions';
-@import 'utility_colors_files/variables/variables';
-@import 'utility_colors_files/mixins/mixins';
-@import 'utility_colors_files/utilities/color';

data/utility_colors/utility_colors_files/functions/_functions.scss

@@ -1,4 +0,0 @@
-@import 'mappings';
-@import 'references';
-@import 'sequences';
-@import 'palettes';

data/utility_colors/utility_colors_files/functions/_mappings.scss

@@ -1,25 +0,0 @@
-// a function to combine multiple mappings variables into a single map
-@function map-combine($maps...) {
-  $collection: ();
-
-  // map-merge combines two mappings together into a single map
-  // this new mapping is then recursively merged to the next mapping in the array
-  @each $mapping in $maps {
-    $collection: map-merge($collection, $mapping);
-  }
-
-  @return $collection;
-}
-
-// a function to combine multiple listings variables into a single list
-@function list-combine($lists...) {
-  $collection: ();
-
-  // list.join combines two listings together into a single list
-  // this new listing is then recursively merged to the next listings in the array
-  @each $listings in $lists {
-    $collection: join($collection, $listings);
-  }
-
-  @return $collection;
-}