wrkflo 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c9902676f57eb67e87861f6cb79acbc4a1f7472
+  data.tar.gz: f4c48b3d64d32b15256e1ae78f482ac4c9bffdf0
+SHA512:
+  metadata.gz: 11ad90a2ac574ca8e9cebc40436b52802ccc7fdb43b66dbe9ae38cd5aff50742717f05ad5efb9c4c0d31c4da7edc3bed044ab414e7fe6942786a23822d7a7793
+  data.tar.gz: 014f69b04bdc6e01e240639c94de6397420f5eb21e2aef7b4023c0f1d88cfcbe579a74b9c5844a60a926dbddcb47dd8016d79bf09f0016c8b4b5154e995db6c5

data/bin/wrkflo

@@ -0,0 +1,59 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require 'pp'
+require 'yaml'
+
+require 'wrkflo/wrkflo'
+
+options = {
+  backward: false,
+  profile: ENV['HOME'] + '/.wrkflorc',
+  project: nil
+}
+OptionParser.new do |opts|
+  opts.banner     = "Usage: workon [options] <project>"
+  opts.separator  "Start working on things faster with predefined workflows"
+  opts.version    = "0.0.2"
+
+  opts.on("-b", "--backward", "Reverse step order and undo compatible steps") do |b|
+    options[:backward] = b
+  end
+
+  opts.on("-f [FILE]", "--file [FILE]",
+      "The file to interpret as the wrkflo profile.",
+      "Defaults to \"~/.wrkflorc\"") do |file|
+    options[:profile] = file
+  end
+
+  begin
+    # Parse and remove options from ARGV.
+    opts.parse!
+  rescue OptionParser::ParseError => error
+    # Without this rescue, Ruby would print the stack trace
+    # of the error. Instead, we want to show the error message,
+    # suggest -h or --help, and exit 1.
+    $stderr.puts error
+    $stderr.puts "(-h or --help will show valid options)"
+    exit 1
+  end
+end
+
+# An object representation of the entire workon profile, merged with
+# the options given for this run.
+workon = WorkOn.new options
+# The project workflow to execute on this run.
+project = workon[ARGV[0]]
+# If no project was specified, notify and exit
+if project == nil
+  puts "No project specified. Nothing to do."
+  exit 1
+end
+
+# Run the project workflow in the direction given from the terminal
+case workon.direction
+when :forward
+  project.run
+when :backward
+  project.unrun
+end

data/lib/wrkflo/project.rb

@@ -0,0 +1,63 @@
+require 'wrkflo/step'
+
+class Project
+  attr_accessor :name, :steps
+
+  def initialize name, steps
+    # The name of this project workflow
+    @name = name
+    # The steps that make up this workflow
+    @steps = steps.map{ |name, config| Step.create(name, config, self) }
+    # The step currently being executed
+    @current_step = 0
+  end
+
+  # Run each step in the order they are specified
+  def run
+    meta_log "Running workflow '#{@name}'"
+    # Reset the current step number
+    @current_step_num = 0
+    # Run the steps
+    @steps.each do |step|
+      # Remember the step being run
+      @current_step = step
+      # Increment the current step so that the first step is 1
+      @current_step_num += 1
+      # Run the step
+      @current_step.run
+    end
+
+    meta_log "Workflow complete"
+  end
+
+  # Undo the steps in reverse order
+  def unrun
+    meta_log "Reversing workflow '#{@name}'"
+    # Reset the current step number
+    @current_step_num = @steps.size
+    # Run the steps
+    @steps.each do |step|
+      # Track the step being run
+      @current_step = step
+      # Run the step
+      @current_step.unrun
+      # Decrement the current step so that the last step is 1
+      @current_step_num -= 1
+    end
+
+    meta_log "Workflow reversed"
+  end
+
+  # Post a message to the terminal with some identifying information
+  def log message
+    puts "> Step ##{@current_step_num} (#{@current_step.name}): #{message}"
+  end
+
+
+  private
+    # Write a log message with a different prefix marker to visually
+    # indicate a meta-type message
+    def meta_log message
+      puts "- #{message}"
+    end
+end

data/lib/wrkflo/step.rb

@@ -0,0 +1,53 @@
+class Step
+  attr_accessor :name, :config, :project
+
+  # A hash of step aliases to their respective classes. This map determines
+  # the class that a given step in a project will be transformed into.
+  @@step_map = { }
+
+  class << self
+    # Add an alias for this class to the step map. Used by subclasses to
+    # register their definitions
+    def add_alias name
+      @@step_map[name.to_sym] = self
+    end
+
+    # Create a new instance of a Step based on the step map entry. If none
+    # exists, a generic Step is created.
+    def create name='', config={}, project=nil
+      @@step_map[name.to_sym].new(name, config, project) or Step.new(name, config, project)
+    end
+  end
+
+  def initialize name, config, project=nil
+    # The name for this step
+    @name = name
+    # The options that define this step
+    @config = config
+    # The project that this step belongs to
+    @project = project
+  end
+
+  # A pass through to this step's project's log. If this step has no project,
+  # a simple puts call is used instead.
+  def log message
+    @project ? @project.log(message) : puts(message)
+  end
+
+  # STEP METHODS
+  #
+  # These methods should be defined by all Step subclasses as given by their
+  # descriptions.
+
+  # The code to run when running this step normally
+  def run
+    log "Nothing to do."
+  end
+  # The code to run when running this step backwards
+  def unrun
+    log "Nothing to do."
+  end
+end
+
+# Require all step definitions
+Dir[File.join(__dir__, 'steps', '*')].each{ |step_file| require step_file }

data/lib/wrkflo/steps/ssh.rb

@@ -0,0 +1,10 @@
+class SSHStep < Step
+  add_alias :ssh
+
+  def run
+    log "SSHing into  #{config['host']}  at  #{config['directory']}"
+
+    ssh_command = "ssh -t #{config['host']} \\\"#{config['directory']}; bash --login\\\""
+    `osascript -e 'tell application "Terminal" to activate' -e 'tell application "Terminal" to set ssh_window to do script "#{ssh_command}"'`
+  end
+end

data/lib/wrkflo/steps/sshfs.rb

@@ -0,0 +1,13 @@
+class SSHFSStep < Step
+  add_alias :sshfs
+
+  def run
+    log "Mounting  #{config['host']}:#{config['remote_path']}  at  #{config['local_path']}"
+    `sshfs #{config['host']}:#{config['remote_path']} #{config['local_path']}`
+  end
+
+  def unrun
+    log "Unmounting  #{config['host']}:#{config['remote_path']}  from  #{config['local_path']}"
+    `umount #{config['local_path']}`
+  end
+end

data/lib/wrkflo/steps/sublime.rb

@@ -0,0 +1,9 @@
+class SublimeStep < Step
+  add_alias :sublime
+  add_alias :subl
+
+  def run
+    log "Opening a Sublime Window at  #{config}"
+    `subl -n #{config}`
+  end
+end

data/lib/wrkflo/wrkflo.rb

@@ -0,0 +1,17 @@
+require 'wrkflo/project'
+
+class WorkOn
+  attr_accessor :direction, :profile, :profile_source
+
+  def initialize options
+    @profile = YAML.load(File.open(options[:profile]))
+    @profile_source = options[:profile]
+    @direction = options[:backward] ? :backward : :forward
+  end
+
+  # Get a specific project out of the profile. If the profile does not define
+  # the given project, return nil.
+  def [] project
+    Project.new(project, @profile[project])
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: wrkflo
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jon Egeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-16 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: audiobahn404@gmail.com
+executables:
+- wrkflo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/wrkflo
+- lib/wrkflo/project.rb
+- lib/wrkflo/step.rb
+- lib/wrkflo/steps/ssh.rb
+- lib/wrkflo/steps/sshfs.rb
+- lib/wrkflo/steps/sublime.rb
+- lib/wrkflo/wrkflo.rb
+homepage: http://github.com/audiobahn404/wrkflo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Get working on things faster with predefined wrkflos.
+test_files: []