annotate_gemfile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d6df8a2966507b6ef6454428ed6e4a5afc73eb4
+  data.tar.gz: 9e0b6e96543613e8c6570db50321359df37b2c42
+SHA512:
+  metadata.gz: 399e5caa85e7983443e7e283817eaeb068f226058716835c5deaf0448d61402a8139ff1eba2b78f43703094a217046dbf947b984c185e73b341e77db2eadcedf
+  data.tar.gz: 7e2570432a150799dd8336a0aea8da1de6e54d0c990c39f6c07ef2c0515bfd649d62cd98499594f17e5ba1445886bb1d61258a3ad1289524663c2d176c21c7f8

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.1.6
+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 annotate_gemfile.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,59 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end

data/README.md

@@ -0,0 +1,27 @@
+[![Build Status](https://travis-ci.org/jakeonrails/annotate_gemfile.svg?branch=master)](https://travis-ci.org/jakeonrails/annotate_gemfile)
+
+# AnnotateGemfile
+
+This tool will hit the API at Rubygems and get a description for each gem listed in your project's Gemfile, and add that description as a comment above that gem.
+
+## Installation
+
+First install the gem:
+
+    $ gem install annotate_gemfile
+
+## Usage
+
+Inside a Ruby project directory with a Gemfile, execute:
+
+    $ annotate-gemfile
+
+## 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/jakeonrails/annotate_gemfile.

data/Rakefile

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

data/annotate_gemfile.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'annotate_gemfile/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "annotate_gemfile"
+  spec.version       = AnnotateGemfile::VERSION
+  spec.authors       = ["Jake Moffatt"]
+  spec.email         = ["jakeonrails@gmail.com"]
+
+  spec.summary       = %q{Adds gem descriptions from Rubygems to every gem in the Gemfile}
+  spec.description   = %q{Adds gem descriptions from Rubygems to every gem in the Gemfile}
+  spec.homepage      = "https://github.com/jakeonrails/annotate_gemfile"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['annotate-gemfile']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "gems"
+  spec.add_dependency "ruby-progressbar"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "pry-byebug"
+end

data/bin/annotate-gemfile

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "annotate_gemfile"
+
+filename = ARGV[0] || 'Gemfile'
+AnnotateGemfile::Annotator.new.annotate(filename)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "annotate_gemfile"
+
+# 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/lib/annotate_gemfile/annotator.rb

@@ -0,0 +1,112 @@
+require 'gems'
+require 'ruby-progressbar'
+
+require 'awesome_print'
+
+module AnnotateGemfile
+  class Annotator
+
+    COMMENT = /^#.*/
+    BEGIN_COMMENT = /^=begin/
+    END_COMMENT = /^=end/
+    GEM_DECLARATION = /^gem\s+/
+    GEM_NAME = /gem\s+[('"]([^'")]+)/
+    BLANK_LINE = /^\s*$/
+
+    def initialize
+      @block_comment = false
+      @progress = ProgressBar.create
+    end
+
+    def annotate(filename)
+      lines = File.readlines(filename)
+      gem_count = lines.count { |line| line.strip =~ GEM_DECLARATION }
+
+      @progress = ProgressBar.create(total: gem_count,
+                                     format:  '%a %bᗧ%i %p%% %t %c/%C',
+                                     progress_mark:  ' ',
+                                     remainder_mark: '･')
+
+      annotated = annotate_lines(lines)
+      File.write("#{filename}.annotated", annotated.join("\n"))
+    end
+
+    def annotate_lines(lines)
+      output = lines.each_with_object([]) do |line, output|
+        annotated = Array(send(type_of(line), line))
+        output.concat annotated
+      end.flatten
+      output
+    end
+
+    def gem(line)
+      [
+        describe_gem(line),
+        line,
+        '',
+      ].compact.flatten.tap { @progress.increment }
+    end
+
+    def blank(line)
+      line.gsub("\n", '')
+    end
+
+    def comment(line)
+      line.gsub("\n", '')
+    end
+
+    def unknown(line)
+      line.gsub("\n", '')
+    end
+
+    def describe_gem(line)
+      indent = line[/\s*/].to_s
+      comment = indent + '# '
+      line_width = 80 - comment.length
+
+      gem_name = line[GEM_NAME, 1]
+      return unless description = gem_info_for(gem_name)
+      description = word_wrap(description, line_width).split("\n")
+      description.map {|d| comment + d.to_s }
+    end
+
+    def gem_info_for(gem_name)
+      return unless info = Gems.info(gem_name)
+      comment = info['info']
+      comment += " (#{info['source_code_uri']})" if info['source_code_uri']
+      comment
+    end
+
+    def word_wrap(text, line_width)
+      squish(text).split("\n").map do |line|
+        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
+      end.join
+    end
+
+    def type_of(line)
+      stripped = line.strip
+      return :comment if @block_comment && stripped !=~ /^=end/
+
+      case stripped
+      when COMMENT
+        :comment
+      when BEGIN_COMMENT || END_COMMENT
+        @block_comment = !@block_comment
+        :comment
+      when GEM_DECLARATION
+        :gem
+      when BLANK_LINE
+        :blank
+      else
+        :unknown
+      end
+    end
+
+    def squish(text)
+      text.gsub(/\A[[:space:]]+/, '')
+          .gsub(/[[:space:]]+\z/, '')
+          .gsub(/[[:space:]]+/, ' ')
+    end
+
+  end
+end

data/lib/annotate_gemfile/version.rb

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

data/lib/annotate_gemfile.rb

@@ -0,0 +1,5 @@
+require "annotate_gemfile/version"
+require 'annotate_gemfile/annotator'
+
+module AnnotateGemfile
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: annotate_gemfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jake Moffatt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds gem descriptions from Rubygems to every gem in the Gemfile
+email:
+- jakeonrails@gmail.com
+executables:
+- annotate-gemfile
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- annotate_gemfile.gemspec
+- bin/annotate-gemfile
+- bin/console
+- bin/setup
+- lib/annotate_gemfile.rb
+- lib/annotate_gemfile/annotator.rb
+- lib/annotate_gemfile/version.rb
+homepage: https://github.com/jakeonrails/annotate_gemfile
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Adds gem descriptions from Rubygems to every gem in the Gemfile
+test_files: []