pantograph 0.1.14 → 0.1.15

data/pantograph/lib/pantograph/actions/danger.rb

@@ -2,30 +2,28 @@ module Pantograph
   module Actions
     class DangerAction < Action
       def self.run(params)
-        Actions.verify_gem!('danger')
-        cmd = []
+        ENV['DANGER_GITHUB_API_TOKEN'] = params[:github_api_token] if params[:github_api_token]
 
-        cmd << 'bundle exec' if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
-        cmd << 'danger'
-        cmd << '--verbose' if params[:verbose]
+        danger_cmd = []
 
-        danger_id = params[:danger_id]
-        dangerfile = params[:dangerfile]
-        base = params[:base]
-        head = params[:head]
-        pr = params[:pr]
-        cmd << "--danger_id=#{danger_id}" if danger_id
-        cmd << "--dangerfile=#{dangerfile}" if dangerfile
-        cmd << "--fail-on-errors=true" if params[:fail_on_errors]
-        cmd << "--new-comment" if params[:new_comment]
-        cmd << "--remove-previous-comments" if params[:remove_previous_comments]
-        cmd << "--base=#{base}" if base
-        cmd << "--head=#{head}" if head
-        cmd << "pr #{pr}" if pr
+        if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
+          danger_cmd << 'bundle exec'
+        end
 
-        ENV['DANGER_GITHUB_API_TOKEN'] = params[:github_api_token] if params[:github_api_token]
+        danger_cmd << 'danger'
+        danger_cmd << "--dangerfile=#{params[:dangerfile]}"
+        danger_cmd << "--new-comment"                     if params[:new_comment]
+        danger_cmd << "--remove-previous-comments"        if params[:remove_previous_comments]
+        danger_cmd << "--base=#{params[:base]}"           if params[:base]
+        danger_cmd << "--head=#{params[:head]}"           if params[:head]
+        danger_cmd << "pr #{params[:pr]}"                 if params[:pr]
+        danger_cmd << "--danger_id=#{params[:danger_id]}" if params[:danger_id]
+        danger_cmd << '--verbose'                         if params[:verbose]
+
+        danger_cmd << "--fail-on-errors=#{params[:fail_on_errors]}"
+        danger_cmd = danger_cmd.join(' ')
 
-        Actions.sh(cmd.join(' '))
+        Actions.sh(danger_cmd)
       end
 
       def self.description
@@ -34,72 +32,95 @@ module Pantograph
 
       def self.details
         [
-          'Formalize your Pull Request etiquette.',
+          'Stop Saying your Forgot in Source Control',
           'More information: [https://github.com/danger/danger](https://github.com/danger/danger).'
         ].join("\n")
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :use_bundle_exec,
-                                       env_name: 'DANGER_USE_BUNDLE_EXEC',
-                                       description: 'Use bundle exec when there is a Gemfile presented',
-                                       is_string: false,
-                                       default_value: true),
-          PantographCore::ConfigItem.new(key: :verbose,
-                                       env_name: 'DANGER_VERBOSE',
-                                       description: 'Show more debugging information',
-                                       is_string: false,
-                                       default_value: false),
-          PantographCore::ConfigItem.new(key: :danger_id,
-                                       env_name: 'DANGER_ID',
-                                       description: 'The identifier of this Danger instance',
-                                       type: String,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :dangerfile,
-                                       env_name: 'DANGER_DANGERFILE',
-                                       description: 'The location of your Dangerfile',
-                                       type: String,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :github_api_token,
-                                       env_name: 'DANGER_GITHUB_API_TOKEN',
-                                       description: 'GitHub API token for danger',
-                                       sensitive: true,
-                                       type: String,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :fail_on_errors,
-                                       env_name: 'DANGER_FAIL_ON_ERRORS',
-                                       description: 'Should always fail the build process, defaults to false',
-                                       is_string: false,
-                                       optional: true,
-                                       default_value: false),
-          PantographCore::ConfigItem.new(key: :new_comment,
-                                       env_name: 'DANGER_NEW_COMMENT',
-                                       description: 'Makes Danger post a new comment instead of editing its previous one',
-                                       is_string: false,
-                                       optional: true,
-                                       default_value: false),
-          PantographCore::ConfigItem.new(key: :remove_previous_comments,
-                                       env_name: 'DANGER_REMOVE_PREVIOUS_COMMENT',
-                                       description: 'Makes Danger remove all previous comment and create a new one in the end of the list',
-                                       is_string: false,
-                                       optional: true,
-                                       default_value: false),
-          PantographCore::ConfigItem.new(key: :base,
-                                       env_name: 'DANGER_BASE',
-                                       description: 'A branch/tag/commit to use as the base of the diff. [master|dev|stable]',
-                                       type: String,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :head,
-                                       env_name: 'DANGER_HEAD',
-                                       description: 'A branch/tag/commit to use as the head. [master|dev|stable]',
-                                       type: String,
-                                       optional: true),
-          PantographCore::ConfigItem.new(key: :pr,
-                                       env_name: 'DANGER_PR',
-                                       description: 'Run danger on a specific pull request. e.g. \"https://github.com/danger/danger/pull/518\"',
-                                       type: String,
-                                       optional: true)
+          PantographCore::ConfigItem.new(
+            key: :use_bundle_exec,
+            env_name: 'DANGER_USE_BUNDLE_EXEC',
+            description: 'Use bundle exec when there is a Gemfile presented',
+            is_string: false,
+            default_value: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :verbose,
+            env_name: 'DANGER_VERBOSE',
+            description: 'Show more debugging information',
+            is_string: false,
+            default_value: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :danger_id,
+            env_name: 'DANGER_ID',
+            description: 'The identifier of this Danger instance',
+            type: String,
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :dangerfile,
+            env_name: 'DANGER_DANGERFILE',
+            description: 'The location of your Dangerfile',
+            type: String,
+            optional: false,
+            default_value: 'Dangerfile'
+          ),
+          PantographCore::ConfigItem.new(
+            key: :github_api_token,
+            env_name: 'DANGER_GITHUB_API_TOKEN',
+            description: 'GitHub API token for danger',
+            sensitive: true,
+            type: String,
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :fail_on_errors,
+            env_name: 'DANGER_FAIL_ON_ERRORS',
+            description: 'Should always fail the build process, defaults to false',
+            is_string: false,
+            optional: true,
+            default_value: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :new_comment,
+            env_name: 'DANGER_NEW_COMMENT',
+            description: 'Makes Danger post a new comment instead of editing its previous one',
+            is_string: false,
+            optional: true,
+            default_value: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :remove_previous_comments,
+            env_name: 'DANGER_REMOVE_PREVIOUS_COMMENT',
+            description: 'Makes Danger remove all previous comment and create a new one in the end of the list',
+            is_string: false,
+            optional: true,
+            default_value: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :base,
+            env_name: 'DANGER_BASE',
+            description: 'A branch/tag/commit to use as the base of the diff. [master|dev|stable]',
+            type: String,
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :head,
+            env_name: 'DANGER_HEAD',
+            description: 'A branch/tag/commit to use as the head. [master|dev|stable]',
+            type: String,
+            optional: true
+          ),
+          PantographCore::ConfigItem.new(
+            key: :pr,
+            env_name: 'DANGER_PR',
+            description: 'Run danger on a specific pull request. e.g. \"https://github.com/danger/danger/pull/518\"',
+            type: String,
+            optional: true
+          )
         ]
       end
 
@@ -120,11 +141,11 @@ module Pantograph
       end
 
       def self.category
-        :misc
+        :source_control
       end
 
       def self.authors
-        ['KrauseFx']
+        ['KrauseFx', 'johnknapprs']
       end
     end
   end

data/pantograph/lib/pantograph/actions/debug.rb

@@ -7,7 +7,7 @@ module Pantograph
       end
 
       def self.description
-        "Print out an overview of the lane context values"
+        'Print out an overview of the lane context values'
       end
 
       def self.is_supported?(platform)
@@ -25,7 +25,7 @@ module Pantograph
       end
 
       def self.author
-        "KrauseFx"
+        'KrauseFx'
       end
     end
   end

data/pantograph/lib/pantograph/actions/default_platform.rb

@@ -6,7 +6,9 @@ module Pantograph
 
     class DefaultPlatformAction < Action
       def self.run(params)
-        UI.user_error!("You forgot to pass the default platform") if params.first.nil?
+        if params.first.nil?
+          UI.user_error!('You forgot to pass the default platform')
+        end
 
         platform = params.first.to_sym
 
@@ -16,7 +18,7 @@ module Pantograph
       end
 
       def self.description
-        "Defines a default platform to not have to specify the platform"
+        'Defines a default platform to not have to specify the platform'
       end
 
       def self.output
@@ -36,7 +38,7 @@ module Pantograph
       end
 
       def self.author
-        "KrauseFx"
+        'KrauseFx'
       end
 
       def self.is_supported?(platform)

data/pantograph/lib/pantograph/actions/download.rb

@@ -31,20 +31,21 @@ module Pantograph
 
       def self.details
         [
-          "Specify the URL to download and get the content as a return value.",
-          "Automatically parses JSON into a Ruby data structure.",
-          "For more advanced networking code, use the Ruby functions instead: [http://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html](http://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html)."
+          'Specify the URL to download and get the content as a return value.',
+          'Automatically parses JSON into a Ruby data structure.'
         ].join("\n")
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :url,
-                                       env_name: 'DOWNLOAD_URL',
-                                       description: "The URL that should be downloaded",
-                                       verify_block: proc do |value|
-                                         UI.important("The URL doesn't start with http or https") unless value.start_with?("http")
-                                       end)
+          PantographCore::ConfigItem.new(
+            key: :url,
+            env_name: 'DOWNLOAD_URL',
+            description: 'The URL that should be downloaded',
+            verify_block: proc do |value|
+              UI.important('The URL does not start with http or https') unless value.start_with?('http')
+            end
+          )
         ]
       end
 

data/pantograph/lib/pantograph/actions/echo.rb

@@ -7,7 +7,7 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Alias for the `puts` action"
+        'Alias for the `puts` action'
       end
     end
   end

data/pantograph/lib/pantograph/actions/ensure_bundle_exec.rb

@@ -1,16 +1,20 @@
 module Pantograph
   module Actions
-    module SharedValues
-    end
-
     # Raises an exception and stop the lane execution if not using bundle exec to run pantograph
     class EnsureBundleExecAction < Action
       def self.run(params)
         return if PluginManager.new.gemfile_path.nil?
         if PantographCore::Helper.bundler?
-          UI.success("Using bundled pantograph ✅")
+          UI.success('Using bundled pantograph ✅')
         else
-          UI.user_error!("pantograph detected a Gemfile in the current directory. However it seems like you don't use `bundle exec`. Use `bundle exec pantograph #{ARGV.join(' ')}`")
+          error_message = [
+            'pantograph detected a Gemfile in the current directory.',
+            'However it seems like you did not use `bundle exec`.',
+            "Use `bundle exec pantograph #{ARGV.join(' ')}`"
+          ]
+          error_message = error_message.join(' ')
+
+          UI.user_error!(error_message)
         end
       end
 
@@ -19,13 +23,12 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Raises an exception if not using `bundle exec` to run pantograph"
+        'Raises an exception if not using `bundle exec` to run pantograph'
       end
 
       def self.details
         [
-          "This action will check if you are using bundle exec to run pantograph.",
-          "You can put it into `before_all` and make sure that pantograph is run using `bundle exec pantograph` command."
+          'This action will check if you are using bundle exec to run pantograph.'
         ].join("\n")
       end
 
@@ -38,12 +41,17 @@ module Pantograph
       end
 
       def self.author
-        ['rishabhtayal']
+        ['rishabhtayal', 'johnknapprs']
       end
 
       def self.example_code
         [
-          "ensure_bundle_exec"
+          'ensure_bundle_exec',
+          ' # always check before running a lane
+          before_all do
+            ensure_bundle_exec
+          end
+          '
         ]
       end
 

data/pantograph/lib/pantograph/actions/ensure_env_vars.rb

@@ -2,17 +2,15 @@ module Pantograph
   module Actions
     class EnsureEnvVarsAction < Action
       def self.run(params)
-        variables = params[:env_vars]
-
-        variables.each do |variable|
-          next unless ENV[variable].to_s.strip.empty?
-
-          UI.user_error!("Missing environment variable '#{variable}'")
+        null_keys = params[:vars].reject do |var|
+          ENV.key?(var)
         end
 
-        is_one = variables.length == 1
+        if null_keys.any?
+          UI.user_error!("Unable to find ENV Variable(s):\n#{null_keys.join("\n")}")
+        end
 
-        UI.success("Environment variable#{is_one ? '' : 's'} '#{variables.join('\', \'')}' #{is_one ? 'is' : 'are'} set!")
+        UI.success("ENV variable(s) '#{params[:vars].join('\', \'')}' set!")
       end
 
       def self.description
@@ -20,28 +18,29 @@ module Pantograph
       end
 
       def self.details
-        'This action will check if some environment variables are set.'
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :env_vars,
-                                       description: 'The environment variables names that should be checked',
-                                       type: Array,
-                                       verify_block: proc do |value|
-                                         UI.user_error!('Specify at least one environment variable name') if value.empty?
-                                       end)
+          PantographCore::ConfigItem.new(
+            key: :vars,
+            description: 'The ENV variables keys to verify',
+            type: Array,
+            verify_block: proc do |value|
+              UI.user_error!('Specify at least one environment variable key') if value.empty?
+            end
+          )
         ]
       end
 
       def self.authors
-        ['revolter']
+        ['johnknapprs']
       end
 
       def self.example_code
         [
           'ensure_env_vars(
-            env_vars: [\'GITHUB_USER_NAME\', \'GITHUB_API_TOKEN\']
+            vars: [\'GITHUB_USER_NAME\', \'GITHUB_API_TOKEN\']
           )'
         ]
       end

data/pantograph/lib/pantograph/actions/ensure_git_branch.rb

@@ -1,17 +1,15 @@
 module Pantograph
   module Actions
-    module SharedValues
-    end
-
     # Raises an exception and stop the lane execution if the repo is not on a specific branch
     class EnsureGitBranchAction < Action
       def self.run(params)
-        branch = params[:branch]
-        branch_expr = /#{branch}/
-        if Actions.git_branch =~ branch_expr
-          UI.success("Git branch matches `#{branch}`, all good! 💪")
+        target_branch  = params[:branch]
+        current_branch = Helper::Git.current_branch
+
+        if current_branch =~ /#{target_branch}/
+          UI.success("Git branch matches `#{target_branch}`, all good! 💪")
         else
-          UI.user_error!("Git is not on a branch matching `#{branch}`. Current branch is `#{Actions.git_branch}`! Please ensure the repo is checked out to the correct branch.")
+          UI.user_error!("Git is not on a branch matching `#{target_branch}`. Current branch is `#{current_branch}`!")
         end
       end
 
@@ -32,11 +30,13 @@ module Pantograph
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :branch,
-                                       env_name: 'ENSURE_GIT_BRANCH_NAME',
-                                       description: "The branch that should be checked for. String that can be either the full name of the branch or a regex to match",
-                                       type: String,
-                                       default_value: 'master')
+          PantographCore::ConfigItem.new(
+            key: :branch,
+            env_name: 'ENSURE_GIT_BRANCH_NAME',
+            description: 'The branch that should be checked for. String that can be either the full name of the branch or a regex to match',
+            type: String,
+            default_value: 'master'
+          )
         ]
       end
 
@@ -45,7 +45,7 @@ module Pantograph
       end
 
       def self.author
-        ['dbachrach', 'Liquidsoul']
+        ['dbachrach', 'Liquidsoul', 'johnknapprs']
       end
 
       def self.example_code

data/pantograph/lib/pantograph/actions/ensure_git_status_clean.rb

@@ -1,72 +1,56 @@
 module Pantograph
   module Actions
     module SharedValues
-      GIT_REPO_WAS_CLEAN_ON_START = :GIT_REPO_WAS_CLEAN_ON_START
+      ENSURE_GIT_STATUS_CLEAN = :ENSURE_GIT_STATUS_CLEAN
     end
 
     # Raises an exception and stop the lane execution if the repo is not in a clean state
     class EnsureGitStatusCleanAction < Action
       def self.run(params)
-        repo_status = Actions.sh("git status --porcelain")
-        repo_clean = repo_status.empty?
+        repo_status = Helper::Git.repo_status
 
-        if repo_clean
+        if repo_status.empty?
           UI.success('Git status is clean, all good! 💪')
-          Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START] = true
+          Actions.lane_context[SharedValues::ENSURE_GIT_STATUS_CLEAN] = true
         else
-          error_message = 'Git repository is dirty! Please ensure the repo is in a clean state by committing/stashing/discarding all changes first.'
-          error_message += "\nUncommitted changes:\n#{repo_status}" if params[:show_uncommitted_changes]
-          if params[:show_diff]
-            repo_diff = Actions.sh("git diff")
-            error_message += "\nGit diff: \n#{repo_diff}"
-          end
+          error_message = [
+            'Git repository is dirty! Please ensure the repo is in a clean state by committing/stashing/discarding all changes first.',
+            'Uncommitted changes:',
+            repo_status
+          ].join("\n")
+
           UI.user_error!(error_message)
         end
       end
 
       def self.description
-        'Raises an exception if there are uncommitted git changes'
+        'Raises error if there are uncommitted git changes'
       end
 
       def self.details
-        [
-          'A sanity check to make sure you are working in a repo that is clean.',
-          'Especially useful to put at the beginning of your Pantfile in the `before_all` block, if some of your other actions will touch your filesystem, do things to your git repo, or just as a general reminder to save your work.',
-          'Also needed as a prerequisite for some other actions like `reset_git_repo`.'
-        ].join("\n")
       end
 
       def self.output
         [
-          ['GIT_REPO_WAS_CLEAN_ON_START', 'Stores the fact that the git repo was clean at some point']
+          ['ENSURE_GIT_STATUS_CLEAN', 'Returns `true` if status clean when executed']
         ]
       end
 
       def self.author
-        ['lmirosevic', 'antondomashnev']
+        ['lmirosevic', 'antondomashnev', 'johnknapprs']
       end
 
       def self.example_code
         [
-          'ensure_git_status_clean'
+          'before_all do
+             # Prevent pantograph from running lanes when git is in a dirty state
+             ensure_git_status_clean
+           end'
         ]
       end
 
       def self.available_options
-        [
-          PantographCore::ConfigItem.new(key: :show_uncommitted_changes,
-                                       env_name: 'ENSURE_GIT_STATUS_CLEAN_SHOW_UNCOMMITTED_CHANGES',
-                                       description: 'The flag whether to show uncommitted changes if the repo is dirty',
-                                       optional: true,
-                                       default_value: false,
-                                       is_string: false),
-          PantographCore::ConfigItem.new(key: :show_diff,
-                                       env_name: 'ENSURE_GIT_STATUS_CLEAN_SHOW_DIFF',
-                                       description: 'The flag whether to show the git diff if the repo is dirty',
-                                       optional: true,
-                                       default_value: false,
-                                       is_string: false)
-        ]
+        []
       end
 
       def self.category

data/pantograph/lib/pantograph/actions/get_github_release.rb

@@ -144,7 +144,7 @@ module Pantograph
 
       def self.example_code
         [
-          'release = get_github_release(url: "pantograph/pantograph", version: "1.0.0")
+          'release = get_github_release(url: "johnknapprs/pantograph", version: "1.0.0")
           puts release["name"]'
         ]
       end

data/pantograph/lib/pantograph/actions/git_branch.rb

@@ -1,13 +1,12 @@
 module Pantograph
   module Actions
     module SharedValues
-      GIT_BRANCH_ENV_VARS = %w(GIT_BRANCH BRANCH_NAME TRAVIS_BRANCH BITRISE_GIT_BRANCH CI_BUILD_REF_NAME CI_COMMIT_REF_NAME WERCKER_GIT_BRANCH BUILDKITE_BRANCH).freeze
+      GIT_BRANCH_NAME = :GIT_BRANCH_NAME
     end
 
     class GitBranchAction < Action
       def self.run(params)
-        env_name = SharedValues::GIT_BRANCH_ENV_VARS.find { |env_var| PantographCore::Env.truthy?(env_var) }
-        ENV.fetch(env_name.to_s) { `git symbolic-ref HEAD --short 2>/dev/null`.strip }
+        Actions.lane_context[SharedValues::GIT_BRANCH_NAME] = Helper::Git.current_branch
       end
 
       #####################################################
@@ -15,11 +14,11 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Returns the name of the current git branch, possibly as managed by CI ENV vars"
+        'Returns the name of the current git branch'
       end
 
       def self.details
-        "If no branch could be found, this action will return an empty string"
+        'If no branch could be found, this action will return an empty string'
       end
 
       def self.available_options
@@ -28,12 +27,12 @@ module Pantograph
 
       def self.output
         [
-          ['GIT_BRANCH_ENV_VARS', 'The git branch environment variables']
+          ['GIT_BRANCH_NAME', 'The git branch name']
         ]
       end
 
       def self.authors
-        ["KrauseFx"]
+        ['johnknapprs']
       end
 
       def self.is_supported?(platform)