screeninator 1.0.1 → 1.0.2

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+1.0.2 / 2011-04-04
+------------------
+
+* 1 bugfix
+  
+  * fix whitespace issue in status line
+  
+* 5 enhancements
+
+  * added help command. shows available commands and explanation
+  * broke list -v into its own command called info
+  * update command can now take a list of configs to update, leave blank to update all
+  * modified bash aliases to attach an already running screen config instead of starting a new one
+  * better support for custom default yml configs and screen config templates with the customize command
+
+1.0.1 / 2010-10-29
+------------------
+
+* 2 enhancements
+
+  * Screeninator now does a better job of cleaning up after itself, removing screen configs when you delete projects
+  * re-factored some code into a helper making the CLI code much better to look at
+
+
 0.1.2 / 2010-10-12
 ------------------
 

data/README.md

@@ -98,6 +98,13 @@ Remove a project
 Remove all screeninator configs, aliases and scripts.
 
 
+Customization
+-------------
+In order to customize the starting screen configuration that is used as
+the .screen template for each project create a file in
+.screeninator/scripts/screen\_config.screen and copy your template info
+(including ERB) in to it.
+
 Questions? Comments? Feature Request?
 -------------------------------------
 

data/Rakefile

@@ -10,14 +10,16 @@ begin
     gem.email = "jon@jondruse.com"
     gem.homepage = "http://github.com/jondruse/screeninator"
     gem.authors = ["Jon Druse"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "shoulda", ">= 0"
     gem.post_install_message = <<-Message
 
 Thanks for installing Screeninator!
 
+UPGRADE WARNING - If you have a custom default config, move it to ~/.screeninator/defaults/
+
 Remember to add the following line to your .bashrc file
 
-if [[ -s $HOME/.screeninator/scripts/screeninator ]] ; then source $HOME/.screeninator/scripts/screeninator ; fi
+[[ -s "$HOME/.screeninator/scripts/screeninator" ]] && source "$HOME/.screeninator/scripts/screeninator"
   
 Message
 

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/screeninator/assets/sample.yml

@@ -2,7 +2,7 @@
 # you can make as many tabs as you wish...
 
 escape: ``
-project_name: Screeninator
+project_name: <%= @name %>
 project_root: ~/code/rails_project
 tabs:
   - shell: git pull

data/lib/screeninator/assets/screen_config.screen

@@ -4,7 +4,7 @@ escape <%= @escape || "``" %>
 autodetach on
 defscrollback 10000
 hardstatus alwayslastline
-hardstatus string '%{= kg}[ %{G} <%= @project_name %> %{g}][%= %{= kw}%?%-Lw%?%{r} (%{W}%n*%f%t%?(%u)%?%{r})%{w}%?%+Lw%?%?%= %{g}][%{B} %m/%d %{W}%c %{g}]'
+hardstatus string '%{= kg}[ %{G} <%= @project_name %> %{g}][%= %{= kw}%?%-Lw%?%{r} (%{W}%n*%f %t%?(%u)%?%{r})%{w}%?%+Lw%?%?%= %{g}][%{B} %m/%d %{W}%c %{g}]'
 
 chdir "<%= @project_root %>"
 
@@ -13,4 +13,4 @@ screen -t <%= tab.name %> <%= @tabs.index(tab) + 1 %>
 stuff "<%= tab.stuff %>\012"
 <% end %>
 
-select 1
+select 1

data/lib/screeninator/cli.rb

@@ -1,6 +1,5 @@
 require 'fileutils'
 
-## 
 # Author:: Jon Druse (mailto:jon@jondruse.com)
 # 
 # = Description
@@ -8,8 +7,8 @@ require 'fileutils'
 # This class is where each screeninator command is implemented.
 #
 # == Change History
-# 09/20/10:: created Jon Druse (mailto:jon@jondruse.com)
-### 
+# * 09/20/10:: created Jon Druse (mailto:jon@jondruse.com)
+# * 03/15/11:: renmaed usage to help. adding option parser
 module Screeninator
   class Cli
     
@@ -17,23 +16,23 @@ module Screeninator
       include Screeninator::Helper
       
       def start(*args)
-
-        if args.empty?
-          self.usage
-        else
+        
+        begin
           self.send(args.shift, *args)
+        rescue NoMethodError => e
+          puts e
+          self.help
         end
 
       end
 
       # print the usage string, this is a fall through method.
-      def usage
-        puts "Usage: screeninator ACTION [Arg]"
+      def help
+        puts HELP_TEXT
       end
       
       # Open a config file, it's created if it doesn't exist already.
       def open(*args)
-        puts "warning: passing multiple arguments to open will be ignored" if args.size > 1
         @name = args.shift
         FileUtils.mkdir_p(root_dir+"scripts")
         config_path = "#{root_dir}#{@name}.yml"
@@ -42,8 +41,9 @@ module Screeninator
           erb         = ERB.new(File.read(template)).result(binding)
           tmp         = File.open(config_path, 'w') {|f| f.write(erb) }
         end
+
         system("$EDITOR #{config_path}")
-        update_scripts
+        update(@name)
       end
       
       def copy(*args)
@@ -91,29 +91,67 @@ module Screeninator
       end
 
       def list(*args)
-        verbose = args.include?("-v")
         puts "screeninator configs:"
-        Dir["#{root_dir}**"].each do |path|
-          next unless verbose || File.extname(path) == ".yml"
-          path = path.gsub(root_dir, '').gsub('.yml','') unless verbose
-          puts "    #{path}"
-        end
+        list
       end
       
-      def update_scripts
-        Dir["#{root_dir}*.screen"].each {|p| FileUtils.rm(p) }
+      def info(*args)
+        puts "screeninator configs:"
+        list(true)
+      end
+      
+      def update(*args)
         aliases = []
-        Dir["#{root_dir}*.yml"].each do |path| 
-          path = File.basename(path, '.yml')
-          aliases << Screeninator::ConfigWriter.new(path).write!
+        Dir["#{root_dir}*.yml"].each do |path|
+          begin
+            path = File.basename(path, '.yml')
+            config_name = path.split("/").last
+            next unless args.empty? || args.include?(config_name)
+          
+            begin; FileUtils.rm("#{path}.screen"); rescue; end
+          
+            puts "updating #{config_name}"
+            aliases << Screeninator::ConfigWriter.new(path).write!
+          rescue ArgumentError => e
+            puts e
+          end
         end
         Screeninator::ConfigWriter.write_aliases(aliases)
       end
       
+      def customize(*args)        
+        @type = args.shift
+        @action = args.shift
+        if !['config','template'].include?(@type)
+          puts "Usage: screeninator customize [config|template]"
+          puts "config - This is the default YAML config file to use."
+          puts "template - This is the default screen config template, complete with ERB"
+          exit
+        end
+
+        FileUtils.mkdir_p(root_dir+"defaults")
+        
+        path = case @type 
+        when "config"; USER_CONFIG
+        when "template"; USER_SCREEN_CONFIG
+        end
+        
+        if @action.nil?
+          system("$EDITOR #{path}")
+        end
+        
+        if @action == "delete"
+          confirm!("Are you sure you want to delete #{path}? (type yes or no):") do
+            FileUtils.rm(path)
+            puts "Deleted #{path}"
+          end
+        end
+      end
+      
       private
             
       def root_dir
-        "#{ENV["HOME"]}/.screeninator/"
+        dir = "#{ENV["HOME"]}/.screeninator/"
       end
       
       def sample_config
@@ -121,7 +159,19 @@ module Screeninator
       end
       
       def user_config
-        @config_to_copy || "#{ENV["HOME"]}/.screeninator/default.yml"
+        @config_to_copy || USER_CONFIG
+      end
+      
+      def user_screen_config
+        USER_SCREEN_CONFIG
+      end
+      
+      def list(verbose=false)
+        Dir["#{root_dir}**"].each do |path|
+          next unless verbose || File.extname(path) == ".yml"
+          path = path.gsub(root_dir, '').gsub('.yml','') unless verbose
+          puts "    #{path}"
+        end
       end
       
     end

data/lib/screeninator/config_writer.rb

@@ -15,12 +15,21 @@ module Screeninator
     end
     
     def write!
-      template    = "#{File.dirname(__FILE__)}/assets/screen_config.screen"
+      if File.exists?(USER_SCREEN_CONFIG)
+        template    = USER_SCREEN_CONFIG
+      else
+        template    = "#{File.dirname(__FILE__)}/assets/screen_config.screen"
+      end
       erb         = ERB.new(IO.read(template)).result(binding)
       config_path = "#{root_dir}#{@filename}.screen"
       tmp         = File.open(config_path, 'w') {|f| f.write(erb) }
-      
-      "alias start_#{@filename}='screen -c #{config_path} -S #{@project_name.gsub(" ", "_")}'"
+
+      @project_name.gsub!(" ", "_")
+
+      check = "screen -ls | grep #{@project_name}"
+      attch = "screen -dr #{@project_name}"
+      start = "screen -c #{config_path} -S #{@project_name}"
+      %Q{alias start_#{@filename}='if [[ -n `#{check}` ]] ; then `#{attch}` ; else `#{start}`; fi'}
     end
     
     private
@@ -30,11 +39,10 @@ module Screeninator
     end
     
     def process_config!
-      yaml = YAML.load(File.read(@file_path))
-
-      exit!("Your configuration file should include some tabs.")        if yaml["tabs"].nil?
-      exit!("Your configuration file didn't specify a 'project_root'")  if yaml["project_root"].nil?
-      exit!("Your configuration file didn't specify a 'project_name'")  if yaml["project_name"].nil?
+      raise ArgumentError.new("#{@file_path} is not valid YAML!")                         unless yaml = YAML.load(File.read(@file_path))
+      raise ArgumentError.new("Your configuration file should include some tabs.")        if yaml["tabs"].nil?
+      raise ArgumentError.new("Your configuration file didn't specify a 'project_root'")  if yaml["project_root"].nil?
+      raise ArgumentError.new("Your configuration file didn't specify a 'project_name'")  if yaml["project_name"].nil?
       
       @escape       = yaml["escape"]
       @project_name = yaml["project_name"]
@@ -60,4 +68,4 @@ module Screeninator
     end
   end
   
-end
+end

data/lib/screeninator/helper.rb

@@ -1,6 +1,18 @@
 module Screeninator
   module Helper
     
+    help = ["Usage: screeninator ACTION [Args]\n\n"]
+    help << "Available Commans:\n\n"
+    help << "open CONFIG_NAME".ljust(40)                  + "Open's the config file in $EDITOR.  If it doesn't exist, it will be created."
+    help << "copy CONFIG_NAME NEW_CONFIG".ljust(40)       + "Copy an existing config into a new one."
+    help << "list".ljust(40)                              + "List all your current config files."
+    help << "info".ljust(40)                              + "List full path of all config files, their compiled versions, and bash scripts."
+    help << "customize [config|template] [delete]".ljust(40)       + "Write your own default YML config or screen template."
+    help << "update [CONFIG_NAME, CONFIG_NAME]".ljust(40) + "Recompile all config files.  Helpful if you edit them without using 'screeninator open'."
+    help << "implode".ljust(40)                           + "Destroy all configs, compiled configs, and bash scripts."
+    
+    HELP_TEXT = help.join("\n")
+    
     def exit!(msg)
       puts msg
       Kernel.exit(1)

data/lib/screeninator.rb

@@ -5,5 +5,7 @@ require 'screeninator/helper'
 require 'screeninator/cli'
 require 'screeninator/config_writer'
 
-module Screeninator  
+module Screeninator
+  USER_CONFIG        = "#{ENV["HOME"]}/.screeninator/defaults/default.yml"
+  USER_SCREEN_CONFIG = "#{ENV["HOME"]}/.screeninator/defaults/screen_config.screen"  
 end

data/screeninator.gemspec

@@ -41,9 +41,11 @@ Gem::Specification.new do |s|
   s.post_install_message = %q{
 Thanks for installing Screeninator!
 
+UPGRADE WARNING - If you have a custom default config, move it to ~/.screeninator/defaults/
+
 Remember to add the following line to your .bashrc file
 
-if [[ -s $HOME/.screeninator/scripts/screeninator ]] ; then source $HOME/.screeninator/scripts/screeninator ; fi
+[[ -s "$HOME/.screeninator/scripts/screeninator" ]] && source "$HOME/.screeninator/scripts/screeninator"
   
 }
   s.rdoc_options = ["--charset=UTF-8"]
@@ -62,10 +64,10 @@ if [[ -s $HOME/.screeninator/scripts/screeninator ]] ; then source $HOME/.screen
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
 

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: screeninator
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-    - 1
-    - 0
-    - 1
-  version: 1.0.1
+  prerelease: 
+  version: 1.0.2
 platform: ruby
 authors: 
   - Jon Druse
@@ -14,18 +10,17 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 -07:00
+date: 2011-04-04 00:00:00 -07:00
 default_executable: screeninator
 dependencies: 
   - !ruby/object:Gem::Dependency 
-    name: thoughtbot-shoulda
+    name: shoulda
     prerelease: false
     requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            segments: 
-              - 0
             version: "0"
     type: :development
     version_requirements: *id001
@@ -40,7 +35,6 @@ extra_rdoc_files:
   - README.md
 files: 
   - .document
-  - .gitignore
   - CHANGELOG.md
   - LICENSE
   - README.md
@@ -64,33 +58,33 @@ post_install_message: |
   
   Thanks for installing Screeninator!
   
+  UPGRADE WARNING - If you have a custom default config, move it to ~/.screeninator/defaults/
+  
   Remember to add the following line to your .bashrc file
   
-  if [[ -s $HOME/.screeninator/scripts/screeninator ]] ; then source $HOME/.screeninator/scripts/screeninator ; fi
+  [[ -s "$HOME/.screeninator/scripts/screeninator" ]] && source "$HOME/.screeninator/scripts/screeninator"
     
 
-rdoc_options: 
-  - --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-          - 0
         version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: Create and manage complex screen sessions easily.

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC