nf 0.0.3

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+debug.log
+newfile.*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nf.gemspec
+gemspec

data/History.txt

@@ -0,0 +1,17 @@
+=== 0.0.3 / 2012-01-21
+
+* Implemented --delete to delete a template
+* Simplified CLI for storing a template
+* Simplified aspects of the code
+* Global templates stored in more appropriate directory
+* Improved README.txt
+* Added LICENCE file
+* More documentation
+
+=== 0.0.2 / 2012-01-21
+
+* Removed debugging code (caused error because of missing require)
+
+=== 0.0.1 / 2012-01-20
+
+* Initial implementation (not released)

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2005 Gavin Sinclair (gsinclair@gmail.com)
+
+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/README.txt

@@ -0,0 +1,41 @@
+nf (VERSION) -- create new file from template
+
+Examples:
+
+  nf text
+   -> Creates new text file (newfile.txt) in current directory.
+
+  nf text /path/to/directory
+   -> Creates new text file in given directory.
+
+  nf text /path/to/file
+   -> Creates new text file in same directory as given file.
+
+  nf --list            (-l)
+   -> Lists file templates (e.g. "text" above)
+
+  nf --store word /path/to/template.docx      (-s)
+   -> Stores a new template named "word", copying the given file
+      into ~/.nf/word and updating the database. A new Word file
+      can now be created with "nf word".
+
+  nf --delete word     (-d, --remove)
+   -> Removes the template that was stored by the previous example,
+      both from the database and the filesystem.
+
+Motivation:
+
+  MacOSX lacks the Windows Explorer right-click functionality to
+  create a new file in the currently browsed folder.  That is annoying.  With
+  'nf' and DTerm installed, from any finder directory I can open DTerm and type
+  "nf word" to create a new Microsoft Word file.
+
+Templates:
+
+  nf has two "global" templates: 'text' and 'ruby'.  Any local templates you
+  create with '--store' are saved in ~/.nf.
+
+Project:
+
+  Homepage: http://github.com/gsinclair/nf
+  Licence:  MIT

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/nf

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+
+require 'nf'
+
+NF.new.run(ARGV)
+
+# vim: ft=ruby

data/lib/nf.rb

@@ -0,0 +1,267 @@
+require 'nf/version'
+require 'fileutils'
+require 'yaml'
+
+# Usage: NF.new.run(ARGV)
+class NF
+  # Nothing to initialize.
+  def initialize
+  end
+
+  def run(args)
+    case word = args.shift
+    when nil, "-h", "--help" then usage
+    when "--list", "-l"      then list(args)
+    when "--store", "-s"     then store(args)
+    when "--delete", "-d"    then delete(args)
+    when "--remove"          then delete(args)
+    else                          create_new_file(word, args)
+    end
+  end
+
+  def usage
+    usage = File.read( File.expand_path("../../README.txt", __FILE__) )
+    puts usage.gsub("VERSION", 'v' + NF::VERSION)
+  end
+
+  # --list or -l
+  def list(args)
+    unless args.empty?
+      puts "(Ignoring arguments)"
+    end
+    puts
+    puts "Global templates:"
+    TemplateDir.global.templates.each do |t|
+      puts "  " + t.name.ljust(15) + "(#{t.extension})"
+    end
+    puts
+    puts "Local templates:"
+    TemplateDir.local.templates.each do |t|
+      puts "  " + t.name.ljust(15) + " (#{t.extension})"
+    end
+  end
+
+  # --store or -s word /path/to/template.docx
+  def store(args)
+    # Need two arguments: template name, template path
+    abort "--store takes two arguments: name, path" unless args.size == 2
+    name, source_path = args.shift(2)
+    abort "Invalid name" unless name =~ /^\w+$/
+    abort "Can't read file: #{source_path}" unless File.readable?(source_path)
+    extension = File.extname(source_path)
+    abort "Path #{source_path} doesn't have an extension" if extension.empty?
+    TemplateDir.local.store(name, source_path)
+      # The above line is not bad, but it has a lot of error-checking and
+      # concomitant message-printing that ill befits the TemplateDir class.
+      # That stuff should be handled by this class.  Consider relocating it.
+  end
+
+  # --delete or -d or --remove template_name
+  def delete(args)
+    abort "--store takes one argument: template_name" unless args.size == 1
+    name = args.shift
+    abort "Invalid name" unless name =~ /^\w+$/
+    TemplateDir.local.delete(name)
+  end
+
+  # Arguments examples: 
+  #   nf word
+  #   nf word /path/to/directory
+  #   nf word /path/to/file
+  def create_new_file(template_name, args)
+    file_or_dir = args.shift
+    abort "Too many arguments provided; see `nf --help`" unless args.empty?
+    abort "Invalid template name" unless template_name =~ /^\w+$/
+    f = file_or_dir
+    target_directory =
+      if f.nil? then Dir.pwd
+      elsif File.file?(f) then File.dirname(f)
+      elsif File.directory?(f) then f
+      else Dir.pwd  # raise exception?
+      end
+    template = TemplateDir.resolve(template_name)
+    if template.nil?
+      abort "Cannot locate template named #{template_name}"
+    end
+    target_path = File.join(target_directory, "newfile#{template.extension}")
+    FileUtils.cp(template.path, target_path)
+  end
+
+
+  # Logical representation of a template: name, extension, directory.
+  # Can find out the path to the template file (needed for creating a new file).
+  class Template
+    attr_reader :name, :extension
+    def initialize(name, extension, directory)
+      @name, @extension, @directory = name, extension, directory
+    end
+
+    def path
+      File.join(@directory, @name)
+    end
+  end  # class Template
+
+  # Encapsulates a template directory.  Methods:
+  #  #templates         -> [Template]
+  #  #template(name)    -> Template or nil
+  #  .global_templates  -> [Template]
+  #  .local_templates   -> [Template]
+  #  .resolve(name)     -> Template or nil
+  class TemplateDir
+    def initialize(dir)
+      @directory = dir
+      unless File.directory?(dir)
+        abort "TemplateDir#initialize: '#{dir}' is not a directory!"
+      end
+    end
+
+    # TemplateDir class methods
+
+    def TemplateDir.local_dir
+      @local_dir ||=
+        begin
+          local_dir = File.expand_path("~/.nf")
+          begin
+            FileUtils.mkpath(local_dir)
+            index_path = File.join(local_dir, "INDEX.yaml")
+            unless File.exist?(index_path)
+              FileUtils.touch(index_path)
+            end
+          rescue Errno::EEXIST
+            abort "Couldn't create local config dir ~/.nf: file (not directory) exists"
+          end
+          local_dir
+        end
+    end
+    def TemplateDir.global_dir
+      File.expand_path("../nf/templates", __FILE__)
+    end
+    def TemplateDir.global
+      TemplateDir.new(global_dir)
+    end
+    def TemplateDir.local
+      TemplateDir.new(local_dir)
+    end
+    def TemplateDir.update_local_index(name, extension)
+      TemplateDir.local.update_index(name, extension)
+    rescue => e
+      puts "Failed to update local index"
+      puts e.inspect
+    end
+    # Returns the first Template object matching the given name. Looks in local
+    # templates before global ones. Returns nil if no such template exists.
+    def TemplateDir.resolve(template_name)
+      template = TemplateDir.local.template(template_name)
+      if template.nil?
+        template = TemplateDir.global.template(template_name)
+      end
+      template
+    end
+
+    # TemplateDir instance methods
+
+    def ==(other)
+      other.class == TemplateDir and
+        @directory == other.instance_variable_get(:@directory)
+    end
+
+    # E.g. store("word", "/path/to/file.docx")
+    #  * copies the file to ~/.nf/word
+    #  * updates the database ~/.nf/INDEX.yaml
+    def store(name, source_path)
+      abort "Can't store in global directory" if self == TemplateDir.global_dir
+      target_path = File.join(@directory, name)
+      extension = File.extname(source_path)
+      if File.readable?(target_path)
+        puts "Warning: about to overwrite template file"
+        puts "  #{target_path}"
+        puts
+        backup = "/tmp/nf.template.#{name}"
+        begin
+          FileUtils.cp target_path, backup
+          puts "Its contents are backed up to #{backup}"
+        rescue
+          puts "Tried to back up to #{backup} but failed. Contents of template below."
+          puts
+          puts File.read(target_path)
+        end
+      end
+      puts
+      begin
+        FileUtils.cp(source_path, target_path)
+        update_index(name, extension)
+        puts "Created file #{target_path}"
+      rescue
+        puts "Failed to create file: #{target_path}"
+      end
+    end
+
+    # E.g. TemplateDir.local.delete("word")
+    #  * Deletes file ~/.ns/word
+    #  * Removes key "word" from database ~/.ns/INDEX.yaml
+    # Returns true if deleted, false if doesn't exist in database.
+    # In either case, it attempts to remove the file.
+    def delete(name)
+      data = index_data()
+      if data.key?(name)
+        data.delete(name)
+        write_index(data)
+        puts "Removed template #{name} from database #{index_path}"
+        remove_file(name, :verbose)
+      else
+        puts "Template named #{name} doesn't exist in local template database"
+        remove_file(name, :quiet)
+      end
+    end
+
+    def templates() @templates ||= _templates end
+
+    private
+
+    def index_path() @_ip ||= File.join(@directory, "INDEX.yaml") end
+    def index_data() YAML.load( File.read(index_path())) || Hash.new end
+    def write_index(data)
+      File.open(index_path(), 'w') { |f| f.write(YAML.dump(data)) }
+    end
+    def update_index(name, extension)
+      data = index_data()        # hash: ruby => .rb, text => .txt, ...
+      data[name] = extension
+      write_index(data)
+    end
+    def _templates
+      data = index_data()        # hash: ruby => .rb, text => .txt, ...
+      data.map { |name, ext| 
+        Template.new(name, ext, @directory)
+      }
+    end
+    # Returns the Template of the given name that is located in the directory
+    # encapsulated by this TemplateDir, or nil if none such exists.
+    def template(name)
+      data = index_data()
+      ext = data[name]
+      if ext
+        template = Template.new(name, ext, @directory)
+      else
+        nil
+      end
+    end
+    # Mode must be :quiet or :verbose.
+    def remove_file(name, mode)
+      path = File.join(@directory, name)
+      if File.exist?(path) and File.writable?(path)
+        FileUtils.rm(path) rescue remove_file_error_message(path, mode)
+      else
+        remove_file_error_message(path, mode)
+      end
+    end
+    def remove_file_error_message(path, mode)
+      case mode
+      when :quiet then nil
+      when :verbose
+        puts "Failed to delete file #{path}"
+      else abort "Invalid value for mode: #{mode}"
+      end
+    end
+  end  # class TemplateDir
+
+end  # class NF

data/lib/nf/templates/INDEX.yaml

@@ -0,0 +1,2 @@
+text: .txt
+ruby: .rb

data/lib/nf/templates/ruby

@@ -0,0 +1 @@
+# New Ruby file

data/lib/nf/templates/text

@@ -0,0 +1 @@
+New text file...

data/lib/nf/version.rb

@@ -0,0 +1,3 @@
+class NF
+  VERSION = "0.0.3"
+end

data/nf.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nf/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nf"
+  s.version     = NF::VERSION
+  s.authors     = ["Gavin Sinclair"]
+  s.email       = ["gsinclair@gmail.com"]
+  s.homepage    = "http://www.github.com/gsinclair/nf"
+  s.summary     = "Create new file from a template"
+  s.description = "Create new file from a template (small command-line utility)"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "bundler"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: nf
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Gavin Sinclair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156159980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156159980
+description: Create new file from a template (small command-line utility)
+email:
+- gsinclair@gmail.com
+executables:
+- nf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- LICENCE
+- README.txt
+- Rakefile
+- bin/nf
+- lib/nf.rb
+- lib/nf/templates/INDEX.yaml
+- lib/nf/templates/ruby
+- lib/nf/templates/text
+- lib/nf/version.rb
+- nf.gemspec
+homepage: http://www.github.com/gsinclair/nf
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Create new file from a template
+test_files: []
+has_rdoc: