pione 0.1.1 → 0.1.2

data/lib/pione/transformer/rule-definition-transformer.rb

@@ -1,14 +1,16 @@
 module Pione
   module Transformer
+    # RuleDefinitionTransformer is a transformer for syntax tree of rule definitions.
     module RuleDefinitionTransformer
       include TransformerModule
 
+      # @api private
       def check_model_type(obj, pione_model_type)
         pione_model_type.match(obj.pione_mode_type)
       end
       module_function :check_model_type
 
-      # rule_definition
+      # Transform +:rule_definition+ as Model::Rule.
       rule(:rule_definition => {
           :rule_header => simple(:rule_expr),
           :rule_conditions => sequence(:conditions),
@@ -17,7 +19,7 @@ module Pione
         outputs = Naming::OutputLine.values(conditions)
         params = Parameters.merge(*Naming::ParamLine.values(conditions))
         features = Feature::AndExpr.new(*Naming::FeatureLine.values(conditions))
-        condition = RuleCondition.new(inputs, outputs, params, features)
+        condition = RuleCondition.new(inputs, outputs, params, features, TicketExpr.empty, TicketExpr.empty)
         case block
         when ActionBlock
           ActionRule
@@ -26,19 +28,19 @@ module Pione
         end.new(rule_expr, condition, block)
       }
 
-      # input_line
+      # Transform +:input_line+ as Naming::InputLine.
       rule(:input_line => simple(:data_expr)) {
         TypeDataExpr.check(data_expr)
         Naming.InputLine(data_expr)
       }
 
-      # output_line
+      # Transform +:output_line+ as Naming::OutputLine.
       rule(:output_line => simple(:data_expr)) {
         TypeDataExpr.check(data_expr)
         Naming.OutputLine(data_expr)
       }
 
-      # param_line
+      # Transform +:param_line+ as Naming::ParamLine.
       rule(:param_line => simple(:param)) {
         unless TypeAssignment.match(param) or TypeParameters.match(param)
           raise PioneModelTypeError.new(param, TypeAssignment)
@@ -46,7 +48,7 @@ module Pione
         Naming.ParamLine(param)
       }
 
-      # feature_line
+      # Transform +:feature_line+ as Naming::FeatureLine.
       rule(:feature_line => simple(:feature)) {
         TypeFeature.check(feature)
         Naming.FeatureLine(feature)

data/lib/pione/transformer/transformer-module.rb

@@ -1,7 +1,10 @@
 module Pione
   module Transformer
+    # TransformerModule enables parslet's transforms to be defined by multiple
+    # modules.
     module TransformerModule
       class << self
+        # @api private
         def included(mod)
           singleton = class << mod; self; end
           create_pair_by(Parslet, Parslet::Transform).each do |name, orig|
@@ -22,15 +25,14 @@ module Pione
 
         private
 
+        # Create module and the methods pair by modules.
+        #
+        # @api private
         def create_pair_by(*mods)
           mods.inject([]) do |list, mod|
-            list += create_pair(mod)
+            list + (mod.methods.sort - Object.methods.sort).map{|m| [m, mod]}
           end
         end
-
-        def create_pair(mod)
-          (mod.methods.sort - Object.methods.sort).map{|m| [m, mod]}
-        end
       end
     end
   end

data/lib/pione/tuple/ticket-tuple.rb

@@ -0,0 +1,8 @@
+module Pione
+  module Tuple
+    # TicketTuple is a tuple representation of ticket.
+    class TicketTuple < BasicTuple
+      define_format [:ticket, :domain, :ticket_name]
+    end
+  end
+end

data/lib/pione/util/{message.rb → console-message.rb}

@@ -1,13 +1,13 @@
 module Pione
   module Util
-    # Message is a set of utility methods for sending messages to user.
-    module Message
+    # ConsoleMessage is a set of utility methods for sending messages to user.
+    module ConsoleMessage
       # @api private
-      MessageQueue = Queue.new
+      MESSAGE_QUEUE = Queue.new
 
       # message queue thread
       Thread.new {
-        while msg = MessageQueue.pop
+        while msg = MESSAGE_QUEUE.pop
           puts msg
         end
       }
@@ -20,7 +20,8 @@ module Pione
       # @api private
       @@quiet_mode = false
 
-      # Evaluates the block in debug mode.
+      # Evaluate the block in debug mode.
+      #
       # @yield []
       #   target block
       # @return [void]
@@ -32,7 +33,8 @@ module Pione
       end
       module_function :debug_mode
 
-      # Sets debug mode.
+      # Set debug mode.
+      #
       # @param [bool] mode
       #   flag of debug mode
       # @return [void]
@@ -42,13 +44,15 @@ module Pione
       module_function :"debug_mode="
 
       # Return true if the system is debug mode.
+      #
       # @return [bool]
       def debug_mode?
         @@debug_mode
       end
       module_function :debug_mode?
 
-      # Evaluates the block in quiet mode.
+      # Evaluate the block in quiet mode.
+      #
       # @yield []
       #   target block
       # @return [void]
@@ -58,9 +62,10 @@ module Pione
         yield
         @@quiet_mode = orig
       end
-      module_function :debug_mode
+      module_function :quiet_mode
 
-      # Sets quiet mode.
+      # Set quiet mode.
+      #
       # @param [bool] mode
       #   flag of quiet mode
       # @return [void]
@@ -70,6 +75,7 @@ module Pione
       module_function :"quiet_mode="
 
       # Return true if the system is quiet mode.
+      #
       # @return [bool]
       def quiet_mode?
         @@quiet_mode
@@ -78,12 +84,13 @@ module Pione
 
       # @!group Message Senders
 
-      # Sends the debug message.
-      # @param [String] msg
+      # Send the debug message.
+      #
+      # @param msg [String]
       #   debug message
-      # @param [Integer] level
+      # @param level [Integer]
       #   indent level
-      # @param [String] type
+      # @param type [String]
       #   message heading type
       # @return [void]
       def debug_message(msg, level=0, type="debug")
@@ -93,28 +100,31 @@ module Pione
       end
       module_function :debug_message
 
-      # Sends the debug message to notify that something begins.
-      # @param [String] msg
+      # Send the debug message to notify that something begins.
+      #
+      # @param msg [String]
       #   debug message
       # @return [void]
       def debug_message_begin(msg)
         debug_message(msg, 0, ">>>")
       end
 
-      # Sends the debug message to notify that something ends.
-      # @param [String] msg
+      # Send the debug message to notify that something ends.
+      #
+      # @param msg [String]
       #   debug message
       # @return [void]
       def debug_message_end(msg)
         debug_message(msg, 0, "<<<")
       end
 
-      # Sends the user message.
-      # @param [String] msg
+      # Send the user message.
+      #
+      # @param msg [String]
       #   user message
-      # @param [Integer] level
+      # @param level [Integer]
       #   indent level
-      # @param [String] type
+      # @param type [String]
       #   message heading type
       # @return [void]
       def user_message(msg, level=0, type="info")
@@ -123,15 +133,17 @@ module Pione
         end
       end
 
-      # Sends the user message to notify that something begins.
-      # @param [String] msg
+      # Send the user message to notify that something begins.
+      #
+      # @param msg [String]
       #   user message
       # @return [void]
       def user_message_begin(msg)
         user_message(msg, 0, ">>>")
       end
 
-      # Sends the debug message to notify that something ends.
+      # Send the debug message to notify that something ends.
+      #
       # @param [String] msg
       #   debug message
       # @return [void]
@@ -139,15 +151,31 @@ module Pione
         user_message(msg, 0, "<<<")
       end
 
-      # use this internal debug only
+      # Show the message.
+      #
+      # @param msg [String]
+      #   the message
+      #
+      # @note
+      #   Use this for debugging only.
+      #
       # @api private
       def show(msg)
         message("show", :red, msg)
       end
 
+      # Print the message with the color.
+      #
+      # @param type [String]
+      #   message type("debug", "info", "show", ">>>", "<<<")
+      # @param color [Symbol]
+      #   type color(:red, :green, :magenta)
+      # @param msg [String]
+      #   message content
+      #
       # @api private
       def message(type, color, msg)
-        MessageQueue.push "%s %s" % [Terminal.color(color, "%5s" % type), msg]
+        MESSAGE_QUEUE.push "%s %s" % [Terminal.color(color, "%5s" % type), msg]
       end
       module_function :message
     end

data/lib/pione/version.rb

@@ -1,4 +1,4 @@
 module Pione
   # version of pione
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/pione.gemspec

@@ -26,9 +26,10 @@ Gem::Specification.new do |gem|
   #
 
   # requisite for system
-  gem.add_dependency "parslet", "~> 1.4.0"
+  gem.add_dependency "parslet", "~> 1.5.0"
   gem.add_dependency "uuidtools", "~> 2.1.3"
   gem.add_dependency "highline", "~> 1.6.15"
+  gem.add_dependency "hamster", "~> 0.4"
   gem.add_dependency "naming"
 
   # for dropbox resource

data/test/model/spec_feature-expr.rb

@@ -304,11 +304,26 @@ describe 'Feature::Expr' do
       r.should == Feature::AndExpr.new(requisite)
     end
 
-    testcases.each do |testname, testcase|
+    testcases["unification"].each do |type_name, methods|
+      methods.each do |method_name, cases|
+        cases.each do |case_name, testcase|
+          it "should unify %s expression by %s(%s)" % [type_name, method_name, case_name] do
+            parser = DocumentParser.new.feature_expr
+            expr1 = Transformer.document(parser.parse(testcase["expr1"]))
+            expr2 = Transformer.document(parser.parse(testcase["expr2"]))
+            result = Transformer.document(parser.parse(testcase["result"]))
+            expr1.send(method_name, expr2).should.be.true
+          end
+        end
+      end
+    end
+
+    # sentence test cases
+    testcases["sentence"].each do |testname, testcase|
       it "should get #{testcase["result"]}: #{testname}" do
         parser = DocumentParser.new.feature_expr
-        provide = DocumentTransformer.new.apply(parser.parse(testcase["provide"]))
-        request = DocumentTransformer.new.apply(parser.parse(testcase["request"]))
+        provide = Transformer.document(parser.parse(testcase["provide"]))
+        request = Transformer.document(parser.parse(testcase["request"]))
         Feature::Sentence.new(provide, request).decide.should == testcase["result"]
       end
     end

data/test/model/spec_feature-expr.yml

@@ -1,16 +1,28 @@
-case1:
-  provide: "^X"
-  request: "+X"
-  result: true
-case2:
-  provide: "^X"
-  request: "*"
-  result: true
-case3:
-  provide: "^X"
-  request: "+Y"
-  result: false
-case4:
-  provide: "^X"
-  request: "-X"
-  result: false
+unification:
+  AND:
+    unify_redundant_feature:
+      case1:
+        expr1: "+X & +Y"
+        expr2: "+X"
+        result: "+X & +Y"
+      case2:
+        expr1: "+X & +Y"
+        expr2: "+Y"
+        result: "+X & +Y"
+sentence:
+  case1:
+    provide: "^X"
+    request: "+X"
+    result: true
+  case2:
+    provide: "^X"
+    request: "*"
+    result: true
+  case3:
+    provide: "^X"
+    request: "+Y"
+    result: false
+  case4:
+    provide: "^X"
+    request: "-X"
+    result: false

data/test/model/spec_ticket-expr.rb

@@ -0,0 +1,67 @@
+require_relative '../test-util'
+
+describe 'Model::TicketExpr' do
+  it 'should get empty ticket expression' do
+    TicketExpr.empty.should.empty
+  end
+
+  it 'should equal between same name ticket expressions' do
+    TicketExpr.new(["T"]).should == TicketExpr.new(["T"])
+  end
+
+  it 'should not equal' do
+    TicketExpr.new(["T"]).should.not == TicketExpr.new(["t"])
+  end
+
+  it 'should get names' do
+    TicketExpr.new(["T"]).names.should == Set.new(["T"])
+  end
+
+  it 'should make complex ticket' do
+    (TicketExpr.new(["T1"]) + TicketExpr.new(["T2"])).should == TicketExpr.new(["T1", "T2"])
+  end
+
+  describe 'pione method: ==' do
+    it 'should true' do
+      TicketExpr.new(["T"]).call_pione_method("==", TicketExpr.new(["T"])).should.true
+    end
+
+    it 'should false' do
+      TicketExpr.new(["T"]).call_pione_method("==", TicketExpr.new(["t"])).should.not.true
+    end
+
+    it 'should raise type error' do
+      should.raise(PioneModelTypeError) do
+        TicketExpr.new(["T"]).call_pione_method("==", PioneString.new("T"))
+      end
+    end
+  end
+
+  describe 'pione method: !=' do
+    it 'should true' do
+      TicketExpr.new(["T"]).call_pione_method("!=", TicketExpr.new(["t"])).should.true
+    end
+
+    it 'should false' do
+      TicketExpr.new(["T"]).call_pione_method("!=", TicketExpr.new(["T"])).should.false
+    end
+
+    it 'should raise type error' do
+      should.raise(PioneModelTypeError) do
+        TicketExpr.new(["T"]).call_pione_method("==", PioneString.new("T"))
+      end
+    end
+  end
+
+  describe 'pione method: +' do
+    it 'should make complex ticket expression' do
+      TicketExpr.new(["T1"]).call_pione_method("+", TicketExpr.new(["T2"]))
+        .should == TicketExpr.new(["T1", "T2"])
+    end
+
+    it 'should get itself' do
+      TicketExpr.new(["T"]).call_pione_method("+", TicketExpr.new(["T"]))
+        .should == TicketExpr.new(["T"])
+    end
+  end
+end