fastlane-plugin-properties 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83cc41668123748946ece3e9a6130b567b791f198cbd56ecfafe413179e4f17d
+  data.tar.gz: 1632a72d065d56d10b2e823ce07111918ffd9393e76b0a5b0e89030d1b786a4a
+SHA512:
+  metadata.gz: 04d8ab1e6b020cb59c14234b6b7598ff74622421add28ad4b94130642e9431230f80fee805c1a71f394b3925f447ef4f68dadeee3647bf72f978e995ebac29e5
+  data.tar.gz: bdd607dd1f1c7025d327dbf68878cc81d3564b4f4a2d42edbad6afb33650d190b5f869a20dfe7f1aca4dc806c7b1d5ec1e6f154f959731285b7247ac2036e50d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pavlo Pakholka <pavlo.pakholka@bolt.eu>
+
+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,79 @@
+# properties plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-properties)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-properties`, add it to your project by running:
+
+```bash
+fastlane add_plugin properties
+```
+
+## About properties
+
+Adds 2 actions to fastlane to read and update properties files.
+Adds 2 actions to read/write the whole properties file.
+Adds 2 more actions to increase versionCode and versionName fast.
+
+## Example
+
+```ruby
+lane :test do
+
+  # Read VERSION_NAME value from Configs/versions.properties
+  version_name = get_properties_value(
+    key: "VERSION_NAME",
+    path: "./Configs/versions.properties"
+  )
+
+  # Set VERSION_NAME value to '0.2.0' in Configs/versions.properties
+  # VERSION_NAME will be added if it doesn't exist
+  set_properties_value(
+    path: "./Configs/versions.properties",
+    name: "VERSION_NAME",
+    value: "0.2.0"
+  )
+
+  # Increase VERSION_CODE value in Configs/versions.properties by 1
+  increment_version_code_in_properties_file(
+    key: "VERSION_CODE",
+    path: "./Configs/versions.properties"
+  )
+  
+  # Increase VERSION_NAME's minor value in Configs/versions.properties by 1
+  # update_type can be one of ['major', 'minor', 'patch']. Default to 'minor'
+  increment_version_name_in_properties_file(
+    key: "VERSION_NAME",
+    path: "./Configs/versions.properties",
+    update_type: "minor"
+  )
+
+  content = parse_properties_file(
+    path: "./Configs/versions.properties"
+  )
+
+  increment_version_name_in_properties_file(
+    key: "VERSION_NAME",
+    path: "./Configs/versions.properties",
+    update_type: "minor"
+  )
+
+end
+```
+
+## 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/properties.rb

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

data/lib/fastlane/plugin/properties/actions/get_properties_value.rb

@@ -0,0 +1,57 @@
+require 'fastlane/action'
+require 'java-properties'
+require_relative '../helper/properties_helper'
+
+module Fastlane
+  module Actions
+    class GetPropertiesValueAction < Action
+      def self.run(params)
+        content = JavaProperties.load(params[:path])
+        return content[params[:key].to_sym]
+      end
+
+      def self.description
+        "Reads a value of a setting from .properties file."
+      end
+
+      def self.authors
+        ["Pavlo Pakholka"]
+      end
+
+      def self.return_value
+        'Value of a setting.'
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key,
+            env_name: "PROPERIES_GET_VALUE_PARAM_KEY",
+            description: "Key of properie in .properties file",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "PROPERIES_GET_VALUE_PARAM_PATH",
+            description: "Path to .properies file you want to update",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .properties file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end)
+        ]
+      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/properties/actions/increment_version_code_in_properties_file.rb

@@ -0,0 +1,60 @@
+require 'fastlane/action'
+require 'java-properties'
+require_relative '../helper/properties_helper'
+
+module Fastlane
+  module Actions
+    class IncrementVersionCodeInPropertiesFileAction < Action
+      def self.run(params)
+        content = JavaProperties.load(params[:path])
+        value = content[params[:key].to_sym].to_i + 1
+        content[params[:key].to_sym] = value
+        JavaProperties.write(content, params[:path])
+        return value
+      end
+
+      def self.description
+        "Increase version code inside .properties file."
+      end
+
+      def self.authors
+        ["Pavlo Pakholka"]
+      end
+
+      def self.return_value
+        "New version code."
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key,
+            env_name: "PROPERIES_GET_VALUE_PARAM_KEY",
+            description: "Key of properie in .properties file",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "PROPERIES_GET_VALUE_PARAM_PATH",
+            description: "Path to .properies file you want to update",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .properties file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end)
+        ]
+      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/properties/actions/increment_version_name_in_properties_file.rb

@@ -0,0 +1,66 @@
+require 'fastlane/action'
+require 'java-properties'
+require_relative '../helper/properties_helper'
+
+module Fastlane
+  module Actions
+    class IncrementVersionNameInPropertiesFileAction < Action
+      def self.run(params)
+        content = JavaProperties.load(params[:path])
+        value = content[params[:key].to_sym]
+        new_value = Helper::PropertiesHelper.update_semver_version(params[:update_type], value)
+        content[params[:key].to_sym] = new_value
+        JavaProperties.write(content, params[:path])
+        return new_value
+      end
+
+      def self.description
+        "Sets a value of a setting in .properties file."
+      end
+
+      def self.authors
+        ["Pavlo Pakholka"]
+      end
+
+      def self.return_value
+        "New version name."
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key,
+            env_name: "PROPERIES_GET_VALUE_PARAM_KEY",
+            description: "Key of properie in .properties file",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "PROPERIES_GET_VALUE_PARAM_PATH",
+            description: "Path to .properies file you want to update",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .properties file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end),
+          FastlaneCore::ConfigItem.new(key: :update_type,
+            env_name: "PROPERIES_GET_VALUE_PARAM_KEY",
+            description: "Key of properie in .properties file",
+            optional: true,
+            type: String)
+        ]
+      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/properties/actions/parse_properties_file.rb

@@ -0,0 +1,51 @@
+require 'fastlane/action'
+require 'java-properties'
+
+module Fastlane
+  module Actions
+    class ParsePropertiesFileAction < Action
+      def self.run(params)
+        content = JavaProperties.load(params[:path])
+        return content
+      end
+
+      def self.description
+        "Load .properties file and returns it as a ruby hash-map."
+      end
+
+      def self.authors
+        ["Pavlo Pakholka"]
+      end
+
+      def self.return_value
+        'Content of properties file.'
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "PROPERIES_READ_HASH_PATH",
+            description: "Path to .properies file you want to read",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .properties file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end)
+        ]
+      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/properties/actions/set_properties_value.rb

@@ -0,0 +1,64 @@
+require 'fastlane/action'
+require 'java-properties'
+require_relative '../helper/properties_helper'
+
+module Fastlane
+  module Actions
+    class SetPropertiesValueAction < Action
+      def self.run(params)
+        content = JavaProperties.load(params[:path])
+        content[params[:key].to_sym] = params[:value]
+        JavaProperties.write(content, params[:path])
+      end
+
+      def self.description
+        "Sets a value of a setting in .properties file."
+      end
+
+      def self.authors
+        ["Pavlo Pakholka"]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key,
+            env_name: "PROPERIES_GET_VALUE_PARAM_KEY",
+            description: "Key of properie in .properties file",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+            env_name: "PROPERIES_SET_VALUE_PARAM_VALUE",
+            description: "Value to set",
+            skip_type_validation: true, # skipping type validation as fastlane converts YES/NO/true/false strings into booleans
+            type: String,
+            optional: false),
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "PROPERIES_GET_VALUE_PARAM_PATH",
+            description: "Path to .properies file you want to update",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .properties file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end)
+        ]
+      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/properties/actions/write_properties_file.rb

@@ -0,0 +1,56 @@
+require 'fastlane/action'
+require 'java-properties'
+
+module Fastlane
+  module Actions
+    class ParsePropertiesFileAction < Action
+      def self.run(params)
+        content = JavaProperties.write(params[:hash], params[:path])
+        return content
+      end
+
+      def self.description
+        "Write any Hash-like structure as a properties file. This action won't create a new file."
+      end
+
+      def self.authors
+        ["Pavlo Pakholka"]
+      end
+
+      def self.return_value
+        ''
+      end
+
+      def self.details
+        # Optional:
+        ""
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key,
+            env_name: "PROPERIES_WRITE_HASH_MAP",
+            description: "Hashmap you want to convert and write to file",
+            optional: false,
+            type: Hash),
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "PROPERIES_WRITE_HASH_PATH",
+            description: "Path to .properies file you want to update",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              UI.user_error!("Couldn't find .properties file at path '#{value}'") unless File.exist?(File.expand_path(value))
+            end)
+        ]
+      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/properties/helper/properties_helper.rb

@@ -0,0 +1,35 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class PropertiesHelper
+      # Available in actions as `Helper::PropertiesHelper.update_semver_version`
+      def self.update_semver_version(type, version_name)
+        type ||= 'minor'
+        version = version_name.split(".")
+        major = version[0].to_i
+        minor = version[1].to_i
+        patch = version[2].to_i
+
+        if type == 'major'
+          major += 1
+          minor = 0
+          patch = 0
+        end
+
+        if type == 'minor'
+          minor += 1
+          patch = 0
+        end
+
+        if type == 'patch'
+          patch += 1
+        end
+
+        return "#{major}.#{minor}.#{patch}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Properties
+    VERSION = "1.1.0"
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-properties
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Pavlo Pakholka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: java-properties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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.130.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.130.0
+description: 
+email: pavlo.pakholka@bolt.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/properties.rb
+- lib/fastlane/plugin/properties/actions/get_properties_value.rb
+- lib/fastlane/plugin/properties/actions/increment_version_code_in_properties_file.rb
+- lib/fastlane/plugin/properties/actions/increment_version_name_in_properties_file.rb
+- lib/fastlane/plugin/properties/actions/parse_properties_file.rb
+- lib/fastlane/plugin/properties/actions/set_properties_value.rb
+- lib/fastlane/plugin/properties/actions/write_properties_file.rb
+- lib/fastlane/plugin/properties/helper/properties_helper.rb
+- lib/fastlane/plugin/properties/version.rb
+homepage: https://github.com/Kerizer/fastlane-plugin-properties
+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.3
+signing_key: 
+specification_version: 4
+summary: Adds 4 actions to fastlane to read and update properties files.
+test_files: []