rambling-trie 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9db4c20b2cd932bc23376649e312e566eb43e227
-  data.tar.gz: 40e5584acca19930a92cd894e43a51dccca4d1f1
+  metadata.gz: 54be3d6a000a38c0864250d0951a1986b2ceac2c
+  data.tar.gz: 5a8b13f581ce79c239f71e7e96c014572697f0c6
 SHA512:
-  metadata.gz: f0e1a3166c876d3d3730dd439563567fbeb2108b33b908152c1a388daf2edf75cfbc250f67a7c0d00ec3dd923be3e71f770b3d3ff28bbd0ecaeadb3fe3fe162c
-  data.tar.gz: 9f0decef0f2d1dd386677a8631888b4744315ede61b5f5957fd51ebf98b845a4564ea3ada4df60590ffcc8a82a27f5904d7261bd3dc21cf7f422c184932b8781
+  metadata.gz: 62bf472c3abfc664ca22e2df3ba55254d3e03e1d66ab7f3f64bba4755feaf6e4ce92de604ff5c7b479056840734b4e3ca0be4707af447f0521c327d1bbc274e6
+  data.tar.gz: c13d4ce29e89093292268426240cc543026f11a4e0747a33c65bcd7950b156629a39ac61a9a5a78a95320de82d734680a532a043ac78a4c56e0334e746f9bb72

data/Gemfile

@@ -1,13 +1,22 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'coveralls', require: false
-
 group :development do
-  gem 'simplecov', require: false
+  gem 'ruby-prof'
+  gem 'memory_profiler'
+  gem 'benchmark-ips'
+  gem 'flamegraph'
+  gem 'stackprof'
 end
 
 group :test do
+  gem 'simplecov', require: false
+  gem 'codeclimate-test-reporter', require: false
+  gem 'coveralls', require: false
+end
+
+group :local do
   gem 'guard-rspec'
 end

data/README.md

@@ -134,6 +134,7 @@ You can find further API documentation on the autogenerated [rambling-trie gem R
 
 The Rambling Trie has been tested with the following Ruby versions:
 
+* 2.4.x
 * 2.3.x
 * 2.2.x
 * 2.1.x

data/lib/rambling/trie.rb

@@ -1,7 +1,8 @@
 require 'forwardable'
 %w{
-  compression compressor inspector container enumerable invalid_operation
-  plain_text_reader node missing_node compressed_node raw_node version
+  forwardable compression compressor inspector container enumerable
+  invalid_operation plain_text_reader node missing_node compressed_node
+  raw_node version
 }.each do |file|
   require File.join('rambling', 'trie', file)
 end

data/lib/rambling/trie/container.rb

@@ -2,8 +2,7 @@ module Rambling
   module Trie
     # Wrapper on top of Trie data structure.
     class Container
-      extend ::Forwardable
-
+      extend Rambling::Trie::Forwardable
       include ::Enumerable
 
       delegate [
@@ -13,6 +12,7 @@ module Rambling
         :children_tree,
         :compressed?,
         :each,
+        :to_a,
         :has_key?,
         :inspect,
         :letter,
@@ -21,6 +21,10 @@ module Rambling
         :to_s
       ] => :root
 
+      # The root node of this trie.
+      # @return [Node] the root node of this trie.
+      attr_reader :root
+
       # Creates a new Trie.
       # @param [Node] root the root node for the trie
       # @param [Compressor] compressor responsible for compressing the trie
@@ -81,7 +85,7 @@ module Rambling
       private
 
       attr_reader :compressor
-      attr_accessor :root
+      attr_writer :root
 
       def default_root
         Rambling::Trie::RawNode.new

data/lib/rambling/trie/enumerable.rb

@@ -4,6 +4,9 @@ module Rambling
     module Enumerable
       include ::Enumerable
 
+      # Returns number of words contained in the trie. See
+      # {https://ruby-doc.org/core-2.4.0/Enumerable.html#method-i-count
+      # Enumerable}
       alias_method :size, :count
 
       # Iterates over the words contained in the trie.

data/lib/rambling/trie/forwardable.rb

@@ -0,0 +1,16 @@
+module Rambling
+  module Trie
+    # Provides delegation behavior
+    module Forwardable
+      def delegate delegated_methods_to_delegated_to
+        delegated_methods_to_delegated_to.each do |methods, delegated_to|
+          methods.each do |method|
+            define_method method do |*args|
+              send(delegated_to).send method, *args
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rambling/trie/invalid_operation.rb

@@ -2,6 +2,8 @@ module Rambling
   module Trie
     # Raised when trying to execute an invalid operation on a Trie data structure.
     class InvalidOperation < Exception
+      # Creates a new InvalidOperation exception.
+      # @param [String, nil] message the exception message.
       def initialize message = nil
         super
       end

data/lib/rambling/trie/node.rb

@@ -2,7 +2,10 @@ module Rambling
   module Trie
     # A representation of a node in the Trie data structure.
     class Node
-      extend ::Forwardable
+      extend Rambling::Trie::Forwardable
+      include Rambling::Trie::Compression
+      include Rambling::Trie::Enumerable
+      include Rambling::Trie::Inspector
 
       delegate [
         :[],
@@ -11,10 +14,6 @@ module Rambling
         :has_key?
       ] => :children_tree
 
-      include Rambling::Trie::Compression
-      include Rambling::Trie::Enumerable
-      include Rambling::Trie::Inspector
-
       # Letter or letters corresponding to this node.
       # @return [Symbol, nil] the corresponding letter(s) or nil.
       attr_reader :letter

data/lib/rambling/trie/raw_node.rb

@@ -54,15 +54,6 @@ module Rambling
         false
       end
 
-      protected
-
-      def closest_node chars
-        letter = chars.slice!(0).to_sym
-        child = children_tree[letter]
-
-        child ? child.scan(chars) : Rambling::Trie::MissingNode.new
-      end
-
       private
 
       def add_to_children_tree word
@@ -77,6 +68,13 @@ module Rambling
         node.letter = letter
         children_tree[letter] = node
       end
+
+      def closest_node chars
+        letter = chars.slice!(0).to_sym
+        child = children_tree[letter]
+
+        child ? child.scan(chars) : Rambling::Trie::MissingNode.new
+      end
     end
   end
 end

data/lib/rambling/trie/tasks/helpers/performance_report.rb

@@ -0,0 +1,17 @@
+class PerformanceReport
+  attr_reader :output
+
+  def initialize output = $stdout.dup
+    @output = output
+  end
+
+  def start name
+    output.puts
+    output.puts "#{name} for rambling-trie version #{Rambling::Trie::VERSION}"
+    output.puts
+  end
+
+  def finish
+    output.close
+  end
+end

data/lib/rambling/trie/tasks/performance.rb

@@ -3,9 +3,13 @@ require 'benchmark'
 require 'ruby-prof'
 require 'memory_profiler'
 require 'benchmark/ips'
+require 'flamegraph'
 require_relative 'helpers/path'
+require_relative 'helpers/time'
+require_relative 'helpers/performance_report'
 require_relative 'performance/directory'
 require_relative 'performance/benchmark'
+require_relative 'performance/flamegraph'
 require_relative 'performance/profile/call_tree'
 require_relative 'performance/profile/memory'
 require_relative 'performance/all'

data/lib/rambling/trie/tasks/performance/benchmark.rb

@@ -1,20 +1,6 @@
-require_relative '../helpers/path'
-
 namespace :performance do
   include Helpers::Path
 
-  class BenchmarkReport
-    attr_reader :output
-
-    def initialize output
-      @output = output
-    end
-
-    def finish
-      output.close
-    end
-  end
-
   class BenchmarkMeasurement
     def initialize output
       @output = output
@@ -42,10 +28,6 @@ namespace :performance do
       end
     end
 
-    def banner
-      output.puts "\nBenchmark for rambling-trie version #{Rambling::Trie::VERSION}"
-    end
-
     private
 
     attr_reader :output
@@ -64,23 +46,20 @@ namespace :performance do
     end
   end
 
-  def benchmark_report= benchmark_report
-    @benchmark_report = benchmark_report
+  def performance_report= performance_report
+    @performance_report = performance_report
   end
 
-  def benchmark_report
-    Rake::Task['performance:benchmark:output:stdout'].invoke unless @benchmark_report
-
-    @benchmark_report
+  def performance_report
+    @performance_report ||= PerformanceReport.new
   end
 
   def output
-    benchmark_report.output
+    performance_report.output
   end
 
   def generate_lookups_benchmark filename = nil
     measure = BenchmarkMeasurement.new output
-    measure.banner
 
     trie = Rambling::Trie.create dictionary
     compressed_trie = Rambling::Trie.create(dictionary).compress!
@@ -102,7 +81,6 @@ namespace :performance do
 
   def generate_scans_benchmark filename = nil
     measure = BenchmarkMeasurement.new output
-    measure.banner
 
     words = {
       hi: 1_000,
@@ -128,38 +106,37 @@ namespace :performance do
 
   namespace :benchmark do
     namespace :output do
-      desc 'Set task reporting output to stdout'
-      task :stdout do
-        self.benchmark_report = BenchmarkReport.new IO.new(1)
-      end
-
       desc 'Set task reporting output to file'
       task file: ['performance:directory'] do
         path = path 'reports', Rambling::Trie::VERSION, 'benchmark'
         file = File.open path, 'a+'
-        self.benchmark_report = BenchmarkReport.new file
+        self.performance_report = PerformanceReport.new file
       end
 
       desc 'Close output stream'
       task :close do
-        benchmark_report.finish unless benchmark_report.nil?
+        performance_report.finish
       end
     end
 
+    desc 'Output banner'
+    task :banner do
+      performance_report.start 'Benchmark'
+    end
+
     desc 'Generate lookups performance benchmark report'
-    task :lookups do
+    task lookups: :banner do
       generate_lookups_benchmark
     end
 
     desc 'Generate scans performance benchmark report'
-    task :scans do
+    task scans: :banner do
       generate_scans_benchmark
     end
 
     desc 'Generate creation performance benchmark report'
-    task :creation do
+    task creation: :banner do
       measure = BenchmarkMeasurement.new output
-      measure.banner
 
       output.puts '==> Creation'
       output.puts '`Rambling::Trie.create`'
@@ -170,9 +147,8 @@ namespace :performance do
     end
 
     desc 'Generate compression performance benchmark report'
-    task :compression do
+    task compression: :banner do
       measure = BenchmarkMeasurement.new output
-      measure.banner
 
       output.puts '==> Compression'
       output.puts '`compress!`'
@@ -188,22 +164,23 @@ namespace :performance do
 
     desc 'Generate all performance benchmark reports'
     task all: [
-      'creation',
-      'compression',
-      'lookups',
-      'scans',
+      :creation,
+      :compression,
+      :lookups,
+      :scans,
     ]
 
     namespace :all do
       desc "Generate and store performance benchmark report in reports/#{Rambling::Trie::VERSION}"
       task save: [
         'output:file',
-        'all'
+        :all
       ]
     end
 
     desc 'Compare ips for different implementations (changes over time)'
     task :compare do
+      require 'benchmark/ips'
       Benchmark.ips do |b|
         hash = { 'thing' => 'gniht' }
 

data/lib/rambling/trie/tasks/performance/flamegraph.rb

@@ -0,0 +1,119 @@
+namespace :performance do
+  include Helpers::Path
+  include Helpers::Time
+
+  def performance_report
+    @performance_report ||= PerformanceReport.new
+  end
+
+  def output
+    performance_report.output
+  end
+
+  class FlamegraphProfile
+    def initialize filename
+      @filename = filename
+    end
+
+    def perform times, params = nil
+      params = Array params
+      params << nil unless params.any?
+
+      dirname = path 'reports', Rambling::Trie::VERSION, 'flamegraph', time
+      FileUtils.mkdir_p dirname
+      path = File.join dirname, "#{filename}.html"
+
+      result = Flamegraph.generate path do
+        params.each do |param|
+          times.times do
+            yield param
+          end
+        end
+      end
+    end
+
+    private
+
+    attr_reader :filename
+  end
+
+  namespace :flamegraph do
+    desc 'Output banner'
+    task :banner do
+      performance_report.start 'Flamegraph'
+    end
+
+    desc 'Generate flamegraph reports for creation'
+    task creation: ['performance:directory', :banner] do
+      output.puts 'Generating flamegraph reports for creation...'
+
+      flamegraph = FlamegraphProfile.new 'new-trie'
+      flamegraph.perform 1 do
+        trie = Rambling::Trie.create dictionary
+      end
+    end
+
+    desc 'Generate flamegraph reports for compression'
+    task compression: ['performance:directory', :banner] do
+      output.puts 'Generating flamegraph reports for compression...'
+
+      tries = [ Rambling::Trie.create(dictionary) ]
+
+      flamegraph = FlamegraphProfile.new 'compressed-trie'
+      flamegraph.perform 1, tries do |trie|
+        trie.compress!
+        nil
+      end
+    end
+
+    desc 'Generate flamegraph reports for lookups'
+    task lookups: ['performance:directory', :banner] do
+      output.puts 'Generating flamegraph reports for lookups...'
+
+      words = %w(hi help beautiful impressionism anthropological)
+
+      trie = Rambling::Trie.create dictionary
+      compressed_trie = Rambling::Trie.create(dictionary).compress!
+
+      [ trie, compressed_trie ].each do |trie|
+        prefix = "#{trie.compressed? ? 'compressed' : 'uncompressed'}-trie"
+
+        flamegraph = FlamegraphProfile.new "#{prefix}-word"
+        flamegraph.perform 1, words do |word|
+          trie.word? word
+        end
+
+        flamegraph = FlamegraphProfile.new "#{prefix}-partial-word"
+        flamegraph.perform 1, words do |word|
+          trie.partial_word? word
+        end
+      end
+    end
+
+    desc 'Generate flamegraph reports for scans'
+    task scans: ['performance:directory', :banner] do
+      output.puts 'Generating flamegraph reports for scans...'
+
+      words = %w(hi help beautiful impressionism anthropological)
+
+      trie = Rambling::Trie.create dictionary
+      compressed_trie = Rambling::Trie.create(dictionary).compress!
+
+      [ trie, compressed_trie ].each do |trie|
+        prefix = "#{trie.compressed? ? 'compressed' : 'uncompressed'}-trie"
+        flamegraph = FlamegraphProfile.new "#{prefix}-scan"
+        flamegraph.perform 1, words do |word|
+          trie.scan(word).size
+        end
+      end
+    end
+
+    desc 'Generate all flamegraph reports'
+    task all: [
+      :creation,
+      :compression,
+      :lookups,
+      :scans,
+    ]
+  end
+end