highway 0.0.1 → 1.0.1

data/lib/highway/compiler/suite.rb

@@ -0,0 +1,56 @@
+#
+# suite.rb
+# Copyright © 2019 Netguru S.A. All rights reserved.
+#
+
+require "highway/compiler/analyze/analyzer"
+require "highway/compiler/build/builder"
+require "highway/compiler/parse/parser"
+
+module Highway
+  module Compiler
+
+    # This class is responsible for executing all compiler stages, including
+    # syntactic analysis, semantic analysis and manifest generation.
+    class Suite
+
+      public
+
+      # Initialize an instance.
+      #
+      # @param registry [Highway::Steps::Registry] The registry of steps.
+      # @param interface [Highway::Inteface] The interface.
+      def initialize(registry:, interface:)
+        @registry = registry
+        @interface = interface
+      end
+
+      # Run the compiler suite.
+      #
+      # @param path [String] Path to the configuration file.
+      # @param preset [String] Preset to compile.
+      #
+      # @return [Highway::Compiler::Build::Output::Manifest]
+      def compile(path:, preset:)
+
+        @interface.header_success("Compiling the configuration file...")
+
+        parser = Parse::Parser.new(interface: @interface)
+        parse_tree = parser.parse(path: path)
+
+        analyzer = Analyze::Analyzer.new(registry: @registry, interface: @interface)
+        sema_tree = analyzer.analyze(parse_tree: parse_tree)
+
+        builder = Build::Builder.new(interface: @interface)
+        manifest = builder.build(sema_tree: sema_tree, preset: preset)
+
+        @interface.success("Successfully compiled the configuration file.")
+
+        manifest
+
+      end
+
+    end
+
+  end
+end

data/lib/highway/environment.rb

@@ -0,0 +1,282 @@
+#
+# environment.rb
+# Copyright © 2019 Netguru S.A. All rights reserved.
+#
+
+require "fastlane"
+require "uri/ssh_git"
+
+module Highway
+
+  # This class wraps `ENV` and additionaly provides wrappers and shortcuts
+  # to the most interesting values in the runtime environment.
+  class Environment
+
+    # Get value for given key in the `ENV`.
+    #
+    # @param key [String] A key.
+    #
+    # @return [String, nil]
+    def [](key)
+      ENV[key]
+    end
+
+    # Set value for given key in the `ENV`.
+    #
+    # @param key [String] A key.
+    # @param value [String, nil] A value.
+    #
+    # @return [Void]
+    def []=(key, value)
+      ENV[key] = value
+    end
+
+    # Find value for any of the given keys.
+    #
+    # @param *keys [String] Keys to look for.
+    #
+    # @return [String, nil]
+    def find(*keys)
+      keys.reduce(nil) { |memo, key| memo || self[key] }
+    end
+
+    # Find a non-empty value for any of the given keys.
+    #
+    # @param *keys [String] Keys to look for.
+    #
+    # @return [String, nil]
+    def find_nonempty(*keys)
+      result = find(*keys)
+      result if result != nil && !result.empty?
+    end
+
+    # Check whether any of the given keys exists.
+    #
+    # @param *keys [String] Keys to look for.
+    #
+    # @param [Boolean]
+    def include?(*keys)
+      find(*keys) != nil
+    end
+
+    # Check whether any of the given keys exists and is not empty.
+    #
+    # @param *keys [String] Keys to look for.
+    #
+    # @param [Boolean]
+    def include_nonempty?(*keys)
+      result = find(*keys)
+      result != nil && !result.empty?
+    end
+
+    # Whether environment specifies running in verbose mode.
+    #
+    # @return [Boolean]
+    def verbose?
+      FastlaneCore::Globals::verbose?
+    end
+
+    # Whether environment is running on a supported CI service.
+    #
+    # @return [Boolean]
+    def ci?
+      ci_service != nil
+    end
+
+    # Detected CI service. One of: `:bitrise`, `:circle`, `:travis`.
+    #
+    # @return [Symbol, nil].
+    def ci_service
+      return :bitrise if include?("BITRISE_IO")
+      return :circle if include?("CIRCLECI")
+      return :travis if include?("TRAVIS")
+    end
+
+    # Build number on CI.
+    #
+    # @return [String, nil]
+    def ci_build_number
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_BUILD_NUMBER")
+        when :circle then find_nonempty("CIRCLE_BUILD_NUM")
+        when :travis then find_nonempty("TRAVIS_BUILD_NUMBER")
+      end
+    end
+
+    # Build URL on CI.
+    #
+    # @return [String, nil]
+    def ci_build_url
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_BUILD_URL")
+        when :circle then find_nonempty("CIRCLE_BUILD_URL")
+        when :travis then find_nonempty("TRAVIS_BUILD_WEB_URL")
+      end
+    end
+
+    # Detected trigger type on CI. One of: `:tag`, `:pr`, `:push`.
+    #
+    # @return [Symbol, nil]
+    def ci_trigger
+      if ci_service == :bitrise
+        return :tag if include_nonempty?("BITRISE_GIT_TAG")
+        return :pr if include_nonempty?("BITRISE_PULL_REQUEST")
+        return :push if include_nonempty?("BITRISE_GIT_BRANCH")
+        return :manual
+      elsif ci_service == :circle
+        return :tag if include_nonempty?("CIRCLE_TAG")
+        return :push if include_nonempty?("CIRCLE_BRANCH")
+        return :manual
+      elsif ci_service == :travis
+        return :tag if include_nonempty?("TRAVIS_TAG")
+        return :pr if find_nonempty("TRAVIS_EVENT_TYPE") == "pull_request"
+        return :push if find_nonempty("TRAVIS_EVENT_TYPE") == "push"
+        return :manual
+      end
+    end
+
+    # Git tag that is triggeting CI or value from local repository.
+    #
+    # @return [String, nil]
+    def git_tag
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_GIT_TAG")
+        when :circle then find_nonempty("CIRCLE_TAG")
+        when :travis then find_nonempty("TRAVIS_TAG")
+        else safe_sh("git", "describe --exact-match --tags HEAD")
+      end
+    end
+
+    # Git branch that is triggeting CI or value from local repository.
+    #
+    # @return [String, nil]
+    def git_branch
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_GIT_BRANCH")
+        when :circle then find_nonempty("CIRCLE_BRANCH")
+        when :travis then find_nonempty("TRAVIS_PULL_REQUEST_BRANCH", "TRAVIS_BRANCH")
+        else safe_sh("git", "rev-parse --abbrev-ref HEAD")
+      end
+    end
+
+    # Git commit hash that is triggeting CI or value from local repository.
+    #
+    # @return [String, nil]
+    def git_commit_hash
+      case ci_service
+        when :bitrise then find_nonempty("GIT_CLONE_COMMIT_HASH")
+        when :circle then find_nonempty("CIRCLE_SHA1")
+        when :travis then find_nonempty("TRAVIS_COMMIT")
+        else safe_sh("git", "rev-parse HEAD")
+      end
+    end
+
+    # Git commit hash that is triggeting CI or value from local repository.
+    #
+    # @return [String, nil]
+    def git_commit_message
+      case ci_service
+        when :bitrise then find_nonempty("GIT_CLONE_COMMIT_MESSAGE_SUBJECT").split("\n").first
+        when :travis then find_nonempty("TRAVIS_COMMIT_MESSAGE").split("\n").first
+        else safe_sh("git", "log -1 --pretty=%B").split("\n").first
+      end
+    end
+
+    # Git remote repository URL that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_repo_url
+      case ci_service
+        when :bitrise then normalize_git_url(find_nonempty("GIT_REPOSITORY_URL"))
+        when :circle then normalize_git_url(find_nonempty("CIRCLE_REPOSITORY_URL"))
+        else normalize_git_url(safe_sh("git", "remote get-url origin"))
+      end
+    end
+
+    # Source Git repository URL of the Pull Request that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_pr_source_repo_url
+      case ci_service
+        when :bitrise then normalize_git_url(find_nonempty("BITRISEIO_PULL_REQUEST_REPOSITORY_URL"))
+      end
+    end
+
+    # Source Git branch of the Pull Request that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_pr_source_branch
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_GIT_BRANCH")
+        when :travis then find_nonempty("TRAVIS_PULL_REQUEST_BRANCH")
+      end
+    end
+
+    # Target Git branch of the Pull Request that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_pr_target_branch
+      case ci_service
+        when :bitrise then find_nonempty("BITRISEIO_GIT_BRANCH_DEST")
+        when :travis then find_nonempty("TRAVIS_BRANCH")
+      end
+    end
+
+    # Number of the Pull Request that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_pr_number
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_PULL_REQUEST")
+        when :travis then find_nonempty("TRAVIS_PULL_REQUEST")
+      end
+    end
+
+    # Title of the Pull Request that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_pr_title
+      case ci_service
+        when :bitrise then find_nonempty("BITRISE_GIT_MESSAGE")
+      end
+    end
+
+    # URL of the Pull Request that is triggering CI.
+    #
+    # @return [String, nil]
+    def git_pr_url
+      normalize_git_url(git_repo_url, git_pr_number)
+    end
+
+    private
+
+    def safe_sh(executable, *command)
+      result = `which #{executable} > /dev/null && #{executable} #{command.join(" ")} 2> /dev/null`.strip
+      result if !result.empty?
+    end
+
+    def normalize_git_url(uri_string, pr_number = nil)
+
+      return nil unless uri_string
+
+      uri = URI.parse(uri_string) if uri_string.start_with?("https://")
+      uri = URI::SshGit.parse(uri_string) if uri_string.start_with?("git@")
+
+      return nil unless uri
+
+      host = uri.host
+      repo_path = File.join(File.dirname(uri.path), File.basename(uri.path, ".git"))
+
+      return File.join("https://#{host}", repo_path) unless pr_number
+
+      pr_path = "pull/#{pr_number}" if host == "github.com"
+      pr_path = "merge_requests/#{pr_number}" if host == "gitlab.com"
+      pr_path = "pull-requests/#{pr_number}" if host == "bitbucket.org"
+
+      return File.join("https://#{host}", repo_path, pr_path) if pr_path
+
+    end
+
+  end
+
+end

data/lib/highway/fastlane/action.rb

@@ -0,0 +1,67 @@
+#
+# action.rb
+# Copyright © 2019 Netguru S.A. All rights reserved.
+#
+
+require "fastlane"
+require "highway"
+
+module Fastlane
+  module Actions
+
+    # The `run_highway` action that can be used inside Fastline.
+    class RunHighwayAction < Action
+
+      # Available options of `run_highway` action.
+      #
+      # Use the same behavior of computing option values as in lane entry point.
+      # First, get the actual values, then fall back to env variables, then fall
+      # back to default values.
+      #
+      # @return [Array<FastlaneCore::ConfigItem>]
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :highwayfile,
+            description: "Path to Highway configuration file",
+            type: String,
+            optional: false,
+            env_name: "HIGHWAY_HIGHWAYFILE",
+            default_value: "Highwayfile.yml",
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :preset,
+            description: "Highway preset to run",
+            type: String,
+            optional: false,
+            env_name: "HIGHWAY_PRESET",
+            default_value: "default",
+          ),
+        ]
+      end
+
+      # Execute the `run_highway` action.
+      #
+      # This is the main entry point of Highway.
+      #
+      # @param options [Hash<String, Object>]
+      def self.run(options)
+
+        # Run Highway from `:action` entry point.
+
+        main = Highway::Main.new(
+          entrypoint: :action,
+          path: options[:highwayfile],
+          preset: options[:preset],
+          fastlane_runner: runner,
+          fastlane_lane_context: lane_context,
+        )
+
+        main.run()
+
+      end
+
+    end
+
+  end
+end

data/lib/highway/interface.rb

@@ -0,0 +1,135 @@
+#
+# interface.rb
+# Copyright © 2019 Netguru S.A. All rights reserved.
+#
+
+require "fastlane"
+require "terminal-table"
+
+module Highway
+
+  # This class is responsible for interfacing with the user (e.g. displaying
+  # error messages), using Fastlane UI mechanism underneath.
+  class Interface
+
+    public
+
+    # Initialize an instance.
+    def initialize()
+      @history = []
+    end
+
+    # Display a raw unformatted message.
+    #
+    # @param message [String] The raw message.
+    #
+    # @return [Void]
+    def raw(message)
+      puts(message.to_s)
+      @history << message.to_s
+    end
+
+    # Display a whitespace, unless it's already displayed.
+    #
+    # @return [Void]
+    def whitespace()
+      unless (@history.last || "").end_with?("\n")
+        raw("\n")
+      end
+    end
+
+    # Display a success message.
+    #
+    # @param message [String] The success message.
+    #
+    # @return [Void]
+    def success(message)
+      message.to_s.strip.split("\n").each { |line| FastlaneCore::UI.success(line) }
+      @history << message.to_s.strip
+    end
+
+    # Display an error message and abort.
+    #
+    # @param message [String] The error message.
+    #
+    # @return [Void]
+    def fatal!(message)
+      FastlaneCore::UI.user_error!(message.to_s)
+    end
+
+    # Display an error message.
+    #
+    # @param message [String] The error message.
+    #
+    # @return [Void]
+    def error(message)
+      message.to_s.strip.split("\n").each { |line| FastlaneCore::UI.error(line) }
+      @history << message.to_s.strip
+    end
+
+    # Display a warning message.
+    #
+    # @param message [String] The warning message.
+    #
+    # @return [Void]
+    def warning(message)
+      message.to_s.strip.split("\n").each { |line| FastlaneCore::UI.important(line) }
+      @history << message.to_s.strip
+    end
+
+    # Display a note message.
+    #
+    # @param message [String] The note message.
+    #
+    # @return [Void]
+    def note(message)
+      message.to_s.strip.split("\n").each { |line| FastlaneCore::UI.message(line) }
+      @history << message.to_s.strip
+    end
+
+    # Display a success header message.
+    #
+    # @param message [String] The header message.
+    #
+    # @return [Void]
+    def header_success(message)
+      whitespace()
+      success("--- #{message}".bold)
+    end
+
+    # Display a warning header message.
+    #
+    # @param message [String] The header message.
+    #
+    # @return [Void]
+    def header_warning(message)
+      whitespace()
+      warning("--- #{message}".bold)
+    end
+
+    # Display a table padded with whitespace.
+    #
+    # @param title [String] Table title.
+    # @param headings [Array<String>] Heading titles.
+    # @param rows [Array<String>] Row values.
+    #
+    # @return [Void]
+    def table(title: nil, headings: [], rows:)
+
+      whitespace()
+
+      table = Terminal::Table.new(
+        title: title,
+        headings: headings,
+        rows: FastlaneCore::PrintTable.transform_output(rows)
+      )
+
+      raw(table)
+
+      whitespace()
+
+    end
+
+  end
+
+end