gemstrapper 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e95bdaee08f3ec61e4862ab445eb88985586002
-  data.tar.gz: 3eee2eb775807f7d2c5b9033fdb602514cc86a8b
+  metadata.gz: 6bd83d7ece0c77d21e7a07136d7424fb77398b1f
+  data.tar.gz: 357a33835fe9126494a32a91cff4303fa72976ea
 SHA512:
-  metadata.gz: bc79d530f531fb473923846a8a831f43636dcaaf429232b3a7418b68183118eb577cc900529e311b6531cf56c42d9eec962459649b51bc8709ffc88b9fa92fdb
-  data.tar.gz: f09e32bd22623a2d73e146e451e1c7268a8b8c5b02b70068143a1f114f0fd3156243884279e34463833f2762c832b732ac851aba7d68283a97552d4853c70755
+  metadata.gz: 5f824ff41b16b80683a8de14dfc4b72acef26b10c8b2eb1b58291751b9cd6cbea384b9129f8a7793d23981d6a1608b15db91400c8d4066dca61d80cd6b9022a2
+  data.tar.gz: d88ca86ae1cebf63da836469e5997767be6b2871201199e00e0852c193da1031cfcabce064a4825c1751c6c4746b3e2452a2635eade972ccccee66fbf8e80e6b

data/bin/gemstrapper

@@ -32,20 +32,36 @@ class OptionsParser
 		subcommands = { 
 		  'init' => OptionParser.new do |opts|
 		      opts.banner = "Usage: init <folder_name>"
+
+		      opts.on("-e", "--executable", "Configures gem to be executable") do |e|
+			    options[:executable] = e
+			  end
 		    end
 		 }
 
 		global.order!
 		command = args.shift
-		project_name = args.shift
 
-		unless command and project_name
+
+
+		unless (command and subcommands.has_key? command)
 			puts "Invalid argument: Command should be: gemstrapper init <project_name>"
 			exit(1)
 		end
 		
-		options.update(project_name: project_name)
 		subcommands[command].order!
+		project_name = args.shift
+		# doing this a second time in case the first argument is the project_name, in which case
+		# OptsParse will nondisruptively fail on that value and not add the executable flag to the 
+		# options hash
+		subcommands[command].order!
+
+		unless project_name
+			puts "Invalid argument: Command should be: gemstrapper init <project_name>"
+			exit(1)
+		end
+
+		options.update(project_name: project_name)
 
 		return command, options
 	end

data/lib/gemstrapper/templates/project_name/bin/executable_name.erb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+## Your executable code here!

data/lib/gemstrapper/templates/project_name/lib/project_file_name.rb.erb

@@ -0,0 +1,6 @@
+require '<%= options[:project_name] %>/version'
+
+module <%= options[:module_name] %>
+    include <%= options[:module_name] %>::VERSION
+
+end

data/lib/gemstrapper/templates/project_name/project_name.gemspec.erb

@@ -4,11 +4,19 @@ Gem::Specification.new do |s|
   s.name          = '<%= options[:project_name] %>'
   s.version       = <%= options[:module_name] %>::VERSION
   s.license       = 'MIT'
+  s.platform      = Gem::Platform::RUBY
   s.summary       = "short summary here"
   s.description   = "longer description here"
   s.author        = 'user'
   s.email         = 'user@example.com'
   s.require_paths = ['lib']
+<% if options[:executable] %>
+  s.bindir        = 'bin'
+  s.executables   << '<%= options[:project_file_name] %>'
+<% end %>
   s.files         = Dir['lib/**/*']
+<% if options[:executable] %>
+  s.files         += Dir['bin/*']
+<% end %>
   s.homepage      = 'home page here'
 end

data/lib/gemstrapper/utility/string_helpers.rb

@@ -12,6 +12,14 @@ module Utility
 		def module_name_for(string)
 			string.split(/[-,_]/).map {|w| w.capitalize}.join('')
 		end
+
+        ##
+        # Converts a given string into a string that follow Ruby conventions for file names
+        # @param [String] string the string to convert
+        # @return [String] The given string converted into a file name
+        def filename_for(string)
+            string.gsub('-', '_')
+        end
 	end
 end
 end

data/lib/gemstrapper/version.rb

@@ -1,5 +1,5 @@
 module Gemstrapper
     ##
     # Version Constant. Called as part of the gemspec definition
-	VERSION = '1.0.0' unless defined? VERSION
+	VERSION = '1.1.0' unless defined? VERSION
 end

data/lib/gemstrapper.rb

@@ -8,6 +8,10 @@ require 'gemstrapper/utility/string_helpers'
 module Gemstrapper
 	include Utility::StringHelpers
 
+	##
+	# The absolute path of the directory containing all the templates needed for a new gem
+	TEMPLATES_DIRECTORY = File.expand_path('gemstrapper/templates', File.dirname(__FILE__))
+
 	extend self
 
 	##
@@ -16,33 +20,40 @@ module Gemstrapper
 	# @param [Hash] options The options passed in from the command line execution
 	# @return [void]
 	def init(options)
-		@options = options
+		options = default_options(options[:project_name]).update(options)
 
 		new_files = []
 
-		@options[:module_name] = module_name_for(@options[:project_name])
-		# Getting a list of folders to create based on folder structure within lib/templates
-		templates_directory = File.expand_path('gemstrapper/templates', File.dirname(__FILE__))
+		files = template_files_for_gem(options)
 
-		files = Dir.chdir(templates_directory) do
-			Dir.glob('**/*.erb')
-		end
+		#require 'pry';binding.pry
 
 		files.each do |file|
 			## creates directories
 			# converting project name placeholder to actual project name and stripping off erb extension
-			new_file_path = file.gsub('project_name', @options[:project_name]).gsub('.erb', '')
+			new_file_path = file.gsub('project_name', options[:project_name]).gsub('.erb', '')
+
+			new_file_path.gsub!('project_file_name', options[:project_file_name])
+			# converting executable_name placeholder for any executable file names into valid names for the gem
+			new_file_path.gsub!('executable_name', options[:project_file_name])
+
 			directory = File.dirname(new_file_path)
 
 			unless File.exist? directory
 				FileUtils.mkdir_p directory
 			end
 
-			data = process_template(File.join(templates_directory, file), options)
+			data = process_template(File.join(TEMPLATES_DIRECTORY, file), options)
 			File.write(new_file_path, data)
 			new_files << new_file_path
 		end
 
+		## modifying executable files to be executable
+		# TODO: Check windows compatibility with this feature
+		exe_files = new_files.select {|f| f.include? 'bin/'}.each do |file|
+			File.chmod(0755, file)
+		end
+
 		#reporting
 		new_files.each do |nf|
 			puts "#{nf} created"
@@ -62,4 +73,38 @@ module Gemstrapper
 
 		ERB.new(template_data).result binding
 	end
+
+	##
+	# default config options for the execution
+	# @param [String] project_name the name of the project. Used to create the default
+	#     module name
+	# @return [Hash] the default options
+	def default_options(project_name)
+		{
+			module_name: module_name_for(project_name),
+			executable: false,
+			project_file_name: filename_for(project_name)
+		}
+	end
+
+	##
+	# returns a list of template files to be processed and created for the new gem
+	# @param [Hash] options a list of the current execution options
+	# @return [Array] a list of template files
+	def template_files_for_gem(options)
+		files = []
+
+		Dir.chdir(TEMPLATES_DIRECTORY) do
+			files += Dir.glob('project_name/lib/**/*.erb') # library files
+			files << 'project_name/Gemfile.erb' # adding Gemfile
+			files << 'project_name/project_name.gemspec.erb' # adding Gemspec
+
+			if options[:executable]
+				files += Dir.glob('project_name/bin/*.erb') # executable files
+			end
+		end
+
+		files
+	end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemstrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Hoiberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-26 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -76,6 +76,8 @@ files:
 - bin/gemstrapper
 - lib/gemstrapper.rb
 - lib/gemstrapper/templates/project_name/Gemfile.erb
+- lib/gemstrapper/templates/project_name/bin/executable_name.erb
+- lib/gemstrapper/templates/project_name/lib/project_file_name.rb.erb
 - lib/gemstrapper/templates/project_name/lib/project_name/version.rb.erb
 - lib/gemstrapper/templates/project_name/project_name.gemspec.erb
 - lib/gemstrapper/utility/string_helpers.rb