git-bundle 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f8a6dbac04e7df74fd20844a8d1b3d9644f1481
-  data.tar.gz: 73c8387f701edb2c52daa89c5dcabfd11623e5d1
+  metadata.gz: 72bdf46a0d1691d386a73789d3e409c7ffa568e1
+  data.tar.gz: 45e26b76656b3d9b64f4e0866c1482ab7d820571
 SHA512:
-  metadata.gz: 0c5d5533464c4aef6dc674c18f70870926955eeb7c3b26c8a511bf73fee90495182f22955639ec8e40f5ec6f90c0a7964eb3ad011409c81fbd78d73512dcadb5
-  data.tar.gz: 9670f36cc2eedc9742e128c474261b5376a4e0031bfc650f46f1182d8339cb448ff6f963de8d8ad33e7a315f4dbdaa1fe8405616321cbf32686a60c89b032d17
+  metadata.gz: 3dc6df327ce0f7efd7b1043329ff17dc1a9b71e06d478e02745a6fcfd12fa82eac3a2643141a2516bdf71836286bc822c90cae8fb54389314fca1c6b542bb7f4
+  data.tar.gz: d95a4aa59168ac53cfa95a24c7eb17d542ff3deada25c0baf6a62c1b72100d0b23001a44781250a7f473f5be0903091f2bda8c2fd9dba774ffbdf8c18fc5c1db

data/README.md

@@ -1,41 +1,135 @@
-# Git::Bundle
+# Gitb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/bundle`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem simplifies working with [gems from git repositories](http://bundler.io/v1.5/git.html):
+```ruby
+gem 'forum_engine', git: 'https://github.com/your_name/forum_engine.git', branch: :master
+```
+in combination with [local overrides](http://bundler.io/v1.5/git.html#local):
+```shell
+bundle config local.some_gem_or_rails_engine /path/to/local/git/repository
+```
 
-TODO: Delete this and the text above, and describe your gem
+## Usage examples
 
-## Installation
+Let's say you have a Rails application that uses two of your own reusable Rails engines called *forum_engine* and
+*blog_engine*.  This is how you include them in your Gemfile:
+```ruby
+gem 'forum_engine', git: 'https://github.com/your_name/forum_engine.git', branch: :master
+gem 'blog_engine', git: 'https://github.com/your_name/blog_engine.git', branch: :master
+```
 
-Add this line to your application's Gemfile:
+You then add local overrides to your bundle config so that you can work on them like you would work on your main Rails
+application: any code change takes immediate effect.
+```
+bundle config local.some_gem_or_rails_engine /path/to/forum/git/repository
+bundle config local.some_gem_or_rails_engine /path/to/blog/git/repository
+```
 
-```ruby
-gem 'git-bundle'
+This gem will make the following scenarios easier and quicker:
+
+**1. Performing the same git command on all local overrides in addition to the main application.**
+
+Gitb will relay any command and arguments you pass it to all local override repositories in addition to the main
+repository.  In other words a **gitb pull** will run a **git pull** in all repositories:
 ```
+=== forum_engine (master)
+Already up-to-date.
 
-And then execute:
+=== blog_engine (master)
+remote: Counting objects: 72, done.
+remote: Compressing objects: 100% (53/53), done.
+remote: Total 72 (delta 16), reused 61 (delta 9), pack-reused 0
+Unpacking objects: 100% (72/72), done.
 
-    $ bundle
+=== your-rails-application (master)
+Already up-to-date.
+```
 
-Or install it yourself as:
+Another example is a **gitb checkout release** will run **git checkout release** in all repositories:
+```
+=== forum_engine (master)
+Switched to branch 'master'
+Your branch is up-to-date with 'origin/master'.
+
+=== blog_engine (master)
+Switched to branch 'master'
+Your branch is ahead of 'origin/master' by 2 commits.
+  (use "git push" to publish your local commits)
+
+=== your-rails-application (master)
+Switched to branch 'master'
+Your branch is up-to-date with 'origin/master'.
+```
 
-    $ gem install git-bundle
+**2. Updating Gemfile.lock when pushing changes.**
 
-## Usage
+When you want to commit and push changes the standard process is:
+* commit the engine git repositories first.
+* run *bundle install* on the main application so that it updates the Gemfile.lock with the new git revisions (shown
+below).
+* Add the Gemfile.lock to a commit and push the main application commits.
+```
+GIT
+  remote: https://github.com/your_name/forum_engine.git
+  revision: b9270e61abb89e1ff77fb8cfacb463e4d04388ad
+  branch: master
+```
 
-TODO: Write usage instructions here
+With this gem you don't need to run *bundle install* to update the Gemfile.lock yourself.  When you run a push command
+it will detect that your Gemfile.lock needs to be updated, run *bundle install*, add the Gemfile.lock to a new commit
+with an appropriate commit message and push it with your other commits.  This is what it looks like if you run **gitb push** in
+the main application:
 
-## Development
+```
+=== forum_engine (master)
+Counting objects: 11, done.
+Delta compression using up to 4 threads.
+Compressing objects: 100% (13/13), done.
+Writing objects: 100% (13/13), 2.42 KiB | 0 bytes/s, done.
+Total 11 (delta 6), reused 0 (delta 0)
+   ba4b3bf..ca4f753  master -> master
+
+=== blog_engine (master)
+Counting objects: 4, done.
+Delta compression using up to 6 threads.
+Compressing objects: 100% (4/4), done.
+Writing objects: 100% (5/5), 2.42 KiB | 0 bytes/s, done.
+Total 11 (delta 6), reused 0 (delta 0)
+   ac1b3bf..b4bf753  master -> master
+
+=== your-rails-application (master)
+Local gems were updated. Building new Gemfile.lock with bundle install.
+
+Counting objects: 13, done.
+Delta compression using up to 8 threads.
+Compressing objects: 100% (12/12), done.
+Writing objects: 100% (13/13), 2.32 KiB | 0 bytes/s, done.
+Total 13 (delta 6), reused 0 (delta 0)
+   ce2b3bf..f0bf753  master -> master
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Installation
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can install it yourself:
 
-## Contributing
+```
+gem install git-bundle
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-bundle.
+Or alternatively add this line to your application's Gemfile:
 
+```ruby
+group :development do
+  gem 'git-bundle'
+end
+```
 
-## License
+Both should allow you to use the **gitb** command anywhere
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/EPI-USE-Labs/git-bundle.
+
+## License
 
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/git-bundle.gemspec

@@ -8,9 +8,11 @@ Gem::Specification.new do |spec|
   spec.version       = GitBundle::VERSION
   spec.authors       = ['Pierre Pretorius']
   spec.email         = ['pierre@labs.epiuse.com']
-
-  spec.summary       = %q{Makes life easier when working with git and local overrides of bundled gems.}
-  spec.description   = %q{If you are using Bundler and local overrides of gems or Rails engines this gem might be for you.}
+  spec.summary       = %q{Simplify working with local gems/engines overrides and git}
+  spec.description   = %q{This gem simplifies working with gems from git repositories:
+                            gem 'forum_engine', git: 'https://github.com/your_name/forum_engine.git', branch: :master
+                          in combination with local overrides:
+                            bundle config local.some_gem_or_rails_engine /path/to/local/git/repository}
   spec.homepage      = 'https://github.com/EPI-USE-Labs/git-bundle'
   spec.license       = 'MIT'
 

data/lib/git_bundle/version.rb

@@ -1,3 +1,3 @@
 module GitBundle
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-bundle
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Pierre Pretorius
@@ -24,8 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-description: If you are using Bundler and local overrides of gems or Rails engines
-  this gem might be for you.
+description: |-
+  This gem simplifies working with gems from git repositories:
+                              gem 'forum_engine', git: 'https://github.com/your_name/forum_engine.git', branch: :master
+                            in combination with local overrides:
+                              bundle config local.some_gem_or_rails_engine /path/to/local/git/repository
 email:
 - pierre@labs.epiuse.com
 executables:
@@ -71,5 +74,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Makes life easier when working with git and local overrides of bundled gems.
+summary: Simplify working with local gems/engines overrides and git
 test_files: []