bundler-commentate 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afb8cac7f4d14ddeda89be75adb7d228e5e1400db60644e58e6c71937091dd7d
+  data.tar.gz: 001b470ab78ef5a32c1a1adafd43c365b29ce40c88a7c83716ce0d38f448b89e
+SHA512:
+  metadata.gz: 3bc6b5613e3cdb26dc10de28d0e9f01f312ac4cd11cf2036d143e35fc2f60bebeac7639c3bb16d04aa46ff866502c025c285b671de05a996b6e20b45a36528e1
+  data.tar.gz: c48de3e57869376d1a5324abd28c83c428bcda7d9dd3934bf5d0269ddb1bdc49491ac6d2eab7bad38e20a0d1d37e62bfe4af4812861c299ab587f74316af9e58

data/.rubocop.yml

@@ -0,0 +1,60 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceBeforeComma:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-04
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bundler-commentate.gemspec
+gemspec
+
+gem "rake", "~> 13.0"	# "Rake is a Make-like program implemented in Ruby"
+
+gem "minitest", "~> 5.0"	# "minitest provides a complete suite of testing facilities supporting TDD, BDD, mocking, and benchmarking"
+
+gem "rubocop", "~> 1.7"	# "Automatic Ruby code style checking tool."
+gem "rubocop-minitest"	# "Automatic Minitest code style checking tool."
+gem "rubocop-rake"	# "A RuboCop plugin for Rake"
+
+plugin 'bundler-commentate', path: '.'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    bundler-commentate (0.2.0)
+      parser (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.2)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler-commentate!
+  minitest (~> 5.0)
+  pry (~> 0.14.1)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.2.27

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Frank J. Cameron
+
+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,82 @@
+# Bundler::Commentate
+
+Append gem summaries to a Gemfile.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+plugin 'bundler-commentate'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bundler-commentate
+
+## Usage
+
+```
+$ bundle commentate -h
+commentate [OPTIONS]
+    -i, --in-place                   Overwrite Gemfile
+    -g, --gemfile GEMFILE            Gemfile input,  "-" for STDIN;  default is "Gemfile"
+    -o, --outfile GEMFILE            Gemfile output, "-" for STDOUT; default is STDOUT
+    -v, --[no-]verbose               Run verbosely
+```
+
+### Example
+
+Read './Gemfile' and print annotated version to STDOUT:  `bundle commentate`
+
+```
+$ cat Gemfile
+# frozen_string_literal: true
+source 'https://rubygems.org'
+# Specify your gem's dependencies in bundler-commentate.gemspec
+gemspec
+gem 'rake', '~> 13.0'
+gem 'minitest', '~> 5.0'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-minitest'
+gem 'rubocop-rake'
+plugin 'bundler-commentate', path: '.'
+
+$ bundle commentate
+# frozen_string_literal: true
+source 'https://rubygems.org'
+# Specify your gem's dependencies in bundler-commentate.gemspec
+gemspec
+gem "rake", "~> 13.0"   # "Rake is a Make-like program implemented in Ruby"
+gem "minitest", "~> 5.0"        # "minitest provides a complete suite of testing facilities supporting TDD, BDD, mocking, and benchmarking"
+gem "rubocop", "~> 1.7" # "Automatic Ruby code style checking tool."
+gem "rubocop-minitest"  # "Automatic Minitest code style checking tool."
+gem "rubocop-rake"      # "A RuboCop plugin for Rake"
+plugin 'bundler-commentate', path: '.'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake test` 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 the created tag, and
+push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://gitlab.com/fjc/bundler-commentate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/commentate'
+
+# 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(__FILE__)

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/bundler-commentate.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bundler/commentate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bundler-commentate'
+  spec.version       = Bundler::Commentate::VERSION
+  spec.authors       = ['Frank J. Cameron']
+  spec.email         = ['fjc@fastmail.net']
+
+  spec.summary       = 'Bundler plugin to add gem summaries to a Gemfile'
+  spec.homepage      = 'https://gitlab.com/fjc/bundler-commentate'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'parser', '~> 3.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/bundler/commentate/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bundler
+  class Commentate < Bundler::Plugin::API
+    VERSION = '0.2.0'
+  end
+end

data/lib/bundler/commentate.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'commentate/version'
+
+require 'optparse'
+require 'parser/current'
+
+module Bundler
+  # Add gem summaries to a Gemfile.
+  class Commentate < Bundler::Plugin::API
+    command 'commentate'
+
+    def exec(command, args)
+      send command, args
+    end
+
+    private
+
+    def commentate(args)
+      OptionParser.new { |opts|
+        opts.banner = 'commentate [OPTIONS] [GEM, GEM, ...]'
+
+        opts.on('-i'         , '--in-place'     , 'Overwrite Gemfile'                                   )
+        opts.on('-g GEMFILE' , '--gemfile'      , 'Gemfile input,  "-" for STDIN;  default is "Gemfile"')
+        opts.on('-o GEMFILE' , '--outfile'      , 'Gemfile output, "-" for STDOUT; default is STDOUT'   )
+        opts.on('-v'         , '--[no-]verbose' , 'Run verbosely'                                       )
+      }.parse!(args, into: (opts={}))
+
+      raise OptionParser::ParseError.new('Conflicting options: in-place, output') if opts[:'in-place'] and opts[:output]
+
+      input  = _io_for(opts[:gemfile], 'r')
+      output = opts[:'in-place'] ? _io_for(opts[:gemfile]) : opts[:outfile] ? _io_for(opts[:outfile]) : _io_for('-')
+
+      _commentate(input, output)
+    rescue
+      raise Bundler::BundlerError.new($!)
+    end
+
+    # get IO for a file or stdio, default to r/w (append, create)
+    def _io_for(opt, mode='a+')
+      case opt
+      when nil
+        File.new('Gemfile', mode)
+      when '-'
+        Module.new do
+          def self.read(...);  $stdin .read(...); end
+          def self.print(...); $stdout.print(...); end
+          def self.truncate(...); end
+        end
+      when String
+        File.new(opt, mode)
+      end
+    end
+
+    def _commentate(input, output)
+      # "Weirich convention"
+      # Use { } for blocks that return values
+      # Use do / end for blocks that are executed for side effects
+      input.read.tap do output.truncate(0) end.lines.each { |line|
+        case Parser::CurrentRuby.parse(line).to_a
+        in [nil, :gem, gem, ver]
+          output.print _commentate_line(gem, ver)
+        in [nil, :gem, gem]
+          output.print _commentate_line(gem)
+        else
+          output.print line
+        end
+      }
+    end
+
+    def _commentate_line(gem, ver=nil)
+      g = gem.deconstruct[1]
+      v = ver.deconstruct[1] if ver
+      c = Gem.latest_spec_for(g).summary
+      "gem #{g.inspect}#{", #{v.inspect}" if ver}\t# #{c.inspect}\n"
+    end
+  end
+end

data/plugins.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/commentate'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: bundler-commentate
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Frank J. Cameron
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- fjc@fastmail.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bundler-commentate.gemspec
+- lib/bundler/commentate.rb
+- lib/bundler/commentate/version.rb
+- plugins.rb
+homepage: https://gitlab.com/fjc/bundler-commentate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/fjc/bundler-commentate
+  source_code_uri: https://gitlab.com/fjc/bundler-commentate
+  changelog_uri: https://gitlab.com/fjc/bundler-commentate
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Bundler plugin to add gem summaries to a Gemfile
+test_files: []