gbud 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 677fc522cd22eab884add70d1df33d4b22fabc43
-  data.tar.gz: ead3de72da63edde8b315ae86b160eca72b495d7
+  metadata.gz: b7e2f94ee9de9401c74cf7ccba14ebe62bf010f1
+  data.tar.gz: 84e58b4233481373ebc72bc027cccf8da80dcd4f
 SHA512:
-  metadata.gz: 32db7aa67455d99ffcdcfa5704d7ea77a24602e65a4229061f1b25df0a0f8c86f7dc7db04a249811e27bd9541b390023f01de6138060c74528041b1662d21e19
-  data.tar.gz: d1869ce58aa8fd6a6e425b2ccac5f4523e11953de744f9e332bafe74c27a7d1a5b7939e2c25adfc55f9dffda448b5dbf861146efbaa9c6a6692fd57853661c6d
+  metadata.gz: b7ed8be48ba2c998643ecc1f6dc0326e046724dd6e1aec61e6eca160cb5d4cc1aaef4a11b435f7642879f4954d86a87beaa6738e8343522e01feb5ecf33993e4
+  data.tar.gz: d344a20157fb5e102f22fac06037b4995a6e3b219ef5c4f3497ed94258effa1ea3884cd54c3e2a5a2fdae4cf772648919f9cff2fd07d1455ef69d773cc274bdf

data/bin/gbud

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright 2016 Richard Davis
+# Copyright 2017 Richard Davis
 #
 # This file is part of gbud.
 #
@@ -16,6 +16,13 @@
 # You should have received a copy of the GNU General Public License
 # along with gbud.  If not, see <http://www.gnu.org/licenses/>.
 
+##
+# = bin/gbud
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Project executable file.
 begin
   require 'gbud'
 rescue LoadError

data/lib/gbud.rb

@@ -1,4 +1,4 @@
-# Copyright 2016 Richard Davis
+# Copyright 2017 Richard Davis
 #
 # This file is part of gbud.
 #
@@ -15,6 +15,13 @@
 # You should have received a copy of the GNU General Public License
 # along with gbud.  If not, see <http://www.gnu.org/licenses/>.
 
+##
+# = gbud.rb
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# The main script for handling user input and program execution.
 require 'fileutils'
 require 'optparse'
 require 'erb'
@@ -41,6 +48,10 @@ optparse = OptionParser.new do |opts|
     options[:cli] = true
   end
 
+  opts.on('--no-cli', 'Creates an executable without option parsing') do
+    options[:cli] = false
+  end
+
   opts.on('-l', '--license', 'Displays the copyright notice') do
     puts "This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -85,7 +96,8 @@ if options[:name]
   end
   metadata.summary = GBud::UserPrompt.get_value 'Enter a short summary of the project => '
   metadata.description = GBud::UserPrompt.get_value 'Enter a description of the project => '
-  project = GBud::ProjectBuilder.new metadata.to_hash, false
+  options[:cli] = true if options[:cli].nil?
+  project = GBud::ProjectBuilder.new metadata.to_hash, options[:cli]
   project.build
 end
 

data/lib/gbud/namespace.rb

@@ -0,0 +1,26 @@
+# Copyright 2017 Richard Davis
+#
+# This file is part of gbud.
+#
+# gbud is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# gbud is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gbud.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = GBud
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Module for namespacing application classes.
+module GBud
+end

data/lib/gbud/project_builder.rb

@@ -1,4 +1,4 @@
-# Copyright 2016 Richard Davis
+# Copyright 2017 Richard Davis
 #
 # This file is part of gbud.
 #
@@ -15,99 +15,154 @@
 # You should have received a copy of the GNU General Public License
 # along with gbud.  If not, see <http://www.gnu.org/licenses/>.
 
+require 'date'
+
 module GBud
+  ##
+  # = ProjectBuilder
+  # Author::    Richard Davis
+  # Copyright:: Copyright 2017 Richard Davis
+  # License::   GNU Public License 3
+  #
+  # The engine that is instantiated to build out the project directory
+  # skeleton and basic files using templates.
   class ProjectBuilder
-    attr_reader :metadata, :cli, :files, :paths
+    # Project metadata information supplied by user
+    attr_reader :metadata
+    # Option for making project executable
+    attr_reader :cli
+    # Hash containing file names for project templates
+    attr_reader :templates
+    # Hash containing file names for project assets
+    attr_reader :assets
+    # Hash specifying project directories
+    attr_reader :paths
 
     ##
-    # Instantiates the ProjectBuilder object using information provided
-    #
-    # metadata : a hash containing the name, summary, description, authors, email
-    #            and URL for the project to be initialized
-    # cli      : specifies the need for a CLI option parser and executable
-    #
+    # Instantiates a ProjectBuilder object
     def initialize metadata, cli
       @metadata = metadata
+
       @cli = cli
-      @files = {
-        readme: 'README.md',
-        gemspec: "#{metadata[:name]}.gemspec",
-        gemfile: 'Gemfile',
-        rakefile: 'Rakefile',
-        main: "#{metadata[:name]}.rb",
-        hello: "hello.rb",
-        test_hello: "test_hello.rb"
+      @templates = {
+        'readme.md': 'README.md',
+        'gemspec.rb': "#{metadata[:name]}.gemspec",
+        'gemfile.rb': 'Gemfile',
+        'guardfile.rb': 'Guardfile',
+        'rakefile.rb': 'Rakefile',
+        'main.rb': "#{metadata[:name]}.rb",
+        'hello.rb': 'hello.rb',
+        'test_hello.rb': 'test_hello.rb',
+        'namespace.rb': 'namespace.rb'
+      }
+      @assets = {
+        license: 'LICENSE'
       }
       @paths = {
         project_dir: "#{metadata[:name]}/",
         project_lib_dir: "#{metadata[:name]}/lib/",
         project_lib_project_dir: "#{metadata[:name]}/lib/#{metadata[:name]}/",
-        project_test_dir: "#{metadata[:name]}/test/"
+        project_test_dir: "#{metadata[:name]}/test/",
       }
       if cli == true
-        @files[:executable] = "#{metadata[:name]}"
+        @templates[:'executable.rb'] = "#{metadata[:name]}"
         @paths[:project_bin_dir] = "#{metadata[:name]}/bin/"
       end
     end
 
+    ##
+    # Builds the project
     def build
       make_directories
-      make_files
-      make_executable :executable if @cli == true
+      render_templates
+      copy_assets
     end
 
     private
 
     ##
-    # make_directories
-    # Creates the project directory structure
+    # Creates the project directories
     def make_directories
       @paths.each do |path, dir|
         FileUtils.mkdir_p(dir)
       end
     end
 
-    def make_files
-      @files.each do |template, filename|
+    ##
+    # Makes the files using templates
+    def render_templates
+      @templates.each do |template, filename|
         directory = map_template template
         file = File.new "#{directory}#{filename}", 'w+'
         file.puts(render template)
         file.close
-        make_executable if template == :executable
+        make_executable if template == :'executable.rb'
       end
     end
 
+    ##
+    # Maps each templated file to correct directory
     def map_template template
-      dir = case template
-        when :readme
+      case template
+        when :'readme.md'
+          @paths[:project_dir]
+        when :'gemspec.rb'
           @paths[:project_dir]
-        when :gemspec
+        when :'gemfile.rb'
           @paths[:project_dir]
-        when :gemfile
+        when :'guardfile.rb'
           @paths[:project_dir]
-        when :rakefile
+        when :'rakefile.rb'
           @paths[:project_dir]
-        when :main
+        when :'main.rb'
           @paths[:project_lib_dir]
-        when :hello
+        when :'hello.rb'
           @paths[:project_lib_project_dir]
-        when :executable
+        when :'executable.rb'
           @paths[:project_bin_dir]
-        when :test_hello
+        when :'test_hello.rb'
           @paths[:project_test_dir]
       end
     end
 
+    ##
+    # Renders the templates into files
     def render template
       path = File.expand_path(File.join(File.dirname(__FILE__),
                                         '..',
                                         'templates',
-                                        "#{template.to_s}.rb.erb"))
+                                        "#{template}.erb"))
       ERB.new(File.read(path)).result(binding)
     end
 
+    ##
+    # Flags the CLI file as executable
     def make_executable
-      File.chmod(0755, "#{@paths[:project_bin_dir]}#{@files[:executable]}")
+      File.chmod(0755, "#{@paths[:project_bin_dir]}#{@templates[:'executable.rb']}")
+    end
+
+    ##
+    # Copies the assets
+    def copy_assets
+      @assets.each do |asset, filename|
+        directory = map_asset asset
+        FileUtils.cp(File.expand_path(File.join(File.dirname(__FILE__),
+                                        '..',
+                                        'assets',
+                                        "#{filename}")),
+                                      "#{directory}#{filename}")
+      end
+    end
+
+    ##
+    # Maps each asset file to correct directory
+    def map_asset asset
+      case asset
+        when :gitignore
+          @paths[:project_dir]
+        when :license
+          @paths[:project_dir]
+      end
     end
   end
 end

data/lib/gbud/project_metadata.rb

@@ -1,4 +1,4 @@
-# Copyright 2016 Richard Davis
+# Copyright 2017 Richard Davis
 #
 # This file is part of gbud.
 #
@@ -16,45 +16,65 @@
 # along with gbud.  If not, see <http://www.gnu.org/licenses/>.
 
 module GBud
+  ##
+  # = ProjectMetadata
+  # Author::    Richard Davis
+  # Copyright:: Copyright 2017 Richard Davis
+  # License::   GNU Public License 3
+  #
+  # The means by which user input describing project metadata is
+  # captured to be used by GBud::ProjectBuilder objects.
   class ProjectMetadata
-    attr_reader :name,
-                :summary,
-                :description,
-                :authors,
-                :email,
-                :url,
-                :version,
-                :license
+    # The name of the project
+    attr_reader :name
+    # A short project summary
+    attr_accessor :summary
+    # A longer description of the project
+    attr_accessor :description
+    # List of the project authors
+    attr_reader :authors
+    # Email address for project
+    attr_reader :email
+    # The URL for project
+    attr_reader :url
+    # The project version (defaults to 0.0.1)
+    attr_reader :version
+    # The project license (defaults to GPL-3.0)
+    attr_reader :license
 
+    ##
+    # Instantiates a ProjectMetadata object
     def initialize
       @version = '0.0.1'
       @license = 'GPL-3.0'
     end
 
-    def name= name
+    ##
+    # Sets the name attribute
+    def name=(name)
       @name = name unless validate_name(name).nil?
     end
 
-    def authors= authors
+    ##
+    # Sets the author attribute
+    def authors=(authors)
       @authors = authors.split(', ')
     end
 
-    def email= email
+    ##
+    # Sets the email attribute
+    def email=(email)
       @email = email unless validate_email(email).nil?
     end
 
-    def url= url
+    ##
+    # Sets the url attribute
+    def url=(url)
       @url = url unless validate_url(url).nil?
     end
 
-    def summary= summary
-      @summary = summary
-    end
-
-    def description= description
-      @description = description
-    end
-
+    ##
+    # Returns the object attributes as a hash
     def to_hash
       {
         name: @name,
@@ -68,16 +88,22 @@ module GBud
       }
     end
 
-    def validate_name name
+    ##
+    # Validates that the given name meets criteria
+    def validate_name(name)
       /\A[a-z][a-z0-9_\-]*\Z/i =~ name
     end
 
-    def validate_email email
+    ##
+    # Validates that the given email meets criteria
+    def validate_email(email)
       /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i =~ email
     end
 
-    def validate_url url
-      /https?:\/\/[\S]+/ =~ url
+    ##
+    # Validates that the given url meets criteria
+    def validate_url(url)
+      %r{https?:\/\/[\S]+} =~ url
     end
   end
 end

data/lib/gbud/user_prompt.rb

@@ -1,4 +1,4 @@
-# Copyright 2016 Richard Davis
+# Copyright 2017 Richard Davis
 #
 # This file is part of gbud.
 #
@@ -16,15 +16,27 @@
 # along with gbud.  If not, see <http://www.gnu.org/licenses/>.
 
 module GBud
+  ##
+  # = UserPrompt
+  # Author::    Richard Davis
+  # Copyright:: Copyright 2017 Richard Davis
+  # License::   GNU Public License 3
+  #
+  # Module containing methods used to prompt the user for program
+  # input.
   module UserPrompt
     @value = ''
 
-    def self.get_value prompt
+    ##
+    # Returns the value entered by the user
+    def self.get_value(prompt)
       prompt_user prompt
       @value
     end
 
-    def self.prompt_user prompt
+    ##
+    # Prompts the user for a value
+    def self.prompt_user(prompt)
       loop do
         print prompt
         @value = gets.chomp.to_s
@@ -32,6 +44,8 @@ module GBud
       end
     end
 
+    ##
+    # Confirms the value entered by the user
     def self.confirm_input
       puts "You have entered: #{@value}"
       print 'Is this correct? (Y/N) => '

data/lib/templates/cli.rb.erb

@@ -0,0 +1,43 @@
+require 'optparse'
+
+trap('INT') do
+  puts "\nTerminating..."
+  exit
+end
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: <%= @metadata[:name] %> [options]'
+
+  opts.on('-g', '--greet NAME', 'Provides a greeting given a name.') do |name|
+    options[:greet] = name
+  end
+
+  opts.on('-l', '--license', 'Displays the copyright notice') do
+    puts "This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+"
+  end
+
+  opts.on('-w', '--warranty', 'Displays the warranty statement') do
+    puts "This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+"
+  end
+
+  opts.on_tail('-h', '--help', 'Displays the help screen') do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
+if options[:greet]
+  puts <%= @metadata[:name].split(/-|_/).each{ |s| s.capitalize! }.join %>::Hello.greeting(options[:greet])
+end

data/lib/templates/executable.rb.erb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby'
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #
@@ -16,6 +16,13 @@
 # You should have received a copy of the GNU General Public License
 # along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
 
+##
+# = /bin/<%= @metadata[:name] %>
+# Author::    <%= @metadata[:authors].join(', ') %>
+# Copyright:: Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+# License::   GNU Public License 3
+#
+# Project executable file.
 begin
   require '<%= @metadata[:name] %>'
 rescue LoadError

data/lib/templates/gemfile.rb.erb

@@ -1,4 +1,4 @@
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #
@@ -16,9 +16,18 @@
 # along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
 
 source 'https://rubygems.org'
-ruby '2.3.1'
+ruby '2.4.1'
 
-gem 'pry', '~> 0.10.4'
-gem 'rake', '~> 12.0'
-gem 'minitest', '~> 5.0'
-gem 'rubocop', '~> 0.46.0'
+group :development do
+  # Minitest for unit tests
+  gem 'minitest', '~> 5.0'
+  # Use Guard to run automated tests
+  gem 'guard', '~> 2.14', '>= 2.14.1'
+  gem 'guard-minitest', '~> 2.4', '>= 2.4.6'
+  # Rake executes tasks defined in the Rakefile
+  gem 'rake', '~> 12.0'
+  # Rubocop for code style guidelines
+  gem 'rubocop', '~> 0.48.1'
+  # RDoc for generating documentation
+  gem 'rdoc', '~> 5.1'
+end

data/lib/templates/gemspec.rb.erb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #

data/lib/templates/guardfile.rb.erb

@@ -0,0 +1,25 @@
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+#
+# This file is part of <%= @metadata[:name] %>.
+#
+# <%= @metadata[:name] %> is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# <%= @metadata[:name] %> is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
+
+directories(%w[lib test])\
+  .select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") }
+
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/lib/templates/hello.rb.erb

@@ -1,4 +1,4 @@
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #
@@ -15,10 +15,17 @@
 # You should have received a copy of the GNU General Public License
 # along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
 
-module <%= @metadata[:name].split('-').each{ |s| s.capitalize! }.join %>
+##
+# = Hello
+# Author::    <%= @metadata[:authors].join(', ') %>
+# Copyright:: Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+# License::   GNU Public License 3
+#
+# Contains modularized code for project; given example provides a greeting
+module <%= @metadata[:name].split(/-|_/).each{ |s| s.capitalize! }.join %>
   class Hello
-    def self.greeting
-      'Hello, friend.'
+    def self.greeting name
+      "Hello, #{name}."
     end
   end
 end

data/lib/templates/main.rb.erb

@@ -1,4 +1,4 @@
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #
@@ -15,5 +15,13 @@
 # You should have received a copy of the GNU General Public License
 # along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
 
+##
+# = /lib/<%= @metadata[:name] %>.rb
+# Author::    <%= @metadata[:authors].join(', ') %>
+# Copyright:: Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+# License::   GNU Public License 3
+#
+# Main application file that loads other files.
 require '<%= @metadata[:name] %>/hello'
-puts <%= @metadata[:name].split('-').each{ |s| s.capitalize! }.join %>::Hello.greeting
+
+<%= render 'cli.rb' if @cli == true %>

data/lib/templates/namespace.rb.erb

@@ -0,0 +1,26 @@
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+#
+# This file is part of <%= @metadata[:name] %>.
+#
+# <%= @metadata[:name] %> is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# <%= @metadata[:name] %> is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
+
+##
+# = <%= @metadata[:name].split(/-|_/).each{ |s| s.capitalize! }.join %>
+# Author::    <%= @metadata[:authors].join(', ') %>
+# Copyright:: Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+# License::   GNU Public License 3
+#
+# Module for namespacing application classes.
+module <%= @metadata[:name].split(/-|_/).each{ |s| s.capitalize! }.join %>
+end

data/lib/templates/rakefile.rb.erb

@@ -1,4 +1,4 @@
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #
@@ -16,7 +16,19 @@
 # along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'rake/testtask'
+require 'rdoc/task'
 
 Rake::TestTask.new do |t|
     t.libs << 'test'
 end
+
+RDoc::Task.new :rdoc do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md',
+                          './lib/*.rb',
+                          './lib/**/*.rb',
+                          './test/**/*.rb')
+  rdoc.title = '<%= @metadata[:name] %> Documentation'
+  rdoc.rdoc_dir = 'docs/'
+  rdoc.options << '--all'
+end

data/lib/templates/readme.md.erb

@@ -0,0 +1,113 @@
+# A note from gbud
+## Next Steps
+* Initiate a git repo with `git init`
+* Run `bundle install` to get the dependencies
+* Write some code!
+* Execute `gem build foobar.gemspec` to build your gem
+* Execute `gem install foobar-0.0.1.gem` to install your gem
+* Share!
+# Name
+<%= @metadata[:description] %>
+
+## Table of Contents
+* About
+* Getting started
+    * Installation
+    * Usage
+* Contributing
+    * Code of Conduct
+    * Code Style
+    * Documentation
+    * Testing
+* TODO
+* Changelog
+
+## About
+<%= @metadata[:description] %>
+
+Documentation can be found [here](https://).
+
+## License
+See `LICENSE` in the project root directory for license information.
+
+## Getting Started
+### Installation
+Put installation instructions here.
+
+### Usage
+Put usage instructions here.
+
+## Contributing
+### Code of Conduct
+All contributions are welcome, but are merged at the discretion of the core
+contributor(s). Contributions to the project will be
+judged on their merits without respect to a contributor's publicly or
+privately held beliefs, opinions, ideology, nationality, ethnicity, or
+demographic. Most communications within the project should be limited to
+project planning, development, bugfixing, or other relevant topics; for
+off-topic discussions, contributors are expected to use good judgement
+and to avoid intentionally abusive behavior. Conflict should be resolved
+at the lowest level possible with minimal disruption to the project. Core
+contributor(s) reserve the right to request that a contributor alter their
+behavior, however, nothing in this code of conduct should be construed in
+such a manner that it infringes upon any contributor's freedom of expression.
+
+### Code Style
+To keep a consistent code style, it is recommended to use
+[rubocop](https://github.com/bbatsov/rubocop). If you use `vim` and
+[syntastic](https://github.com/vim-syntastic/syntastic), you
+can use `rubocop` as a Ruby checker. To manually run `rubocop`, you
+can run the following commands:
+
+```
+# Run rubocop for the entire project
+bundle exec rubocop
+# Run rubocop for a specific file
+bundle exec rubocop foo/bar.rb
+```
+
+### Documentation
+Comment any code contributions according to the existing conventions within the project.
+Reference the examples listed below:
+
+Example top-level comment:
+
+```
+##
+# = ClassNameGoesHere
+# Author::    [Author Information]
+# Copyright:: Copyright [Year] [Author Information]
+# License::   GNU Public License 3
+#
+# This is a class that is something and does something.
+```
+
+Example method comment:
+
+```
+##
+# This is a method that does something
+```
+
+Documentation should be regenerated prior to merging any branches into master. The latest
+[documentation](https://d3d1rty.github.io/gbud/) auto-sources off the `docs/` folder on
+the master branch. For more information on RDoc, go
+[here](https://rdoc.github.io/rdoc/index.html).
+
+```
+# Run custom rake task to regenerate RDoc documentation
+rake rdoc
+```
+
+### Testing
+Integration tests should be written for all classes and methods. The test suite
+can be run manually `bundle exec rake test` or automatically using guard `bundle exec guard`.
+
+## TODO
+List action items here.
+
+## Changelog
+### [Date]
+* Upgraded to version `X.X.X`.
+* List other changes made.
+* ...

data/lib/templates/test_hello.rb.erb

@@ -1,4 +1,4 @@
-# Copyright <%= Date.today.year %> <%= metadata[:authors].join(', ') %>
+# Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
 #
 # This file is part of <%= @metadata[:name] %>.
 #
@@ -16,10 +16,25 @@
 # along with <%= @metadata[:name] %>.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'minitest/autorun'
-require '<%= @metadata[:name] %>'
+require_relative '../lib/<%= @metadata[:name] %>/hello'
 
+##
+# = HelloTest
+# Author::    <%= @metadata[:authors].join(', ') %>
+# Copyright:: Copyright <%= Date.today.year %> <%= @metadata[:authors].join(', ') %>
+# License::   GNU Public License 3
+#
+# Contains modularized code for project; given example provides a greeting
 class HelloTest < Minitest::Test
+  ##
+  # Initializes test with sample data
+  def setup
+    @name = 'friend'
+  end
+
+  ##
+  # Ensures the greeter is behaving as expected
   def test_hello
-    assert_equal('Hello, friend.', <%= <%= @metadata[:name].split('-').each{ |s| s.capitalize! }.join %>::Hello.greeting
+    assert_equal('Hello, friend.', <%= @metadata[:name].split(/-|_/).each{ |s| s.capitalize! }.join %>::Hello.greeting(@name))
   end
 end

data/test/test_project_builder.rb

@@ -1,7 +1,3 @@
-# Copyright 2016 Richard Davis
-#
-# This file is part of gbud.
-#
 # gbud is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
@@ -18,7 +14,16 @@
 require 'minitest/autorun'
 require_relative '../lib/gbud/project_builder'
 
+##
+# = ProjectBuilderTest
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Tests for GBud::ProjectBuilder class functionality.
 class ProjectBuilderTest < Minitest::Test
+  ##
+  # Initializes test with sample data
   def setup
     metadata = {
       name: 'gbud-test',

data/test/test_project_metadata.rb

@@ -1,7 +1,3 @@
-# Copyright 2016 Richard Davis
-#
-# This file is part of gbud.
-#
 # gbud is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
@@ -18,66 +14,103 @@
 require 'minitest/autorun'
 require_relative '../lib/gbud/project_metadata'
 
+##
+# = ProjectMetadataTest
+# Author::    Richard Davis
+# Copyright:: Copyright 2017 Richard Davis
+# License::   GNU Public License 3
+#
+# Tests for GBud::ProjectMetadata class functionality.
 class ProjectMetadataTest < Minitest::Test
+  ##
+  # Initializes test with sample data
   def setup
     @metadata = GBud::ProjectMetadata.new
   end
 
+  ##
+  # Tests that an invalid name is not accepted
   def test_name_mutator_negative
     @metadata.name = '-test'
     assert_nil @metadata.name
   end
 
+  ##
+  # Tests that a valid name is accepted
   def test_name_mutator_positive
     @metadata.name = 'gbud-test'
     assert_equal 'gbud-test', @metadata.name
   end
 
+  ##
+  # Tests that an invalid name is rejected by validate_name
   def test_validate_name_negative
     assert_nil @metadata.validate_name('-fail')
   end
 
+  ##
+  # Tests that a valid name is accepted by validate_name
   def test_validate_name_positive
     assert_equal 0, @metadata.validate_name('test-gem')
   end
 
+  ##
+  # Tests that an invalid email is rejected by validate_email
   def test_validate_email_negative
     assert_nil @metadata.validate_email('rvdavis')
   end
 
+  ##
+  # Tests that a valid email is accepted by validate_email
   def test_validate_email_positive
     assert_equal 0, @metadata.validate_email('rvdavis@member.fsf.org')
   end
 
+  ##
+  # Tests that an invalid URL is rejected by validate_url
   def test_validate_url_negative
     assert_nil @metadata.validate_url('github.com')
   end
 
+  ##
+  # Tests that a valid URL is accepted by validate_url
   def test_validate_url_positive
     assert_equal 0, @metadata.validate_url('https://github.com/d3d1rty/gbud')
   end
 
+  ##
+  # Tests that user-provided author list is split into an array
   def test_authors_mutator
     @metadata.authors = 'Richard Davis, d3d1rty'
     assert_equal ['Richard Davis', 'd3d1rty'], @metadata.authors
   end
 
+  ##
+  # Tests that the summary attribute accepts assignment
   def test_summary_mutator
     assert_equal 'This is a test', @metadata.summary = 'This is a test'
   end
 
+  ##
+  # Tests that the description attribute accepts assignment
   def test_description_mutator
     assert_equal 'This is a test', @metadata.description = 'This is a test'
   end
 
+  ##
+  # Tests that the version attribute is able to be retrieved
   def test_version_accessor
     assert_equal '0.0.1', @metadata.version
   end
 
+  ##
+  # Tests that the license attribute is able to be retrieved
   def test_license_accessor
     assert_equal 'GPL-3.0', @metadata.license
   end
 
+  ##
+  # Tests that project metadata is properly converted to hash
   def test_to_hash
     @metadata.name = 'gbud-test'
     @metadata.authors = 'Richard Davis, d3d1rty'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gbud
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Richard Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2017-12-23 00:00:00.000000000 Z
 dependencies: []
 description: |2
       This project aims to make starting a new gem project simple by automating
@@ -22,17 +22,20 @@ files:
 - bin/gbud
 - lib/assets/LICENSE
 - lib/gbud.rb
+- lib/gbud/namespace.rb
 - lib/gbud/project_builder.rb
 - lib/gbud/project_metadata.rb
 - lib/gbud/user_prompt.rb
+- lib/templates/cli.rb.erb
 - lib/templates/executable.rb.erb
 - lib/templates/gemfile.rb.erb
 - lib/templates/gemspec.rb.erb
-- lib/templates/guardfile.erb.rb
+- lib/templates/guardfile.rb.erb
 - lib/templates/hello.rb.erb
 - lib/templates/main.rb.erb
+- lib/templates/namespace.rb.erb
 - lib/templates/rakefile.rb.erb
-- lib/templates/readme.rb.erb
+- lib/templates/readme.md.erb
 - lib/templates/test_hello.rb.erb
 - test/test_project_builder.rb
 - test/test_project_metadata.rb
@@ -56,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Initializes the basic structure of a gem

data/lib/templates/readme.rb.erb

@@ -1,12 +0,0 @@
-#<%= @metadata[:name] %>
-##Description
-<%= @metadata[:description] %>
-##Next Steps
-* Initiate a git repo with `git init`
-* Run `bundle install` to get the dependencies
-* Write some code!
-* Execute `gem build foobar.gemspec` to build your gem
-* Execute `gem install foobar-0.0.1.gem` to install your gem
-* Share!
-##License
-See `LICENSE` in the project root directory for license information.