redbreast 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af297ef6e37a2914f39cefda66be835e4d8550728f87faebf68748843ba0e8d
-  data.tar.gz: c2b0b4251ae80070c635453c9988eec30d285e2a3e7cab4607a14aa10f54d220
+  metadata.gz: 58587403662d735b14fe0d4c0c1aa45acca3bfc7fa93a8c0f6c78bd604849d16
+  data.tar.gz: 8456066d1d95ede4fbb08fb14eae08cf78462fd241df238acf5baf31ad9ecd89
 SHA512:
-  metadata.gz: 7af2661161d5e3b4c6fd4764d4836065eb136494dbb70ff0767c51cb847ab66f9c6c631429267072a74fb255f22baa17bab18f95d7813ef287a21278a4d01690
-  data.tar.gz: 806e793afb6fe385b2207b96cc60bf239f58f249d1da38d048bd5f884c9d9ff3e76436dd124c0b983f06845898548040afff714b8be3353091daec87f2ea0d28
+  metadata.gz: 52f3181555a1500ea5b9ce30d41b3d97705a06ec18761e83f3c8918010e27bca3e0ba37965a52bef04345c41935e6dc0486e010a5ab63a1c4306498952f805f6
+  data.tar.gz: f01695bf88db097e5eb13e72472d32f08c62b63424f2a36cb1d8f39f1b4f7e29a2e4689ef2c8e4f38f6cbbc6024cf7fcb832ab0f7f3d73dda1a0f36b4cd468e4

data/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Infinum
+
+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/README.md

@@ -1,6 +1,10 @@
 # Redbreast
 
-![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/b8/Turdus-migratorius-002.jpg/440px-Turdus-migratorius-002.jpg)
+[![License](https://img.shields.io/cocoapods/l/SemanticVersioning.svg)](https://github.com/infinum/redbreast/blob/master/LICENSE.md)
+
+<p align="center">
+    <img src="redbreast.svg" width="300" max-width="50%" alt="Japx"/>
+</p>
 
 ## Installation
 
@@ -103,20 +107,82 @@ For more examples checkout the sample project.
 
 ### Init
 
-After installing redbreast run `redbreast init` to create `redbreast.yml` file. This file is used for generating your extensions.
+After installing redbreast run `redbreast init` to create `.redbreast.yml` file. This file is used for generating your extensions.
 In the init you will be prompted to:
 
 * Choose a language in which colors/images will be generated.
 * Input the application name (optional)
 * Input bundle names (default is main)
+* Input whether you want to omit namespacing (optional)
 * Choose whether you want to generate images, colors or both
 * Input the path to assets folder
 * Input the path where the files will be created
 * Choose to create tests for generated assets
 
+This is how your `.redbreast.yml` file should look after the `redbreast init` if you are using version 1.3.1 and lower:
+
+```yml
+---
+:language: swift
+:bundles:
+- :name: main
+  :reference: ".main"
+  :shouldOmitNamespace: false
+  :assetsSearchPath: "MyProject/**/*.xcassets"
+  :outputSourcePathImages: "./MyProject/Common/Extensions/UIImage+Redbreast.swift"
+  :outputSourcePathColors: "./MyProject/Common/Extensions/UIColor+Redbreast.swift"
+  :outputTestPathImages: "./MyProject-UnitTests/Common/Extensions/UIImageExtensionTest.swift"
+  :outputTestPathColors: "./MyProject-UnitTests/Common/Extensions/UIColorExtensionTest.swift"
+  :testableImport: MyProject
+:app_name: MyProject
+```
+
+Multiple language support is available from version 1.4.0. Example `.redbreast.yml` files from version 1.4.0 and higher:
+
+If you are using only one language:
+
+```yml
+---
+:bundles:
+- :language: swift
+  :name: main
+  :reference: ".main"
+  :assetsSearchPath: "MyProject/**/*.xcassets"
+  :outputSourcePathImages: "./MyProject/Common/Extensions/UIImage+Redbreast.swift"
+  :outputSourcePathColors: "./MyProject/Common/Extensions/UIColor+Redbreast.swift"
+  :outputTestPathImages: "./MyProject-UnitTests/Common/Extensions/UIImageExtensionTest.swift"
+  :outputTestPathColors: "./MyProject-UnitTests/Common/Extensions/UIColorExtensionTest.swift"
+  :testableImport: MyProject
+:app_name: MyProject
+```
+
+and if you are using two or more languages:
+
+```yml
+---
+:bundles:
+- :language: swift
+  :name: main
+  :reference: ".main"
+  :assetsSearchPath: "**/*.xcassets"
+  :outputSourcePathImages: ".MyProject/Common/Extensions/UIImageExtension.swift"
+  :outputTestPathImages: ".MyProject/Common/Extensions/UIImageExtensionTest.swift"
+  :testableImport: MyProject
+- :language: swiftui
+  :name: MyProjectUI
+  :reference: ".MyProjectUI"
+  :assetsSearchPath: "MyProject/**/*.xcassets"
+  :outputSourcePathImages: ".MyProject/Common/Extensions/ImageExtension.swift"
+  :outputSourcePathColors: ".MyProject/Common/Extensions/ColorExtension.swift"
+  :outputTestPathImages: ".MyProject/Common/Extensions/ImageExtensionTest.swift"
+  :outputTestPathColors: ".MyProject/Common/Extensions/ColorExtensionTest.swift"
+  :testableImport: MyProject
+:app_name: MyProject
+```
+
 ### Generate
 
-When you finish creating `redbreast.yml` file,  run `redbreast generate` and all needed files will be generated.
+When you finish creating `.redbreast.yml` file,  run `redbreast generate` and all needed files will be generated.
 
 ### Install
 
@@ -130,8 +196,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Credits
+
+Maintained and sponsored by [Infinum](http://www.infinum.com).
+<p align="center">
+  <a href='https://infinum.com'>
+    <picture>
+        <source srcset="https://assets.infinum.com/brand/logo/static/white.svg" media="(prefers-color-scheme: dark)">
+        <img src="https://assets.infinum.com/brand/logo/static/default.svg">
+    </picture>
+  </a>
+</p>

data/lib/redbreast/commands/color_generator.rb

@@ -24,7 +24,9 @@ module Redbreast
         bundles.each do |bundle|
           color_names = pull_asset_names(bundle[:assetsSearchPath])
           bundle_language = bundle[:language] || programming_language 
-          write_colors(color_names, bundle, bundle_language, app_name)
+          shouldOmitNamespace = bundle[:shouldOmitNamespace]
+          namespace = shouldOmitNamespace ? '' : app_name
+          write_colors(color_names, bundle, bundle_language, namespace)
         end
       end
 

data/lib/redbreast/commands/image_generator.rb

@@ -24,7 +24,9 @@ module Redbreast
         bundles.each do |bundle|
           image_names = pull_asset_names(bundle[:assetsSearchPath])
           bundle_language = bundle[:language] || programming_language
-          write_images(image_names, bundle, bundle_language, app_name)
+          shouldOmitNamespace = bundle[:shouldOmitNamespace]
+          namespace = shouldOmitNamespace ? '' : app_name
+          write_images(image_names, bundle, bundle_language, namespace)
         end
       end
 

data/lib/redbreast/commands/setup.rb

@@ -18,11 +18,11 @@ module Redbreast
       end
 
       def call
-        language = language_prompt
         app_name = app_name_prompt
-        bundle_names = bundle_names_prompt(language).split(' ')
-        assets_types = assets_types_prompt
+        bundle_names = bundle_names_prompt().split(' ')
         bundles = bundle_names.map do |bundle|
+          language = language_prompt(bundle)
+          assets_types = assets_types_prompt(bundle)
           reference = bundle_reference(bundle, language)
           assets_search_path = assets_search_path_prompt(bundle)
           output_source_path_images = assets_types == 1 ? nil : images_sources_path_prompt(bundle, language)
@@ -31,6 +31,7 @@ module Redbreast
           output_test_path_images = assets_types != 1 && include_tests ? images_tests_path_prompt(bundle, language) : nil
           output_test_path_colors = assets_types != 0 && include_tests ? colors_tests_path_prompt(bundle, language) : nil
           fields = {
+            language: language,
             name: bundle,
             reference: reference,
             assetsSearchPath: assets_search_path,
@@ -43,7 +44,6 @@ module Redbreast
           compact fields
         end
         config = {
-          language: language,
           bundles: bundles,
           app_name: app_name
         }
@@ -55,9 +55,9 @@ module Redbreast
 
       # Language
 
-      def language_prompt
+      def language_prompt(bundle)
         languages = { 'Swift' => 'swift', 'SwiftUI' => 'swiftui', 'Objective-C' => 'objc', }
-        prompt.select('Choose a language: ', languages)
+        prompt.select("Choose a language for bundle #{bundle}: ", languages)
       end
 
       # Assets source path
@@ -69,16 +69,9 @@ module Redbreast
 
       # Bundle names promt
 
-      def bundle_names_prompt(language)
-        prompt_text = 'Please enter bundle names that you use separated by spaces'
-        case language
-        when 'objc'
-          prompt.ask(prompt_text, default: 'mainBundle')
-        when 'swift'
-          prompt.ask(prompt_text, default: 'main')
-        when 'swiftui'
-          prompt.ask(prompt_text, default: 'main')
-        end
+      def bundle_names_prompt()
+        prompt_text = 'Please enter bundle names that you use separated by spaces. For Obj-C use mainBundle.'
+        prompt.ask(prompt_text, default: 'main')
       end
 
       def bundle_reference(bundle_name, language)
@@ -95,7 +88,7 @@ module Redbreast
       # Images source path
 
       def images_sources_path_prompt(bundle, language)
-        prompt_text = "Where would you like to store images resources files for bundle #{bundle}?"
+        prompt_text = "Where would you like to store image resources files for bundle #{bundle}?"
         case language
         when 'objc'
           prompt.ask(prompt_text, default: './Common/Categories/Images')
@@ -109,7 +102,7 @@ module Redbreast
       # Colors source path
 
       def colors_sources_path_prompt(bundle, language)
-        prompt_text = "Where would you like to store colors resources files for bundle #{bundle}?"
+        prompt_text = "Where would you like to store color resources files for bundle #{bundle}?"
         case language
         when 'objc'
           prompt.ask(prompt_text, default: './Common/Categories/Colors')
@@ -127,7 +120,7 @@ module Redbreast
       end
 
       def images_tests_path_prompt(bundle, language)
-        prompt_text = "Where would you like to store tests for bundle #{bundle}?"
+        prompt_text = "Where would you like to store image tests for bundle #{bundle}?"
         case language
         when 'objc'
           prompt.ask(prompt_text, default: './Common/Categories/ImagesTest')
@@ -139,7 +132,7 @@ module Redbreast
       end
 
       def colors_tests_path_prompt(bundle, language)
-        prompt_text = "Where would you like to store tests for bundle #{bundle}?"
+        prompt_text = "Where would you like to store color tests for bundle #{bundle}?"
         case language
         when 'objc'
           prompt.ask(prompt_text, default: './Common/Categories/ColorsTest')
@@ -169,9 +162,9 @@ module Redbreast
 
       # Assets type prompt
 
-      def assets_types_prompt
+      def assets_types_prompt(bundle)
         types = { 'Images' => 0, 'Colors' => 1, 'Both' => 2 }
-        prompt.select('Choose a type: ', types)
+        prompt.select("Choose a type for bundle #{bundle}: ", types)
       end
     end
   end

data/lib/redbreast/version.rb

@@ -1,3 +1,3 @@
 module Redbreast
-  VERSION = '1.4.0'
+  VERSION = '1.4.2'
 end

data/redbreast.svg

@@ -0,0 +1,8 @@
+<svg width="80" height="80" viewBox="0 0 80 80" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M35 60.5L29.5 74.5L42 65.5L53.5 74.5L49 60.5" stroke="#D82828" stroke-width="4" stroke-linejoin="round"/>
+<path d="M63 33C63 47.1199 53.3093 58 42 58C30.6907 58 21 47.1199 21 33C21 18.8801 30.6907 8 42 8C53.3093 8 63 18.8801 63 33Z" stroke="#D82828" stroke-width="4"/>
+<path d="M63 34.5C63 27.5 50.5 18.5 42 30.5C38 25.5001 28.2 19.3001 21 34.5" stroke="#D82828" stroke-width="4"/>
+<circle cx="36" cy="16" r="3" fill="#D82828"/>
+<path d="M31 12H16L23 20.5" stroke="#D82828" stroke-width="4" stroke-linejoin="round"/>
+<path d="M58.5 50H63C64.1046 50 65 50.8954 65 52V58C65 59.1046 64.1046 60 63 60H21C19.8954 60 19 59.1046 19 58V52C19 50.8954 19.8954 50 21 50H26.5" stroke="#D82828" stroke-width="4"/>
+</svg>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redbreast
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Maroje
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
@@ -178,6 +178,7 @@ files:
 - lib/redbreast/template_generators/tests/images/swiftui_images_tests_template_generator.rb
 - lib/redbreast/version.rb
 - redbreast.gemspec
+- redbreast.svg
 homepage: https://github.com/infinum/redbreast
 licenses:
 - MIT

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Vlaho
-
-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.