stylegen 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4808a4d66b66694ce4df774bc4fc3cc4048e5eb28849bc9d6e89c191a2c9f32
-  data.tar.gz: 639451c4ee1913d543c1b10cd3ed6dc7bf8f70b5711ac490ca1644d28b88bd88
+  metadata.gz: 1f3c7f3c64e0c2b99ca8ab6fa2f200f4a47af401b9e1c2547983eaed4f6a339e
+  data.tar.gz: 870d75d1e851c2cf8d1f8958f0eed6ceff39b2537d28f81e199a6cb8f683caee
 SHA512:
-  metadata.gz: 3ac5a414042b33bef240224d8390d79e92466b777a98bd9ffa0dcd20fe63b4b3353823d26dcc129655bd3d534b1eca2b7c9950b2b6e1764b5d7e30e8e1381ac2
-  data.tar.gz: 8d2e762fef43e854ca222e9fba107fb8df885d2ae4b2d0ab44eed03c6f7e0c5f61138df701954fd479b4dcbe2f1698b18ae4a140423a625bab83ccff95b0eec5
+  metadata.gz: 9e18ecf6503daef89a5cc9fdc9f4fda1a90a2872ff701f750d924a2e3d4f4efedc3ca74cd9a4803fd4b3ee2001defc877e07d40feada9cfa96c845fa3c0e79d2
+  data.tar.gz: 8365c8bad165c4f518502185e5f639c5e9beebe664c6018d2ea9ec1175bc6f720fa8dc6fc21b879fb76a9dea59e1e071222a360f0235519fcae5a72a087e5440

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # 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. 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stylegen (0.3.1)
+    stylegen (0.4.0)
       dry-inflector (~> 0.2.0)
       gli (~> 2.1)
       json_schemer (~> 0.2.0)

data/README.md

@@ -68,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

data/lib/stylegen/cli/template.yaml

@@ -37,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/data.rb

@@ -46,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

@@ -10,8 +10,7 @@ module Stylegen
     end
 
     def generate
-      template_content = File.read(File.join(__dir__, "resources/template.swift.erb"))
-      template = Template.new(template_content, @data)
+      template = Template.new(@data)
 
       file = File.open(@data.output_path, "w")
       file << template.render
@@ -19,7 +18,7 @@ module Stylegen
     end
 
     def stats
-      @stats ||= { output_path: @data.output_path, color_count: @data.colors.count }
+      @stats ||= { output_path: @data.output_path, color_count: @data.color_entries.count }
     end
   end
 end

data/lib/stylegen/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"
         },
@@ -107,4 +116,4 @@
     "output_path",
     "colors"
   ]
-}
+}

data/lib/stylegen/template.rb

@@ -1,16 +1,157 @@
 # frozen_string_literal: true
 
-require "erb"
-
 module Stylegen
   class Template
-    def initialize(content, data)
-      @content = content
+    attr_reader :data
+
+    def initialize(data)
       @data = data
     end
 
     def render
-      ERB.new(@content, nil, "-").result(binding)
+      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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stylegen
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ramon Torres
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-22 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -165,7 +165,6 @@ files:
 - lib/stylegen/data.rb
 - lib/stylegen/generator.rb
 - lib/stylegen/resources/schema.json
-- lib/stylegen/resources/template.swift.erb
 - lib/stylegen/template.rb
 - lib/stylegen/validator.rb
 - lib/stylegen/version.rb
@@ -193,7 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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

data/lib/stylegen/resources/template.swift.erb

@@ -1,97 +0,0 @@
-//
-//  <%= @data.basename %>
-//
-//  Autogenerated by stylegen (<%= @data.version %>)
-//  DO NOT EDIT
-//
-
-import UIKit
-<% if @data.swiftui? -%>
-import SwiftUI
-<% end -%>
-
-<%= @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
-        }
-    }
-
-}
-
-// MARK: Colors
-
-<%= @data.access_level %> extension <%= @data.struct_name %> {
-<% @data.colors.each do |member, color| %>
-    static let <%= member %> = <%= color.to_s(@data.struct_name, 4) %>
-<% end %>
-}
-
-// MARK: - Extensions
-<% if @data.swiftui? %>
-<%= @data.access_level %> extension Color {
-
-    @inline(__always)
-    static func <%= @data.util_method_name %>(_ color: <%= @data.struct_name %>) -> Color {
-        return Color(color.uiColor)
-    }
-
-}
-<% end -%>
-
-<%= @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
-    }
-
-}