pione 0.2.2 → 0.3.0

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

@@ -2,79 +2,118 @@ 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
+      #
+      # basic informations
+      #
+
+      command_name "pione-log"
+      command_banner "View and convert PIONE log."
+
+      #
+      # options
+      #
 
-      define_option do
-        use :color
-        use :debug
+      use_option :color
+      use_option :debug
 
-        default :trace_filter, []
+      option_default :trace_filter, []
 
-        define(:agent_activity) do |item|
-          item.long = "--agent-activity[=TYPE]"
-          item.desc = "output only agent activity log"
-          item.action = proc do |option, name|
-            option[: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
+      define_option(:agent_activity) do |item|
+        item.long = "--agent-activity[=TYPE]"
+        item.desc = "output only agent activity log"
+        item.action = proc do |_, option, name|
+          option[: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
+      end
 
-        define(:rule_process) do |item|
-          item.long = "--rule-process"
-          item.desc = "generate rule process log"
-          item.action = proc do |option|
-            option[:trace_filter] << Proc.new do |trace|
-              trace.attributes.include?(XES.string("pione:traceType", "rule_process"))
-            end
+      define_option(:rule_process) do |item|
+        item.long = "--rule-process"
+        item.desc = "generate rule process log"
+        item.action = proc do |_, option|
+          option[:trace_filter] << Proc.new do |trace|
+            trace.attributes.include?(XES.string("pione:traceType", "rule_process"))
           end
         end
+      end
 
-        define(:task_process) do |item|
-          item.long = "--task-process"
-          item.desc = "generate task process log"
-          item.action = proc do |option|
-            option[:trace_filter] << Proc.new do |trace|
-              trace.attributes.include?(XES.string("pione:traceType", "task_process"))
-            end
+      define_option(:task_process) do |item|
+        item.long = "--task-process"
+        item.desc = "generate task process log"
+        item.action = proc do |_, option|
+          option[:trace_filter] << Proc.new do |trace|
+            trace.attributes.include?(XES.string("pione:traceType", "task_process"))
           end
         end
+      end
 
-        define(:location) do |item|
-          item.long = "--location=LOCATION"
-          item.desc = "set log location of PIONE process"
-          item.default = Location["local:./output/pione-process.log"]
-          item.value = proc {|location| Location[location]}
-        end
+      define_option(:location) do |item|
+        item.long = "--location=LOCATION"
+        item.desc = "set log location of PIONE process"
+        item.default = Location["local:./output/pione-process.log"]
+        item.value = proc {|location| Location[location]}
+      end
+
+      define_option(:format) do |item|
+        item.long = "--format=(XES|JSON|HTML)"
+        item.desc = "set format type"
+        item.default = :xes
+        item.value = proc {|name| name.downcase.to_sym}
+      end
+
+      define_option(:log_id) do |item|
+        item.long = "--log-id=ID"
+        item.desc = "target log id"
+      end
 
-        define(:format) do |item|
-          item.long = "--format=(XES|JSON|HTML)"
-          item.desc = "set format type"
-          item.default = :xes
-          item.value = proc {|name| name.downcase.to_sym}
+      validate_option do |option|
+        unless option[:location].exist?
+          abort("File not found in the location: %s" % option[:location].uri.to_s)
         end
+      end
 
-        validate do |option|
-          unless option[:location].exist?
-            abort("File not found in the location: %s" % option[:location].uri.to_s)
-          end
+      #
+      # command lifecycle: setup phase
+      #
+
+      setup :formatter
+      setup :raw_log
+      setup :log_id
+
+      # Setup formatter.
+      def setup_formatter
+        if Log::ProcessLog.known?(option[:format])
+          @formatter = Log::ProcessLog[option[:format]]
+        else
+          abort("Unknown format: %s" % option[:format])
         end
       end
 
-      start do
-        Log::ProcessLog[option[:format]].tap do |formatter|
-          if formatter
-            $stdout.puts(formatter.read(option[:location]).format(option[:trace_filter]))
-            $stdout.flush
-          else
-            abort("Unknown format: %s" % option[:format])
-          end
+      # Read raw log table.
+      def setup_raw_log
+        @raw_log_table = @formatter.read(option[:location])
+      end
+
+      def setup_log_id
+        if option[:log_id]
+          @log_id = option[:log_id]
+        else
+          @log_id = @raw_log_table.keys.sort.last
         end
       end
+
+      #
+      # command lifecycle: execution phase
+      #
+
+      execute :format_log
+
+      # Format log file from the event log.
+      def execute_format_log
+        puts(@raw_log_table[@log_id].format(option[:trace_filter]))
+      end
     end
   end
 end

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

@@ -1,93 +1,146 @@
 module Pione
   module Command
+    # PionePackage is a command body of "pione-package".
     class PionePackage < BasicCommand
-      define_info do
-        set_name "pione-package"
-        set_banner "PIONE package utility."
-      end
+      #
+      # basic informations
+      #
 
-      define_option do
-        use :color
-        use :debug
+      command_name "pione-package"
+      command_banner "PIONE package utility."
 
-        default :output, Location["./"]
+      #
+      # options
+      #
 
-        define(:build) do |item|
-          item.long = '--build'
-          item.desc = 'build PIONE archive file(*.ppg)'
-          item.action = lambda do |option, location|
-            option[:action] = :build
-          end
-        end
+      use_option :color
+      use_option :debug
 
-        define(:output) do |item|
-          item.short = "-o"
-          item.long = "--output=LOCATION"
-          item.desc = "output file or directory location"
-          item.value = lambda {|val| Location[val]}
-        end
+      option_default :output, Location["./"]
 
-        define(:tag) do |item|
-          item.long = "--tag=NAME"
-          item.desc = "specify tag name"
-          item.value = :as_is
+      define_option(:add) do |item|
+        item.long = '--add'
+        item.desc = 'add the package to package database'
+        item.action = lambda do |_, option, location|
+          option[:action_mode] = :add
         end
+      end
 
-        define(:tag) do |item|
-          item.long = "--branch=NAME"
-          item.desc = "specify branch name"
-          item.value = :as_is
+      define_option(:build) do |item|
+        item.long = '--build'
+        item.desc = 'build PIONE archive file(*.ppg)'
+        item.action = lambda do |_, option, location|
+          option[:action_mode] = :build
         end
+      end
 
-        define(:hash_id) do |item|
-          item.long = "--hash-id=HASH"
-          item.desc = "specify git hash id"
-          item.value = :as_is
+      define_option(:write_info) do |item|
+        item.long = '--write-info'
+        item.desc = 'write package and scenario info files'
+        item.action = lambda do |_, option, location|
+          option[:action_mode] = :write_info
         end
+      end
 
-        validate do |option|
-          unless option[:output].directory?
-            abort("output location should be a directory: %s" % option[:output])
-          end
+      define_option(:output) do |item|
+        item.short = "-o"
+        item.long = "--output=LOCATION"
+        item.desc = "output file or directory location"
+        item.value = lambda {|val| Location[val]}
+      end
+
+      define_option(:tag) do |item|
+        item.long = "--tag=NAME"
+        item.desc = "specify tag name"
+        item.value = :as_is
+      end
+
+      define_option(:hash_id) do |item|
+        item.long = "--hash-id=HASH"
+        item.desc = "specify git hash id"
+        item.value = :as_is
+      end
+
+      validate_option do |option|
+        unless option[:output].directory?
+          abort("output location should be a directory: %s" % option[:output])
         end
       end
 
-      start do
-        if option[:action] == :build
-          # package is not found
-          if @argv.first.nil?
-            abort("There are no PIONE documents or packages.")
-          end
+      #
+      # command lifecycle: setup phase
+      #
 
-          # archive
-          if ppg = try_to_archive(Location[git: @argv.first], Location[data: @argv.first])
-            puts "suceeded: %s" % ppg.address
-          else
-            abort("Faild to archive.")
-          end
+      setup :target
+
+      # Check archiver target location.
+      def setup_target
+        abort("There are no PIONE documents or packages.")  if @argv.first.nil?
+        @target = @argv.first
+      end
+
+      #
+      # command lifecycle: execution phase
+      #
+
+      execute :add => :add_package
+
+      # Add the package to package database.
+      def execute_add_package
+        handler = Package::PackageReader.read(Location[@target])
+        tag = option[:tag] || handler.info.tag
+        db = Package::Database.load
+        db.add(name: handler.info.name, editor: handler.info.editor, tag: tag, digest: handler.digest)
+        db.save
+
+        # show log
+        args = []
+        args << "editor: " + handler.info.editor if handler.info.editor
+        args << "tag: " + handler.info.tag if handler.info.tag
+        _args = args.size > 0 ? "(" + args.join(", ") + ")" : ""
+        Log::SystemLog.info(
+          "package \"%s\"%s was added to package database" % [handler.info.name, _args]
+        )
+      end
+
+      execute :build => :build_package
+
+      # Build a PPG package.
+      def execute_build_package
+        if ppg = try_to_archive(Location[git: @target], Location[data: @target])
+          Log::SystemLog.info("pione-package suceeded to build %s" % ppg.address)
+        else
+          abort("pione-package faild to archive.")
         end
       end
 
-      private
+      execute :write_info => :write_info
 
-      def archive_from_directory_package
-        archiver = Component::PackageArchiver.new(Location[@argv.first])
+      # Update update info files.
+      def execute_write_info
+        Package::PackageHandler.write_info_files(Location[@target])
       end
 
+      #
+      # helper methods
+      #
+
+      private
+
       def try_to_archive(*locations)
         locations.each do |location|
           begin
+            handler = Package::PackageReader.read(location)
+            cache_location = Package::PackageCache.directory_cache(handler.digest)
+
             # make archiver
-            archiver_option = {tag: option[:tag], branch: option[:branch], hash_id: option[:hash_id]}
-            if location.location_type == :data
-              archiver_option[:tag] = Time.now.strftime("%Y%m%d%H%M")
-            end
-            archiver = Component::PackageArchiver.new(location, archiver_option)
+            archiver = Package::PackageArchiver.new(cache_location)
 
             # archive
-            return archiver.archive(option[:output])
+            return archiver.archive(option[:output], false)
           rescue => e
-            Util::ErrorReport.warn("archiver faild: %s" % location, self, e, __FILE__, __LINE__)
+            p e
+            Log::Debug.system("pione-package failed to archive %s: %s" % [location, e.message])
           end
         end
         return false

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

@@ -3,69 +3,77 @@ module Pione
     # PioneRelayAccountDB is a command that adds, deletes, shows your accounts
     # of relay servers.
     class PioneRelayAccountDB < BasicCommand
-      define_info do
-        set_name "pione-relay-account-db"
-        set_banner "Add, delete, or show your accounts of relay servers."
-      end
+      #
+      # basic informations
+      #
 
-      define_option do
-        use :color
-        use :debug
+      command_name "pione-relay-account-db"
+      command_banner "Add, delete, or show your accounts of relay servers."
 
-        define(:add) do |item|
-          item.short = "-a"
-          item.long = "--add"
-          item.desc = "add an account"
-          item.action = lambda {|option| option[:action] = :add}
-        end
+      #
+      # options
+      #
 
-        define(:delete) do |item|
-          item.short = "-d"
-          item.long = "--delete"
-          item.desc = "delete an account"
-          item.action = lambda {|option| option[:action] = :delete}
-        end
+      use_option :color
+      use_option :debug
 
-        define(:list) do |item|
-          item.short = "-l"
-          item.long = "--list"
-          item.desc = "list accounts"
-          item.action = lambda {|option| option[:action] = :list}
-        end
+      define_option(:add) do |item|
+        item.short = "-a"
+        item.long = "--add"
+        item.desc = "add an account"
+        item.action = lambda {|_, option| option[:action] = :add}
+      end
 
-        define(:realm) do |item|
-          item.short = "-r"
-          item.long = "--realm=REALM"
-          item.desc = "realm name"
-          item.value = lambda {|name| name}
-        end
+      define_option(:delete) do |item|
+        item.short = "-d"
+        item.long = "--delete"
+        item.desc = "delete an account"
+        item.action = lambda {|_, option| option[:action] = :delete}
+      end
 
-        define(:name) do |item|
-          item.short = "-u"
-          item.long = "--user=NAME"
-          item.desc = "user name"
-          item.value = lambda {|name| name}
-        end
+      define_option(:list) do |item|
+        item.short = "-l"
+        item.long = "--list"
+        item.desc = "list accounts"
+        item.action = lambda {|_, option| option[:action] = :list}
+      end
 
-        define(:password) do |item|
-          item.short = "-p"
-          item.long = "--password=PASSWORD"
-          item.desc = "password"
-          item.value = lambda {|password| password}
-        end
+      define_option(:realm) do |item|
+        item.short = "-r"
+        item.long = "--realm=REALM"
+        item.desc = "realm name"
+        item.value = lambda {|name| name}
+      end
 
-        define(:file) do |item|
-          item.short = "-f"
-          item.long = "--file=PATH"
-          item.desc = "account db path"
-          item.action = lambda {|path| Global.relay_account_db_path = path}
-        end
+      define_option(:name) do |item|
+        item.short = "-u"
+        item.long = "--user=NAME"
+        item.desc = "user name"
+        item.value = lambda {|name| name}
+      end
 
-        validate do |option|
-          abort("error: -a, -d, or -l") unless option[:action]
-        end
+      define_option(:password) do |item|
+        item.short = "-p"
+        item.long = "--password=PASSWORD"
+        item.desc = "password"
+        item.value = lambda {|password| password}
+      end
+
+      define_option(:file) do |item|
+        item.short = "-f"
+        item.long = "--file=PATH"
+        item.desc = "account db path"
+        item.action = lambda {|_, _, path| Global.relay_account_db_path = path}
+      end
+
+      validate_option do |option|
+        abort("error: -a, -d, or -l") unless option[:action]
       end
 
+      #
+      # instance methods
+      #
+
       def initialize(*options)
         super(*options)
         @realm = nil
@@ -73,38 +81,59 @@ module Pione
         @password = nil
       end
 
-      prepare do
-        # set account db
+      #
+      # command lifecycle: setup phase
+      #
+
+      setup :account_db
+      setup [:add, :delete] => :realm
+      setup :add => :name_and_password
+
+      # Set account db.
+      def setup_account_db
         Global.relay_account_db = RelayAccountDB.new(Global.relay_account_db_path)
+      end
 
-        # set realm
-        if [:add, :delete].include?(option[:action])
-          @realm = option[:realm] || HighLine.new.ask("Realm: ") unless @realm
-        end
+      # Get realm name from user input.
+      def setup_realm
+        @realm = option[:realm] || HighLine.new.ask("Realm: ") unless @realm
+      end
 
-        # set name and 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
-          end
+      # Get user name and password from user input.
+      def setup_name_and_password
+        @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
         end
       end
 
-      start do
-        db = Global.relay_account_db
-        case option[:action]
-        when :add
-          db.add(@realm, @name, @password)
-          db.save
-        when :delete
-          db.delete(@realm)
-          db.save
-        when :list
-          puts "%s accounts in %s" % [db.realms.size, Global.relay_account_db_path]
-          db.realms.each {|realm| puts "%s:%s" % [realm, db[realm].name]}
+      #
+      # command lifecycle: execution phase
+      #
+
+      execute :add => :add
+      execute :delete => :delete
+      execute :list => :list
+
+      # Add a user.
+      def execute_add
+        Global.relay_account_db.add(@realm, @name, @password)
+        Global.relay_account_db.save
+      end
+
+      # Delete a user.
+      def execute_delete
+        Global.relay_account_db.delete(@realm)
+        Global.relay_account_db.save
+      end
+
+      # Show all users.
+      def execute_list
+        puts "%s accounts in %s" % [db.realms.size, Global.relay_account_db_path]
+        Global.relay_account_db.realms.each do |realm|
+          puts "%s:%s" % [realm, Global.relay_account_db[realm].name]
         end
       end
     end