rmm5t-yarg 0.1.0

data/README.markdown

@@ -0,0 +1,53 @@
+# yarg: Yet Another Ruby Generator
+
+Yarg is Yet Another Ruby Generator.  It allows you to customize existing project
+generators to fit your personality or common scaffolding.
+
+**Yarg is still in its infancy.  It currently works for rails generation, but use it at your own risk.**
+
+## Usage
+
+Install:
+
+    gem install rmm5t-yarg --source http://gems.github.com
+
+Configure by placing a <tt>~/.yarg</tt> file in your home directory.  Here's a simple example
+
+    Yarg::Rails.new do |rg|
+      rg.scm :git
+      rg.delete "public/index.html"
+      rg.delete "public/dispatch.*"
+      rg.plugin "git://github.com/thoughtbot/shoulda.git"
+      rg.plugin "git://github.com/nex3/haml.git"
+      rg.freeze
+    end
+
+Here's another example:
+
+    Yarg::Rails.new do |rg|
+      rg.scm :git, :using => :submodules
+      rg.delete "public/index.html"
+      rg.delete "public/dispatch.*"
+      rg.plugin "git://github.com/thoughtbot/shoulda.git"
+      rg.plugin "git://github.com/nex3/haml.git"
+      rg.plugin "git://github.com/rmm5t/strip_attributes.git"
+      rg.plugin "git://github.com/github/hubahuba.git"
+      rg.freeze :version => :edge
+    end
+
+## TODO
+
+* Add better option parsing support in script
+* Add template directory support
+* Add rails gem freezing support
+* Add newgem support
+* Add merb support
+* Add webby support
+* Add staticmatic support
+* Add svn support (?)
+
+## Other
+
+[MIT License](http://www.opensource.org/licenses/mit-license.php)
+
+Copyright (c) 2008, Ryan McGeary (ryanonruby -[at]- mcgeary [*dot*] org)

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'lib/yarg'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the yarg gem.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the yarg gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Yarg'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name              = "yarg"
+  s.version           = Yarg::VERSION
+  s.summary           = "Yet Another Ruby Generator"
+  s.homepage          = "http://github.com/rmm5t/yarg"
+#   s.rubyforge_project = "yarg"
+
+  s.files       = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+  s.executables = s.files.grep(/^bin/) { |f| File.basename(f) }
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.markdown"]
+  s.rdoc_options     = ["--line-numbers", "--inline-source", "--main", "README.markdown"]
+
+  s.authors = ["Ryan McGeary"]
+end
+
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/bin/yarg

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'yarg'
+require 'yarg/rails'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} /path/to/your/project"
+
+  opts.on("-h", "--help", "Show this help info and quit") do
+    puts opts
+    exit 0
+  end
+
+  opts.on("-v", "--version", "Show the Yarg version number and quit") do
+    puts "Yarg #{Yarg::VERSION}"
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+#TODO test if file exists
+load "~/.yarg"
+
+#TODO check ARGV size
+ENV["PROJECT_NAME"] = ARGV[0]
+
+#TODO allow for default or for named task
+Rake::Task[:rails].invoke

data/lib/yarg/file_actions.rb

@@ -0,0 +1,64 @@
+require 'yarg/scm'
+
+module Yarg
+  module FileActions
+    # List of paths to delete. (default is NONE)
+    attr_accessor :deletions
+
+    # List of source template paths to overwrite files in the destination
+    # project. (default is NONE)
+    attr_accessor :templates
+
+    # Source control management module to use (default is NONE)
+    attr_accessor :scm_module
+
+    def initialize_file_actions
+      self.deletions = []
+      self.templates = []
+    end
+
+    def delete(relative_path)
+      self.deletions << relative_path
+    end
+
+    def template(absolute_path)
+      self.templates << absolute_path
+    end
+
+    def scm(scm, options = {})
+      self.scm_module = Scm.new(scm, options)
+    end
+
+    private
+
+    def apply_file_actions
+      apply_deletions
+      apply_templates
+      apply_scm_init
+    end
+
+    def apply_deletions
+      self.deletions.each do |path|
+        File.delete(*Dir.glob(path))
+      end
+    end
+
+    def apply_templates
+      # TODO
+    end
+
+    def apply_scm_init
+      exec_commands(self.scm_module.init_commands) if self.scm_module
+    end
+
+    def apply_scm_commit
+      exec_commands(self.scm_module.commit_commands) if self.scm_module
+    end
+
+    def exec_commands(commands)
+      commands.each do |command|
+        sh(command)
+      end
+    end
+  end
+end

data/lib/yarg/rails.rb

@@ -0,0 +1,86 @@
+require 'yarg'
+require 'yarg/file_actions'
+require 'rake/tasklib'
+
+module Yarg
+  # Create a task that customizes a Rails project generation bootstrap.
+  #
+  # Example (<tt>~/.yarg</tt>):
+  #
+  #   Yarg::Rails.new do |rg|
+  #     rg.template "~/.yarg.d/default"
+  #     rg.delete "public/index.html"
+  #     rg.delete "public/dispatch.*"
+  #     rg.plugin "git://github.com/thoughtbot/shoulda.git"
+  #     rg.plugin "git://github.com/nex3/haml.git"
+  #     rg.freeze :version => :edge
+  #   end
+  class Rails < Rake::TaskLib
+    include Yarg::FileActions
+
+    # Name of rails generator task. (default is :rails)
+    attr_accessor :name
+
+    # List of plugins to install. (default is NONE)
+    attr_accessor :plugins
+
+    # True if freezing rails under vendor/rails is desired. (default is false)
+    attr_accessor :frozen
+
+    # Version to freeze rails if frozen is true. (default is :gems)
+    attr_accessor :freeze_version
+
+    def initialize(name = :rails)
+      self.name = name
+      self.plugins = []
+      self.frozen = false
+      initialize_file_actions
+      yield self if block_given?
+      define
+    end
+
+    def plugin(repository)
+      self.plugins << repository
+    end
+
+    def freeze(options = {})
+      self.frozen = true
+      self.freeze_version = options[:version] || :gems
+    end
+
+    private
+
+    def define
+      task self.name do
+        app_name = ENV["PROJECT_NAME"]
+        sh("rails #{app_name}")
+        Dir.chdir(app_name)
+        apply_file_actions
+        apply_plugins
+        apply_freeze
+        apply_scm_commit
+      end
+      self
+    end
+
+    def apply_plugins
+      plugins.each do |plugin|
+        if scm_module && scm_module.using
+          plugin_name = File.basename(plugin, ".*")
+          exec_commands(scm_module.install_commands(plugin, "vendor/plugins/#{plugin_name}"))
+        else
+          sh("./script/plugin install #{plugin}")
+        end
+      end
+    end
+
+    def apply_freeze
+      return unless frozen
+      if scm_module && scm_module.using
+        exec_commands(scm_module.install_commands("git://github.com/rails/rails.git", "vendor/rails"))
+      elsif [:gems, :edge].include?(freeze_version.to_sym)
+        sh("rake rails:freeze:#{freeze_version}")
+      end
+    end
+  end
+end

data/lib/yarg/scm/git.rb

@@ -0,0 +1,21 @@
+module Yarg
+  module Scm
+    class Git < Base
+      def initialize(options = {})
+        super
+      end
+
+      def init_commands
+        ["git init"]
+      end
+
+      def commit_commands
+        ["git add .", "git commit -m 'Initial commit. Yarg!'"]
+      end
+
+      def install_commands(repository, destination)
+        ["git submodule add #{repository} #{destination}"]
+      end
+    end
+  end
+end

data/lib/yarg/scm.rb

@@ -0,0 +1,48 @@
+module Yarg
+  module Scm
+    class Base
+      attr_accessor :using
+
+      def initialize(options = {})
+        self.using = options[:using]
+      end
+
+      def init_commands
+        []
+      end
+
+      def commit_commands
+        []
+      end
+
+      def install(repository, destination)
+        raise NotImplementedError, "install is not implemented by #{self.class.name}"
+      end
+    end
+
+    def self.new(scm, options = {})
+      scm_const = scm.to_s.capitalize.gsub(/_(.)/) { $1.upcase }
+      load_scm(scm) unless const_defined?(scm_const)
+      initialize_scm(scm_const, options)
+    end
+
+    private
+
+    def self.load_scm(scm)
+      scm_path = "yarg/scm/#{scm}"
+      begin
+        require(scm_path)
+      rescue LoadError
+        raise Yarg::Error, "could not find an SCM at #{scm_path}"
+      end
+    end
+
+    def self.initialize_scm(scm_const, options)
+      if const_defined?(scm_const)
+        const_get(scm_const).new(options)
+      else
+        raise Yarg::Error, "could not find #{name}::#{scm_const}"
+      end
+    end
+  end
+end

data/lib/yarg.rb

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rake/tasklib'
+#require 'active_support'
+
+module Yarg
+  VERSION = "0.1.0"
+
+  class Error < RuntimeError; end
+end

data/test/file_actions_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+require 'yarg/file_actions'
+require 'yarg/scm/git'
+
+class FakeGen < Rake::TaskLib
+  include Yarg::FileActions
+
+  def initialize(name = :fake)
+    @name = name
+    initialize_file_actions
+    yield self if block_given?
+    define
+  end
+
+  private
+
+  def define
+    task @name do
+      project_name = ENV["PROJECT_NAME"]
+      Dir.mkdir(project_name)
+      Dir.chdir(project_name)
+      apply_file_actions
+      apply_scm_commit
+    end
+    self
+  end
+end
+
+class FileActionsTest < Test::Unit::TestCase
+  def setup
+    Rake::Task.clear
+  end
+
+  context "An empty Fake generator" do
+    setup do
+      @generator = FakeGen.new do |rg| end
+      stub_fake_system_calls("my_app")
+    end
+
+    should_define_task :fake
+    should_have_generator_attribute_of :scm_module, nil
+
+    context "once invoked" do
+      setup do
+        Rake::Task[:fake].invoke
+      end
+
+      should_cd_into "my_app"
+      should_not_delete_any_files
+      should_not_invoke %r{^git}
+      should_not_invoke %r{^svn}
+    end
+  end
+
+  context "An Fake generator using GIT" do
+    setup do
+      @generator = FakeGen.new do |rg|
+        rg.scm :git
+      end
+      stub_fake_system_calls("my_app")
+    end
+
+    should_define_task :fake
+    should_have_generator_attribute_of :scm_module, Yarg::Scm::Git
+
+    context "once invoked" do
+      setup do
+        Rake::Task[:fake].invoke
+      end
+
+      should_cd_into "my_app"
+      should_not_delete_any_files
+      should_invoke %r{^git init}
+      should_invoke %r{^git add}
+      should_invoke %r{^git commit}
+    end
+  end
+
+  private
+
+  def stub_fake_system_calls(project_name)
+    ENV["PROJECT_NAME"] = project_name
+    @generator.stubs(:sh)
+    Dir.stubs(:mkdir)
+    Dir.stubs(:chdir)
+    File.stubs(:delete)
+  end
+end

data/test/rails_test.rb

@@ -0,0 +1,143 @@
+require 'test_helper'
+require 'yarg/rails'
+
+class RailsTest < Test::Unit::TestCase
+  def setup
+    Rake::Task.clear
+  end
+
+  context "A missing Rails generator" do
+    should_not_define_task :rails
+  end
+
+  context "An empty default Rails generator" do
+    setup do
+      @generator = Yarg::Rails.new do |rg| end
+      stub_rails_system_calls("my_app")
+    end
+
+    should_define_task :rails
+    should_have_generator_attribute_of :name,      :rails
+    should_have_generator_attribute_of :deletions, []
+    should_have_generator_attribute_of :plugins,   []
+    should_have_generator_attribute_of :templates, []
+    should_have_generator_attribute_of :frozen,    false
+    should_have_generator_attribute_of :freeze_version, nil
+
+    context "once invoked" do
+      setup do
+        Rake::Task[:rails].invoke
+      end
+
+      should_run_rails_command_for_app "my_app"
+      should_cd_into "my_app"
+      should_not_delete_any_files
+      should_not_invoke %r{^\./script/plugin install}
+      should_not_invoke %r{^rake rails:freeze}
+      should_eventually "not overwrite with any templates"
+    end
+  end
+
+  context "A Rails generator with multiple options set" do
+    setup do
+      @generator = Yarg::Rails.new(:template) do |rg|
+        rg.scm :git, :using => :submodules
+        rg.delete "public/index.html"
+        rg.delete "public/dispatch.*"
+        rg.plugin "git://github.com/thoughtbot/shoulda.git"
+        rg.plugin "git://github.com/nex3/haml.git"
+        rg.template "~/.yarg.d/rails"
+        rg.freeze :version => :edge
+      end
+      stub_rails_system_calls("my_rails_project")
+    end
+
+    should_define_task :template
+    should_have_generator_attribute_of :name,       :template
+    should_have_generator_attribute_of :scm_module, Yarg::Scm::Git
+    should_have_generator_attribute_of :deletions,  %w(public/index.html public/dispatch.*)
+    should_have_generator_attribute_of :plugins,    %w(git://github.com/thoughtbot/shoulda.git git://github.com/nex3/haml.git)
+    should_have_generator_attribute_of :templates,  %w(~/.yarg.d/rails)
+    should_have_generator_attribute_of :frozen,     true
+    should_have_generator_attribute_of :freeze_version, :edge
+
+    context "once invoked" do
+      setup do
+        Rake::Task[:template].invoke
+      end
+
+      should_run_rails_command_for_app "my_rails_project"
+      should_cd_into "my_rails_project"
+      should_delete "public/index.html"
+      should_delete "public/dispatch.cgi", "public/dispatch.fcgi", "public/dispatch.rb"
+      should_invoke "git submodule add git://github.com/thoughtbot/shoulda.git vendor/plugins/shoulda"
+      should_invoke "git submodule add git://github.com/nex3/haml.git vendor/plugins/haml"
+      should_invoke "git submodule add git://github.com/rails/rails.git vendor/rails"
+      should_invoke %r{^git init}
+      should_invoke %r{^git add}
+      should_invoke %r{^git commit}
+      should_eventually "overwrite with the template"
+    end
+  end
+
+  context "A Rails generator with a default freeze" do
+    setup do
+      @generator = Yarg::Rails.new do |rg|
+        rg.freeze
+      end
+      stub_rails_system_calls("my_app")
+    end
+
+    should_have_generator_attribute_of :frozen, true
+    should_have_generator_attribute_of :freeze_version, :gems
+
+    context "once invoked" do
+      setup do
+        Rake::Task[:rails].invoke
+      end
+
+      should_run_rails_command_for_app "my_app"
+      should_cd_into "my_app"
+      should_not_invoke %r{^\./script/plugin install}
+      should_invoke "rake rails:freeze:gems"
+      should_eventually "not overwrite with any templates"
+    end
+  end
+
+  context "A Rails generator with a default scm" do
+    setup do
+      @generator = Yarg::Rails.new do |rg|
+        rg.scm :git
+        rg.plugin "git://github.com/nex3/haml.git"
+        rg.freeze :version => :edge
+      end
+      stub_rails_system_calls("my_app")
+    end
+
+    should_have_generator_attribute_of :scm_module, Yarg::Scm::Git
+
+    context "once invoked" do
+      setup do
+        Rake::Task[:rails].invoke
+      end
+
+      should_invoke "./script/plugin install git://github.com/nex3/haml.git"
+      should_invoke "rake rails:freeze:edge"
+      should_invoke %r{^git init}
+      should_invoke %r{^git add}
+      should_invoke %r{^git commit}
+    end
+  end
+
+  private
+
+  def stub_rails_system_calls(app_name)
+    ENV["PROJECT_NAME"] = app_name
+    @generator.stubs(:sh)
+    Dir.stubs(:chdir)
+    Dir.stubs(:glob)
+    Dir.stubs(:glob).with("public/index.html").returns(%w(public/index.html))
+    Dir.stubs(:glob).with("public/dispatch.*").returns(%w(public/dispatch.cgi public/dispatch.fcgi public/dispatch.rb))
+    File.stubs(:delete)
+  end
+end

data/test/scm_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'yarg/scm'
+require 'yarg/scm/git'
+
+class Yarg::Scm::Custom < Yarg::Scm::Base
+  def initialize(options = {})
+  end
+end
+
+class ScmTest < Test::Unit::TestCase
+  def setup
+    Rake::Task.clear
+  end
+
+  context "Creating a new git SCM" do
+    setup do
+      @scm = Yarg::Scm.new(:git)
+    end
+
+    should_change "@scm", :to => Yarg::Scm::Git
+
+    should "return git init commands" do
+      assert_equal ["git init"], @scm.init_commands
+    end
+
+    should "return git commit commands" do
+      assert_equal ["git add .", "git commit -m 'Initial commit. Yarg!'"], @scm.commit_commands
+    end
+
+    should "return git install commands" do
+      assert_equal ["git submodule add git://example.com/foo.git vendor/plugins/foo"], @scm.install_commands("git://example.com/foo.git", "vendor/plugins/foo")
+    end
+  end
+
+  context "Creating a new custom SCM" do
+    setup do
+      @scm = Yarg::Scm.new(:custom)
+    end
+
+    should_change "@scm", :to => Yarg::Scm::Custom
+
+    should "return empty init commands" do
+      assert @scm.init_commands.empty?
+    end
+
+    should "return empty commit commands" do
+      assert @scm.commit_commands.empty?
+    end
+
+    should "raise error on install request" do
+      assert_raise NotImplementedError do
+        @scm.install(:a, :b)
+      end
+    end
+  end
+
+  context "Creating a new unknown SCM" do
+    should "fail" do
+      assert_raise Yarg::Error do
+        @scm = Yarg::Scm.new(:unknown)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+begin require 'redgreen' if ENV['TM_FILENAME'].nil?; rescue LoadError; end
+require 'yarg'
+
+module ShouldaHelper
+  module Macros
+    def should_define_task(task)
+      should "define the task #{task.inspect}" do
+        assert Rake::Task.task_defined?(task)
+      end
+    end
+
+    def should_not_define_task(task)
+      should "not define the task #{task.inspect}" do
+        assert !Rake::Task.task_defined?(task)
+      end
+    end
+
+    def should_cd_into(directory)
+      before_should "chdir into #{directory}" do
+        Dir.expects(:chdir).with(directory)
+      end
+    end
+
+    def should_have_generator_attribute_of(attribute, expected)
+      should "have attribute of #{attribute.inspect} matching #{expected.inspect}" do
+        assert_operator expected, :===, @generator.send(attribute)
+      end
+    end
+
+    def should_run_rails_command_for_app(app_name)
+      before_should "execute rails system call for #{app_name}" do
+        @generator.expects(:sh).with("rails #{app_name}")
+      end
+    end
+
+    def should_delete(*files)
+      before_should "delete #{files.inspect}" do
+        File.expects(:delete).with(*files)
+      end
+    end
+
+    def should_not_delete_any_files
+      before_should "not delete any files" do
+        File.expects(:delete).never
+      end
+    end
+
+    def should_invoke(matching_command)
+      before_should "invoke #{matching_command.inspect}" do
+        @generator.expects(:sh).with { |value|
+          matching_command === value
+        }
+      end
+    end
+
+    def should_not_invoke(matching_command)
+      before_should "not invoke #{matching_command.inspect}" do
+        @generator.expects(:sh).with { |value|
+          matching_command === value
+        }.never
+      end
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  extend ShouldaHelper::Macros
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: rmm5t-yarg
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan McGeary
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-12 00:00:00 -08:00
+default_executable: yarg
+dependencies: []
+
+description: 
+email: 
+executables: 
+- yarg
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- Rakefile
+- README.markdown
+- bin/yarg
+- lib/yarg
+- lib/yarg/file_actions.rb
+- lib/yarg/rails.rb
+- lib/yarg/scm
+- lib/yarg/scm/git.rb
+- lib/yarg/scm.rb
+- lib/yarg.rb
+- test/file_actions_test.rb
+- test/rails_test.rb
+- test/scm_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rmm5t/yarg
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Yet Another Ruby Generator
+test_files: []
+