conjoiner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c299bb2f3d58db4461105f5965c0c89a7031aa9e4006c33f9817da87266e6792
-  data.tar.gz: b1d3e72ec85b62a934e8f0e12cc9badf3108e09bd1add9b2cef4420404b22bb6
+  metadata.gz: 81ccd5489780454659c657ca55ad9f48333f4834d87688cff68bd9b90f9aba6b
+  data.tar.gz: 17ac85e833af9fa8af956ed715fe0ea64625ec6391191fd623bb221cf1afbc73
 SHA512:
-  metadata.gz: 391e4618be7fa6aac2c90fea430e6c1ceb1fb98b7f4f6989e026ea59b99c49a309da96fba515ccb9fd5d53eafd72fa268dbf382ac75e1bae05fcb33b2b0503b1
-  data.tar.gz: dba77655da367f54f5ab15f5d9164c4ded2ffdf771a3be6a10d71c41f0427dcf7b36609d86935e3afa4fcb08e49405b73c4577b4d09453e783b3829ec768d089
+  metadata.gz: 519fa71b2216bce70c7abb0ea34f2276cd8cf08fddbabd69f0922a6baea8fb9df5189cca7df9c4b0270ba4fe1adecfd588cf49956cb746cb23b85843104b6542
+  data.tar.gz: e0368e4402685bb78dc5695d8142d1d2df64b8699bf2fc181ca0c31dc63c8cb311ec461192c8a4641c297ea848480a0e7d351d9d2240f9f340306c8ae0dbcafb

data/.rubocop.yml

@@ -8,3 +8,7 @@ Layout/HashAlignment:
 
 AllCops:
   NewCops: enable
+
+# Account for rspec-tabular examples ###########################################
+RSpec/EmptyExampleGroup:
+  Enabled: false

data/CHANGELOG.md

@@ -5,3 +5,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.2.0] - 2012-12-24
+### Added
+- Command to clone an arbitrary repository into the `~/joined` directory
+  structure
+- Command to list all the remote origins of the joined repositories
+- Add configuration file for specifying the default aspect
+
+## [0.1.0] - 2012-11-12
+### Added
+- Initializing dated aspect directories
+- Manual synchronization command
+- Show command to display git status of aspect directories
+- Synchronization mode to watch aspect repositories, committing and pushing
+  changes

data/README.md

@@ -41,6 +41,14 @@ And show the status of the repositories with:
 conjoiner show
 ```
 
+You can also clone arbitrary repositories into the `joined` directory with:
+```
+conjoiner clone git@gitlab.com:acant/conjoiner.git
+```
+
+This repository would be cloned to `$HOME/joined/gitlab.com/acant/conjoiner`.
+
+
 ### Enable the synchronization deaemon on with systemd on Linux
 
 You can enable the automatic synchronization with the following script:
@@ -79,6 +87,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and merge requests are welcome on Gitlab at https://gitlab.com/acant/conjoiner.
 
+## Similar projects
+
+* https://myrepos.branchable.com/
+* https://github.com/nesquena/gitdocs
+
 ## License
 
 Released under the [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.en.html).

data/conjoiner.gemspec

@@ -11,9 +11,10 @@ Gem::Specification.new do |spec|
   spec.description   = 'Manager for cloned git reporitories, automatically sync some of those repositories.'
   spec.homepage      = 'https://gitlab.com/acant/conjoiner'
   spec.metadata      = {
-    'homepage_uri'    => spec.homepage,
-    'source_code_uri' => spec.homepage,
-    'changelog_uri'   => "#{spec.homepage}/CHANGELOG.md"
+    'homepage_uri'          => spec.homepage,
+    'source_code_uri'       => spec.homepage,
+    'changelog_uri'         => "#{spec.homepage}/CHANGELOG.md",
+    'rubygems_mfa_required' => 'true'
   }
   spec.license       = 'AGPL-3.0-or-later'
   spec.files         =
@@ -28,15 +29,18 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
-  spec.add_dependency 'git',         '~> 1.9'
-  spec.add_dependency 'listen',      '~> 3.6'
-  spec.add_dependency 'table_print', '~> 1.5'
-  spec.add_dependency 'thor',        '~> 1.0'
+  spec.add_dependency 'git',           '~> 1.9'
+  spec.add_dependency 'git_clone_url', '~> 2.0'
+  spec.add_dependency 'listen',        '~> 3.6'
+  spec.add_dependency 'table_print',   '~> 1.5'
+  spec.add_dependency 'thor',          '~> 1.0'
 
-  spec.add_development_dependency 'aruba',     '~> 1.0'
-  spec.add_development_dependency 'cucumber',  '~> 5.3'
-  spec.add_development_dependency 'rspec',     '~> 3.10'
-  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'aruba',         '~> 1.0'
+  spec.add_development_dependency 'cucumber',      '~> 5.3'
+  spec.add_development_dependency 'fakefs',        '~> 1.4.0'
+  spec.add_development_dependency 'rspec',         '~> 3.10'
+  spec.add_development_dependency 'rspec-tabular', '~> 0.2'
+  spec.add_development_dependency 'simplecov',     '~> 0.21'
 
   spec.add_development_dependency 'bundler-audit'
   spec.add_development_dependency 'rubocop'

data/lib/conjoiner/cli.rb

@@ -2,6 +2,7 @@
 
 require 'thor'
 require 'git'
+require 'git_clone_url'
 require 'pathname'
 require 'table_print'
 require 'ostruct'
@@ -18,7 +19,7 @@ module Conjoiner
     desc 'init_aspect [ASPECT] [YEAR]', 'initialize aspect for a year'
     options year: :integer
     def init_aspect(aspect = nil, year = nil)
-      aspect ||= 'prime'
+      aspect ||= configuration.default_aspect
       year   ||= Time.now.year
 
       puts "init aspect #{aspect} #{year}"
@@ -34,20 +35,10 @@ module Conjoiner
         year.to_s
       )
 
-      repository_names =
-        if aspect == 'prime'
-          %w[gpx log misc]
-        else
-          %w[log]
-        end
-
-      repository_names.each do |name|
+      configuration.dated_repository_names.each do |name|
         repo = "gitolite@git.andrewcant.ca:andrew/aspects/#{aspect}/dated/#{year}/#{name}"
         dir  = dated_root.join(name)
 
-        puts repo
-        puts dir
-
         git =
           if dir.exist?
             begin
@@ -96,9 +87,34 @@ module Conjoiner
       end
     end
 
+    desc 'clone [URL]', 'clone the repository into the joined directory'
+    def clone(url)
+      home                = Pathname.new(Dir.home)
+      joined_dir          = home.join('joined')
+
+      # Create repository pathname from the URL.
+      git_clone_url       = GitCloneUrl.parse(url)
+      path_parts          = git_clone_url.path.sub(%r{^/}, '').sub(/\.git$/, '').split('/')
+      repository_pathname =
+        joined_dir
+        .join(git_clone_url.host)
+        .join(*path_parts)
+
+      # Clone is repository if it is not already present.
+      if repository_pathname.exist?
+        puts "Already cloned at #{repository_pathname}"
+      else
+        puts "Clone #{url} to #{repository_pathname}"
+        repository_pathname.mkpath
+        Git.clone(url, repository_pathname)
+      end
+    rescue URI::Error
+      puts "Invalid URL <#{url}>"
+    end
+
     desc 'sync', 'run the repository synchronization once'
     def sync(aspect = nil, year = nil)
-      aspect ||= 'prime'
+      aspect ||= configuration.default_aspect
       year   ||= Time.now.year
 
       home = Pathname.new(Dir.home)
@@ -150,9 +166,8 @@ module Conjoiner
         'aspects'
       )
 
-      current_aspects = %w[prime sugar]
       listen_pathnames =
-        current_aspects.map do |aspect|
+        configuration.aspects.map do |aspect|
           aspect_dir = aspects_root.join(aspect)
           [
             aspect_dir.join('dated', year.to_s),
@@ -170,7 +185,7 @@ module Conjoiner
         listen_pathnames.map { |x| x.glob('**/.git').map(&:dirname) }.flatten
 
       puts 'For these aspects:'
-      current_aspects.each { |x| puts "  * #{x}" }
+      configuration.aspects.each { |x| puts "  * #{x}" }
       puts 'Watch the following repositories:'
       listen_repository_pathnames.each { |x| puts "  * #{x}" }
 
@@ -225,7 +240,7 @@ module Conjoiner
 
     desc 'show [PATH]', 'show the status of aspects and other repositories'
     def show(aspect = nil, year = nil)
-      aspect ||= 'prime'
+      aspect ||= configuration.default_aspect
       year   ||= Time.now.year
 
       home = Pathname.new(Dir.home)
@@ -250,7 +265,7 @@ module Conjoiner
       output =
         gits.map do |git|
           additions = git.status.added.count + git.status.changed.count
-          OpenStruct.new(
+          OpenStruct.new( # rubocop:disable Style/OpenStructUse
             path:   Pathname.new(git.dir.to_s).relative_path_from(joined_dir).to_s,
             status: "+#{additions} -#{git.status.deleted.count} *#{git.status.untracked.count}"
           )
@@ -259,6 +274,41 @@ module Conjoiner
       tp.set(:max_width, 256)
       tp(output, :path, :status)
     end
+
+    desc 'ls', 'show all the joined repositories'
+    option :origin, type: :boolean, aliases: :o
+    option :noorigin, type: :boolean, aliases: :no
+    def ls
+      home       = Pathname.new(Dir.home)
+      joined_dir = home.join('joined')
+      result     = []
+      joined_dir.find do |pathname|
+        next unless pathname.directory? && pathname.join('.git').directory?
+
+        if options[:origin]
+          origin_url = Git.open(pathname).remote('origin').url
+          result.push(origin_url) if origin_url
+        elsif options[:noorigin]
+          origin_url = Git.open(pathname).remote('origin').url
+          result.push(pathname) unless origin_url
+        else
+          result.push(pathname)
+        end
+
+        Find.prune
+      end
+
+      result.sort.each { |x| puts x }
+    end
+
+    ############################################################################
+
+    private
+
+    # @return [Conjoiner::Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
   end
 end
 

data/lib/conjoiner/configuration.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Conjoiner
+  # @private
+  # Frontend for determining the configuration of conjoiner. Either using
+  # defaults specified in this file, or overridden by configuration located in:
+  #   ~/.config/conjoiner/
+  class Configuration
+    # @return [Array<String>]
+    def aspects
+      %w[prime sugar]
+    end
+
+    # @return [String]
+    def default_aspect
+      return @default_aspect if @default_aspect
+
+      default_aspect_pathname =
+        Pathname.new(Dir.home).join('.config', 'conjoiner', 'default_aspect')
+
+      @default_aspect =
+        if default_aspect_pathname.readable?
+          default_aspect_pathname.read.strip
+        else
+          'prime'
+        end
+    end
+
+    # @param aspect [String]
+    #
+    # @return [Array<String>]
+    def dated_repository_names(aspect)
+      if aspect == 'prime'
+        %w[gpx log misc]
+      else
+        %w[log]
+      end
+    end
+  end
+end

data/lib/conjoiner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Conjoiner
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/conjoiner.rb

@@ -2,6 +2,7 @@
 
 require 'conjoiner/version'
 require 'conjoiner/cli'
+require 'conjoiner/configuration'
 
 module Conjoiner
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conjoiner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Sullivan Cant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-12 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: git_clone_url
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-tabular
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +275,7 @@ files:
 - exe/conjoiner
 - lib/conjoiner.rb
 - lib/conjoiner/cli.rb
+- lib/conjoiner/configuration.rb
 - lib/conjoiner/version.rb
 homepage: https://gitlab.com/acant/conjoiner
 licenses:
@@ -241,6 +284,7 @@ metadata:
   homepage_uri: https://gitlab.com/acant/conjoiner
   source_code_uri: https://gitlab.com/acant/conjoiner
   changelog_uri: https://gitlab.com/acant/conjoiner/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: