git-commander 0.1.0

data/lib/git_commander/rspec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'rspec/plugin_helpers'

data/lib/git_commander/rspec/plugin_helpers.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "rspec/mocks/matchers/receive"
+require "rspec/mocks/any_instance"
+require "rspec/support/differ"
+
+module GitCommander
+  module RSpec
+    # Contains helper methods and matchers for testing git-commander plugins
+    module PluginHelpers
+      # nodoc
+      class MockGemfile
+        DEFAULT_GEM_SOURCE = "https://rubygems.org"
+
+        attr_reader :gems, :options
+
+        def initialize
+          @gems = {}
+          @source = DEFAULT_GEM_SOURCE
+        end
+
+        def gem(name, *options)
+          @gems[name] = options || []
+        end
+
+        def source(value = nil)
+          return "source: '#{@source}'" if value.nil?
+
+          @source = value
+        end
+
+        def gemfile_lines
+          [
+            source,
+            *@gems.map { |name, options| gem_definition(name, *options) }
+          ]
+        end
+
+        def gem_definition(name, *options)
+          ["gem '#{name}'", *Array(options).map { |o| gem_option_to_s(o) }].join(", ")
+        end
+
+        def gem_option_to_s(option)
+          return "" if option.to_s.empty?
+
+          case option
+          when Hash
+            option.map { |k, v| "#{k}: '#{v}'" }
+          else
+            "'#{option}'"
+          end
+        end
+      end
+
+      def stub_inline_gemfile
+        mock_gemfile = MockGemfile.new
+        allow_any_instance_of(GitCommander::Plugin::Loader).to receive(:gemfile) do |*args, &block|
+          mock_gemfile.instance_eval(&block)
+        end
+        mock_gemfile
+      end
+
+      ::RSpec::Matchers.define :have_defined_gems do |gemfile_lines|
+        gemfile_lines.map! { |l| l.gsub(/"/, "'") }
+        gemfile_lines.prepend(MockGemfile.new.source) if gemfile_lines.none? { |line| line.start_with?("source:") }
+
+        match do |block|
+          mock_gemfile = stub_inline_gemfile unless GitCommander::Plugin::Loader.new(nil).is_a?(MockGemfile)
+
+          block.call
+
+          @actual = mock_gemfile.gemfile_lines
+
+          values_match? gemfile_lines, @actual
+        end
+
+        diffable
+        supports_block_expectations
+      end
+    end
+  end
+end

data/lib/git_commander/system.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "open3"
+
+module GitCommander
+  # @abstract A wrapper for system calls
+  class System
+    DEFAULT_RUN_OPTIONS = {
+      silent: false
+    }.freeze
+
+    # @abstract Wraps a system command with logging, stderr, and stdout capture
+    class Command
+      attr_accessor :output, :error, :status
+      attr_reader :name, :options, :command_with_arguments
+      def initialize(command_with_arguments, options = {})
+        @command_with_arguments = command_with_arguments
+        @name = command_with_arguments.split(/\w/i).first
+        @options = DEFAULT_RUN_OPTIONS.merge(options)
+      end
+
+      def run
+        log_command_initiated
+        @output, @error, @status = Open3.capture3(command_with_arguments)
+        log_command_completed
+      end
+
+      private
+
+      def log_command_initiated
+        GitCommander.logger.debug <<~COMMAND_LOG
+          [system] Running '#{command_with_arguments}' with options #{options.inspect} ...
+        COMMAND_LOG
+      end
+
+      def log_command_completed
+        GitCommander.logger.debug <<~COMMAND_LOG
+          [system] Ran '#{command_with_arguments}' with options #{options.inspect}.
+          \tStatus: #{status}
+          \tOutput: #{output.inspect}
+          \tError: #{error.inspect}
+        COMMAND_LOG
+      end
+    end
+
+    class RunError < StandardError; end
+
+    include Singleton
+
+    # Runs a system command
+    # @param [String] command_with_arguments the command string (with args, flags and switches) to run
+    # @param [Hash] options the options to run the command with
+    # @option options [Boolean] :silent Supress the output of the command
+    # @option options [Boolean] :blocking Supress errors running the command
+    def self.run(command_with_arguments, options = {})
+      command = Command.new(command_with_arguments, options)
+
+      command.run
+
+      unless command.status.success? || command.options[:blocking] == false
+        raise RunError, "\"#{command.error}\" \"#{command.name}\" failed to run."
+      end
+
+      puts command.output if command.options[:silent] == false
+      command.output.strip
+    end
+
+    # Appends to the output stream
+    # @param [String] new_output the string to add to the output stream
+    def self.say(new_output)
+      GitCommander.logger.info "[System#say] #{new_output}"
+      puts new_output
+    end
+  end
+end

data/lib/git_commander/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GitCommander
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: git-commander
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valentino Stoll
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+description: Build custom flexible git workflows with Ruby!
+email:
+- v@codenamev.com
+executables:
+- git-cmd
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/git-cmd
+- git-commander.gemspec
+- lib/git_commander.rb
+- lib/git_commander/cli.rb
+- lib/git_commander/command.rb
+- lib/git_commander/command/configurator.rb
+- lib/git_commander/command/loaders/file_loader.rb
+- lib/git_commander/command/loaders/raw.rb
+- lib/git_commander/command/option.rb
+- lib/git_commander/command/runner.rb
+- lib/git_commander/command_loader_options.rb
+- lib/git_commander/loader.rb
+- lib/git_commander/loader_result.rb
+- lib/git_commander/logger.rb
+- lib/git_commander/plugin.rb
+- lib/git_commander/plugin/executor.rb
+- lib/git_commander/plugin/loader.rb
+- lib/git_commander/plugins/git.rb
+- lib/git_commander/plugins/github.rb
+- lib/git_commander/plugins/prompt.rb
+- lib/git_commander/plugins/system.rb
+- lib/git_commander/registry.rb
+- lib/git_commander/rspec.rb
+- lib/git_commander/rspec/plugin_helpers.rb
+- lib/git_commander/system.rb
+- lib/git_commander/version.rb
+homepage: https://github.com/codenamev/git-commander
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Make your own git commands
+test_files: []