fastlane-plugin-ram_disk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42abbe525a241af40a52e141b1dc7e118f9740c94d0733c0e7322a0423bf81e8
+  data.tar.gz: bd58812200465cbbc6cff9daa12323ff0ce74e9e187b388a5c6c27f02b2b0f56
+SHA512:
+  metadata.gz: 918c3c6191eaaa12cb875a1d5e7dd08341e2102387e0848ffddee6deff3ab3f0f5f6eca4e0112ad7671270b6bfc1d92eab58a76197437a9c2e4b633462b7757f
+  data.tar.gz: cb7e5c9d17aa9c3a33c0fe82b47ff6f453320bfc48490fcd5e430e79e78c59fc633c81ad3688f91fdeb82d8382e2e1b47ab8c88b8ae43239c02f93331e34c179

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 icyleaf <icyleaf.cn@gmail.com>
+
+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,125 @@
+# ram_disk plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ram_disk)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-ram_disk`, add it to your project by running:
+
+```bash
+fastlane add_plugin ram_disk
+```
+
+## About ram_disk
+
+Use a temporary ram disk to do anything else, it contains three actions:
+
+Action | Description
+---|---
+ram_disk | combo two action below and do something with a lambda
+create_ram_disk | Create a virtual ram disk
+remove_ram_disk | Remove a virtual ram disk
+
+**Note to author:** Only works in macOS for now and add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+### ram_disk
+
+```
++------------+-----------------------------------+---------------------+----------+
+|                                ram_disk Options                                 |
++------------+-----------------------------------+---------------------+----------+
+| Key        | Description                       | Env Var             | Default  |
++------------+-----------------------------------+---------------------+----------+
+| name       | The name of ram disk              | RAM_DISK_NAME       |          |
+| size       | The size of ram disk (unit is MB) | RAM_DISK_SIZE       |          |
+| mount_path | The path of ram disk              | RAM_DISK_MOUNT_PATH | /Volumes |
+| use        | The code of lamda to run          |                     |          |
++------------+-----------------------------------+---------------------+----------+
+* = default value is dependent on the user's system
+
++---------------+----------------------+
+|      ram_disk Output Variables       |
++---------------+----------------------+
+| Key           | Description          |
++---------------+----------------------+
+| RAM_DISK_PATH | the path of ram disk |
++---------------+----------------------+
+Access the output values using `lane_context[SharedValues::VARIABLE_NAME]`
+```
+
+### create_ram_disk
+
+```
++------------+-----------------------------------+---------------------+----------+
+|                             create_ram_disk Options                             |
++------------+-----------------------------------+---------------------+----------+
+| Key        | Description                       | Env Var             | Default  |
++------------+-----------------------------------+---------------------+----------+
+| name       | The name of ram disk              | RAM_DISK_NAME       |          |
+| size       | The size of ram disk (unit is MB) | RAM_DISK_SIZE       |          |
+| mount_path | The path of ram disk              | RAM_DISK_MOUNT_PATH | /Volumes |
++------------+-----------------------------------+---------------------+----------+
+* = default value is dependent on the user's system
+
++---------------+----------------------+
+|   create_ram_disk Output Variables   |
++---------------+----------------------+
+| Key           | Description          |
++---------------+----------------------+
+| RAM_DISK_PATH | the path of ram disk |
++---------------+----------------------+
+Access the output values using `lane_context[SharedValues::VARIABLE_NAME]`
+
++------------------------------+
+| create_ram_disk Return Value |
++------------------------------+
+| String                       |
++------------------------------+
+```
+
+### remove_ram_disk
+
+```
++------+----------------------+---------------+---------+
+|                remove_ram_disk Options                |
++------+----------------------+---------------+---------+
+| Key  | Description          | Env Var       | Default |
++------+----------------------+---------------+---------+
+| path | The path of ram disk | RAM_DISK_PATH |         |
++------+----------------------+---------------+---------+
+```
+
+## 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`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## 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/ram_disk.rb

@@ -0,0 +1,17 @@
+require 'fastlane/plugin/ram_disk/version'
+require 'fastlane/plugin/ram_disk/manager'
+
+module Fastlane
+  module RamDisk
+    # 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::RamDisk.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/ram_disk/actions/create_ram_disk_action.rb

@@ -0,0 +1,61 @@
+require 'fastlane/action'
+require_relative '../helper/ram_disk_helper'
+
+module Fastlane
+  module Actions
+    class CreateRamDiskAction < Action
+      def self.run(params)
+        manager = RamDisk::Manager.new(params)
+        manager.create
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Use a temporary ram disk to do anything else"
+      end
+
+      def self.authors
+        ["icyleaf"]
+      end
+
+      def self.example_code
+        [
+          'create_ram_disk(
+            name: "ramdisk"
+            size: 4096
+          )',
+          'create_ram_disk(
+            name: "ramdisk",
+            path: "/Volumes",
+            size: 4096
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.output
+        [
+          ['RAM_DISK_PATH', 'the path of ram disk']
+        ]
+      end
+
+      def self.return_value
+        String
+      end
+
+      def self.available_options
+        Fastlane::RamDisk::Options.create_options
+      end
+
+      def self.is_supported?(_)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ram_disk/actions/ram_disk_action.rb

@@ -0,0 +1,56 @@
+require 'fastlane/action'
+require_relative '../helper/ram_disk_helper'
+
+module Fastlane
+  module Actions
+    class RamDiskAction < Action
+      def self.run(params)
+        RamDisk::Manager.run(params)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Use a temporary ram disk to do anything else'
+      end
+
+      def self.available_options
+        Fastlane::RamDisk::Options.available_options
+      end
+
+      def self.example_code
+        [
+          'use_ram_disk(
+            name: "ramdisk"
+            size: 4096,
+            use: lambda {
+              build_app(
+                derived_data_path: Actions.lane_context[SharedValues::RAM_DISK_PATH]
+              )
+            }
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.output
+        [
+          ['RAM_DISK_PATH', 'the path of ram disk']
+        ]
+      end
+
+      def self.authors
+        ['icyleaf']
+      end
+
+      def self.is_supported?(_)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ram_disk/actions/remove_ram_disk_action.rb

@@ -0,0 +1,41 @@
+module Fastlane
+  module Actions
+    class RemoveRamDiskAction < Action
+      def self.run(params)
+        manager = RamDisk::Manager.new(params)
+        manager.remove
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Remove a ram disk (use it after _create_ram_disk_ action)'
+      end
+
+      def self.available_options
+        Fastlane::RamDisk::Options.remove_options
+      end
+
+      def self.example_code
+        [
+          'remove_ram_disk',
+          'remove_ram_disk(path: "/Volumes/ramdisk")'
+        ]
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.authors
+        ['icyleaf']
+      end
+
+      def self.is_supported?(_)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ram_disk/helper/ram_disk_helper.rb

@@ -0,0 +1,23 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class RamDiskHelper
+      # class methods that you define here become available in your action
+      # as `Helper::RamDiskHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the ram_disk plugin helper!")
+      end
+
+      def self.mac?
+        require 'rbconfig'
+
+        platform = RbConfig::CONFIG['host_os']
+        platform.include?('darwin')
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ram_disk/manager.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'fastlane_core/configuration/config_item'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      RAM_DISK_PATH = :RAM_DISK_PATH
+    end
+  end
+
+  module RamDisk
+    class Manager
+      def self.run(params)
+        instance = new(params)
+        instance.create
+        params[:use].call
+        instance.remove
+      end
+
+      def initialize(params)
+        @params = params
+        UI.user_error!('Sorry, it only works in macOS for now') unless mac?
+      end
+
+      def create
+        name = @params[:name]
+        path = @params[:mount_path]
+        size = @params[:size]
+        ram_disk_path = File.join(path, name)
+
+        UI.user_error!('the name is empty') if name.to_s.empty?
+        UI.user_error!('the disk size is zero or negative') if size.to_i <= 0
+        UI.user_error!("mount path existed: #{ram_disk_path}") if File.exist?(ram_disk_path)
+
+        commands = []
+        commands << create_ram_disk(name, size)
+        commands << spotlight_indexes(ram_disk_path, true)
+
+        commands.each do |shell_command|
+          if Helper.test?
+            UI.message("$ #{shell_command}")
+            next
+          end
+
+          Actions.sh(shell_command)
+        end
+
+        UI.crash! "fail to create ram disk" unless Dir.exist?(ram_disk_path)
+
+        UI.success "Successful on ram disk: #{ram_disk_path}"
+        shared_value(Actions::SharedValues::RAM_DISK_PATH, ram_disk_path)
+      end
+
+      def remove
+        path = @params[:path]
+
+        UI.user_error!('ram path is empty') if path.to_s.empty?
+        UI.user_error!("ram path is not exist: #{path}") unless Dir.exist?(path)
+        UI.message("Found ram disk: #{path}")
+
+        commands = []
+        commands << spotlight_indexes(path, false)
+        commands << remove_ram_disk(path)
+
+        commands.each do |shell_command|
+          if Helper.test?
+            UI.message("$ #{shell_command}")
+            next
+          end
+
+          Actions.sh(shell_command)
+        end
+
+        UI.crash! "fail to remove ram disk" if Dir.exist?(path)
+      end
+
+      def mac?
+        require 'rbconfig'
+
+        platform = RbConfig::CONFIG['host_os']
+        platform.include?('darwin')
+      end
+
+      private
+
+      def create_ram_disk(name, size)
+        attch_ram = "hdiutil attach -nomount ram://$[#{size}*2048]"
+        disk_path = (Helper.test? ? "'#{attch_ram}'" : `#{attch_ram}`.chomp)
+
+        "diskutil erasevolume HFS+ #{name} #{disk_path}"
+      end
+
+      def remove_ram_disk(path)
+        "diskutil eject #{path}"
+      end
+
+      def spotlight_indexes(path, value)
+        value = value ? 'on' : 'off'
+        "mdutil -i #{value} #{path}"
+      end
+
+      def shared_value(key, value)
+        return Actions.lane_context[key] || ENV[key.to_s] unless value
+
+        Actions.lane_context[key] = value
+        ENV[key.to_s] = value
+      end
+    end
+
+    class Options
+      class << self
+        def available_options
+          @available_options ||= available_options
+        end
+
+        def available_create_options
+          @create_options ||= create_options
+        end
+
+        def available_remove_options
+          @remove_options ||= remove_options
+        end
+
+        def available_options
+          create_options.concat([
+            FastlaneCore::ConfigItem.new(key: :use,
+                                        description: 'The code of lamda to run',
+                                        is_string: false,
+                                        verify_block: proc do |value|
+                                          UI.user_error!('Please pass a lambda in Fastfile') unless value.respond_to?(:call)
+                                        end)
+          ])
+        end
+
+        def create_options
+          [
+            FastlaneCore::ConfigItem.new(key: :name,
+                                        env_name: 'RAM_DISK_NAME',
+                                        description: 'The name of ram disk',
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :size,
+                                        env_name: 'RAM_DISK_SIZE',
+                                        description: 'The size of ram disk (unit is MB)',
+                                        type: String),
+            FastlaneCore::ConfigItem.new(key: :mount_path,
+                                        env_name: 'RAM_DISK_MOUNT_PATH',
+                                        description: 'The path of ram disk',
+                                        optional: true,
+                                        default_value: '/Volumes',
+                                        type: String)
+          ]
+        end
+
+        def remove_options
+          [
+            FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: 'RAM_DISK_PATH',
+                                       description: 'The path of ram disk',
+                                       optional: true,
+                                       default_value: Actions.lane_context[Actions::SharedValues::RAM_DISK_PATH],
+                                       type: String)
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module RamDisk
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-ram_disk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- icyleaf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-15 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.135.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.135.2
+description: 
+email: icyleaf.cn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/ram_disk.rb
+- lib/fastlane/plugin/ram_disk/actions/create_ram_disk_action.rb
+- lib/fastlane/plugin/ram_disk/actions/ram_disk_action.rb
+- lib/fastlane/plugin/ram_disk/actions/remove_ram_disk_action.rb
+- lib/fastlane/plugin/ram_disk/helper/ram_disk_helper.rb
+- lib/fastlane/plugin/ram_disk/manager.rb
+- lib/fastlane/plugin/ram_disk/version.rb
+homepage: 
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Use a temporary ram disk to do anything else
+test_files: []