drgdsl 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9715079e711fd5f608888b4b6433221db58145b85d58562e5419170496201c1
-  data.tar.gz: 7c83b0126a22e86431e5d8ededa65b75cb982d8fdd8b1dd2db726308c94e5b25
+  metadata.gz: 346dd382500a954f17d93e1d1385e6cb8af10b02059298776973f0af8389686d
+  data.tar.gz: 3add8eaaa026e2bd054c230933be1e546592da9c919b67155e35165025a89e5a
 SHA512:
-  metadata.gz: 8051b841182ad48e4e13f57bd06bfe999f694321c1abd3c88d16065a6149d0c80d357d6a6e75fd0d56f96356bc16fabaf85f321da6a7deb66d7510e8cb8695a9
-  data.tar.gz: af4454d07118b2966da5074332d7549fda5b9ffc3fafae56dd151f86d40342ae23be3d089967d68e0ddcf6d8c6a7c1d388fba19b6aa61718d72ad9d1dc9f4b29
+  metadata.gz: f7fda718baaaa0077ed81705b6178a11b8ba8d170b19d53aa7b4fc61d1ed86f18514ec153422b9406d4b429b5d53f467fb91e92dec3e4289d2ded36f1b6eae5f
+  data.tar.gz: '00138b8f522e3c277163a86724a011e92e83845aae9a9fd6fdf67921b7f0bc7dde2030de8f78ed80bf4756dd2765a109057e1a41e724e8333fe907dd2394ec31'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    drgdsl (1.1.0)
+    drgdsl (1.2.0)
       oj (~> 3.5.0)
       parslet (~> 1.8.2)
 

data/bin/cache

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "drgdsl"
+require 'benchmark'
+
+string_printer = DrgDSL::PrettyPrinter.new(output_format: :string)
+html_printer = DrgDSL::PrettyPrinter.new(output_format: :html)
+bash_printer = DrgDSL::PrettyPrinter.new(output_format: :bash)
+
+asts = File.read('./test/expressions.txt', encoding: 'utf-8')
+           .split("\n\n")
+           .map { |exp| DrgDSL.parse(exp) }
+
+N = 2
+
+puts "Pretty printing #{N} * #{asts.count} ASTs:"
+
+t1 = Benchmark.realtime do
+  N.times do
+    asts.each do |ast|
+      ast.accept(string_printer)
+      ast.accept(html_printer)
+      ast.accept(bash_printer)
+    end
+  end
+end
+puts "PrettyPrinter while building up cache:    \t#{t1}"
+
+t2 = Benchmark.realtime do
+  N.times do
+    asts.each do |ast|
+      ast.accept(string_printer)
+      ast.accept(html_printer)
+      ast.accept(bash_printer)
+    end
+  end
+end
+puts "PrettyPrinter with cache hits only:        \t#{t2}"
+
+[string_printer, html_printer, bash_printer].each do |printer|
+  class << printer
+    def cache?
+      false
+    end
+  end
+end
+
+t3 = Benchmark.realtime do
+  N.times do
+    asts.each do |ast|
+      ast.accept(string_printer)
+      ast.accept(html_printer)
+      ast.accept(bash_printer)
+    end
+  end
+end
+puts "PrettyPrinter with caching disabled:    \t#{t3}"
+
+puts "Speed increase when enabling caching:    \t#{(100 / t3 * (t3 - t1)).round(2)}%"
+puts "Speed increase when cache fully built up:    \t#{(100 / t3 * (t3 - t2)).round(2)}%"

data/bin/html

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 # Generates highlighted html snippets for a bunch of expressions for
 # visualization purposes.
 

data/lib/drgdsl/ast.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 module DrgDSL
 
   # Nodes in DRG logic AST.
   #
   # @see AstBuilder
   module Ast
+    def self.node_classes
+      Node.node_classes
+    end
+
     module Node
       class << self
         def node_classes
@@ -46,6 +52,19 @@ module DrgDSL
         raise NotImplementedError
       end
 
+      # @return [Integer] object hash for this AST node. Node instances for the
+      #   same expression should always return the same hash code. This is
+      #   useful for optimizations.
+      def hash
+        raise NotImplementedError
+      end
+
+      def ==(other)
+        type == other.type && hash == other.hash
+      end
+
+      alias eql? ==
+
       def pretty_print(**pretty_printer_options)
         accept PrettyPrinter.new(**pretty_printer_options)
       end
@@ -79,6 +98,10 @@ module DrgDSL
       def to_hash
         { or: [expressions.map(&:to_hash)] }
       end
+
+      def hash
+        @hash ||= [type, *expressions].hash
+      end
     end
 
     # Represents a list of expressions joined with an "AND",
@@ -93,7 +116,11 @@ module DrgDSL
       end
 
       def to_hash
-        { and: [ expressions.map(&:to_hash) ] }
+        { and: [expressions.map(&:to_hash)] }
+      end
+
+      def hash
+        @hash ||= [type, *expressions].hash
       end
     end
 
@@ -110,6 +137,10 @@ module DrgDSL
       def to_hash
         { paren: expression.to_hash }
       end
+
+      def hash
+        @hash ||= [type, expression].hash
+      end
     end
 
     # A NotExpression is a logic text of the form
@@ -126,6 +157,10 @@ module DrgDSL
       def to_hash
         { not: expression.to_hash }
       end
+
+      def hash
+        @hash ||= [type, expression].hash
+      end
     end
 
     # "Komplizierende_Prozeduren", "Dialyse", ...
@@ -141,6 +176,10 @@ module DrgDSL
       def to_hash
         { function_call: name }
       end
+
+      def hash
+        @hash ||= [type, name].hash
+      end
     end
 
     # A drg link originates from the grammar rule basic_or_drg_link
@@ -160,6 +199,10 @@ module DrgDSL
       def to_hash
         { drg_link: { var: variable.to_hash, name: name } }
       end
+
+      def hash
+        @hash ||= [type, name, variable].hash
+      end
     end
 
     # A BasicExpression consists of a variable and a condition
@@ -187,9 +230,14 @@ module DrgDSL
       def to_hash
         { basic: { var: variable.to_hash, condition: condition.to_hash } }
       end
+
+      def hash
+        @hash ||= [type, variable, condition].hash
+      end
     end
 
-    # A comparison is either from a table_condition, a condition or a date_expression
+    # A comparison is either from a table_condition, a condition or a
+    # date_expression
     class Comparison
       include Node
 
@@ -210,6 +258,10 @@ module DrgDSL
           }
         }
       end
+
+      def hash
+        @hash ||= [type, op, value, table_condition].hash
+      end
     end
 
     # Has a certain operator (i.e. not / different) and a condition
@@ -227,13 +279,17 @@ module DrgDSL
       end
 
       def to_hash
-        { 
+        {
           unary_condition: {
             op: op,
             condition: condition.to_hash
           }
         }
       end
+
+      def hash
+        @hash ||= [type, op, condition].hash
+      end
     end
 
     class Empty
@@ -242,15 +298,21 @@ module DrgDSL
       def to_hash
         { empty: nil }
       end
+
+      def hash
+        @hash ||= type.hash
+      end
     end
 
-    # There are 3 variants of table conditions (in_table, in_tables, all_in_table)
-    # A table condition can have an optional comparison.
-    # Tables refers to the table names (the internal names)
+    # There are 3 variants of table conditions (in_table, in_tables,
+    # all_in_table)
+    #
+    # A table condition can have an optional comparison. Tables refers to the
+    # table names (the internal names)
     class TableCondition
-      IN_TABLE     = 'in table'.freeze
-      IN_TABLES    = 'in tables'.freeze
-      ALL_IN_TABLE = 'all in table'.freeze
+      IN_TABLE     = 'in table'
+      IN_TABLES    = 'in tables'
+      ALL_IN_TABLE = 'all in table'
 
       include Node
 
@@ -273,6 +335,10 @@ module DrgDSL
           }
         }
       end
+
+      def hash
+        @hash ||= [type, op, *tables, comparison].hash
+      end
     end
 
     # INFO: srg (prozedur) l (links) r (rechts) b(beidseitig)
@@ -294,17 +360,21 @@ module DrgDSL
           }
         }
       end
+
+      def hash
+        @hash ||= [type, variable, condition].hash
+      end
     end
 
     class DateExpression
       include Node
 
       attr_reader :left_variable,
-        :right_variable,
-        :left_condition,
-        :right_condition,
-        :comparison,
-        :opd
+                  :right_variable,
+                  :left_condition,
+                  :right_condition,
+                  :comparison,
+                  :opd
 
       # @param opd [String] E.g. "opd4" => "mind. 4 erfüllen" query
       def initialize(left_variable:,
@@ -312,8 +382,7 @@ module DrgDSL
                      left_condition:,
                      right_condition: nil,
                      comparison:,
-                     opd:
-                    )
+                     opd:)
 
         @left_variable = left_variable
         @right_variable = right_variable
@@ -335,6 +404,18 @@ module DrgDSL
           }
         }
       end
+
+      def hash
+        @hash ||= [
+          type,
+          left_variable,
+          right_variable,
+          left_condition,
+          right_condition,
+          comparison,
+          opd
+        ].hash
+      end
     end
 
     # "PDX", "AGEYEARS", ...
@@ -350,6 +431,10 @@ module DrgDSL
       def to_hash
         { name: name }
       end
+
+      def hash
+        @hash ||= [type, name].hash
+      end
     end
 
     # "3", "'MDC'", ...
@@ -369,6 +454,10 @@ module DrgDSL
       def to_hash
         { constant: { value: value } }
       end
+
+      def hash
+        @hash ||= [type, value].hash
+      end
     end
   end
 end

data/lib/drgdsl/parser.rb

@@ -171,7 +171,7 @@ module DrgDSL
 
     #   condition
     #     ::= comparison
-    #       | unary_operator
+    #       | unary_condition
     #       | empty
     #       | table_condition
     rule(:condition) do

data/lib/drgdsl/pretty_printer.rb

@@ -52,6 +52,20 @@ module DrgDSL
       ''
     end
 
+    def cache?
+      true
+    end
+
+    def cache_key(n)
+      [
+        n.hash,
+        @indentation_level,
+        @indentation_string,
+        @output_format,
+        @multiline
+      ].hash
+    end
+
     private
 
     def visit_Expression(n)

data/lib/drgdsl/version.rb

@@ -1,3 +1,3 @@
 module DrgDSL
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/drgdsl/visitor.rb

@@ -1,9 +1,52 @@
 # frozen_string_literal: true
 
 module DrgDSL
+
   # Mixin for Ast::Node visitors. Visits all child nodes and returns the
   # visited node by default.
   module Visitor
+    def self.included(visitor)
+      visitor.prepend Cache
+      visitor.extend ClassMethods
+    end
+
+    module Cache
+      # @param n [Ast::Node]
+      def visit(n)
+        return super(n) unless cache?
+        self.class.cache[cache_key(n)] ||= super(n)
+      end
+    end
+
+    module ClassMethods
+      # @return [Hash] in-memory Ruby Hash
+      def cache
+        @cache ||= {}
+      end
+
+      def clear_cache!
+        @cache = {}
+      end
+    end
+
+    # Whether this visitor should cache visit results. Note that one might need
+    # to override #cache_key(n) if a visit is not deterministic, e.g. when it
+    # depends on some instance variables.
+    #
+    # @see PrettyPrinter#cache_key
+    #
+    # @return [Boolean]
+    def cache?
+      false
+    end
+
+    # @param n [Ast::Node]
+    # @return [Integer] ideally an object hash
+    def cache_key(n)
+      n.hash
+    end
+
+    # @param n [Ast::Node]
     def visit(n)
       return visit_nil if n.nil?
       send("visit_#{n.type}", n)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drgdsl
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - SwissDRG AG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -138,6 +138,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cache
 - bin/console
 - bin/html
 - bin/setup