rambling-trie 0.9.2 → 0.9.3

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

@@ -1,31 +1,46 @@
-require_relative '../../helpers/path'
-require_relative '../../helpers/time'
-
 namespace :performance do
   namespace :profile do
     include Helpers::Path
     include Helpers::Time
 
-    def profile times, params, path
-      params = Array params
-      params << nil unless params.any?
+    def performance_report
+      @performance_report ||= PerformanceReport.new
+    end
+
+    def output
+      performance_report.output
+    end
+
+    class CallTreeProfile
+      def initialize dirname
+        @dirname = dirname
+      end
+
+      def perform times, params = nil
+        params = Array params
+        params << nil unless params.any?
 
-      result = RubyProf.profile merge_fibers: true do
-        params.each do |param|
-          times.times do
-            yield param
+        result = RubyProf.profile merge_fibers: true do
+          params.each do |param|
+            times.times do
+              yield param
+            end
           end
         end
+
+        path = path 'reports', Rambling::Trie::VERSION, 'call-tree', time, dirname
+        FileUtils.mkdir_p path
+        printer = RubyProf::CallTreePrinter.new result
+        printer.print path: path
       end
 
-      printer = RubyProf::CallTreePrinter.new result
-      printer.print path: path
+      private
+
+      attr_reader :dirname
     end
 
     def generate_lookups_call_tree
-      puts 'Generating call tree profiling reports for lookups...'
-
-      puts "\nCall Tree profile for rambling-trie version #{Rambling::Trie::VERSION}"
+      output.puts 'Generating call tree profiling reports for lookups...'
 
       words = %w(hi help beautiful impressionism anthropological)
 
@@ -33,30 +48,24 @@ namespace :performance do
       compressed_trie = Rambling::Trie.create(dictionary).compress!
 
       [ trie, compressed_trie ].each do |trie|
-        filename = "profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-word"
-        path = path 'reports', Rambling::Trie::VERSION, 'call-tree', time, filename
-        FileUtils.mkdir_p path
+        prefix = "profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}"
 
-        profile 200_000, words, path do
+        call_tree_profile = CallTreeProfile.new "#{prefix}-word"
+        call_tree_profile.perform 200_000, words do
           trie.word? word
         end
 
-        filename = "profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-partial-word"
-        path = path 'reports', Rambling::Trie::VERSION, 'call-tree', time, filename
-        FileUtils.mkdir_p path
-
-        profile 200_000, words, path do
+        call_tree_profile = CallTreeProfile.new "#{prefix}-partial-word"
+        call_tree_profile.perform 200_000, words do
           trie.partial_word? word
         end
       end
 
-      puts 'Done'
+      output.puts 'Done'
     end
 
     def generate_scans_call_tree
-      puts 'Generating call tree profiling reports for scans...'
-
-      puts "\nCall Tree profile for rambling-trie version #{Rambling::Trie::VERSION}"
+      output.puts 'Generating call tree profiling reports for scans...'
 
       words = {
         hi: 1_000,
@@ -70,68 +79,68 @@ namespace :performance do
       compressed_trie = Rambling::Trie.create(dictionary).compress!
 
       [ trie, compressed_trie ].each do |trie|
-        filename = "profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-scan"
-        path = path 'reports', Rambling::Trie::VERSION, 'call-tree', time, filename
-        FileUtils.mkdir_p path
+        dirname = "profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-scan"
+        call_tree_profile = CallTreeProfile.new dirname
 
         words.each do |word, times|
-          profile times, word.to_s, path do |word|
+          call_tree_profile.perform times, word.to_s do |word|
             trie.scan(word).size
           end
         end
       end
 
-      puts 'Done'
+      output.puts 'Done'
     end
 
     namespace :call_tree do
+      desc 'Output banner'
+      task :banner do
+        performance_report.start 'Call Tree profile'
+      end
+
       desc 'Generate call tree profiling reports for creation'
-      task creation: ['performance:directory'] do
-        puts 'Generating call tree profiling reports for creation...'
-        puts "\nCall Tree profile for rambling-trie version #{Rambling::Trie::VERSION}"
-        filename = "profile-new-trie"
-        path = path 'reports', Rambling::Trie::VERSION, 'call-tree', time, filename
-        FileUtils.mkdir_p path
+      task creation: ['performance:directory', :banner] do
+        output.puts 'Generating call tree profiling reports for creation...'
 
-        profile 5, nil, path do
+        call_tree_profile = CallTreeProfile.new 'profile-new-trie'
+        call_tree_profile.perform 5 do
           trie = Rambling::Trie.create dictionary
         end
+
+        output.puts 'Done'
       end
 
       desc 'Generate call tree profiling reports for compression'
-      task compression: ['performance:directory'] do
-        puts 'Generating call tree profiling reports for compression...'
-        puts "\nCall Tree profile for rambling-trie version #{Rambling::Trie::VERSION}"
-
-        filename = "profile-compressed-trie"
-        path = path 'reports', Rambling::Trie::VERSION, 'call-tree', time, filename
-        FileUtils.mkdir_p path
+      task compression: ['performance:directory', :banner] do
+        output.puts 'Generating call tree profiling reports for compression...'
 
         tries = []
         5.times { tries << Rambling::Trie.create(dictionary) }
 
-        profile 5, tries, path do |trie|
-          trie.compress!
-          nil
+        call_tree_profile = CallTreeProfile.new 'profile-compressed-trie'
+        call_tree_profile.perform 5, tries do |trie|
+          trie.compress!; nil
         end
+
+        output.puts 'Done'
       end
 
       desc 'Generate call tree profiling reports for lookups'
-      task lookups: ['performance:directory'] do
+      task lookups: ['performance:directory', :banner] do
         generate_lookups_call_tree
       end
 
       desc 'Generate call tree profiling reports for scans'
-      task scans: ['performance:directory'] do
+      task scans: ['performance:directory', :banner] do
         generate_scans_call_tree
       end
 
       desc 'Generate all call tree profiling reports'
       task all: [
-        'creation',
-        'compression',
-        'lookups',
-        'scans',
+        :creation,
+        :compression,
+        :lookups,
+        :scans,
       ]
     end
   end

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

@@ -1,55 +1,79 @@
-require_relative '../../helpers/path'
-require_relative '../../helpers/time'
-
 namespace :performance do
   namespace :profile do
     include Helpers::Path
     include Helpers::Time
 
-    def with_gc_stats
-      puts "Live objects before - #{GC.stat[:heap_live_slots]}"
-      yield
-      puts "Live objects after  - #{GC.stat[:heap_live_slots]}"
+    def performance_report
+      @performance_report ||= PerformanceReport.new
+    end
+
+    def output
+      performance_report.output
     end
 
-    def memory_profile name
-      puts
-      puts name
+    class MemoryProfile
+      def initialize name
+        @name = name
+      end
 
-      result = MemoryProfiler.report allow_files: 'lib/rambling/trie', ignore_files: 'lib/rambling/trie/tasks' do
-        yield
+      def perform
+        result = MemoryProfiler.report allow_files: 'lib/rambling/trie', ignore_files: 'lib/rambling/trie/tasks' do
+          with_gc_stats do
+            yield
+          end
+        end
+
+        dir = path 'reports', Rambling::Trie::VERSION, 'memory', time
+        FileUtils.mkdir_p dir
+        result.pretty_print to_file: File.join(dir, name)
       end
 
-      dir = path 'reports', Rambling::Trie::VERSION, 'memory', time
-      FileUtils.mkdir_p dir
-      result.pretty_print to_file: File.join(dir, name)
+      private
+
+      attr_reader :name
+    end
+
+    def with_gc_stats
+      output.puts "Live objects before - #{GC.stat[:heap_live_slots]}"
+      yield
+      output.puts "Live objects after  - #{GC.stat[:heap_live_slots]}"
     end
 
     namespace :memory do
+      desc 'Output banner'
+      task :banner do
+        performance_report.start 'Memory profile'
+      end
+
       desc 'Generate memory profiling reports for creation'
-      task creation: ['performance:directory'] do
-        puts 'Generating memory profiling reports for creation...'
+      task creation: ['performance:directory', :banner] do
+        output.puts 'Generating memory profiling reports for creation...'
 
         trie = nil
 
-        memory_profile "memory-profile-new-trie" do
-          with_gc_stats { trie = Rambling::Trie.create dictionary }
+        memory_profile = MemoryProfile.new 'memory-profile-new-trie'
+        memory_profile.perform do
+          trie = Rambling::Trie.create dictionary
         end
       end
 
       desc 'Generate memory profiling reports for compression'
-      task compression: ['performance:directory'] do
+      task compression: ['performance:directory', :banner] do
+        output.puts 'Generating memory profiling reports for compression...'
         trie = Rambling::Trie.create dictionary
 
-        memory_profile "memory-profile-trie-and-compress" do
-          with_gc_stats { trie.compress! }
+        memory_profile = MemoryProfile.new 'memory-profile-trie-and-compress'
+        memory_profile.perform do
+          trie.compress!
         end
 
         with_gc_stats { GC.start }
       end
 
       desc 'Generate memory profiling reports for lookups'
-      task lookups: ['performance:directory'] do
+      task lookups: ['performance:directory', :banner] do
+        output.puts 'Generating memory profiling reports for lookups...'
+
         words = %w(hi help beautiful impressionism anthropological)
 
         trie = Rambling::Trie.create dictionary
@@ -57,24 +81,23 @@ namespace :performance do
         [ trie, compressed_trie ].each do |trie|
           times = 10
 
-          name = "memory-profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-trie-word"
-          memory_profile name do
-            with_gc_stats do
-              words.each do |word|
-                times.times do
-                  trie.word? word
-                end
+          prefix = "memory-profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-trie"
+          name = "#{prefix}-word"
+          memory_profile = MemoryProfile.new name
+          memory_profile.perform do
+            words.each do |word|
+              times.times do
+                trie.word? word
               end
             end
           end
 
-          name = "memory-profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-trie-partial-word"
-          memory_profile name do
-            with_gc_stats do
-              words.each do |word|
-                times.times do
-                  trie.partial_word? word
-                end
+          name = "#{prefix}-partial-word"
+          memory_profile = MemoryProfile.new name
+          memory_profile.perform do
+            words.each do |word|
+              times.times do
+                trie.partial_word? word
               end
             end
           end
@@ -82,7 +105,9 @@ namespace :performance do
       end
 
       desc 'Generate memory profiling reports for scans'
-      task scans: ['performance:directory'] do
+      task scans: ['performance:directory', :banner] do
+        output.puts 'Generating memory profiling reports for scans...'
+
         words = {
           hi: 1,
           help: 100,
@@ -95,7 +120,8 @@ namespace :performance do
         compressed_trie = Rambling::Trie.create(dictionary).compress!
         [ trie, compressed_trie ].each do |trie|
           name = "memory-profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-trie-scan"
-          memory_profile name do
+          memory_profile = MemoryProfile.new name
+          memory_profile.perform do
             words.each do |word, times|
               times.times do
                 trie.scan(word.to_s).size
@@ -107,10 +133,10 @@ namespace :performance do
 
       desc 'Generate all memory profiling reports'
       task all: [
-        'creation',
-        'compression',
-        'lookups',
-        'scans',
+        :creation,
+        :compression,
+        :lookups,
+        :scans,
       ]
     end
   end

data/lib/rambling/trie/version.rb

@@ -1,6 +1,6 @@
 module Rambling
   module Trie
     # Current version of the rambling-trie.
-    VERSION = '0.9.2'
+    VERSION = '0.9.3'
   end
 end

data/rambling-trie.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.date = Time.now.strftime '%Y-%m-%d'
 
   gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename f }
-  gem.files = `git ls-files`.split "\n"
+  gem.files = `git ls-files -- {lib,*file,*.gemspec,LICENSE*,README*}`.split "\n"
   gem.test_files = `git ls-files -- {test,spec,features}/*`.split "\n"
   gem.require_paths = ['lib']
 
@@ -22,9 +22,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rspec', '~> 3.5'
   gem.add_development_dependency 'rake', '~> 12.0'
-  gem.add_development_dependency 'ruby-prof', '~> 0.16.2'
-  gem.add_development_dependency 'memory_profiler', '~> 0.9.7'
-  gem.add_development_dependency 'benchmark-ips', '~> 2.7.2'
   gem.add_development_dependency 'yard', '~> 0.9.5'
-  gem.add_development_dependency 'redcarpet', '~> 3.3.4'
 end

data/spec/assets/test_words.es_DO.txt

@@ -0,0 +1,23 @@
+claro
+donde
+dónde
+eres
+es
+eso
+falso
+hermoso
+hola
+hoy
+mi
+mío
+no
+nuestro
+ola
+quien
+quién
+si
+tu
+tus
+tuyos
+verdad
+verdadero

data/spec/integration/rambling/trie_spec.rb

@@ -53,20 +53,28 @@ describe Rambling::Trie do
   describe 'with words provided directly' do
     it_behaves_like 'a compressable trie' do
       let(:words) { %w[a couple of words for our full trie integration test] }
-      let(:trie) { Rambling::Trie.create }
-
-      before do
-        words.each do |word|
-          trie << word
-          trie.add word
-        end
-      end
+      let(:trie) { Rambling::Trie.create { |t| words.each { |w| t << w } } }
     end
   end
 
   describe 'with words from a file' do
     it_behaves_like 'a compressable trie' do
-      let(:filepath) { File.join ::SPEC_ROOT, 'assets', 'test_words.txt' }
+      let(:filepath) { File.join ::SPEC_ROOT, 'assets', 'test_words.en_US.txt' }
+      let(:words) { File.readlines(filepath).map &:chomp! }
+      let(:trie) { Rambling::Trie.create filepath }
+    end
+  end
+
+  describe 'with words with unicode characters' do
+    it_behaves_like 'a compressable trie' do
+      let(:words) { %w[poquísimas palabras para nuestra prueba de integración completa] }
+      let(:trie) { Rambling::Trie.create { |t| words.each { |w| t << w } } }
+    end
+  end
+
+  describe 'with words with unicode characters from a file' do
+    it_behaves_like 'a compressable trie' do
+      let(:filepath) { File.join ::SPEC_ROOT, 'assets', 'test_words.en_US.txt' }
       let(:words) { File.readlines(filepath).map &:chomp! }
       let(:trie) { Rambling::Trie.create filepath }
     end