gbud 0.0.3 → 0.0.4

data/lib/gbud.rb

@@ -1,3 +1,91 @@
-# gbud
-# Copyright 2015 Richard Davis GPL v3
-require 'gbud/base'
+# 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
+# (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/>.
+
+require 'fileutils'
+require 'optparse'
+require 'erb'
+
+require 'gbud/user_prompt'
+require 'gbud/project_metadata'
+require 'gbud/project_builder'
+
+trap('INT') do
+  puts "\nTerminating..."
+  exit
+end
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: gbud [options]'
+
+  opts.on('-n', '--new NAME', 'Creates a project given a name') do |name|
+    options[:name] = name
+  end
+
+  opts.on('--cli', 'Creates an executable with option parsing') do
+    options[:cli] = true
+  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[:name]
+  metadata = GBud::ProjectMetadata.new
+  metadata.name = options[:name]
+  if metadata.name.nil?
+    puts 'Invalid gem name. See RubyGems for gem naming conventions.'
+    exit 1
+  end
+  metadata.authors = GBud::UserPrompt.get_value 'Project authors => '
+  loop do
+    metadata.email = GBud::UserPrompt.get_value 'Project email => '
+    break unless metadata.email.nil?
+    puts 'Please enter a valid email address.'
+  end
+  loop do
+    metadata.url = GBud::UserPrompt.get_value 'Project website => '
+    break unless metadata.url.nil?
+    puts 'Please enter a valid project URL'
+  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
+  project.build
+end
+

data/lib/gbud/project_builder.rb

@@ -0,0 +1,113 @@
+# 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
+# (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/>.
+
+module GBud
+  class ProjectBuilder
+    attr_reader :metadata, :cli, :files, :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
+    #
+    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"
+      }
+      @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/"
+      }
+      if cli == true
+        @files[:executable] = "#{metadata[:name]}"
+        @paths[:project_bin_dir] = "#{metadata[:name]}/bin/"
+      end
+    end
+
+    def build
+      make_directories
+      make_files
+      make_executable :executable if @cli == true
+    end
+
+    private
+
+    ##
+    # make_directories
+    # Creates the project directory structure
+    def make_directories
+      @paths.each do |path, dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def make_files
+      @files.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
+      end
+    end
+
+    def map_template template
+      dir = case template
+        when :readme
+          @paths[:project_dir]
+        when :gemspec
+          @paths[:project_dir]
+        when :gemfile
+          @paths[:project_dir]
+        when :rakefile
+          @paths[:project_dir]
+        when :main
+          @paths[:project_lib_dir]
+        when :hello
+          @paths[:project_lib_project_dir]
+        when :executable
+          @paths[:project_bin_dir]
+        when :test_hello
+          @paths[:project_test_dir]
+      end
+    end
+
+    def render template
+      path = File.expand_path(File.join(File.dirname(__FILE__),
+                                        '..',
+                                        'templates',
+                                        "#{template.to_s}.rb.erb"))
+      ERB.new(File.read(path)).result(binding)
+    end
+
+    def make_executable
+      File.chmod(0755, "#{@paths[:project_bin_dir]}#{@files[:executable]}")
+    end
+  end
+end

data/lib/gbud/project_metadata.rb

@@ -0,0 +1,83 @@
+# 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
+# (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/>.
+
+module GBud
+  class ProjectMetadata
+    attr_reader :name,
+                :summary,
+                :description,
+                :authors,
+                :email,
+                :url,
+                :version,
+                :license
+
+    def initialize
+      @version = '0.0.1'
+      @license = 'GPL-3.0'
+    end
+
+    def name= name
+      @name = name unless validate_name(name).nil?
+    end
+
+    def authors= authors
+      @authors = authors.split(', ')
+    end
+
+    def email= email
+      @email = email unless validate_email(email).nil?
+    end
+
+    def url= url
+      @url = url unless validate_url(url).nil?
+    end
+
+    def summary= summary
+      @summary = summary
+    end
+
+    def description= description
+      @description = description
+    end
+
+    def to_hash
+      {
+        name: @name,
+        authors: @authors,
+        email: @email,
+        url: @url,
+        summary: @summary,
+        description: @description,
+        version: @version,
+        license: @license
+      }
+    end
+
+    def validate_name name
+      /\A[a-z][a-z0-9_\-]*\Z/i =~ name
+    end
+
+    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
+    end
+  end
+end

data/lib/gbud/user_prompt.rb

@@ -0,0 +1,43 @@
+# 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
+# (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/>.
+
+module GBud
+  module UserPrompt
+    @value = ''
+
+    def self.get_value prompt
+      prompt_user prompt
+      @value
+    end
+
+    def self.prompt_user prompt
+      loop do
+        print prompt
+        @value = gets.chomp.to_s
+        break if confirm_input
+      end
+    end
+
+    def self.confirm_input
+      puts "You have entered: #{@value}"
+      print 'Is this correct? (Y/N) => '
+      confirm = gets.chomp.to_s.upcase
+      return false unless confirm == 'Y'
+      true
+    end
+  end
+end

data/lib/templates/executable.rb.erb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby'
+# 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/>.
+
+begin
+  require '<%= @metadata[:name] %>'
+rescue LoadError
+  require 'rubygems'
+  require '<%= @metadata[:name] %>'
+end

data/lib/templates/gemfile.rb.erb

@@ -0,0 +1,24 @@
+# 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/>.
+
+source 'https://rubygems.org'
+ruby '2.3.1'
+
+gem 'pry', '~> 0.10.4'
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'
+gem 'rubocop', '~> 0.46.0'

data/lib/templates/gemspec.rb.erb

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+# 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/>.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = '<%= @metadata[:name] %>'
+  s.version       = '<%= @metadata[:version] %>'
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = <%= @metadata[:authors] %>
+  s.email         = '<%= @metadata[:email] %>'
+  s.homepage      = '<%= @metadata[:url] %>'
+  s.summary       = '<%= @metadata[:summary] %>'
+  s.description   = <<-EOF
+  <%= @metadata[:description] %>
+EOF
+  s.license       = '<%= @metadata[:license] %>'
+  s.files         = Dir['lib/**/*']
+  <% if @cli == true %>
+    s.executables   = ['<%= @metadata[:name] %>']
+  <% end %>
+  s.test_files    = Dir['test/**/*']
+  s.require_path  = ['lib']
+end

data/lib/templates/hello.rb.erb

@@ -0,0 +1,24 @@
+# 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/>.
+
+module <%= @metadata[:name].split('-').each{ |s| s.capitalize! }.join %>
+  class Hello
+    def self.greeting
+      'Hello, friend.'
+    end
+  end
+end