pione 0.1.2 → 0.1.3

data/lib/pione/command/pione-log.rb

@@ -0,0 +1,61 @@
+module Pione
+  module Command
+    # PioneLog is a command for viewing PIONE log or converting into other formats.
+    class PioneLog < BasicCommand
+      define_info do
+        set_name "pione-log"
+        set_banner "View and convert PIONE log."
+      end
+
+      define_option do
+        default :format, :xes
+        default :trace_filter, []
+        default :output, Location["local:./output"]
+
+        option("--agent-activity[=TYPE]", "output only agent activity log") do |data, name|
+          data[:trace_filter] << Proc.new do |trace|
+            trace.attributes.include?(XES.string("pione:traceType", "agent_activity")) and
+              (name.nil? or trace.events.first.org_resource == name)
+          end
+        end
+
+        option("--rule-process", "generate rule process log") do |data|
+          data[:trace_filter] << Proc.new do |trace|
+            trace.attributes.include?(XES.string("pione:traceType", "rule_process"))
+          end
+        end
+
+        option("--task-process", "generate task process log") do |data|
+          data[:trace_filter] << Proc.new do |trace|
+            trace.attributes.include?(XES.string("pione:traceType", "task_process"))
+          end
+        end
+
+        option("--location=LOCATION", "set log location of PIONE process") do |data, location|
+          data[:output] = Location[location]
+        end
+
+        option("--format=(XES|JSON|HTML)", "set format type") do |data, name|
+          data[:format] = name.downcase.to_sym
+        end
+
+        validate do |data|
+          unless data[:output].exist?
+            abort("File or directory not found in the location: %s" % data[:output].uri.to_s)
+          end
+        end
+      end
+
+      start do
+        Log::ProcessLog[option[:format]].tap do |formatter|
+          if formatter
+            $stdout.puts(formatter.read(option[:output]).format(option[:trace_filter]))
+            $stdout.flush
+          else
+            abort("Unknown format: %s" % option[:format])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pione/command/pione-relay-account-db.rb

@@ -1,63 +1,66 @@
 module Pione
   module Command
+    # PioneRelayAccountDB is a command that adds, deletes, shows your accounts
+    # of relay servers.
     class PioneRelayAccountDB < BasicCommand
-      set_program_name("pione-relay-account-db")
+      define_info do
+        set_name "pione-relay-account-db"
+        set_banner "Add, delete, or show your accounts of relay servers."
+      end
 
-      set_program_message <<TXT
-Add, delete, or show your accounts of relay servers.
-TXT
+      define_option do
+        option("-a", "--add", "add an account") do |data|
+          data[:action] = :add
+        end
 
-      define_option("-a", "--add", "add an account") do
-        @action = :add
-      end
+        option("-d", "--delete", "delete an account") do |data|
+          data[:action] = :delete
+        end
 
-      define_option("-d", "--delete", "delete an account") do
-        @action = :delete
-      end
+        option("-l", "--list", "list accounts") do |data|
+         data[:action] = :list
+        end
 
-      define_option("-l", "--list", "list accounts") do
-        @action = :list
-      end
+        option("-r realm", "--realm realm", "realm name") do |data, realm|
+          data[:realm] = realm
+        end
 
-      define_option("-r realm", "--realm realm", "realm name") do |realm|
-        @realm = realm
-      end
+        option("-u name", "--user name", "user name") do |data, name|
+          data[:name] = name
+        end
 
-      define_option("-u name", "--user name", "user name") do |name|
-        @name = name
-      end
+        option("-p password", "--password password", "password") do |data, password|
+          data[:password] = password
+        end
 
-      define_option("-p password", "--password password", "password") do |password|
-        @password = password
-      end
+        option("-f path", "--file path", "account db path") do |data, path|
+          Global.relay_account_db_path = path
+        end
 
-      define_option("-f path", "--file path", "account db path") do |path|
-        Global.relay_account_db_path = path
+        validate do |data|
+          abort("error: -a, -d, or -l") unless data[:action]
+        end
       end
 
       def initialize
-        @action = nil
+        @realm = nil
         @name = nil
         @password = nil
       end
 
-      def validate_options
-        abort("error: -a, -d, or -l") unless @action
-      end
-
-      def prepare
+      prepare do
         # set account db
         Global.relay_account_db = RelayAccountDB.new(Global.relay_account_db_path)
 
         # set realm
-        if [:add, :delete].include?(@action)
-          @realm = HighLine.new.ask("Realm: ") unless @realm
+        if [:add, :delete].include?(option[:action])
+          @realm = option[:realm] || HighLine.new.ask("Realm: ") unless @realm
         end
 
         # set name and password
-        if @action == :add
-          @name = HighLine.new.ask("Name: ") unless @name
-          unless @password
+        if option[:action] == :add
+          @name = option[:name] || HighLine.new.ask("Name: ")
+          unless @password = option[:password]
             @password = HighLine.new.ask("Password: "){|q| q.echo = "*"}
             password = HighLine.new.ask("Re-enter password: "){|q| q.echo = "*"}
             abort("error: password mismatch") unless @password == password
@@ -65,9 +68,9 @@ TXT
         end
       end
 
-      def start
+      start do
         db = Global.relay_account_db
-        case @action
+        case option[:action]
         when :add
           db.add(@realm, @name, @password)
           db.save
@@ -78,7 +81,6 @@ TXT
           puts "%s accounts in %s" % [db.realms.size, Global.relay_account_db_path]
           db.realms.each {|realm| puts "%s:%s" % [realm, db[realm].name]}
         end
-        terminate
       end
     end
   end

data/lib/pione/command/pione-relay-client-db.rb

@@ -1,79 +1,75 @@
 module Pione
   module Command
+    # PioneRelayClientDB is a command that adds, deletes, or shows clients in
+    # relay server.
     class PioneRelayClientDB < BasicCommand
-      set_program_name("pione-relay-client-db")
-
-      set_program_message <<TXT
-Add, delete, or show clients in this relay server.
-TXT
-
-      define_option("-a", "--add", "add a client") do
-        @action = :add
+      define_info do
+        set_name "pione-relay-client-db"
+        set_banner "Add, delete, or show clients in this relay server."
       end
 
-      define_option("-d", "--delete", "delete a client") do
-        @action = :delete
-      end
+      define_option do
+        option("-a", "--add", "add a client") do |data|
+          data[:action] = :add
+        end
 
-      define_option("-l", "--list", "list clients") do
-        @action = :list
-      end
+        option("-d", "--delete", "delete a client") do |data|
+          data[:action] = :delete
+        end
 
-      define_option("-u name", "--user name", "user name") do |name|
-        @name = name
-      end
+        option("-l", "--list", "list clients") do |data|
+          data[:action] = :list
+        end
 
-      define_option("-p password", "--password password", "password") do |password|
-        @password = password
-      end
+        option("-u name", "--user name", "user name") do |data, name|
+          data[:name] = name
+        end
 
-      define_option("-f path", "--file path", "client db path") do |path|
-        Global.relay_client_db_path = path
-      end
+        option("-p password", "--password password", "password") do |data, password|
+          data[:password] = password
+        end
 
-      def initialize
-        @action = nil
-        @name = nil
-        @password = nil
-      end
+        option("-f path", "--file path", "client db path") do |data, path|
+          Global.relay_client_db_path = path
+        end
 
-      def validate_options
-        abort("error: -a, -d, or -l") unless @action
+        validate do |data|
+          abort("error: -a, -d, or -l") unless data[:action]
+        end
       end
 
-      def prepare
+      prepare do
         # set client db
         Global.relay_client_db = RelayClientDB.new(Global.relay_client_db_path)
 
         # set name
-        if [:add, :delete].include?(@action)
-          @name = HighLine.new.ask("Name: ") unless @name
+        if [:add, :delete].include?(option[:action])
+          option[:name] = HighLine.new.ask("Name: ") unless option[:name]
         end
 
         # set password
-        if @action == :add
-          unless @password
-            @password = HighLine.new.ask("Password: "){|q| q.echo = "*"}
+        if option[:action] == :add
+          unless option[:password]
+            option[:password] = HighLine.new.ask("Password: "){|q| q.echo = "*"}
             password = HighLine.new.ask("Re-enter password: "){|q| q.echo = "*"}
-            abort("error: password mismatch") unless @password == password
+            abort("error: password mismatch") unless option[:password] == password
           end
         end
       end
 
-      def start
-        case @action
+      start do
+        case option[:action]
         when :add
-          Global.relay_client_db.add(@name, @password)
+          Global.relay_client_db.add(option[:name], option[:password])
           Global.relay_client_db.save
         when :delete
-          Global.relay_client_db.delete(@name)
+          Global.relay_client_db.delete(option[:name])
           Global.relay_client_db.save
         when :list
           names = Global.relay_client_db.names
           puts "%s clients in %s" % [names.size, Global.relay_client_db_path]
           names.each {|user| puts user}
         end
-        terminate
       end
     end
   end

data/lib/pione/command/pione-relay.rb

@@ -1,42 +1,41 @@
 module Pione
   module Command
+    # PioneRelay is a command for connecting relay server.
     class PioneRelay < FrontOwnerCommand
-      set_program_name("pione-relay") do
-        "--relay-port %s" % [@relay_port]
+      define_info do
+        set_name "pione-relay"
+        set_tail {|cmd| "--relay-port %s" % cmd.option[:relay_port]}
+        set_banner "Run relay process for connecting between clients and brokers."
       end
 
-      set_program_message <<TXT
-Runs relay process for connecting between clients and brokers.
-TXT
+      define_option do
+        default :relay_port, Global.relay_port
 
-      define_option("--realm name", "set relay realm name for client authentification") do |name|
-        Global.relay_realm = name
-      end
-
-      define_option("--relay-port port", "set relay port") do |port|
-        @relay_port = port
-      end
+        option("--realm name", "set relay realm name for client authentification") do |data, name|
+          Global.relay_realm = name
+        end
 
-      def initialize
-        @relay_port = Global.relay_port
-      end
+        option("--relay-port port", "set relay port") do |data, port|
+          data[:relay_port] = port
+        end
 
-      def validate_options
-        abort("error: no realm name") if Global.relay_realm.nil? or Global.relay_realm.empty?
-        abort("error: no relay port") unless @relay_port
+        validate do |data|
+          abort("error: no realm name") if Global.relay_realm.nil? or Global.relay_realm.empty?
+          abort("error: no relay port") unless data[:relay_port]
+        end
       end
 
       def create_front
         Front::RelayFront.new(self)
       end
 
-      def start
+      start do
         # wake up tuple space provider process
         Pione::TupleSpaceProvider.instance
 
         puts DRb.front.uri
         DRb::DRbServer.new(
-          "relay://:%s" % @relay_port,
+          "relay://:%s" % data[:relay_port],
           nil,
           {:SSLCertName => Global.relay_ssl_certname}
         )

data/lib/pione/command/pione-syntax-checker.rb

@@ -1,52 +1,79 @@
 module Pione
   module Command
+    # PioneSyntaxChecker is a command for checking syntax tree and model of the
+    # PIONE document.
     class PioneSyntaxChecker < BasicCommand
-      set_program_name("pione-syntax-checker")
+      define_info do
+        set_name "pione-syntax-checker"
+        set_banner "Print syntax tree of PIONE notation."
+      end
 
-      set_program_message <<TXT
-Prints syntax tree of PIONE notation.
-TXT
+      define_option do
+        default :readline_mode, true
+        default :transform, false
 
-      define_option('-e', '--expr=expr', 'expression string') do |e|
-        @expr = e
-        @readline_mode = false
-      end
+        option('-e', '--expr=EXPR', 'check the expression string and exit') do |data, e|
+          data[:expr] = e
+          data[:readline_mode] = false
+        end
 
-      define_option('-t', '--transformer', 'show transformer result') do
-        @transform = true
-      end
+        option('-t', '--transformer', 'show transformer result') do |data|
+          data[:transform] = true
+        end
 
-      define_option('-f', '--file=PATH', 'check syntax of the document') do |path|
-        @document = path
-        @readline_mode = false
+        option('-f', '--file=PATH', 'check syntax of the document') do |data, path|
+          data[:document] = path
+          data[:readline_mode] = false
+        end
       end
 
       def initialize
-        @readline_mode = true
+        @history = File.join(Global.dot_pione_dir, "pione-history")
       end
 
-      def prepare
+      prepare do
         require 'pp'
-        @history = File.join(Global.dot_pione_dir, "pione-history")
-        trap_int
       end
 
-      def start
-        if @readline_mode
-          start_readline_mode
-        else
-          if @document
-            print_result(Pathname.new(@document).read)
-          else
-            # print parsing result
-            print_result(@expr)
-          end
+      start do
+        case action_mode
+        when :readline
+          action_readline_mode
+        when :file
+          print_result(Pathname.new(option[:document]).read)
+        when :expr
+          print_result(option[:expr])
         end
       end
 
+      terminate(:pre) do
+        save_history if readline_mode?
+      end
+
       private
 
-      def start_readline_mode
+      # Return action mode.
+      #
+      # @return [Symbol]
+      #   action mode
+      def action_mode
+        return :readline if readline_mode?
+        return :file if option[:document]
+        return :expr if option[:expr]
+      end
+
+      # Return true if readline mode is enabled.
+      #
+      # @return [Boolean]
+      #   true if readline mode is enabled
+      def readline_mode?
+        option[:readline_mode]
+      end
+
+      # Action readline mode.
+      #
+      # @return [void]
+      def action_readline_mode
         require 'readline'
         restore_history
         buf = ""
@@ -74,40 +101,36 @@ TXT
             # don't record if it is an empty line
             Readline::HISTORY.pop
           end
-          # print parsing result
-          print_result(buf)
         end
       end
 
-      # Prints parsing result of the string
+      # Print parsing result of the string.
+      #
+      # @param str [String]
+      #   PIONE expression
+      # @return [void]
       def print_result(str)
         begin
           puts Terminal.green("syntax:")
           stree = DocumentParser.new.parse(str)
           pp stree
-          if @transform
+          if option[:transform]
             puts Terminal.green("model:")
             pp DocumentTransformer.new.apply(stree)
           end
         rescue Pione::Parser::ParserError, Parslet::ParseFailed => e
           msg = "Pione syntax error: %s (%s)" % [e.message, e.class.name]
-          @readline_mode ? puts(msg) : abort(msg)
+          readline_mode? ? puts(msg) : abort(msg)
         rescue Pione::Model::PioneModelTypeError,
           Pione::Model::VariableBindingError => e
           msg = "Pione model error: %s (%s)" % [e.message, e.class.name]
-          @readline_mode ? puts(msg) : abort(msg)
-        end
-      end
-
-      # Makes trap Ctr+C
-      def trap_int
-        trap("INT") do
-          save_history
-          exit
+          readline_mode? ? puts(msg) : abort(msg)
         end
       end
 
-      # Restores history.
+      # Restore readline's history.
+      #
+      # @return [void]
       def restore_history
         if File.exist?(@history)
           File.readlines(@history).reverse.each do |line|
@@ -116,7 +139,9 @@ TXT
         end
       end
 
-      # Saves history.
+      # Save history to file.
+      #
+      # @return [void]
       def save_history
         File.open(@history, "w+") do |file|
           Readline::HISTORY.to_a.reverse[0..100].each do |line|