stylegen 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5882aa3fdd2e17f9e0fe683c07fd07d5c045f505a78a8ba7c5765edfc60a2c6e
-  data.tar.gz: f583e4f26b3e4dccc121eceec5a7f5e4349f7210e660527aa07128f1401e2837
+  metadata.gz: 6880c6848932f2c2f954860a1885cfd20fda16e99f6ea01dd8c5fe5731658c45
+  data.tar.gz: b7f49e94a5c19dbe464b3c246cf1834b7477b118c006aea1eed9ebd0c548acd6
 SHA512:
-  metadata.gz: d525975a51b7415c727b1f46299ec37283bcc2d2efbde3450cc361c4095c27abc7d2d606863676acc8f35950dbe885519cf1568fab89520fb731cf92812445d0
-  data.tar.gz: 6aa2ac484c0697175a7f6e1ebf94221fcbf66f78e2ba11d3e351434c1949646bc3ff49e46ccf9895703327217a33e1c766d5eb9c3df1f9589b92f210ded81395
+  metadata.gz: d16722e424e033cd0d29b73ffa65358de4bdc490a3bf44736202f403bba405b6d4cb64499646dead5cc6185c71e0708d0977ac9688c4fd3baffd88f69ec6e546
+  data.tar.gz: 264639f5ff9bf1541f3670cf428c7390ec72d3746144501fa039eae7ce5a4b28f7bd3dfb72cc02ade6ce3ee9db6bdd844646ad1e11657dba9068afd9e70b0c5a

data/.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: "*"
   pull_request:
-    branches: [ master ]
+    branches: "*"
 
 jobs:
   test:
@@ -28,5 +28,7 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Lint
+      run: bundle exec rake rubocop
     - name: Run tests
       run: bundle exec rake

data/.gitignore

@@ -1,2 +1,6 @@
 .idea
 pkg
+
+# Testing artifacts
+theme.yaml
+Colors.swift

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    stylegen (0.1.0)
-      dry-inflector (>= 0.2.0)
-      json_schemer (>= 0.2.0)
+    stylegen (0.2.0)
+      dry-inflector (~> 0.2.0)
+      gli (~> 2.1)
+      json_schemer (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,6 +13,7 @@ GEM
     dry-inflector (0.2.0)
     ecma-re-validator (0.3.0)
       regexp_parser (~> 2.0)
+    gli (2.20.0)
     hana (1.3.7)
     json_schemer (0.2.17)
       ecma-re-validator (~> 0.3)
@@ -50,7 +52,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  minitest (>= 5.14.0)
+  minitest (~> 5.14)
   rake
   rubocop
   rubocop-minitest

data/README.md

@@ -20,14 +20,20 @@ gem "stylegen"
 
 ## How to use
 
-Create a `theme.yaml` file in the root of your project. You can use the following YAML file as a starting point:
+To use stylegen in your project, you will need to create a `theme.yaml` file at the root of the project by executing:
+
+```shell
+$ stylegen init
+```
+
+The generated YAML file will look similar to this:
 
 ```yaml
 # Name of the design system. Defaults to "Theme".
 # Feel free to use your company name, name of product,
 # or name of your design system.
 # e.g.: Primer, Material, Polaris, etc.
-system_name: "Theme"
+# system_name: "Theme"
 
 # Path of generated Swift file.
 output_path: "Colors.swift"
@@ -38,7 +44,7 @@ colors:
   accent: # Keys will be used as color names.
     color: "#00BFC2" # Hex color
 
-  # Shorthand syntax  
+  # Shorthand syntax
   warning: "#ED4337"
 
   text_primary:
@@ -67,13 +73,14 @@ colors:
       elevated: "#191D1D"
 ```
 
-After creating the theme file run:
+You can use your favorite text editor to edit the YAML file, then use the `build` sub-command to generate the Swift code:
 
 ```shell
-$ stylegen
+$ stylegen build
 ```
 
-This will generate a Swift file that you can add to your target. The generated file will contain all the colors and utility methods for referencing the colors.
+The generated file will contain all the colors and utility methods for referencing them. You must add this generated
+file to your Xcode target to use it.
 
 In places where you normally do:
 
@@ -87,11 +94,12 @@ Now you can just do:
 self.backgroundColor = .theme(.accent)
 ```
 
-The `.theme()` static method serves as a namespace to easily distinguish between UIKit's built-in colors and our custom colors. The name of the namespacing function is inferred from the `system_name` property in the YAML file.
+The `.theme()` static method serves as a namespace to easily distinguish between UIKit's built-in colors and our custom
+colors. The name of the namespacing function gets inferred from the `system_name` property in the YAML file.
 
 ## TODO
 
-* `$ stylegen init` command
+* ~~`$ stylegen init` command~~
 * Option to specify target frameworks: AppKit, UIKit, Core Graphics, and SwiftUI
 * SwiftUI support
 * AppKit support

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new
+RuboCop::RakeTask.new
 
 task default: :test

data/bin/stylegen

@@ -1,31 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "yaml"
-require "optparse"
-require "stylegen"
+require "stylegen/cli"
 
-@options = {}
-
-OptionParser.new do |opts|
-  opts.on_tail("--version", "Show version") do
-    puts Stylegen::VERSION
-    exit
-  end
-end.parse!
-
-data = File.open("theme.yaml") { |file| YAML.safe_load(file) }
-
-validator = Stylegen::Validator.new
-unless validator.valid?(data)
-  warn "theme.yaml contains one or more errors:"
-
-  validator.validate(data).each do |e|
-    warn "  #{e}"
-  end
-
-  exit(1)
-end
-
-generator = Stylegen::Generator.new(data)
-generator.generate
+exit Stylegen::CLI::App.run(ARGV)

data/lib/stylegen/cli.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "stylegen/cli/app"

data/lib/stylegen/cli/app.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "gli"
+
+require "stylegen/validator"
+require "stylegen/generator"
+
+module Stylegen
+  module CLI
+    class App
+      extend GLI::App
+
+      program_desc "CLI tool for managing colors in iOS apps"
+
+      version Stylegen::VERSION
+
+      default_command :build
+
+      # Commands
+
+      desc "Generates a sample theme.yaml file in the current directory"
+      command :init do |c|
+        c.action do
+          exit_now!("'theme.yaml' already exists!") if File.exist?("theme.yaml")
+
+          template = File.read(File.join(__dir__, "template.yaml"))
+          File.write("theme.yaml", template)
+
+          puts "Generated 'theme.yaml'."
+        end
+      end
+
+      desc "Generates the Swift colors file"
+      command :build do |c|
+        c.action do
+          exit_now!("'theme.yaml' not found. Create one with 'stylegen init'.") unless File.exist?("theme.yaml")
+
+          data = File.open("theme.yaml") { |file| YAML.safe_load(file) }
+
+          validator = Validator.new
+
+          unless validator.valid?(data)
+            message = []
+            message << "theme.yaml contains one or more errors:"
+
+            validator.validate(data).each do |e|
+              message << "  #{e}"
+            end
+
+            exit_now!(message.join("\n"))
+          end
+
+          generator = Generator.new(data)
+          generator.generate
+
+          puts "Generated '#{generator.stats[:output_path]}' with #{generator.stats[:color_count]} colors."
+        end
+      end
+    end
+  end
+end

data/lib/stylegen/cli/template.yaml

@@ -0,0 +1,42 @@
+# Name of the design system. Defaults to "Theme".
+# Feel free to use your company name, name of product,
+# or name of your design system.
+# e.g.: Primer, Material, Polaris, etc.
+# system_name: "Theme"
+
+# Path of generated Swift file.
+output_path: "Colors.swift"
+
+# Key-value pairs of theme colors.
+colors:
+
+  accent: # Keys will be used as color names.
+    color: "#00BFC2" # Hex color
+
+  # Shorthand syntax
+  warning: "#ED4337"
+
+  text_primary:
+    light: # Value for light mode
+      color: "#000000"
+      # Optionally you can specify an alpha value.
+      # Defaults to `1.0`.
+      alpha: 0.95
+    dark: # Value for dark mode
+      color: "#FFFFFF"
+
+  text_secondary:
+    light:
+      color: "#000000"
+      alpha: 0.4
+    dark:
+      color: "#FFFFFF"
+      alpha: 0.6
+
+  primary_background:
+    light: "#FFFFFF"
+    dark:
+      # Value for base (non-elevated) level
+      base: "#0D0D0D"
+      # Value for elevated level
+      elevated: "#191D1D"

data/lib/stylegen/data.rb

@@ -43,8 +43,8 @@ module Stylegen
     end
 
     def colors
-      @data["colors"].each do |key, value|
-        yield inflector.camelize_lower(key), generate_color(value)
+      @colors ||= @data["colors"].map do |key, value|
+        [inflector.camelize_lower(key), generate_color(value)]
       end
     end
 

data/lib/stylegen/generator.rb

@@ -20,6 +20,10 @@ module Stylegen
       generate_extensions
     end
 
+    def stats
+      @stats ||= { output_path: @data.output_path, color_count: @data.colors.count }
+    end
+
     private
 
     def generate_header
@@ -89,7 +93,7 @@ module Stylegen
       out "#{@data.access_level} extension #{@data.struct_name} {"
       out ""
 
-      @data.colors do |member, color|
+      @data.colors.each do |member, color|
         out "    static let #{member} = #{color.to_s(@data.struct_name, 4)}"
         out ""
       end

data/lib/stylegen/version.rb

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

data/stylegen.gemspec

@@ -16,11 +16,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.license = "MIT"
 
-  s.add_runtime_dependency "dry-inflector", ">= 0.2.0"
-  s.add_runtime_dependency "json_schemer", ">= 0.2.0"
+  s.add_runtime_dependency "dry-inflector", "~> 0.2.0"
+  s.add_runtime_dependency "gli", "~> 2.1"
+  s.add_runtime_dependency "json_schemer", "~> 0.2.0"
 
   s.add_development_dependency "bundler"
-  s.add_development_dependency "minitest", ">= 5.14.0"
+  s.add_development_dependency "minitest", "~> 5.14"
   s.add_development_dependency "rake"
   s.add_development_dependency "rubocop"
   s.add_development_dependency "rubocop-minitest"

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: stylegen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ramon Torres
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: json_schemer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
@@ -56,16 +70,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.14.0
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +154,9 @@ files:
 - Rakefile
 - bin/stylegen
 - lib/stylegen.rb
+- lib/stylegen/cli.rb
+- lib/stylegen/cli/app.rb
+- lib/stylegen/cli/template.yaml
 - lib/stylegen/colors.rb
 - lib/stylegen/colors/base_elevated_color.rb
 - lib/stylegen/colors/color.rb
@@ -173,8 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Tool for generating styling code for iOS apps