guard-annotate_gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e18304b59c1c57f9d8480ed57a40719a335e223
+  data.tar.gz: 2112ed9b27d4b3c1fd116e7c0aafa9611f1b9f5c
+SHA512:
+  metadata.gz: 0d33c4ce73d575ee167840b4965e3d5d2d2ee82ce21c28956cf033309161d840e4f68f3991f1333fda76168e4ba5ba450df32ee689fd2733c619456b98f490db
+  data.tar.gz: 9de70696578168a421b16d960f9d7b0f46453366c8fc08a0e63eb7b110044c20336cc3dd1335a716de43e0a4ed68544c13dd757638e45bc4b62c9244bef6899f

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Marchlík
+
+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,57 @@
+# Guard::AnnotateGem
+Guard plugin for [annotate_gem](https://github.com/ivantsepp/annotate_gem) gem.
+Guard::AnnotateGem automatically annotate your gems on update.
+
+## Installation
+
+Please ensure you have [Guard](http://github.com/guard/guard) installed before you continue.
+
+Add the following to your application's Gemfile:
+```ruby
+group :development do
+  gem 'guard-annotate_gem', require: false
+end
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Add Guard::AnnotateGem to your Guardfile by running:
+```
+$ guard init annotate_gem
+```
+
+Alternatively, install it without bundler:
+```
+$ gem install guard-annotate_gem
+```
+
+## Usage
+
+Please refer to the [Guard usage doc](http://github.com/guard/guard#readme)
+
+## Example Guardfile
+
+```ruby
+guard 'annotate_gem', inline: true do
+  watch('Gemfile.lock')
+end
+```
+
+## Options
+
+### List of available options
+
+```ruby
+inline: true              # put comments inline, instead of an above the gem line
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/unodor/guard-annotate_gem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "guard/annotate_gem"
+
+# 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/guard-annotate_gem.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/annotate_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guard-annotate_gem'
+  spec.version       = Guard::AnnotateGemVersion::VERSION
+  spec.authors       = ['Daniel Marchlik']
+  spec.email         = ['marchlik@unodor.cz']
+  spec.homepage      = 'https://github.com/unodor/guard-annotate_gem'
+  spec.summary       = 'Guard plugin for annotate_gem'
+  spec.description   = 'Guard::AnnotateGem automatically annotate your gems on update.'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'guard',        '~> 2.0'
+  spec.add_dependency 'guard-compat', '~> 1.1'
+  spec.add_dependency 'annotate_gem', '~> 0.0.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/guard/annotate_gem.rb

@@ -0,0 +1,42 @@
+require 'guard/compat/plugin'
+
+module Guard
+  class AnnotateGem < Plugin
+    def run_on_modifications(paths)
+      annotate
+    end
+
+    def inline?
+      options[:inline] == true
+    end
+
+    private
+
+    def annotate
+      result = annotate_gem
+      case result
+      when :gems_annotated
+        Guard::Compat::UI.info 'Gems annotated', reset: true
+      else
+        Guard::Compat::UI.info "Gems can't be annotated -- Please check manually", reset: true
+      end
+
+      result
+    end
+
+    def annotate_gem
+      Guard::Compat::UI.info 'Annotating gems...', reset: true
+      ::Bundler.with_clean_env do
+        system("bundle exec annotate_gem #{options_flags}")
+      end
+      $CHILD_STATUS == 0 ? :gems_annotated : false
+    end
+
+    def options_flags
+      output = ''
+      output += ' --inline' if inline?
+
+      output
+    end
+  end
+end

data/lib/guard/annotate_gem/templates/Guardfile

@@ -0,0 +1,3 @@
+guard 'annotate_gem', inline: true do
+  watch('Gemfile.lock')
+end

data/lib/guard/annotate_gem/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module AnnotateGemVersion
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: guard-annotate_gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Marchlik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: annotate_gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !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'
+description: Guard::AnnotateGem automatically annotate your gems on update.
+email:
+- marchlik@unodor.cz
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guard-annotate_gem.gemspec
+- lib/guard/annotate_gem.rb
+- lib/guard/annotate_gem/templates/Guardfile
+- lib/guard/annotate_gem/version.rb
+homepage: https://github.com/unodor/guard-annotate_gem
+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: Guard plugin for annotate_gem
+test_files: []
+has_rdoc: