pantograph 0.1.14 → 0.1.15

data/pantograph/lib/pantograph/actions/git_commit.rb

@@ -32,19 +32,27 @@ module Pantograph
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :path,
-                                       description: "The file you want to commit",
-                                       is_string: false),
-          PantographCore::ConfigItem.new(key: :message,
-                                       description: "The commit message that should be used"),
-          PantographCore::ConfigItem.new(key: :skip_git_hooks,
-                                       description: "Set to true to pass --no-verify to git",
-                                       type: Boolean,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :allow_nothing_to_commit,
-                                       description: "Set to true to allow commit without any git changes",
-                                       type: Boolean,
-                                       optional: true)
+          PantographCore::ConfigItem.new(
+            key: :path,
+            description: "The file you want to commit",
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :message,
+            description: "The commit message that should be used"
+          ),
+          PantographCore::ConfigItem.new(
+            key: :skip_git_hooks,
+            description: "Set to true to pass --no-verify to git",
+            type: Boolean,
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :allow_nothing_to_commit,
+            description: "Set to true to allow commit without any git changes",
+            type: Boolean,
+            optional: true
+          )
         ]
       end
 

data/pantograph/lib/pantograph/actions/git_pull.rb

@@ -2,36 +2,18 @@ module Pantograph
   module Actions
     class GitPullAction < Action
       def self.run(params)
-        commands = []
-
-        unless params[:only_tags]
-          commands += ["git pull &&"]
-        end
-
-        commands += ["git fetch --tags"]
-
-        Actions.sh(commands.join(' '))
+        Actions.sh('git pull')
       end
 
       def self.description
-        "Executes a simple git pull command"
+        'Executes a simple git pull command'
       end
 
       def self.available_options
-        [
-          PantographCore::ConfigItem.new(key: :only_tags,
-                                       description: "Simply pull the tags, and not bring new commits to the current branch from the remote",
-                                       is_string: false,
-                                       optional: true,
-                                       default_value: false,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("Please pass a valid value for only_tags. Use one of the following: true, false") unless value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
-                                       end)
-        ]
       end
 
       def self.authors
-        ["KrauseFx", "JaviSoto"]
+        ['johnknapprs']
       end
 
       def self.is_supported?(platform)
@@ -40,8 +22,7 @@ module Pantograph
 
       def self.example_code
         [
-          'git_pull',
-          'git_pull(only_tags: true) # only the tags, no commits'
+          'git_pull'
         ]
       end
 

data/pantograph/lib/pantograph/actions/git_pull_tags.rb

@@ -0,0 +1,31 @@
+module Pantograph
+  module Actions
+    class GitPullTagsAction < Action
+      def self.run(params)
+        Actions.sh('git fetch --tags')
+      end
+
+      def self.description
+        'Executes a simple `git fetch --tags` command'
+      end
+
+      def self.authors
+        ['johnknapprs']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'git_pull_tags'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/git_submodule_update.rb

@@ -2,10 +2,13 @@ module Pantograph
   module Actions
     class GitSubmoduleUpdateAction < Action
       def self.run(params)
-        commands = ["git submodule update"]
-        commands += ["--init"] if params[:init]
-        commands += ["--recursive"] if params[:recursive]
-        Actions.sh(commands.join(' '))
+        cmd = []
+        cmd << 'git submodule update'
+        cmd << '--init'      if params[:init]
+        cmd << '--recursive' if params[:recursive]
+        cmd = cmd.join(' ')
+
+        Actions.sh(cmd)
       end
 
       #####################################################
@@ -13,20 +16,24 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Executes a git submodule command"
+        'Execute git submodule command'
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :recursive,
-           description: "Should the submodules be updated recursively",
-           type: Boolean,
-           default_value: false),
-          PantographCore::ConfigItem.new(key: :init,
-           description: "Should the submodules be initiated before update",
-           type: Boolean,
-           is_string: false,
-           default_value: false)
+          PantographCore::ConfigItem.new(
+            key: :recursive,
+            description: 'Add the `--recursive` flag',
+            type: Boolean,
+            default_value: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :init,
+            description: 'Add the `--init` flag',
+            type: Boolean,
+            is_string: false,
+            default_value: false
+          )
         ]
       end
 
@@ -37,11 +44,11 @@ module Pantograph
       end
 
       def self.authors
-        ["braunico"]
+        ['johnknapprs']
       end
 
       def self.is_supported?(platform)
-        return true
+        true
       end
 
       def self.category

data/pantograph/lib/pantograph/actions/git_tag_exists.rb

@@ -1,20 +1,20 @@
 module Pantograph
   module Actions
     class GitTagExistsAction < Action
+      module SharedValues
+        GIT_TAG_EXISTS ||= :GIT_TAG_EXISTS
+      end
+
       def self.run(params)
-        tag_ref = "refs/tags/#{params[:tag].shellescape}"
-        if params[:remote]
-          command = "git ls-remote -q --exit-code #{params[:remote_name].shellescape} #{tag_ref}"
-        else
-          command = "git rev-parse -q --verify #{tag_ref}"
-        end
-        exists = true
+        tag_exists = true
+
         Actions.sh(
-          command,
+          "git rev-parse -q --verify refs/tags/#{params[:tag].shellescape}",
           log: PantographCore::Globals.verbose?,
-          error_callback: ->(result) { exists = false }
+          error_callback: ->(result) { tag_exists = false }
         )
-        exists
+
+        Actions.lane_context[SharedValues::GIT_TAG_EXISTS] = tag_exists
       end
 
       #####################################################
@@ -22,36 +22,32 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Checks if the git tag with the given name exists in the current repo"
+        'Checks if the git tag with the given name exists'
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :tag,
-                                       description: "The tag name that should be checked"),
-          PantographCore::ConfigItem.new(key: :remote,
-                                       description: "Whether to check remote. Defaults to `false`",
-                                       type: Boolean,
-                                       default_value: false,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :remote_name,
-                                       description: "The remote to check. Defaults to `origin`",
-                                       default_value: 'origin',
-                                       optional: true)
+          PantographCore::ConfigItem.new(
+            key: :tag,
+            env_name: 'GIT_TAG_EXISTS_TAG',
+            description: 'The tag name that should be checked',
+            is_string: true
+          )
         ]
       end
 
       def self.return_value
-        "Boolean value whether the tag exists or not"
+        'Returns Boolean value whether the tag exists'
       end
 
       def self.output
         [
+          ['GIT_TAG_EXISTS', 'Boolean value whether tag exists']
         ]
       end
 
       def self.authors
-        ["antondomashnev"]
+        ['johnknapprs']
       end
 
       def self.is_supported?(platform)
@@ -61,7 +57,7 @@ module Pantograph
       def self.example_code
         [
           'if git_tag_exists(tag: "1.1.0")
-            UI.message("Found it 🚀")
+            UI.message("Git Tag Exists!")
           end'
         ]
       end

data/pantograph/lib/pantograph/actions/gradle.rb

@@ -27,7 +27,9 @@ module Pantograph
                       end
 
         # Ensure we ended up with a valid path to gradle
-        UI.user_error!("Couldn't find gradlew at path '#{File.expand_path(gradle_path)}'") unless File.exist?(gradle_path)
+        unless File.exist?(gradle_path)
+          UI.user_error!("Couldn't find gradlew at path '#{File.expand_path(gradle_path)}'")
+        end
 
         # Construct our flags
         flags = []
@@ -93,63 +95,85 @@ module Pantograph
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :task,
-                                       env_name: 'GRADLE_TASK',
-                                       description: 'The gradle task you want to execute, e.g. `assemble`, `bundle` or `test`. For tasks such as `assembleMyFlavorRelease` you should use gradle(task: \'assemble\', flavor: \'Myflavor\', build_type: \'Release\')',
-                                       optional: false,
-                                       type: String),
-          PantographCore::ConfigItem.new(key: :flavor,
-                                       env_name: 'GRADLE_FLAVOR',
-                                       description: 'The flavor that you want the task for, e.g. `MyFlavor`. If you are running the `assemble` task in a multi-flavor project, and you rely on Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] then you must specify a flavor here or else this value will be undefined',
-                                       optional: true,
-                                       type: String),
-          PantographCore::ConfigItem.new(key: :build_type,
-                                       env_name: 'GRADLE_BUILD_TYPE',
-                                       description: 'The build type that you want the task for, e.g. `Release`. Useful for some tasks such as `assemble`',
-                                       optional: true,
-                                       type: String),
-          PantographCore::ConfigItem.new(key: :flags,
-                                       env_name: 'GRADLE_FLAGS',
-                                       description: 'All parameter flags you want to pass to the gradle command, e.g. `--exitcode --xml file.xml`',
-                                       optional: true,
-                                       type: String),
-          PantographCore::ConfigItem.new(key: :project_dir,
-                                       env_name: 'GRADLE_PROJECT_DIR',
-                                       description: 'The root directory of the gradle project',
-                                       default_value: '.',
-                                       type: String),
-          PantographCore::ConfigItem.new(key: :gradle_path,
-                                       env_name: 'GRADLE_PATH',
-                                       description: 'The path to your `gradlew`. If you specify a relative path, it is assumed to be relative to the `project_dir`',
-                                       optional: true,
-                                       type: String,
-                                       default_value: './gradlew'),
-          PantographCore::ConfigItem.new(key: :properties,
-                                       env_name: 'GRADLE_PROPERTIES',
-                                       description: 'Gradle properties to be exposed to the gradle script',
-                                       optional: true,
-                                       is_string: false),
-          PantographCore::ConfigItem.new(key: :artifact_extension,
-                                       env_name: 'GRADLE_ARTIFACT_EXTENSION',
-                                       description: 'Gradle build output filetype extension',
-                                       optional: true,
-                                       is_string: true,
-                                       default_value: 'jar'),
-          PantographCore::ConfigItem.new(key: :system_properties,
-                                       env_name: 'GRADLE_SYSTEM_PROPERTIES',
-                                       description: 'Gradle system properties to be exposed to the gradle script',
-                                       optional: true,
-                                       is_string: false),
-          PantographCore::ConfigItem.new(key: :print_command,
-                                       env_name: 'GRADLE_PRINT_COMMAND',
-                                       description: 'Control whether the generated Gradle command is printed as output before running it (true/false)',
-                                       is_string: false,
-                                       default_value: true),
-          PantographCore::ConfigItem.new(key: :print_command_output,
-                                       env_name: 'GRADLE_PRINT_COMMAND_OUTPUT',
-                                       description: 'Control whether the output produced by given Gradle command is printed while running (true/false)',
-                                       is_string: false,
-                                       default_value: true)
+          PantographCore::ConfigItem.new(
+            key: :task,
+            env_name: 'GRADLE_TASK',
+            description: 'The gradle task you want to execute, e.g. `assemble`, `bundle` or `test`. For tasks such as `assembleMyFlavorRelease` you should use gradle(task: \'assemble\', flavor: \'Myflavor\', build_type: \'Release\')',
+            optional: false,
+            type: String
+          ),
+          PantographCore::ConfigItem.new(
+            key: :flavor,
+            env_name: 'GRADLE_FLAVOR',
+            description: 'The flavor that you want the task for, e.g. `MyFlavor`. If you are running the `assemble` task in a multi-flavor project, and you rely on Actions.lane_context[SharedValues::GRADLE_ARTIFACT  _OUTPUT_PATH] then you must specify a flavor here or else this value will be undefined',
+            optional: true,
+            type: String
+          ),
+          PantographCore::ConfigItem.new(
+            key: :build_type,
+            env_name: 'GRADLE_BUILD_TYPE',
+            description: 'The build type that you want the task for, e.g. `Release`. Useful for some tasks such as `assemble`',
+            optional: true,
+            type: String
+          ),
+          PantographCore::ConfigItem.new(
+            key: :flags,
+            env_name: 'GRADLE_FLAGS',
+            description: 'All parameter flags you want to pass to the gradle command, e.g. `--exitcode --xml file.xml`',
+            optional: true,
+            type: String
+          ),
+          PantographCore::ConfigItem.new(
+            key: :project_dir,
+            env_name: 'GRADLE_PROJECT_DIR',
+            description: 'The root directory of the gradle project',
+            default_value: '.',
+            type: String
+          ),
+          PantographCore::ConfigItem.new(
+            key: :gradle_path,
+            env_name: 'GRADLE_PATH',
+            description: 'The path to your `gradlew`. If you specify a relative path, it is assumed to be relative to the `project_dir`',
+            optional: true,
+            type: String,
+            default_value: './gradlew'
+          ),
+          PantographCore::ConfigItem.new(
+            key: :properties,
+            env_name: 'GRADLE_PROPERTIES',
+            description: 'Gradle properties to be exposed to the gradle script',
+            optional: true,
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :artifact_extension,
+            env_name: 'GRADLE_ARTIFACT_EXTENSION',
+            description: 'Gradle build output filetype extension',
+            optional: true,
+            is_string: true,
+            default_value: 'jar'
+          ),
+          PantographCore::ConfigItem.new(
+            key: :system_properties,
+            env_name: 'GRADLE_SYSTEM_PROPERTIES',
+            description: 'Gradle system properties to be exposed to the gradle script',
+            optional: true,
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :print_command,
+            env_name: 'GRADLE_PRINT_COMMAND',
+            description: 'Control whether the generated Gradle command is printed as output before running it (true/false)',
+            is_string: false,
+            default_value: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :print_command_output,
+            env_name: 'GRADLE_PRINT_COMMAND_OUTPUT',
+            description: 'Control whether the output produced by given Gradle command is printed while running (true/false)',
+            is_string: false,
+            default_value: true
+          )
         ]
       end
 

data/pantograph/lib/pantograph/actions/import.rb

@@ -15,7 +15,7 @@ module Pantograph
 
       def self.details
         [
-          'This is useful if you have shared lanes across multiple apps and you want to store a Pantfile in a separate folder.',
+          'This is useful when sharing the same lanes across multiple projects',
           'The path must be relative to the Pantfile this is called from.'
         ].join("\n")
       end

data/pantograph/lib/pantograph/actions/import_from_git.rb

@@ -10,36 +10,45 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Import another Pantfile from a remote git repository to use its lanes"
+        'Import another Pantfile from a remote git repository to use its lanes'
       end
 
       def self.details
-        "This is useful if you have shared lanes across multiple apps and you want to store the Pantfile in a remote git repository."
+        'This is useful when sharing the same lanes across multiple projects'
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :url,
-                                       description: "The URL of the repository to import the Pantfile from",
-                                       default_value: nil),
-          PantographCore::ConfigItem.new(key: :branch,
-                                       description: "The branch or tag to check-out on the repository",
-                                       default_value: 'HEAD',
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :path,
-                                       description: "The path of the Pantfile in the repository",
-                                       default_value: 'pantograph/Pantfile',
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :version,
-                                       description: "The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the latest version within constraints",
-                                       default_value: nil,
-                                       is_string: false,
-                                       optional: true)
+          PantographCore::ConfigItem.new(
+            key: :url,
+            description: 'The URL of the repository to import the Pantfile from',
+            default_value: nil,
+            optional: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :branch,
+            description: 'The branch or tag to check-out on the repository',
+            default_value: 'master',
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :path,
+            description: 'The path of the Pantfile in the repository',
+            default_value: 'pantograph/Pantfile',
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :version,
+            description: 'The version to checkout on the repository. Optimistic match operator or multiple conditions can be used to select the version within constraints',
+            default_value: nil,
+            is_string: false,
+            optional: true
+          )
         ]
       end
 
       def self.authors
-        ["fabiomassimo", "KrauseFx", "Liquidsoul"]
+        ['fabiomassimo', 'KrauseFx', 'Liquidsoul', 'johnknapprs']
       end
 
       def self.is_supported?(platform)
@@ -48,18 +57,26 @@ module Pantograph
 
       def self.example_code
         [
-          'import_from_git(
-            url: "git@github.com:pantograph/pantograph.git", # The URL of the repository to import the Pantfile from.
-            branch: "HEAD", # The branch to checkout on the repository
-            path: "pantograph/Pantfile", # The path of the Pantfile in the repository
-            version: "~> 1.0.0" # The version to checkout on the repository. Optimistic match operator can be used to select the latest version within constraints.
-          )',
-          'import_from_git(
-            url: "git@github.com:pantograph/pantograph.git", # The URL of the repository to import the Pantfile from.
-            branch: "HEAD", # The branch to checkout on the repository
-            path: "pantograph/Pantfile", # The path of the Pantfile in the repository
-            version: [">= 1.1.0", "< 2.0.0"] # The version to checkout on the repository. Multiple conditions can be used to select the latest version within constraints.
-          )'
+          ' # Simple import on master branch
+            import_from_git(
+              url: "git@github.com:johnknapprs/pantograph.git"
+            )
+          ',
+          ' # Import a Pantfile with an Optimistic version match operator
+            import_from_git(
+              url: "git@github.com:johnknapprs/pantograph.git",
+              branch: "master",
+              path: "pantograph/Pantfile",
+              version: "~> 1.0.0"
+            )
+          ',
+          ' # Import a Pantfile with multiple version conditions
+            import_from_git(
+              url: "git@github.com:johnknapprs/pantograph.git", # The URL of the repository to import the Pantfile from.
+              branch: "development", # The branch to checkout on the repository
+              version: [">= 1.1.0", "< 2.0.0"]
+            )
+          '
         ]
       end
 

data/pantograph/lib/pantograph/actions/is_ci.rb

@@ -14,7 +14,7 @@ module Pantograph
       end
 
       def self.details
-        'The return value of this method is true if pantograph is currently executed on Travis, Jenkins, Circle or a similar CI service'
+        'Return `true` if pantograph is currently executed on Travis, Jenkins, or a similar CI service'
       end
 
       def self.available_options

data/pantograph/lib/pantograph/actions/is_verbose.rb

@@ -0,0 +1,77 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      IS_VERBOSE = :IS_VERBOSE
+    end
+
+    class IsVerboseAction < Action
+      def self.run(params)
+        Actions.lane_context[:IS_VERBOSE] = PantographCore::Globals.verbose? ? true : false
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Returns Boolean whether `--verbose` flag was set'
+      end
+
+      def self.details
+        ''
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.output
+        [
+          ['IS_VERBOSE', 'Boolean whether verbosity flag was set']
+        ]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to pantograph :) You are awesome btw!
+        ['johnknapprs']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      # Is printed out in the Steps: output in the terminal
+      # Return nil if you don't want any logging in the terminal/JUnit Report
+      def self.step_text
+        self.action_name
+      end
+
+      # Returns an array of string of sample usage of this action
+      def self.example_code
+        [
+          'if is_verbose?
+             UI.important("Verbosity is turned on!")
+           else
+             UI.message("Verbosity is turned off!")
+           end
+          '
+
+        ]
+      end
+
+      def category
+        # Available Categories: ./pantograph/lib/pantograph/action.rb
+        :misc
+      end
+
+      # If category == :deprecated, uncomment to include a message for user
+      # def self.deprecated_notes
+      #   nil
+      # end
+    end
+  end
+end