geet 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6851bac2fb23c71d05f45df5bb3fd5031f7edd3
-  data.tar.gz: 82d8882974a9ce36099507adbd88f1030da1331a
+  metadata.gz: b893cf44b85d8bfeedc77128b96c5bc921abb701
+  data.tar.gz: e50482a1691bedde73ef4c1c195693a57c60d9ce
 SHA512:
-  metadata.gz: 66454a2b83427c2cbce5a693a5271f78d4b70f38ab2762f949d53c6ba65151961cc31fde338454a171243732bb23ec35498967299eb883b7f039174798a9fcde
-  data.tar.gz: bb4ac9a4a07dd9a5f72923564b45db22a047576e41c63c05a15442ca5983f20de332c7be1f0edbd183b8780662f11976b9a736813bb2f036202b4018de83c58b
+  metadata.gz: 2733412c618b5d39cdeeb3b900364c69fcc551fa9238c30e743d6deb1b6a9083fc3cbf279df09027692a685f9f47fddb2d8eecb6beda7f79f03617f3dce31814
+  data.tar.gz: 4cb03d50785c4645e0d206337340d84bd53f8569c667c20787a2507a4579264fc4d13be4c2bffa5109c1a46ac2c79d8011917c50d7e580f0de72e7d207a36611

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -5,3 +5,13 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'simple_scripting', '~> 0.9.3'
+
+group :development, :test do
+  gem 'byebug', '~> 9.1.0'
+end
+
+group :test do
+  gem 'vcr', '~> 3.0.3'
+  gem 'webmock', '~> 3.1.1'
+  gem 'rspec', '~> 3.7.0'
+end

data/Gemfile.lock

@@ -1,15 +1,46 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (9.1.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
     parseconfig (1.0.8)
+    public_suffix (3.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    safe_yaml (1.0.4)
     simple_scripting (0.9.3)
       parseconfig (~> 1.0)
+    vcr (3.0.3)
+    webmock (3.1.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug (~> 9.1.0)
+  rspec (~> 3.7.0)
   simple_scripting (~> 0.9.3)
+  vcr (~> 3.0.3)
+  webmock (~> 3.1.1)
 
 BUNDLED WITH
    1.16.0.pre.3

data/README.md

@@ -85,5 +85,3 @@ Examples:
 Geet is in alpha status. Although I use it daily, lots of features are being implemented, and internal/external APIs are frequently changed.
 
 The public release will be 1.0, and is expected to be released in January 2018 or earlier.
-
-The test suite is planned for v0.3.0. In case the project should have any user/developer besides me before that version, I will put any feature on hold, and build the full test suite.

data/bin/geet

@@ -1,45 +1,56 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/geet/helpers/configuration_helper.rb'
+require_relative '../lib/geet/commandline/configuration.rb'
+require_relative '../lib/geet/commandline/commands.rb'
 require_relative '../lib/geet/git/repository.rb'
+Dir[File.join(__dir__, '../lib/geet/services/*.rb')].each { |filename| require filename }
+
+class GeetLauncher
+  include Geet
+  include Geet::Commandline::Commands
+
+  def launch
+    commandline_configuration = Commandline::Configuration.new
+
+    command, options = commandline_configuration.decode_argv || exit
+    api_token = commandline_configuration.api_token
+
+    # `:upstream` is always false in the gist command case.
+    repository = Git::Repository.new(api_token, upstream: !!options[:upstream])
+
+    case command
+    when GIST_CREATE_COMMAND
+      filename = options.delete(:filename)
+      options[:publik] = options.delete(:public) if options.key?(:public)
+
+      Services::CreateGist.new.execute(repository, filename, options)
+    when ISSUE_CREATE_COMMAND
+      title, description = options.values_at(:title, :description)
+      options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
+
+      Services::CreateIssue.new.execute(repository, title, description, options)
+    when ISSUE_LIST_COMMAND
+      Services::ListIssues.new.execute(repository)
+    when LABEL_LIST_COMMAND
+      Services::ListLabels.new.execute(repository)
+    when MILESTONE_LIST_COMMAND
+      Services::ListMilestones.new.execute(repository)
+    when PR_CREATE_COMMAND
+      title, description = options.values_at(:title, :description)
+      options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
+
+      Services::CreatePr.new.execute(repository, title, description, options)
+    when PR_LIST_COMMAND
+      Services::ListPrs.new.execute(repository)
+    when PR_MERGE_COMMAND
+      Services::MergePr.new.execute(repository)
+    else
+      raise "Internal error - Unrecognized command #{command.inspect}"
+    end
+  end
+end
 
-include Geet
-
-configuration_helper = Helpers::ConfigurationHelper.new
-
-command, options = configuration_helper.decode_argv || exit
-api_token = configuration_helper.api_token
-
-# `:upstream` is always false in the gist command case.
-repository = Git::Repository.new(api_token, upstream: !!options[:upstream])
-
-case command
-when Helpers::ConfigurationHelper::GIST_CREATE_COMMAND
-  filename = options.delete(:filename)
-  options[:publik] = options.delete(:public) if options.key?(:public)
-
-  Services::CreateGist.new.execute(repository, filename, options)
-when Helpers::ConfigurationHelper::ISSUE_CREATE_COMMAND
-  title, description = options.values_at(:title, :description)
-  options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
-
-  Services::CreateIssue.new.execute(repository, title, description, options)
-when Helpers::ConfigurationHelper::ISSUE_LIST_COMMAND
-  Services::ListIssues.new.execute(repository)
-when Helpers::ConfigurationHelper::LABEL_LIST_COMMAND
-  Services::ListLabels.new.execute(repository)
-when Helpers::ConfigurationHelper::MILESTONE_LIST_COMMAND
-  Services::ListMilestones.new.execute(repository)
-when Helpers::ConfigurationHelper::PR_CREATE_COMMAND
-  title, description = options.values_at(:title, :description)
-  options[:milestone_pattern] = options.delete(:milestone) if options.key?(:milestone)
-
-  Services::CreatePr.new.execute(repository, title, description, options)
-when Helpers::ConfigurationHelper::PR_LIST_COMMAND
-  Services::ListPrs.new.execute(repository)
-when Helpers::ConfigurationHelper::PR_MERGE_COMMAND
-  Services::MergePr.new.execute(repository)
-else
-  raise "Internal error - Unrecognized command #{command.inspect}"
+if __FILE__ == $0
+  GeetLauncher.new.launch
 end

data/geet.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.2.0'
   s.authors     = ['Saverio Miroddi']
-  s.date        = '2017-11-08'
+  s.date        = '2017-11-21'
   s.email       = ['saverio.pub2@gmail.com']
   s.homepage    = 'https://github.com/saveriomiroddi/geet'
   s.summary     = 'Commandline interface for performing SCM (eg. GitHub) operations (eg. PR creation).'

data/lib/geet/commandline/commands.rb

@@ -0,0 +1,14 @@
+module Geet
+  module Commandline
+    module Commands
+      GIST_CREATE_COMMAND = 'gist.create'
+      ISSUE_CREATE_COMMAND = 'issue.create'
+      ISSUE_LIST_COMMAND = 'issue.list'
+      LABEL_LIST_COMMAND = 'label.list'
+      MILESTONE_LIST_COMMAND = 'milestone.list'
+      PR_CREATE_COMMAND = 'pr.create'
+      PR_LIST_COMMAND = 'pr.list'
+      PR_MERGE_COMMAND = 'pr.merge'
+    end
+  end
+end

data/lib/geet/{helpers/configuration_helper.rb → commandline/configuration.rb}

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
 
 require 'simple_scripting/argv'
+require_relative 'commands'
 
 module Geet
-  module Helpers
-    class ConfigurationHelper
-      # Commands
-
-      GIST_CREATE_COMMAND = 'gist.create'
-      ISSUE_CREATE_COMMAND = 'issue.create'
-      ISSUE_LIST_COMMAND = 'issue.list'
-      LABEL_LIST_COMMAND = 'label.list'
-      MILESTONE_LIST_COMMAND = 'milestone.list'
-      PR_CREATE_COMMAND = 'pr.create'
-      PR_LIST_COMMAND = 'pr.list'
-      PR_MERGE_COMMAND = 'pr.merge'
+  module Commandline
+    class Configuration
+      include Commands
 
       # Command options
 

data/lib/geet/git/repository.rb

@@ -1,32 +1,12 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
-Dir[File.join(__dir__, '../**/remote_repository.rb')].each { |repository_file| require repository_file }
-Dir[File.join(__dir__, '../**/account.rb')].each { |account_file| require account_file }
-Dir[File.join(__dir__, '../**/api_helper.rb')].each { |helper_file| require helper_file }
-Dir[File.join(__dir__, '../services/*.rb')].each { |helper_file| require helper_file }
+require 'shellwords'
 
 module Geet
   module Git
     # This class represents, for convenience, both the local and the remote repository, but the
     # remote code is separated in each provider module.
     class Repository
-      extend Forwardable
-
-      def_delegators :@remote_repository, :abstract_issues
-      def_delegators :@remote_repository, :collaborators, :labels
-      def_delegators :@remote_repository, :create_gist
-      def_delegators :@remote_repository, :create_issue, :issues
-      def_delegators :@remote_repository, :labels
-      def_delegators :@remote_repository, :milestones
-      def_delegators :@remote_repository, :create_pr, :prs
-      def_delegators :@account, :authenticated_user
-
-      DOMAIN_PROVIDERS_MAPPING = {
-        'github.com' => Geet::GitHub
-      }.freeze
-
       # For simplicity, we match any character except the ones the separators.
       REMOTE_ORIGIN_REGEX = %r{
         \A
@@ -39,54 +19,80 @@ module Geet
       ORIGIN_NAME   = 'origin'
       UPSTREAM_NAME = 'upstream'
 
-      def initialize(api_token, upstream: false)
-        the_provider_domain = provider_domain
-        provider_module = DOMAIN_PROVIDERS_MAPPING[the_provider_domain] || raise("Provider not supported for domain: #{provider_domain}")
+      def initialize(api_token, upstream: false, location: nil)
+        @api_token = api_token
+        @upstream = upstream
+        @location = location
+      end
 
-        api_helper = provider_module::ApiHelper.new(api_token, user, path(upstream: upstream), upstream)
+      # REMOTE FUNCTIONALITIES (REPOSITORY)
 
-        @remote_repository = provider_module::RemoteRepository.new(self, api_helper)
-        @account = provider_module::Account.new(api_helper)
+      def collaborators
+        provider_module::Collaborator.list(api_interface)
       end
 
-      # METADATA
+      def labels
+        provider_module::Label.list(api_interface)
+      end
 
-      def user
-        `git config --get user.email`.strip
+      def create_gist(filename, content, description: nil, publik: false)
+        provider_module::Gist.create(filename, content, api_interface, description: description, publik: publik)
       end
 
-      def provider_domain
-        # We assume that it's not possible to have origin and upstream on different providers.
-        #
-        remote_url = remote(ORIGIN_NAME)
+      def create_issue(title, description)
+        provider_module::Issue.create(title, description, api_interface)
+      end
 
-        remote_url[REMOTE_ORIGIN_REGEX, 1] || remote_url[REMOTE_ORIGIN_REGEX, 2]
+      def abstract_issues(milestone: nil)
+        provider_module::AbstractIssue.list(api_interface, milestone: milestone)
       end
 
-      def path(upstream: false)
-        remote_name = upstream ? UPSTREAM_NAME : ORIGIN_NAME
+      def issues
+        provider_module::Issue.list(api_interface)
+      end
 
-        remote(remote_name)[REMOTE_ORIGIN_REGEX, 3]
+      def milestone(number)
+        provider_module::Milestone.find(number, api_interface)
+      end
+
+      def milestones
+        provider_module::Milestone.list(api_interface)
+      end
+
+      def create_pr(title, description, head)
+        provider_module::PR.create(title, description, head, api_interface)
+      end
+
+      def prs(head: nil)
+        provider_module::PR.list(api_interface, head: head)
       end
 
-      # DATA
+      # REMOTE FUNCTIONALITIES (ACCOUNT)
+
+      def authenticated_user
+        provider_module::Account.new(api_interface).authenticated_user
+      end
+
+      # OTHER/CONVENIENCE FUNCTIONALITIES
 
       def current_branch
-        branch = `git rev-parse --abbrev-ref HEAD`.strip
+        gitdir_option = "--git-dir #{@location.shellescape}/.git" if @location
+        branch = `git #{gitdir_option} rev-parse --abbrev-ref HEAD`.strip
 
         raise "Couldn't find current branch" if branch == 'HEAD'
 
         branch
       end
 
-      # OTHER
-
       private
 
-      # The result is in the format `git@github.com:saveriomiroddi/geet.git`
+      # REPOSITORY METADATA
+
+      # The result is in the format `git@github.com:donaldduck/geet.git`
       #
       def remote(name)
-        remote_url = `git ls-remote --get-url #{name}`.strip
+        gitdir_option = "--git-dir #{@location.shellescape}/.git" if @location
+        remote_url = `git #{gitdir_option} ls-remote --get-url #{name}`.strip
 
         if remote_url == name
           raise "Remote #{name.inspect} not found!"
@@ -96,6 +102,49 @@ module Geet
 
         remote_url
       end
+
+      # PROVIDER
+
+      def provider_domain
+        # We assume that it's not possible to have origin and upstream on different providers.
+        #
+        remote_url = remote(ORIGIN_NAME)
+
+        domain = remote_url[REMOTE_ORIGIN_REGEX, 1] || remote_url[REMOTE_ORIGIN_REGEX, 2]
+
+        raise "Can't identify domain in the provider domain string: #{provider_domain}" if domain !~ /(.*)\.\w+/
+
+        domain
+      end
+
+      def provider_module
+        module_name = provider_domain[/(.*)\.\w+/, 1].capitalize
+
+        require_provider_modules
+
+        Kernel.const_get("Geet::#{module_name}")
+      end
+
+      def require_provider_modules
+        provider_dirname = provider_domain[/(.*)\.\w+/, 1]
+        files_pattern = "#{__dir__}/../#{provider_dirname}/*.rb"
+
+        Dir[files_pattern].each { |filename| require filename }
+      end
+
+      # OTHER HELPERS
+
+      def api_interface
+        provider_module::ApiInterface.new(@api_token, path(upstream: @upstream), @upstream)
+      end
+
+      # Example: `donaldduck/geet`
+      #
+      def path(upstream: false)
+        remote_name = upstream ? UPSTREAM_NAME : ORIGIN_NAME
+
+        remote(remote_name)[REMOTE_ORIGIN_REGEX, 3]
+      end
     end
   end
 end

data/lib/geet/{git_hub → github}/abstract_issue.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Geet
-  module GitHub
+  module Github
     # It seems that autoloading will be deprecated, but it's currently the cleanest solution
     # to the legitimate problem of AbstractIssue needing Issue/PR to be loaded (due to :list),
     # and viceversa (due to class definition).
@@ -13,20 +13,20 @@ module Geet
     class AbstractIssue
       attr_reader :number, :title, :link
 
-      def initialize(number, api_helper, title, link)
+      def initialize(number, api_interface, title, link)
         @number = number
-        @api_helper = api_helper
+        @api_interface = api_interface
         @title = title
         @link = link
       end
 
       # See https://developer.github.com/v3/issues/#list-issues-for-a-repository
       #
-      def self.list(api_helper, milestone: nil)
-        request_address = "#{api_helper.api_repo_link}/issues"
+      def self.list(api_interface, milestone: nil)
+        api_path = 'issues'
         request_params = { milestone: milestone } if milestone
 
-        response = api_helper.send_request(request_address, params: request_params, multipage: true)
+        response = api_interface.send_request(api_path, params: request_params, multipage: true)
 
         response.map do |issue_data|
           number = issue_data.fetch('number')
@@ -35,7 +35,7 @@ module Geet
 
           klazz = issue_data.key?('pull_request') ? PR : Issue
 
-          klazz.new(number, api_helper, title, link)
+          klazz.new(number, api_interface, title, link)
         end
       end
 
@@ -43,26 +43,26 @@ module Geet
       #   users:   String, or Array of strings.
       #
       def assign_users(users)
+        api_path = "issues/#{@number}/assignees"
         request_data = { assignees: Array(users) }
-        request_address = "#{@api_helper.api_repo_link}/issues/#{@number}/assignees"
 
-        @api_helper.send_request(request_address, data: request_data)
+        @api_interface.send_request(api_path, data: request_data)
       end
 
       def add_labels(labels)
+        api_path = "issues/#{@number}/labels"
         request_data = labels
-        request_address = "#{@api_helper.api_repo_link}/issues/#{@number}/labels"
 
-        @api_helper.send_request(request_address, data: request_data)
+        @api_interface.send_request(api_path, data: request_data)
       end
 
       # See https://developer.github.com/v3/issues/#edit-an-issue
       #
       def edit(milestone:)
-        request_address = "#{@api_helper.api_repo_link}/issues/#{@number}"
         request_data = { milestone: milestone }
+        api_path = "issues/#{@number}"
 
-        @api_helper.send_request(request_address, data: request_data, http_method: :patch)
+        @api_interface.send_request(api_path, data: request_data, http_method: :patch)
       end
     end
   end