fastlane-plugin-device_image_selector 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53cf59eb78d2cd990b0080bde16e8a707a2e3e2b
+  data.tar.gz: c006bc660ba58116b3869647d2609d4ceda1898f
+SHA512:
+  metadata.gz: d22f2d39eeaf4f1ff47c42fed1a5a9ea5a34a6a72ba159664017b77ea1cf2e3881cf301382e363f1158dc7fc80521d25f5bbb9314dfc6253d4908e1c16db0029
+  data.tar.gz: a9f377739228277b7e6674de81bcec1e0334a538d38aec04b7f37470399dd4dd736bab669bfe0569b961217818d840f96bef4ce57b6be689d95f1988957468c9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mario Zimmermann <mail@zisoft.de>
+
+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

@@ -0,0 +1,64 @@
+# device_image_selector plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-device_image_selector)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-device_image_selector`, add it to your project by running:
+
+```bash
+fastlane add_plugin device_image_selector
+```
+
+## About device_image_selector
+
+After creating hundrets of screenshots for the AppStore you probably want to use only a few of them with device frames, i.e. to put them on your website. Instead of running 'frameit' on the whole screenshots directory this plugin selects only the screenshots you want to use and puts them into the output directory. Running 'frameit' on this directory produces the device images. After that, the screenshot files can automatically be deleted by running the cleanup action. So the Fastfile may look like this:
+
+    
+    desc "Generate device images"
+    lane :device_images do
+      device_image_selector(name_prefixes: ["iPhone X","iPad Pro (12.9-inch)"])
+      frame_screenshots(path: "fastlane/screenshots/device_images")
+      device_image_selector_cleanup
+    end
+
+## Actions
+### device_image_selector
+Selects only the screenshot files which matches the specified name prefixes and copys them into the output directory.
+
+    # iPhone X screenshots only
+    device_image_selector(name_prefixes: "iPhone X")   
+
+    # iPhone 8 Plus and iPad Pro (9.7-inch) screenshots
+    device_image_selector(name_prefixes: ["iPhone 8 Plus","iPad Pro (9.7-inch)"])
+
+    # specify the screenshots directory (default: ./fastlane/screenshots)
+    device_image_selector(screenshot_directory: "path/to/screenshots",  name_prefixes: "iPhone X")   
+
+    # specify the output directory (default: ./fastlane/screenshots/device_images)
+    device_image_selector(output_directory: "~/device_images",  name_prefixes: "iPhone X")       
+
+
+
+### device_image_selector_cleanup
+Cleans up the output directory by deleting the previously selected screenshot files. This leaves only the generated device images in the output directory.
+
+    # cleanup after the device images are created
+    device_image_selector_cleanup
+
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/device_image_selector.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/device_image_selector/version'
+
+module Fastlane
+  module DeviceImageSelector
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::DeviceImageSelector.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/device_image_selector/actions/cleanup.rb

@@ -0,0 +1,44 @@
+require 'fastlane/action'
+require_relative '../helper/device_image_selector_helper'
+
+module Fastlane
+  module Actions
+    class DeviceImageSelectorCleanupAction < Action
+      def self.run(params)
+        UI.message("Cleaning up device images...")
+
+        Actions.lane_context[SharedValues::DEVICE_IMAGE_SELECTOR_FILES].split(",").each do |file|
+          File.delete(file)
+        end
+      end
+
+      def self.description
+        "Cleanup screenshot files after frameit"
+      end
+
+      def self.authors
+        ["Mario Zimmermann"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Deletes the screenshot files in the output directory which were previously selected and processed by frameit"
+      end
+
+      def self.available_options
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/device_image_selector/actions/select.rb

@@ -0,0 +1,102 @@
+require 'fastlane/action'
+require_relative '../helper/device_image_selector_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      DEVICE_IMAGE_SELECTOR_FILES = :DEVICE_IMAGE_SELECTOR_FILES
+    end
+
+    class DeviceImageSelectorAction < Action
+      def self.run(params)
+        Dir.mkdir(params[:output_directory]) unless Dir.exists?(params[:output_directory])
+
+        files = []
+
+        Dir.entries(params[:screenshot_directory]).each do |entry|
+          next if entry == "." || entry == ".."
+          input_dir = params[:screenshot_directory] + "/#{entry}"
+          next unless File.directory?(input_dir)
+          next if input_dir == params[:output_directory]
+
+          output_dir = "#{params[:output_directory]}/#{entry}"
+          Dir.mkdir(output_dir) unless Dir.exists?(output_dir)
+
+          Dir.entries(input_dir).each do |filename|
+            next if filename == "." || filename == ".."
+
+            use_this = false
+            params[:name_prefixes].each do |name_prefix|
+              if filename.start_with?(name_prefix)
+                use_this = true
+                break
+              end
+            end
+            next unless use_this
+
+            FileUtils.copy("#{input_dir}/#{filename}","#{output_dir}/#{filename}")
+
+            files << "#{output_dir}/#{filename}"
+          end
+        end
+
+        Actions.lane_context[SharedValues::DEVICE_IMAGE_SELECTOR_FILES] = files.join(",")
+      end
+
+      def self.description
+        "Selects screenshots with specified names for processing with frameit"
+      end
+
+      def self.authors
+        ["Mario Zimmermann"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.output
+        [
+          ["DEVICE_IMAGE_SELECTOR_FILES", "Comma separated list of selected screenshot files"]
+        ]
+      end
+
+      def self.details
+        # Optional:
+        "Takes the device screenshots which matches the specified names and puts them in the output directory for frameit to process. The screenshot files can then be cleaned up after the device images are created."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :screenshot_directory,
+                                  env_name: "DEVICE_IMAGE_SELECTOR_SCREENSHOT_DIRECTORY",
+                               description: "Directory where the screenshots are located",
+                                  optional: false,
+                             default_value: "./fastlane/screenshots",
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :output_directory,
+                                  env_name: "DEVICE_IMAGE_SELECTOR_OUTPUT_DIRECTORY",
+                               description: "Directory where to put the selected screenshots",
+                                  optional: false,
+                             default_value: "./fastlane/screenshots/device_images",
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :name_prefixes,
+                                  env_name: "DEVICE_IMAGE_SELECTOR_NAME_PREFIXES",
+                               description: "Array of filename prefixes to select",
+                                  optional: true,
+                                      type: Array)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/device_image_selector/helper/device_image_selector_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class DeviceImageSelectorHelper
+      # class methods that you define here become available in your action
+      # as `Helper::DeviceImageSelectorHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the device_image_selector plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module DeviceImageSelector
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-device_image_selector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mario Zimmermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.81.0
+description: 
+email: mail@zisoft.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/device_image_selector.rb
+- lib/fastlane/plugin/device_image_selector/actions/cleanup.rb
+- lib/fastlane/plugin/device_image_selector/actions/select.rb
+- lib/fastlane/plugin/device_image_selector/helper/device_image_selector_helper.rb
+- lib/fastlane/plugin/device_image_selector/version.rb
+homepage: https://github.com/zisoft/fastlane-plugin-device_image_selector
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Takes the screenshots from devices which matches the specified names and
+  puts them in a new directory for frameit to process. The screenshot files can then
+  be cleaned up after the device images are created.
+test_files: []