github_copier 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4f993114e8a40461a5937d56f84b580d62062fa
-  data.tar.gz: 3dd6b2ef0b3d636610f30e2ce226d2e5c167b3a7
+  metadata.gz: f65a16009f22048a6d1efb93d734bd5c936e99ec
+  data.tar.gz: 2d6042100d7705c19166037abd9ada3eee891618
 SHA512:
-  metadata.gz: ab4869300def7a4754ab104c1ae87cbffe02a83756bb402ed7123acf7c3d97b87e403933bc6c5e762af2021f257c53146ea123423c9643ab745a0a15c3c69a84
-  data.tar.gz: 1422f1b597e56ce3fabafdde1fb3bf1ce678bfec128ee813922dd8d12cc543cbce7ff6f2155e95041ae918f1da758b3dd12cd5765090886b4de0d0820b7ce37b
+  metadata.gz: b45a11433cf42353184a92da6af9edb0dd983fa8ab88c1f824ab576e3df42f979b2f0d59db98877bffb1db3d1a916fee73c3b7a6f14c28df8bfbe62f7aff034c
+  data.tar.gz: 6c62d3a174b690fadd93d57f0c1928af00ed4031e63d9de9fe426ec6179567aa8bedb9dda55a38e9656276431eeb873d2dbea4eb812293a4c60dbdd1c700cf5d

data/CHANGELOG.md

@@ -3,3 +3,9 @@
 #### 0.1.0
 
 - Initial release
+
+#### 0.2.0
+- Add option to group output by language by default
+- Show list of repositories in the dry-run mode (--no-clone) option
+- Improve the gemspec to add more context for the user
+- Add some example to default option when the user type no argument

data/README.md

@@ -38,18 +38,21 @@ You should see something like
 Usage: github_copier [options]
 
 Specific options:
-    -b, --base-dir BASE_DIR          Output directory where the repository will be cloned to
-    -u, --user USER                  The github USER that will be cloned from
-    -o, --org [ORG]                  The Github's organization name to be used if specified
-                                     (where ORG is the organization that the user belongs to)
-    -t, --oauth-token [OAUTH_TOKEN]  The Github's oauth_token for authentication (required to list/clone private repositories)
-                                     (where OAUTH_TOKEN is from the user's Github setting)
-    -l, --language [LANG]            Clone only project of type LANG
-                                     (where LANG is main language as shown on Github)
+    -b, --base-dir BASE_DIR          where BASE_DIR is the directory where the repositories will be cloned to (mandatory)
+                                     If not specified, current directory will be used
+    -u, --user USER                  The Github USER that will be cloned from (mandatory)
+    -o, --org [ORG]                  The Github's organization name to be used if specified (optional)
+                                     where ORG is the organization that the user belongs to
+    -t, --oauth-token [OAUTH_TOKEN]  The Github's oauth_token for authentication (optional - only required to list/clone private repositories)
+                                     where OAUTH_TOKEN is from the user's Github setting
+    -l, --language [LANG]            Clone only project of type LANG (optional)
+                                     where LANG is main language as shown on Github
     -a, --[no-]all-repos             All repository only (optional)
-                                     (default to original/non-fork repositories only)
+                                     default to original/non-forked repositories only
+    -g, --[no-]group-by-user         Group the output by {BASE_DIR}/{USER}/{LANG}
+                                     default to {BASE_DIR}/{LANG}/{USER}
     -c, --[no-]clone                 Clone the repositories to the path specified (optional)
-                                     (default to --no-clone e.g. dry-run only)
+                                     default to --no-clone e.g. dry-run only
 
 Common options:
     -h, --help                       Show this message
@@ -108,8 +111,7 @@ $github_copier --user awesome_user \
 - List repositories by a given user (dry-run)
 
 ```
-# Dry run option (list only)
-$github_copier -b ~/Desktop/projects -u littlebee -l CoffeeScript
+$github_copier -b ~/Desktop/projects -u littlebee -l Ruby
 ------------------------------------------
 List of languages by littlebee
 Makefile
@@ -136,55 +138,52 @@ List of all repositories by littlebee
 14/15: littlebee/JavaScript/selectable-collection
 15/15: littlebee/Arduino/solar-sunflower
 ------------------------------------------
-Dry-run only, no action taken!
+FYI: dry-run only, no action taken!!
+Process 1 of 1 : git clone git@github.com:littlebee/got.git /Users/bchoomnuan/Desktop/projects/Ruby/littlebee/got
 ```
 
 - List and clone repositories for a given user (e.g. `--clone` option used)
 
 ```
-$github_copier git:(master) ✗ github_copier -b ~/Desktop/projects -u littlebee -l CoffeeScript -c
- ------------------------------------------
- List of languages by littlebee
- Makefile
- CoffeeScript
- Ruby
- JavaScript
- Arduino
- ------------------------------------------
- ------------------------------------------
- List of all repositories by littlebee
- 1/15: littlebee/Makefile/arduino-mk
- 2/15: littlebee/CoffeeScript/bumble-build
- 3/15: littlebee/CoffeeScript/bumble-docs
- 4/15: littlebee/CoffeeScript/bumble-strings
- 5/15: littlebee/CoffeeScript/bumble-test
- 6/15: littlebee/CoffeeScript/bumble-util
- 7/15: littlebee/CoffeeScript/git-log-utils
- 8/15: littlebee/CoffeeScript/git-status-utils
- 9/15: littlebee/CoffeeScript/git-time-machine
- 10/15: littlebee/CoffeeScript/notjs
- 11/15: littlebee/CoffeeScript/publish
- 12/15: littlebee/CoffeeScript/react-focus-trap-amd
- 13/15: littlebee/Ruby/got
- 14/15: littlebee/JavaScript/selectable-collection
- 15/15: littlebee/Arduino/solar-sunflower
- ------------------------------------------
- Process 1 of 11 => git clone git@github.com:littlebee/bumble-build.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/bumble-build
- Process 2 of 11 => git clone git@github.com:littlebee/bumble-docs.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/bumble-docs
- Process 3 of 11 => git clone git@github.com:littlebee/bumble-strings.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/bumble-strings
- Process 4 of 11 => git clone git@github.com:littlebee/bumble-test.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/bumble-test
- Process 5 of 11 => git clone git@github.com:littlebee/bumble-util.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/bumble-util
- Process 6 of 11 => git clone git@github.com:littlebee/git-log-utils.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/git-log-utils
- Process 7 of 11 => git clone git@github.com:littlebee/git-status-utils.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/git-status-utils
- Process 8 of 11 => git clone git@github.com:littlebee/git-time-machine.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/git-time-machine
- Process 9 of 11 => git clone git@github.com:littlebee/notjs.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/notjs
- Process 10 of 11 => git clone git@github.com:littlebee/publish.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/publish
- Process 11 of 11 => git clone git@github.com:littlebee/react-focus-trap-amd.git /Users/bchoomnuan/Desktop/projects/littlebee/CoffeeScript/react-focus-trap-amd
+$github_copier -b ~/Desktop/projects -u littlebee -l Ruby -c
+------------------------------------------
+List of languages by littlebee
+Makefile
+CoffeeScript
+Ruby
+JavaScript
+Arduino
+------------------------------------------
+------------------------------------------
+List of all repositories by littlebee
+1/15: littlebee/Makefile/arduino-mk
+2/15: littlebee/CoffeeScript/bumble-build
+3/15: littlebee/CoffeeScript/bumble-docs
+4/15: littlebee/CoffeeScript/bumble-strings
+5/15: littlebee/CoffeeScript/bumble-test
+6/15: littlebee/CoffeeScript/bumble-util
+7/15: littlebee/CoffeeScript/git-log-utils
+8/15: littlebee/CoffeeScript/git-status-utils
+9/15: littlebee/CoffeeScript/git-time-machine
+10/15: littlebee/CoffeeScript/notjs
+11/15: littlebee/CoffeeScript/publish
+12/15: littlebee/CoffeeScript/react-focus-trap-amd
+13/15: littlebee/Ruby/got
+14/15: littlebee/JavaScript/selectable-collection
+15/15: littlebee/Arduino/solar-sunflower
+------------------------------------------
+Process 1 of 1 : git clone git@github.com:littlebee/got.git /Users/bchoomnuan/Desktop/projects/Ruby/littlebee/got
 ```
 
 ### TODO
 
 - Replace system call with the ruby library like [grit](https://github.com/mojombo/grit) or something similar
+- Allow the `https` when performing the clone
+- Implement the `FilenameCleaner.sanitize()` locally
+
+### Related Projects
+
+- [github_cloner](https://github.com/nashby/github_cloner) by Vasiliy Ermolovich
 
 ### Contributing
 

data/bin/github_copier

@@ -24,12 +24,13 @@ if options.language
 end
 
 args = {
-  base_dir:    options.base_dir,    # mandatory
-  oauth_token: options.oauth_token, # optional
-  user:        options.user,        # optional if org is used?
-  org:         options.org,         # optional if user is used?
-  all_repos:   options.all_repos,   # optional
-  clone_repos: options.clone_repos  # optional
+  base_dir:      options.base_dir,      # mandatory
+  oauth_token:   options.oauth_token,   # optional required for private repos
+  user:          options.user,          # optional if org is used?
+  org:           options.org,           # optional if user is used?
+  all_repos:     options.all_repos,     # default to false
+  group_by_user: options.group_by_user, # default to false
+  clone_repos:   options.clone_repos    # default to false
 }
 
 repos = GithubCopier::GithubUtils.list_all(args)
@@ -53,14 +54,6 @@ if result && !result.empty?
   end
   puts "------------------------------------------"
 
-  if args[:clone_repos]
-    if language
-      GithubCopier::GithubUtils.clone_all(result.keep_if { |i| i.split(File::SEPARATOR)[1] == language }, options.base_dir)
-    else
-      GithubCopier::GithubUtils.clone_all(result, options.base_dir)
-    end
-  else
-    puts "Dry-run only, no action taken!"
-    puts "------------------------------------------"
-  end
+  result.keep_if { |i| i.split(File::SEPARATOR)[1] == language } if language
+  GithubCopier::GithubUtils.clone_all(result,args)
 end

data/github_copier.gemspec

@@ -8,7 +8,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Burin Choomnuan']
   spec.email         = ['agilecreativity@gmail.com']
   spec.summary       = %q{Clone/list Github repository for a given user/organization include private/public in one go}
-  spec.description   = %q{Clone/list Github repository for any user/organization including private repositories}
+  spec.description   = %q(
+    Clone/list multiple Github repositories for a given user/organization including private repos easily.
+    e.g.$github_copier --base-dir ~/projects --user awesome_dev --language "Emacs Lisp" --clone
+    ).gsub(/^\s+/, " ")
   spec.homepage      = 'https://github.com/agilecreativity/github_copier'
   spec.required_ruby_version = ">= 2.0.0"
   spec.license       = 'MIT'
@@ -25,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'github_api', '~> 0.13'
-  spec.add_runtime_dependency 'awesome_print', '~> 1.6'
   spec.add_runtime_dependency 'filename_cleaner', '~> 0.4'
 
+  spec.add_development_dependency 'awesome_print', '~> 1.6'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'gem-ctags', '~> 1.0'
   spec.add_development_dependency 'guard', '~> 2.12'

data/lib/github_copier.rb

@@ -3,5 +3,4 @@ require 'github_copier/opt_parser'
 require 'github_copier/github_copier'
 require 'github_api'
 require 'filename_cleaner'
-require 'ap'
 include GithubCopier

data/lib/github_copier/github_copier.rb

@@ -21,6 +21,7 @@ module GithubCopier
 
           # require this for only with org and with private repos
           args.merge!(oauth_token: args[:oauth_token]) if args[:oauth_token]
+          ##puts "FYI: your options #{args}"
 
           # Only required if we use oauth_token which allow use to list private repositories
           github = Github.new(args)
@@ -51,15 +52,14 @@ module GithubCopier
 
       # Clone list of repos of the following forms
       #
-      # @params [Array<string>] projects list of project of the form '{org|user}/{language}/{repo_name}'
-      #         [ "magnars/clojure/project1", "magnars/clojure/tools.macro", ...]
-      # @param [String] base_dir the base directory to save the clone result
-      #         default to current directory
-      # The result will be saved to '/path/to/base_dir/{org_name}/{language}/{repo_name}'
-      def clone_all(projects, base_dir = ".")
-        base_path = File.expand_path(base_dir)
+      def clone_all(projects, args = {})
+        base_path = File.expand_path(args[:base_dir])
 
-        FileUtils.mkdir_p(base_path)
+        if args[:clone_repos]
+          FileUtils.mkdir_p(base_path)
+        else
+          puts "FYI: dry-run only, no action taken!!" unless args[:clone_repos]
+        end
 
         projects.each_with_index do |project, i|
           org_name, language, repo_name = project.split(File::SEPARATOR)
@@ -67,10 +67,15 @@ module GithubCopier
           # Note: need to cleanup the language like 'Emacs Lisp' to 'Emacs_Lisp' or 'emacs_lisp'
           language = FilenameCleaner.sanitize(language, '_', false)
 
-          output_path = [base_path, org_name, language, repo_name].join(File::SEPARATOR)
-          puts "Process #{i+1} of #{projects.size} => git clone git@github.com:#{[org_name, repo_name].join(File::SEPARATOR)}.git #{output_path}"
-          # TODO: may be allow `https` as well as `git`?
-          output = system("git clone git@github.com:#{[org_name, repo_name].join(File::SEPARATOR)}.git #{output_path} 2> /dev/null")
+          if args[:group_by_user]
+            output_path = [base_path, org_name, language, repo_name].join(File::SEPARATOR)
+          else
+            output_path = [base_path, language, org_name, repo_name].join(File::SEPARATOR)
+          end
+          puts "Process #{i+1} of #{projects.size} : git clone git@github.com:#{[org_name, repo_name].join(File::SEPARATOR)}.git #{output_path}"
+          if args[:clone_repos]
+            system("git clone git@github.com:#{[org_name, repo_name].join(File::SEPARATOR)}.git #{output_path} 2> /dev/null")
+          end
         end
       end
 

data/lib/github_copier/opt_parser.rb

@@ -5,14 +5,13 @@ module GithubCopier
     # Return a structure describing the options.
     def self.parse(args)
       # The options specified on the command line will be collected in *options*.
-      # We set default values here.
       options = OpenStruct.new
 
-      # The mandatory arguments
+      # Set the sensible default for the options explicitly
       options.base_dir = "."
-
-      # The option arguments
-      options.verbose = false
+      options.all_repos = false
+      options.group_by_user = false
+      options.clone_repos = false
 
       # The parser
       opt_parser = OptionParser.new do |opts|
@@ -23,44 +22,50 @@ module GithubCopier
 
         # Mandatory argument
         opts.on("-b", "--base-dir BASE_DIR",
-                "Output directory where the repository will be cloned to") do |dir|
+                "where BASE_DIR is the directory where the repositories will be cloned to (mandatory)",
+                "If not specified, current directory will be used") do |dir|
           options.base_dir = dir
         end
 
         opts.on("-u", "--user USER",
-                "The github USER that will be cloned from") do |user|
-          # By default the id is assumed to be of a normal user not as organization
+                "The Github USER that will be cloned from (mandatory)") do |user|
           options.user = user
         end
 
         opts.on("-o", "--org [ORG]",
-                "The Github's organization name to be used if specified",
-                "(where ORG is the organization that the user belongs to)") do |org|
+                "The Github's organization name to be used if specified (optional)",
+                "where ORG is the organization that the user belongs to") do |org|
           options.org = org
         end
 
         opts.on("-t", "--oauth-token [OAUTH_TOKEN]",
-                "The Github's oauth_token for authentication (required to list/clone private repositories)",
-                "(where OAUTH_TOKEN is from the user's Github setting)") do |token|
+                "The Github's oauth_token for authentication (optional - only required to list/clone private repositories)",
+                "where OAUTH_TOKEN is from the user's Github setting") do |token|
           options.oauth_token = token
         end
 
         opts.on("-l", "--language [LANG]",
-                "Clone only project of type LANG",
-                "(where LANG is main language as shown on Github)") do |lang|
+                "Clone only project of type LANG (optional)",
+                "where LANG is main language as shown on Github") do |lang|
           options.language = lang
         end
 
         # Boolean switch.
         opts.on("-a", "--[no-]all-repos",
                 "All repository only (optional)",
-                "(default to original/non-fork repositories only)") do |a|
+                "default to original/non-forked repositories only") do |a|
           options.all_repos = a
         end
 
+        opts.on("-g", "--[no-]group-by-user",
+                "Group the output by {BASE_DIR}/{USER}/{LANG}",
+                "default to {BASE_DIR}/{LANG}/{USER}") do |gbu|
+          options.group_by_user = gbu
+        end
+
         opts.on( "-c", "--[no-]clone",
                 "Clone the repositories to the path specified (optional)",
-                "(default to --no-clone e.g. dry-run only)") do |c|
+                "default to --no-clone e.g. dry-run only") do |c|
           options.clone_repos = c
         end
 
@@ -68,9 +73,17 @@ module GithubCopier
         opts.separator "Common options:"
 
         # No argument, shows at tail.  This will print an options summary.
-        # Try it and see!
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
+          puts ""
+          puts "Example Usage:"
+          puts ""
+          puts "a) List the 'JavaScript' repositories for a given user (dry-run)"
+          puts "github_copier -b ~/Desktop/projects -u awesome_user -l JavaScript"
+          puts ""
+          puts "b) Clone the 'JavaScript' repositories for a given user (note: --clone or -c option)"
+          puts "github_copier -b ~/Desktop/projects -u awesome_user -l JavaScript -c"
+          puts ""
           exit
         end
       end

data/lib/github_copier/version.rb

@@ -1,3 +1,3 @@
 module GithubCopier
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_copier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: filename_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: filename_cleaner
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
+        version: '1.6'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,8 +206,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: Clone/list Github repository for any user/organization including private
-  repositories
+description: " Clone/list multiple Github repositories for a given user/organization
+  including private repos easily.\n e.g.$github_copier --base-dir ~/projects --user
+  awesome_dev --language \"Emacs Lisp\" --clone\n "
 email:
 - agilecreativity@gmail.com
 executables: