pantograph 0.1.0

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

@@ -0,0 +1,81 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      GIT_REPO_WAS_CLEAN_ON_START = :GIT_REPO_WAS_CLEAN_ON_START
+    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?
+
+        if repo_clean
+          UI.success('Git status is clean, all good! 💪')
+          Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START] = 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
+          UI.user_error!(error_message)
+        end
+      end
+
+      def self.description
+        "Raises an exception 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']
+        ]
+      end
+
+      def self.author
+        ["lmirosevic", "antondomashnev"]
+      end
+
+      def self.example_code
+        [
+          'ensure_git_status_clean'
+        ]
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :show_uncommitted_changes,
+                                       env_name: "FL_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: "FL_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
+        :source_control
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/erb.rb

@@ -0,0 +1,88 @@
+module Pantograph
+  module Actions
+    class ErbAction < Action
+      def self.run(params)
+        template = File.read(params[:template])
+        result =   ERB.new(template).result(OpenStruct.new(params[:placeholders]).instance_eval { binding })
+        File.open(params[:destination], 'w') { |file| file.write(result) } if params[:destination]
+        UI.message("Successfully parsed template: '#{params[:template]}' and rendered output to: #{params[:destination]}") if params[:destination]
+        result
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Allows to Generate output files based on ERB templates"
+      end
+
+      def self.details
+        [
+          "Renders an ERB template with `:placeholders` given as a hash via parameter.",
+          "If no `:destination` is set, it returns the rendered template as string."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+
+          PantographCore::ConfigItem.new(key: :template,
+                                       short_option: "-T",
+                                       env_name: "FL_ERB_SRC",
+                                       description: "ERB Template File",
+                                       optional: false,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :destination,
+                                       short_option: "-D",
+                                       env_name: "FL_ERB_DST",
+                                       description: "Destination file",
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :placeholders,
+                                       short_option: "-p",
+                                       env_name: "FL_ERB_PLACEHOLDERS",
+                                       description: "Placeholders given as a hash",
+                                       default_value: {},
+                                       is_string: false,
+                                       type: Hash)
+
+        ]
+      end
+
+      def self.authors
+        ["hjanuschka"]
+      end
+
+      def self.example_code
+        [
+          '# Example `erb` template:
+
+          # Variable1 <%= var1 %>
+          # Variable2 <%= var2 %>
+          # <% for item in var3 %>
+          #        <%= item %>
+          # <% end %>
+
+          erb(
+            template: "1.erb",
+            destination: "/tmp/rendered.out",
+            placeholders: {
+              :var1 => 123,
+              :var2 => "string",
+              :var3 => ["element1", "element2"]
+            }
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/get_build_number_repository.rb

@@ -0,0 +1,120 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      BUILD_NUMBER_REPOSITORY = :BUILD_NUMBER_REPOSITORY
+    end
+
+    class GetBuildNumberRepositoryAction < Action
+      def self.is_svn?
+        Actions.sh('svn info')
+        return true
+      rescue
+        return false
+      end
+
+      def self.is_git?
+        Actions.sh('git rev-parse HEAD')
+        return true
+      rescue
+        return false
+      end
+
+      def self.is_git_svn?
+        Actions.sh('git svn info')
+        return true
+      rescue
+        return false
+      end
+
+      def self.is_hg?
+        Actions.sh('hg status')
+        return true
+      rescue
+        return false
+      end
+
+      def self.command(use_hg_revision_number)
+        if is_svn?
+          UI.message("Detected repo: svn")
+          return 'svn info | grep Revision | egrep -o "[0-9]+"'
+        elsif is_git_svn?
+          UI.message("Detected repo: git-svn")
+          return 'git svn info | grep Revision | egrep -o "[0-9]+"'
+        elsif is_git?
+          UI.message("Detected repo: git")
+          return 'git rev-parse --short HEAD'
+        elsif is_hg?
+          UI.message("Detected repo: hg")
+          if use_hg_revision_number
+            return 'hg parent --template {rev}'
+          else
+            return 'hg parent --template "{node|short}"'
+          end
+        else
+          UI.user_error!("No repository detected")
+        end
+      end
+
+      def self.run(params)
+        build_number = Action.sh(command(params[:use_hg_revision_number])).strip
+        Actions.lane_context[SharedValues::BUILD_NUMBER_REPOSITORY] = build_number
+        return build_number
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Get the build number from the current repository"
+      end
+
+      def self.details
+        [
+          "This action will get the **build number** according to what the SCM HEAD reports.",
+          "Currently supported SCMs are svn (uses root revision), git-svn (uses svn revision), git (uses short hash) and mercurial (uses short hash or revision number).",
+          "There is an option, `:use_hg_revision_number`, which allows to use mercurial revision number instead of hash."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :use_hg_revision_number,
+                                       env_name: "USE_HG_REVISION_NUMBER",
+                                       description: "Use hg revision number instead of hash (ignored for non-hg repos)",
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['BUILD_NUMBER_REPOSITORY', 'The build number from the current repository']
+        ]
+      end
+
+      def self.return_value
+        "The build number from the current repository"
+      end
+
+      def self.authors
+        ["bartoszj", "pbrooks", "armadsen"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'get_build_number_repository'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      GET_GITHUB_RELEASE_INFO = :GET_GITHUB_RELEASE_INFO
+    end
+
+    class GetGithubReleaseAction < Action
+      def self.run(params)
+        UI.message("Getting release on GitHub (#{params[:server_url]}/#{params[:url]}: #{params[:version]})")
+
+        GithubApiAction.run(
+          server_url: params[:server_url],
+          api_token: params[:api_token],
+          http_method: 'GET',
+          path: "repos/#{params[:url]}/releases",
+          error_handlers: {
+            404 => proc do |result|
+              UI.error("Repository #{params[:url]} cannot be found, please double check its name and that you provided a valid API token (if it's a private repository).")
+              return nil
+            end,
+            401 => proc do |result|
+              UI.error("You are not authorized to access #{params[:url]}, please make sure you provided a valid API token.")
+              return nil
+            end,
+            '*' => proc do |result|
+              UI.error("GitHub responded with #{result[:status]}:#{result[:body]}")
+              return nil
+            end
+          }
+        ) do |result|
+          json = result[:json]
+          json.each do |current|
+            next unless current['tag_name'] == params[:version]
+
+            # Found it
+            Actions.lane_context[SharedValues::GET_GITHUB_RELEASE_INFO] = current
+            UI.message("Version is already live on GitHub.com 🚁")
+            return current
+          end
+        end
+
+        UI.important("Couldn't find GitHub release #{params[:version]}")
+        return nil
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "This will verify if a given release version is available on GitHub"
+      end
+
+      def self.details
+        sample = <<-SAMPLE.markdown_sample
+          ```no-highlight
+          {
+            "url"=>"https://api.github.com/repos/KrauseFx/pantograph/releases/1537713",
+             "assets_url"=>"https://api.github.com/repos/KrauseFx/pantograph/releases/1537713/assets",
+             "upload_url"=>"https://uploads.github.com/repos/KrauseFx/pantograph/releases/1537713/assets{?name}",
+             "html_url"=>"https://github.com/pantograph/pantograph/releases/tag/1.8.0",
+             "id"=>1537713,
+             "tag_name"=>"1.8.0",
+             "target_commitish"=>"master",
+             "name"=>"1.8.0 Switch Lanes & Pass Parameters",
+             "draft"=>false,
+             "author"=>
+              {"login"=>"KrauseFx",
+               "id"=>869950,
+               "avatar_url"=>"https://avatars.githubusercontent.com/u/869950?v=3",
+               "gravatar_id"=>"",
+               "url"=>"https://api.github.com/users/KrauseFx",
+               "html_url"=>"https://github.com/pantograph",
+               "followers_url"=>"https://api.github.com/users/KrauseFx/followers",
+               "following_url"=>"https://api.github.com/users/KrauseFx/following{/other_user}",
+               "gists_url"=>"https://api.github.com/users/KrauseFx/gists{/gist_id}",
+               "starred_url"=>"https://api.github.com/users/KrauseFx/starred{/owner}{/repo}",
+               "subscriptions_url"=>"https://api.github.com/users/KrauseFx/subscriptions",
+               "organizations_url"=>"https://api.github.com/users/KrauseFx/orgs",
+               "repos_url"=>"https://api.github.com/users/KrauseFx/repos",
+               "events_url"=>"https://api.github.com/users/KrauseFx/events{/privacy}",
+               "received_events_url"=>"https://api.github.com/users/KrauseFx/received_events",
+               "type"=>"User",
+               "site_admin"=>false},
+             "prerelease"=>false,
+             "created_at"=>"2015-07-14T23:33:01Z",
+             "published_at"=>"2015-07-14T23:44:10Z",
+             "assets"=>[],
+             "tarball_url"=>"https://api.github.com/repos/KrauseFx/pantograph/tarball/1.8.0",
+             "zipball_url"=>"https://api.github.com/repos/KrauseFx/pantograph/zipball/1.8.0",
+             "body"=> ...Markdown...
+            "This is one of the biggest updates of _pantograph_ yet"
+          }
+          ```
+        SAMPLE
+
+        [
+          "This will return all information about a release. For example:".markdown_preserve_newlines,
+          sample
+        ].join("\n")
+      end
+
+      def self.output
+        [
+          ['GET_GITHUB_RELEASE_INFO', 'Contains all the information about this release']
+        ]
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :url,
+                                       env_name: "FL_GET_GITHUB_RELEASE_URL",
+                                       description: "The path to your repo, e.g. 'KrauseFx/pantograph'",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please only pass the path, e.g. 'KrauseFx/pantograph'") if value.include?("github.com")
+                                         UI.user_error!("Please only pass the path, e.g. 'KrauseFx/pantograph'") if value.split('/').count != 2
+                                       end),
+          PantographCore::ConfigItem.new(key: :server_url,
+                                       env_name: "FL_GITHUB_RELEASE_SERVER_URL",
+                                       description: "The server url. e.g. 'https://your.github.server/api/v3' (Default: 'https://api.github.com')",
+                                       default_value: "https://api.github.com",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please include the protocol in the server url, e.g. https://your.github.server") unless value.include?("//")
+                                       end),
+          PantographCore::ConfigItem.new(key: :version,
+                                       env_name: "FL_GET_GITHUB_RELEASE_VERSION",
+                                       description: "The version tag of the release to check"),
+          PantographCore::ConfigItem.new(key: :api_token,
+                                       env_name: "FL_GITHUB_RELEASE_API_TOKEN",
+                                       sensitive: true,
+                                       description: "GitHub Personal Token (required for private repositories)",
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["KrauseFx", "czechboy0", "jaleksynas", "tommeier"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'release = get_github_release(url: "pantograph/pantograph", version: "1.0.0")
+          puts release["name"]'
+        ]
+      end
+
+      def self.sample_return_value
+        {
+          "name" => "name"
+        }
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/git_add.rb

@@ -0,0 +1,93 @@
+module Pantograph
+  module Actions
+    class GitAddAction < Action
+      def self.run(params)
+        should_escape = params[:shell_escape]
+
+        if params[:pathspec]
+          paths = params[:pathspec]
+          success_message = "Successfully added from \"#{paths}\" 💾."
+        elsif params[:path]
+          if params[:path].kind_of?(String)
+            paths = shell_escape(params[:path], should_escape)
+          elsif params[:path].kind_of?(Array)
+            paths = params[:path].map do |p|
+              shell_escape(p, should_escape)
+            end.join(' ')
+          end
+          success_message = "Successfully added \"#{paths}\" 💾."
+        else
+          paths = "."
+          success_message = "Successfully added all files 💾."
+        end
+
+        result = Actions.sh("git add #{paths}", log: PantographCore::Globals.verbose?).chomp
+        UI.success(success_message)
+        return result
+      end
+
+      def self.shell_escape(path, should_escape)
+        path = path.shellescape if should_escape
+        path
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Directly add the given file or all files"
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :path,
+                                       description: "The file(s) and path(s) you want to add",
+                                       is_string: false,
+                                       conflicting_options: [:pathspec],
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :shell_escape,
+                                       description: "Shell escapes paths (set to false if using wildcards or manually escaping spaces in :path)",
+                                       is_string: false,
+                                       default_value: true,
+                                       optional: true),
+          # Deprecated
+          PantographCore::ConfigItem.new(key: :pathspec,
+                                       description: "The pathspec you want to add files from",
+                                       is_string: true,
+                                       conflicting_options: [:path],
+                                       optional: true,
+                                       deprecated: "Use `--path` instead")
+        ]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["4brunu", "antondomashnev"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'git_add',
+          'git_add(path: "./version.txt")',
+          'git_add(path: ["./version.txt", "./changelog.txt"])',
+          'git_add(path: "./Frameworks/*", shell_escape: false)',
+          'git_add(path: ["*.h", "*.m"], shell_escape: false)',
+          'git_add(path: "./Frameworks/*", shell_escape: false)',
+          'git_add(path: "*.txt", shell_escape: false)'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+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
+    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 }
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Returns the name of the current git branch, possibly as managed by CI ENV vars"
+      end
+
+      def self.details
+        "If no branch could be found, this action will return an empty string"
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.output
+        [
+          ['GIT_BRANCH_ENV_VARS', 'The git branch environment variables']
+        ]
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'git_branch'
+        ]
+      end
+
+      def self.return_type
+        :string
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+module Pantograph
+  module Actions
+    class GitCommitAction < Action
+      def self.run(params)
+        if params[:path].kind_of?(String)
+          paths = params[:path].shellescape
+        else
+          paths = params[:path].map(&:shellescape).join(' ')
+        end
+
+        skip_git_hooks = params[:skip_git_hooks] ? '--no-verify' : ''
+
+        if params[:allow_nothing_to_commit]
+          repo_clean = Actions.sh("git status --porcelain").empty?
+          UI.success("Nothing to commit, working tree clean ✅.") if repo_clean
+          return if repo_clean
+        end
+
+        command = "git commit -m #{params[:message].shellescape} #{paths} #{skip_git_hooks}".strip
+        result = Actions.sh(command)
+        UI.success("Successfully committed \"#{params[:path]}\" 💾.")
+        return result
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Directly commit the given file with the given message"
+      end
+
+      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)
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'git_commit(path: "./version.txt", message: "Version Bump")',
+          'git_commit(path: ["./version.txt", "./changelog.txt"], message: "Version Bump")',
+          'git_commit(path: ["./*.txt", "./*.md"], message: "Update documentation")',
+          'git_commit(path: ["./*.txt", "./*.md"], message: "Update documentation", skip_git_hooks: true)'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end