yakuake_controller 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2cd828dfa3e629e21a15397d2f5cbcec04104af0
+  data.tar.gz: 0a59cd4fadd6acc99989c0c812af7f51c0a4cb8d
+SHA512:
+  metadata.gz: d8af7efa8ffbf373a96fa3e1f2e5ab48918be4e1aa9d4c418dc999a54e0c2f8b3a24e029a3e8926cd5aa91540ac57959ef1af1e9c1a1a1d031fd236f3a2b09bd
+  data.tar.gz: ae041f43909aeb50f0943df0a6e4b9215eb8ddfbefdc54ebaec1689b2861703590a91e25a9d9ad4e6b1327a13f99339aa65123ccd118c87dd07e01aa4eace7b7

data/.gitignore

@@ -0,0 +1,5 @@
+*.sublime-project
+*.sublime-workspace
+Gemfile.lock
+pkg
+coverage

data/Gemfile

@@ -0,0 +1,7 @@
+#ruby=ruby-2.2.1
+#ruby-gemset=yakuake_controller
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yakuake_controller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tomislav Adamic
+
+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,31 @@
+# YakuakeController
+
+Ruby gem to interact with [Yakuake] through DBus.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yakuake_controller'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yakuake_controller
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yakuake_controller/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[Yakuake]:https://yakuake.kde.org/

data/Rakefile

@@ -0,0 +1,18 @@
+# require 'rubygems'
+require "bundler/gem_tasks"
+require 'bundler/setup'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+# load rakefile extensions (tasks)
+Dir['tasks/*.rake'].sort.each { |f| load f }
+
+task :default => [:test]

data/lib/yakuake_controller/dbus_client.rb

@@ -0,0 +1,68 @@
+require_relative "./yakuake_dbus.rb"
+
+module YakuakeController
+
+  class DBusClient
+    def initialize(dbus: YakuakeDbus.new)
+      @dbus = dbus
+    end
+
+    def terminal_ids_for_tab tab_index:
+      terminal_ids_for_session session_id: session_id(tab_index: tab_index)
+    end
+
+    def tab_title tab_index:
+      @dbus.tabs_interface.tabTitle(session_id tab_index: tab_index).first
+    end
+
+    def set_tab_title tab_index:, new_title:
+      @dbus.tabs_interface.setTabTitle session_id(tab_index: tab_index).to_i,
+                                       new_title
+    end
+
+    def run_command_in_tab tab_index:, command_text:
+      terminal_id = terminal_ids_for_tab(tab_index: tab_index).first
+      run_command_in_terminal terminal_id: terminal_id,
+                              command_text: command_text
+    end
+
+    def run_command_in_terminal terminal_id:, command_text:
+      @dbus.sessions_interface.runCommandInTerminal terminal_id.to_i, command_text
+    end
+
+    def add_tabs_if_needed count:
+      if count > sessions_ids.length
+        active_session = @dbus.sessions_interface.activeSessionId.first.to_i
+        (count - sessions_ids.length).times do
+          @dbus.sessions_interface.addSession
+        end
+        @dbus.sessions_interface.raiseSession active_session
+      end
+    end
+
+    def remove_tab tab_index:
+      @dbus.sessions_interface.removeSession session_id(tab_index: tab_index).to_i
+    end
+
+    def remove_terminal terminal_id:
+      @dbus.sessions_interface.removeTerminal terminal_id.to_i
+    end
+
+  private
+
+    def sessions_ids
+      @dbus.sessions_interface.sessionIdList.first.split(',').map{|i| i.strip}
+    end
+
+    def terminal_ids_for_session session_id:
+      @dbus.sessions_interface.terminalIdsForSessionId(session_id.to_i).
+        first.split(',').map{|i| i.strip}
+    end
+
+    def session_id tab_index:
+      @dbus.tabs_interface.sessionAtTab(tab_index.to_i).first
+    end
+
+  end
+
+end

data/lib/yakuake_controller/version.rb

@@ -0,0 +1,3 @@
+module YakuakeController
+  VERSION = "0.1.0"
+end

data/lib/yakuake_controller/yakuake_dbus.rb

@@ -0,0 +1,26 @@
+require "dbus"
+
+# to explore yakuake interfaces use
+# qdbus org.kde.yakuake /yakuake/sessions
+# qdbus org.kde.yakuake /yakuake/tabs
+
+module YakuakeController
+
+  class YakuakeDBus
+
+    attr_reader :sessions_interface, :tabs_interface
+
+    def initialize
+      bus = DBus.session_bus
+      service = bus['org.kde.yakuake']
+      sessions_proxy = service.object '/yakuake/sessions'
+      sessions_proxy.introspect
+      tabs_proxy = service.object '/yakuake/tabs'
+      tabs_proxy.introspect
+      @sessions_interface = sessions_proxy['org.kde.yakuake']
+      @tabs_interface = tabs_proxy['org.kde.yakuake']
+    end
+
+  end
+
+end

data/lib/yakuake_controller.rb

@@ -0,0 +1,6 @@
+require "yakuake_controller/version"
+require "yakuake_controller/yakuake_dbus"
+require "yakuake_controller/dbus_client"
+
+module YakuakeController
+end

data/tasks/test.rake

@@ -0,0 +1,31 @@
+require 'rake/testtask'
+
+ALL_TEST_FILES = FileList[
+    'test/{functional,unit,yakuake_controller,lib,ext}/**/*_test.rb',
+    'test/*_test.rb'
+  ]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = ALL_TEST_FILES
+  t.verbose = false
+  t.warning = false
+end
+
+namespace :test do
+
+  desc 'Run all tests and calculate code coverage'
+  task :simplecov do
+    ENV['COVERAGE'] = "true"
+    Rake::Task['test'].execute
+  end
+
+  desc 'Run single test: "rake test:single[foo_test_method]"'
+  task :single, [:test_file] do |t, args|
+    filename = File.basename(args[:test_file])
+    filepath = ALL_TEST_FILES[ ALL_TEST_FILES.find_index{|f| /.*#{filename}.*/ === f } ]
+    ENV["TEST"] = filepath
+    Rake::Task[:test].execute
+  end
+
+end

data/test/lib/yakuake_controller/dbus_client_test.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+
+describe YakuakeController::DBusClient do
+
+  before do
+    @dbus = YakuakeController::YakuakeDBus.new
+    @client = YakuakeController::DBusClient.new(dbus: @dbus)
+
+    @tab_index = 1
+    @tab_title = 'Foo tab'
+    @command_text = 'Foo command'
+    @terminal_id = 2
+    @session_id = 3
+    @terminal_ids = "4, 5"
+    @session_ids = "6, 7"
+    @session_ids_array = @session_ids.split(',').map{|i| i.strip}
+    @terminal_ids_array = @terminal_ids.split(',').map{|i| i.strip}
+  end
+
+  describe '#session_id'do
+    it 'finds Yakuake session ID for tab index' do
+      @dbus.tabs_interface.expects(:sessionAtTab).
+                           with(@tab_index).
+                           returns(["#{@session_id}"])
+
+      assert_equal @client.send(:session_id, **{tab_index: @tab_index}),
+                   "#{@session_id}"
+    end
+  end
+
+  describe '#terminal_ids_for_session' do
+    it 'finds all terminal IDs for one session ID' do
+      @dbus.sessions_interface.expects(:terminalIdsForSessionId).
+                               with(@session_id).
+                               returns([@terminal_ids])
+
+      assert_equal @client.send(:terminal_ids_for_session, **{session_id: @session_id}),
+                   @terminal_ids_array
+    end
+  end
+
+  describe '#sessions_ids' do
+    it 'finds all session IDs in Yakuake instance' do
+        @dbus.sessions_interface.expects(:sessionIdList).
+                                 returns([@session_ids])
+        assert_equal @client.send(:sessions_ids), @session_ids_array
+    end
+  end
+
+  describe '#remove_terminal' do
+    it 'removes terminal by ID' do
+      @dbus.sessions_interface.expects(:removeTerminal).
+                               with(@terminal_id).at_most_once
+      @client.remove_terminal(terminal_id: @terminal_id)
+    end
+  end
+
+  describe '#remove_tab' do
+    it 'removes tab by tab index' do
+      @dbus.sessions_interface.expects(:removeSession).
+                               with(@session_id).at_most_once
+      @dbus.tabs_interface.expects(:sessionAtTab).
+                           with(@tab_index).returns(["#{@session_id}"])
+      @client.remove_tab(tab_index: @tab_index)
+    end
+  end
+
+  describe '#add_tabs_if_needed' do
+    it 'Adds tabs to Yakuake if there are less than :count of them' do
+      @dbus.sessions_interface.expects(:raiseSession).at_most_once
+      @dbus.sessions_interface.expects(:activeSessionId).returns([@session_id])
+
+      @client.expects(:sessions_ids).returns(@session_ids_array).at_most(2)
+      @dbus.sessions_interface.expects(:addSession).at_most(4)
+      @client.add_tabs_if_needed(count: 6)
+    end
+
+    it 'Does nothing if there are already :count or more tabs' do
+      @client.expects(:sessions_ids).returns(@session_ids_array).at_most(2)
+      @dbus.sessions_interface.expects(:addSession).at_most(0)
+      @client.add_tabs_if_needed(count: 1)
+    end
+  end
+
+  describe '#run_command_in_terminal' do
+    it 'Sends text command to terminal ID specified' do
+      @dbus.sessions_interface.expects(:runCommandInTerminal).
+        with(@terminal_id, @command_text).at_most_once
+      @client.run_command_in_terminal terminal_id: @terminal_id, command_text: @command_text
+    end
+  end
+
+  describe '#run_command_in_tab' do
+    it 'Sends text command to first terminal in specified tab index' do
+      @client.expects(:terminal_ids_for_tab).
+              with(tab_index: @tab_index).returns(@terminal_ids_array)
+
+      @client.expects(:run_command_in_terminal).
+              with(terminal_id: @terminal_ids_array.first,
+                   command_text:@command_text)
+
+      @client.run_command_in_tab tab_index: @tab_index, command_text: @command_text
+    end
+  end
+
+  describe '#set_tab_title' do
+    it 'sets title of tab with provided tab index' do
+      @dbus.tabs_interface.expects(:setTabTitle).
+                           with(@session_id, @tab_title)
+      @client.expects(:session_id).with(tab_index: @tab_index).
+              returns(@session_id)
+
+      @client.set_tab_title tab_index: @tab_index, new_title: @tab_title
+    end
+  end
+
+  describe '#tab_title' do
+    it 'returns title of tab with specified tab index' do
+      @dbus.tabs_interface.expects('tabTitle').
+                           with(@session_id).returns([@tab_title])
+      @client.expects(:session_id).with(tab_index: @tab_index).
+              returns(@session_id)
+
+      assert_equal @client.tab_title(tab_index: @tab_index), @tab_title
+    end
+  end
+
+  describe '#terminal_ids_for_tab' do
+    it 'returns IDs of all terminals in tab specified by tab index' do
+      @client.expects(:session_id).with(tab_index: @tab_index).
+              returns(@session_id)
+      @client.expects(:terminal_ids_for_session).with(session_id: @session_id).
+              returns(@terminal_ids)
+
+      assert_equal @client.terminal_ids_for_tab(tab_index: @tab_index),
+                   @terminal_ids
+    end
+  end
+
+end

data/test/lib/yakuake_controller/version_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+describe YakuakeController do
+
+  it "defines VERSION" do
+    refute YakuakeController::VERSION.nil?
+  end
+
+end

data/test/lib/yakuake_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+describe YakuakeController do
+
+  it "tests that tests are loaded" do
+    assert true
+  end
+
+end

data/test/minitest_extensions.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require "minitest/reporters"
+
+Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new(:color => true)  # => Redgreen-capable version of standard Minitest reporter
+# Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new     # => Turn-like output that reads like a spec
+
+Minitest.after_run do
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'test'
+    command_name 'test'
+  end
+end
+
+require 'yakuake_controller'
+require "pry"
+
+require File.expand_path('test/minitest_extensions.rb')
+
+require 'mocha/mini_test'
+# require 'minitest/given'

data/yakuake_controller.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yakuake_controller/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'yakuake_controller'
+  spec.version       = YakuakeController::VERSION
+
+  spec.required_ruby_version = '~> 2.2'
+
+  spec.authors       = ['Tomislav Adamic']
+  spec.email         = ['tomislav.adamic@gmail.com']
+  spec.summary       = %q{Client for Yakuake DBus interface.}
+  spec.description   = %q{Client for Yakuake DBus interface.}
+  # spec.homepage      = 'TODO - enter homepage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ruby-dbus', '~> 0.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-doc', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'mocha', '~> 1.1'
+  # spec.add_development_dependency 'minitest-given', '~> 3.7'
+
+  spec.add_development_dependency 'activesupport', '~> 4.1'
+
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: yakuake_controller
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomislav Adamic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Client for Yakuake DBus interface.
+email:
+- tomislav.adamic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yakuake_controller.rb
+- lib/yakuake_controller/dbus_client.rb
+- lib/yakuake_controller/version.rb
+- lib/yakuake_controller/yakuake_dbus.rb
+- tasks/test.rake
+- test/lib/yakuake_controller/dbus_client_test.rb
+- test/lib/yakuake_controller/version_test.rb
+- test/lib/yakuake_controller_test.rb
+- test/minitest_extensions.rb
+- test/test_helper.rb
+- yakuake_controller.gemspec
+homepage: 
+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'
+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: Client for Yakuake DBus interface.
+test_files:
+- test/lib/yakuake_controller/dbus_client_test.rb
+- test/lib/yakuake_controller/version_test.rb
+- test/lib/yakuake_controller_test.rb
+- test/minitest_extensions.rb
+- test/test_helper.rb
+has_rdoc: