bundler-commentator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2bc0b89269e07e8a5736ab1f6c163c41d903485
+  data.tar.gz: 5846ca588c0c07bce7670c073c0bf21f71f77fad
+SHA512:
+  metadata.gz: 21e0a0f0fae8381f941d9a5cf77e21509466a8479b6e38e7e541d40acd95ff79ae2a475640a000c5e2dac72b8e49a162960d72b6098388c94a0ba0bebe77f88d
+  data.tar.gz: b4e21374db36c94513e05375f9d21e0972081ea4c06c95af27f0241d6b14a88d3113d2c4b9955b69abbb4776fd11f7767685e3ca8bdc605220e31c482d478580

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kevin Traver
+
+MIT License
+
+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,52 @@
+# Bundler::Commentator
+
+> Automatically comment your Gems with descriptions from RubyGems
+
+One simple command turns this:
+
+```ruby
+gem 'rails', '4.2.0'
+gem 'sqlite3'
+gem 'sass-rails', '~> 5.0'
+```
+
+into this:
+
+```ruby
+# Ruby on Rails is a full-stack web framework optimized for programmer happiness
+# and sustainable productivity. It encourages beautiful code by favoring
+# convention over configuration.
+gem 'rails', '4.2.0'
+
+# This module allows Ruby programs to interface with the SQLite3
+# database engine (http://www.sqlite.org).  You must have the
+# SQLite engine installed in order to build this module.
+# Note that this module is only compatible with SQLite 3.6.16 or newer.
+gem 'sqlite3'
+
+# Sass adapter for the Rails asset pipeline.
+gem 'sass-rails', '~> 5.0'
+```
+
+## Installation
+
+```bash
+> gem install bundler-commentator
+```
+
+## Usage
+
+```bash
+> bundler-commentator
+```
+
+### Exisiting comments
+At the moment `bundler-commentator` doesn't remove existing comments, so I would
+highly recommend first using [bundler-reorganizer](https://github.com/wireframe/bundler-reorganizer) which organizes and cleans your Gemfile
+
+#### Options
+`--gemfile_path "path/to/Gemfile"`
+`--output_path "path/to/commented/Gemfile"`
+
+## TODO
+* Ability to leave existing comments

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/bundler-commentator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/bundler/commentator'
+Bundler::Commentator::new.run

data/bundler-commentator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bundler/commentator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bundler-commentator"
+  spec.version       = Bundler::Commentator::VERSION
+  spec.authors       = ["Kevin Traver"]
+  spec.email         = ["kevintraver@gmail.com"]
+  spec.summary       = %q{Automatically add comments to your Gems}
+  spec.description   = %q{Comment your Gemfile with descriptions from RubyGems.org}
+  spec.homepage      = "https://github.com/kevintraver/bundler-commentator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["bundler-commentator"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  spec.add_dependency "gems", '~> 0.8'
+  spec.add_dependency "commander", "~> 4.2"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/bundler/commentator/version.rb

@@ -0,0 +1,5 @@
+module Bundler
+  module Commentator
+    VERSION = "1.0.1"
+  end
+end

data/lib/bundler/commentator.rb

@@ -0,0 +1,68 @@
+require 'gems'
+require 'commander'
+
+module Bundler
+  class Commentator
+    include Commander::Methods
+
+    def run
+      program :name, 'bundler-commentator'
+      program :version, '1.0.0'
+      program :description, 'Comment your Gemfile with descriptions from RubyGems.org'
+
+      command :comment do |c|
+        c.syntax = '[options]'
+        c.description = 'comments Gemfile'
+        c.option '--gemfile_path STRING', String, 'Path to Gemfile'
+        c.option '--output_path STRING', String, 'Output Path'
+
+        c.action do |args, options|
+          options.default gemfile_path: 'Gemfile', output_path: 'Gemfile'
+          say "Reading Gemfile: #{options.gemfile_path}"
+          begin
+            open(options.gemfile_path)
+          rescue
+            raise RuntimeError, 'Error opening Gemfile'
+            exit
+          end
+          output_buffer = ''
+          File.open(options.gemfile_path "r") do |f|
+            f.each_line do |line|
+              begin
+                if (gem = instance_eval line)
+                  if !(description = get_description(gem)).empty?
+                    indentation = line[/\A */]
+                    output_buffer << "\n#{wrap(description,indentation)}"
+                  end
+                end
+              rescue Exception
+              end
+              output_buffer << line
+            end
+          end
+          say "Writing commented Gemfile to: #{options.output_path}"
+          File.open(options.output_path, 'w') {|file| file.write(output_buffer)}
+        end
+
+      end
+
+      default_command :comment
+      run!
+    end
+
+    def get_description(*args)
+      rubygems_info = Gems.info args[0].to_s
+      rubygems_info["info"].chomp
+    end
+
+    def wrap(s, indentation="", width=78)
+      s.gsub(/(.{1,#{width-indentation.size}})(\s+|\Z)/, "#{indentation}# \\1\n")
+    end
+
+    private
+
+    def gem(*args)
+      args[0]
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: bundler-commentator
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Kevin Traver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Comment your Gemfile with descriptions from RubyGems.org
+email:
+- kevintraver@gmail.com
+executables:
+- bundler-commentator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bundler-commentator
+- bundler-commentator.gemspec
+- lib/bundler/commentator.rb
+- lib/bundler/commentator/version.rb
+homepage: https://github.com/kevintraver/bundler-commentator
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Automatically add comments to your Gems
+test_files: []