pantograph 0.1.0

data/pantograph/lib/pantograph/actions/bundle_install.rb

@@ -0,0 +1,156 @@
+module Pantograph
+  module Actions
+    class BundleInstallAction < Action
+      # rubocop:disable Metrics/PerceivedComplexity
+      def self.run(params)
+        if gemfile_exists?(params)
+          cmd = ['bundle install']
+
+          cmd << "--binstubs #{params[:binstubs]}" if params[:binstubs]
+          cmd << "--clean" if params[:clean]
+          cmd << "--full-index" if params[:full_index]
+          cmd << "--gemfile #{params[:gemfile]}" if params[:gemfile]
+          cmd << "--jobs #{params[:jobs]}" if params[:jobs]
+          cmd << "--local" if params[:local]
+          cmd << "--deployment" if params[:deployment]
+          cmd << "--no-cache" if params[:no_cache]
+          cmd << "--no_prune" if params[:no_prune]
+          cmd << "--path #{params[:path]}" if params[:path]
+          cmd << "--system" if params[:system]
+          cmd << "--quiet" if params[:quiet]
+          cmd << "--retry #{params[:retry]}" if params[:retry]
+          cmd << "--shebang" if params[:shebang]
+          cmd << "--standalone #{params[:standalone]}" if params[:standalone]
+          cmd << "--trust-policy" if params[:trust_policy]
+          cmd << "--without #{params[:without]}" if params[:without]
+          cmd << "--with #{params[:with]}" if params[:with]
+
+          return sh(cmd.join(' '))
+        else
+          UI.message("No Gemfile found")
+        end
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def self.gemfile_exists?(params)
+        possible_gemfiles = ['Gemfile', 'gemfile']
+        possible_gemfiles.insert(0, params[:gemfile]) if params[:gemfile]
+        possible_gemfiles.each do |gemfile|
+          gemfile = File.absolute_path(gemfile)
+          return true if File.exist?(gemfile)
+          UI.message("Gemfile not found at: '#{gemfile}'")
+        end
+        return false
+      end
+
+      def self.description
+        'This action runs `bundle install` (if available)'
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.author
+        ["birmacher", "koglinjg"]
+      end
+
+      def self.example_code
+        nil
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :binstubs,
+                                       env_name: "FL_BUNDLE_INSTALL_BINSTUBS",
+                                       description: "Generate bin stubs for bundled gems to ./bin",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :clean,
+                                       env_name: "FL_BUNDLE_INSTALL_CLEAN",
+                                       description: "Run bundle clean automatically after install",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :full_index,
+                                       env_name: "FL_BUNDLE_INSTALL_FULL_INDEX",
+                                       description: "Use the rubygems modern index instead of the API endpoint",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :gemfile,
+                                       env_name: "FL_BUNDLE_INSTALL_GEMFILE",
+                                       description: "Use the specified gemfile instead of Gemfile",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :jobs,
+                                       env_name: "FL_BUNDLE_INSTALL_JOBS",
+                                       description: "Install gems using parallel workers",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :local,
+                                       env_name: "FL_BUNDLE_INSTALL_LOCAL",
+                                       description: "Do not attempt to fetch gems remotely and use the gem cache instead",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :deployment,
+                                       env_name: "FL_BUNDLE_INSTALL_DEPLOYMENT",
+                                       description: "Install using defaults tuned for deployment and CI environments",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :no_cache,
+                                       env_name: "FL_BUNDLE_INSTALL_NO_CACHE",
+                                       description: "Don't update the existing gem cache",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :no_prune,
+                                       env_name: "FL_BUNDLE_INSTALL_NO_PRUNE",
+                                       description: "Don't remove stale gems from the cache",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :path,
+                                       env_name: "FL_BUNDLE_INSTALL_PATH",
+                                       description: "Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME). Bundler will remember this value for future installs on this machine",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :system,
+                                       env_name: "FL_BUNDLE_INSTALL_SYSTEM",
+                                       description: "Install to the system location ($BUNDLE_PATH or $GEM_HOME) even if the bundle was previously installed somewhere else for this application",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :quiet,
+                                       env_name: "FL_BUNDLE_INSTALL_QUIET",
+                                       description: "Only output warnings and errors",
+                                       is_string: false,
+                                       default_value: false),
+          PantographCore::ConfigItem.new(key: :retry,
+                                       env_name: "FL_BUNDLE_INSTALL_RETRY",
+                                       description: "Retry network and git requests that have failed",
+                                       is_string: false,
+                                       type: Boolean,
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :shebang,
+                                       env_name: "FL_BUNDLE_INSTALL_SHEBANG",
+                                       description: "Specify a different shebang executable name than the default (usually 'ruby')",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :standalone,
+                                       env_name: "FL_BUNDLE_INSTALL_STANDALONE",
+                                       description: "Make a bundle that can work without the Bundler runtime",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :trust_policy,
+                                       env_name: "FL_BUNDLE_INSTALL_TRUST_POLICY",
+                                       description: "Sets level of security when dealing with signed gems. Accepts `LowSecurity`, `MediumSecurity` and `HighSecurity` as values",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :without,
+                                       env_name: "FL_BUNDLE_INSTALL_WITHOUT",
+                                       description: "Exclude gems that are part of the specified named group",
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :with,
+                                       env_name: "FL_BUNDLE_INSTALL_WITH",
+                                       description: "Include gems that are part of the specified named group",
+                                       optional: true)
+        ]
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/changelog_from_git_commits.rb

@@ -0,0 +1,197 @@
+module Pantograph
+  module Actions
+    module SharedValues
+      FL_CHANGELOG ||= :FL_CHANGELOG
+    end
+
+    class ChangelogFromGitCommitsAction < Action
+      def self.run(params)
+        if params[:commits_count]
+          UI.success("Collecting the last #{params[:commits_count]} Git commits")
+        else
+          if params[:between]
+            if params[:between].kind_of?(String) && params[:between].include?(",") # :between is string
+              from, to = params[:between].split(",", 2)
+            elsif params[:between].kind_of?(Array)
+              from, to = params[:between]
+            end
+          else
+            from = Actions.last_git_tag_name(params[:match_lightweight_tag], params[:tag_match_pattern])
+            UI.verbose("Found the last Git tag: #{from}")
+            to = 'HEAD'
+          end
+          UI.success("Collecting Git commits between #{from} and #{to}")
+        end
+
+        # Normally it is not good practice to take arbitrary input and convert it to a symbol
+        # because prior to Ruby 2.2, symbols are never garbage collected. However, we've
+        # already validated that the input matches one of our allowed values, so this is OK
+        merge_commit_filtering = params[:merge_commit_filtering].to_sym
+
+        # We want to be specific and exclude nil for this comparison
+        if params[:include_merges] == false
+          merge_commit_filtering = :exclude_merges
+        end
+
+        params[:path] = './' unless params[:path]
+
+        Dir.chdir(params[:path]) do
+          if params[:commits_count]
+            changelog = Actions.git_log_last_commits(params[:pretty], params[:commits_count], merge_commit_filtering, params[:date_format], params[:ancestry_path])
+          else
+            changelog = Actions.git_log_between(params[:pretty], from, to, merge_commit_filtering, params[:date_format], params[:ancestry_path])
+          end
+
+          changelog = changelog.gsub("\n\n", "\n") if changelog # as there are duplicate newlines
+          Actions.lane_context[SharedValues::FL_CHANGELOG] = changelog
+
+          if params[:quiet] == false
+            puts("")
+            puts(changelog)
+            puts("")
+          end
+
+          changelog
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Collect git commit messages into a changelog"
+      end
+
+      def self.details
+        "By default, messages will be collected back to the last tag, but the range can be controlled"
+      end
+
+      def self.output
+        [
+          ['FL_CHANGELOG', 'The changelog string generated from the collected git commit messages']
+        ]
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :between,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_BETWEEN',
+                                       description: 'Array containing two Git revision values between which to collect messages, you mustn\'t use it with :commits_count key at the same time',
+                                       optional: true,
+                                       is_string: false,
+                                       conflicting_options: [:commits_count],
+                                       verify_block: proc do |value|
+                                         if value.kind_of?(String)
+                                           UI.user_error!(":between must contain comma") unless value.include?(',')
+                                         else
+                                           UI.user_error!(":between must be of type array") unless value.kind_of?(Array)
+                                           UI.user_error!(":between must not contain nil values") if value.any?(&:nil?)
+                                           UI.user_error!(":between must be an array of size 2") unless (value || []).size == 2
+                                         end
+                                       end),
+          PantographCore::ConfigItem.new(key: :commits_count,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_COUNT',
+                                       description: 'Number of commits to include in changelog, you mustn\'t use it with :between key at the same time',
+                                       optional: true,
+                                       is_string: false,
+                                       conflicting_options: [:between],
+                                       type: Integer,
+                                       verify_block: proc do |value|
+                                         UI.user_error!(":commits_count must be >= 1") unless value.to_i >= 1
+                                       end),
+          PantographCore::ConfigItem.new(key: :path,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_PATH',
+                                       description: 'Path of the git repository',
+                                       optional: true,
+                                       default_value: './'),
+          PantographCore::ConfigItem.new(key: :pretty,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_PRETTY',
+                                       description: 'The format applied to each commit while generating the collected value',
+                                       optional: true,
+                                       default_value: '%B',
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :date_format,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_DATE_FORMAT',
+                                       description: 'The date format applied to each commit while generating the collected value',
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :ancestry_path,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_ANCESTRY_PATH',
+                                       description: 'Whether or not to use ancestry-path param',
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          PantographCore::ConfigItem.new(key: :tag_match_pattern,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_TAG_MATCH_PATTERN',
+                                       description: 'A glob(7) pattern to match against when finding the last git tag',
+                                       optional: true),
+          PantographCore::ConfigItem.new(key: :match_lightweight_tag,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_MATCH_LIGHTWEIGHT_TAG',
+                                       description: 'Whether or not to match a lightweight tag when searching for the last one',
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
+          PantographCore::ConfigItem.new(key: :quiet,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_TAG_QUIET',
+                                       description: 'Whether or not to disable changelog output',
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          PantographCore::ConfigItem.new(key: :include_merges,
+                                       deprecated: "Use `:merge_commit_filtering` instead",
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_INCLUDE_MERGES',
+                                       description: "Whether or not to include any commits that are merges",
+                                       optional: true,
+                                       is_string: false,
+                                       type: Boolean,
+                                       verify_block: proc do |value|
+                                         UI.important("The :include_merges option is deprecated. Please use :merge_commit_filtering instead") unless value.nil?
+                                       end),
+          PantographCore::ConfigItem.new(key: :merge_commit_filtering,
+                                       env_name: 'FL_CHANGELOG_FROM_GIT_COMMITS_MERGE_COMMIT_FILTERING',
+                                       description: "Controls inclusion of merge commits when collecting the changelog. Valid values: #{GIT_MERGE_COMMIT_FILTERING_OPTIONS.map { |o| "`:#{o}`" }.join(', ')}",
+                                       optional: true,
+                                       default_value: 'include_merges',
+                                       verify_block: proc do |value|
+                                         matches_option = GIT_MERGE_COMMIT_FILTERING_OPTIONS.any? { |opt| opt.to_s == value }
+                                         UI.user_error!("Valid values for :merge_commit_filtering are #{GIT_MERGE_COMMIT_FILTERING_OPTIONS.map { |o| "'#{o}'" }.join(', ')}") unless matches_option
+                                       end)
+        ]
+      end
+
+      def self.return_value
+        "Returns a String containing your formatted git commits"
+      end
+
+      def self.return_type
+        :string
+      end
+
+      def self.author
+        ['mfurtak', 'asfalcone', 'SiarheiFedartsou', 'allewun']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'changelog_from_git_commits',
+          'changelog_from_git_commits(
+            between: ["7b092b3", "HEAD"],            # Optional, lets you specify a revision/tag range between which to collect commit info
+            pretty: "- (%ae) %s",                    # Optional, lets you provide a custom format to apply to each commit when generating the changelog text
+            date_format: "short",                    # Optional, lets you provide an additional date format to dates within the pretty-formatted string
+            match_lightweight_tag: false,            # Optional, lets you ignore lightweight (non-annotated) tags when searching for the last tag
+            merge_commit_filtering: "exclude_merges" # Optional, lets you filter out merge commits
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/clipboard.rb

@@ -0,0 +1,52 @@
+module Pantograph
+  module Actions
+    class ClipboardAction < Action
+      def self.run(params)
+        value = params[:value]
+
+        truncated_value = value[0..800].gsub(/\s\w+\s*$/, '...')
+        UI.message("Storing '#{truncated_value}' in the clipboard 🎨")
+
+        if PantographCore::Helper.mac?
+          require 'open3'
+          Open3.popen3('pbcopy') { |input, _, _| input << value }
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Copies a given string into the clipboard. Works only on macOS"
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :value,
+                                       env_name: "FL_CLIPBOARD_VALUE",
+                                       description: "The string that should be copied into the clipboard")
+        ]
+      end
+
+      def self.authors
+        ["KrauseFx", "joshdholtz"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'clipboard(value: "https://docs.pantograph.tools/")',
+          'clipboard(value: lane_context[SharedValues::HOCKEY_DOWNLOAD_LINK] || "")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/cloc.rb

@@ -0,0 +1,89 @@
+module Pantograph
+  module Actions
+    class ClocAction < Action
+      def self.run(params)
+        cloc_binary = params[:binary_path]
+        exclude_dirs = params[:exclude_dir].nil? ? '' : "--exclude-dir=#{params[:exclude_dir]}"
+        xml_format = params[:xml]
+        out_dir = params[:output_directory]
+        output_file = xml_format ? "#{out_dir}/cloc.xml" : "#{out_dir}/cloc.txt"
+        source_directory = params[:source_directory]
+
+        command = [
+          cloc_binary,
+          exclude_dirs,
+          '--by-file',
+          xml_format ? '--xml ' : '',
+          "--out=#{output_file}",
+          source_directory
+        ].join(' ').strip
+
+        Actions.sh(command)
+      end
+
+      def self.description
+        "Generates a Code Count that can be read by Jenkins (xml format)"
+      end
+
+      def self.details
+        [
+          "This action will run cloc to generate a SLOC report that the Jenkins SLOCCount plugin can read.",
+          "See [https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin](https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin) and [https://github.com/AlDanial/cloc](https://github.com/AlDanial/cloc) for more information."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(key: :binary_path,
+                                       env_name: "FL_CLOC_BINARY_PATH",
+                                       description: "Where the cloc binary lives on your system (full path including 'cloc')",
+                                       optional: true,
+                                       is_string: true,
+                                       default_value: '/usr/local/bin/cloc'),
+          PantographCore::ConfigItem.new(key: :exclude_dir,
+                                       env_name: "FL_CLOC_EXCLUDE_DIR",
+                                       description: "Comma separated list of directories to exclude", # a short description of this parameter
+                                       optional: true,
+                                       is_string: true),
+          PantographCore::ConfigItem.new(key: :output_directory,
+                                       env_name: "FL_CLOC_OUTPUT_DIRECTORY",
+                                       description: "Where to put the generated report file",
+                                       is_string: true,
+                                       default_value: "build"),
+          PantographCore::ConfigItem.new(key: :source_directory,
+                                      env_name: "FL_CLOC_SOURCE_DIRECTORY",
+                                      description: "Where to look for the source code (relative to the project root folder)",
+                                      is_string: true,
+                                      default_value: ""),
+          PantographCore::ConfigItem.new(key: :xml,
+                                      env_name: "FL_CLOC_XML",
+                                      description: "Should we generate an XML File (if false, it will generate a plain text file)?",
+                                      is_string: false,
+                                      default_value: true)
+        ]
+      end
+
+      def self.authors
+        ["intere"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'cloc(
+             exclude_dir: "ThirdParty,Resources",
+             output_directory: "reports",
+             source_directory: "MyCoolApp"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end