fastlane-plugin-framer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ac4706b2a926352904eaaae3091e02ebf3ff9f2
-  data.tar.gz: 3746ed04028126a2fcbfb3a7be5e5128cba0f6cd
+  metadata.gz: ead286739a4dc5358d1ce3b78445e2be9d1b998b
+  data.tar.gz: 52b60581ce5c3dda8011a98b38e52aaa36395558
 SHA512:
-  metadata.gz: 942ac782050e71f02d823755eb6b38f1618ec3f5ed57c2f54db139344a1c16287eea1596b2a81ca1b88b60de198972c63c210f278f72e97c6e3f29d298e15516
-  data.tar.gz: f826dd182be3393bc537deb93b5cf40516c3dc1216be020ae46fc87f6ef996aa4f929cc61a284f47603bd1556d0cdf5c382e94370f106ffc3df1ed60a4f20331
+  metadata.gz: 0f04aabf6c588370a376dc7b9feb44cc8fb5d6209a63025a0958d5095893abb3b0146ed386c7c588ad6c03f6c889869287cc8eaa401192b957256226d443c8d0
+  data.tar.gz: 163a4fe66cd172c1b9d75b71789565eb952dbe943cb657c35ac5bec196f4935283c9abf77f891fd579b18c19611718410044c5b231777e3c348db63fba0ed70f

data/README.md

@@ -12,18 +12,97 @@ fastlane add_plugin framer
 
 ## About framer
 
-Create images combining app screenshots to templates to make nice pictures to upload in App Store.
+Create images combining app screenshots to templates to make nice pictures to upload in App Store or Google Play.
+
+![Flow](assets/example-flow.png)
 
 It gives you the freedom to customize the looks of each image (your designers will love that!) while keep their generation fully automated.
 
+Template images can be anything. The only important thing is that it needs to be the same size as the screenshot it will contains.
+
+You can specify the position and the size of the screen in the template and (optionally) the position and size of the text.
+
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`. 
+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`. 
+
+## Configuration
+
+> From great customizations come great configurations [files]
+
+In order to work, you need to configure each template and the text to draw in the final images.
+
+### Running parameters
+
+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` | 
+| `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` |
+
+### Template Configuration
+
+In the template folder you choose, there must be a `Config.json` file (see [example](fastlane/demo-1/templates/Config.json)). In there you will found
+
+- a default configuration for all templates
+- a custom configuration for each template (if needed).
+
+**default** is, as you guess, the default configuration for all templates (a fallback configuration, if you will).
+
+After that, for each template image you have, you have to put a new map with the same filename as your template image.
+
+There are keys for configuring screeshot and for the text.
+
+```
+"iPhone6s": {
+  "image": {
+    "offset": "+148+172",
+    "width": 457
+  },
+  "text": {
+    "offset_y": 1123,
+    "height": 210,
+    "size": 48
+  }
+}
+```
+
+#### Image
+
+| Key            | Type     | Description        |
+| -------------- | --------:| ------------:|
+| `offset`       | String   | Pixel position in the format `+[X value]+[Y value]` |
+| `width`        | Number 	  | space available, in pixel, for the screen |
+
+#### Text
+
+| Key            | Type     | Description        |
+| -------------- | --------:| ------------:|
+| `offset_x`     | Number   | X position of the text block |
+| `offset_y`     | Number   | Y position of the text block|
+| `height`       | Number   | height of the text block |
+| `size`         | Number   | font size |
+| `font`         | String   | path of custom font file to use |
+| `color`        | String   | color for the text in hex format (ex. `#545454`) |
+| `padding`      | Number   | horizontal internal padding of the text block |
+
+### Screenshots Text
+
+If you want some text in the final framed images, you need to create a `text.json` file and put it with the raw device screenshots. It makes sense to commit this file in your repository.
+
+`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.
 
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run
-
 ```
 rake
 ```

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

@@ -29,7 +29,7 @@ module Fastlane
           UI.message "Processing #{file}"
 
           template = self.find_template(templates, file)
-          text = self.find_text(file)
+          text = self.find_text(source_folder, file)
           output = self.find_output(source_folder, file, output_folder, params[:output_suffix])
 
           if template.nil?
@@ -65,7 +65,7 @@ module Fastlane
         # Detect available templates
         templates = []
 
-        Dir.glob("#{template_folder}/*.png") do |file|
+        Dir.glob("#{template_folder}/**/*.png") do |file|
 
           name = File.basename(file, ".png")
           UI.message "Loading template #{name}"
@@ -116,9 +116,16 @@ module Fastlane
         return templates.find { |template| template.size == size }
       end
 
-      def self.find_text(screenshot_file)
+      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
+          directory = File.dirname(directory)
+          break if directory == source_dir
+          strings_path = File.join(directory, "text.json")
+        end
+
         return nil unless File.exist?(strings_path)
 
         text = JSON.parse(File.read(strings_path))
@@ -145,7 +152,7 @@ module Fastlane
 
         # Ensure output dir exist
         folder = File.dirname(file_path)
-        Dir.mkdir(folder) unless File.exist?(folder)
+        self.create_dir_if_not_exists(folder)
 
         return file_path
       end
@@ -222,6 +229,15 @@ module Fastlane
         template_img.destroy!
       end
 
+      def self.create_dir_if_not_exists(path)
+        recursive = path.split('/')
+        directory = ''
+        recursive.each do |sub_directory|
+          directory += sub_directory + '/'
+          Dir.mkdir(directory) unless (File.directory? directory)
+        end
+      end
+
       #####################################################
       # @!group Documentation
       #####################################################

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Framer
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-framer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - DrAL3X
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -155,10 +155,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Create images combining app screenshots with templates to make nice pictures
   for the App Store
 test_files: []
-has_rdoc: