scite-session 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efd809ac386914ed6ce5c31d292b843f9bbb0d9e
+  data.tar.gz: 5b19a590c94d8863047538eb4a825b7499072160
+SHA512:
+  metadata.gz: 4dc744eb71c3bb741348587574a068b7e704bfbd401b1ff568f27e434ba49d9550eef10207abe65fbd023c173f9c5324bd20c0f55a6b36231193e3f495098081
+  data.tar.gz: c3d6c856128c6f88798272b93f583fa68f6c9f7ada83621fdba081d460f46fbccf0fe254e681b94df52ed5d2a062a4ce3e273475bc500fa6df636faa1ea59327

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scite-session.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Sergey Baev, https://github.com/tinbka
+
+MIT License
+
+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/README.md

@@ -0,0 +1,49 @@
+# SciTE::Session
+
+This gem is used to ease a process of starting to work on a new project.  
+It handles SciTE sessions using a yaml file with a list of windows needed to pop up on demand. With a command it restores and arranges on a display a project-specific set of SciTE windows setting them custom meta-titles.  
+It works only within KDE using `kwin`, `xwininfo` and `wmctrl`.
+
+SciTE is a non-popular text editor which I use for several reasons:  
+1. My eyes favor non-monospace fonts.  
+2. Several years ago I made cute lexers with beautiful color scheme for Ruby, CofeeScript, HAML, and Slim.  
+3. It allows to arrange its instances so that I have configs in the first corner, models in the second, controllers in the third and so on. One day it has become mnemonical.
+
+I use one Dolphin instance to manage files which allows text editor windows to contain only code not wasting display space.
+
+For more info on title template read comment at top of `./bin/kwintag.fish`
+
+## Installation
+
+Inside new project dir, so that it would be installed into an according gemset, run
+
+$ gem install scite-session
+
+## Usage
+
+Suggest there is two windows for project "my-app": one with models and another with controllers.  
+Save sessions to `~/scite/my-app/models` and `~/scite/my-app/controllers` accordingly.  
+In a console:
+
+```ruby
+require 'scite/session'
+windows = SciTE::Window.find_all
+windows[0].title = 'Models: :title:'
+windows[1].title = 'Controllers: :title:'
+windows[0].session = 'my-app/models'
+windows[1].session = 'my-app/controllers'
+SciTE::Session.save windows, layout: 'my-app'
+```
+
+Now when you run
+
+```ruby
+SciTE::Session.restore layout: 'my-app'
+```
+or
+```
+$ scite-session my-app
+```
+
+Those windows will be back on positions.  
+You can manually adjust a layout at ~/scite/layouts/my-app.yml

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scite/session"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/kwintag.fish

@@ -0,0 +1,85 @@
+#!/usr/bin/env fish
+
+# This is a modified version of what can be found at  https://unix.stackexchange.com/questions/22561/override-the-window-title-for-an-arbitrary-window-in-kde-and-set-a-custom-window
+# This version implements "meta-title", that is it keeps a custom template for a window, and when a program changes a title for the window, it extracts the title, inserts it into the template and sets a result as an actual title.
+#
+# Usage:
+#   $ kwintag  
+#   then quickly make a window active and in the opened window type a title you want
+# There is a keyword ":title:", it will be substituted with the title a program itself want to set. E.g.
+#   suggest you set "Specs: :title:" on an editor window,
+#   then an editor tries to reset it to "message_spec.rb * SciTE",
+#   then a window title actually becomes "Specs: message_spec.rb *"
+# It handles asterisk as well as regular KDE dashes and long dashes.
+
+# this block is so you can use it from the command line with -t and -w
+if test "$argv" != "" -a (math (count $argv)%2 == 0)
+    for i in (seq 1 (count $argv))
+        if test $argv[$i] = '-t'
+            set title_i_want $argv[(math 1 + $i)]
+        else if test $argv[$i] = '-w'
+            set window_id $argv[(math 1 + $i)]
+        end
+    end
+    if not test $window_id
+        echo "YOU DIDN'T ENTER A `window_id` WITH `-w`,
+SO MAKE SURE THE WINDOW YOU WANT HAS FOCUS
+TWO SECONDS FROM NOW!"
+        sleep 2
+    end
+end
+
+# get the id of the currently focused window
+if not test $window_id
+    set window_id (xprop -root _NET_ACTIVE_WINDOW | grep -P -o "0x\w+")
+end
+
+echo window_id = $window_id
+
+# get the title to force on that window
+
+if not test $title_i_want
+    set title_i_want (kdialog --title "entitled" --inputbox "Type the title you want and hit enter.
+To stop renaming, just enter nothing and hit esc.")
+end
+
+# this bit is needed for a kludge that allows window renaming
+set has_renamed_before "FALSE"
+set interrupt_message "WAIT WAIT I WANT A TURN BLOO BLOO BLEE BLUH BLOO" # hopefully i never want to actually use that as a title xD
+xprop -f _NET_WM_NAME 8u -set _NET_WM_NAME $interrupt_message -id $window_id
+
+set auto_title ""
+set custom_title ""
+# take the output of xprop
+# pipe it into a while loop
+# everytime it outputs a new line
+# stuff it into a variable named "current_title"
+xprop -spy _NET_WM_NAME -id $window_id | while read current_title
+
+    # cut off extraneous not-the-title bits of that string
+    set current_title (echo $current_title | grep -P -o '(?<=_NET_WM_NAME\(UTF8_STRING\) = ").*(?="\z)')
+
+    # if the current title is the interrupt message
+    # AND
+    # this script has renamed the window at least once before
+    # then we wanna let the new name take over
+    if test $current_title = $interrupt_message -a $has_renamed_before = "TRUE"
+        exit
+    # if title_i_want is an empty string, exit
+    else if test $title_i_want = ""
+        xprop -f _NET_WM_NAME 8u -set _NET_WM_NAME "WIDNOW WILL START RENAMING ITSELF AS NORMAL" -id $window_id
+        exit
+    # otherwise just change the title to what i want
+    else if test $current_title != $custom_title
+        set auto_title (echo $current_title | sed -re 's| \* ([—\-] )?| * - |')
+        echo auto title:    $auto_title
+        set auto_title_short (echo $auto_title | grep -P -o '.*?(?= [—\-] )')
+        echo auto title short:    $auto_title_short
+        echo title i want:     $title_i_want
+        set custom_title (echo $title_i_want | sed -e "s|:title:|$auto_title_short|")
+        echo custom title:     $custom_title
+        echo $current_title != $custom_title
+        xprop -f _NET_WM_NAME 8u -set _NET_WM_NAME "$custom_title" -id $window_id
+        set has_renamed_before "TRUE"
+    end
+end

data/bin/scite-session

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'scite/session'
+SciTE::Session.restore layout: ARGV[0]

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/scite/animation.rb

@@ -0,0 +1,44 @@
+# Basic implementation of an animation. Could be used anywhere.
+# Optimized to not do anything when it is too late to display a frame.
+module Animation
+  class << self
+    
+    def swing_easing(part)
+      0.5 - Math.cos(part * Math::PI)/2
+    end
+      
+    def perform(initial_values, target_values, frames: 40, duration: 400.0, &interpolation)
+      keys = initial_values.merge(target_values).keys
+      values_diff = keys.map_hash {|k| [k, target_values[k].to_f - initial_values[k].to_f]}
+      
+      initial_time = Time.now.to_f
+      duration_ms = duration.to_f / 1000
+      frame_count = frames
+      wait_count = frames - 1
+      
+      1.upto(frame_count) {|frame_i|
+        if frame_i != frame_count
+          now = Time.now.to_f
+          this_must_be_run_at = initial_time + duration_ms/wait_count * (frame_i - 1)
+          next_must_be_run_at = initial_time + duration_ms/wait_count * frame_i
+          next if now > this_must_be_run_at + 0.001
+        end
+        
+        frame_values = keys.map_hash {|k|
+          time_part = frame_i.to_f / frame_count
+          [k, initial_values[k] + values_diff[k] * swing_easing(time_part)]
+        }
+        #$log << frame_values
+        yield frame_values
+        
+        if frame_i != frame_count
+          now = Time.now.to_f
+          if now < next_must_be_run_at
+            sleep next_must_be_run_at - now
+          end
+        end
+      }
+    end
+  
+  end
+end

data/lib/scite/session.rb

@@ -0,0 +1,58 @@
+require "scite/session/version"
+require "rmtools"
+require "scite/animation"
+require "scite/window"
+
+module SciTE
+  
+  class << self
+    
+    def run(params={})
+      sh_pid = Process.spawn "scite #{params.map {|k, v| "-#{k}:\"#{v}\""}*' '} 1>/dev/null 2>/dev/null", pgroup: 0
+      pid = `pgrep -P #{sh_pid}`.chomp
+      #$log << pid
+      pid
+    end
+    
+    def set_title(wid, title)
+      Process.spawn "#{File.dirname(__FILE__)}/../../bin/kwintag.fish -t '#{title}' -w #{wid} 1>/dev/null 2>/dev/null", pgroup: 0
+    end
+    
+  end
+  
+  # Save and restore a SciTE sessions layout.
+  module Session
+    mattr_accessor :home, :layouts_home
+    self.home = "#{ENV['HOME']}/scite"
+    self.layouts_home = "#{home}/layouts"
+    
+    class << self
+    
+      def save(windows, layout:)
+        File.write "#{layouts_home}/#{layout}.yml", windows.map {|win|
+          {session: win.session, title: win.title, move_to: win.position}
+        }.to_yaml
+      end
+    
+      def restore(windows: nil, layout: nil)
+        if layout
+          windows ||= YAML.load read "#{layouts_home}/#{layout}.yml"
+        end
+        
+        windows.map! {|params|
+          if params.is Window
+            params
+          else
+            Window.new params
+          end
+        }
+        windows.each {|w|
+          w.create
+          sleep 0.1
+        }
+        windows.each &:wait
+      end
+    
+    end
+  end
+end

data/lib/scite/session/version.rb

@@ -0,0 +1,5 @@
+module SciTE
+  module Session
+    VERSION = "0.1.0"
+  end
+end

data/lib/scite/window.rb

@@ -0,0 +1,109 @@
+module KDE
+  
+  # Basic operations over windows in KDE.
+  class Window
+    class_attribute :header_height, :border_width
+    self.header_height = 23
+    self.border_width = 2
+    
+    attr_reader :title, :position, :pid
+    attr_writer :title
+    
+    def self.find(title: nil)
+      if title
+        if info = `wmctrl -l -p`[/^(0x\w+) +-?\d+ (\d+) .+ #{title}$/]
+          new title: title, pid: $2.to_i, wid: $1
+        end
+      end
+    end
+  
+    def initialize(title: nil, pid: nil, wid: nil)
+      @title, @pid, @wid = title, pid, wid
+      @threads = []
+    end
+    
+    def wait
+      @threads.joins
+      @threads = []
+      self
+    end
+    
+    def wid
+      @wid ||= `wmctrl -l -p | grep " #@pid "`[/0x\w+/]
+    end
+    
+    def position
+      @position ||= begin
+        shape = `xwininfo -id #{wid} -shape`.lines
+        dimms = shape.grep(/-geometry/)[0].match(/(?<w>\d+)x(?<h>\d+)/)
+        corner = shape.grep(/Corner/)[0].match(/\+(?<x>-?\d+)\+(?<y>-?\d+)/)
+        {w: dimms[:w].to_i, h: dimms[:h].to_i,
+          x: corner[:x].to_i - border_width, y: corner[:y].to_i - header_height}
+      end
+    end
+    
+    def position=(coords)
+      coords = coords.map_hash {|k, v| [k, v.to_i]}
+      if @position != coords
+        @position = coords
+        `wmctrl -i -r #{wid} -e 0,#{coords[:x]},#{coords[:y]},#{coords[:w]},#{coords[:h]}`
+      end
+    end
+    
+    def move(frames: 20, duration: 400.0, **coords)
+      coords.reverse_merge! position
+      #$log << [position, coords, {frames: frames, duration: duration}]
+      Animation.perform(position, coords, frames: frames, duration: duration) {|coords|
+        self.position = coords
+      }
+    end
+    
+  end
+  
+end
+
+module SciTE
+
+  # SciTE-specific operations over windows in KDE.
+  class Window < KDE::Window
+    attr_reader :session, :move_to
+    attr_writer :session
+    
+    def self.find_all
+      `wmctrl -l -p`.split("\n").map {|line|
+        if line[/^(0x\w+) +-?\d+ (\d+) +\S+ +(.+ [-*] SciTE)$/]
+          new(title: $3, pid: $2.to_i, wid: $1)
+        end
+      }.compact
+    end
+  
+    def initialize(title: nil, pid: nil, wid: nil, session: nil, move_to: nil)
+      @session, @move_to = session, move_to
+      super title: title, pid: pid, wid: wid
+    end
+    
+    def create(&oncreate)
+      @pid ||= SciTE.run loadsession: "#{SciTE::Session.home}/#@session"
+      @threads << Thread.new {
+        sleep 0.2
+        self.position = {w: 50, h: 20, x: 2550, y: -40}
+        sleep 3 # даём вкладкам прогрузиться
+        move if @move_to
+        set_title if @title
+        yield self if block_given?
+      }
+      self
+    end
+    
+    def move(frames: 20, duration: 400.0, **coords)
+      coords.reverse_merge! @move_to if @move_to
+      super
+    end
+    
+    def set_title
+      SciTE.set_title wid, @title
+    end
+    
+  end
+
+end

data/scite-session.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scite/session/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scite-session"
+  spec.version       = SciTE::Session::VERSION
+  spec.authors       = ["Sergey Baev"]
+
+  spec.summary       = "Restores and arranges multiple SciTE sessions within KDE"
+  spec.homepage      = "https://github.com/tinbka/" + spec.name
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.bindir        = "bin"
+  spec.executables   = ["scite-session"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+  spec.add_dependency "rmtools", "~> 2.5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: scite-session
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Baev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rmtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: 
+email: 
+executables:
+- scite-session
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/kwintag.fish
+- bin/scite-session
+- bin/setup
+- lib/scite/animation.rb
+- lib/scite/session.rb
+- lib/scite/session/version.rb
+- lib/scite/window.rb
+- scite-session.gemspec
+homepage: https://github.com/tinbka/scite-session
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Restores and arranges multiple SciTE sessions within KDE
+test_files: []