monofile 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b40761cdf41323e67c0f31dc5322ae1d33a73a40
-  data.tar.gz: 69eebef7b4e3a036eaf45c2888fdaaaaae0b0dc8
+  metadata.gz: 972e45a2358abae2cc65d2689004ee6caeffc06a
+  data.tar.gz: 793fb0d5404a10dd22a1e3478785769683b5b25f
 SHA512:
-  metadata.gz: b35816490aff623a84368d646fdb68ba9c999009210a613c6731f1636b0b00a7d23e6d5a99e9041700c067f4d929b54d1b780fa6081512d99b297a40c9db73f8
-  data.tar.gz: dd939bbab36398a63340e2810f86774a077676f0bad3a91bee3220a9ecceb7f6a7828df64f2da41b5369249117424b5857d37a774da46aaecb2e9d6c18a3fa22
+  metadata.gz: 8c5e1a3399d7465f2fa94df7ec9c15cb38890928808850490edf07635a4b98b8e5b4010bf738d892cd5916b1d03a4e3c55187938cb82a32e8b3ac7a888d7db89
+  data.tar.gz: 95b41e6fd5b0950551b29c605524eba6ce0b59b95591ed148ae70ee205fc317739facfc89738a3dc42c2bac2fb515e9f78b2d8b313c13d63c3145b4a89a87c20

data/Manifest.txt

@@ -6,6 +6,7 @@ bin/monofile
 lib/monofile.rb
 lib/monofile/monofile.rb
 lib/monofile/mononame.rb
+lib/monofile/tool.rb
 lib/monofile/version.rb
 test/helper.rb
 test/test_names.rb

data/README.md

@@ -1,7 +1,7 @@
-# monofile - read in/ parse mono (source) tree defintions with git (and github) projects, and more
+# monofile - read in / parse monorepo / mono source tree definitions - a list of git (and github) projects, and more
 
-* home  :: [github.com/rubycoco/git](https://github.com/rubycoco/git)
-* bugs  :: [github.com/rubycoco/git/issues](https://github.com/rubycoco/git/issues)
+* home  :: [github.com/rubycoco/monos](https://github.com/rubycoco/monos)
+* bugs  :: [github.com/rubycoco/monos/issues](https://github.com/rubycoco/monos/issues)
 * gem   :: [rubygems.org/gems/monofile](https://rubygems.org/gems/monofile)
 * rdoc  :: [rubydoc.info/gems/monofile](http://rubydoc.info/gems/monofile)
 
@@ -9,7 +9,127 @@
 
 ## Usage
 
-To be done
+
+Use `Monofile.read` to read in / parse monorepo / mono source tree definitions - supporting a ruby or a yaml format.
+
+
+Example - `Monofile`:
+``` ruby
+project "@openfootball/england"
+project "@openfootball/world-cup"
+project "@geraldb/austria"
+project "@geraldb/geraldb.github.io"
+
+project "geraldb", "catalog"
+project "openfootball", "europe"
+project "openfootball", "south-america"
+```
+
+or
+
+Example - `monofile.yml`:
+
+``` yaml
+geraldb:
+- austria
+- catalog
+- geraldb.github.io
+
+openfootball:
+- england
+- europe
+- south-america
+- world-cup
+```
+
+
+To read use.
+
+``` ruby
+monofile = Monofile.read( "./Monofile" )
+# -or-
+monofile = Monofile.read( "./monofile.yml" )
+pp monofile.to_a
+#=> ["@openfootball/england",
+#    "@openfootball/world-cup",
+#    "@geraldb/austria",
+#    "@geraldb/geraldb.github.io",
+#    "@geraldb/catalog",
+#    "@openfootball/europe"]
+#    "@openfootball/south-america"]
+
+pp monofile.to_h
+#=> {"openfootball"=>["england", "world-cup", "europe", "south-america"],
+#    "geraldb"     =>["austria", "geraldb.github.io", "catalog"]}
+
+monofile.each do |proj|
+  puts "  #{proj}"
+end
+#=> @openfootball/england
+#   @openfootball/world-cup
+#   @geraldb/austria
+#   @geraldb/geraldb.github.io
+#   @geraldb/catalog
+#   @openfootball/europe
+#   @openfootball/south-america
+
+monofile.size
+#=> 7
+```
+
+and so on.  That's it for now.
+
+
+
+### Troubleshooting / Debugging
+
+Use the `monofile` command line tool to test reading in of
+monorepo / mono source tree definitions.
+Example:
+
+```  shell
+# option 1) try to find default name (e.g. Monofile, Monofile.rb, etc.)
+$ monofile
+
+# option 2) pass in monofiles
+$ monofile ./Monofile
+$ monofile ./monfile.yml
+# ...
+```
+
+Printing the normalized / canonical names of the repo sources. Example.
+
+```
+@openfootball/england
+@openfootball/world-cup
+@geraldb/austria
+@geraldb/geraldb.github.io
+@geraldb/catalog
+@openfootball/europe
+@openfootball/south-america
+```
+
+
+
+
+## Real-World Usage
+
+See the [`monos`](https://github.com/rubycoco/monos/tree/master/monos) package that incl. the `mono` (or short `mo`)
+command line tool lets you run
+git commands on multiple repo(sitories) with a single command.
+
+
+## Installation
+
+Use
+
+    gem install monofile
+
+or add to your Gemfile
+
+    gem 'monofile'
+
+
 
 ## License
 

data/Rakefile

@@ -6,10 +6,10 @@ Hoe.spec 'monofile' do
 
   self.version = Mono::Module::Monofile::VERSION
 
-  self.summary = "monofile - read in/ parse mono (source) tree defintions with git (and github) projects, and more"
+  self.summary = "monofile - read in / parse monorepo / mono source tree definitions - a list of git (and github) projects, and more"
   self.description = summary
 
-  self.urls = { home: 'https://github.com/rubycoco/git' }
+  self.urls = { home: 'https://github.com/rubycoco/monos' }
 
   self.author = 'Gerald Bauer'
   self.email = 'opensport@googlegroups.com'

data/lib/monofile.rb

@@ -13,7 +13,7 @@ require 'net/http'
 require 'net/https'
 
 
-require 'optparse'
+require 'optparse'    ## used by monofile (built-in test/debug) command line tool
 
 
 
@@ -22,7 +22,7 @@ require 'optparse'
 require 'monofile/version'   # note: let version always go first
 require 'monofile/mononame'
 require 'monofile/monofile'
-
+require 'monofile/tool'
 
 
 
@@ -73,41 +73,5 @@ MonoPath = Monopath
 MonoFile = Monofile
 
 
-
-class Monofile
-class Tool
-  def self.main( args=ARGV )
-
-    ## todo/fix:
-    ##   check args - if any, use/read monofiles in args!!!
-
-    path = Monofile.find
-    if path.nil?
-      puts "!! ERROR: no mono configuration file found; looking for #{Monofile::NAMES.join(', ')} in (#{Dir.getwd})"
-      exit 1
-    end
-
-    ## add check for auto-require (e.g. ./config.rb)
-    config_path = "./config.rb"
-    if File.exist?( config_path )
-      puts "[monofile] auto-require >#{config_path}<..."
-      require( config_path )
-    end
-
-    puts "[monofile] reading >#{path}<..."
-    monofile=Monofile.read( path )
-    pp monofile
-
-    ## print one project per line
-    puts "---"
-    monofile.each do |proj|
-      puts proj.to_s
-    end
-  end
-end # (nested) class Tool
-end # class Monofile
-
-
-
-Mono::Module::Monofile.banner
+puts Mono::Module::Monofile.banner   ## say hello
 

data/lib/monofile/monofile.rb

@@ -198,12 +198,11 @@ class Monofile
   ## - austria
   ## - catalog
   ## - geraldb.github.io
-  ## - logos
-  ## yorobot:
-  ## - auto
-  ## - backup
-  ## - football.json
-  ## - logs
+  ## openfootball:
+  ## - england
+  ## - europe
+  ## - south-america
+  ## - world-cup
   ##
   def to_h
     h = {}

data/lib/monofile/mononame.rb

@@ -1,11 +1,11 @@
 #####
 #  mononame (e.g. @org/hello) machinery
 #  turn
-#  - @yorobot/stage/one
-#  - one@yorobot/stage
-#  - stage/one@yorobot
+#  - @openfootball/england/2020-21
+#  - 2020-21@openfootball/england
+#  - england/2020-21@openfootball
 #      => into
-#  - yorobot/stage/one
+#  - openfootball/england/2020-21
 
 
 
@@ -52,6 +52,14 @@ class Mononame
   end
 
 
+  def self.real_path( line )
+    ## add one-time (quick) usage convenience shortcut
+    name = parse( line )
+    name.real_path
+  end
+
+  ## todo/fix: add real_path
+
 
   ## note: org and name for now required
   ##   - make name optional too - why? why not?!!!

data/lib/monofile/tool.rb

@@ -0,0 +1,59 @@
+class Monofile
+class Tool
+  def self.main( args=ARGV )
+
+    options = {}
+    OptionParser.new do |parser|
+      ## note:
+      ##  you can add many/multiple modules
+      ##  e.g. -r gitti -r mono etc.
+      parser.on( '-r NAME', '--require NAME') do |name|
+        options[:requires] ||= []
+        options[:requires] << name
+      end
+      ## todo/fix:
+      ##    add --verbose
+      ##    add -d/--debug
+    end.parse!( args )
+
+
+    if args.size == 0   ## auto-add default arg (monofile)
+      monofile_path = Monofile.find
+      if monofile_path.nil?
+        puts "!! ERROR: no mono configuration file found; looking for #{Monofile::NAMES.join(', ')} in (#{Dir.getwd})"
+        exit 1
+      end
+      args << monofile_path
+    end
+
+
+    ## add check for auto-require (e.g. ./config.rb)
+    if options[:requires]  ## use custom (auto-)requires
+      options[:requires].each do |path|
+        puts "[monofile] auto-require >#{path}<..."
+        require( path )
+      end
+    else  ## use/try defaults
+      config_path = "./config.rb"
+      if File.exist?( config_path )
+        puts "[monofile] auto-require (default) >#{config_path}<..."
+        require( config_path )
+      end
+    end
+
+
+    args.each do |path|
+      puts "[monofile] reading >#{path}<..."
+      monofile=Monofile.read( path )
+      pp monofile
+
+      ## print one project per line
+      puts "---"
+      monofile.each do |proj|
+        puts proj.to_s
+      end
+    end
+  end # method self.main
+end # (nested) class Tool
+end # class Monofile
+

data/lib/monofile/version.rb

@@ -5,7 +5,7 @@ module Monofile
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
   MINOR = 2
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_names.rb

@@ -10,85 +10,86 @@ class TestNames < MiniTest::Test
 
 def test_parse
   %w[
-    @yorobot/stage
-    stage@yorobot
+    @openfootball/england
+    england@openfootball
   ].each do |line|
     mono = Mononame.parse( line )
 
-    assert_equal '@yorobot/stage', mono.to_s
-    assert_equal 'yorobot/stage',  mono.to_path
+    assert_equal '@openfootball/england', mono.to_s
+    assert_equal 'openfootball/england',  mono.to_path
 
-    assert_equal 'yorobot',            mono.org
-    assert_equal 'stage',              mono.name
+    assert_equal 'openfootball',          mono.org
+    assert_equal 'england',               mono.name
   end
 
 
   %w[
-    @yorobot/stage/one
-    one@yorobot/stage
-    stage/one@yorobot
+    @openfootball/england/2020-21
+    2020-21@openfootball/england
+    england/2020-21@openfootball
   ].each do |line|
     mono = Monopath.parse( line )
 
-    assert_equal '@yorobot/stage/one', mono.to_s
-    assert_equal 'yorobot/stage/one',  mono.to_path
+    assert_equal '@openfootball/england/2020-21', mono.to_s
+    assert_equal 'openfootball/england/2020-21',  mono.to_path
 
-    assert_equal 'yorobot',            mono.org
-    assert_equal 'stage',              mono.name
-    assert_equal 'one',                mono.path
+    assert_equal 'openfootball',            mono.org
+    assert_equal 'england',                 mono.name
+    assert_equal '2020-21',                 mono.path
   end
 
   %w[
-    @yorobot/stage/one/hello.txt
-    hello.txt@yorobot/stage/one
-    stage/one/hello.txt@yorobot
+    @openfootball/england/2020-21/premierleague.txt
+    2020-21/premierleague.txt@openfootball/england
+    england/2020-21/premierleague.txt@openfootball
   ].each do |line|
     mono = Monopath.parse( line )
 
-    assert_equal '@yorobot/stage/one/hello.txt', mono.to_s
-    assert_equal 'yorobot/stage/one/hello.txt',  mono.to_path
+    assert_equal '@openfootball/england/2020-21/premierleague.txt', mono.to_s
+    assert_equal 'openfootball/england/2020-21/premierleague.txt',  mono.to_path
 
-    assert_equal 'yorobot',            mono.org
-    assert_equal 'stage',              mono.name
-    assert_equal 'one/hello.txt',      mono.path
+    assert_equal 'openfootball',              mono.org
+    assert_equal 'england',                   mono.name
+    assert_equal '2020-21/premierleague.txt', mono.path
   end
 end   # method test_parse
 
 
+
 def test_init
-  mono = Mononame.new( 'yorobot','stage' )
+  mono = Mononame.new( 'openfootball','england' )
 
-  assert_equal '@yorobot/stage', mono.to_s
-  assert_equal 'yorobot/stage',  mono.to_path
+  assert_equal '@openfootball/england', mono.to_s
+  assert_equal 'openfootball/england',  mono.to_path
 
-  assert_equal 'yorobot',            mono.org
-  assert_equal 'stage',              mono.name
+  assert_equal 'openfootball',            mono.org
+  assert_equal 'england',              mono.name
 
 
-  mono = Monopath.new( 'yorobot', 'stage', 'one' )
+  mono = Monopath.new( 'openfootball', 'england', '2020-21' )
 
-  assert_equal '@yorobot/stage/one', mono.to_s
-  assert_equal 'yorobot/stage/one',  mono.to_path
+  assert_equal '@openfootball/england/2020-21', mono.to_s
+  assert_equal 'openfootball/england/2020-21',  mono.to_path
 
-  assert_equal 'yorobot',            mono.org
-  assert_equal 'stage',              mono.name
-  assert_equal 'one',                mono.path
+  assert_equal 'openfootball',            mono.org
+  assert_equal 'england',                 mono.name
+  assert_equal '2020-21',                 mono.path
 
 
   ## !!!!todo/check/fix!!!!!:
-  ##   - support 'one', 'hello.txt' too (or only) - why? why not?
+  ##   - support '2020-21', 'premierleague.txt' too (or only) - why? why not?
   ##
   ##  todo/check/fix:
   ##    find a better name for path/path? component / part - why? why not?
   ##      to_path and path/path? to confusing!!!
-  mono = Monopath.new( 'yorobot', 'stage', 'one/hello.txt' )
+  mono = Monopath.new( 'openfootball', 'england', '2020-21/premierleague.txt' )
 
-  assert_equal '@yorobot/stage/one/hello.txt', mono.to_s
-  assert_equal 'yorobot/stage/one/hello.txt',  mono.to_path
+  assert_equal '@openfootball/england/2020-21/premierleague.txt', mono.to_s
+  assert_equal 'openfootball/england/2020-21/premierleague.txt',  mono.to_path
 
-  assert_equal 'yorobot',            mono.org
-  assert_equal 'stage',              mono.name
-  assert_equal 'one/hello.txt',      mono.path
+  assert_equal 'openfootball',              mono.org
+  assert_equal 'england',                   mono.name
+  assert_equal '2020-21/premierleague.txt', mono.path
 end   # method test_init
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monofile
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -44,8 +44,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.22'
-description: monofile - read in/ parse mono (source) tree defintions with git (and
-  github) projects, and more
+description: monofile - read in / parse monorepo / mono source tree definitions -
+  a list of git (and github) projects, and more
 email: opensport@googlegroups.com
 executables:
 - monofile
@@ -63,10 +63,11 @@ files:
 - lib/monofile.rb
 - lib/monofile/monofile.rb
 - lib/monofile/mononame.rb
+- lib/monofile/tool.rb
 - lib/monofile/version.rb
 - test/helper.rb
 - test/test_names.rb
-homepage: https://github.com/rubycoco/git
+homepage: https://github.com/rubycoco/monos
 licenses:
 - Public Domain
 metadata: {}
@@ -91,6 +92,6 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: monofile - read in/ parse mono (source) tree defintions with git (and github)
-  projects, and more
+summary: monofile - read in / parse monorepo / mono source tree definitions - a list
+  of git (and github) projects, and more
 test_files: []