pantograph 0.1.0

data/pantograph/lib/pantograph/actions/create_pull_request.rb

@@ -0,0 +1,190 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      CREATE_PULL_REQUEST_HTML_URL = :CREATE_PULL_REQUEST_HTML_URL
+    end
+
+    class CreatePullRequestAction < Action
+      def self.run(params)
+        UI.message("Creating new pull request from '#{params[:head]}' to branch '#{params[:base]}' of '#{params[:repo]}'")
+
+        payload = {
+          'title' => params[:title],
+          'head' => params[:head],
+          'base' => params[:base]
+        }
+        payload['body'] = params[:body] if params[:body]
+
+        GithubApiAction.run(
+          server_url: params[:api_url],
+          api_token: params[:api_token],
+          http_method: 'POST',
+          path: "repos/#{params[:repo]}/pulls",
+          body: payload,
+          error_handlers: {
+            '*' => proc do |result|
+              UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
+              return nil
+            end
+          }
+        ) do |result|
+          json = result[:json]
+          number = json['number']
+          html_url = json['html_url']
+          UI.success("Successfully created pull request ##{number}. You can see it at '#{html_url}'")
+
+          # Add labels to pull request
+          add_labels(params, number) if params[:labels]
+
+          # Add assignees to pull request
+          add_assignees(params, number) if params[:assignees]
+
+          Actions.lane_context[SharedValues::CREATE_PULL_REQUEST_HTML_URL] = html_url
+          return html_url
+        end
+      end
+
+      def self.add_labels(params, number)
+        payload = {
+          'labels' => params[:labels]
+        }
+        GithubApiAction.run(
+          server_url: params[:api_url],
+          api_token: params[:api_token],
+          http_method: 'PATCH',
+          path: "repos/#{params[:repo]}/issues/#{number}",
+          body: payload,
+          error_handlers: {
+            '*' => proc do |result|
+              UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
+              return nil
+            end
+          }
+        )
+      end
+
+      def self.add_assignees(params, number)
+        payload = {
+          'assignees' => params[:assignees]
+        }
+        GithubApiAction.run(
+          server_url: params[:api_url],
+          api_token: params[:api_token],
+          http_method: 'POST',
+          path: "repos/#{params[:repo]}/issues/#{number}/assignees",
+          body: payload,
+          error_handlers: {
+            '*' => proc do |result|
+              UI.error("GitHub responded with #{result[:status]}: #{result[:body]}")
+              return nil
+            end
+          }
+        )
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "This will create a new pull request on GitHub"
+      end
+
+      def self.output
+        [
+          ['CREATE_PULL_REQUEST_HTML_URL', 'The HTML URL to the created pull request']
+        ]
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :api_token,
+                                       env_name: "GITHUB_PULL_REQUEST_API_TOKEN",
+                                       description: "Personal API Token for GitHub - generate one at https://github.com/settings/tokens",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       default_value: ENV["GITHUB_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       is_string: true,
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :repo,
+                                       env_name: "GITHUB_PULL_REQUEST_REPO",
+                                       description: "The name of the repository you want to submit the pull request to",
+                                       is_string: true,
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :title,
+                                       env_name: "GITHUB_PULL_REQUEST_TITLE",
+                                       description: "The title of the pull request",
+                                       is_string: true,
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :body,
+                                       env_name: "GITHUB_PULL_REQUEST_BODY",
+                                       description: "The contents of the pull request",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :labels,
+                                       env_name: "GITHUB_PULL_REQUEST_LABELS",
+                                       description: "The labels for the pull request",
+                                       type: Array,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :head,
+                                       env_name: "GITHUB_PULL_REQUEST_HEAD",
+                                       description: "The name of the branch where your changes are implemented (defaults to the current branch name)",
+                                       is_string: true,
+                                       code_gen_sensitive: true,
+                                       default_value: Actions.git_branch,
+                                       default_value_dynamic: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :base,
+                                       env_name: "GITHUB_PULL_REQUEST_BASE",
+                                       description: "The name of the branch you want your changes pulled into (defaults to `master`)",
+                                       is_string: true,
+                                       default_value: 'master',
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :api_url,
+                                       env_name: "GITHUB_PULL_REQUEST_API_URL",
+                                       description: "The URL of GitHub API - used when the Enterprise (default to `https://api.github.com`)",
+                                       is_string: true,
+                                       code_gen_default_value: 'https://api.github.com',
+                                       default_value: 'https://api.github.com',
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :assignees,
+                                       env_name: "GITHUB_PULL_REQUEST_ASSIGNEES",
+                                       description: "The assignees for the pull request",
+                                       type: Array,
+                                       optional: true)
+        ]
+      end
+
+      def self.author
+        ["seei", "tommeier", "marumemomo"]
+      end
+
+      def self.is_supported?(platform)
+        return true
+      end
+
+      def self.return_value
+        "The pull request URL when successful"
+      end
+
+      def self.example_code
+        [
+          'create_pull_request(
+            api_token: "secret",                # optional, defaults to ENV["GITHUB_API_TOKEN"]
+            repo: "pantograph/pantograph",
+            title: "Amazing new feature",
+            head: "my-feature",                 # optional, defaults to current branch name
+            base: "master",                     # optional, defaults to "master"
+            body: "Please pull this in!",       # optional
+            api_url: "http://yourdomain/api/v3" # optional, for GitHub Enterprise, defaults to "https://api.github.com"
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+module Pantograph
+  module Actions
+    class DangerAction < Action
+      def self.run(params)
+        Actions.verify_gem!('danger')
+        cmd = []
+
+        cmd << 'bundle exec' if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
+        cmd << 'danger'
+        cmd << '--verbose' if params[:verbose]
+
+        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
+
+        ENV['DANGER_GITHUB_API_TOKEN'] = params[:github_api_token] if params[:github_api_token]
+
+        Actions.sh(cmd.join(' '))
+      end
+
+      def self.description
+        "Runs `danger` for the project"
+      end
+
+      def self.details
+        [
+          "Formalize your Pull Request etiquette.",
+          "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: "FL_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: "FL_DANGER_VERBOSE",
+                                       description: "Show more debugging information",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :danger_id,
+                                       env_name: "FL_DANGER_ID",
+                                       description: "The identifier of this Danger instance",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :dangerfile,
+                                       env_name: "FL_DANGER_DANGERFILE",
+                                       description: "The location of your Dangerfile",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :github_api_token,
+                                       env_name: "FL_DANGER_GITHUB_API_TOKEN",
+                                       description: "GitHub API token for danger",
+                                       sensitive: true,
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :fail_on_errors,
+                                       env_name: "FL_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: "FL_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: "FL_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: "FL_DANGER_BASE",
+                                       description: "A branch/tag/commit to use as the base of the diff. [master|dev|stable]",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :head,
+                                       env_name: "FL_DANGER_HEAD",
+                                       description: "A branch/tag/commit to use as the head. [master|dev|stable]",
+                                       is_string: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :pr,
+                                       env_name: "FL_DANGER_PR",
+                                       description: "Run danger on a specific pull request. e.g. \"https://github.com/danger/danger/pull/518\"",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'danger',
+          'danger(
+            danger_id: "unit-tests",
+            dangerfile: "tests/MyOtherDangerFile",
+            github_api_token: ENV["GITHUB_API_TOKEN"],
+            verbose: true
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Pantograph
+  module Actions
+    class DebugAction < Action
+      def self.run(params)
+        puts("Lane Context".green)
+        puts(Actions.lane_context)
+      end
+
+      def self.description
+        "Print out an overview of the lane context values"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'debug'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      DEFAULT_PLATFORM = :DEFAULT_PLATFORM
+    end
+
+    class DefaultPlatformAction < Action
+      def self.run(params)
+        UI.user_error!("You forgot to pass the default platform") if params.first.nil?
+
+        platform = params.first.to_sym
+
+        SupportedPlatforms.verify!(platform)
+
+        Actions.lane_context[SharedValues::DEFAULT_PLATFORM] = platform
+      end
+
+      def self.description
+        "Defines a default platform to not have to specify the platform"
+      end
+
+      def self.output
+        [
+          ['DEFAULT_PLATFORM', 'The default platform']
+        ]
+      end
+
+      def self.example_code
+        [
+          'default_platform(:android)'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      DOWNLOAD_CONTENT = :DOWNLOAD_CONTENT
+    end
+
+    class DownloadAction < Action
+      def self.run(params)
+        require 'net/http'
+
+        begin
+          result = Net::HTTP.get(URI(params[:url]))
+          begin
+            result = JSON.parse(result) # try to parse and see if it's valid JSON data
+          rescue
+            # never mind, using standard text data instead
+          end
+          Actions.lane_context[SharedValues::DOWNLOAD_CONTENT] = result
+        rescue => ex
+          UI.user_error!("Error fetching remote file: #{ex}")
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Download a file from a remote server (e.g. JSON file)"
+      end
+
+      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)."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_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)
+        ]
+      end
+
+      def self.output
+        [
+          ['DOWNLOAD_CONTENT', 'The content of the file we just downloaded']
+        ]
+      end
+
+      def self.example_code
+        [
+          'data = download(url: "https://host.com/api.json")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Pantograph
+  module Actions
+    require 'pantograph/actions/puts'
+    class EchoAction < PutsAction
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Alias for the `puts` action"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+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 ✅")
+        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(' ')}`")
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "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."
+        ].join("\n")
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.output
+        []
+      end
+
+      def self.author
+        ['rishabhtayal']
+      end
+
+      def self.example_code
+        [
+          "ensure_bundle_exec"
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+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}'")
+        end
+
+        is_one = variables.length == 1
+
+        UI.success("Environment variable#{is_one ? '' : 's'} '#{variables.join('\', \'')}' #{is_one ? 'is' : 'are'} set!")
+      end
+
+      def self.description
+        'Raises an exception if the specified env vars are not set'
+      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)
+        ]
+      end
+
+      def self.authors
+        ['revolter']
+      end
+
+      def self.example_code
+        [
+          'ensure_env_vars(
+            env_vars: [\'GITHUB_USER_NAME\', \'GITHUB_API_TOKEN\']
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+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! 💪")
+        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.")
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Raises an exception if not on a specific git branch"
+      end
+
+      def self.details
+        [
+          "This action will check if your git repo is checked out to a specific branch.",
+          "You may only want to make releases from a specific branch, so `ensure_git_branch` will stop a lane if it was accidentally executed on an incorrect branch."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :branch,
+                                       env_name: "FL_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",
+                                       is_string: true,
+                                       default_value: 'master')
+        ]
+      end
+
+      def self.output
+        []
+      end
+
+      def self.author
+        ['dbachrach', 'Liquidsoul']
+      end
+
+      def self.example_code
+        [
+          "ensure_git_branch # defaults to `master` branch",
+          "ensure_git_branch(
+            branch: 'develop'
+          )"
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end