wrkflo 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d70b824f5d4eb229c5134ea2c72332395c46571f
-  data.tar.gz: b082c49cdb7b670d9540aac2489be8a6648ac6fe
+  metadata.gz: 92d4805587cc03e7998552a6259cf57a571e864c
+  data.tar.gz: 41f6e3f8d01d326612f876f683880ff1f633f819
 SHA512:
-  metadata.gz: eac20bcd6aa3b7da6190a5cfe318e9c78bfa748829b0e58b441be4c52659850404e33e3e6bb03437fe271b4d7b14064fd21dc97f9353b6bf990fe0b5d470e9d2
-  data.tar.gz: ea1455f2474a28cdfc8093a29f7d9eba445e571e1d9164dfafea8fab6a64fb2bce73c52fdeb6bf38f853f6fe25c10a629731c75a38a05fbf8528b2d2d4c32a7b
+  metadata.gz: 85726e95f9f54eefcd9b6763d33cd2646eff4c5fe8e0744e08d3f351ff75273eb1cb481aaed82b148488d5d8e889dfa07d706679146cfac93d6053d0813f35c7
+  data.tar.gz: 315f2af6027850d4c135cd409890cd2d4b45c66bb0cb1cc7004a2a7c1a571b589fd830af93dbe66e2c55b013048eed80228d7db90d31f537c9830ba1caab6fe2

data/bin/wrkflo

@@ -17,13 +17,13 @@ end
 
 options = {
   backward: false,
-  profile: ENV['HOME'] + '/.wrkflorc',
+  profile: ENV['HOME'] + '/.wrkflo/config',
   project: nil
 }
 OptionParser.new do |opts|
   opts.banner     = "Usage: wrkflo [options] <project>"
   opts.separator  "Start working on things faster with predefined workflows"
-  opts.version    = "0.0.2"
+  opts.version    = Wrkflo::VERSION
 
   opts.on("-b", "--backward", "Reverse step order and undo compatible steps") do |b|
     options[:backward] = b
@@ -31,7 +31,7 @@ OptionParser.new do |opts|
 
   opts.on("-f [FILE]", "--file [FILE]",
       "The file to interpret as the wrkflo profile.",
-      "Defaults to \"~/.wrkflorc\"") do |file|
+      "Defaults to \"~/.wrkflo/config\"") do |file|
     options[:profile] = file
   end
 

data/lib/wrkflo/configurable/property.rb

@@ -0,0 +1,24 @@
+module Configurable
+  class Property
+    # The name of the property as it should appear in the configuration
+    attr_accessor :name
+    # Whether the property is required to be provided by the user
+    attr_accessor :required
+    alias_method  :required?, :required
+    # The default value to be given to this property if one is not provided
+    attr_accessor :default
+
+
+    def initialize name, is_required, default_value
+      @name     = name
+      @required = is_required
+      @default  = default_value
+    end
+
+
+    # Assign a value to this property
+    def resolve_value value
+      value.nil? ? @default : value
+    end
+  end
+end

data/lib/wrkflo/configurable.rb

@@ -0,0 +1,37 @@
+require 'wrkflo/configurable/property'
+
+module Configurable
+  module ClassMethods
+    # A list of properties defined by the owner
+    def properties
+      @properties ||= {}
+    end
+
+    # Define a new property for the owning object
+    def property name, required: false, default: nil
+      properties[name] = Property.new(name, required, default)
+    end
+  end
+
+  def self.included base
+    base.extend ClassMethods
+  end
+
+
+  def apply_configuration raw_config
+    final_config = self.class.properties.each.with_object({}) do |(name, prop), h|
+      provided_value = raw_config[name.to_s]
+      # Determine the real value based on the property's definition
+      real_value = prop.resolve_value(provided_value)
+      # Remember the real value in the actual configuration
+      h[name.to_sym] = real_value
+    end
+
+    # Create a struct from the configuration hash to enable dot-access.
+    @configuration = Struct.new(*final_config.keys).new(*final_config.values)
+  end
+
+  def config
+    @configuration
+  end
+end

data/lib/wrkflo/profile.rb

@@ -0,0 +1,13 @@
+class Profile
+  def self.load source
+    @projects = YAML.load_file(source)
+    @options = @projects.delete("options")
+  rescue
+    $stderr.puts "Could not load configuration at '#{source}'."
+    $stderr.puts "Make sure the file exists before running `wrkflo`."
+    exit 1
+  end
+
+  def self.projects;  @projects;  end
+  def self.options;   @options;   end
+end

data/lib/wrkflo/project.rb

@@ -3,11 +3,13 @@ require 'wrkflo/step'
 class Project
   attr_accessor :name, :steps
 
-  def initialize name, steps
+  def initialize name
     # The name of this project workflow
-    @name = name
+    @name         = name
+    # The raw configuration used by this project
+    @config       = Profile.projects[@name]
     # The steps that make up this workflow
-    @steps = steps.map{ |name, config| Step.create(name, config, self) }
+    @steps        = @config.map{ |name, conf| Step.create(name, conf, self) }
     # The step currently being executed
     @current_step = 0
   end
@@ -24,6 +26,7 @@ class Project
       # Increment the current step so that the first step is 1
       @current_step_num += 1
       # Run the step
+      @current_step.setup
       @current_step.run
     end
 
@@ -40,6 +43,7 @@ class Project
       # Track the step being run
       @current_step = step
       # Run the step
+      @current_step.setup
       @current_step.unrun
       # Decrement the current step so that the last step is 1
       @current_step_num -= 1

data/lib/wrkflo/step.rb

@@ -1,5 +1,8 @@
+require 'os'
+require 'wrkflo/configurable'
+
 class Step
-  attr_accessor :name, :config, :project
+  attr_accessor :name, :raw_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.
@@ -15,17 +18,25 @@ class Step
     # 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)
+      @@step_map[name.to_sym].new(name, config, project) || Step.new(name, config, project)
     end
   end
 
-  def initialize name, config, project=nil
+
+  include Configurable
+
+
+  def initialize name, raw_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
+    @raw_config = raw_config
+    # The project to which this step belongs
     @project = project
+    # Generate the finalized step configuration
+    apply_configuration(@raw_config)
+    # Run step-specific initialization
+    init
   end
 
   # A pass through to this step's project's log. If this step has no project,
@@ -34,11 +45,16 @@ class Step
     @project ? @project.log(message) : puts(message)
   end
 
+
   # STEP METHODS
   #
   # These methods should be defined by all Step subclasses as given by their
   # descriptions.
 
+  # Work done immediately after initializing this step
+  def init;   end
+  # Common work done before running and unrunning.
+  def setup;  end
   # The code to run when running this step normally
   def run
     log "Nothing to do."
@@ -47,7 +63,17 @@ class Step
   def unrun
     log "Nothing to do."
   end
-end
 
-# Require all step definitions
-Dir[File.join(__dir__, 'steps', '*')].each{ |step_file| require step_file }
+
+  protected
+
+    # Return true if being run on the given platform. If a block is given, run
+    # the block only if being run on the given platform and return the result.
+    def on platform
+      if block_given?
+        yield if OS.send("#{platform}?")
+      else
+        return OS.send("#{platform}?")
+      end
+    end
+end

data/lib/wrkflo/steps/atom.rb

@@ -1,8 +1,10 @@
 class AtomStep < Step
   add_alias :atom
 
+  property :path, required: true
+
   def run
-    log "Opening an Atom Window at #{config}"
-    `atom #{config}`
+    log "Opening an Atom Window at  #{config.path}"
+    `atom #{config.path}`
   end
 end

data/lib/wrkflo/steps/editor.rb

@@ -0,0 +1,15 @@
+class Editor < Step
+  add_alias :editor
+
+  property :which,  required: false,  default: Profile.options['editor']
+  property :path,   required: true
+
+  def init
+    @editor = config.which
+    @step = Step.create(@editor.to_sym, @raw_config, project)
+    @name = "editor[#{@step.name}]"
+  end
+
+  def run;    @step.run;    end
+  def unrun;  @step.unrun;  end
+end

data/lib/wrkflo/steps/emacs.rb

@@ -1,8 +1,10 @@
 class EmacsStep < Step
   add_alias :emacs
 
+  property :path, required: true
+
   def run
-    log "Opening an Emacs frame at #{config}"
-    `emacsclient -c -a "" -n #{config}`
+    log "Opening an Emacs frame at #{config.path}"
+    `emacsclient -c -a "" -n #{config.path}`
   end
 end

data/lib/wrkflo/steps/filesystem.rb

@@ -0,0 +1,18 @@
+class FileSystem < Step
+  add_alias :filesystem
+  add_alias :fs
+
+  property :which,        required: false,  default: Profile.options['filesystem']
+  property :host,         required: true
+  property :remote_path,  required: true
+  property :local_path,   required: true
+
+  def init
+    @filesystem = config.which
+    @step = Step.create(@filesystem.to_sym, @raw_config, project)
+    @name = "filesystem[#{@step.name}]"
+  end
+
+  def run;    @step.run;    end
+  def unrun;  @step.unrun;  end
+end

data/lib/wrkflo/steps/ssh.rb

@@ -1,10 +1,13 @@
 class SSHStep < Step
   add_alias :ssh
 
+  property :host,       required: true
+  property :directory,  required: true
+
   def run
-    log "SSHing into  #{config['host']}  at  #{config['directory']}"
+    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}"'`
+    ssh_command = "ssh -t #{config.host} \\\"#{config.directory}; bash --login\\\""
+    `osascript -e 'tell application "Terminal" to activate' -e 'tell application "System Events" to tell process "Terminal" to keystroke "t" using command down' -e 'tell application "Terminal" to do script "#{ssh_command}" in selected tab of the front window'`
   end
 end

data/lib/wrkflo/steps/sshfs.rb

@@ -1,13 +1,17 @@
 class SSHFSStep < Step
   add_alias :sshfs
 
+  property :host,         required: true
+  property :remote_path,  required: true
+  property :local_path,   required: true
+
   def run
-    log "Mounting  #{config['host']}:#{config['remote_path']}  at  #{config['local_path']}"
-    `sshfs #{config['host']}:#{config['remote_path']} #{config['local_path']}`
+    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']}`
+    log "Unmounting  #{config.host}:#{config.remote_path}  from  #{config.local_path}"
+    `umount #{config.local_path}`
   end
 end

data/lib/wrkflo/steps/sublime.rb

@@ -2,8 +2,10 @@ class SublimeStep < Step
   add_alias :sublime
   add_alias :subl
 
+  property :path, required: true
+
   def run
-    log "Opening a Sublime Window at  #{config}"
-    `subl -n #{config}`
+    log "Opening a Sublime Window at  #{config.path}"
+    `subl -n #{config.path}`
   end
 end

data/lib/wrkflo/version.rb

@@ -0,0 +1,3 @@
+module Wrkflo
+  VERSION = '0.1.0'
+end

data/lib/wrkflo/wrkflo.rb

@@ -1,19 +1,51 @@
+require 'wrkflo/version'
+require 'wrkflo/profile'
 require 'wrkflo/project'
 
 class WrkFlo
   attr_accessor :direction, :profile, :profile_source
 
+  DEFAULT_STEP_PATHS = [
+    File.join(__dir__, 'steps'),
+    File.join(ENV['HOME'], '.wrkflo', 'steps'),
+    File.join('.', '.wrkflo', 'steps')
+  ]
+
   def initialize options
-    @profile = YAML.load(File.open(options[:profile]))
     @profile_source = options[:profile]
+    Profile.load(@profile_source)
+    load_step_definitions
     @direction = options[:backward] ? :backward : :forward
   end
 
+  # Load all step definitions from various default and configured paths.
+  def load_step_definitions
+    # For the default directories, try to scan them if they exist.
+    DEFAULT_STEP_PATHS.each do |path|
+      if Dir.exists?(path)
+        Dir[File.join(path, '*')].each{ |step_file| require step_file }
+      end
+    end
+
+    # For configured paths, try to require each entry and error out if one is
+    # not available.
+    configured_step_paths.each do |path|
+      if Dir.exists?(path)
+        Dir[File.join(path, '*')].each{ |step_file| require step_file }
+      else
+        require path
+      end
+    end
+  end
+
   # Get a specific project out of the profile. If the profile does not define
   # the given project, return nil.
   def [] project
-    if @profile.has_key?(project)
-      Project.new(project, @profile[project])
-    end
+    Project.new(project) if Profile.projects[project]
   end
+
+  private
+    def configured_step_paths
+      Profile.options['step_definitions'] || []
+    end
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: wrkflo
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Jon Egeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
-dependencies: []
+date: 2017-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: 
 email: jonegeland@gmail.com
 executables:
@@ -18,13 +60,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/wrkflo
+- lib/wrkflo/configurable.rb
+- lib/wrkflo/configurable/property.rb
+- lib/wrkflo/profile.rb
 - lib/wrkflo/project.rb
 - lib/wrkflo/step.rb
 - lib/wrkflo/steps/atom.rb
+- lib/wrkflo/steps/editor.rb
 - lib/wrkflo/steps/emacs.rb
+- lib/wrkflo/steps/filesystem.rb
 - lib/wrkflo/steps/ssh.rb
 - lib/wrkflo/steps/sshfs.rb
 - lib/wrkflo/steps/sublime.rb
+- lib/wrkflo/version.rb
 - lib/wrkflo/wrkflo.rb
 homepage: http://github.com/faultyserver/wrkflo
 licenses:
@@ -34,6 +82,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/wrkflo
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="