basis 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 / 2008-04-17
+
+* Initial pre-release.

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/basis
+lib/basis/engine.rb
+lib/basis/errors.rb
+lib/basis/options.rb
+lib/basis/templates.rb
+lib/basis/templates/base.rb
+lib/basis/templates/git.rb
+lib/basis/templates/list.rb
+lib/basis/templates/local.rb
+lib/basis/templates/state.rb
+lib/basis/version.rb
+lib/templates.yml
+test/basis/engine_test.rb
+test/basis/options_test.rb
+test/basis/templates/base_test.rb
+test/basis/templates_test.rb
+test/fixtures/local/erb/erb.txt.erb
+test/fixtures/local/project.name/project.name.txt
+test/helper.rb

data/README.txt

@@ -0,0 +1,67 @@
+= basis
+
+* http://github.com/jbarnette/basis
+
+== DESCRIPTION:
+
+Basis is smart project skeletons. This is a very, very early release. Basis only
+knows how to deal with git:// urls and local file paths right now. Also, there's
+no documentation, no way to track remote template lists, dubious cache update
+semantics, bad command-line messaging, bad error reporting, and bad code.
+
+Honestly, installing this gem will probably melt your system.
+
+Basis owes a ton to Hoe, Mr. Bones, Rubigen, Newgem, and skel.
+
+== SYNOPSIS:
+
+  # List all available templates:
+  basis list
+
+  # Add a template to the local list:
+  basis add -n rails:example git://github.com/jbarnette/basis-rails.git
+
+  # Remove a template from the local list:
+  basis remove rails:example
+
+  # Show a local template's configuration:
+  basis show rails:example
+
+  # Update a local template (or all, without a template name):
+  basis update rails:example
+
+  # Generate a project in ./monkeys:
+  basis rails:example monkeys
+
+== REQUIREMENTS:
+
+* Subversion and Git (for some templates)
+
+== INSTALL:
+
+  sudo gem install basis
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 John Barnette <jbarnette@rubyforge.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+require "rubygems"
+require "hoe"
+require "./lib/basis/version.rb"
+
+Hoe.new("basis", Basis::VERSION) do |project|
+  project.developer("John Barnette", "jbarnette@rubyforge.org")
+  project.test_globs = ["test/**/*_test.rb"]
+end

data/bin/basis

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby -w
+
+require "rubygems"
+
+require "basis/engine"
+require "basis/errors"
+require "basis/options"
+
+begin
+  options = Basis::Options.parse!(ARGV)
+  Basis::Engine.new.send(options.verb, options)  
+rescue Basis::Errors::Reportable => e
+  abort e.message
+end

data/lib/basis/engine.rb

@@ -0,0 +1,78 @@
+require "pathname"
+
+require "basis/templates"
+
+module Basis
+  class Engine
+    attr_reader :home
+    
+    def initialize(home="~/.basis")
+      @home = File.expand_path(home)
+    end
+    
+    def list(options)
+      return if templates.empty?
+      
+      name_width = templates.collect { |t| t.name.size }.max
+      desc_width = 80 - name_width - 4
+      
+      templates.each do |template|
+        desc = template.description || "(no description)"
+        desc = desc[0, desc_width - 3] + "..." if desc.size > desc_width
+        printf("%-#{name_width}s  # #{desc}\n", template.name)
+      end
+    end
+    
+    def remove(options)
+      templates.reject! { |t| t.name == options.name }
+      templates.write!
+    end
+    
+    def add(options)
+      if templates.detect { |t| t.name == options.name || t.url == options.source }
+        raise Errors::TemplateAlreadyExists.new(options.name, options.source)
+      end
+      
+      template = Templates.create(self, options.source, :name => options.name)
+      template.update!
+      
+      templates << template
+      templates.write!
+    end
+    
+    def generate(options)
+      find_template(options.name).generate(options.destination)
+    end
+    
+    def update(options)
+      templates.select {|t| options.name.nil? || t.name == options.name }.each { |t| t.update! }
+    end
+    
+    def show(options)
+      # FIXME: terrible
+      puts YAML.dump(find_template(options.name))
+    end
+    
+    protected
+    
+    def find_template(name)
+      template = templates.detect {|t| t.name == name }
+      raise Errors::TemplateNotFound.new(name) unless template
+      template
+    end
+    
+    def templates
+      @templates ||= begin
+        template = Pathname.new(__FILE__).dirname + "../templates.yml"
+        file = Pathname.new(@home) + "templates.yml"
+        
+        unless file.exist?
+          file.dirname.mkpath
+          FileUtils.cp(template, file)
+        end
+
+        Templates::List.new(self, file)
+      end      
+    end
+  end
+end

data/lib/basis/errors.rb

@@ -0,0 +1,29 @@
+module Basis
+  module Errors
+    class Reportable < StandardError; end
+    
+    class TemplateAlreadyExists < Reportable
+      def initialize(name, url)
+        super("'#{name || url}' is already a template")
+      end
+    end
+
+    class DestinationAlreadyExists < Reportable
+      def initialize(destination)
+        super("#{destination} already exists")
+      end
+    end
+    
+    class TemplateNotFound < Reportable
+      def initialize(name)
+        super("template not found: #{name}")
+      end
+    end
+    
+    class UnknownTemplateScheme < Reportable
+      def initialize(raw_url)
+        super("don't know how to load '#{raw_url}'")
+      end
+    end
+  end
+end

data/lib/basis/options.rb

@@ -0,0 +1,98 @@
+require "optparse"
+
+require "basis/version"
+
+module Basis
+  class Options
+    VALID_VERBS = %w(add remove list update show)
+    
+    attr_reader :source, :destination, :name, :verb
+    
+    class << self
+      alias_method :parse!, :new
+    end
+    
+    def initialize(*args)
+      argv = args.flatten
+      
+      parser = OptionParser.new do |parser|
+        parser.banner = "Usage: basis [options] [verb]"
+        parser.version = Basis::VERSION
+        
+        parser.on("-h", "-?", "--help", "Show this message") do
+          puts parser
+          exit
+        end
+        
+        parser.on("-v", "--version", "Show version") do
+          puts Basis::VERSION
+          exit
+        end
+        
+        parser.on("-n", "--name [NAME]", "Override an added template's name") do |name|
+          @name = name
+        end
+        
+        # FIXME: This is lame. Document it better and stop misusing parser.separator.
+        
+        parser.separator ""
+        parser.separator "# List all available templates:"
+        parser.separator "basis list"
+        
+        parser.separator ""
+        parser.separator "# Add a template to the local list:"
+        parser.separator "basis add -n rails:edge git://github.com/jbarnette/basis-rails-edge.git"
+
+        parser.separator ""
+        parser.separator "# Remove a template from the local list:"
+        parser.separator "basis remove rails:edge"
+
+        parser.separator ""
+        parser.separator "# Show a local template's configuration:"
+        parser.separator "basis show rails:edge"
+
+        parser.separator ""
+        parser.separator "# Update a local template (or all, without a template name):"
+        parser.separator "basis update rails:edge"
+
+        parser.separator ""
+        parser.separator "# Generate a project in ./monkeys:"
+        parser.separator "basis rails:edge monkeys"        
+        parser.separator ""
+      end
+      
+      parser.parse!(argv)      
+      
+      verb_or_template_name = argv.shift
+      
+      if VALID_VERBS.include?(verb_or_template_name)
+        @verb = verb_or_template_name
+        
+        case @verb
+        when "add" then @source = shift_required_arg(parser, argv)
+        when "remove" then @name = shift_required_arg(parser, argv)
+        when "show" then @name = shift_required_arg(parser, argv)
+        when "update" then @name = argv.shift
+        end          
+        
+      else
+        @verb = "generate"
+        @name = verb_or_template_name
+        @destination = shift_required_arg(parser, argv)
+      end
+    end
+    
+    private
+    
+    def shift_required_arg(parser, argv)
+      arg = argv.shift
+      
+      unless arg
+        puts parser
+        exit 1
+      end
+      
+      arg      
+    end
+  end
+end

data/lib/basis/templates/base.rb

@@ -0,0 +1,72 @@
+require "erb"
+require "fileutils"
+require "pathname"
+
+require "basis/errors"
+require "basis/templates/state"
+
+module Basis
+  module Templates
+    class Base
+      attr_reader :url, :name, :description
+
+      def initialize(engine, url, options={})
+        raise ArgumentError, "source URL is required" unless url
+        
+        @engine = engine
+        @url = url
+        @name = options[:name] || url.path.split("/").last
+        @description = options[:description]
+      end
+      
+      def update!
+        raise NotImplementedError, "implement in subclasses"
+      end
+      
+      def generate(destination)
+        srcpath = Pathname.new(cache_dir)
+        destpath = Pathname.new(destination)
+        state = State.new(destpath)
+        
+        raise Errors::DestinationAlreadyExists.new(destination) if destpath.exist?
+        update! unless cached?
+
+        
+        Pathname.glob(srcpath + "**" + "*").each do |src|
+          next unless src.file?
+          
+          dest = destination_for(src, :from => srcpath, :to => destpath)
+          dest.dirname.mkpath
+          
+          if erb?(src)
+            dest.open("w") { |d| d.write(ERB.new(src.read).result(state.binding)) }
+          else
+            FileUtils.copy(src, dest)
+          end
+        end
+      end
+      
+      protected
+
+      def cached?
+        File.directory?(cache_dir)
+      end
+
+      def cache_dir
+        @cache_dir ||= File.join(@engine.home, "cache", "#{url.path.split("/").last}-#{name.hash.abs}")
+      end
+
+      private
+      
+      def erb?(path)
+        path.extname == ".erb"
+      end
+      
+      def destination_for(src, options={})
+        dest = src.relative_path_from(options[:from]).expand_path(options[:to])
+        dest = dest.dirname + dest.basename.to_s[0...-4] if erb?(src)
+        Pathname.new(dest.to_s.gsub("project.name", options[:to].basename))
+      end
+    end
+  end
+end

data/lib/basis/templates/git.rb

@@ -0,0 +1,15 @@
+require "fileutils"
+
+module Basis
+  module Templates
+    class Git < Base
+      def update!
+        if File.directory?(cache_dir)
+          Dir.chdir(cache_dir) { system "git pull" }
+        else
+          system "git clone #{url.to_s} #{cache_dir}"
+        end
+      end
+    end
+  end
+end

data/lib/basis/templates/list.rb

@@ -0,0 +1,28 @@
+require "YAML"
+
+module Basis
+  module Templates
+    class List < Array
+      def initialize(engine, file)
+        @engine = engine
+        @file = file
+      
+        YAML.load(IO.read(@file)).each do |name, data|
+          self << Templates.create(@engine, data["url"],
+            :name => name, :description => data["description"])
+        end
+      
+        sort! { |a, b| a.name <=> b.name }
+      end
+    
+      def write!(file=@file)
+        hashified = {}
+        each { |t| hashified[t.name] = { "url" => t.url.to_s, "description" => t.description } }
+        
+        File.open(file, "w") do |f|
+          f.write(YAML.dump(hashified))
+        end
+      end
+    end
+  end
+end

data/lib/basis/templates/local.rb

@@ -0,0 +1,13 @@
+require "fileutils"
+
+module Basis
+  module Templates
+    class Local < Base
+      def update!
+        FileUtils.rmtree(cache_dir)
+        FileUtils.mkdir_p(cache_dir)
+        FileUtils.cp_r(Dir.glob(File.join(url.path, "*")), cache_dir)
+      end
+    end
+  end
+end

data/lib/basis/templates/state.rb

@@ -0,0 +1,27 @@
+module Basis
+  module Templates
+    class State
+      public :binding
+      attr_reader :project
+      
+      def initialize(destination)
+        @project = Project.new(destination)
+      end
+      
+      private
+
+      class Project
+        attr_reader :directory, :name
+        
+        def initialize(destination)
+          @directory = destination.to_s
+          @name = destination.basename.to_s
+          
+          def @name.classify
+            gsub(/(?:^|_)(.)/) { $1.upcase }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/basis/templates.rb

@@ -0,0 +1,28 @@
+require "basis/templates/base"
+require "basis/templates/list"
+require "basis/templates/state"
+
+require "basis/templates/local"
+require "basis/templates/git"
+
+require "uri"
+
+module Basis
+  module Templates
+    def self.create(engine, raw_url, options={})
+      uri = URI.parse(raw_url)
+      
+      if uri.scheme.nil?
+        uri = URI.parse("file://#{File.expand_path(uri.path)}")
+      end
+      
+      klass = case uri.scheme
+      when "file" then Local
+      when "git" then Git
+      else raise Errors::UnknownTemplateScheme.new(raw_url)
+      end
+      
+      klass.new(engine, uri, options)
+    end
+  end
+end

data/lib/basis/version.rb

@@ -0,0 +1,3 @@
+module Basis
+  VERSION = "0.0.1"
+end

data/lib/templates.yml

@@ -0,0 +1,7 @@
+"gem:hoe":
+  description: A new RubyGem, powered by Hoe!
+  url: git://github.com/jbarnette/basis-gem-hoe.git
+  
+rails:
+  description: A clean Rails 2.0 app.
+  url: git://github.com/jbarnette/basis-rails.git

data/test/basis/engine_test.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "/../helper"))
+
+require "basis/engine"
+
+module Basis
+  class EngineTest < Test::Unit::TestCase
+    def test_has_some_sane_defaults_for_home
+      engine = Basis::Engine.new
+      assert_equal(File.expand_path("~/.basis"), engine.home)
+    end
+  end
+end

data/test/basis/options_test.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "/../helper"))
+
+require "basis/options"
+
+module Basis
+  class OptionsTest < Test::Unit::TestCase
+    def test_list
+      opts = Basis::Options.parse!("list")
+      assert_equal("list", opts.verb)
+    end
+    
+    def test_add
+      opts = Basis::Options.parse!("add", "someurl")
+      assert_equal("add", opts.verb)
+      assert_equal("someurl", opts.source)
+    end
+    
+    def test_add_with_explicit_name
+      opts = Basis::Options.parse!("add", "-n", "monkeys", "someurl")
+      assert_equal("add", opts.verb)
+      assert_equal("someurl", opts.source)
+      assert_equal("monkeys", opts.name)
+    end
+    
+    def test_remove
+      opts = Basis::Options.parse!("remove", "sometemplate")
+      assert_equal("remove", opts.verb)
+      assert_equal("sometemplate", opts.name)
+    end
+    
+    def test_generate
+      opts = Basis::Options.parse!("sometemplate", "whereto")
+      assert_equal("generate", opts.verb)
+      assert_equal("sometemplate", opts.name)
+      assert_equal("whereto", opts.destination)
+    end
+  end
+end

data/test/basis/templates/base_test.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "/../../helper"))
+
+require "fileutils"
+require "tmpdir"
+require "uri"
+
+require "basis/templates/base"
+
+module Basis
+  module Templates
+    class BaseTest < Test::Unit::TestCase
+      PROJECT_NAME = "rendered_project"
+      PROJECT_CLASS_NAME = "RenderedProject"
+      PROJECT_DIR = File.join("/tmp", PROJECT_NAME)
+      
+      class MockTemplate < Templates::Base
+        def initialize; super(nil, URI.parse(LOCAL_TEMPLATE_PATH)); end        
+        def update!; end
+        def cache_dir; LOCAL_TEMPLATE_PATH; end
+      end
+      
+      def setup
+        FileUtils.rm_rf(PROJECT_DIR)
+      end
+      
+      def test_requires_a_url
+        assert_raise(ArgumentError) { Base.new(nil, nil) }
+      end
+      
+      def test_uses_last_path_component_as_name_by_default
+        t = Base.new(nil, URI.parse("~/work/monkeys"))
+        assert_equal("monkeys", t.name)
+      end
+      
+      def test_can_override_name
+        t = Base.new(nil, URI.parse("~/work/monkeys"), :name => "lemurs")
+        assert_equal("lemurs", t.name)
+      end
+      
+      def test_can_specify_an_optional_description
+        t = Base.new(nil, URI.parse("~/work/monkeys"), :description => "hai")
+        assert_equal("hai", t.description)
+      end
+      
+      def test_requires_subclasses_to_implement_update
+        base = Base.new(nil, URI.parse("~/work/monkeys"))
+        base.stubs(:cache_dir).returns(true)
+        
+        assert_raise(NotImplementedError) { base.update! }
+      end  
+      
+      def test_complains_about_generating_if_dest_exists
+        Dir.mkdir(PROJECT_DIR)
+        assert_raise(Errors::DestinationAlreadyExists) { MockTemplate.new.generate(PROJECT_DIR) }
+      end
+      
+      def test_transforms_project_name_in_directory_names
+        MockTemplate.new.generate(PROJECT_DIR)
+        
+        destdir = File.join(PROJECT_DIR, PROJECT_NAME)
+        assert(File.directory?(destdir), "#{destdir} exists and is a directory")
+      end
+      
+      def test_transforms_project_name_in_file_names
+        MockTemplate.new.generate(PROJECT_DIR)
+        
+        destfile = File.join(PROJECT_DIR, PROJECT_NAME, "#{PROJECT_NAME}.txt")
+        assert(File.file?(destfile), "#{destfile} exists and is a file")
+      end
+      
+      def test_renders_erb_templates
+        MockTemplate.new.generate(PROJECT_DIR)
+        erbfile = Pathname.new(File.join(PROJECT_DIR, "erb", "erb.txt"))
+        assert(erbfile.exist?, "#{erbfile} exists")
+        
+        lines = erbfile.readlines.collect { |l| l.chomp }
+        
+        assert_equal(3, lines.size)
+        assert_equal(PROJECT_NAME, lines[0])
+        assert_equal(PROJECT_CLASS_NAME, lines[1])
+        assert_equal(PROJECT_DIR, lines[2])
+      end
+    end
+  end
+end

data/test/basis/templates_test.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "/../helper"))
+
+require "basis/templates"
+
+module Basis
+  class TemplatesTest < Test::Unit::TestCase
+    def test_local_from_simple_path
+      assert_kind_of(Templates::Local, Templates.create(nil, LOCAL_TEMPLATE_PATH))
+    end
+    
+    def test_git_from_git_scheme_url
+      assert_kind_of(Templates::Git, Templates.create(nil, "git://foo"))
+    end
+    
+    def test_complains_about_unhandled_url_schemes
+      assert_raise(Errors::UnknownTemplateScheme) { Templates.create(nil, "ether://monkeys") }
+    end
+  end
+end

data/test/fixtures/local/erb/erb.txt.erb

@@ -0,0 +1,3 @@
+<%= project.name %>
+<%= project.name.classify %>
+<%= project.directory %>

data/test/helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "test/unit"
+require "mocha"
+
+%w(../lib).each do |path|
+  $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), path)))
+end
+
+LOCAL_TEMPLATE_PATH = File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "local"))

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: basis
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: Basis is smart project skeletons. This is a very, very early release. Basis only knows how to deal with git:// urls and local file paths right now. Also, there's no documentation, no way to track remote template lists, dubious cache update semantics, bad command-line messaging, bad error reporting, and bad code.  Honestly, installing this gem will probably melt your system.  Basis owes a ton to Hoe, Mr. Bones, Rubigen, Newgem, and skel.
+email: 
+- jbarnette@rubyforge.org
+executables: 
+- basis
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- test/fixtures/local/project.name/project.name.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/basis
+- lib/basis/engine.rb
+- lib/basis/errors.rb
+- lib/basis/options.rb
+- lib/basis/templates.rb
+- lib/basis/templates/base.rb
+- lib/basis/templates/git.rb
+- lib/basis/templates/list.rb
+- lib/basis/templates/local.rb
+- lib/basis/templates/state.rb
+- lib/basis/version.rb
+- lib/templates.yml
+- test/basis/engine_test.rb
+- test/basis/options_test.rb
+- test/basis/templates/base_test.rb
+- test/basis/templates_test.rb
+- test/fixtures/local/erb/erb.txt.erb
+- test/fixtures/local/project.name/project.name.txt
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/jbarnette/basis
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: basis
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Basis is smart project skeletons
+test_files: 
+- test/basis/engine_test.rb
+- test/basis/options_test.rb
+- test/basis/templates/base_test.rb
+- test/basis/templates_test.rb