restore_bundled_with 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68935973b538af474edcaa7251e8d882670f73a0
-  data.tar.gz: ac28ee848557aa9c6125cb02372aef03a892eede
+  metadata.gz: 3d0052ed0f13a64e5e516d928ec22e9ba71834a7
+  data.tar.gz: 61275fbe18e0baaaccfc68b4dcf79a2451ffa8c4
 SHA512:
-  metadata.gz: 2c70cb23dae2932b7ab2f74f7e6fee15ddf6bf428cb2d14489fa25191146c574387faa5ded32f78c2e8c43cea9bc47fda818b4468bcc935c175997ff2804ac1b
-  data.tar.gz: 077639234e72ab043a4014f09fc1387f630dbac1ec97e13cbb143d861a209150ee2812ec8b8143e389d42dffb306075fa2252822881e93f64763bdb850d6e0cd
+  metadata.gz: f2d1f3c68463e8a691e0b127e9deb43eff6b6e4619c723b96e52236a8aad15ebb7b4d88982e73b02592cbc436e9f072ddb21bc28f2a131e35f9b9facddb79d96
+  data.tar.gz: af240ad0fb74bfd9caa5e926ff9a843dfe05ce06f1728afb2404f6f5c264f08cfeb4058f3035b9e5b8998d0aeb7e7add694d6c40e508e5aa1fa782a52106b9f9

data/.conventional-changelog.context.js

@@ -0,0 +1,17 @@
+'use strict';
+var execSync = require('child_process').execSync;
+var URI = require('urijs');
+
+var gemspec = JSON.parse(execSync('bundle exec parse-gemspec-cli restore_bundled_with.gemspec'));
+var homepageUrl = gemspec.homepage;
+var url = new URI(homepageUrl);
+var host = url.protocol() + '://' + url.authority();
+var owner = url.pathname().split('/')[1];
+var repository = url.pathname().split('/')[2];
+
+module.exports = {
+  version: gemspec.version,
+  host: host,
+  owner: owner,
+  repository: repository
+};

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+<a name="1.0.0"></a>
+# [1.0.0](https://github.com/packsaddle/ruby-restore_bundled_with/compare/v0.3.0...v1.0.0) (2016-07-23)
+
+* Ship v1.0.0!
+
+
 <a name"0.3.0"></a>
 ## 0.3.0 (2015-06-22)
 

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in restore_bundled_with.gemspec
 gemspec
+
+gem 'rubocop'
+gem 'byebug' if RUBY_VERSION >= '2.0.0'
+gem 'parse_gemspec-cli'
+gem 'yard'

data/README.md

@@ -1,9 +1,8 @@
 # RestoreBundledWith
 
-[![Gem Version](http://img.shields.io/gem/v/restore_bundled_with.svg?style=flat)](http://badge.fury.io/rb/restore_bundled_with)
-[![Build Status](http://img.shields.io/travis/packsaddle/ruby-restore_bundled_with/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-restore_bundled_with)
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
 
-Restore `BUNDLED WITH` section in `Gemfile.lock` from git repository.
+> Restore `BUNDLED WITH` section in `Gemfile.lock` from git repository.
 
 ```text
 # Gemfile.lock
@@ -111,6 +110,19 @@ $ git diff
 
 There is no diff, because this restores `BUNDLED WITH` from git repository.
 
+### Call from Ruby script
+
+```ruby
+system(*['bundle', 'update'])
+
+# restore_bundled_with
+lock_file_contents = File.read('Gemfile.lock')
+lock = RestoreBundledWith::Lock.restore(lock_file_contents, 'Gemfile.lock')
+File.write('Gemfile.lock', lock.body)
+```
+
+There is no diff, because this restores `BUNDLED WITH` from git repository.
+
 ## Requirement
 
 * Git
@@ -162,6 +174,10 @@ Or install it yourself as:
 
     $ gem install restore_bundled_with
 
+## Changelog
+
+[CHANGELOG.md](./CHANGELOG.md).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -177,3 +193,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/packsa
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+[travis-url]: https://travis-ci.org/packsaddle/ruby-restore_bundled_with
+[travis-image]: https://img.shields.io/travis/packsaddle/ruby-restore_bundled_with/master.svg?style=flat-square&label=build%20%28linux%29
+[gem-url]: https://rubygems.org/gems/restore_bundled_with
+[gem-image]: http://img.shields.io/gem/v/restore_bundled_with.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/restore_bundled_with
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -7,3 +7,12 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+DOC_FILES = ['lib/**/*.rb'].freeze
+DOC_OPTIONS = ['--debug', '--verbose'].freeze
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+  t.options = DOC_OPTIONS if Rake.application.options.trace
+end

data/lib/restore_bundled_with.rb

@@ -6,8 +6,9 @@ require 'restore_bundled_with/lock'
 require 'restore_bundled_with/repository'
 require 'restore_bundled_with/version'
 
+# Restore BUNDLED WITH section in Gemfile.lock from git repository.
 module RestoreBundledWith
-  ISSUE_URL = 'https://github.com/packsaddle/ruby-restore_bundled_with/issues/new'
+  ISSUE_URL = 'https://github.com/packsaddle/ruby-restore_bundled_with/issues/new'.freeze
   def self.default_logger
     logger = Logger.new(STDERR)
     logger.progname = "RestoreBundledWith #{VERSION}"

data/lib/restore_bundled_with/cli.rb

@@ -78,7 +78,8 @@ module RestoreBundledWith
                   .fetch_file(
                     options[:lockfile],
                     options[:ref],
-                    options[:new_line])
+                    options[:new_line]
+                  )
       puts Lock
         .new(lock_file)
         .pick
@@ -101,7 +102,7 @@ module RestoreBundledWith
 
         logger.info('input data')
         logger.info(data)
-        fail NoInputError if !data || data.empty?
+        raise NoInputError if !data || data.empty?
 
         data
       end

data/lib/restore_bundled_with/lock.rb

@@ -1,9 +1,16 @@
 module RestoreBundledWith
+  # The lock file
   class Lock
     attr_reader :body
+    # @!attribute [r] body
+    #   @return [String] file body
 
     REGEX_BUNDLED_WITH = /^(?<pick>(?:\r\n|\r|\n)^BUNDLED WITH.*(?:\r\n|\r|\n).+(?:\r\n|\r|\n))/
 
+    # @param text [String] base lock file
+    # @param section [String] appending section
+    #
+    # @return [Lock] the lock file instance
     def self.insert(text, section)
       if section && !section.empty?
         new(text + section)
@@ -12,6 +19,14 @@ module RestoreBundledWith
       end
     end
 
+    # @param data [String] before restore
+    # @param lockfile [String] file name
+    # @param ref [String] git ref
+    # @param git_path [String] git repository path
+    # @param git_options [Hash] ruby-git options
+    # @param new_line [String] new line
+    #
+    # @return [Lock] the lock file instance
     def self.restore(
       data,
       lockfile = Repository::LOCK_FILE,
@@ -29,15 +44,22 @@ module RestoreBundledWith
       insert(trimmed.body, section)
     end
 
+    # @param text [String] the lock file contents
+    #
+    # @return [Lock] the lock file instance
     def initialize(text)
       @body = text
     end
 
-    # "\n\nBUNDLED WITH\n   1.10.4\n" => "\n"
+    # @example delete bundled with
+    #   "\n\nBUNDLED WITH\n   1.10.4\n" => "\n"
+    #
+    # @return [Lock] new lock file instance which is deleted bundled with
     def delete_bundled_with
       self.class.new(body.sub(REGEX_BUNDLED_WITH) { '' })
     end
 
+    # @return [String] pick target section
     def pick
       match = REGEX_BUNDLED_WITH.match(body)
       if match
@@ -47,10 +69,14 @@ module RestoreBundledWith
       end
     end
 
+    # @return [String] the lock file contents
     def to_s
       body
     end
 
+    # @param [#body] other compare body
+    #
+    # @return [Boolean] true if file body is same
     def ==(other)
       body == other.body
     end

data/lib/restore_bundled_with/repository.rb

@@ -1,20 +1,31 @@
 module RestoreBundledWith
+  # The git repository
   class Repository
-    LOCK_FILE = 'Gemfile.lock'
-    REF = 'HEAD'
-    GIT_PATH = '.'
-    GIT_OPTIONS = {}
-    NEW_LINE = "\n"
+    LOCK_FILE = 'Gemfile.lock'.freeze
+    REF = 'HEAD'.freeze
+    GIT_PATH = '.'.freeze
+    GIT_OPTIONS = {}.freeze
+    NEW_LINE = "\n".freeze
 
+    # @param git_path [String] git repository path
+    # @param git_options [Hash] ruby-git options
+    #
+    # @return [Repository] Repository instance
     def initialize(git_path = GIT_PATH, git_options = GIT_OPTIONS)
       @git_path = git_path
       @git_options = git_options
     end
 
+    # @return [Git::Base] ruby-git object
     def git
       @git ||= Git.open(@git_path, @git_options)
     end
 
+    # @param file [String] target file
+    # @param ref [String] git ref
+    # @param new_line [String] file's ending new line
+    #
+    # @return [String] target file contents
     def fetch_file(file = LOCK_FILE, ref = REF, new_line = NEW_LINE)
       # NOTE: git.cat_file trims last \n?
       text = git.cat_file("#{ref}:#{file}")

data/lib/restore_bundled_with/version.rb

@@ -1,3 +1,3 @@
 module RestoreBundledWith
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'.freeze
 end

data/restore_bundled_with.gemspec

@@ -21,9 +21,9 @@ RestoreBundledWith solves these conflicts.
 
   spec.files         = \
     `git ls-files -z`
-      .split("\x0")
-      .reject { |f| f.match(%r{^(test|spec|features)/}) }
-      .reject do |f|
+    .split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+    .reject do |f|
       [
         '.rubocop.yml',
         '.rubocop_todo.yml',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restore_bundled_with
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -109,6 +109,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -118,7 +119,6 @@ files:
 - RELEASE.md
 - Rakefile
 - bin/console
-- bin/conventional-changelog.js
 - bin/run-rubocop.sh
 - bin/setup
 - exe/restore-bundled-with
@@ -149,8 +149,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Restore BUNDLED WITH section in Gemfile.lock from git repository.
 test_files: []
+has_rdoc: 

data/bin/conventional-changelog.js

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-
-var fs = require('fs');
-var execSync = require('child_process').execSync;
-var conventionalChangelog = require('conventional-changelog');
-
-var repo = 'https://github.com/packsaddle/ruby-restore_bundled_with'
-var version = "" + execSync('bundle exec exe/restore-bundled-with version --digit');
-
-conventionalChangelog({
-  repository: repo,
-  version: version,
-  file: 'CHANGELOG.md'
-}, function(err, log) {
-  fs.writeFile('CHANGELOG.md', log, function(err){
-    console.log(err);
-  });
-  console.log('Here is your changelog!', log);
-});