zashoku 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 922f72730a69266a0d9887bc40d29e1f8ec6d6db
-  data.tar.gz: 58f7296f3a64ddb859662cdb55051fe612c80a86
+  metadata.gz: f452ac173dc980027b942716bd56472cb40a8770
+  data.tar.gz: ba9020e54e6db010d51ea17a7514053514363edf
 SHA512:
-  metadata.gz: 77359dc8bae25be4eace1ed61ce022e32a2526bf132918f862ae2d12aa5aa81733b0da5c186f8ed039ee75639221539d8b3c515173220141eb3542ca1d4dc7c7
-  data.tar.gz: 5f7aad025b5ef676ff851c5eab70a8a9d86e7bc83edce5e2c1971df47c1e5713e8c60b332494ebdc7be276ab8a3830288c9e94473767881016e24773a581c48e
+  metadata.gz: 5fbce4a8509ff7a4138348221ef43b82fe37355903f5716ddc4443ba92683154becca9fc98d7bf2ced0fe6384508935035053aa77a654697edafdc3fa8dd7794
+  data.tar.gz: 0ed5d01d23a2549742becf9c089b25f7641b13201e3c583814a164ee595efe41a53b520e6d10cf0e2f61fa182d6de0891d26237a260158228adf1e7515f3b288

data/examples/hello/README.md

@@ -0,0 +1,17 @@
+# Example hello world app
+
+## to run
+
+first
+
+```
+cd examples/hello
+bin/hello -s
+```
+
+then, in another terminal
+
+```
+cd examples/hello
+bin/hello
+```

data/examples/hello/config/daemon.yml

@@ -0,0 +1 @@
+---

data/examples/hello/config/view.yml

@@ -0,0 +1 @@
+---

data/examples/hello/modules/hello/README.md

@@ -0,0 +1 @@
+# README for hello

data/examples/hello/modules/hello/config/daemon.yml

@@ -0,0 +1 @@
+---

data/examples/hello/modules/hello/config/view.yml

@@ -0,0 +1,13 @@
+---
+keymaps:
+  global:
+    #1: change_view hello
+  hello:
+
+title:
+    hello: hello
+format:
+  hello:
+    title: " %t "
+    parent: " %t@ %l "
+    child: "  %t@ %l "

data/examples/hello/modules/hello/lib/hello.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zashoku
+  module Hello
+    extend Zashoku::Module
+
+    Version = [1, 0, 0].freeze
+    Root    = File.expand_path('../', __dir__)
+
+    autoload :HelloController, File.join(Root, 'lib/hello/hello_controller')
+    autoload :HelloView, File.join(Root, 'lib/hello/hello_view')
+
+    def self.view
+      HelloView.new
+    end
+
+    def self.controller
+      HelloController.new
+    end
+  end
+end

data/examples/hello/modules/hello/lib/hello/hello_controller.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'hello_item'
+
+module Zashoku
+  module Hello
+    class HelloController < Zashoku::Controller
+      def items
+        {
+          HelloItem.new(title: 'hello', lang: 'en') => [
+            HelloItem.new(title: 'おはようございます', lang: 'jp'),
+            HelloItem.new(title: 'こんにちは', lang: 'jp')
+          ],
+          HelloItem.new(title: 'world', lang: 'en') => [
+            HelloItem.new(title: 'earth', lang: 'en'),
+            HelloItem.new(title: '世界', lang: 'jp')
+          ]
+        }
+      end
+    end
+  end
+end

data/examples/hello/modules/hello/lib/hello/hello_item.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Zashoku
+  module Hello
+    class HelloItem < Zashoku::Item
+    end
+  end
+end

data/examples/hello/modules/hello/lib/hello/hello_view.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'hello_item'
+
+module Zashoku
+  module Hello
+    class HelloView < Zashoku::View
+      def refresh_attributes
+        @attributes = {
+          't' => Zashoku.conf.get(%w[title hello]),
+        }
+      end
+
+      def refresh_items
+        Zashoku.command(mod: 'remote::hello', meth: 'items')
+      end
+
+      def get_format
+        Zashoku.conf.get(%w[format hello])
+      end
+    end
+  end
+end

data/lib/constants.rb

@@ -3,7 +3,7 @@
 require_relative 'core/util/util'
 
 module Zashoku
-  Version = [1, 5, 2].freeze
+  Version = [1, 5, 3].freeze
 
   Root    = File.expand_path('../', __dir__)
 
@@ -16,6 +16,10 @@ module Zashoku
         viewer: [],
         daemon: [],
       },
+      log_level: {
+        viewer: :warn,
+        daemon: :info
+      },
       save_config: false,
       save_history: false,
       persistent_daemon: false,

data/lib/core/module.rb

@@ -26,10 +26,10 @@ module Zashoku
     def self.require_all(modules)
       modules.map do |mod|
         if require_module(mod)
-          Zashoku.logger.debug("loaded module #{mod}")
+          Zashoku.logger.info("loaded module #{mod}")
           Zashoku.const_get(mod)
         else
-          Zashoku.logger.debug("failed to load module #{mod}")
+          Zashoku.logger.error("failed to load module #{mod}")
           nil
         end
       end.compact

data/lib/core/modules/conf/config/view.yml

@@ -0,0 +1,12 @@
+---
+keymaps:
+  global:
+    ',': change_view conf
+  conf:
+
+title:
+    conf: config
+format:
+  conf:
+    title: " %t "
+    parent: " %t@ %v "

data/lib/core/net/client.rb

@@ -4,8 +4,6 @@ require 'socket'
 require 'json'
 require 'thread'
 
-require 'pry'
-
 module Zashoku
   module Net
     class Client
@@ -16,6 +14,8 @@ module Zashoku
         @socket = connect(@host, @port)
         @alive = true
 
+        @timeout = 2
+
         @callbacks = []
 
         @command_queue = Queue.new
@@ -39,6 +39,7 @@ module Zashoku
         @events_thread&.exit
       end
 
+
       def self.command(host, port, msg, args = {})
         sock = TCPSocket.new(host, port)
         sock.puts(JSON.generate({'msg' => msg}.merge(args)))
@@ -78,7 +79,7 @@ module Zashoku
       def lost_connection
         @alive = false
         @socket.close
-        Zashoku.logger.debug('lost connection')
+        Zashoku.logger.warn('lost connection')
         Util.alert('no connection')
         stop_threads
       end
@@ -97,7 +98,16 @@ module Zashoku
           payload = { 'msg' => msg }.merge(args)
           @command_queue << JSON.generate(payload)
 
-          result = @result_queue.pop
+          result = nil
+          start = Time.now
+          thread = Thread.new do
+            result = @result_queue.pop
+          end
+          sleep 0.1 until result || (Time.now - start) > @timeout
+          thread.exit
+
+          result ||= {}
+
           result.keys.length == 1 ? result['response'] : result
         }
       end
@@ -119,16 +129,17 @@ module Zashoku
       end
 
       def distribute_results!
-        response = JSON.parse(@socket.readline)
+        raw = @socket.readline
+        response = JSON.parse(raw)
         if response['event']
           @event_queue << response
         else
           @result_queue << response
         end
       rescue JSON::ParserError
-        Zashoku.logger.debug("discarding #{response}, JSON::ParserError")
+        Zashoku.logger.error("discarding #{raw}, JSON::ParserError")
       rescue EOFError
-        Zashoku.logger.debug('eof error')
+        Zashoku.logger.error('eof error')
         lost_connection
       rescue IOError
         Util.alert("error: socket#{@socket}")

data/lib/core/net/server.rb

@@ -50,6 +50,7 @@ module Zashoku
             break unless response
           end
         end
+        Zashoku.logger.info("client #{client.hash} disconnected")
         @clients.delete(client)
         @client_queue.delete(client)
         client.close
@@ -59,7 +60,7 @@ module Zashoku
         Thread.abort_on_exception = true
         loop do
           Thread.start(@server.accept) do |client|
-            Zashoku.logger.debug("got client (hash: #{client.hash})")
+            Zashoku.logger.info("got client (hash: #{client.hash})")
             @clients << client
             @client_queue[client] = Queue.new
             handle(client)

data/lib/core/options.rb

@@ -15,7 +15,7 @@ module Zashoku
       }
 
       parser = OptionParser.new do |opts|
-        opts.banner = 'Usage: zashoku [options]'
+        opts.banner = "Usage: #{Zashoku::CConf[:app][:name]} [options]"
 
         opts.on('-s [COMMAND]', '--server [COMMAND]', 'pass commands to the server') do |cmd|
           options[:server] = true
@@ -26,9 +26,11 @@ module Zashoku
           options[:daemon] = true
         end
 
-        opts.on('-g TEMPLATE', '--generate TEMPLATE', 'generate a template') do |template|
-          options[:template] = template
-          options[:generate] = true
+        if Zashoku::CConf[:app][:name] == 'zashoku'
+          opts.on('-g TEMPLATE', '--generate TEMPLATE', 'generate a template') do |template|
+            options[:template] = template
+            options[:generate] = true
+          end
         end
 
         opts.on_tail('-h', '--help', 'Show this message') do

data/lib/core/statusline/statusline.rb

@@ -5,7 +5,6 @@ require_relative 'widget'
 module Zashoku
   module Statusline
     def self.new
-      Zashoku.logger.debug('statusline.new')
       Zashoku::Statusline::Statusline.new
     end
 
@@ -16,7 +15,7 @@ module Zashoku
         @widgets = Zashoku.modules.keys.zip(Zashoku.modules.map do |_k, m|
           m.widgets if m.respond_to?(:widgets)
         end).to_h.compact
-        Zashoku.logger.debug("loaded widgets for #{@widgets.keys.join(', ')}")
+        Zashoku.logger.info("loaded widgets for #{@widgets.keys.join(', ')}")
         refresh
       end
 

data/lib/core/util/readline.rb

@@ -87,7 +87,7 @@ module Zashoku
               Curses.beep
             end
           else
-            Zashoku.logger.debug("unknown key #{c}")
+            Zashoku.logger.warn("unbound key pressed: #{c}")
             Curses.beep
           end
           @history[@hy_index] = string

data/lib/core/util/util.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'base64'
-require_relative 'readline'
 
 module Zashoku
   module Util
@@ -10,6 +9,7 @@ module Zashoku
     end
 
     def self.decode_object(e)
+      return e if e.class == Hash
       Marshal.load(Base64.decode64(e))
     rescue ArgumentError
       {}

data/lib/core/view.rb

@@ -27,7 +27,7 @@ module Zashoku
     end
 
     def dirty_all_lines
-      @dirty_lines = 0.step(Term.rows-2).to_a
+      @dirty_lines = 0.step(get_len).to_a
     end
 
     def next_match
@@ -66,7 +66,6 @@ module Zashoku
 
         matches
       end.flatten(1) #.sort.reverse
-      Zashoku.logger.debug(@matches)
       next_match
     end
 

data/lib/daemon.rb

@@ -36,6 +36,7 @@ module Zashoku
       @semaphore = Mutex.new
 
       Zashoku.logger = Logger.new(STDOUT)
+      Zashoku.logger.level = Zashoku::CConf[:app][:log_level][:daemon]
       # Load conf
       Zashoku.conf = DaemonConfig.new
       # Load modules
@@ -53,7 +54,7 @@ module Zashoku
       lay_traps!
       @server = Net::Server.new(Zashoku::CConf[:app][:net][:port])
       @server.handler = method(:respond)
-      Zashoku.logger.debug('server listening')
+      Zashoku.logger.info('server listening')
       sleep
     end
 

data/lib/generator.rb

@@ -38,7 +38,9 @@ module Zashoku
       def pairs
         @pairs || @pairs = {
           /<name>/ => @name,
-          /<Name>/ => @name.capitalize
+          /<Name>/ => @name.capitalize,
+          /<zv_short>/ => Zashoku::Version.first(2).join('.'),
+          /<zv_long>/ => Zashoku::Version.join('.')
         }
       end
 

data/lib/viewer.rb

@@ -12,6 +12,7 @@ require_relative 'core/controller'
 require_relative 'core/config/view_config'
 require_relative 'core/net/client'
 require_relative 'core/statusline/statusline'
+require_relative 'core/util/readline'
 require_relative 'core/util/term'
 require_relative 'core/util/util'
 require_relative 'core/formatter'
@@ -34,7 +35,6 @@ module Zashoku
         message[:mod] = message[:mod].gsub('remote::', '')
         Zashoku.logger.debug("sending message #{message}")
         msg = Zashoku::Util.decode_object(client.command('fwd', message))
-        Zashoku.logger.debug('got it')
         msg
       else
         modules[message[:mod]].send(message[:meth], *message[:args])
@@ -57,6 +57,7 @@ module Zashoku
       Zashoku.logger = Logger.new(
         File.join(Zashoku::CConf[:app][:root], "#{Zashoku::CConf[:app][:name]}.log")
       )
+      Zashoku.logger.level = Zashoku::CConf[:app][:log_level][:viewer]
 
       Zashoku.conf = ViewConfig.new
 
@@ -75,9 +76,7 @@ module Zashoku
       end).to_h
       @view = @views.keys.first
 
-      Zashoku.logger.debug('initializing statusline')
       @statusline = Statusline.new
-      Zashoku.logger.debug(@statusline)
       @statusline.add_observer(self, :draw_statusline)
 
       @cmdline = Util::Readline.new(
@@ -148,8 +147,12 @@ module Zashoku
     def cleanup
       Zashoku.client.disconnect
       @key_thread&.exit
-      Zashoku.command_server('stop') if Zashoku::CConf[:app][:persistent_daemon]
       Curses.close_screen
+
+      unless Zashoku::CConf[:app][:persistent_daemon]
+        Zashoku.command_server('stop')
+      end
+
       if Zashoku::Conf.save?
         Util.put_yaml(CMD_HISTORY, @cmdline.history)
         Util.put_yaml(SRCH_HISTORY, @searchline.history)
@@ -185,7 +188,7 @@ module Zashoku
       raise "no such command" if cmd.split.length == 1
       command(*cmd.split) unless cmd.empty?
     rescue StandardError => e
-      Zashoku.logger.debug("#{cmd.split} raised an error '#{e}'")
+      Zashoku.logger.error("#{cmd.split} raised an error '#{e}'")
       Util.alert("Error: #{e}")
     end
 
@@ -250,7 +253,7 @@ module Zashoku
         begin
           command(mod, meth, *args)
         rescue Exception => e
-          Zashoku.logger.debug("#{[mod, meth, args].join(', ')} raised #{e}")
+          Zashoku.logger.error("#{[mod, meth, args].join(', ')} raised #{e}")
         end
       end
     end

data/templates/app/README.md

@@ -0,0 +1 @@
+# readme for <name>

data/templates/app/config/daemon.yml

@@ -0,0 +1 @@
+---

data/templates/app/config/view.yml

@@ -0,0 +1 @@
+---

data/templates/app/lib/<name>.rb

@@ -0,0 +1,3 @@
+module <Name>
+  Version = [0, 0, 0].freeze
+end

data/templates/module/README.md

@@ -0,0 +1 @@
+# README for <name>

data/templates/module/config/daemon.yml

@@ -0,0 +1 @@
+---

data/templates/module/config/view.yml

@@ -0,0 +1,13 @@
+---
+keymaps:
+  global:
+    #1: change_view <name>
+  <name>:
+
+title:
+    <name>: <name>
+format:
+  <name>:
+    title: " %t "
+    parent: " %t"
+    child: "  %t "

data/templates/module/lib/<name>.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zashoku
+  module <Name>
+    extend Zashoku::Module
+
+    Version = [1, 0, 0].freeze
+    Root    = File.expand_path('../', __dir__)
+
+    autoload :<Name>Controller, File.join(Root, 'lib/<name>/<name>_controller')
+    autoload :<Name>View, File.join(Root, 'lib/<name>/<name>_view')
+
+    def self.view
+      <Name>View.new
+    end
+
+    def self.controller
+      <Name>Controller.new
+    end
+  end
+end

data/templates/module/lib/<name>/<name>_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '<name>_item'
+
+module Zashoku
+  module <Name>
+    class <Name>Controller < Zashoku::Controller
+    end
+  end
+end

data/templates/module/lib/<name>/<name>_item.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Zashoku
+  module <Name>
+    class <Name>Item < Zashoku::Item
+    end
+  end
+end

data/templates/module/lib/<name>/<name>_view.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '<name>_item'
+
+module Zashoku
+  module <Name>
+    class <Name>View < Zashoku::View
+      def refresh_attributes
+        @attributes = {
+          't' => Zashoku.conf.get(%w[title <name>]),
+        }
+      end
+
+      def refresh_items
+        Zashoku.command(mod: 'remote::<name>', meth: 'items')
+      end
+
+      def get_format
+        Zashoku.conf.get(%w[format <name>])
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zashoku
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - annacrombie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -100,6 +100,16 @@ files:
 - "./README.md"
 - "./config/daemon.yml"
 - "./config/view.yml"
+- "./examples/hello/README.md"
+- "./examples/hello/config/daemon.yml"
+- "./examples/hello/config/view.yml"
+- "./examples/hello/modules/hello/README.md"
+- "./examples/hello/modules/hello/config/daemon.yml"
+- "./examples/hello/modules/hello/config/view.yml"
+- "./examples/hello/modules/hello/lib/hello.rb"
+- "./examples/hello/modules/hello/lib/hello/hello_controller.rb"
+- "./examples/hello/modules/hello/lib/hello/hello_item.rb"
+- "./examples/hello/modules/hello/lib/hello/hello_view.rb"
 - "./lib/constants.rb"
 - "./lib/core/config/config.rb"
 - "./lib/core/config/daemon_config.rb"
@@ -108,6 +118,7 @@ files:
 - "./lib/core/formatter.rb"
 - "./lib/core/item.rb"
 - "./lib/core/module.rb"
+- "./lib/core/modules/conf/config/view.yml"
 - "./lib/core/modules/conf/lib/conf.rb"
 - "./lib/core/modules/conf/lib/conf/config_view.rb"
 - "./lib/core/net/client.rb"
@@ -115,8 +126,6 @@ files:
 - "./lib/core/options.rb"
 - "./lib/core/statusline/statusline.rb"
 - "./lib/core/statusline/widget.rb"
-- "./lib/core/util/folder_listen.rb"
-- "./lib/core/util/matcher.rb"
 - "./lib/core/util/readline.rb"
 - "./lib/core/util/term.rb"
 - "./lib/core/util/util.rb"
@@ -127,6 +136,17 @@ files:
 - "./lib/generator/module_generator.rb"
 - "./lib/viewer.rb"
 - "./lib/zashoku.rb"
+- "./templates/app/README.md"
+- "./templates/app/config/daemon.yml"
+- "./templates/app/config/view.yml"
+- "./templates/app/lib/<name>.rb"
+- "./templates/module/README.md"
+- "./templates/module/config/daemon.yml"
+- "./templates/module/config/view.yml"
+- "./templates/module/lib/<name>.rb"
+- "./templates/module/lib/<name>/<name>_controller.rb"
+- "./templates/module/lib/<name>/<name>_item.rb"
+- "./templates/module/lib/<name>/<name>_view.rb"
 - bin/zashoku
 homepage: https://github.com/zashoku/zashoku/
 licenses:

data/lib/core/util/folder_listen.rb

@@ -1,53 +0,0 @@
-# watch for changes in a folder's existance
-
-module Zashoku
-  module Util
-    module FolderListen
-
-      def self.to(dirs, &block)
-        Listener.new(dirs, &block)
-      end
-
-      ##
-      ## @brief      Similar to Listen gem but uses polling and is only intended
-      ##             to be used on a small number of files. the Listen gem
-      ##             wouldn't support watching an individual FOLDER to see if
-      ##             the folder went away so this is that!
-      ##
-      class Listener
-        def initialize(dirs, &block)
-          @dirs           = dirs
-          @block          = block
-          @sleep_duration = 1
-          @dir_hash       = dir_hash
-        end
-
-        def dir_hash
-          @dirs.map { |dir| [dir, File.exist?(dir)]}.to_h
-        end
-
-        def changed?
-          @dir_hash != dir_hash
-        end
-
-        def stop
-          @listen_thread.exit if @listen_thread
-        end
-
-        def start
-          Thread.abort_on_exception = true
-          @listen_thread = Thread.new do
-            while true
-              if changed?
-                @block.call
-                @dir_hash = dir_hash
-              end
-              sleep 1
-            end
-          end
-        end
-
-      end
-    end
-  end
-end