safe_update 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76e32c112b1472705905d9ee7da198eb56be4a39
+  data.tar.gz: 005240cf53a0e77b505ea876531c9ac91295ec76
+SHA512:
+  metadata.gz: 53e735d64c14e5e403bc160deefab71cd09eff6686b666515261a70b5189333d7cfbda62c69fd1292f179f1834805a139369a5963776d3ef32799afc7c5666bc
+  data.tar.gz: f9f836d155ced363c29a8e89bdf59cca3faab248dadb0c61f64db04564f479f2eb1a1ad140f644deef1f7d503a003dc76d05f5862496e9edf15017a641520792

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safe_update.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joshua Paling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# SafeUpdate
+
+This automates the tedious but important process of updating your gems, one at a time.
+
+When I first started ruby, I was told 'Never run `bundle update`'. The reality is, we should be keeping our gems as up to date as possible - but `bundle update` just isn't a great way to do it. It does everything in one hit, and it's hard to figure out the cause when things go wrong.
+
+This gem does `bundle update` in a safer way. It takes the output of `bundle outdated`, and, for each outdated gem, it:
+
+- runs `bundle update <gem_name>`
+- commits to git with the message: `ran: bundle update <gem_name>`
+
+Once you've got each gem updated, with one commit per gem, you can run your tests, and check everything is working. If something is broken, you can use `git bisect` to easily figure out the problem gem.
+
+## Installation
+
+    $ gem install safe_update
+
+And then, from your project's root directory, execute:
+
+    $ safe_update
+
+Since this gem is not a dependency of your application, per se, there's no need to add it to your gemfile.
+
+## Usage
+
+1. `cd /path/to/project`
+2. `safe_update`
+3. Watch your gems get updated and committed, one at a time. The output looks like this:
+
+```
+(... more goes here)
+-------------
+OUTDATED GEM: sprockets-rails
+   Newest: 3.0.3.
+Installed: 3.0.0.
+Running `bundle update sprockets-rails`...
+committing changes (message: 'bundle update sprockets-rails')...
+-------------
+OUTDATED GEM: unf_ext
+   Newest: 0.0.7.2.
+Installed: 0.0.7.1.
+Running `bundle update unf_ext`...
+committing changes (message: 'bundle update unf_ext')...
+-------------
+OUTDATED GEM: uniform_notifier
+   Newest: 1.10.0.
+Installed: 1.9.0.
+Running `bundle update uniform_notifier`...
+committing changes (message: 'bundle update uniform_notifier')...
+-------------
+-------------
+FINISHED
+```
+
+## Future
+
+I've knocked this up really quickly, and it's pretty MVP-ish. Ideas for future include:
+
+- run your tests each update, and don't update problem gems
+- specify what update sizes you want to apply (major, minor, patch)
+- summary of what's happened at the end (eg. 2 major updates ignored, 5 minor updates applied, etc)
+- other ideas? Open an issue.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshuapaling/safe_update.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "safe_update"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/safe_update

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/safe_update"
+SafeUpdate::Updater.new.run

data/lib/safe_update.rb

@@ -0,0 +1,13 @@
+# @ToDO - without changing the loadpath here,
+# we get errors:
+# /lib/safe_update.rb:4:in `require': cannot load such file -- safe_update/version
+# See what we can do to resolve this.
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "safe_update/version"
+require "safe_update/updater"
+require "safe_update/outdated_gem"
+
+module SafeUpdate
+end

data/lib/safe_update/outdated_gem.rb

@@ -0,0 +1,56 @@
+module SafeUpdate
+  class OutdatedGem
+    attr_reader :newest, :installed, :requested
+
+    # line is a line from bundle outdated --parseable
+    # eg. react-rails (newest 1.6.0, installed 1.5.0, requested ~> 1.0)
+    # or. react-rails (newest 1.6.0, installed 1.5.0)
+    def initialize(line)
+      @line = line
+      raise "Unexpected output from `bundle outdated --parseable`: #{@line}" unless name.to_s.length > 0
+    end
+
+    def update
+      puts '-------------'
+      puts "OUTDATED GEM: #{name}"
+      puts "   Newest: #{newest}. "
+      puts "Installed: #{installed}."
+      puts "Running `bundle update #{name}`..."
+      %x(bundle update #{name})
+      puts "committing changes (message: '#{commit_message}')..."
+      %x(git add -A)
+      %x(git commit -m '#{commit_message}')
+    end
+
+    def name
+      string_between(@line, '', ' (newest')
+    end
+
+    def newest
+      string_between(@line, ' (newest ', ', installed')
+    end
+
+    def requested
+      string_between(@line, ', requested ', ')')
+    end
+
+    def installed
+      if @line.index('requested')
+        string_between(@line, ', installed ', ', requested')
+      else
+        string_between(@line, ', installed ', ')')
+      end
+    end
+
+    private
+
+    def commit_message
+      "ran: bundle update #{name}"
+    end
+
+    # returns the section of string that resides between marker1 and marker2
+    def string_between(string, marker1, marker2)
+      string[/#{Regexp.escape(marker1)}(.*?)#{Regexp.escape(marker2)}/m, 1]
+    end
+  end
+end

data/lib/safe_update/updater.rb

@@ -0,0 +1,26 @@
+module SafeUpdate
+  class Updater
+    def run
+      output_array = bundle_outdated_parseable.split(/\n+/)
+      output_array.each do |line|
+        OutdatedGem.new(line).update
+      end
+      puts '-------------'
+      puts '-------------'
+      puts 'FINISHED'
+    end
+
+    def bundle_outdated_parseable
+      output = %x(bundle outdated --parseable)
+      if output.strip == "Unknown switches '--parseable'"
+        # pre-1.12.0 version of bundler
+        output = %x(bundle outdated)
+        output.gsub!(/(\n|.)*Outdated gems included in the bundle:/, '')
+        output.gsub!(/  \* /, '')
+        output.gsub!(/ in group.*/, '')
+      end
+
+      return output.strip
+    end
+  end
+end

data/lib/safe_update/version.rb

@@ -0,0 +1,3 @@
+module SafeUpdate
+  VERSION = "0.1.0"
+end

data/safe_update.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_update/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_update"
+  spec.version       = SafeUpdate::VERSION
+  spec.authors       = ["Joshua Paling"]
+  spec.email         = ["joshua.paling@gmail.com"]
+
+  spec.summary       = %q{Safely and automatically update your gems, one at a time, with one git commit per updated gem. }
+  spec.homepage      = "https://github.com/joshuapaling/safe_update"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: safe_update
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Paling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- joshua.paling@gmail.com
+executables:
+- safe_update
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/safe_update
+- lib/safe_update.rb
+- lib/safe_update/outdated_gem.rb
+- lib/safe_update/updater.rb
+- lib/safe_update/version.rb
+- safe_update.gemspec
+homepage: https://github.com/joshuapaling/safe_update
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Safely and automatically update your gems, one at a time, with one git commit
+  per updated gem.
+test_files: []