codger 0.0.1 → 0.0.2

data/README.md

@@ -9,17 +9,13 @@ Goals:
 
 Put the skeleton in a git repo. Before testing it, make sure to at least `git add` the files. Then:
 
-    codger skeleton path/to/your-repo-name --test
-
-Now, to generate code inside the current working directory, do
-
-    codger gen your-repo-name
+    codger gen path/to/your/repo path/to/new/project
 
 Here's how the skeleton repo will be used:
 
 1. If there is a script named `generate.rb` in the root directory, it will be run.
 2. Files ending in `.erb` will be [interpolated](http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html) and written to the target directory.
-3. Other files will be copied directly to the target directory. (Exceptions: README, README.md, README.markdown)
+3. Other files will be copied directly to the target directory. (Exceptions: README, README.md, README.markdown, .gitignore)
 
 ### Parameters
 
@@ -32,23 +28,31 @@ The first time a prompt is given, the skeleton repo's README will be printed (if
 * In a template, you can use `<%- rename "relative_path" -%>` to override the output file name.
 * Use `copy "path1", "path2"` to copy files "path1" and "path2" (relative the skeleton repo's root directory) into the target directory directly. Use `copy "path1" => "newpath1"` to override the destination path in the target directory.
 * Use `interpolate "path1", "path2"` to interpolate ERB files "path1" and "path2" into the target directory. As with `copy` you can use a hash to override the destination paths.
+* Use `cancel` inside a template to stop its interpolation.
 * Use `ignore "path1", "path2"` to prevent automatic copying or interpolation of files.
 
 ## Using Skeletons
 
-Register a skeleton:
+Run in a new folder:
 
-    codger skeleton git://example.com/boilerplate.git
+    codger gen boilerplate monumental-endeavor
 
-Run it in a new folder:
+Or run in the current working directory:
 
-    codger create boilerplate monumental-endeavor
+    codger gen boilerplate
 
-Or run it in the current working directory:
+### Caching
 
-    codger gen boilerplate
+    codger cache git://uri/to/boilerplate.git # stores a local clone in ~/.codger/cached
+    codger gen boilerplate # uses the local clone (but will update it first if possible)
+
+### Diffing
+
+You can add the `-r` (record) option:
+
+    codger gen boilerplate -r
 
-In either case the parameters used will be recorded in a file named `.codger`, so that later, after the project or the skeleton have changed, you can use
+to have the run recorded in a file named `.codger`, so that later, after the project or the skeleton have changed, you can use
 
     codger diff
 

data/lib/codger/cli.rb

@@ -1,3 +1,5 @@
+# coding: UTF-8
+
 require 'fileutils'
 require 'git'
 require 'thor'
@@ -6,6 +8,23 @@ require 'yaml'
 
 module Codger
   class CLI < Thor
+    desc 'cache GENERATOR', 'keep a local clone of the generator from the given location'
+    def cache identifier
+      Manager.default.cache identifier
+    end
+
+    desc 'cached', 'list all cached generators'
+    def cached
+      Manager.default.settings[:cached].each do |identifier, _|
+        puts identifier
+      end
+    end
+
+    desc 'uncache GENERATOR', 'remove local clone of a generator'
+    def uncache identifier
+      Manager.default.uncache identifier
+    end
+
     desc 'config [NAME [VALUE]]', 'lists, shows, or alters configuration'
     def config(name = nil, value = nil)
       if name
@@ -20,41 +39,19 @@ module Codger
       end
     end
 
-    desc 'available', 'lists registered code generators'
-    def available
-      Manager.default.settings[:generators].each do |name, info|
-        puts "#{name}\t#{info.inspect}"
+    desc 'gen GENERATOR [PATH]', 'run the specified generator at the given path or the current working directory'
+    method_option :record, aliases: '-r', type: :boolean, desc: 'record this run in a .codger file in the directory'
+    def gen identifier, path='.'
+      path = File.expand_path path
+      unless File.exists? path
+        FileUtils.mkdir path
+        Git.init path
       end
-    end
-
-    desc 'skeleton LOCATION', 'register a git repository as a code generator, creating a clone from the given location'
-    method_option :name, desc: 'Name you wish to refer to the skeleton by.'
-    method_option :test, desc: 'Prevent cloning or pulling of the repository. Location should be a path on the file system.'
-    def skeleton(location)
-      info = {}
-      if options[:test]
-        location = File.expand_path(location)
-        info[:test] = true
-      end
-      info[:git] = location
-      Manager.default.register options[:name], info
-    end
-
-    desc 'create NAME PATH', 'run the named generator in a new folder at the given path'
-    def create(name, path)
-      FileUtils.mkdir path
-      Git.init File.expand_path(path)
-      manager = Manager.new(File.join(path, '.codger'))
-      generator = manager.generator(manager.settings[:generators][name])
-      generator.run path, project_name: path.split('/').last
-      manager.record_run generator
-    end
-
-    desc 'gen NAME', 'run the named generator'
-    def gen(name)
-      generator = Manager.default.generator(Manager.default.settings[:generators][name])
-      generator.run(Dir.pwd)
-      Manager.default.record_run(generator)
+      manager = Manager.new File.join(path, '.codger')
+      generator = manager.generator identifier
+      puts "Running #{generator.identifier}"
+      generator.run path
+      manager.record_run generator if options[:record]
     end
 
     desc 'history', 'show the actions recorded for this directory'
@@ -91,10 +88,5 @@ module Codger
         end
       end
     end
-
-    desc 'unregister NAME', 'unregister a code generator and delete its clone'
-    def unregister(name)
-      Manager.default.unregister name
-    end
   end
 end

data/lib/codger/manager.rb

@@ -35,8 +35,7 @@ module Codger
         config: {
           diff: 'diff -ur %SOURCE %DEST'
         },
-        clones: {},
-        generators: {}
+        cached: {}
       }.with_indifferent_access
       if File.exists?(globals_path)
         @global_settings.merge! YAML.load(File.read(globals_path))
@@ -44,43 +43,32 @@ module Codger
     end
 
     # Creates a Generator, currently always a Skeleton.
-    # info should contain :git, the path/URI of the repository.
-    # Unless it contains :test, the repository will be cloned to #clones_base
-    # (if it has not been already).
-    def generator(info)
-      if location = info[:git]
-        if info[:test]
-          clone = location
-        elsif !(clone = settings[:clones][location] and File.exists?(clone))
-          FileUtils.mkdir_p clones_base
-          next_id = Dir.entries(clones_base).map(&:to_i).max + 1
-          clone = File.join(clones_base, next_id.to_s)
-          Git.clone location, clone
-          @global_settings[:clones][location] = clone
-          save_globals
+    # id can be:
+    # * a filesystem path, which will be used directly
+    # * a git uri, which will be cloned to a temporary directory
+    # * a substring of the identifier of a cached skeleton
+    def generator(id)
+      if File.exists? id
+        clone = id
+        id = File.expand_path id
+      elsif cached = match_cached_identifier(id)
+        id, clone = cached
+        git = Git.open(clone)
+        # https://github.com/schacon/ruby-git/issues/32
+        begin
+          git.lib.send(:command, 'pull')
+        rescue StandardError => ex
+          puts "Warning: could not update cached clone: #{ex.inspect}"
+        end
+      else
+        clone = Dir.mktmpdir
+        Git.clone id, clone
+        at_exit do
+          raise "I'm scared to delete #{clone}" unless clone.size > 10 # just being paranoid before rm_rf'ing
+          FileUtils.rm_rf clone
         end
-        Skeleton.new clone, info
-      end
-    end
-
-    # Load a generator for the given attributes and register it
-    # in the global configuration under the given name, or its default
-    # name if name is nil.
-    def register(name, info)
-      gen = generator(info)
-      @global_settings[:generators][name || gen.name] = gen.info
-      save_globals
-    end
-
-    # Given a generator name, removes it from the config, and delete its
-    # local clone if one exists.
-    def unregister(name)
-      info = @global_settings[:generators].delete name # TODO graciously handle it not existing
-      clone = @global_settings[:clones].delete info[:git]
-      if clone and clone.start_with? clones_base # sanity check before rm_rf
-        FileUtils.rm_rf clone
       end
-      save_globals
+      Skeleton.new clone, id
     end
 
     # Saves the tags, identifier, and params from the last run of the given generator instance
@@ -88,12 +76,46 @@ module Codger
     def record_run(generator)
       @project_settings[:runs] << {
         tags: [generator.name] + generator.tags,
-        generator: generator.info,
+        generator: generator.identifier,
         params: generator.params
       }.with_indifferent_access
       save_project
     end
 
+    # Clone the specified repo into #cached_base.
+    def cache identifier
+      return if settings[:cached][identifier]
+      identifier = File.expand_path identifier if File.exist?(identifier) # hacky
+      FileUtils.mkdir_p cached_base
+      next_id = Dir.entries(cached_base).map(&:to_i).max + 1
+      clone = File.join cached_base, next_id.to_s
+      Git.clone identifier, clone
+      @global_settings[:cached][identifier] = clone
+      save_globals
+    end
+
+    # Remove the specified repo from #cached_base. identifier may
+    # be a substring of the desired repo.
+    def uncache identifier
+      if match = match_cached_identifier(identifier)
+        @global_settings[:cached].delete match[0]
+        clone = match[1]
+        raise "I'm scared to delete #{clone}" unless clone.size > 10 && clone.start_with?(cached_base) # again, paranoia
+        FileUtils.rm_rf clone
+        save_globals
+      end
+    end
+
+    # Find a cached repository with an identifier similar to
+    # the given one (specifically, that has the given one as a substring).
+    # Returns [identifier, clone]
+    def match_cached_identifier identifier
+      return nil if identifier.size < 4 # crude typo protection
+      settings[:cached].detect do |cached_id, clone|
+        cached_id.include?(identifier)
+      end
+    end
+
     # Save #project_settings.
     def save_project
       File.write @project_path, @project_settings.to_yaml
@@ -116,9 +138,9 @@ module Codger
       File.join(codger_home, 'codger.yaml')
     end
 
-    # Return the folder where skeleton clones can be saved - 'clones' in #codger_home.
-    def clones_base
-      File.join(codger_home, 'clones')
+    # Return the folder where clones can be saved - 'cached' in #codger_home.
+    def cached_base
+      File.join codger_home, 'cached'
     end
 
     # Return a merged map of #global_settings and #project_settings.

data/lib/codger/skeleton.rb

@@ -17,6 +17,7 @@ module Codger
   #
   # Methods for use in generate.rb and templates:
   # * #src_path
+  # * #cancel
   # * #copy
   # * #interpolate
   # * #ignore
@@ -26,24 +27,20 @@ module Codger
     # skeletons this is based on the last segment of the origin
     # URI or of the clone's path.
     attr_reader :name
-    # Returns the attributes used in creating this instance.
-    attr_reader :info
+    # Returns the identifier that can (hopefully) be used to locate this skeleton in the future.
+    attr_reader :identifier
 
-    # Create an instance reading from the git repository at the specified
-    # path. Options for info:
-    # git:: Canonical source for the repo; required.
-    # test:: Unless truthy, an attempt will be made to perform a 'pull' for the repository.
-    def initialize(repo, info)
-      @info = info
-      @git = Git.open(repo)
-      # https://github.com/schacon/ruby-git/issues/32
-      @git.lib.send(:command, 'pull') unless info[:test] # TODO needs to be OK if this fails
-      @name = info[:git].split('/').last.sub(/\.git\z/,'')
+    # Create an instance reading from the git repository at the specified (local)
+    # path.
+    def initialize clone, identifier
+      @identifier = identifier
+      @git = Git.open(clone)
+      @name = identifier.split('/').last.sub(/\.git\z/,'')
     end
 
     # Perform code generation using the process outlined in the class documentation.
     def generate
-      @to_copy = @git.ls_files.keys - ['README', 'README.md', 'README.markdown', 'generate.rb']
+      @to_copy = @git.ls_files.keys - ['README', 'README.md', 'README.markdown', 'generate.rb', '.gitignore']
 
       code_path = src_path('generate.rb')
       if File.exists?(code_path)
@@ -104,12 +101,15 @@ module Codger
       end
 
       mappings.each do |src, dest|
-        @current_template_src = src
-        @current_template_dest = dest
-        template = ERB.new(File.read(src_path(src)), nil, '-')
-        ensure_folder @current_template_dest
-        result = template.result(binding)
-        File.write dest_path(@current_template_dest), result
+        begin
+          @current_template_src = src
+          @current_template_dest = dest
+          template = ERB.new(File.read(src_path(src)), nil, '-')
+          ensure_folder @current_template_dest
+          result = template.result(binding)
+          File.write dest_path(@current_template_dest), result
+        rescue CancelInterpolation
+        end
         @to_copy.delete src
       end
     end
@@ -121,6 +121,11 @@ module Codger
       @current_template_dest = File.join(File.dirname(@current_template_src), dest)
     end
 
+    # Stop interpolation of the current template.
+    def cancel
+      raise CancelInterpolation.new
+    end
+
     # For each path or array of paths, disable implicit copying.
     def ignore(*paths)
       @to_copy -= paths.flatten
@@ -134,4 +139,6 @@ module Codger
       end
     end
   end
+
+  class CancelInterpolation < StandardError; end
 end

data/lib/codger/version.rb

@@ -1,3 +1,3 @@
 module Codger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2012-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70337635384820 !ruby/object:Gem::Requirement
+  requirement: &70203594029980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70337635384820
+  version_requirements: *70203594029980
 - !ruby/object:Gem::Dependency
   name: deep_merge
-  requirement: &70337635384160 !ruby/object:Gem::Requirement
+  requirement: &70203594029380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70337635384160
+  version_requirements: *70203594029380
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &70337635383500 !ruby/object:Gem::Requirement
+  requirement: &70203594028620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.5
   type: :runtime
   prerelease: false
-  version_requirements: *70337635383500
+  version_requirements: *70203594028620
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70337635382820 !ruby/object:Gem::Requirement
+  requirement: &70203594028020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70337635382820
+  version_requirements: *70203594028020
 description: Manages invocation of code generators.
 email:
 - jacobaw@gmail.com