gem_polish 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08d511ff59f61a52d0659a211c8631480a549fdf
+  data.tar.gz: 3bf795407d78b9595ec17839c5cb4feb582e3216
+SHA512:
+  metadata.gz: 79bbce144eba9068f2bb8ee46a4791e41dd785e920aa730891bf9f6f797c4c120bf154a0aa583364c7f41f82ec40437c766e81c8ff61d1c5b843e3b1e2c08f05
+  data.tar.gz: 0e88b20d4232fb3ef73571cfbc30471fe49b7e1929c4e347f10817a46cea3443733a4d9af0b3b7d87a2a11b42a30f8d89b2e7e74d112e2fa5111f857d94a0f1c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 LFDM
+
+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 @@
+# GemPolish
+
+Further polishes your Bundler gem skeleton.
+
+## Installation
+
+    $ gem install gem_polish
+
+## Usage
+
+Provides two executables to improve your Bundler gem skeleton.
+
+- polish_gem
+
+Is meant to be used inside the directory a newly created gem (`bundle gem GEM_NAME`)
+Available options:
+
+|      Option      | Alias | Result |
+|:---------------- |:-----:| ------ |
+| `--description`    | `-d` | Takes a string and writes it to the gemspec and the README |
+| `--rspec_conf`     | `-r` | Adds additional rspec configuration, check `lib/templates` |
+| `--travis`         | `-t` | Takes several ruby versions travis will use |
+| `--coverage`       | `-c` | Adds coveralls to your gem |
+| `--badges`         | `-b` | Adds badge fury, gemnasium, travis, coveralls and code climate and/or badges to your README |
+| `--git_user`       | `-g` | Git user name used to link to your badges. Defaults to the information inside of your `.gitconfig` |
+| `--no_default`     | `-n` | Disables all default values provided in your `.gem_polish.yml` file |
+
+Unless `--no_default` is set, `polish_gem` will look into your home
+directory for a `.gem_polish.yml` file, that can provide default values
+for gem polishing. Check the `examples` folder for its formatting.
+
+* create_gem
+
+Combines gem creation and polishing:
+``` 
+create_gem my_new_gem
+```
+This will create the new gem `my_new_gem`. Arguments can be passed to
+override defaults or provide a description.
+```
+create_gem my_new_gem -d 'Does nothing so far'
+```
+At the moment he `bundle gem` command is invoked with `-t rspec` to
+provide the `rspec` test framework by default.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/gem_polish/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 new Pull Request

data/Rakefile

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

data/bin/create_gem

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'yaml'
+
+name = ARGV.shift
+# bundler_options are currently not used, maybe later
+#conf_file = "#{ENV['HOME']}/.gem_polish.yml"
+#conf = File.exists?(conf_file) ?
+  #YAML.load(File.read(conf_file))['bundler_options'].to_s : {}
+
+# hardcoding rspec as testframework
+conf = '-t rspec'
+
+b_command = "bundle gem #{name} #{conf}"
+p_command = "polish_gem #{name} #{ARGV.join(' ')}"
+g_command = "cd #{name} && git add -A"
+
+exec([b_command, p_command, g_command].join (' && '))
+

data/bin/polish_gem

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gem_polish'
+GemPolish::CLI.start([:polish] + ARGV)

data/examples/.gem_polish.yml

@@ -0,0 +1,15 @@
+coverage: true
+rspec_conf: true
+badges:
+  - badge_fury
+  - gemnasium
+  - travis
+  - coveralls
+  - code_climate
+travis:
+  before_script:
+    - "export JRUBY_OPTS=--2.0"
+  rvm:
+    - 2.1.0
+    - 2.0.0
+    - jruby-1.7.8

data/gem_polish.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gem_polish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem_polish"
+  spec.version       = GemPolish::VERSION
+  spec.authors       = ["LFDM"]
+  spec.email         = ["1986gh@gmail.com"]
+  spec.summary       = %q{Further polishes your bundler gem skeleton}
+  spec.description   = %q{Adds code coverage tools, badges in README, more ruby versions in travis etc.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "thor"
+end

data/gem_polish.thor

@@ -0,0 +1 @@
+require 'gem_polish'

data/lib/gem_polish/cli.rb

@@ -0,0 +1,144 @@
+require 'thor'
+require 'yaml'
+
+module GemPolish
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "polish", "polishes your gem"
+    method_option :badges, type: :array, aliases: '-b'
+    method_option :git_user, type: :string, aliases: '-g'
+    method_option :description, aliases: '-d'
+    method_option :coverage, aliases: '-c'
+    method_option :rspec_conf, aliases: '-r'
+    method_option :travis, type: :array, aliases: '-t'
+    method_option :no_default, aliases: '-n'
+    def polish(name = '.')
+      inside name do
+        default = options.has_key?('no_default') ? {} : def_conf
+
+        description = options[:description]
+        git_user_name = extract_git_user(options)
+        badges = parse_opt(:badges, options, default)
+        travis_opts = parse_opt(:travis, options, default)
+
+        insert_badges(badges, git_user_name, gem_name) if badges
+        insert_description(description) if description
+        insert_coveralls if parse_opt(:coverage, options, default)
+        insert_rspec_conf if parse_opt(:rspec_conf, options, default)
+        insert_travis(travis_opts) if travis_opts
+      end
+    end
+
+    no_commands do
+      def parse_opt(opt, opts, default)
+        opts[opt] || default[opt]
+      end
+
+      def extract_git_user(options)
+       user = options[:git_user] || `git config user.name`.chomp
+       user.empty? ? "TODO: Write your name" : user
+      end
+
+      def insert_description(description)
+        gsub_file(gemspec, /TODO:.*summary.*(?=})/, description)
+        gsub_file(readme, /TODO:.*gem description/, description)
+      end
+
+      BADGE_NAMES = {
+        'badge_fury' => 'Version',
+        'gemnasium' => 'Dependencies',
+        'travis' => 'Build Status',
+        'coveralls' => 'Coverage',
+        'code_climate' => 'Code Climate'
+      }
+
+      def insert_badges(badges, user, gem)
+        insert_into_file(readme, after: /^#\s.*\n/, force: false) do
+          "\n#{badges.map { |badge| badge_link(badge, user, gem) }.join("\n")}\n"
+        end
+      end
+
+      def badge_link(badge, user, gem)
+        path = "http://allthebadges.io/#{user}/#{gem}/#{badge}"
+        "[![#{BADGE_NAMES[badge]}](#{path}.png)](#{path})"
+      end
+
+      def insert_coveralls
+        prepend_file(spec_helper, read_template(:coveralls) + "\n")
+        add_dev_dependency('simplecov', '0.7')
+        append_file(gemfile, %{gem 'coveralls', require: false})
+      end
+
+      def insert_rspec_conf
+        append_file(spec_helper, "\n" + read_template(:rspec_configuration))
+      end
+
+      def insert_travis(opts)
+        say_status :rewrite, relative_destination(travis)
+        File.write(travis, YAML.dump(travis_content(opts)))
+      end
+
+      def travis_content(opts)
+        c = { 'language' => 'ruby'}
+        c.merge((opts.is_a?(Hash) ? opts : { 'rvm' => opts }))
+      end
+
+      def relative_destination(dest)
+        d = File.expand_path(dest, destination_root)
+        relative_to_original_destination_root(d)
+      end
+
+      def def_conf
+        conf_file = "#{ENV['HOME']}/.gem_polish.yml"
+        conf = File.exists?(conf_file) ? YAML.load(File.read(conf_file)) : {}
+        conf.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      end
+
+      def gem_name
+        File.basename(Dir.pwd)
+      end
+
+      def travis
+        ".travis.yml"
+      end
+
+      def spec_helper
+        "spec/spec_helper.rb"
+      end
+
+      def gemspec
+        "#{gem_name}.gemspec"
+      end
+
+      def gemfile
+        "Gemfile"
+      end
+
+      def readme
+        "README.md"
+      end
+
+      TEMPLATE_DIR = File.expand_path('../../templates', __FILE__)
+      def read_template(name)
+        File.read("#{TEMPLATE_DIR}/#{name}.template")
+      end
+
+      def add_dev_dependency(gem, version = nil)
+        total_size = File.size(gemspec)
+        pos_before_end = total_size - 4
+        insertion = %{  spec.add_development_dependency "#{gem}"}
+        return if File.read(gemspec).match(/#{insertion}/)
+        insertion << %{, "~> #{version}"} if version
+
+        say_status :append, relative_destination(gemspec)
+        File.open(gemspec, 'r+') do |file|
+          file.seek(pos_before_end, IO::SEEK_SET)
+          file.puts(insertion)
+          file.puts('end')
+        end
+      end
+    end
+  end
+end
+

data/lib/gem_polish/version.rb

@@ -0,0 +1,3 @@
+module GemPolish
+  VERSION = "0.0.1"
+end

data/lib/gem_polish.rb

@@ -0,0 +1,2 @@
+require "gem_polish/version"
+require "gem_polish/cli"

data/lib/templates/coveralls.template

@@ -0,0 +1,13 @@
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end

data/lib/templates/rspec_configuration.template

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/gem_polish_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe GemPolish do
+  it 'should have a version number' do
+    GemPolish::VERSION.should_not be_nil
+  end
+
+  it 'should do something useful' do
+    false.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'gem_polish'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: gem_polish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- LFDM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: thor
+  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'
+description: Adds code coverage tools, badges in README, more ruby versions in travis
+  etc.
+email:
+- 1986gh@gmail.com
+executables:
+- create_gem
+- polish_gem
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/create_gem
+- bin/polish_gem
+- examples/.gem_polish.yml
+- gem_polish.gemspec
+- gem_polish.thor
+- lib/gem_polish.rb
+- lib/gem_polish/cli.rb
+- lib/gem_polish/version.rb
+- lib/templates/coveralls.template
+- lib/templates/rspec_configuration.template
+- spec/gem_polish_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Further polishes your bundler gem skeleton
+test_files:
+- spec/gem_polish_spec.rb
+- spec/spec_helper.rb