utility_colors 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bcb54e43ef56335b61de7c5657477471310d42b4c7150821d874e35cc48af36
-  data.tar.gz: b45099cb134d67fb04898daf013d78a1908d970c63950220e6fc9368eca4653c
+  metadata.gz: b724d22935983f69caf72f8a4d7f4fda4cb36d9170e3f2bdb903af17429ca3e0
+  data.tar.gz: 2b73c4015dbe484f7ef4e8912ef471273b28580e518275dc729c60f695aad117
 SHA512:
-  metadata.gz: ad703fe0a83d64355550e011eed509101935794f3954e20c8d4bca8b5556ab86f41d6ba0777e021f6afd447c2c5d03b1ba6c3341155a0c8289472b840b38a4d8
-  data.tar.gz: 5ac4ff72a529536744477e3317578c0001f5bb76181aa2618183d984db22900b26f0c5c611124d9ac82d6fcadfff4165227a495cd7a65529376c6c1cec39a155
+  metadata.gz: 90e3859529d811fe17f01c4b419c109e3f9b05359ec14fb6fccd39fa8bab7b4322d39d8a73f24be3a1a63e09c58fe811cc4fcd21632b1542cd45c05f25ad1c11
+  data.tar.gz: 455b3b7cc322b728261aea0647b06b1eeb1685788e30fa60cadd6dbc7af086b019df392ad2237039bb41bd07f9fdc266db0dbe46f66a3dce8529f94616d4ef89

data/README.md

@@ -83,7 +83,7 @@ What types of classes should be built:
 | regular_classes           | Should 'regular' classes be built, e.g. ".bg--red-50"                     | true    | Boolean    | true / false          |
 | breakpoint_classes        | Should 'breakpoint' classes be built, e.g. ".md\\|color--black"           | false   | Boolean    | true / false          |
 | pseudo_classes            | Should 'pseudo' classes be built, e.g. ".hover\\|border-c--blue-50:hover" | false   | Boolean    | true / false          |
-| breakpoint_pseudo_classes | Should 'regular' classes be built, e.g. ".hover\\|md\\|bg--blue-50:hover" | false   | Boolean    | true / false          |
+| pseudo_breakpoint_classes | Should 'regular' classes be built, e.g. ".hover\\|md\\|bg--blue-50:hover" | false   | Boolean    | true / false          |
 
 ### Extra Information
 

data/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

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

@@ -18,5 +18,5 @@ UtilityColors.configure do |config|
   # config.regular_classes = true
   # config.breakpoint_classes = false
   # config.pseudo_classes = false
-  # config.breakpoint_pseudo_classes = false
+  # config.pseudo_breakpoint_classes = false
 end

data/lib/generators/templates/palettes/_color-variables.scss

@@ -1,34 +1,34 @@
-// v0.1.8 Absolute Sources
-
-$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%);
-
-// v0.1.8 Relative Sources
-
-$success: $green-400;
-$danger: $red-400;
-$information: $blue-400;
-$warning: $gold-400;
-
-// v0.1.8 Single Sources
-
-$white: #fff;
-$black: #000;
-$translucent: rgba(#000, 0.45);
+// v0.1.8 Absolute Sources
+
+$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%);
+
+// v0.1.8 Relative Sources
+
+$success: $green-400;
+$danger: $red-400;
+$information: $blue-400;
+$warning: $gold-400;
+
+// v0.1.8 Single Sources
+
+$white: #fff;
+$black: #000;
+$translucent: rgba(#000, 0.45);

data/lib/generators/utility_colors/config_generator.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-
-module UtilityColors
-  module Generators
-    class ConfigGenerator < Rails::Generators::Base
-      source_root File.expand_path('../../..', __dir__)
-
-      def copy_config
-        copy_file 'lib/generators/templates/config/utility_colors.rb', 'config/initializers/utility_colors.rb'
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module UtilityColors
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../..', __dir__)
+
+      def copy_config
+        copy_file 'lib/generators/templates/config/utility_colors.rb', 'config/initializers/utility_colors.rb'
+      end
+    end
+  end
+end

data/lib/generators/utility_colors/generate_generator.rb

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-module UtilityColors
-  module Generators
-    class GenerateGenerator < Rails::Generators::Base
-      def generate_utility_colors
-        # TODO: check if the v0.1.8 scss files exists
-        # "app/app/assets/stylesheets/utility_colors_files" directory
-        self.class.config_format_warn if File.exist?('config/utility_colors.yml') || File.exist?('config/utility_colors.json')
-
-        if UtilityColors.configuration.enable_environments.include?(Rails.env.to_sym)
-          UtilityColors::Colors.generate
-        else
-          self.class.disabled_warn
-        end
-      end
-
-      private
-
-      # TODO: add links to README for migration
-      def self.config_format_warn
-        warn 'WARNING: Utility Colors now uses an initializer to set config. You need to migrate and remove your YML/JSON file.'
-      end
-
-      # TODO: add links to README for environment setting
-      def self.disabled_warn
-        warn 'ERROR: Utility Colors is disabled for this environment. Color classes will not be generated.'
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module UtilityColors
+  module Generators
+    class GenerateGenerator < Rails::Generators::Base
+      def generate_utility_colors
+        # TODO: check if the v0.1.8 scss files exists
+        # "app/app/assets/stylesheets/utility_colors_files" directory
+        self.class.config_format_warn if File.exist?('config/utility_colors.yml') || File.exist?('config/utility_colors.json')
+
+        if UtilityColors.configuration.enable_environments.include?(Rails.env.to_sym)
+          UtilityColors::Colors.generate
+        else
+          self.class.disabled_warn
+        end
+      end
+
+      private
+
+      # TODO: add links to README for migration
+      def self.config_format_warn
+        warn 'WARNING: Utility Colors now uses an initializer to set config. You need to migrate and remove your YML/JSON file.'
+      end
+
+      # TODO: add links to README for environment setting
+      def self.disabled_warn
+        warn 'ERROR: Utility Colors is disabled for this environment. Color classes will not be generated.'
+      end
+    end
+  end
+end

data/lib/utility_colors/builders.rb

@@ -10,22 +10,23 @@ module UtilityColors
       { class_name => "#{content.join(': ')};" }
     end
 
+    # ';' are already in the content from the above source method
     # 'md|color--red-400'
     def self.utility_pseudo_classes_creation(class_name, content, pseudo)
       content = [content] unless content.is_a?(Array)
-      { "#{pseudo}\|#{class_name}:#{pseudo}" => "#{content.join(': ')};" }
+      { "#{pseudo}\\|#{class_name}:#{pseudo}" => content.join(': ') }
     end
 
     # 'hover|color--red-400'
     def self.utility_breakpoint_classes_creation(class_name, content, initial, screen_size)
       content = [content] unless content.is_a?(Array)
-      { "#{initial}\|#{class_name}" => "@media only screen and (min-width: #{screen_size - 1}) { #{content.join(': ')}; }" }
+      { "#{initial}\\|#{class_name}" => "@media only screen and (min-width: #{screen_size - 1}) { #{content.join(': ')} }" }
     end
 
     # 'hover|md|color--red-400'
     def self.utility_pseudo_breakpoint_classes_creation(class_name, content, pseudo, initial, screen_size)
       content = [content] unless content.is_a?(Array)
-      { "#{pseudo}\|#{initial}\|#{class_name}:#{pseudo}" => "@media only screen and (min-width: #{screen_size - 1}) { #{content.join(': ')}; }" }
+      { "#{pseudo}\\|#{initial}\\|#{class_name}:#{pseudo}" => "@media only screen and (min-width: #{screen_size - 1}) { #{content.join(': ')} }" }
     end
 
     # Bulk Methods

data/lib/utility_colors/colors.rb

@@ -30,14 +30,14 @@ module UtilityColors
         puts 'Generated breakpoint colour classes...'
       end
 
-      if configuration.breakpoint_classes
+      if configuration.pseudo_classes
         generated_pseudo_classes = UtilityColors::Builders.bulk_pseudo_class_creation(generated_source_classes)
-        puts 'Generated breakpoint colour classes...'
+        puts 'Generated pseudo colour classes...'
       end
 
-      if configuration.breakpoint_classes
+      if configuration.pseudo_breakpoint_classes
         generated_pseudo_breakpoint_classes = UtilityColors::Builders.bulk_pseudo_breakpoint_class_creation(generated_source_classes)
-        puts 'Generated breakpoint colour classes...'
+        puts 'Generated pseudo breakpoint colour classes...'
       end
 
       generated_classes = {}.merge(generated_regular_classes, generated_breakpoint_classes, generated_pseudo_classes, generated_pseudo_breakpoint_classes)

data/lib/utility_colors/configuration.rb

@@ -5,7 +5,7 @@ module UtilityColors
     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
+                  :regular_classes, :breakpoint_classes, :pseudo_classes, :pseudo_breakpoint_classes # :utility_palettes_configuration
 
     def initialize
       # Enabled Environments
@@ -25,7 +25,7 @@ module UtilityColors
       @regular_classes = true
       @breakpoint_classes = false
       @pseudo_classes = false
-      @breakpoint_pseudo_classes = false
+      @pseudo_breakpoint_classes = false
 
       # Configuration instance for UtilityPalettes
       # @utility_palettes_configuration = UtilityPalettes::Configuration.new

data/lib/utility_colors/exports.rb

@@ -1,54 +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
+# 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

@@ -1,42 +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
+# 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

@@ -1,77 +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
+# 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 = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/utility_colors.rb

@@ -1,15 +1,15 @@
-# 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
+# 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utility_colors
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Louis Davis