gem_bootstrap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b971c9ff6eeff1e96a93856890d5e3b526893dae
+  data.tar.gz: 69a6c4147c0117e540b03b858345870bc5ec80f2
+SHA512:
+  metadata.gz: 68276627da8235910abd8d04ef055d7810ef551aaf3332a99db3616165465d3bae1d8a89e8d1fff8bc9727a2cc67c624eac21cd0bac06298633832016cd0a2ef
+  data.tar.gz: 83ce45e72f24287cb641cd990eafc20863783e4a6c62bf3d23f17c91d187989708bce84ba30f4966348202620959c44a656b34224a542d67edd68baa8c8cc88a

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+# This is the configuration used to check the rubocop source code.
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - lib/**/*
+  Exclude:
+    - templates/**/*
+inherit_from: rubocop-todo.yml

data/CHANGELOGS.md

@@ -0,0 +1,5 @@
+### Changelogs
+
+#### 0.0.1
+
+- Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Burin Choomnuan
+
+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,116 @@
+## gem_bootstrap
+
+[![Gem Version](https://badge.fury.io/rb/gem_bootstrap.svg)](http://badge.fury.io/rb/gem_bootstrap)
+[![Dependency Status](https://gemnasium.com/agilecreativity/gem_bootstrap.png)](https://gemnasium.com/agilecreativity/gem_bootstrap)
+[![Code Climate](https://codeclimate.com/github/agilecreativity/gem_bootstrap.png)](https://codeclimate.com/github/agilecreativity/gem_bootstrap)
+
+Generate the starting template for creating the ruby gem in ruby in one command.
+
+### Features:
+
+- Test framework using [Minitest][]
+- Document with [Yard][]
+- Style check with [Rubocop][]
+- Debug with [Pry][]
+- Initial git commit with [Grit] gem
+- Build on top of the most popular [Thor][] framework
+- Give you simple working structure that you can build upon but not dictate on
+  how you should do it
+- Templates files are customizable to suite your specific need
+
+### Requirements
+
+#### Mandatory
+
+- [Git][] the free and opensource distributed version control system.
+
+### Optional
+
+- Valid [Github][] account so that you can share your awesome gem with the community.
+
+### Installation
+
+Install the ruby gem
+
+```sh
+gem install gem_bootstrap
+```
+
+Then just run the `gem_bootstrap` without any argument for list of help
+
+```
+gem_bootstrap generate [GEM_NAME]
+                       --github-id [GITHUB_ID]
+                       --email [EMAIL]
+                       --author [AUTHOR]
+e.g.
+gem_bootstrap generate awesome_gem
+                       --github-id awesome_developer
+                       --email cool@awesomedev.com
+                       --author 'John Guru II'
+gem_bootstrap help [COMMAND]  # Describe available commands or one specific command
+gem_bootstrap usage           # Display help screen
+```
+To generate the gem just type the command like
+
+```
+gem_bootstrap generate awesome_gem --github-id awesome_developer -- email cool@awesomedev.com --author 'John Guru II'
+```
+Which should output something like
+
+```
+create  awesome_gem/README.md
+create  awesome_gem/CHANGELOGS.md
+create  awesome_gem/.yardopts
+create  awesome_gem/.gitignore
+create  awesome_gem/Gemfile
+create  awesome_gem/Rakefile
+create  awesome_gem/Guardfile
+create  awesome_gem/.rubocop.yml
+create  awesome_gem/rubocop-todo.yml
+create  awesome_gem/awesome_gem.gemspec
+create  awesome_gem/bin/awesome_gem
+create  awesome_gem/lib/awesome_gem.rb
+create  awesome_gem/lib/awesome_gem/version.rb
+create  awesome_gem/lib/awesome_gem/logger.rb
+create  awesome_gem/lib/awesome_gem/cli.rb
+create  awesome_gem/lib/awesome_gem/awesome_gem.rb
+create  awesome_gem/lib/awesome_gem/core_ext/hash/keys.rb
+create  awesome_gem/test/test_helper.rb
+create  awesome_gem/test/lib/awesome_gem/test_awesome_gem.rb
+create  awesome_gem/LICENSE
+```
+
+```sh
+# Change directory to the generated gem
+cd awesome_gem
+
+# Build the gem
+bundle
+
+# Run the default rake task (minitest and rubocop)
+rake
+
+# Install the gem to your local system
+rake install
+
+# You should have the basic command line that you can run like
+awesome_gem
+```
+
+### Contributing
+
+1. Fork it
+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
+
+[Git]: http://git-scm.com/
+[github]: https://github.com/
+[Grit]: https://github.com/mojombo/grit
+[Minitest]: https://github.com/seattlerb/minitest
+[Thor]: https://github.com/erikhuda/thor
+[Yard]: https://github.com/lsegal/yard
+[Rubocop]: https://github.com/bbatsov/rubocop
+[Pry]: https://github.com/pry/pry

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+project_name = 'gem_bootstrap'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib/#{project_name}"
+  t.test_files = FileList["test/lib/#{project_name}/test_*.rb"]
+  t.verbose = true
+end
+
+task default: [:test, :rubocop]
+
+task :pry do
+  require 'pry'
+  require 'awesome_print'
+  require_relative 'lib/gem_bootstrap'
+  include GemBootstrap
+  ARGV.clear
+  Pry.start
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on the lib directory'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['files']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/bin/gem_bootstrap

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative './../lib/gem_bootstrap'
+GemBootstrap::MainCLI.start(ARGV)

data/gem_bootstrap.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gem_bootstrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gem_bootstrap'
+  spec.version       = GemBootstrap::VERSION
+  spec.authors       = ['Burin Choomnuan']
+  spec.email         = ['agilecreativity@gmail.com']
+  spec.summary       = %q(Bootstrap the creation of ruby gem so that you don't have to start from scratch)
+  spec.description   = %q(Bootstrap the creation of ruby gem so that you don't have to start from scratch.
+                          Build with simple, sensible default and very easy to extend)
+  spec.homepage      = 'https://github.com/agilecreativity/gem_bootstrap'
+  spec.license       = 'MIT'
+  spec.files         = Dir.glob('{bin,lib,templates}/**/*') + %w(Gemfile
+                                                                 Rakefile
+                                                                 gem_bootstrap.gemspec
+                                                                 README.md
+                                                                 CHANGELOGS.md
+                                                                 LICENSE
+                                                                 .rubocop.yml
+                                                                 .gitignore
+                                                                 rubocop-todo.yml)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = Dir.glob('test/**/*')
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+  spec.add_runtime_dependency 'grit', '~> 2.5'
+  spec.add_development_dependency 'awesome_print', '~> 1.2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'gem-ctags', '~> 1.0'
+  spec.add_development_dependency 'minitest', '~> 5.3'
+  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
+  spec.add_development_dependency 'guard', '~> 2.6'
+  spec.add_development_dependency 'guard-minitest', '~> 2.2'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rubocop', '~> 0.21'
+  spec.add_development_dependency 'yard', '~> 0.8.7'
+end

data/lib/gem_bootstrap/cli.rb

@@ -0,0 +1,57 @@
+require 'thor'
+require_relative './misc_utils'
+require_relative './git_utils'
+module GemBootstrap
+  class CLI < Thor::Group
+    include Thor::Actions
+    argument :name
+    class_option :github_id,
+                 aliases: '-g',
+                 desc: 'github profile id',
+                 required: true
+    class_option :author,
+                 aliases: '-a',
+                 desc: 'Full name of the author',
+                 required: true
+    class_option :email,
+                 aliases: '-e',
+                 desc: 'Email for github',
+                 required: true
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    # rubocop:disable MethodLength, LineLength
+    def create_lib_file
+      template '../../templates/README.md',                        "#{name}/README.md"
+      template '../../templates/CHANGELOGS.md',                    "#{name}/CHANGELOGS.md"
+      template '../../templates/dot_yardopts',                     "#{name}/.yardopts"
+      template '../../templates/dot_gitignore',                    "#{name}/.gitignore"
+      template '../../templates/Gemfile',                          "#{name}/Gemfile"
+      template '../../templates/Rakefile',                         "#{name}/Rakefile"
+      template '../../templates/Guardfile',                        "#{name}/Guardfile"
+      template '../../templates/dot_rubocop.yml',                  "#{name}/.rubocop.yml"
+      template '../../templates/rubocop-todo.yml',                 "#{name}/rubocop-todo.yml"
+      template '../../templates/newgem.gemspec.tt',                "#{name}/#{name}.gemspec"
+      template '../../templates/bin/newgem',                       "#{name}/bin/#{name}"
+      template '../../templates/lib/newgem.rb',                    "#{name}/lib/#{name}.rb"
+      template '../../templates/lib/newgem/version.rb',            "#{name}/lib/#{name}/version.rb"
+      template '../../templates/lib/newgem/logger.rb',             "#{name}/lib/#{name}/logger.rb"
+      template '../../templates/lib/newgem/cli.rb',                "#{name}/lib/#{name}/cli.rb"
+      template '../../templates/lib/newgem/newgem.rb',             "#{name}/lib/#{name}/#{name}.rb"
+      template '../../templates/lib/newgem/core_ext/hash/keys.rb', "#{name}/lib/#{name}/core_ext/hash/keys.rb"
+      template '../../templates/test/test_helper.rb',              "#{name}/test/test_helper.rb"
+      template '../../templates/test/lib/newgem/test_newgem.rb',   "#{name}/test/lib/#{name}/test_#{name}.rb"
+    end
+    # rubocop:enable all
+
+    def copy_licence
+      copy_file '../../templates/MIT_LICENSE', "#{name}/LICENSE"
+    end
+
+    # Create the git project to store our generated code
+    def create_git_project
+      GemBootstrap::GitUtils.create_git_project(File.expand_path(name), name)
+    end
+  end
+end

data/lib/gem_bootstrap/core_ext/hash/keys.rb

@@ -0,0 +1,54 @@
+class Hash
+  # from: activesupport/lib/active_support/core_ext/hash/keys.rb
+  #
+  # hash = { name: 'Rob', age: '28' }
+  # hash.transform_keys{ |key| key.to_s.upcase }
+  # => { "NAME" => "Rob", "AGE" => "28" }
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def transform_keys!(&block)
+    keys.each do |key|
+      value = delete(key)
+      self[yield(key)] = value.is_a?(Hash) ? value.transform_keys!(&block) : value
+    end
+    self
+  end
+
+  # hash = { 'name' => 'Rob', 'age' => '28' }
+  # hash.symbolize_keys
+  # => { name: "Rob", age: "28" }
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+
+  # from: activesupport/lib/active_support/core_ext/hash/keys.rb, line 135
+  def symbolize_keys!
+    transform_keys! { |key| key.to_sym rescue key }
+  end
+
+  # Merges the caller into +other_hash+. For example,
+  #
+  #   options = options.reverse_merge(size: 25, velocity: 10)
+  #
+  # is equivalent to
+  #
+  #   options = { size: 25, velocity: 10 }.merge(options)
+  #
+  # This is particularly useful for initializing an options hash
+  # with default values.
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+
+  # Destructive +reverse_merge+.
+  def reverse_merge!(other_hash)
+    # right wins if there is no left
+    merge!(other_hash) { |_key, left, _right| left }
+  end
+end

data/lib/gem_bootstrap/core_ext/object/blank.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+# from: active_support/core_ext/object/blank.rb
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies:
+  #
+  #   if address.nil? || address.empty?
+  #
+  # ...to:
+  #
+  #   if address.blank?
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  # An object is present if it's not <tt>blank?</tt>.
+  def present?
+    !blank?
+  end
+
+  # Returns object if it's <tt>present?</tt> otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to <tt>object.present? ? object : nil</tt>.
+  #
+  # This is handy for any representation of objects where blank is the same
+  # as not present at all. For example, this simplifies a common check for
+  # HTTP POST/query parameters:
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # ...becomes:
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  alias_method :blank?, :empty?
+end
+
+class String
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?                 # => true
+  #   '   '.blank?              # => true
+  #   '　'.blank?               # => true
+  #   ' something here '.blank? # => false
+  def blank?
+    self !~ /[^[:space:]]/
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  def blank?
+    false
+  end
+end

data/lib/gem_bootstrap/gem_bootstrap.rb

@@ -0,0 +1,35 @@
+require 'thor'
+require_relative './cli'
+module GemBootstrap
+  class MainCLI < Thor
+    register GemBootstrap::CLI,
+             'generate',
+             'generate',
+             'Generate the starting template for CLI'
+
+    desc 'usage', 'Display help screen'
+    def usage
+      generate_usage = <<-EOT
+gem_bootstrap generate [GEM_NAME]
+                       --github-id [GITHUB_ID]
+                       --email [EMAIL]
+                       --author [AUTHOR]
+e.g. create a gem name 'awesome_gem'
+gem_bootstrap generate awesome_gem
+                       --github-id awesome_developer
+                       --email cool@awesomedev.com
+                       --author 'John Guru II'
+      EOT
+
+      help_text = <<-EOT
+        gem_bootstrap help [COMMAND]  # Describe available commands or one specific command
+        gem_bootstrap usage           # Display help screen
+      EOT
+
+      puts generate_usage
+      puts help_text.gsub(/^\s+/, '')
+    end
+
+    default_task :usage
+  end
+end

data/lib/gem_bootstrap/git_utils.rb

@@ -0,0 +1,49 @@
+require 'grit'
+module GemBootstrap
+  class GitUtils
+    class << self
+      # create new git repo from a given directory
+      #
+      # @param [String] base_dir the starting directory
+      # @param [String] gem_name the name of the gem we are creating
+      def create_git_project(base_dir, gem_name)
+        base_dir = File.expand_path(base_dir) # so that it works with ~/codes/etc
+        files = MiscUtils.files base_dir: base_dir,
+                                non_exts: %w(Gemfile
+                                             Rakefile
+                                             Guardfile
+                                             LICENSE
+                                             .rubocop.yml
+                                             .yardopts
+                                             .gitignore) << gem_name,
+                                exts: %w(md rb gemspec yml),
+                                recursive: true
+        git_init(base_dir: base_dir)
+        git_add(files, base_dir: base_dir, gem_name: gem_name)
+      end
+
+      # Run the git init on a given directory
+      #
+      # @param [String] base_dir the base directory
+      def git_init(options = {})
+        current_dir = File.expand_path(options[:base_dir])
+        base_dir = options[:base_dir] || Dir.pwd
+        Dir.chdir(base_dir)
+        MiscUtils.shell(%w(git init) << base_dir)
+        Dir.chdir(current_dir)
+      end
+
+      def git_add(files, options = {})
+        base_dir = File.expand_path(options[:base_dir])
+        Dir.chdir(base_dir) do
+          git = Grit::Repo.new(File.expand_path('.'))
+          files.each do |file|
+            # puts "Add '#{file}' to repository"
+            git.add(file)
+          end
+          git.commit_index('Initial commit')
+        end
+      end
+    end
+  end
+end

data/lib/gem_bootstrap/misc_utils.rb

@@ -0,0 +1,75 @@
+require 'open3'
+module GemBootstrap
+  class MiscUtils
+
+    CustomError = Class.new(StandardError)
+
+    class << self
+      # Receives a string and convert it to snake case.
+      # SnakeCase returns snake_case.
+      #
+      # @param [String] str the input string
+      def snake_case(str)
+        return str.downcase if str =~ /^[A-Z_]+$/
+        str.gsub(/\B[A-Z]/, '_\&').squeeze('_') =~ /_*(.*)/
+        $+.downcase
+      end
+
+      # Receives a string and convert it to camel case.
+      # camel_case returns CamelCase.
+      #
+      # @param [String] str the input string
+      def camel_case(str)
+        return str if str !~ /_/ && str =~ /[A-Z]+.*/
+        str.split('_').map { |i| i.capitalize }.join
+      end
+
+      # List files base on some extension
+      def files(args = {})
+        opts = {
+          base_dir: Dir.pwd,
+          recursive: false,
+          exts: [],
+          non_exts: []
+        }.merge(args)
+
+        base_dir = opts[:base_dir]
+        fail CustomError, "The directory #{base_dir} is not valid or or not readable!" unless File.exist?(base_dir)
+
+        wildcard = opts[:recursive] ? '**' : ''
+        exts     = opts[:exts]
+        non_exts = opts[:non_exts]
+
+        file_with_extension    = Dir.glob(File.join(base_dir, wildcard, "*.{#{exts.join(',')}}"))
+        file_with_no_extension = no_extension_files(base_dir, wildcard, non_exts)
+
+        (file_with_extension + file_with_no_extension).sort
+      end
+
+      # List files that do not have the extension
+      #
+      # @return list of files that does not have any extension
+      def no_extension_files(base_dir, wildcard, non_exts = [])
+        list = []
+        unless non_exts.empty?
+          list = Dir.glob(File.join(base_dir, wildcard, "{#{non_exts.join(',')}}"))
+        end
+        list
+      end
+
+      # Wrapper function to call the 'popen3' and return the result
+      #
+      # @param [Array<String>] commands list of command
+      # @return [String] result of the command as the string
+      def shell(commands = [])
+        begin
+          command = commands.join(' ')
+          stdin, _stderr, _status = Open3.capture3(command)
+        rescue Exception => e
+          raise "Problem processing #{command}, #{e.message}"
+        end
+        stdin
+      end
+    end
+  end
+end

data/lib/gem_bootstrap/version.rb

@@ -0,0 +1,3 @@
+module GemBootstrap
+  VERSION = '0.0.1'
+end

data/lib/gem_bootstrap.rb

@@ -0,0 +1,7 @@
+require_relative './gem_bootstrap/version'
+require_relative './gem_bootstrap/cli'
+require_relative './gem_bootstrap/git_utils'
+require_relative './gem_bootstrap/misc_utils'
+require_relative './gem_bootstrap/gem_bootstrap'
+require_relative './gem_bootstrap/core_ext/object/blank'
+include GemBootstrap