redbreast 0.1.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acb449e6185cec29a8b5db4b37b9c2d1171a8cee
-  data.tar.gz: ed1ca1fae6e110d58b10bf64368a3292fa60d213
+SHA256:
+  metadata.gz: a61b421737d7f28ab41362cb78ad00e3fd2246588e6346938dbe3589c82320e7
+  data.tar.gz: ca241430323a6822e1b1943e67ebf1dddec6ea663e26fde0cd3d792d97f30f17
 SHA512:
-  metadata.gz: caeabd7ec6255affe9e59c2e5c56bd9bba1ada4bc0ae62a8294385df7cd141fedcdbe7995ed56b607b71f0215f7fec6668c9f4007914a2971551a22693ced72f
-  data.tar.gz: 89e95780148d0e1ce307d1ac2965c96612663a9c1ac7910b3acfa686f4efd2a65033f5ac95930e6cba0c5d0879554e47cd232947e51ee947861a8e388d807e7e
+  metadata.gz: 5cdb3304c7d176836430c1ec41826071a8544f171b0f9004f87a5a11da2bb7a817e79cfc28ca4662a44f5084b85bdf83f491a831a930b94b80e009610bcc1f0a
+  data.tar.gz: a3257f6b265ed44b1f1a7fe12326002838e3f25c063001051c2b550ff716898621491157e4948855706f52fe748ff5ded3560db968e4fa40b1c986ce9815c5f3

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Layout/LineLength:
+  Max: 100
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/README.md

@@ -18,20 +18,118 @@ Or install it yourself as:
 
     $ gem install redbreast
 
+## Description
+
+Redbreast is a gem used for generating extensions (categories) of UIImage or UIColor. In Swift it creates computed properties of images or colors that are in your assets folder. While in Objective-C it creates static methods that returns UIImage or UIColor object.
+
+ ### 	Example ###
+
+In this example we will show how will your extensions (catergories) look like after using Redbreast.
+
+Lets say this is how your *Images.xcassets* folder looks like:
+
+```
+Images.xcassets
+    └── App // namespaced
+    │    └── Admin // namespaced
+    │    │   └── Report.imageset
+    │    │   └── User.imageset
+    │    └── Course
+    │        └── Assignment.imageset
+    │
+    └── AppLogo.imageset
+    │
+    └── Arrows
+        └── DownArrow.imageset
+```
+
+*App* and *Admin* are namespaced folders while *Course* and *Arrows* are not. If a folder is namespaced, enum with that folder name will appear in the exension and path to that image will contain folder name. In the other case, folders are ignored and images belong to the last namespaced folder.
+
+Redbreast will generate a file similar to this one varying on app name (more in Usage chapter). As you can see *Arrows* folder is not namespaced so there isn't an enum called *Arrows*. Because of this *downArrow* is in root of extension and is accessed by writing `UIImage.downArrow`. *Report* image is in two namespaced folders (*App* and *Admin*) so path for it is *App/Admin* and it located inside both enums. *Report* is accessed by `UIImage.App.Admin.report`.
+
+```swift
+extension UIImage {
+
+  static var appLogo: UIImage { return UIImage(named: "AppLogo", in: .main, compatibleWith: nil)! }
+  static var downArrow: UIImage { return UIImage(named: "DownArrow", in: .main, compatibleWith: nil)! }
+
+  enum App {
+
+    enum Admin {
+      static var report: UIImage { return UIImage(named: "App/Admin/Report", in: .main, compatibleWith: nil)! }
+      static var user: UIImage { return UIImage(named: "App/Admin/User", in: .main, compatibleWith: nil)! }
+    }
+			  
+  static var assignment: UIImage { return UIImage(named: "App/Assignment", in: .main, compatibleWith: nil)! }
+  }
+}
+```
+
+In Objective-C .h and .m files are generated. Because enums don't exist in Objc folder names are used in method name instead. Everything else is the same as in Swift.
+```objc
+@implementation UIImage (ApplicationName)
+
++ (UIImage *)appLogo
+{
+	return [UIImage imageNamed:@"AppLogo" inBundle:[NSBundle mainBundle] compatibleWithTraitCollection:nil];
+}
+
++ (UIImage *)downArrow
+{
+	return [UIImage imageNamed:@"DownArrow" inBundle:[NSBundle mainBundle] compatibleWithTraitCollection:nil];
+}
+
++ (UIImage *)appAdminReport
+{
+	return [UIImage imageNamed:@"App/Admin/Report" inBundle:[NSBundle mainBundle] compatibleWithTraitCollection:nil];
+}
+
++ (UIImage *)appAdminUser
+{
+	return [UIImage imageNamed:@"App/Admin/User" inBundle:[NSBundle mainBundle] compatibleWithTraitCollection:nil];
+}
+
++ (UIImage *)appAssignment
+{
+	return [UIImage imageNamed:@"App/Assignment" inBundle:[NSBundle mainBundle] compatibleWithTraitCollection:nil];
+}
+
+@end
+```
+
+For more examples checkout the sample project.
+
 ## Usage
 
-TODO: Write usage instructions here
+### Init
 
-## Development
+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:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* Choose a language in which colors/images will be generated.
+* Input the application name (optional)
+* Input bundle names (default is main)
+* 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
 
-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).
+### Generate
+
+When you finish creating `redbreast.yml` file,  run `redbreast generate` and all needed files will be generated.
+
+### Install
+
+Command `redbreast install` will setup a file generator in your project and whenever you build it, it will create new image/color names. 
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/redbreast. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "redbreast"
+require 'bundler/setup'
+require 'redbreast'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "redbreast"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/exe/redbreast

@@ -12,7 +12,7 @@ program :description, 'An iOS client for safe and strong resources.'
 command :init do |c|
   c.syntax = 'redbreast init'
   c.description = 'Sets up a redbreast.yml config for selected project.'
-  c.action do |_args, options|
+  c.action do
     Redbreast::ErrorHandler.rescuable do
       Redbreast::Command::Setup.init
     end
@@ -21,11 +21,23 @@ end
 
 command :generate do |c|
   c.syntax = 'redbreast generate'
-  c.description = 'Generate images strong reference files.'
-  c.action do |_args, options|
+  c.description = 'Generate images and colors strong reference files.'
+  c.action do
     Redbreast::ErrorHandler.rescuable do
+      Redbreast::Command::ColorGenerator.init
       Redbreast::Command::ImageGenerator.init
-      Redbreast::Command::TestGenerator.init
+      Redbreast::Command::ColorTestGenerator.init
+      Redbreast::Command::ImageTestGenerator.init
     end
   end
-end
+end
+
+command :install do |c|
+  c.syntax = 'redbreast install'
+  c.description = 'Sets up file generator in your xcproject build phases. Whenewer you run a buld, new image/color names will be created'
+  c.action do
+    Redbreast::ErrorHandler.rescuable do
+      Redbreast::Command::ConfigurationInstaller.init
+    end
+  end
+end

data/lib/redbreast.rb

@@ -1,22 +1,27 @@
 # Parsing
-require "yaml"
-require "erb"
+
+require 'yaml'
+require 'erb'
 
 # Helpers
-require "redbreast/helpers/terminal"
-require "redbreast/helpers/general"
-require "redbreast/helpers/hash"
+require 'redbreast/helpers/terminal'
+require 'redbreast/helpers/general'
+require 'redbreast/helpers/hash'
 
 # Commands
-require "redbreast/commands/setup"
-require "redbreast/commands/image_generator"
-require "redbreast/commands/test_generator"
+require 'redbreast/commands/setup'
+require 'redbreast/commands/image_generator'
+require 'redbreast/commands/color_generator'
+require 'redbreast/commands/image_test_generator'
+require 'redbreast/commands/color_test_generator'
+require 'redbreast/commands/configuration_installer'
 
 # File Accessors
-require "redbreast/io/config"
+require 'redbreast/io/config'
 
 # Crawlers
-require "redbreast/crawlers/image_crawler"
+require 'redbreast/crawlers/image_crawler'
+require 'redbreast/crawlers/color_crawler'
 
 # Serializers
 require 'redbreast/serializers/serializer'
@@ -28,16 +33,19 @@ require 'redbreast/template_generators/objc_template_generator'
 require 'redbreast/template_generators/swift_template_generator'
 require 'redbreast/template_generators/images/objc_images_template_generator'
 require 'redbreast/template_generators/images/swift_images_template_generator'
-require 'redbreast/template_generators/tests/objc_tests_template_generator'
-require 'redbreast/template_generators/tests/swift_tests_template_generator'
+require 'redbreast/template_generators/colors/objc_colors_template_generator'
+require 'redbreast/template_generators/colors/swift_colors_template_generator'
+require 'redbreast/template_generators/tests/colors/objc_colors_tests_template_generator'
+require 'redbreast/template_generators/tests/colors/swift_colors_tests_template_generator'
+require 'redbreast/template_generators/tests/images/objc_images_tests_template_generator'
+require 'redbreast/template_generators/tests/images/swift_images_tests_template_generator'
 
 # Error Handler
-require "redbreast/error_handler"
+require 'redbreast/error_handler'
 
 # Version
-require "redbreast/version"
-
+require 'redbreast/version'
 
+# Program used for creating images and colors
 module Redbreast
-
-end
+end

data/lib/redbreast/commands/color_generator.rb

@@ -0,0 +1,54 @@
+module Redbreast
+  module Command
+    # Class for generating color files
+    class ColorGenerator
+      include Helper::Terminal
+      include Helper::General
+
+      def self.init
+        new.call
+      end
+
+      def call
+        return if bundles.first[:outputSourcePathColors].nil?
+
+        prompt.say('Generating color resources...')
+        generate_color_sources(bundles, programming_language, app_name)
+        success('Color resources generated!')
+      end
+
+      private
+
+      def generate_color_sources(bundles, programming_language, app_name)
+        bundles.each do |bundle|
+          color_names = pull_asset_names(bundle[:assetsSearchPath])
+          write_colors(color_names, bundle, programming_language, app_name)
+        end
+      end
+
+      # Serializing data
+
+      def write_colors(color_names, bundle, programming_language, app_name)
+        output_path = bundle[:outputSourcePathColors]
+        return if output_path.to_s.empty?
+
+        case programming_language.downcase
+        when 'objc'
+          serializer = Redbreast::Serializer::ObjC
+          template_generator = Redbreast::TemplateGenerator::Color::ObjC
+        when 'swift'
+          serializer = Redbreast::Serializer::Swift
+          template_generator = Redbreast::TemplateGenerator::Color::Swift
+        end
+        serializer.new(color_names, bundle, app_name).save(output_source_path: output_path, template_generator: template_generator.new, generate_colors: true)
+      end
+
+      # Pulling data
+
+      def pull_asset_names(assetsSearchPath)
+        Redbreast::Crawler::Color
+          .color_names_uniq(assetsSearchPath)
+      end
+    end
+  end
+end

data/lib/redbreast/commands/color_test_generator.rb

@@ -0,0 +1,57 @@
+module Redbreast
+  module Command
+    # Class for creating color tests
+    class ColorTestGenerator
+      include Helper::Terminal
+      include Helper::General
+
+      def self.init
+        new.call
+      end
+
+      def call
+        filtered_bundles = bundles.select { |bundle| bundle[:outputTestPathColors] }
+        return if filtered_bundles.empty?
+
+        prompt.say('Generating color test resources...')
+        generate_test_sources(bundles, programming_language, app_name)
+        success('Color test resources generated!')
+      end
+
+      private
+
+      def generate_test_sources(bundles, programming_language, app_name)
+        bundles.each do |bundle|
+          color_names = pull_asset_names(bundle[:assetsSearchPath])
+          write_tests(color_names, bundle, programming_language, app_name)
+        end
+      end
+
+      # Serializing data
+
+      def write_tests(color_names, bundle, programming_language, app_name)
+        output_path = bundle[:outputTestPathColors]
+
+        return if output_path.to_s.empty?
+
+        case programming_language.downcase
+        when 'objc'
+          serializer = Redbreast::Serializer::ObjC
+          template_generator = Redbreast::TemplateGenerator::ColorTest::ObjC
+        when 'swift'
+          serializer = Redbreast::Serializer::Swift
+          template_generator = Redbreast::TemplateGenerator::ColorTest::Swift
+        end
+        serializer.new(color_names, bundle, app_name).save(output_source_path: output_path, template_generator: template_generator.new, generate_colors: true)
+
+      end
+
+      # Pulling data
+
+      def pull_asset_names(assetsSearchPath)
+        Redbreast::Crawler::Color
+          .color_names_uniq(assetsSearchPath)
+      end
+    end
+  end
+end

data/lib/redbreast/commands/configuration_installer.rb

@@ -0,0 +1,37 @@
+require 'xcodeproj'
+
+module Redbreast
+  module Command
+    # Class for installing configuration
+    class ConfigurationInstaller
+      include Helper::Terminal
+      include Helper::General
+      def self.init
+        new.call
+      end
+
+      def call
+        prompt.say('Adding generation script to xcode buid phases...')
+        project = fetch_project
+        configure_target project.targets.first
+        project.save
+        success('Build phase setup!')
+      end
+
+      private
+
+      def fetch_project
+        path = Dir.glob('*.xcodeproj').first
+        raise '.xcodeproj file not found' if path.nil?
+
+        Xcodeproj::Project.open(path)
+      end
+
+      def configure_target(target)
+        puts target.build_phases.class
+        phase = target.new_shell_script_build_phase('Redbreast generate')
+        phase.shell_script = "PATH=$PATH:~/.rbenv/shims\nredbreast generate"
+      end
+    end
+  end
+end

data/lib/redbreast/commands/image_generator.rb

@@ -1,53 +1,55 @@
 module Redbreast
-    module Command
-      class ImageGenerator
-        include Helper::Terminal
-        include Helper::General
-  
-        def self.init
-          new.call
-        end
-  
-        def call
-          prompt.say("Generating image resources...")
-          generate_image_sources(bundles, programming_language)
-          success("Image resources generated!")
-        end
-  
-        private
-  
-        def generate_image_sources(bundles, programming_language)
-            bundles.each do |bundle|
-            image_names = pull_asset_names(bundle[:assetsSearchPath])
-            
-            write_images(image_names, bundle, programming_language)
-          end
-        end
-  
-        # Serializing data
-  
-        def write_images(image_names, bundle, programming_language)
-          output_path = bundle[:outputSourcePath]
-          return if output_path.to_s.empty?
-          case programming_language.downcase
-          when "objc"
-            serializer = Redbreast::Serializer::ObjC
-            template_generator = Redbreast::TemplateGenerator::Image::ObjC
-          when "swift"
-            serializer = Redbreast::Serializer::Swift
-            template_generator = Redbreast::TemplateGenerator::Image::Swift
-          end
-          serializer.new(image_names, bundle).save(output_path, template_generator.new)
+  module Command
+    # Class for creating images
+    class ImageGenerator
+      include Helper::Terminal
+      include Helper::General
+
+      def self.init
+        new.call
+      end
+
+      def call
+        return if bundles.first[:outputSourcePathImages].nil?
+
+        prompt.say('Generating image resources...')
+        generate_image_sources(bundles, programming_language, app_name)
+        success('Image resources generated!')
+      end
+
+      private
+
+      def generate_image_sources(bundles, programming_language, app_name)
+        bundles.each do |bundle|
+          image_names = pull_asset_names(bundle[:assetsSearchPath])
+          write_images(image_names, bundle, programming_language, app_name)
         end
-  
-        # Pulling data
-  
-        def pull_asset_names(assetsSearchPath)
-            Redbreast::Crawler::Image
-            .image_names_uniq(assetsSearchPath)
+      end
+
+      # Serializing data
+
+      def write_images(image_names, bundle, programming_language, app_name)
+        output_path = bundle[:outputSourcePathImages]
+        return if output_path.to_s.empty?
+
+        case programming_language.downcase
+        when 'objc'
+          serializer = Redbreast::Serializer::ObjC
+          template_generator = Redbreast::TemplateGenerator::Image::ObjC
+        when 'swift'
+          serializer = Redbreast::Serializer::Swift
+          template_generator = Redbreast::TemplateGenerator::Image::Swift
         end
-  
+        serializer.new(image_names, bundle, app_name).save(output_source_path: output_path, template_generator: template_generator.new, generate_colors: false)
+
+      end
+
+      # Pulling data
+
+      def pull_asset_names(assetsSearchPath)
+        Redbreast::Crawler::Image
+          .image_names_uniq(assetsSearchPath)
       end
     end
   end
-  
+end