snip 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,19 +0,0 @@
-= snip
-
-Description goes here.
-
-== Contributing to snip
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Boris Searles. See LICENSE.txt for
-further details.
-

data/bin/snip

@@ -1,36 +1,122 @@
 #!/usr/bin/env ruby
-
+# 1.9 adds realpath to resolve symlinks; 1.8 doesn't
+# have this method, so we add it so we get resolved symlinks
+# and compatibility
+unless File.respond_to? :realpath
+  class File #:nodoc:
+    def self.realpath path
+      return realpath(File.readlink(path)) if symlink?(path)
+      path
+    end
+  end
+end
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+require 'rubygems'
+require 'gli'
 require 'snip'
-require 'trollop'
-
-SUB_COMMANDS = %w(add edit list rm show run)
-global_opts = Trollop::options do
-  version "snip 0.1.0 (c) 2012 Boris Searles"
-  banner "command line snippet manager"
-  stop_on SUB_COMMANDS
-end
-
-cmd = ARGV.shift # get the subcommand
-cmd_opts = case cmd
-  when "add"
-    Snip.add(ARGV[0])
-  when "edit"
-    Snip.edit(ARGV[0])
-  when "list"
-    Snip.list(ARGV[0])
-  when "rm"
-    Snip.rm(ARGV[0])
-  when "show"
-    Snip.show(ARGV[0])
-  when "run"
-    Snip.run(ARGV[0])
+require 'snip_version'
+require 'snip/commands'
+
+include GLI
+include Snip::Commands
+
+program_desc 'A command line snippet manager'
+
+version Snip::VERSION
+
+
+pre do |global,command,options,args|
+  if Snip::initialized?
+    true
   else
-    Trollop::die "unknown subcommand #{cmd.inspect}"
+    puts "This seems to be the first time snip is run on this computer."
+    puts "Should #{Snip::INSTALL_DIR} be created? (Yn)"
+    check = $stdin.gets.chomp
+    if check == 'Y'
+      Snip::init
+      true
+    else
+      puts "aborting..."
+      false
+    end
+  end
+end
+
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+
+desc 'List snippets'
+long_desc <<EOS
+  List all existing snippets. Optional regex argument can be used to filter list.
+EOS
+arg_name 'regex'
+command :list do |c|
+  c.action do |global_options,options,arguments|
+    list_snippets(arguments, options)
+  end
+end
+
+
+desc 'Show snippet'
+long_desc <<EOS
+  Display the specified snippet.
+EOS
+arg_name 'snippet_name'
+command :show do |c|
+  c.action do |global_options,options,arguments|
+    show_snippet(arguments, options)
   end
+end
 
-#puts "Global options: #{global_opts.inspect}"
-#puts "Subcommand: #{cmd.inspect}"
-#puts "Subcommand options: #{cmd_opts.inspect}"
-#puts "Remaining arguments: #{ARGV.inspect}"
 
+desc 'Edit snippet'
+long_desc <<EOS
+  Edit the specified snippet.
+EOS
+arg_name 'snippet_name'
+command :edit do |c|
+  c.action do |global_options,options,arguments|
+    edit_snippet(arguments, options)
+  end
+end
+
+
+desc 'Run snippet'
+long_desc <<EOS
+  Execute the specified snippet.
+EOS
+arg_name 'snippet_name'
+command :run do |c|
+  c.action do |global_options,options,arguments|
+    run_snippet(arguments, options)
+  end
+end
+
+
+desc 'Remove snippet'
+arg_name 'snippet_name'
+command [:remove, :rm] do |c|
+  c.action do |global_options,options,arguments|
+    remove_snippet(arguments, options)
+  end
+end
+
+
+desc 'Add a new snippet'
+long_desc <<EOS
+  The first argument is required and is the name of the new snippet. The second argument is the actual snippet itself, should be a string. If the second argument is not supplied then the configured editor ($EDITOR) will be opened and will be saved when saved in editor.
+  Example: snip add dirsize "du -ch | grep total"
+EOS
+arg_name 'snippet_name'
+command :add do |c|
+  c.action do |global_options,options,arguments|
+    add_snippet(arguments, options)
+  end
+end
 
+exit GLI.run(ARGV)

data/lib/snip.rb

@@ -1,78 +1,26 @@
-class Snip
+require 'rainbow'
 
-  def self.init
-    root_dir = File.expand_path('~')
-    unless File.exists?("#{root_dir}/.snips")
-      puts "...initializing ~/.snips directory"
-      `mkdir $HOME/.snips`
-    end
-  end
-
-
-  def self.add(snippet)
-    Snip.init
-    `vim "$HOME/.snips/#{snippet}" 3>&1 1>&2 2>&3`
-    puts "...added new snippet: #{snippet}"
-  end
-
-
-  def self.edit(snippet)
-    Snip.init
-    root_dir = File.expand_path('~')
-    target_file = "#{root_dir}/.snips/#{snippet}"
-    if File.exists?(target_file)
-      `vim "#{target_file}" 3>&1 1>&2 2>&3`
-    else
-      puts "Snippet #{snippet} could not be found"
-    end
-  end
+module Snip
 
+  DEFAULT_DIR = '~/.snip'
+  INSTALL_DIR = File.expand_path(Snip::DEFAULT_DIR)
 
-  def self.list(query)
-    Snip.init
-    root_dir = File.expand_path('~')
-    Dir.foreach("#{root_dir}/.snips") do |file|
-      unless File.directory?(file)
-        puts file
-      end
-    end
-  end
+  class NotInitializedError < StandardError ; end
+  class DuplicateSnippetNameError < StandardError ; end
+  class SnippetNotFoundError < StandardError ; end
+  class ExecuteSnippetError < StandardError ; end
 
-
-  def self.rm(snippet)
-    Snip.init
-    root_dir = File.expand_path('~')
-    target_file = "#{root_dir}/.snips/#{snippet}"
-    if File.exists?(target_file)
-      `rm #{target_file}`
-      puts "Snippet #{snippet} was deleted"
-    else
-      puts "Snippet #{snippet} could not be found"
-    end
+  def self.initialized?
+    File.directory?(Snip::INSTALL_DIR)
   end
 
-
-  def self.show(snippet)
-    Snip.init
-    root_dir = File.expand_path('~')
-    target_file = "#{root_dir}/.snips/#{snippet}"
-    if File.exists?(target_file)
-      puts `cat #{target_file}`
-    else
-      puts "Snippet #{snippet} could not be found"
+  def self.init
+    unless Snip::initialized?
+      FileUtils.mkdir(Snip::INSTALL_DIR)
     end
   end
 
-
-  def self.run(snippet)
-    Snip.init
-    root_dir = File.expand_path('~')
-    target_file = "#{root_dir}/.snips/#{snippet}"
-    if File.exists?(target_file)
-      puts `cat #{target_file}`
-      puts `cat #{target_file} | sh`
-    else
-      puts "Snippet #{snippet} could not be found"
-    end
+  def self.snippet_exists?(name)
+    File.exists?(File.join(Snip::INSTALL_DIR, name))
   end
 end

data/lib/snip/command/add.rb

@@ -0,0 +1,34 @@
+require 'snip'
+require 'snip/util/editor'
+
+module Snip
+  module Command
+    class Add
+      include Snip
+
+      def initialize(args, options={})
+        @args = Array(args)
+        @options = options
+      end
+
+      def execute
+        name, content = @args
+        raise NotInitializedError unless Snip::initialized?
+        raise DuplicateSnippetNameError if Snip::snippet_exists?(name)
+
+        file_path = File.join(Snip::INSTALL_DIR, name)
+        if content.nil?
+          if Snip::Util::Editor::open(file_path)
+            if File.exists?(file_path)
+              puts "Snippet created successfully"
+            end
+          end
+        else
+          File.open(file_path, 'w') do |f|
+            f.puts content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snip/command/edit.rb

@@ -0,0 +1,26 @@
+require 'snip'
+require 'snip/util/editor'
+
+module Snip
+  module Command
+    class Edit
+      include Snip
+
+      def initialize(args, options={})
+        @args = Array(args)
+        @options = options
+      end
+
+      def execute
+        name = @args
+        raise NotInitializedError unless Snip::initialized?
+        raise SnippetNotFoundError unless Snip::snippet_exists?(name)
+
+        file_path = File.join(Snip::INSTALL_DIR, name)
+        if Snip::Util::Editor::open(file_path)
+          puts "Snippet updated successfully"
+        end
+      end
+    end
+  end
+end

data/lib/snip/command/list.rb

@@ -0,0 +1,26 @@
+require 'snip'
+
+module Snip
+  module Command
+    class List
+      def initialize(args=[], options={})
+        @args = Array(args)
+        @options = options
+      end
+
+      def execute
+        raise NotInitializedError unless Snip::initialized?
+
+        Dir.foreach(Snip::INSTALL_DIR) do |file|
+          next if file == '.' or file == '..'
+          next unless @args.empty? || file.match(@args.first)
+
+          first_line = ""
+          File.open(File.join(Snip::INSTALL_DIR, file)) {|f| first_line = f.readline}
+
+          printf("%-35s # %s", file.color(:blue), first_line);
+        end
+      end
+    end
+  end
+end

data/lib/snip/command/remove.rb

@@ -0,0 +1,20 @@
+require 'snip'
+
+module Snip
+  module Command
+    class Remove
+      def initialize(args, options={})
+        @args = Array(args)
+        @options = options
+      end
+
+      def execute
+        name = @args
+        raise NotInitializedError unless Snip::initialized?
+        raise SnippetNotFoundError unless Snip::snippet_exists?(name)
+
+        FileUtils.rm(File.join(Snip::INSTALL_DIR, name)) if Snip::snippet_exists?(name)
+      end
+    end
+  end
+end

data/lib/snip/command/run.rb

@@ -0,0 +1,27 @@
+require 'snip'
+
+module Snip
+  module Command
+    class Run
+      def initialize(args, options={})
+        @args = Array(args)
+        @options = options
+      end
+
+      def execute
+        name = @args
+        raise NotInitializedError unless Snip::initialized?
+        raise SnippetNotFoundError unless Snip::snippet_exists?(name)
+
+        snippet = File.read(File.join(Snip::INSTALL_DIR, name))
+
+        begin
+          puts snippet.color(:magenta)
+          puts `#{snippet}`
+        rescue
+          raise ExecuteSnippetError
+        end
+      end
+    end
+  end
+end

data/lib/snip/command/show.rb

@@ -0,0 +1,20 @@
+require 'snip'
+
+module Snip
+  module Command
+    class Show
+      def initialize(args, options={})
+        @args = Array(args)
+        @options = options
+      end
+
+      def execute
+        name = @args
+        raise NotInitializedError unless Snip::initialized?
+        raise SnippetNotFoundError unless Snip::snippet_exists?(name)
+
+        puts File.read(File.join(Snip::INSTALL_DIR, name)).color(:magenta)
+      end
+    end
+  end
+end

data/lib/snip/commands.rb

@@ -0,0 +1,34 @@
+require 'snip/command/list'
+require 'snip/command/show'
+require 'snip/command/add'
+require 'snip/command/edit'
+require 'snip/command/run'
+require 'snip/command/remove'
+
+module Snip
+  module Commands
+    def list_snippets(args=[], options={})
+      Snip::Command::List.new(args, options).execute
+    end
+
+    def show_snippet(args, options={})
+      Snip::Command::Show.new(args, options).execute
+    end
+
+    def add_snippet(args, options={})
+      Snip::Command::Add.new(args, options).execute
+    end
+
+    def edit_snippet(args, options={})
+      Snip::Command::Edit.new(args, options).execute
+    end
+
+    def run_snippet(args, options={})
+      Snip::Command::Run.new(args, options).execute
+    end
+
+    def remove_snippet(args, options={})
+      Snip::Command::Remove.new(args, options).execute
+    end
+  end
+end

data/lib/snip/util/editor.rb

@@ -0,0 +1,23 @@
+
+module Snip
+  module Util
+    class Editor
+      def self.open(file_path)
+        unless ENV.has_key?('EDITOR')
+          puts "No editor configured. The $EDITOR shell variable is empty."
+          puts "Example: Add 'echo EDITOR=vim' to your .bashrc or .zshrc if you would like to use VIM as your editor."
+          return
+        end
+
+        # open configured editor and redirect outputs
+        `#{ENV['EDITOR']} "#{file_path}" 3>&1 1>&2 2>&3`
+
+        unless $?.success?
+          puts "Error occured: " + $?.to_s
+        end
+
+        $?
+      end
+    end
+  end
+end

data/lib/snip_version.rb

@@ -0,0 +1,3 @@
+module Snip
+  VERSION = '0.2.0'
+end

data/snip.rdoc

@@ -0,0 +1,5 @@
+= snip
+
+Generate this with
+    snip rdoc
+After you have described your command line interface

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-04 00:00:00.000000000Z
+date: 2012-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: trollop
-  requirement: &24388840 !ruby/object:Gem::Requirement
+  name: gli
+  requirement: &70316298687900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *24388840
+  version_requirements: *70316298687900
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &24388280 !ruby/object:Gem::Requirement
+  name: rainbow
+  requirement: &70316298686860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70316298686860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70316298686080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,76 +43,80 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24388280
+  version_requirements: *70316298686080
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &24387800 !ruby/object:Gem::Requirement
+  requirement: &70316298684820 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24387800
+  version_requirements: *70316298684820
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &24387020 !ruby/object:Gem::Requirement
+  name: minitest-reporters
+  requirement: &70316298683980 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24387020
+  version_requirements: *70316298683980
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &24386480 !ruby/object:Gem::Requirement
+  name: fakefs
+  requirement: &70316298683440 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *24386480
-description: command line snippet manager
+  version_requirements: *70316298683440
+description: 
 email: boris@lucidgardens.com
 executables:
 - snip
 extensions: []
 extra_rdoc_files:
-- LICENSE.txt
 - README.rdoc
+- snip.rdoc
 files:
-- .document
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.rdoc
-- Rakefile
-- VERSION
 - bin/snip
 - lib/snip.rb
-- test/helper.rb
-- test/test_snip.rb
+- lib/snip_version.rb
+- lib/snip/commands.rb
+- lib/snip/command/list.rb
+- lib/snip/command/show.rb
+- lib/snip/command/add.rb
+- lib/snip/command/edit.rb
+- lib/snip/command/run.rb
+- lib/snip/command/remove.rb
+- lib/snip/util/editor.rb
+- README.rdoc
+- snip.rdoc
 homepage: http://github.com/bozz/snip
-licenses:
-- MIT
+licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --title
+- snip
+- --main
+- README.rdoc
+- -ri
 require_paths:
 - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2118759123288687265
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -113,5 +128,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: command line snippet manager
+summary: A Command Line Snippet Manager
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/Gemfile

@@ -1,14 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem "trollop", "~> 1.16"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.8.3"
-end

data/Gemfile.lock

@@ -1,25 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.6.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    shoulda (2.11.3)
-    trollop (1.16.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.8.3)
-  rdoc (~> 3.12)
-  shoulda
-  trollop (~> 1.16)

data/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2012 Boris Searles
-
-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

@@ -1,46 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "snip"
-  gem.homepage = "http://github.com/bozz/snip"
-  gem.license = "MIT"
-  gem.summary = %Q{command line snippet manager}
-  gem.description = %Q{command line snippet manager}
-  gem.email = "boris@lucidgardens.com"
-  gem.authors = ["Boris Searles"]
-  gem.executable = "snip"
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "snip #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'snip'
-
-class Test::Unit::TestCase
-end

data/test/test_snip.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestSnip < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end