gem-new 0.1.2 → 0.2.0

data/HISTORY.markdown

@@ -0,0 +1,39 @@
+GEM NEW HISTORY
+===============
+
+
+
+2011- - Released Version 0.2.0
+------------------------------
+
+* New:      Added basic rake tasks to build the gem.
+* Changed:  .literal Suffix no longer exists, use .stop instead.
+* Changed:  Files are now processed by suffix, until .stop or an unknown suffix is hit.
+  E.g. foo.html.markdown.erb will first be processed by the ERB processor, then by the
+  Markdown  processor and then it'll stop (because .html is not being processed any
+  further)
+* Fixed:    Fixed broken template file default/skeleton/lib/REQUIRE_NAME.rb.
+* Improved: Added executables detection and setting of spec.executables to
+  GEM\_NAME.gemspec.erb
+* Improved: Removed spec.date from GEM\_NAME.gemspec.erb
+
+
+
+2011-06-15 - Released Version 0.1.2
+-----------------------------------
+
+* Fixed:    Fixed a bug in the text of "gem help new"
+
+
+
+2011-06-13 - Released Version 0.1.1
+-----------------------------------
+
+* Fixed:    Fixed a small bug in the initial release
+
+
+
+2011-06-13 - Released Version 0.1.0
+-----------------------------------
+
+* Initial Release

data/README.markdown

@@ -0,0 +1,41 @@
+GEM NEW
+=======
+
+
+
+Summary
+-------
+Create new gems easily
+
+
+
+Quick Install & Usage
+---------------------
+1. `gem install gem-new`
+2. `gem new my_new_gems_name`
+3. Profit!
+
+See `gem help new` for more information (only available after you installed the `gem-new`
+gem).
+
+
+
+Description
+-----------
+Gem-new is a gem command plugin that allows you to easily create a new gem.
+To facilitate gem creation, it relies on directory templates. You can create your own templates and
+let a template use other templates. For example you could have a 'rails-plugin' template, which
+includes a 'git-repository', 'rspec', 'ruby-lib' and 'yard' template. This way you can modularly
+build up your templates and quickly create matching directory structures.
+
+
+
+Executable
+----------
+Use `gem help new` for information on how to use the gem-new executable.
+
+
+
+Known Bugs and Issues
+---------------------
+Go to https://github.com/apeiros/gem-new/issues

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.expand_path('../rake/lib', __FILE__))
+Dir.glob(File.expand_path('../rake/tasks/**/*.{rake,task,rb}', __FILE__)) do |task_file|
+  begin
+    import task_file
+  rescue LoadError => e
+    warn "Failed to load task file #{task_file}"
+    warn "  #{e.class} #{e.message}"
+    warn "  #{e.backtrace.first}"
+  end
+end

data/data/gem-new/default/description.txt

@@ -0,0 +1,2 @@
+The default template for gem new. It is very minimalistic and will only generate the basic
+structure of a rubygem, without anything in it.

data/data/gem-new/default/meta.yaml

@@ -1,3 +1,3 @@
 ---
-version:  1
+version:  2
 includes: []

data/data/gem-new/default/skeleton/GEM_NAME.gemspec.erb

@@ -4,8 +4,9 @@ Gem::Specification.new do |s|
   s.name                      = <%= gem_name.inspect %>
   s.version                   = <%= version.to_s.inspect %>
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1")
+  # According to Eric Hodel (Rubygems maintainer), you should generally not set this value
+  # s.date                      = <%= date.inspect %>
   s.authors                   = <%= author.inspect %>
-  s.date                      = <%= date.inspect %>
   s.description               = <<-DESCRIPTION.gsub(/^    /, '').chomp
 <%= description && description.gsub(/^/,'    ') %>
   DESCRIPTION
@@ -24,6 +25,10 @@ Gem::Specification.new do |s|
       README.markdown
     ]
   s.require_paths             = %w[lib]
+  if File.directory?('bin') then
+    executables = Dir.chdir('bin') { Dir.glob('**/*').select { |f| File.executable?(f) } }
+    s.executables = executables unless executables.empty?
+  end
   s.rubygems_version          = "1.3.1"
   s.specification_version     = 3
 end

data/data/gem-new/default/skeleton/Rakefile

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.expand_path('../rake/lib', __FILE__))
 Dir.glob(File.expand_path('../rake/tasks/**/*.{rake,task,rb}', __FILE__)) do |task_file|
   begin
-    require task_file
+    import task_file
   rescue LoadError => e
     warn "Failed to load task file #{task_file}"
     warn "  #{e.class} #{e.message}"

data/data/gem-new/default/skeleton/lib/REQUIRE_NAME.rb.erb

@@ -1,24 +1,12 @@
 # encoding: utf-8
 
-Gem::Specification.new do |s|
-  s.name                      = "gem-new"
-  s.version                   = "0.1.0"
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1")
-  s.authors                   = ["Stefan Rusterholz"]
-  s.date                      = "2011-06-10"
-  s.default_executable        = "baretest"
-  s.description               = <<-DESCRIPTION.chomp
-    Gem-new is a gem command plugin that allows you to easily create a new gem.
-  DESCRIPTION
-  s.summary                   = <<-SUMMARY.chomp
-    Create new gems easily
-  SUMMARY
-  s.email                     = "stefan.rusterholz@gmail.com"
-  s.files                     = %w[
-    lib/rubygems_plugin.rb
-  ]
-  s.homepage                  = "http://github.com/apeiros/gem-new"
-  s.require_paths             = %w[lib]
-  s.rubygems_version          = "1.3.1"
-  s.specification_version     = 3
+
+
+require '<%= require_name %>/version'
+
+
+
+# <%= namespace.chomp %>
+<%= description.gsub(/\n*\z/, '').gsub(/^/, '# ')+"\n" %>
+module <%= namespace %>
 end

data/data/gem-new/default/skeleton/lib/REQUIRE_NAME/version.rb.erb

@@ -1,6 +1,10 @@
 # encoding: utf-8
 
-require 'gem/version'
+begin
+  require 'rubygems/version' # newer rubygems use this
+rescue LoadError
+  require 'gem/version' # older rubygems use this
+end
 
 module <%= namespace %>
   Version = Gem::Version.new(<%= version.to_s.inspect %>)

data/data/gem-new/gem-raketasks/description.txt

@@ -0,0 +1 @@
+This template provides a couple of rake tasks related to building your gem.

data/data/gem-new/gem-raketasks/meta.yaml

@@ -0,0 +1,3 @@
+---
+version:  1
+includes: []

data/data/gem-new/gem-raketasks/skeleton/rake/tasks/gem.rake

@@ -0,0 +1,21 @@
+begin
+  require 'rubygems/package_task'
+rescue
+  require 'gem/package_task'
+end
+
+namespace :gem do
+  spec_files = Dir.glob('*.gemspec')
+  abort("No gemspec found in project-root") if spec_files.empty?
+  abort("More than one gemspec found in project-root: #{spec.join(', ')}") if spec_files.size > 1
+  gem_spec    = Gem::Specification.load(spec_files.first)
+
+  Gem::PackageTask.new(gem_spec) do |pkg|
+    pkg.package_dir = 'pkg'
+    pkg.need_zip    = false
+    pkg.need_tar    = false
+  end
+end
+
+desc "Clobbers previous products and builds the gem"
+task :gem => ['gem:clobber_package', 'gem:gem']

data/lib/gem/commands/new_command.rb

@@ -37,9 +37,17 @@ class Gem::Commands::NewCommand < Gem::Command
     add_option('--variables', 'Show all available variables') do |value, opts|
       opts[:variables] = value
     end
+    add_option('--version', 'Show gem-new version and exit') do |value, opts|
+      opts[:version] = true
+    end
   end
 
   def execute
+    if options[:version] then
+      puts "gem-new version #{VERSION}"
+      return
+    end
+
     if File.exist?(ConfigPath) then
       if Configuration.new(ConfigPath).config_version < ConfigVersion then
         FileUtils.mv(ConfigPath, "#{ConfigPath}.bak")
@@ -267,6 +275,7 @@ private
       path_variables: {}
     YAML
     FileUtils.mkdir_p(File.dirname(ConfigPath))
+    FileUtils.mkdir_p(UserTemplatesDir.last)
     File.open(ConfigPath, 'wb') { |fh| fh.write(yaml) }
   end
 
@@ -286,6 +295,6 @@ private
   end
 
   def camelcase(string)
-    string.gsub(/(?:^|_)([a-z])/) { |m| $1.upcase }
+    string.gsub(/(?:^|_)([a-z])/) { $1.upcase }
   end
 end

data/lib/gem/commands/new_command/skeleton.rb

@@ -6,22 +6,42 @@ require 'gem/commands/new_command/erb_template'
 
 
 class Gem::Commands::NewCommand < Gem::Command
+  # Preregistered processors
+  # * .erb:  Interprets the file as ERB template, see rubys stdlib docs on ERB.
+  # * .stop: Stops the preprocessing chain, it's advised to add that to all files.
+  # * .rb:   Same as .stop
+  # * .yaml: Same as .stop
+  # * .html: Same as .stop
+  # * .js:   Same as .stop
+  # * .png:  Same as .stop
+  # * .jpg:  Same as .stop
+  # * .gif:  Same as .stop
+  #   
   class Skeleton
     DefaultOptions  = {
       :verbose  => false,
       :silent   => false,
       :out      => $stdout,
     }
-    Processors = {}
+    Processors = {
+      '.stop' => nil,
+      '.rb'   => nil,
+      '.yaml' => nil,
+      '.html' => nil,
+      '.js'   => nil,
+      '.png'  => nil,
+      '.jpg'  => nil,
+      '.gif'  => nil,
+    }
     Processor  = Struct.new(:suffix, :name, :execute)
-    
+
     def self.register_processor(suffix, name, &execute)
+      raise ArgumentError, "A processor named #{suffix.inspect} is already registered" if Processors[suffix]
+      raise TypeError, "Processor name must be a String, but is #{suffix.class}:#{suffix.inspect}" unless suffix.is_a?(String)
+
       Processors[suffix] = Processor.new(suffix, name, execute)
     end
 
-    register_processor '.literal', 'Literal' do |template, variables|
-      template
-    end
     register_processor '.erb', 'ERB' do |template, variables|
       ErbTemplate.replace(template, variables)
     end
@@ -100,25 +120,33 @@ class Gem::Commands::NewCommand < Gem::Command
 
     def source_to_target_path_and_processors(source_path, target_dir, replacer)
       replaced_source   = replacer.replace(source_path[@source_slice])
-      extname           = File.extname(replaced_source)
+      processed_source  = replaced_source.dup
       processors        = []
-      processed_source  = replaced_source
 
-      if processor = Processors[extname] then
-        processors      << processor
-        processed_source = processed_source.chomp(extname)
+      while processor = extract_processor_from_path(processed_source)
+        processors << processor
       end
       target_path = File.join(target_dir, processed_source)
-#       while processor = Processors[extname]
-#         processors       << processor
-#         processed_source  = File.basename(processed_source, extname)
-#         extname           = File.extname(processed_source)
-#       end
 
       [target_path, processors]
     end
 
   private
+    # @param [String] path
+    #   The path to extract the processor from.
+    #   BEWARE! The string referenced by path will be mutated. The extension is being
+    #   removed.
+    #
+    # @return [Processor, nil]
+    #   Returns the processor or nil
+    def extract_processor_from_path(path)
+      extname   = File.extname(path)
+      processor = Processors[extname]
+      path.chomp!(extname) if processor
+
+      processor
+    end
+
     def info(msg)
       @out.puts msg unless @silent
     end

data/lib/gem/commands/new_command/version.rb

@@ -1,3 +1,3 @@
 class Gem::Commands::NewCommand < Gem::Command
-  VERSION = Gem::Version.new("0.1.0")
+  VERSION = Gem::Version.new("0.2.0")
 end

data/rake/tasks/gem.rake

@@ -0,0 +1,21 @@
+begin
+  require 'rubygems/package_task'
+rescue
+  require 'gem/package_task'
+end
+
+namespace :gem do
+  spec_files = Dir.glob('*.gemspec')
+  abort("No gemspec found in project-root") if spec_files.empty?
+  abort("More than one gemspec found in project-root: #{spec.join(', ')}") if spec_files.size > 1
+  gem_spec    = Gem::Specification.load(spec_files.first)
+
+  Gem::PackageTask.new(gem_spec) do |pkg|
+    pkg.package_dir = 'pkg'
+    pkg.need_zip    = false
+    pkg.need_tar    = false
+  end
+end
+
+desc "Clobbers previous products and builds the gem"
+task :gem => ['gem:clobber_package', 'gem:gem']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-new
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-10 00:00:00.000000000 Z
+date: 2011-06-10 00:00:00.000000000Z
 dependencies: []
 description: ! '    Gem-new is a gem command plugin that allows you to easily create
   a new gem.'
@@ -18,15 +18,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- data/gem-new/default/description.txt
 - data/gem-new/default/meta.yaml
 - data/gem-new/default/skeleton/GEM_NAME.gemspec.erb
 - data/gem-new/default/skeleton/lib/REQUIRE_NAME/version.rb.erb
 - data/gem-new/default/skeleton/lib/REQUIRE_NAME.rb.erb
 - data/gem-new/default/skeleton/Rakefile
-- data/gem-new/default/skeleton/README.markdown.literal
+- data/gem-new/default/skeleton/README.markdown.stop.erb
 - data/gem-new/default/skeleton/README_DIRECTORIES
 - data/gem-new/gem-new-template/meta.yaml
 - data/gem-new/gem-new-template/skeleton/data/GEM_NAME/your_template_name/meta.yaml
+- data/gem-new/gem-raketasks/description.txt
+- data/gem-new/gem-raketasks/meta.yaml
+- data/gem-new/gem-raketasks/skeleton/rake/tasks/gem.rake
 - data/gem-new/default/skeleton/bin/.gitkeep
 - data/gem-new/default/skeleton/development/.gitkeep
 - data/gem-new/default/skeleton/documentation/.gitkeep
@@ -35,6 +39,8 @@ files:
 - data/gem-new/default/skeleton/rake/tasks/.gitkeep
 - data/gem-new/default/skeleton/test/.gitkeep
 - data/gem-new/gem-new-template/skeleton/data/GEM_NAME/your_template_name/skeleton/.gitkeep
+- data/gem-new/gem-raketasks/skeleton/rake/lib/.gitkeep
+- data/gem-new/gem-raketasks/skeleton/rake/tasks/.gitkeep
 - lib/gem/commands/new_command/blank_slate.rb
 - lib/gem/commands/new_command/configuration.rb
 - lib/gem/commands/new_command/erb_template.rb
@@ -43,6 +49,10 @@ files:
 - lib/gem/commands/new_command/version.rb
 - lib/gem/commands/new_command.rb
 - lib/rubygems_plugin.rb
+- rake/tasks/gem.rake
+- HISTORY.markdown
+- Rakefile
+- README.markdown
 homepage: https://github.com/apeiros/gem-new
 licenses: []
 post_install_message: 
@@ -63,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Create new gems easily