gemify 0.3 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+== 0.4
+* Gemify is now a gemspec generator!
+
 == 0.3
 * Gemify is now a gemspec editor!
 
@@ -35,4 +38,4 @@
 * Added a very fancy CLI
 
 == 0.1.0 - 2008-02-07
-* The first release. More like a POC-code
+* The first release. More like a POC-code

data/README.md

@@ -1,71 +1,54 @@
-Gemify, the lightweight gemspec editor
-======================================
+Gemify, the gemspec generator
+=============================
 
 Overview
 --------
 
-Gemify is a simple tool which helps you create and manage your gemspecs.
-Instead of messing with Rakefiles and adding yet another development
-dependency (like Hoe, Echoe and Jeweler), Gemify takes a much less obtrusive
-approach.
-
-Gemify works directly on the .gemspec file. In fact, when you're using Gemify,
-you're only using it as an editor. If you want, you could just edit the file
-manually.
+Gemify is a simple tool which helps you generate gemspecs (which are
+used for building gems) and verify that your project follows the common
+and proven way to structure your Ruby packages.
 
 Getting started
 ---------------
 
+Generating gemspec:
+
     $ gem install gemify
-    $ cd myproject (might already have a gemspec)
+    $ cd myproject (which doesn't have a gemspec yet)
     $ gemify
-    Currently editing gemify.gemspec
-
-    Which task would you like to invoke?
-    1) Change name (required) = gemify
-    2) Change summary (required) = The lightweight gemspec editor
-    3) Change version (required) = 0.3
-    4) Change author = Magnus Holm
-    5) Change email = judofyr@gmail.com
-    6) Change homepage = http://dojo.rubyforge.org/
-    7) Set dependencies
-
-    s) Save
-    r) Reload (discard unsaved changes)
-    m) Rename
-    l) List files
+    Gemify needs to know a bit about your project, but should be
+    able to guess most of the information. Type the value if you
+    need to correct it, or press ENTER to accept the suggestion by Gemify.
 
-    x) Exit
+    Project name:        gemify? 
+    Namespace:           Gemify? 
+    Library:             lib/gemify? 
 
-    > 
+    *** Verifying the structure of lib/
+    [+] Please consider to define Gemify::VERSION in lib/gemify/version.rb
+    [.] Done
 
-### Manifest
+    *** Verifying the structure of bin/
+    [.] Done
 
-Gemify helps you manage the manifest (files which will be included in the gem). It follows these rules:
+    *** Verifying the structure of ext/
+    [.] Done
 
-* If there's a file called **MANIFEST**, **Manifest.txt** or **.manifest**, it
-  assumes this files contains a line-separated list of the manifest.
+    *** Generating a gemspec
+    [.] Done
 
-* If not, it checks if you're using Git, Mercurial, Darcs, Bazaar, Subversion
-  or CVS and uses the commited files.
+    Please open gemify.gemspec in your text editor and fill out the details.
 
-* If not, it just includes all the files.
+    You should fix any warnings that was reported above. You won't need to
+    generate a new gemspec after you've fixed them.
 
-You can always run `gemify -m` to see the manifest, and if you don't like what
-you see you should maintain a manifest file yourself. Every time you open
-Gemify and save, it will update the manifest. You can also call `gemify -u`.
+    You must also define Gemify::VERSION in lib/gemify/version.rb.
+    Gemify has automatically created the file for you, so simply
+    open it in your text editor and fill in the current version.
+    
+Or if you just want to verify it:
 
-### Dependencies
-
-When you set dependencies, you can separate the version requirement by a
-comma:
-
-    $ gemify
-    ...
-    > 7
-    Split by ENTER and press ENTER twice when you're done
-    > nokogiri
-    > rack, >= 1.0  
+    $ gemify -v
 
 ### Build and share a gem
 
@@ -78,8 +61,8 @@ Let's not reinvent the wheel, shall we?
 Acknowledgements
 ----------------
 
-Thanks to [Pat Nakajima](http://patnakajima.com/) for reminding me that Gemify
-still has its uses.
+Thanks to [Pat Nakajima](http://patnakajima.com/) for reminding me that
+Gemify still has its uses.
 
 
 Contributors

data/Rakefile

@@ -0,0 +1,3 @@
+task :test do
+  sh "ruby -Ilib test/test_gemify.rb"
+end

data/bin/gemify

@@ -1,57 +1,265 @@
 #!/usr/bin/env ruby
-
-$:.unshift File.dirname(__FILE__) + '/../lib'
 require 'gemify'
-require 'trollop'
-
-gemspec = nil
-actions = [:new, :update, :manifest]
-
-opts = Trollop.options do
-  version "gemify 0.3"
-  banner <<-EOS
-Usage: #{$0} [OPTION]... [FILE]
-A simple gemspec editor
-  
-  EOS
-  
-  opt :new, "Create a new gemspec"
-  opt :update, "Update the manifest"
-  opt :manifest, "Dump the manifest"
-end
-
-action = opts.detect { |opt, val| actions.include?(opt) && val }
-action = action[0] unless action.nil?
-
-if action == :new
-  # do nothing
-elsif (arg = ARGV.shift).nil?
-  gemspecs = Dir['*.gemspec']
-  gemspec = case gemspecs.length
-  when 0
-    nil
-  when 1
-    gemspecs.first
-  else
-    gemspecs
-  end
-elsif File.exists?(arg)
-  gemspec = arg
-else
-  Trollop.die "No such file: #{arg}"
-end
-
-Trollop.die "Extra operand: #{ARGV[0]}" unless ARGV.empty?
-  
-cli = Gemify::CLI.load(gemspec)
-
-case action
-when :update
-  cli.update_manifest
-  cli.save
-  puts "Updated manifest (to #{cli.base.files.length} files)"
-when :manifest
-  puts cli.base.inspect_files
-else
-  cli.main
+require 'gemify/version'
+require 'fileutils'
+include Gemify
+include FileUtils
+
+options, args = ARGV.partition { |a| a[0] == ?- }
+verify_only = options.include?('-v')
+force = options.include?('-f')
+
+if options.grep(/^--?(h|\?)/).first
+  puts <<-EOF
+Gemify v#{Gemify::VERSION}
+
+Verify project and generate gemspec:
+  #$0
+
+Only verify project:
+  #$0 -v
+
+Show help:
+  #$0 -h
+EOF
+  exit
+end
+
+puts <<-EOF
+Gemify needs to know a bit about your project, but should be
+able to guess most of the information. Type the value if you
+need to correct it, or press ENTER to accept the suggestion by Gemify.
+
+EOF
+
+name = clean_name(args.shift || File.basename(Dir.pwd))
+name = ask "Project name", name
+
+namespace = name_to_namespace(name)
+namespace = ask "Namespace", namespace
+
+library = namespace_to_library(namespace)
+library = ask "Library", 'lib/' + library
+library = 'lib/' + library unless library =~ /^lib\//
+puts
+
+gemspec = "#{name}.gemspec"
+
+if !force && !verify_only && File.exists?(gemspec)
+  puts <<-EOF
+*** Gemspec already exists!
+Either remove the gemspec:
+  mv #{gemspec} #{gemspec}.old
+
+Or run the verifier only:
+  #{$0} -v #{ARGV.join(' ')}
+
+Or force an overwrite:
+  #{$0} -f #{ARGV.join(' ')}
+EOF
+  exit
+end
+
+
+## Verify files
+
+puts "*** Verifying the structure of lib/"
+
+Dir["lib/**/*"].each do |file|
+  next if File.directory?(file)
+  next if file =~ /^lib\/tasks/
+  
+  if File.extname(file) != ".rb"
+    w :lib_rb, "Non-Ruby library: #{file}"
+  end
+  
+  if file !~ /^#{Regexp.escape(library)}(\.rb|\/)/
+    w :lib_leaky, "Library pollution: #{file}"
+  end
+  
+  mode = File.stat(file).mode.to_s(8)[-4..-1]
+  if mode != "0644"
+    w :bin_mode, "Wrong permission (#{mode}): #{file}"
+  end
+end
+
+if w? :lib_rb
+  n "Please consider moving any library non-Ruby files to the data/ directory"
+end
+
+if w? :lib_leaky
+  n "Please consider moving all your library files to the #{library}/ directory"
+end
+
+if w? :lib_perm
+  n "Please consider to chmod all your library files to 0644"
+  if yes "  Should Gemify do this for you?"
+    Dir["lib/**/*"].each do |file|
+      next if File.directory?(file)
+      chmod(0644, file)
+    end
+  end
+end
+
+version_require = library[4..-1] + '/version'
+version_file = library + '/version.rb'
+version = File.exists?(version_file)
+
+unless version
+  n "Please consider to define #{namespace}::VERSION in #{version_file}"
+end
+
+puts "[.] Done"
+
+puts
+puts "*** Verifying the structure of bin/"
+
+shebang = "#!/usr/bin/env ruby"
+
+Dir["bin/*"].each do |file|
+  next if File.directory?(file)
+  
+  File.open(file) do |f|
+    if f.read(shebang.length) != shebang
+      w :shebang, "Missing shebang: #{file}"
+    end
+  end
+  
+  if File.extname(file) == ".rb"
+    w :bin_rb, ".rb extension: #{file}"
+  end
+  
+  mode = File.stat(file).mode.to_s(8)[-4..-1]
+  if mode != "0755"
+    w :bin_mode, "Wrong permission (#{mode}): #{file}"
+  end
+end
+
+if w? :shebang 
+  n "Please consider to add '#{shebang}' to all binaries"
+end
+
+if w? :bin_rb
+  n "Please consider that binaries should NOT end in .rb"
+end
+
+if w? :bin_mode
+  n "Please consider to chmod all your binary files to 0755"
+  if yes "  Should Gemify do this for you?"
+    Dir["bin/*"].each do |file|
+      next if File.directory?(file)
+      chmod(0755, file)
+    end
+  end
+end
+
+puts "[.] Done"
+
+puts
+puts "*** Verifying the structure of ext/"
+
+Dir["ext/*"].each do |ext|
+  unless File.exists?(ext + '/extconf.rb')
+    w :ext_conf, "Missing extconf.rb: #{ext}"
+  end
+end
+
+if w? :ext_conf
+  n "All extensions MUST have a extconf.rb"
+end
+
+puts "[.] Done"
+
+exit if options.include?('-v')
+
+puts
+puts "*** Generating a gemspec"
+
+require 'erb'
+require 'time'
+
+now = Time.now.strftime('%Y-%m-%d')
+content = ERB.new(DATA.read).result(binding)
+File.open(gemspec, "w") do |f|
+  f << content
+end
+
+puts "[.] Done"
+puts
+puts <<EOF
+Please open #{gemspec} in your text editor and fill out the details.
+
+You should fix any warnings that was reported above. You won't need to
+generate a new gemspec after you've fixed them.
+EOF
+
+unless version
+  mkdir_p(File.dirname(version_file))
+
+  File.open(version_file, "w") do |f|
+    i = 0
+    mods = namespace.split("::")
+    mods.each do |mod|
+      f.puts("#{'  '*i}module #{mod}")
+      i += 1
+    end
+    
+    f.puts("#{'  '*i}VERSION = '0.0.1'")
+    
+    mods.each do
+      i -= 1
+      f.puts("#{'  '*i}end")
+    end
+  end
+  
+  puts
+  puts <<-EOF
+You must also define #{namespace}::VERSION in #{version_file}.
+Gemify has automatically created the file for you, so simply
+open it in your text editor and fill in the current version.
+EOF
+end
+
+__END__
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require <%= version_require.inspect %>
+
+Gem::Specification.new do |s|
+  s.name     = <%= name.inspect %>
+  s.version  = <%= namespace %>::VERSION.dup
+  s.date     = <%= now.inspect %>
+  s.summary  = "TODO: Summary of project"
+  s.email    = "todo@project.com"
+  s.homepage = "http://todo.project.com/"
+  s.authors  = ['Me Todo']
+  
+  s.description = <<-EOF
+TODO: Long description 
+EOF
+  
+  dependencies = [
+    # Examples:
+    # [:runtime,     "rack",  "~> 1.1"],
+    # [:development, "rspec", "~> 2.1"],
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = <%= Gem::VERSION.inspect %>
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
 end