fastlane-plugin-framer 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e9290f3e19124b67452ff24982ca4f1eff09b19
-  data.tar.gz: 4f5b1035d851c4c5b6dab6aca9c7f9f597faa639
+  metadata.gz: 4c4b531a62b518edcbfb5ef5d6696cd3a109511b
+  data.tar.gz: b85e2d2e122b8f4c32497f4b5274729793b44a64
 SHA512:
-  metadata.gz: 803aa2a181b6d28ee43cfb7231308d678ae9aec6b4c82a0aa0234e572854d414da72326b396a7c019ed2bebcf900a256cbae73b20572d3ea409bc2b6ec6c8dfc
-  data.tar.gz: a4604d3b991a74bcbab6ea41aa5b9b959d9369ebc1c83d4e5b52c837260faf42411f3ce5432b82449a88217627c0256594f23d2c54f57b622f50e68128ace342
+  metadata.gz: 75f7533dbabe59ff64b89e884440da4bbe438101dd851f600a79ad2434ccc2e5a63ead9709df95a7c45622a1b7941ba864470198df7054ecdece69d6eb9422dd
+  data.tar.gz: 8af5b26a8ffd8881c3b945173ce4b1bad502f5bf24b7007abaff2cfb96cbf6818877f33354eb520f7279312c1979d61336c5ba1e3f36ea5ba29e2165743ec7db

data/README.md

@@ -24,11 +24,11 @@ You can specify the position and the size of the screen in the template and (opt
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. 
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin.
 
 There are 2 lanes, one for a simple flow (`demo-1`) and another with more languages and screens (`demo-2`).
 
-Try them by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane demo_1` or `bundle exec fastlane demo_2`. 
+Try them by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane demo_1` or `bundle exec fastlane demo_2`.
 
 ## Configuration
 
@@ -42,7 +42,7 @@ The **framer** action support 4 optional parameters (default values are used).
 
 | Option            | Description     | Default        |
 | ----------------- | -------- | ------------ |
-| `source_folder`   | path to the folder that contains raw screenshots and `text.json` file | `./fastlane/framer/screens` | 
+| `source_folder`   | path to the folder that contains raw screenshots and `text.json` file | `./fastlane/framer/screens` |
 | `template_folder` | path to the folder that contains the templates images and configuration | `./fastlane/framer/templates` |
 | `output_folder`   | path to the folder that will contains the final images, framed. Used then by `deliver` | `./fastlane/screenshots` (default one for `deliver`) |
 | `output_suffix`   | filenam suffix for the framed images | `-framed` |
@@ -101,6 +101,26 @@ If you want some text in the final framed images, you need to create a `text.jso
 `text.json` is a simple map where *key* is the part of the screenshot filename (I suggest the same string you use with the `snapshot()` command on your UI tests.
 The *value* can be any strings.
 
+### Colors
+
+You can customize the color of the text and the background color applyed below the template (if you have transparencies on the template, you can fill them with the background color).
+
+`colors.json` is a simple map where *key* is the part of the screenshot filename. The *value* is a map with 2 optional keys, *text* and *background*.
+
+```
+{
+  "default": {
+    "background": "#00FFFF",
+    "text": "#FFFFFF"
+  },
+  "demo": {
+    "background": "#FF00FF",
+  }
+}
+```
+
+Default values can be defined inside the *default* map.
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
@@ -108,7 +128,7 @@ To run both the tests, and code style validation, run
 rake
 ```
 
-To automatically fix many of the styling issues, use 
+To automatically fix many of the styling issues, use
 ```
 rubocop -a
 ```

data/lib/fastlane/plugin/framer/actions/framer_action.rb

@@ -3,13 +3,31 @@ require 'json'
 
 module Fastlane
   module Actions
+
     class Template
       attr_accessor :name
-      attr_accessor :size
+      attr_accessor :width, :height
 
       attr_accessor :file
       attr_accessor :imageOffset, :imageWidth, :imageBelow
-      attr_accessor :textOffsetX, :textOffsetY, :textWidth, :textHeight, :textPadding, :textSize, :textFont, :textColor
+      attr_accessor :textOffsetX, :textOffsetY, :textWidth, :textHeight, :textPadding, :textSize, :textFont
+    end
+
+    class Colors
+      attr_accessor :text, :background
+
+      def merge(other)
+        unless other.text.nil? || other.text.empty?
+          self.text = other.text
+        end
+        unless other.background.nil? || other.background.empty?
+          self.background = other.background
+        end
+      end
+
+      def to_s
+        "{ text: #{self.text}, background: #{self.background} }"
+      end
     end
 
     class FramerAction < Action
@@ -29,20 +47,23 @@ module Fastlane
           UI.message "Processing #{file}"
 
           template = self.find_template(templates, file)
-          text = self.find_text(source_folder, file)
-          output = self.find_output(source_folder, file, output_folder, params[:output_suffix])
-
           if template.nil?
             UI.error "Unable to find template for screenshot #{file}"
             next
           end
+          UI.message "Using template: #{template.name} (#{template.width}x#{template.height})"
 
-          UI.verbose "Using template: #{template.name} (#{template.size})"
-          UI.verbose "Using text: #{text}"
-          UI.verbose "Saving to: #{output}"
+          text = self.find_text(source_folder, file)
+          UI.message "Using text: #{text}"
+
+          colors = self.find_colors(source_folder, file)
+          UI.message "Using colors: #{colors}"
+
+          output = self.find_output(source_folder, file, output_folder, params[:output_suffix])
+          UI.message "Saving to: #{output}"
 
           # Do the magic
-          self.combine(file, template, text, output)
+          self.combine(file, template, colors, text, output)
 
           UI.verbose "Framed screenshot #{output}"
         end
@@ -76,7 +97,8 @@ module Fastlane
 
           # Read template image size
           img = MiniMagick::Image.open(file)
-          template.size = "#{img.width}x#{img.height}"
+          template.width = img.width
+          template.height = img.height
           img.destroy!
 
           # Get template config
@@ -92,7 +114,6 @@ module Fastlane
           template.imageWidth   = (config_custom['image'] && config_custom['image']['width']) || (config_default['image'] && config_default['image']['width'])
           template.imageBelow   = (config_custom['image'] && config_custom['image']['add_below']) || (config_default['image'] && config_default['image']['add_below']) || false
 
-          template.textColor    = (config_custom['text'] && config_custom['text']['color']) || (config_default['text'] && config_default['text']['color'])
           template.textFont     = (config_custom['text'] && config_custom['text']['font']) || (config_default['text'] && config_default['text']['font'])
           template.textSize     = (config_custom['text'] && config_custom['text']['size']) || (config_default['text'] && config_default['text']['size'])
           template.textWidth    = (config_custom['text'] && config_custom['text']['width']) || (config_default['text'] && config_default['text']['width'])
@@ -108,22 +129,20 @@ module Fastlane
       end
 
       def self.find_template(templates, screenshot_file)
-        # Read screenshot image size
-        img = MiniMagick::Image.open(screenshot_file)
-        size = "#{img.width}x#{img.height}"
-        img.destroy!
+        # Read device name from file
+        filename = File.basename(screenshot_file)
+        device = filename.slice(0, filename.rindex('-'))
 
         # Search template that matches that size
-        return templates.find { |template| template.size == size }
+        return templates.find { |template| template.name == device }
       end
 
       def self.find_text(source_dir, screenshot_file)
         directory = File.dirname(screenshot_file)
         strings_path = File.join(directory, "text.json")
 
-        while !File.exist?(strings_path) do
+        while directory.start_with?(source_dir) && !File.exist?(strings_path) do
           directory = File.dirname(directory)
-          break if directory == source_dir
           strings_path = File.join(directory, "text.json")
         end
 
@@ -135,6 +154,46 @@ module Fastlane
         return result.last if result
       end
 
+      def self.find_colors(source_dir, screenshot_file)
+
+        # Default values
+        colors = Colors.new
+        colors.text = "#000000"
+        colors.background = nil
+
+        # Read values from file
+        directory = File.dirname(screenshot_file)
+        colors_path = File.join(directory, "colors.json")
+
+        while directory.start_with?(source_dir) && !File.exist?(colors_path) do
+          directory = File.dirname(directory)
+          colors_path = File.join(directory, "colors.json")
+        end
+
+        if File.exist?(colors_path)
+          config = JSON.parse(File.read(colors_path))
+
+          # Read default values
+          default = Colors.new
+          default.text = config['default']['text']
+          default.background = config['default']['background']
+          colors.merge(default)
+
+          # Read and apply override, if any
+          override = config.select { |k, v| File.basename(screenshot_file).upcase.include? k.upcase }.values.map { |value|
+            c = Colors.new
+            c.text = value['text']
+            c.background = value['background']
+            c
+          }
+          unless override.empty?
+            colors.merge(override.first)
+          end
+        end
+
+        return colors
+      end
+
       def self.find_output(source_folder, screenshot_file, output_folder, output_suffix)
         # Prepare file name
         if output_suffix.empty?
@@ -158,7 +217,19 @@ module Fastlane
         return file_path
       end
 
-      def self.combine(screenshot_file, template, text, output_file)
+      def self.combine(screenshot_file, template, colors, text, output_file)
+
+        # Prepare base image
+        result_img = MiniMagick::Image.open("#{Framer::ROOT}/assets/background.png")
+        result_img.resize "#{template.width}x#{template.height}!" # `!` says it should ignore the ratio
+
+        # Apply background color, if any
+        unless colors.background.nil?
+          result_img.combine_options do |c|
+            c.fill "#{colors.background}"
+            c.draw "rectangle 0,0,#{template.width},#{template.height}"
+          end
+        end
 
         # Get template image
         template_img = MiniMagick::Image.open(template.file)
@@ -171,29 +242,27 @@ module Fastlane
 
         # Put screenshot over template
         if template.imageBelow
-          
-          # Create a blank image
-          base_1_img = MiniMagick::Image.open("#{Framer::ROOT}/assets/background.png")
-          base_1_img.resize "#{template.size}!" # `!` says it should ignore the ratio
 
           # Screenshot first
-          base_2_img = base_1_img.composite(screenshot_img) do |c|
+          result_img = result_img.composite(screenshot_img) do |c|
             c.compose "Over"
             c.geometry template.imageOffset.to_s
           end
-          
+
           # Template second
-          result_img = base_2_img.composite(template_img) do |c|
+          result_img = result_img.composite(template_img) do |c|
             c.compose "Over"
           end
 
-          base_1_img.destroy!
-          base_2_img.destroy!
-
         else
 
-          # Screenshot over template, in one shot
-          result_img = template_img.composite(screenshot_img) do |c|
+          # Template first
+          result_img = result_img.composite(template_img) do |c|
+            c.compose "Over"
+          end
+
+          # Screenshot second
+          result_img = result_img.composite(screenshot_img) do |c|
             c.compose "Over"
             c.geometry template.imageOffset.to_s
           end
@@ -217,7 +286,7 @@ module Fastlane
             c.pointsize template.textSize.to_s
             c.gravity "Center"
             c.draw "text 0,0 '#{text}'"
-            c.fill template.textColor.to_s
+            c.fill colors.text.to_s
           end
           text_img.trim # remove white space
 
@@ -255,7 +324,7 @@ module Fastlane
         result_img.destroy!
         screenshot_img.destroy!
         template_img.destroy!
-        
+
       end
 
       def self.create_dir_if_not_exists(path)

data/lib/fastlane/plugin/framer/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Framer
-    VERSION = "0.2.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-framer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - DrAL3X
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick