rambling-trie 0.9.3 → 1.0.0

data/lib/rambling/trie/inspector.rb

@@ -1,11 +0,0 @@
-module Rambling
-  module Trie
-    # Provides pretty printing behavior for the Trie data structure.
-    module Inspector
-      # @return [String] a string representation of the current node.
-      def inspect
-        "#<#{self.class.name} letter: #{letter.inspect || 'nil'}, children: #{children_tree.keys}>"
-      end
-    end
-  end
-end

data/lib/rambling/trie/plain_text_reader.rb

@@ -1,23 +0,0 @@
-module Rambling
-  module Trie
-    # File reader for .txt files
-    class PlainTextReader
-      # Yields each word read from a .txt file
-      # @param [String] filepath the full path of the file to load the words from.
-      # @yield [String] Each line read from the file.
-      def each_word filepath
-        each_line(filepath) { |line| yield line.chomp! }
-      end
-
-      private
-
-      def each_line filepath
-        open(filepath) { |file| file.each_line { |line| yield line } }
-      end
-
-      def open filepath
-        File.open(filepath) { |file| yield file }
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-namespace :gem do
-  desc 'Build the rambling-trie gem'
-  task :build do
-    system 'gem build rambling-trie.gemspec'
-  end
-
-  desc 'Push the latest version of the rambling-trie gem'
-  task release: :build do
-    system "gem push rambling-trie-#{Rambling::Trie::VERSION}.gem"
-  end
-
-  desc 'Output the current rambling-trie version'
-  task :version do
-    puts "rambling-trie #{Rambling::Trie::VERSION}"
-  end
-end
-

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

@@ -1,17 +0,0 @@
-module Helpers
-  module Path
-    def path *filename
-      Pathname.new(full_path *filename).cleanpath
-    end
-
-    def dictionary
-      path 'assets', 'dictionaries', 'words_with_friends.txt'
-    end
-
-    private
-
-    def full_path *filename
-      full_path = File.join File.dirname(__FILE__), '..', '..', '..', '..', '..', *filename
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-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/helpers/time.rb

@@ -1,7 +0,0 @@
-module Helpers
-  module Time
-    def time
-      @time ||= ::Time.now.strftime '%Y-%m-%d %H.%M.%S.%L'
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-require 'fileutils'
-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/all.rb

@@ -1,17 +0,0 @@
-namespace :performance do
-  desc 'Generate all profiling and performance reports'
-  task all: [
-    'benchmark:all',
-    'profile:call_tree:all',
-    'profile:memory:all',
-  ]
-
-  namespace :all do
-    desc 'Generate and store all profiling and performance reports'
-    task save: [
-      'benchmark:all:save',
-      'profile:call_tree:all',
-      'profile:memory:all',
-    ]
-  end
-end

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

@@ -1,201 +0,0 @@
-namespace :performance do
-  include Helpers::Path
-
-  class BenchmarkMeasurement
-    def initialize output
-      @output = output
-    end
-
-    def param_to_s param
-      case param
-      when Rambling::Trie::Container
-        ''
-      else
-        param.to_s
-      end
-    end
-
-    def perform times, params = nil
-      params = Array params
-      params << nil unless params.any?
-
-      params.each do |param|
-        output.print param_to_s(param).ljust 20
-
-        measure times, param do |param|
-          yield param
-        end
-      end
-    end
-
-    private
-
-    attr_reader :output
-
-    def measure times, param = nil
-      result = nil
-
-      measure = Benchmark.measure do
-        times.times do
-          result = yield param
-        end
-      end
-
-      output.print "#{result}".ljust 10
-      output.puts measure
-    end
-  end
-
-  def performance_report= performance_report
-    @performance_report = performance_report
-  end
-
-  def performance_report
-    @performance_report ||= PerformanceReport.new
-  end
-
-  def output
-    performance_report.output
-  end
-
-  def generate_lookups_benchmark filename = nil
-    measure = BenchmarkMeasurement.new output
-
-    trie = Rambling::Trie.create dictionary
-    compressed_trie = Rambling::Trie.create(dictionary).compress!
-    [ trie, compressed_trie ].each do |trie|
-      output.puts "==> #{trie.compressed? ? 'Compressed' : 'Uncompressed'}"
-      words = %w(hi help beautiful impressionism anthropological)
-
-      output.puts '`word?`'
-      measure.perform 200_000, words do |word|
-        trie.word? word
-      end
-
-      output.puts '`partial_word?`'
-      measure.perform 200_000, words do |word|
-        trie.partial_word? word
-      end
-    end
-  end
-
-  def generate_scans_benchmark filename = nil
-    measure = BenchmarkMeasurement.new output
-
-    words = {
-      hi: 1_000,
-      help: 100_000,
-      beautiful: 100_000,
-      impressionism: 200_000,
-      anthropological: 200_000,
-    }
-
-    trie = Rambling::Trie.create dictionary
-    compressed_trie = Rambling::Trie.create(dictionary).compress!
-
-    [ trie, compressed_trie ].each do |trie|
-      output.puts "==> #{trie.compressed? ? 'Compressed' : 'Uncompressed'}"
-      output.puts "`scan`"
-      words.each do |word, times|
-        measure.perform times, word.to_s do |word|
-          trie.scan(word).size
-        end
-      end
-    end
-  end
-
-  namespace :benchmark do
-    namespace :output do
-      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.performance_report = PerformanceReport.new file
-      end
-
-      desc 'Close output stream'
-      task :close do
-        performance_report.finish
-      end
-    end
-
-    desc 'Output banner'
-    task :banner do
-      performance_report.start 'Benchmark'
-    end
-
-    desc 'Generate lookups performance benchmark report'
-    task lookups: :banner do
-      generate_lookups_benchmark
-    end
-
-    desc 'Generate scans performance benchmark report'
-    task scans: :banner do
-      generate_scans_benchmark
-    end
-
-    desc 'Generate creation performance benchmark report'
-    task creation: :banner do
-      measure = BenchmarkMeasurement.new output
-
-      output.puts '==> Creation'
-      output.puts '`Rambling::Trie.create`'
-      measure.perform 5 do
-        trie = Rambling::Trie.create dictionary
-        nil
-      end
-    end
-
-    desc 'Generate compression performance benchmark report'
-    task compression: :banner do
-      measure = BenchmarkMeasurement.new output
-
-      output.puts '==> Compression'
-      output.puts '`compress!`'
-
-      tries = []
-      5.times { tries << Rambling::Trie.create(dictionary) }
-
-      measure.perform 5, tries do |trie|
-        trie.compress!
-        nil
-      end
-    end
-
-    desc 'Generate all performance benchmark reports'
-    task all: [
-      :creation,
-      :compression,
-      :lookups,
-      :scans,
-    ]
-
-    namespace :all do
-      desc "Generate and store performance benchmark report in reports/#{Rambling::Trie::VERSION}"
-      task save: [
-        'output:file',
-        :all
-      ]
-    end
-
-    desc 'Compare ips for different implementations (changes over time)'
-    task :compare do
-      require 'benchmark/ips'
-      Benchmark.ips do |b|
-        hash = { 'thing' => 'gniht' }
-
-        b.report 'has_key?' do
-          hash.has_key? 'thing'
-        end
-
-        b.report '[]' do
-          !!hash['thing']
-        end
-      end
-    end
-  end
-end
-
-current_tasks =  Rake.application.top_level_tasks
-current_tasks << 'performance:benchmark:output:close'
-Rake.application.instance_variable_set :@top_level_tasks, current_tasks

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

@@ -1,11 +0,0 @@
-require 'fileutils'
-require_relative '../helpers/path'
-
-namespace :performance do
-  include Helpers::Path
-
-  desc 'Create report dir'
-  task :directory do
-    FileUtils.mkdir_p path('reports', Rambling::Trie::VERSION)
-  end
-end

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

@@ -1,119 +0,0 @@
-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