stylegen 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6880c6848932f2c2f954860a1885cfd20fda16e99f6ea01dd8c5fe5731658c45
-  data.tar.gz: b7f49e94a5c19dbe464b3c246cf1834b7477b118c006aea1eed9ebd0c548acd6
+  metadata.gz: 1f3c7f3c64e0c2b99ca8ab6fa2f200f4a47af401b9e1c2547983eaed4f6a339e
+  data.tar.gz: 870d75d1e851c2cf8d1f8958f0eed6ceff39b2537d28f81e199a6cb8f683caee
 SHA512:
-  metadata.gz: d16722e424e033cd0d29b73ffa65358de4bdc490a3bf44736202f403bba405b6d4cb64499646dead5cc6185c71e0708d0977ac9688c4fd3baffd88f69ec6e546
-  data.tar.gz: 264639f5ff9bf1541f3670cf428c7390ec72d3746144501fa039eae7ce5a4b28f7bd3dfb72cc02ade6ce3ee9db6bdd844646ad1e11657dba9068afd9e70b0c5a
+  metadata.gz: 9e18ecf6503daef89a5cc9fdc9f4fda1a90a2872ff701f750d924a2e3d4f4efedc3ca74cd9a4803fd4b3ee2001defc877e07d40feada9cfa96c845fa3c0e79d2
+  data.tar.gz: 8365c8bad165c4f518502185e5f639c5e9beebe664c6018d2ea9ec1175bc6f720fa8dc6fc21b879fb76a9dea59e1e071222a360f0235519fcae5a72a087e5440

data/.github/workflows/ci.yml

@@ -21,10 +21,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-minitest
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   NewCops: enable
 
 Style/StringLiterals:

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## v0.4.0
+### Added
+- Added support for color descriptions.
+
+## v0.3.1
+### Changed
+- Increased precision of HEX color conversion to avoid truncation. 
+
+## v0.3.0
+### Added
+- SwiftUI support.
+
+## v0.2.0
+### Added
+- `stylegen init` command.
+
+## v0.1.0
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stylegen (0.2.0)
+    stylegen (0.4.0)
       dry-inflector (~> 0.2.0)
       gli (~> 2.1)
       json_schemer (~> 0.2.0)
@@ -9,38 +9,38 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     dry-inflector (0.2.0)
     ecma-re-validator (0.3.0)
       regexp_parser (~> 2.0)
-    gli (2.20.0)
+    gli (2.20.1)
     hana (1.3.7)
-    json_schemer (0.2.17)
+    json_schemer (0.2.18)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
-    minitest (5.14.3)
+    minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rubocop (1.8.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.14.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-minitest (0.10.3)
-      rubocop (>= 0.87, < 2.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.12.1)
+      rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.5.1)
       rubocop
     ruby-progressbar (1.11.0)

data/README.md

@@ -38,6 +38,9 @@ The generated YAML file will look similar to this:
 # Path of generated Swift file.
 output_path: "Colors.swift"
 
+# Enables SwiftUI support
+# swiftui: false
+
 # Key-value pairs of theme colors.
 colors:
 
@@ -65,6 +68,7 @@ colors:
       alpha: 0.6
 
   primary_background:
+    description: The color for the main background of your interface.
     light: "#FFFFFF"
     dark:
       # Value for base (non-elevated) level
@@ -101,5 +105,5 @@ colors. The name of the namespacing function gets inferred from the `system_name
 
 * ~~`$ stylegen init` command~~
 * Option to specify target frameworks: AppKit, UIKit, Core Graphics, and SwiftUI
-* SwiftUI support
+* ~~SwiftUI support~~
 * AppKit support

data/lib/stylegen/cli/template.yaml

@@ -7,6 +7,9 @@
 # Path of generated Swift file.
 output_path: "Colors.swift"
 
+# Enables SwiftUI support
+# swiftui: false
+
 # Key-value pairs of theme colors.
 colors:
 
@@ -34,6 +37,8 @@ colors:
       alpha: 0.6
 
   primary_background:
+    # Use `description` to document your colors (optional).
+    description: The color for the main background of your interface.
     light: "#FFFFFF"
     dark:
       # Value for base (non-elevated) level

data/lib/stylegen/colors/base_elevated_color.rb

@@ -2,6 +2,8 @@
 
 module Stylegen
   class BaseElevatedColor
+    attr_reader :description
+
     def initialize(base, elevated)
       @base, @elevated = base, elevated
     end

data/lib/stylegen/colors/color.rb

@@ -21,20 +21,30 @@ module Stylegen
         raise ArgumentError, "Invalid color syntax: #{hex}"
       end
 
-      max_digits = 2
+      max_precision = 16
 
-      Color.new(r.round(max_digits), g.round(max_digits), b.round(max_digits), alpha || 1.0)
+      Color.new(r.round(max_precision), g.round(max_precision), b.round(max_precision), alpha || 1.0)
     end
 
     def grayscale?
       @red == @green && @green == @blue
     end
 
-    def to_s(struct_name, _indent = 0)
+    def to_s(struct_name, indent = 0)
       if grayscale?
         "#{struct_name}(white: #{@red}, alpha: #{@alpha})"
       else
-        "#{struct_name}(red: #{@red}, green: #{@green}, blue: #{@blue}, alpha: #{@alpha})"
+        indent_prefix = " " * indent
+
+        result = []
+        result << "#{struct_name}("
+        result << "#{indent_prefix}    red: #{@red},"
+        result << "#{indent_prefix}    green: #{@green},"
+        result << "#{indent_prefix}    blue: #{@blue},"
+        result << "#{indent_prefix}    alpha: #{@alpha}"
+        result << "#{indent_prefix})"
+
+        result.join("\n")
       end
     end
   end

data/lib/stylegen/data.rb

@@ -30,6 +30,10 @@ module Stylegen
       @data["output_path"]
     end
 
+    def swiftui?
+      @data["swiftui"] || false
+    end
+
     def basename
       File.basename(@data["output_path"])
     end
@@ -42,9 +46,13 @@ module Stylegen
       "#{system_name}Color"
     end
 
-    def colors
-      @colors ||= @data["colors"].map do |key, value|
-        [inflector.camelize_lower(key), generate_color(value)]
+    def color_entries
+      @color_entries ||= @data["colors"].map do |key, value|
+        {
+          property: inflector.camelize_lower(key),
+          description: value["description"],
+          color: generate_color(value)
+        }
       end
     end
 

data/lib/stylegen/generator.rb

@@ -1,126 +1,24 @@
 # frozen_string_literal: true
 
 require "stylegen/data"
+require "stylegen/template"
 
 module Stylegen
   class Generator
     def initialize(data)
       @data = Data.new(data)
-      @file = File.open(@data.output_path, "w")
-    end
-
-    def out(line)
-      @file << line << "\n"
     end
 
     def generate
-      generate_header
-      generate_struct
-      generate_colors
-      generate_extensions
-    end
-
-    def stats
-      @stats ||= { output_path: @data.output_path, color_count: @data.colors.count }
-    end
+      template = Template.new(@data)
 
-    private
-
-    def generate_header
-      out "//"
-      out "//  #{@data.basename}"
-      out "//"
-      out "//  Autogenerated by stylegen (v#{@data.version})"
-      out "//  DO NOT EDIT"
-      out "//"
-      out ""
-      out "import UIKit"
-      out ""
+      file = File.open(@data.output_path, "w")
+      file << template.render
+      file.close
     end
 
-    def generate_struct
-      out "#{@data.access_level} struct #{@data.struct_name} {"
-      out ""
-      out "    let uiColor: UIColor"
-      out ""
-      out "    fileprivate init(white: CGFloat, alpha: CGFloat) {"
-      out "        self.uiColor = UIColor(white: white, alpha: alpha)"
-      out "    }"
-      out ""
-      out "    fileprivate init(red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat) {"
-      out "        self.uiColor = UIColor(red: red, green: green, blue: blue, alpha: alpha)"
-      out "    }"
-      out ""
-      out "    fileprivate init(_ color: UIColor) {"
-      out "        self.uiColor = color"
-      out "    }"
-      out ""
-      out "    fileprivate init(light: #{@data.struct_name}, dark: #{@data.struct_name}) {"
-      out "        if #available(iOS 13.0, *) {"
-      out "            self.uiColor = UIColor(dynamicProvider: { (traits: UITraitCollection) -> UIColor in"
-      out "                switch traits.userInterfaceStyle {"
-      out "                case .dark:"
-      out "                    return dark.uiColor"
-      out "                default:"
-      out "                    return light.uiColor"
-      out "                }"
-      out "            })"
-      out "        } else {"
-      out "            self.uiColor = light.uiColor"
-      out "        }"
-      out "    }"
-      out ""
-      out "    fileprivate init(base: #{@data.struct_name}, elevated: #{@data.struct_name}) {"
-      out "        if #available(iOS 13.0, *) {"
-      out "            self.uiColor = UIColor(dynamicProvider: { (traits: UITraitCollection) -> UIColor in"
-      out "                switch traits.userInterfaceLevel {"
-      out "                case .elevated:"
-      out "                    return elevated.uiColor"
-      out "                default:"
-      out "                    return base.uiColor"
-      out "                }"
-      out "            })"
-      out "        } else {"
-      out "            self.uiColor = base.uiColor"
-      out "        }"
-      out "    }"
-      out ""
-      out "}"
-      out ""
-    end
-
-    def generate_colors
-      out "#{@data.access_level} extension #{@data.struct_name} {"
-      out ""
-
-      @data.colors.each do |member, color|
-        out "    static let #{member} = #{color.to_s(@data.struct_name, 4)}"
-        out ""
-      end
-
-      out "}"
-      out ""
-    end
-
-    def generate_extensions
-      out "#{@data.access_level} extension UIColor {"
-      out ""
-      out "    @inline(__always)"
-      out "    static func #{@data.util_method_name}(_ color: #{@data.struct_name}) -> UIColor {"
-      out "       return color.uiColor"
-      out "    }"
-      out ""
-      out "}"
-      out ""
-
-      out "#{@data.access_level} extension CGColor {"
-      out ""
-      out "    @inline(__always)"
-      out "    static func #{@data.util_method_name}(_ color: #{@data.struct_name}) -> CGColor {"
-      out "       return color.uiColor.cgColor"
-      out "    }"
-      out ""
-      out "}"
+    def stats
+      @stats ||= { output_path: @data.output_path, color_count: @data.color_entries.count }
     end
   end
 end

data/lib/stylegen/{schema.json → resources/schema.json}

@@ -26,6 +26,9 @@
     "Color": {
       "type": "object",
       "properties": {
+        "description": {
+          "type": "string"
+        },
         "color": {
           "$ref": "#/definitions/HexColor"
         },
@@ -41,6 +44,9 @@
     "BaseElevatedColor": {
       "type": "object",
       "properties": {
+        "description": {
+          "type": "string"
+        },
         "base": {
           "$ref": "#/definitions/AbstractColor"
         },
@@ -54,6 +60,9 @@
     "LightDarkColor": {
       "type": "object",
       "properties": {
+        "description": {
+          "type": "string"
+        },
         "light": {
           "$ref": "#/definitions/AbstractColor"
         },
@@ -83,6 +92,11 @@
       "minLength": 1,
       "description": "Path of generated Swift file."
     },
+    "swiftui": {
+      "type": "boolean",
+      "default": false,
+      "description": "Enables SwiftUI support."
+    },
     "colors": {
       "type": "object",
       "description": "Key-value pairs of colors.",
@@ -102,4 +116,4 @@
     "output_path",
     "colors"
   ]
-}
+}

data/lib/stylegen/template.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Stylegen
+  class Template
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def render
+      result = []
+      result << render_header
+      result << render_imports
+      result << render_struct
+      result << render_colors
+      result << render_utils
+      result.join("\n")
+    end
+
+    private
+
+    def render_header
+      <<~HEREDOC
+        //
+        //  #{data.basename}
+        //
+        //  Autogenerated by stylegen (#{data.version})
+        //  DO NOT EDIT
+        //
+      HEREDOC
+    end
+
+    def render_imports
+      result = []
+      result << "import UIKit"
+      result << "import SwiftUI" if data.swiftui?
+      result << ""
+      result.join("\n")
+    end
+
+    def render_struct
+      <<~HEREDOC
+        #{data.access_level} struct #{data.struct_name} {
+
+            let uiColor: UIColor
+
+            fileprivate init(white: CGFloat, alpha: CGFloat) {
+                self.uiColor = UIColor(white: white, alpha: alpha)
+            }
+
+            fileprivate init(red: CGFloat, green: CGFloat, blue: CGFloat, alpha: CGFloat) {
+                self.uiColor = UIColor(red: red, green: green, blue: blue, alpha: alpha)
+            }
+
+            fileprivate init(_ color: UIColor) {
+                self.uiColor = color
+            }
+
+            fileprivate init(light: #{data.struct_name}, dark: #{data.struct_name}) {
+                if #available(iOS 13.0, *) {
+                    self.uiColor = UIColor(dynamicProvider: { (traits: UITraitCollection) -> UIColor in
+                        switch traits.userInterfaceStyle {
+                        case .dark:
+                            return dark.uiColor
+                        default:
+                            return light.uiColor
+                        }
+                    })
+                } else {
+                    self.uiColor = light.uiColor
+                }
+            }
+
+            fileprivate init(base: #{data.struct_name}, elevated: #{data.struct_name}) {
+                if #available(iOS 13.0, *) {
+                    self.uiColor = UIColor(dynamicProvider: { (traits: UITraitCollection) -> UIColor in
+                        switch traits.userInterfaceLevel {
+                        case .elevated:
+                            return elevated.uiColor
+                        default:
+                            return base.uiColor
+                        }
+                    })
+                } else {
+                    self.uiColor = base.uiColor
+                }
+            }
+
+        }
+      HEREDOC
+    end
+
+    def render_colors
+      result = []
+      result << "// MARK: Colors"
+      result << ""
+      result << "#{data.access_level} extension #{data.struct_name} {"
+      result << ""
+
+      data.color_entries.each do |entry|
+        unless entry[:description].nil?
+          entry[:description].strip.lines.each do |line|
+            result << "    /// #{line.strip}"
+          end
+        end
+
+        result << "    static let #{entry[:property]} = #{entry[:color].to_s(data.struct_name, 4)}\n"
+      end
+
+      result << "}"
+      result << ""
+      result.join("\n")
+    end
+
+    def render_utils
+      result = []
+      result << "// MARK: Utils"
+      result << ""
+
+      if data.swiftui?
+        result << <<~HEREDOC
+          #{data.access_level} extension Color {
+
+              @inline(__always)
+              static func #{data.util_method_name}(_ color: #{data.struct_name}) -> Color {
+                  return Color(color.uiColor)
+              }
+
+          }
+        HEREDOC
+      end
+
+      result << <<~HEREDOC
+        #{data.access_level} extension UIColor {
+
+            @inline(__always)
+            static func #{data.util_method_name}(_ color: #{data.struct_name}) -> UIColor {
+                return color.uiColor
+            }
+
+        }
+
+        #{data.access_level} extension CGColor {
+
+            @inline(__always)
+            static func #{data.util_method_name}(_ color: #{data.struct_name}) -> CGColor {
+                return color.uiColor.cgColor
+            }
+
+        }
+      HEREDOC
+
+      result.join("\n")
+    end
+  end
+end

data/lib/stylegen/validator.rb

@@ -21,7 +21,7 @@ module Stylegen
     private
 
     def schema
-      @schema ||= JSONSchemer.schema(File.read(File.join(__dir__, "schema.json")))
+      @schema ||= JSONSchemer.schema(File.read(File.join(__dir__, "resources/schema.json")))
     end
   end
 end

data/lib/stylegen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stylegen
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/stylegen.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop-minitest"
   s.add_development_dependency "rubocop-rake"
 
-  s.required_ruby_version = ">= 2.4.0"
+  s.required_ruby_version = ">= 2.5.0"
 end

data/test/test_color.rb

@@ -6,14 +6,14 @@ class TestColor < MiniTest::Test
   def test_parsing
     color = Stylegen::Color.from_hex("#FF8000")
     assert_equal 1.0, color.red
-    assert_equal 0.5, color.green
+    assert_equal 0.5019607843137255, color.green
     assert_equal 0.0, color.blue
     assert_equal 1.0, color.alpha
 
     # Optional pound sign
     color = Stylegen::Color.from_hex("FF8000")
     assert_equal 1.0, color.red
-    assert_equal 0.5, color.green
+    assert_equal 0.5019607843137255, color.green
     assert_equal 0.0, color.blue
     assert_equal 1.0, color.alpha
 
@@ -25,14 +25,14 @@ class TestColor < MiniTest::Test
   def test_parsing_shorthand_syntax
     color = Stylegen::Color.from_hex("#FC0")
     assert_equal 1.0, color.red
-    assert_equal 0.8, color.green
+    assert_equal 0.8000000000000002, color.green
     assert_equal 0.0, color.blue
     assert_equal 1.0, color.alpha
 
     # Optional pound sign
     color = Stylegen::Color.from_hex("FC0")
     assert_equal 1.0, color.red
-    assert_equal 0.8, color.green
+    assert_equal 0.8000000000000002, color.green
     assert_equal 0.0, color.blue
     assert_equal 1.0, color.alpha
   end
@@ -47,7 +47,16 @@ class TestColor < MiniTest::Test
 
   def test_to_string
     color = Stylegen::Color.from_hex("#00FF00")
-    expected = "ThemeColor(red: 0.0, green: 1.0, blue: 0.0, alpha: 1.0)"
+
+    expected = <<~CODE.strip
+      ThemeColor(
+          red: 0.0,
+          green: 1.0,
+          blue: 0.0,
+          alpha: 1.0
+      )
+    CODE
+
     assert_equal expected, color.to_s("ThemeColor")
 
     # Grayscale

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stylegen
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ramon Torres
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -147,6 +147,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -163,7 +164,8 @@ files:
 - lib/stylegen/colors/light_dark_color.rb
 - lib/stylegen/data.rb
 - lib/stylegen/generator.rb
-- lib/stylegen/schema.json
+- lib/stylegen/resources/schema.json
+- lib/stylegen/template.rb
 - lib/stylegen/validator.rb
 - lib/stylegen/version.rb
 - stylegen.gemspec
@@ -183,14 +185,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project:
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
 summary: Tool for generating styling code for iOS apps