generic_gem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75cf554db010518773c6fcc6526affc7bfd3dce5
+  data.tar.gz: bf2dd0eabfa2df632a0082338a87d94479b173a8
+SHA512:
+  metadata.gz: 024cca148efc7e0afc2bb0ea358bb18cc861a4a8518911d88780cb8ca3551690a1aa90a4bd76140c25bba7f4a368d97da98c4ea393f6178e8b1de94598b426a5
+  data.tar.gz: ce82253278060bab6a118694da730a3c597c265d2348b23becf72bc9f7bcfb798e056185f251ef1cc9c36405c92322969301a997208699544f271fe85ad062f1

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+/tmp*
+.DS_Store
+
+Gemfile.lock
+/log/
+gemsurance_report.html
+*.svg

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+Metrics/AbcSize:
+  Exclude:
+    - lib/generic_gem.rb
+
+Metrics/LineLength:
+  Exclude:
+    - bin/generic_gem
+    - generic_gem.gemspec
+    - lib/generic_gem.rb
+    - spec/generic_gem_spec.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/generic_gem.rb
+    
+Metrics/ModuleLength:
+  Exclude:
+    - lib/generic_gem.rb
+
+AllCops:
+  Exclude:
+    - tmp/**/*

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,81 @@
+[![Gem Version](https://badge.fury.io/rb/generic_gem.svg)](https://badge.fury.io/rb/generic_gem)
+[![Dependency Status](https://gemnasium.com/jhsu802701/generic_gem.svg)](https://gemnasium.com/jhsu802701/generic_gem)
+[![Build Status](https://travis-ci.org/jhsu802701/generic_gem.svg?branch=master)](https://travis-ci.org/jhsu802701/generic_gem)
+[![Code Climate](https://codeclimate.com/github/jhsu802701/generic_gem/badges/gpa.svg)](https://codeclimate.com/github/jhsu802701/generic_gem)
+[![Test Coverage](https://codeclimate.com/github/jhsu802701/generic_gem/badges/coverage.svg)](https://codeclimate.com/github/jhsu802701/generic_gem/coverage)
+
+# GenericGem
+
+Welcome to GenericGem!  The purpose of this gem is to streamline the process of creating a gem with Bundler.  
+
+## What's the point?
+I HATE having to jump through hoops just to take care of the generic details that are necessary for all or most Ruby gems.  Every time I have created a Ruby gem, there were numerous details that I had to remember to do.  The generic aspects of a gem are fully automated to minimize the drudgery so that you have more time available to work on the capabilities that make your Ruby gem unique.
+
+## Prerequisites for Understanding GenericGem
+You should be familiar with the process of building a Ruby gem.  Some good resources are:
+
+    https://quickleft.com/blog/engineering-lunch-series-step-by-step-guide-to-building-your-first-ruby-gem/
+    http://rakeroutes.com/blog/lets-write-a-gem-part-one/
+    http://rakeroutes.com/blog/lets-write-a-gem-part-two/
+    http://guides.rubygems.org/make-your-own-gem/
+    
+## How does GenericGem work?
+GenericGem uses the bundle command to begin the process of creating a gem.  Additionally, it adds a number of enhancements needed by all or most Ruby gems.  These changes are:
+
+* The Code of Conduct and MIT license are automatically included.  (It's easier to remove them than to remember to add them.)
+* Your name is automatically filled in the file LICENSE.txt and in the gemspec file.
+* The gem description in the gemspec file is "GENERIC DESCRIPTION" to enable the "rake install" command.
+* The gem summary in the gemspec file is "GENERIC SUMMARY" to enable the "rake install" command.
+* Your email address is automatically provided in the gemspec file.
+* RSpec testing is automatically included and installed.  Your gem will pass the initial meaningless tests.
+* The version number is set to 0.0.0.
+* The bin/console and bin/setup script files are made executable.
+* A working Rakefile is provided.
+* The gem_test.sh script is added to the gem's root directory.  This is the 1-step test procedure that executes the bin/setup script (which includes the "bundle install" command) AND the command "rake".  Just enter the command "sh gem_test.sh" command to start the process.  When you clone your gem's source code onto a machine with a fresh Ruby on Rails installation, running the gem_test.sh script should confirm that all of the details needed to make your gem work are complete.
+* The .gitignore file includes .DS_Store and the directories tmp and tmp*.
+* Instructions on using the gem_test.sh and gem_console.sh scripts are included in the README.md file.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'generic_gem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install generic_gem
+
+## Usage
+
+Just enter the command "generic_gem".  When prompted, provide the name of your new gem, your name, and your email address.  Your new gem will be automatically created AND tested.  The initial meaningless tests will pass.
+
+## Development
+
+### Testing this gem
+
+After cloning this source code, cd your way into this directory and enter the command `sh gem_test.sh`.  Note that this script also runs the code_test.sh and gem_install.sh scripts.
+
+### Testing this gem's source code
+Enter the command `sh code_test.sh` to test the quality of the source code.
+
+### Running this gem in irb
+Enter the command `sh gem_console.sh`.
+
+### Installing this gem
+
+Enter the command `sh gem_install.sh`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/generic_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,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec
+
+# TEST GEM: Enter "rake".
+# INSTALL GEM: Enter "rake install".

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'generic_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/generic_gem

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'generic_gem'
+
+puts '***********************'
+puts 'Welcome to Generic Gem!'
+puts
+puts 'DEFAULT VALUE: tmp1'
+puts 'Enter the name of the gem you wish to create:'
+subdir_name = gets.chomp
+subdir_name = 'tmp1' if subdir_name == ''
+
+puts
+puts 'DEFAULT VALUE: Marie Curie'
+puts 'Enter your name:'
+your_name = gets.chomp
+your_name = 'Marie Curie' if your_name == ''
+
+puts
+puts 'DEFAULT VALUE: mcurie@example.com'
+puts 'Enter your email address:'
+your_email = gets.chomp
+your_email = 'mcurie@example.com' if your_email == ''
+
+GenericGem.create(subdir_name, your_name, your_email)
+system("cd #{subdir_name} && sh gem_test.sh")
+
+puts
+puts '******************************'
+puts 'Your new gem is ready to roll.'
+puts "GEM NAME: #{subdir_name}"
+puts "YOUR NAME: #{your_name}"
+puts "YOUR EMAIL: #{your_email}"
+puts "Please remember to fill in the rest of your #{subdir_name}.gemspec file."
+puts 'You still need to provide a gem summary, a gem description, and a homepage.'
+puts 'You also need to remove the metadata section.'
+puts

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/code_test.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+DIR_GENERIC_GEM=$PWD
+DIR_PARENT="${PWD%/*}"
+mkdir -p log
+rm -rf tmp
+
+echo '--------------'
+echo 'bundle install'
+bin/setup >/dev/null
+
+echo
+echo '-------'
+echo 'rubocop'
+rubocop
+
+echo
+echo '-----------'
+echo 'sandi_meter'
+sandi_meter
+
+echo
+echo '------------'
+echo 'bundle-audit'
+bundle-audit
+
+echo '----------------------------------------------'
+echo 'gemsurance --output log/gemsurance_report.html'
+gemsurance --output log/gemsurance_report.html
+echo 'Gemsurance Report: log/gemsurance_report.html'
+
+echo '------------------------------------------------------------------------'
+echo 'bundle viz --file=log/diagram-gems --format=svg --requirements --version'
+bundle viz --file=log/diagram-gems --format=svg --requirements --version
+echo 'Gem dependency diagram: log/diagram-gems.svg'

data/gem_console.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+bin/setup
+bin/console

data/gem_install.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+gem uninstall generic_gem
+
+echo '--------------'
+echo 'bundle install'
+bin/setup >/dev/null
+
+echo '------------'
+echo 'rake install'
+rake install

data/gem_test.sh

@@ -0,0 +1,77 @@
+#!/bin/bash
+
+gem uninstall generic_gem
+
+DIR_GENERIC_GEM=$PWD
+DIR_PARENT="${PWD%/*}"
+DIR_TMP=$DIR_PARENT/tmp
+
+FILE_LOG_MAIN=$DIR_GENERIC_GEM/log/1-test-gem-main.log
+FILE_LOG_TMP=$DIR_GENERIC_GEM/log/2-test-gem-tmp.log
+
+FILE_LOG_MAIN_CODE=$DIR_GENERIC_GEM/log/3-test-code-main.log
+FILE_LOG_TMP_CODE=$DIR_GENERIC_GEM/log/4-test-code-tmp.log
+
+FILE_LOG_MAIN_INSTALL=$DIR_GENERIC_GEM/log/5-install-main.log
+FILE_LOG_TMP_INSTALL=$DIR_GENERIC_GEM/log/6-install-tmp.log
+
+mkdir -p $DIR_GENERIC_GEM/log
+
+echo '--------------'
+echo 'bundle install'
+bin/setup >/dev/null
+
+echo '*************************'
+echo 'BEGIN TESTING generic_gem'
+rake 2>&1 | tee $FILE_LOG_MAIN
+echo 'FINISHED TESTING generic_gem'
+echo '****************************'
+
+echo '******************************'
+echo 'BEGIN TESTING THE tmp RUBY GEM'
+DIR_PARENT="${PWD%/*}"
+DIR_TMP="$DIR_PARENT/tmp"
+cd $DIR_TMP && sh gem_test.sh 2>&1 | tee $FILE_LOG_TMP
+echo 'FINISHED TESTING THE tmp RUBY GEM'
+echo '*********************************'
+
+echo '******************************'
+echo 'BEGIN TESTING generic_gem CODE'
+cd $DIR_GENERIC_GEM && sh code_test.sh 2>&1 | tee $FILE_LOG_MAIN_CODE
+echo 'FINISHED TESTING generic_gem CODE'
+echo '*********************************'
+
+echo "******************************"
+echo "BEGIN TESTING THE tmp CODE"
+cd $DIR_TMP && sh code_test.sh | tee $FILE_LOG_TMP_CODE
+echo 'FINISHED TESTING THE tmp CODE'
+echo '*********************************'
+
+echo '****************************'
+echo 'BEGIN INSTALLING generic_gem'
+cd $DIR_GENERIC_GEM && sh gem_install.sh 2>&1 | tee $FILE_LOG_MAIN_INSTALL
+echo 'FINISHED INSTALLING generic_gem'
+echo '*******************************'
+
+echo '****************************'
+echo 'BEGIN INSTALLING THE tmp GEM'
+cd $DIR_TMP && sh gem_install.sh | tee $FILE_LOG_TMP_INSTALL
+echo 'FINISHED INSTALLING THE tmp GEM'
+echo '*******************************'
+
+echo 'The results of gem_test.sh are logged at:'
+echo $FILE_LOG_MAIN
+echo $FILE_LOG_TMP
+echo $FILE_LOG_MAIN_CODE
+echo $FILE_LOG_TMP_CODE
+echo $FILE_LOG_MAIN_INSTALL
+echo $FILE_LOG_TMP_INSTALL
+echo
+echo "Gemsurance Report (main app): $DIR_GENERIC_GEM/log/gemsurance_report.html"
+echo "Gem dependency diagram (main app): $DIR_GENERIC_GEM/log/diagram-gems.svg"
+echo
+echo "Gemsurance Report (tmp app): $DIR_TMP/log/gemsurance_report.html"
+echo "Gem dependency diagram (tmp app): $DIR_TMP/log/diagram-gems.svg"
+echo
+echo 'If all went well, there are no error messages and no failed tests.'
+echo

data/generic_gem.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generic_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'generic_gem'
+  spec.version       = GenericGem::VERSION
+  spec.authors       = ['Jason Hsu']
+  spec.email         = ['rubyist@jasonhsu.com']
+
+  spec.summary       = 'GenericGem streamlines the process of starting a new Ruby gem.'
+  spec.description   = 'GenericGem executes the bundle command but fills in important but easily forgotten details.'
+  spec.homepage      = 'https://github.com/jhsu802701/generic_gem'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = 'generic_gem'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.8'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sandi_meter'
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'gemsurance'
+  spec.add_development_dependency 'ruby-graphviz'
+
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'string_in_file'
+  spec.add_runtime_dependency 'replace_quotes'
+end

data/lib/files_to_add/README-to_do.txt

@@ -0,0 +1,6 @@
+BADGES for README.md
+* Version Badge: http://badge.fury.io/
+* Gemnasium: https://gemnasium.com/
+* Travis CI: https://travis-ci.org/ (SPECIAL NOTE: There are incorrect procedures out there.  You must go into your Travis CI settings and add the Code Climate repository token as an environment variable.)
+* Code Climate: https://codeclimate.com/
+* Hakiri: https://hakiri.io/

data/lib/files_to_add/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec
+
+# TEST GEM: Enter "rake".
+# INSTALL GEM: Enter "rake install".

data/lib/files_to_add/all.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+mkdir -p log
+FILE_TEST_GEM='log/1-test-gem.log'
+FILE_TEST_CODE='log/2-test-code.log'
+FILE_INSTALL_GEM='log/3-install-gem.log'
+sh gem_test.sh 2>&1 | tee $FILE_TEST_GEM
+sh code_test.sh 2>&1 | tee $FILE_TEST_CODE
+sh gem_install.sh 2>&1 | tee $FILE_INSTALL_GEM
+
+echo 'Results are logged in:'
+echo $FILE_TEST_GEM
+echo $FILE_TEST_CODE
+echo $FILE_INSTALL_GEM
+echo
+echo 'Gemsurance Report: log/gemsurance_report.html'
+echo 'Gem dependency diagram: log/diagram-gems.svg'

data/lib/files_to_add/code_test.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+DIR_PARENT="${PWD%/*}"
+DIR_TMP="$DIR_PARENT/tmp"
+mkdir -p log
+rm -rf tmp
+
+echo '--------------'
+echo 'bundle install'
+bin/setup >/dev/null
+
+echo
+echo '-------'
+echo 'rubocop'
+rubocop
+
+echo
+echo '-----------'
+echo 'sandi_meter'
+sandi_meter
+
+echo
+echo '------------'
+echo 'bundle-audit'
+bundle-audit
+
+echo '----------------------------------------------'
+echo 'gemsurance --output log/gemsurance_report.html'
+gemsurance --output log/gemsurance_report.html
+echo 'Gemsurance Report: log/gemsurance_report.html'
+
+echo '------------------------------------------------------------------------'
+echo 'bundle viz --file=log/diagram-gems --format=svg --requirements --version'
+bundle viz --file=log/diagram-gems --format=svg --requirements --version
+echo 'Gem dependency diagram: log/diagram-gems.svg'

data/lib/files_to_add/config

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+---
+BUNDLE_GEM__COC: true
+BUNDLE_GEM__MIT: true
+BUNDLE_GEM__TEST: rspec

data/lib/files_to_add/gem_console.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# uninstall
+bin/setup
+bin/console

data/lib/files_to_add/gem_install.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# uninstall
+bin/setup
+rake install

data/lib/files_to_add/gem_test.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# uninstall
+bin/setup
+echo '-----------------'
+echo 'BEGIN TESTING gem'
+rake
+echo 'FINISHED TESTING gem'
+echo '--------------------'

data/lib/files_to_add/rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/LineLength:
+  Exclude:
+    - gemspec_file

data/lib/generic_gem.rb

@@ -0,0 +1,221 @@
+require 'generic_gem/version'
+require 'string_in_file'
+require 'replace_quotes'
+
+#
+module GenericGem
+  def self.create(gem_name, your_name, your_email)
+    puts '**********************'
+    puts 'Welcome to Generic Gem'
+    puts "GEM NAME: #{gem_name}"
+    puts "YOUR NAME: #{your_name}"
+    puts "YOUR EMAIL: #{your_email}"
+    ENV['DIR_MAIN'] = File.expand_path('../../', __FILE__)
+
+    bundle_config
+    bundle_gem(gem_name)
+    update_version(gem_name)
+    add_name(gem_name, your_name)
+    update_gemspec(gem_name, your_email)
+    add_gem_dep(gem_name, 'rubocop')
+    add_gem_dep(gem_name, 'sandi_meter')
+    add_gem_dep(gem_name, 'bundler-audit')
+    add_gem_dep(gem_name, 'gemsurance')
+    add_gem_dep(gem_name, 'ruby-graphviz')
+    add_gem_dep(gem_name, 'simplecov')
+    update_spec_helper(gem_name)
+    update_tests(gem_name)
+    update_bin_scripts(gem_name)
+    add_rakefile(gem_name)
+    add_readme_todo(gem_name)
+    add_bash_scripts(gem_name)
+    update_gitignore(gem_name)
+    update_readme(gem_name)
+    update_main_module(gem_name)
+    add_rubocop_yml(gem_name)
+    reset_git(gem_name)
+  end
+
+  def self.bundle_config
+    puts '----------------------------------------'
+    puts "Setting up #{ENV['HOME']}/.bundle/config"
+    puts 'Includes the Code of Conduct (CODE_OF_CONDUCT.md file) and MIT license (LICENSE.txt file)'
+    puts 'Using rspec testing'
+    system("mkdir -p #{ENV['HOME']}/.bundle")
+    system("cp #{ENV['DIR_MAIN']}/lib/files_to_add/config #{ENV['HOME']}/.bundle/config")
+  end
+
+  def self.bundle_gem(gem_name)
+    t1 = Thread.new do
+      puts '--------------------'
+      puts 'Creating the new gem'
+      puts "bundle gem #{gem_name}"
+      system("bundle gem #{gem_name}")
+    end
+    t1.join
+  end
+
+  def self.update_version(gem_name)
+    puts '----------------------'
+    puts 'Initial version: 0.0.0'
+    StringInFile.replace('0.1.0', '0.0.0', "#{gem_name}/lib/#{gem_name}/version.rb")
+    ReplaceQuotes.update("#{gem_name}/lib/#{gem_name}/version.rb")
+    StringInFile.replace('module', "#\nmodule", "#{gem_name}/lib/#{gem_name}/version.rb")
+  end
+
+  def self.add_name(gem_name, your_name)
+    puts '-----------------------------------------------------------'
+    puts "Filling in your name in LICENSE.txt and #{gem_name}.gemspec"
+    puts "Your name: #{your_name}"
+    StringInFile.replace('TODO: Write your name', your_name, "#{gem_name}/LICENSE.txt")
+    StringInFile.replace('TODO: Write your name', your_name, "#{gem_name}/#{gem_name}.gemspec")
+  end
+
+  def self.update_gemspec(gem_name, your_email)
+    puts '----------------------------------------------------'
+    puts "Filling in your email address in #{gem_name}.gemspec"
+    StringInFile.replace('TODO: Write your email address', your_email, "#{gem_name}/#{gem_name}.gemspec")
+
+    puts '-----------------------------------------------------'
+    puts "Filling in the gem description in #{gem_name}.gemspec"
+    StringInFile.replace('TODO: Write a longer description or delete this line.', 'GENERIC DESCRIPTION', "#{gem_name}/#{gem_name}.gemspec")
+    StringInFile.replace('%q{GENERIC DESCRIPTION}', "'GENERIC DESCRIPTION'", "#{gem_name}/#{gem_name}.gemspec")
+
+    puts '-------------------------------------------------'
+    puts "Filling in the gem summary in #{gem_name}.gemspec"
+    StringInFile.replace('TODO: Write a short summary, because Rubygems requires one.', 'GENERIC SUMMARY', "#{gem_name}/#{gem_name}.gemspec")
+    StringInFile.replace('%q{GENERIC SUMMARY}', "'GENERIC SUMMARY'", "#{gem_name}/#{gem_name}.gemspec")
+
+    puts '---------------------------------------------------'
+    puts "Updating #{gem_name}.gemspec for RuboCop compliance"
+    ReplaceQuotes.update("#{gem_name}/#{gem_name}.gemspec")
+    StringInFile.replace("'\\x0'", '"\\x0"', "#{gem_name}/#{gem_name}.gemspec")
+
+    puts '--------------------------------------------------------------'
+    puts "Replace 'raise' in #{gem_name}/#{gem_name}.gemspec with 'fail'"
+    StringInFile.replace("raise 'RubyGems", "fail 'RubyGems", "#{gem_name}/#{gem_name}.gemspec")
+  end
+
+  def self.add_gem_dep(gem_name, gem_dep)
+    puts '----------------------------------------'
+    puts "Adding #{gem_dep} development dependency"
+    str1 = "spec.add_development_dependency 'rspec'"
+    str2 = "\n  spec.add_development_dependency '#{gem_dep}'"
+    str3 = "#{str1}#{str2}"
+    StringInFile.replace(str1, str3, "#{gem_name}/#{gem_name}.gemspec")
+  end
+
+  def self.update_spec_helper(gem_name)
+    puts '----------------------------'
+    puts 'Updating spec/spec_helper.rb'
+    file_new = "#{gem_name}/spec/spec_helper_new.rb"
+    file_old = "#{gem_name}/spec/spec_helper.rb"
+    open(file_new, 'a') do |f|
+      f << "require 'simplecov'\n"
+      f << "SimpleCov.start\n\n"
+      f << File.read(file_old)
+    end
+    system("mv #{file_new} #{file_old}")
+  end
+
+  def self.update_tests(gem_name)
+    puts '--------------------------------'
+    puts 'Revising the initial rspec tests'
+    StringInFile.replace('expect(false).to eq(true)', 'expect(true).to eq(true)', "#{gem_name}/spec/#{gem_name}_spec.rb")
+  end
+
+  def self.update_bin_scripts(gem_name)
+    puts '----------------------------------'
+    puts 'Updating bin/console and bin/setup'
+    ReplaceQuotes.update("#{gem_name}/bin/console")
+    system("chmod +x #{gem_name}/bin/*")
+  end
+
+  def self.add_rakefile(gem_name)
+    puts '-------------------'
+    puts 'Adding the Rakefile'
+    system("cp #{ENV['DIR_MAIN']}/lib/files_to_add/Rakefile #{gem_name}")
+  end
+
+  def self.add_readme_todo(gem_name)
+    puts '--------------------------------'
+    puts 'Adding the README-to_do.txt file'
+    system("cp #{ENV['DIR_MAIN']}/lib/files_to_add/README-to_do.txt #{gem_name}")
+  end
+
+  def self.add_bash_scripts(gem_name)
+    puts '-------------------'
+    puts 'Adding Bash scripts'
+    system("cp #{ENV['DIR_MAIN']}/lib/files_to_add/*.sh #{gem_name}")
+
+    puts '----------------------------------------------'
+    puts "Adding 'gem uninstall' command to Bash scripts"
+    str_old = '# uninstall'
+    str_new = "gem uninstall #{gem_name}"
+    StringInFile.replace(str_old, str_new, "#{gem_name}/code_test.sh")
+    StringInFile.replace(str_old, str_new, "#{gem_name}/gem_test.sh")
+    StringInFile.replace(str_old, str_new, "#{gem_name}/gem_install.sh")
+    StringInFile.replace(str_old, str_new, "#{gem_name}/gem_console.sh")
+  end
+
+  def self.update_gitignore(gem_name)
+    puts '----------------------------'
+    puts 'Updating the .gitignore file'
+    puts 'Adding tmp* and .DS_Store'
+    open("#{gem_name}/.gitignore", 'a') do |f|
+      f << "\nlog/"
+      f << "\ntmp*"
+      f << "\n.DS_Store"
+      f << "\n*.gem"
+    end
+  end
+
+  def self.update_readme(gem_name)
+    puts '---------------------------'
+    puts 'Updating the README.md file'
+    t1 = Thread.new do
+      file_w = open("#{gem_name}/README.md", 'a')
+      file_w.write("## Bash Scripts\n")
+      file_w.write("### Testing this gem\n")
+      file_w.write("After you download this source code, enter `sh gem_test.sh` to set up and test this gem.\n\n")
+      file_w.write("### Testing this gem's source code\n")
+      file_w.write("Enter `sh code_test.sh` to test the quality of this gem's source code.\n")
+      file_w.write("### Running this gem in irb\n")
+      file_w.write("Enter `sh gem_console.sh`.\n\n")
+      file_w.write("### Installing this gem\n")
+      file_w.write("Enter `sh gem_install.sh`.\n")
+      file_w.write("### Testing the gem, source code, and installation process\n")
+      file_w.write("Enter `sh all.sh` to run the gem_test.sh, code_test.sh, and gem_install.sh scripts.\n")
+      file_w.close
+    end
+    t1.join
+  end
+
+  def self.update_main_module(gem_name)
+    puts '--------------------------------------------------------------'
+    puts "Updating #{gem_name}/lib/#{gem_name}.rb to comply with RuboCop"
+    ReplaceQuotes.update("#{gem_name}/lib/#{gem_name}.rb")
+    StringInFile.replace('module', "#\nmodule", "#{gem_name}/lib/#{gem_name}.rb")
+
+    puts '-------------------------------------------------------------------------------'
+    puts "Adding the suggestion of using a class or module to the lib/#{gem_name}.rb file"
+    open("#{gem_name}/lib/#{gem_name}.rb", 'a') do |f|
+      f << "# Your new gem is a module by default.  You may wish to use a class instead.\n"
+    end
+  end
+
+  def self.add_rubocop_yml(gem_name)
+    puts '-------------------'
+    puts 'Adding .rubocop.yml'
+    system("cp #{ENV['DIR_MAIN']}/lib/files_to_add/rubocop.yml #{gem_name}/.rubocop.yml")
+    StringInFile.replace('gemspec_file', "#{gem_name}.gemspec", "#{gem_name}/.rubocop.yml")
+  end
+
+  def self.reset_git(gem_name)
+    puts '---------'
+    puts 'Reset Git'
+    system("cd #{gem_name} && git init")
+    system("cd #{gem_name} && git add .")
+    system("cd #{gem_name} && git commit -m 'Initial commit'")
+  end
+end

data/lib/generic_gem/version.rb

@@ -0,0 +1,4 @@
+#
+module GenericGem
+  VERSION = '0.1.0'
+end

data/plans.txt

@@ -0,0 +1,52 @@
+AT START:
+1.  Set configuration
+#!/usr/bin/env sh
+echo "---" > $HOME/.bundle/config
+echo "BUNDLE_GEM__COC: true" >> $HOME/.bundle/config
+echo "BUNDLE_GEM__MIT: true" >> $HOME/.bundle/config
+echo "BUNDLE_GEM__TEST: rspec" >> $HOME/.bundle/config
+/usr/bin/env ruby <<-EORUBY
+ 
+  StringInFile.replace("0.1.0", "0.0.0", (lib/gem name/version.txt))
+ 
+EORUBY
+
+2.  bundle gem (name of gem)
+
+3.  Make bin/setup and bin/console executable
+chmod +x bin/setup
+chmod +x bin/console
+
+4.  Add gem_test file
+echo "#!/bin/bash" > gem_test.sh
+echo "" >> gem_test.sh
+echo "# Run this script to test this gem." >> gem_test.sh
+echo "bin/setup" >> gem_test.sh
+echo "rake" >> gem_test.sh
+chmod +x gem_test.sh
+
+5.  Add gem_console file
+
+echo "#!/bin/bash" > gem_console.sh
+echo "" >> gem_console.sh
+echo "# Run this script to test this gem in an irb shell." >> gem_console.sh
+echo "bin/console" >> gem_console.sh
+chmod +x gem_console.sh
+
+6.  gemspec: Add rspec to development dependency list, replace "\nend" with
+'  spec.add_development_dependency "rspec"\nend'
+
+7.  Rakefile:
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+8.  *_spec.rb:
+expect(false).to eq(true) -> expect(true).to eq(true)
+
+9.  .gitignore
+include tmp, tmp*, and .DS_Store

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: generic_gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Hsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sandi_meter
+  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: bundler-audit
+  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: gemsurance
+  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: ruby-graphviz
+  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: codeclimate-test-reporter
+  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: simplecov
+  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: string_in_file
+  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: replace_quotes
+  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: GenericGem executes the bundle command but fills in important but easily
+  forgotten details.
+email:
+- rubyist@jasonhsu.com
+executables:
+- generic_gem
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/generic_gem
+- bin/setup
+- code_test.sh
+- gem_console.sh
+- gem_install.sh
+- gem_test.sh
+- generic_gem.gemspec
+- lib/files_to_add/README-to_do.txt
+- lib/files_to_add/Rakefile
+- lib/files_to_add/all.sh
+- lib/files_to_add/code_test.sh
+- lib/files_to_add/config
+- lib/files_to_add/gem_console.sh
+- lib/files_to_add/gem_install.sh
+- lib/files_to_add/gem_test.sh
+- lib/files_to_add/rubocop.yml
+- lib/generic_gem.rb
+- lib/generic_gem/version.rb
+- plans.txt
+homepage: https://github.com/jhsu802701/generic_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.4.5.1
+signing_key: 
+specification_version: 4
+summary: GenericGem streamlines the process of starting a new Ruby gem.
+test_files: []