lab42_tmux2 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa6d271b6905b366c4b25b82446a8704b74c7472
-  data.tar.gz: 85114f4fe2219da5a411b0ab9cb08cd1ac12abd3
+  metadata.gz: 79993d86d50f7c16d0da14ae7b0f328e6cc4ecdf
+  data.tar.gz: ce574b34edc975cb667c7ebec4e848b65db6e3b3
 SHA512:
-  metadata.gz: 1725b3048d60964398e95a044267b781b86c354c8f921447529e36f145d976eb0d53b541054d3864b8667f4d050f50e16c855e9cda7149ababd0c07ca7c5a957
-  data.tar.gz: bd945cd058a3be6b6f93b5791fc533ed386947e7341556533b7426fae0c4ce3b49e2ff4d15c34cc06dc9dfe6658b1f8e2d2e068b52b5910011bdd8ac32fd7065
+  metadata.gz: 6ff696863217be3ba06ebae74000eaf979eddbfca3c9f142a71d59c635f7116cb6f14724ca752ed889b6c988bf8a5578000ab5f521846b0c2ee4c9222e427420
+  data.tar.gz: 0e4b95d44b3935d5567c7512e1f2b3f31a0616cf79f234d8a9fcc4832d9bb59f0987f729954dbea2ce5c552c6a8fb43bb76de2e30dfe04ed13d75c0cded78b47

data/README.md

@@ -134,8 +134,55 @@ end
 Plugins are easy to write, just MP the `Lab42::Tmux::Session` class. However precise guidelines
 how to do this will be available soon, also you might want to create some configuration.
 
-The plugin guidelines and some plugins (vi, ruby, rvm, python's virtualenv) are planned for
-the near future.
+However, the goal of plugins being to be combineable the `lab42_tmux2` gem offers a mechanism to
+protect plugins from each other. This works as follows:
+
+#### A Vim Plugin
+
+##### Commands, The Easy One
+
+Instead of MPatching Lab42::Tmux::Session::Commands you just write your own module of commands, e.g.
+
+```ruby
+    require 'lab42/tmux/auto_import'
+    module VimCommands
+      def vim_window name, **options
+        new_window name do
+          send_keys "vi #{options.fetch :dir, '.'}"
+          if options[:nerdtree]
+            send_keys_raw 'C-w', 'l'
+          end
+        end
+      end
+    end
+```
+
+Now you _register_ the plugin via `Lab42::Tmux::Plugins.register VimCommands`, the benefit of doing this is, that
+the plugin will not overwrite other plugins that might have implemented  a `vim_window` command, and later plugins, that
+on their account want to define a `vim_window` command will not be able to overwite yours.
+
+##### Configuration, A Little Bit More Complicated
+
+**Not yet implemented c.f. Issues**
+
+Imagine, and it is quite useful as explained above, that whenever we use the plugin we want to have a changed default configuration.
+In our case we want to set a `pre_waint_interval` and a `post_wait_interval` by default. We could simply invoke
+`Lab42::Tmux::Session.config{ ... }` but we would be exposed to the same dangers as above, _breaking_ and _being broken_.
+
+Although conflicts might still arise, it is much saver to wrap our methods in a `with_config` block, that adds temporary configuration
+
+```ruby
+    # ...
+    def vim_window name, **options
+      # config.pre_wait_interval.nil?
+      with_config pre_wait_interval: 0.1 do
+        # config.pre_wait_interval == 0.1
+        # other config values are unchanged
+        # ...
+      end
+      # config.pre_wait_interval.nil?
+    end
+```
 
 ## Dev Notes
 

data/lib/lab42/tmux/plugins/conflict.rb

@@ -0,0 +1,8 @@
+
+module Lab42
+  module Tmux
+    module Plugins
+      Conflict = Class.new RuntimeError
+    end # module Plugins
+  end # module Tmux
+end # module Lab42

data/lib/lab42/tmux/plugins.rb

@@ -0,0 +1,31 @@
+require_relative 'plugins/conflict'
+module Lab42
+  module Tmux
+    module Plugins extend self
+      @registered = Set.new
+      attr_reader :registered
+
+      def register a_module, as: nil
+        if as
+          # Not yet implemented
+          raise ArgumentError 'as: is not yet implemented'
+          register_namespaced a_module, as
+        else
+          register_directly a_module
+        end
+      end
+
+      private
+      def register_directly a_module
+        conflicts = []
+        a_module.instance_methods.each do | im_name |
+          conflicts << im_name if registered.include? im_name
+          registered << im_name
+        end
+        raise Conflict unless conflicts.empty?
+        
+        Session.send :include, a_module
+      end
+    end
+  end # module Tmux
+end # module Lab42

data/lib/lab42/tmux/version.rb

@@ -1,6 +1,6 @@
 
 module Lab42
   module Tmux
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end # module Tmux
 end # module Lab42

data/lib/lab42/tmux/vim_plugin.rb

@@ -0,0 +1,38 @@
+require 'lab42/tmux/auto_import'
+require 'lab42/core/hash'
+
+module VimPlugin
+
+  def vim_command command, params
+    send_keys ":#{command} #{params}"
+  end
+
+  def vim_new_window name, **options
+    new_window name do
+      send_keys "vi #{__vim_dir options}"
+      __vim_source options
+      __vim_colorscheme options
+    end
+  end
+
+  private
+
+  def __vim_colorscheme options
+    options.with_present :colorscheme do | cs |
+      vim_command :colorscheme, cs
+    end
+  end
+
+  def __vim_dir options
+    options.fetch :dir, '.'
+  end
+
+  def __vim_source options
+    options.with_present :source do | source |
+      vim_command :source, source
+    end
+  end
+
+end # module VimPlugin
+
+Lab42::Tmux::Plugins.register VimPlugin

data/lib/lab42/tmux.rb

@@ -1,6 +1,7 @@
 require_relative 'tmux/config'
 require_relative 'tmux/interface'
 require_relative 'tmux/session'
+require_relative 'tmux/plugins'
 
 module Lab42
   module Tmux

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lab42_tmux2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lab42_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: forwarder2
   requirement: !ruby/object:Gem::Requirement
@@ -80,11 +94,14 @@ files:
 - lib/lab42/tmux/dry_run.rb
 - lib/lab42/tmux/errors.rb
 - lib/lab42/tmux/interface.rb
+- lib/lab42/tmux/plugins.rb
+- lib/lab42/tmux/plugins/conflict.rb
 - lib/lab42/tmux/session.rb
 - lib/lab42/tmux/session/commands.rb
 - lib/lab42/tmux/session/hooks.rb
 - lib/lab42/tmux/session/parameter_helpers.rb
 - lib/lab42/tmux/version.rb
+- lib/lab42/tmux/vim_plugin.rb
 homepage: https://github.com/RobertDober/lab42_tmux2
 licenses:
 - MIT