pantograph 0.1.0

data/pantograph/lib/pantograph/actions/last_git_tag.rb

@@ -0,0 +1,51 @@
+module Pantograph
+  module Actions
+    class LastGitTagAction < Action
+      def self.run(params)
+        Actions.last_git_tag_name
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Get the most recent git tag"
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.output
+        []
+      end
+
+      def self.return_type
+        :string
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.details
+        "If you are using this action on a **shallow clone**, *the default with some CI systems like Bamboo*, you need to ensure that you have also pulled all the git tags appropriately. Assuming your git repo has the correct remote set you can issue `sh('git fetch --tags')`."
+      end
+
+      def self.example_code
+        [
+          'last_git_tag'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/make_changelog_from_jenkins.rb

@@ -0,0 +1,81 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      FL_CHANGELOG ||= :FL_CHANGELOG # originally defined in ChangelogFromGitCommitsAction
+    end
+
+    class MakeChangelogFromJenkinsAction < Action
+      def self.run(params)
+        require 'json'
+        require 'net/http'
+
+        changelog = ""
+
+        if Helper.ci? || Helper.test?
+          # The "BUILD_URL" environment variable is set automatically by Jenkins in every build
+          jenkins_api_url = URI(ENV["BUILD_URL"] + "api/json\?wrapper\=changes\&xpath\=//changeSet//comment")
+          begin
+            json = JSON.parse(Net::HTTP.get(jenkins_api_url))
+            json['changeSet']['items'].each do |item|
+              comment = params[:include_commit_body] ? item['comment'] : item['msg']
+              changelog << comment.strip + "\n"
+            end
+          rescue => ex
+            UI.error("Unable to read/parse changelog from jenkins: #{ex.message}")
+          end
+        end
+
+        Actions.lane_context[SharedValues::FL_CHANGELOG] = changelog.strip.length > 0 ? changelog : params[:fallback_changelog]
+      end
+
+      def self.description
+        "Generate a changelog using the Changes section from the current Jenkins build"
+      end
+
+      def self.details
+        "This is useful when deploying automated builds. The changelog from Jenkins lists all the commit messages since the last build."
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :fallback_changelog,
+                                       description: "Fallback changelog if there is not one on Jenkins, or it couldn't be read",
+                                       optional: true,
+                                       default_value: ""),
+          PantographCore::ConfigItem.new(key: :include_commit_body,
+                                       description: "Include the commit body along with the summary",
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['FL_CHANGELOG', 'The changelog generated by Jenkins']
+        ]
+      end
+
+      def self.authors
+        ["mandrizzle"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'make_changelog_from_jenkins(
+            # Optional, lets you set a changelog in the case is not generated on Jenkins or if ran outside of Jenkins
+            fallback_changelog: "Bug fixes and performance enhancements"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/min_pantograph_version.rb

@@ -0,0 +1,57 @@
+module Pantograph
+  module Actions
+    module SharedValues
+    end
+
+    class MinPantographVersionAction < Action
+      def self.run(params)
+        params = nil unless params.kind_of?(Array)
+        value = (params || []).first
+        defined_version = Gem::Version.new(value) if value
+
+        UI.user_error!("Please pass minimum pantograph version as parameter to min_pantograph_version") unless defined_version
+
+        if Gem::Version.new(Pantograph::VERSION) < defined_version
+          PantographCore::UpdateChecker.show_update_message('pantograph', Pantograph::VERSION)
+          error_message = "The Pantfile requires a pantograph version of >= #{defined_version}. You are on #{Pantograph::VERSION}."
+          UI.user_error!(error_message)
+        end
+
+        UI.message("Your pantograph version #{Pantograph::VERSION} matches the minimum requirement of #{defined_version}  ✅")
+      end
+
+      def self.step_text
+        "Verifying pantograph version"
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.description
+        "Verifies the minimum pantograph version required"
+      end
+
+      def self.example_code
+        [
+          'min_pantograph_version("1.50.0")'
+        ]
+      end
+
+      def self.details
+        [
+          "Add this to your `Pantfile` to require a certain version of _pantograph_.",
+          "Use it if you use an action that just recently came out and you need it."
+        ].join("\n")
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/nexus_upload.rb

@@ -0,0 +1,230 @@
+module Pantograph
+  module Actions
+    class NexusUploadAction < Action
+      def self.run(params)
+        command = []
+        command << "curl"
+        command << verbose(params)
+        command += ssl_options(params)
+        command += proxy_options(params)
+        command += upload_options(params)
+        command << upload_url(params)
+
+        Pantograph::Actions.sh(command.join(' '), log: params[:verbose])
+      end
+
+      def self.upload_url(params)
+        url = "#{params[:endpoint]}#{params[:mount_path]}"
+
+        if params[:nexus_version] == 2
+          url << "/service/local/artifact/maven/content"
+        else
+          file_extension = File.extname(params[:file]).shellescape
+
+          url << "/repository/#{params[:repo_id]}"
+          url << "/#{params[:repo_group_id].gsub('.', '/')}"
+          url << "/#{params[:repo_project_name]}"
+          url << "/#{params[:repo_project_version]}"
+          url << "/#{params[:repo_project_name]}-#{params[:repo_project_version]}"
+          url << "-#{params[:repo_classifier]}" if params[:repo_classifier]
+          url << file_extension.to_s
+        end
+
+        url.shellescape
+      end
+
+      def self.verbose(params)
+        params[:verbose] ? "--verbose" : "--silent"
+      end
+
+      def self.upload_options(params)
+        file_path = File.expand_path(params[:file]).shellescape
+        file_extension = file_path.split('.').last.shellescape
+
+        options = []
+        if params[:nexus_version] == 2
+          options << "-F p=zip"
+          options << "-F hasPom=false"
+          options << "-F r=#{params[:repo_id].shellescape}"
+          options << "-F g=#{params[:repo_group_id].shellescape}"
+          options << "-F a=#{params[:repo_project_name].shellescape}"
+          options << "-F v=#{params[:repo_project_version].shellescape}"
+
+          if params[:repo_classifier]
+            options << "-F c=#{params[:repo_classifier].shellescape}"
+          end
+
+          options << "-F e=#{file_extension}"
+          options << "-F file=@#{file_path}"
+        else
+          options << "--upload-file #{file_path}"
+        end
+
+        options << "-u #{params[:username].shellescape}:#{params[:password].shellescape}"
+
+        options
+      end
+
+      def self.ssl_options(params)
+        options = []
+        unless params[:ssl_verify]
+          options << "--insecure"
+        end
+
+        options
+      end
+
+      def self.proxy_options(params)
+        options = []
+        if params[:proxy_address] && params[:proxy_port] && params[:proxy_username] && params[:proxy_password]
+          options << "-x #{params[:proxy_address].shellescape}:#{params[:proxy_port].shellescape}"
+          options << "--proxy-user #{params[:proxy_username].shellescape}:#{params[:proxy_password].shellescape}"
+        end
+
+        options
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload a file to [Sonatype Nexus platform](https://www.sonatype.com)"
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :file,
+                                       env_name: "FL_NEXUS_FILE",
+                                       description: "File to be uploaded to Nexus",
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         file_path = File.expand_path(value)
+                                         UI.user_error!("Couldn't find file at path '#{file_path}'") unless File.exist?(file_path)
+                                       end),
+          PantographCore::ConfigItem.new(key: :repo_id,
+                                       env_name: "FL_NEXUS_REPO_ID",
+                                       description: "Nexus repository id e.g. artefacts",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :repo_group_id,
+                                       env_name: "FL_NEXUS_REPO_GROUP_ID",
+                                       description: "Nexus repository group id e.g. com.company",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :repo_project_name,
+                                       env_name: "FL_NEXUS_REPO_PROJECT_NAME",
+                                       description: "Nexus repository commandect name. Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :repo_project_version,
+                                       env_name: "FL_NEXUS_REPO_PROJECT_VERSION",
+                                       description: "Nexus repository commandect version",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :repo_classifier,
+                                       env_name: "FL_NEXUS_REPO_CLASSIFIER",
+                                       description: "Nexus repository artifact classifier (optional)",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :endpoint,
+                                       env_name: "FL_NEXUS_ENDPOINT",
+                                       description: "Nexus endpoint e.g. http://nexus:8081",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :mount_path,
+                                       env_name: "FL_NEXUS_MOUNT_PATH",
+                                       description: "Nexus mount path (Nexus 3 instances have this configured as empty by default)",
+                                       default_value: "/nexus",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_NEXUS_USERNAME",
+                                       description: "Nexus username",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :password,
+                                       env_name: "FL_NEXUS_PASSWORD",
+                                       description: "Nexus password",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :ssl_verify,
+                                       env_name: "FL_NEXUS_SSL_VERIFY",
+                                       description: "Verify SSL",
+                                       is_string: false,
+                                       default_value: true,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :nexus_version,
+                                       env_name: "FL_NEXUS_MAJOR_VERSION",
+                                       description: "Nexus major version",
+                                       type: Integer,
+                                       default_value: 2,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         min_version = 2
+                                         max_version = 3
+                                         UI.user_error!("Unsupported version (#{value}) min. supported version: #{min_version}") unless value >= min_version
+                                         UI.user_error!("Unsupported version (#{value}) max. supported version: #{max_version}") unless value <= max_version
+                                       end),
+          PantographCore::ConfigItem.new(key: :verbose,
+                                       env_name: "FL_NEXUS_VERBOSE",
+                                       description: "Make detailed output",
+                                       is_string: false,
+                                       default_value: false,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :proxy_username,
+                                       env_name: "FL_NEXUS_PROXY_USERNAME",
+                                       description: "Proxy username",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :proxy_password,
+                                       env_name: "FL_NEXUS_PROXY_PASSWORD",
+                                       sensitive: true,
+                                       description: "Proxy password",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :proxy_address,
+                                       env_name: "FL_NEXUS_PROXY_ADDRESS",
+                                       description: "Proxy address",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :proxy_port,
+                                       env_name: "FL_NEXUS_PROXY_PORT",
+                                       description: "Proxy port",
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["xfreebird", "mdio"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          '# for Nexus 2
+          nexus_upload(
+            file: "/path/to/file.ipa",
+            repo_id: "artefacts",
+            repo_group_id: "com.pantograph",
+            repo_project_name: "ipa",
+            repo_project_version: "1.13",
+            repo_classifier: "dSYM", # Optional
+            endpoint: "http://localhost:8081",
+            username: "admin",
+            password: "admin123"
+          )',
+          '# for Nexus 3
+          nexus_upload(
+            nexus_version: 3,
+            mount_path: "",
+            file: "/path/to/file.ipa",
+            repo_id: "artefacts",
+            repo_group_id: "com.pantograph",
+            repo_project_name: "ipa",
+            repo_project_version: "1.13",
+            repo_classifier: "dSYM", # Optional
+            endpoint: "http://localhost:8081",
+            username: "admin",
+            password: "admin123"
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/notification.rb

@@ -0,0 +1,75 @@
+module Pantograph
+  module Actions
+    class NotificationAction < Action
+      def self.run(params)
+        require 'terminal-notifier'
+
+        options = params.values
+        # :message is non-optional
+        message = options.delete(:message)
+        # remove nil keys, since `notify` below does not ignore them and instead translates them into empty strings in output, which looks ugly
+        options = options.select { |_, v| v }
+        option_map = {
+          app_icon: :appIcon,
+          content_image: :contentImage
+        }
+        options = Hash[options.map { |k, v| [option_map.fetch(k, k), v] }]
+        TerminalNotifier.notify(message, options)
+      end
+
+      def self.description
+        "Display a macOS notification with custom message and title"
+      end
+
+      def self.author
+        ["champo", "cbowns", "KrauseFx", "amarcadet", "dusek"]
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :title,
+                                       description: "The title to display in the notification",
+                                       default_value: 'pantograph'),
+          PantographCore::ConfigItem.new(key: :subtitle,
+                                       description: "A subtitle to display in the notification",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :message,
+                                       description: "The message to display in the notification",
+                                       optional: false),
+          PantographCore::ConfigItem.new(key: :sound,
+                                       description: "The name of a sound to play when the notification appears (names are listed in Sound Preferences)",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :activate,
+                                       description: "Bundle identifier of application to be opened when the notification is clicked",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :app_icon,
+                                       description: "The URL of an image to display instead of the application icon (Mavericks+ only)",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :content_image,
+                                       description: "The URL of an image to display attached to the notification (Mavericks+ only)",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :open,
+                                       description: "URL of the resource to be opened when the notification is clicked",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :execute,
+                                       description: "Shell command to run when the notification is clicked",
+                                       optional: true)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        Helper.mac?
+      end
+
+      def self.example_code
+        [
+          'notification(subtitle: "Finished Building", message: "Ready to upload...")'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/number_of_commits.rb

@@ -0,0 +1,75 @@
+module Pantograph
+  module Actions
+    class NumberOfCommitsAction < Action
+      def self.is_git?
+        Actions.sh('git rev-parse HEAD')
+        return true
+      rescue
+        return false
+      end
+
+      def self.run(params)
+        if is_git?
+          if params[:all]
+            command = 'git rev-list --all --count'
+          else
+            command = 'git rev-list HEAD --count'
+          end
+        else
+          UI.user_error!("Not in a git repository.")
+        end
+        return Actions.sh(command).strip.to_i
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Return the number of commits in current git branch"
+      end
+
+      def self.return_value
+        "The total number of all commits in current git branch"
+      end
+
+      def self.return_type
+        :int
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :all,
+                                       env_name: "FL_NUMBER_OF_COMMITS_ALL",
+                                       optional: true,
+                                       is_string: false,
+                                       description: "Returns number of all commits instead of current branch")
+        ]
+      end
+
+      def self.details
+        "You can use this action to get the number of commits of this branch. This is useful if you want to set the build number to the number of commits. See `pantograph actions number_of_commits` for more details."
+      end
+
+      def self.authors
+        ["onevcat", "samuelbeek"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'increment_build_number(build_number: number_of_commits)',
+          'build_number = number_of_commits(all: true)
+          increment_build_number(build_number: build_number)'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/opt_out_usage.rb

@@ -0,0 +1,40 @@
+module Pantograph
+  module Actions
+    class OptOutUsageAction < Action
+      def self.run(params)
+        ENV['PANTOGRAPH_OPT_OUT_USAGE'] = "YES"
+        UI.message("Disabled upload of used actions")
+      end
+
+      def self.description
+        "This will stop uploading the information which actions were run"
+      end
+
+      def self.details
+        [
+          "By default, _pantograph_ will track what actions are being used. No personal/sensitive information is recorded.",
+          "Learn more at [https://docs.pantograph.tools/#metrics](https://docs.pantograph.tools/#metrics).",
+          "Add `opt_out_usage` at the top of your Pantfile to disable metrics collection."
+        ].join("\n")
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'opt_out_usage # add this to the top of your Pantfile'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/pantograph_version.rb

@@ -0,0 +1,15 @@
+require "pantograph/actions/min_pantograph_version"
+
+module Pantograph
+  module Actions
+    class PantographVersionAction < MinPantographVersionAction
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Alias for the `min_pantograph_version` action"
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/println.rb

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