sort_index 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44dd87ebf9e2728f47050cfa271ed013f7af834d
+  data.tar.gz: cf3f99237d86fa6caed70a84ab57b5df06eb23c5
+SHA512:
+  metadata.gz: 867b0ba9295f54cedcb616da6101e7aeac773c9688a42255d5ee4d3feab137767c767c7d7ba42ce87ed16e7302e8b66b0601eaee8b04b6df15162f771222d26e
+  data.tar.gz: 0bfdeed7a173e601e4d036586000bf66175a9bb7bcc72fa1e5971f5b750aa21d7351dfeebda4bdeec4b897dc6a52389522b4b390795d8c464cfa72d87dcb182d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sort_index.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Scott Pierce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# SortIndex
+Proof of concept to maintain a file with sorted and unique values.
+This could be helpful for building building indexes.
+
+`Range#bsearch` is used to determine if a line is already in the file and
+to determine where a line should be inserted. This means Ruby 2.0 is required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sort_index'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sort_index
+
+## Usage
+
+Use `sorted_puts` on the File instance instead of `write`, `<<`, etc.
+
+```ruby
+SortIndex::File.open('animals', 'w+') do |f|
+  f.sorted_puts 'cat'  # add stuff out of order
+  f.sorted_puts 'bat'
+  f.sorted_puts 'dog'
+  f.sorted_puts 'ant'
+  f.sorted_puts 'cat'  # duplicate on purpose
+end
+
+IO.read('animals')
+=> "ant\nbat\ncat\ndog\n"
+```
+
+## Gotchas
+Performance of writes is probably the biggest problem. There really isn't a
+great way to insert lines in the middle of a file. So we do it the naive way.
+
+1. save current position `IO#tell`
+2. read the remaining bytes of the file using `IO#read`
+3. write the line at the current position
+4. write the rest of the contents from step 2.
+
+Common sense would say don't create gigabyte files this way. Use unix calls
+instead:
+
+```sh
+echo 'cat' >> animals
+echo 'bat' >> animals
+echo 'dog' >> animals
+echo 'ant' >> animals
+sort -u animals
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddrscott/sort_index.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sort_index'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sort_index/file.rb

@@ -0,0 +1,104 @@
+module SortIndex
+  class File < ::File
+
+    # adds the line to the while maintaining the data's sort order
+    #
+    # @param [String] line to add to the file, it should not have it's own line ending.
+    # @return [Nil] always returns nil to match standard #puts method
+    def sorted_puts(line)
+      if line == nil || line.size == 0
+        raise ArgumentError, 'Line cannot be blank!'
+      end
+      if line.index($/)
+        raise ArgumentError, "Cannot `puts` a line with extra line endings. Make sure the line does not contain `#{$/.inspect}`"
+      end
+
+      matched, idx = binary_seek(line)
+
+      if matched
+        # an exact match was found, nothing to do
+      else
+        if idx == nil
+          # append to end of file
+          self.seek(0, IO::SEEK_END)
+          puts(line)
+        else
+          self.seek(cached_positions[idx][0], IO::SEEK_SET)
+          do_at_current_position{puts(line)}
+        end
+        update_cached_position(idx, line)
+      end
+      nil
+    end
+
+    private
+
+      # Builds an Array of position and length of the current file.
+      # @return [Array[Array[Fixnum,Fixnum]]] array of position, line length pairs
+      def index_each_line
+        positions = []
+        size = 0
+        each_line do |line|
+          positions << [size, line.size]
+          size += line.size
+        end
+        rewind
+        positions
+      end
+
+      # remembers current file position, reads everything at the position
+      # execute the block, and put everything back.
+      # This routine is really bad for huge files since it could run out of
+      # memory.
+      def do_at_current_position(&block)
+        current_position = self.tell
+        huge_buffer = self.read
+        self.seek(current_position, IO::SEEK_SET)
+        block.call
+      ensure
+        self.write huge_buffer
+      end
+
+      def update_cached_position(idx, line)
+        line_size_with_ending = line.size + $/.size
+        if idx
+          # add an entry to the positions
+          prev_pos = cached_positions[idx][0]
+          cached_positions.insert(idx, [prev_pos, line_size_with_ending])
+
+          # move all other entries ahead by the new entries length
+          (idx+1).upto(cached_positions.size-1).each do |i|
+            prev_pos = cached_positions[i][0]
+            cached_positions[i][0] = prev_pos + line_size_with_ending
+          end
+        elsif cached_positions.empty?
+          cached_positions << [0, line_size_with_ending]
+        else
+          last_pos, last_size = *cached_positions.last
+          cached_positions << [last_pos + last_size, line_size_with_ending]
+        end
+      end
+
+      def cached_positions
+        @cached_positions ||= index_each_line
+      end
+
+      # @return [Boolean, Fixnum] true if exact match, the minimum position index
+      def binary_seek(val)
+        return nil if cached_positions.empty?
+
+        last_line = nil
+        idx = (0...@cached_positions.size).bsearch do |i|
+          last_pair = @cached_positions[i]
+          pos, len = *last_pair
+          self.seek(pos, IO::SEEK_SET)
+
+          # we don't want to compare the line ending
+          last_line = self.read(len).strip
+          last_line >= val
+        end
+        return last_line == val, idx
+      end
+    # END private
+  end
+end

data/lib/sort_index/version.rb

@@ -0,0 +1,3 @@
+module SortIndex
+  VERSION = '0.1.0'
+end

data/lib/sort_index.rb

@@ -0,0 +1,5 @@
+require 'sort_index/version'
+require 'sort_index/file'
+
+module SortIndex
+end

data/sort_index.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sort_index/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.name          = 'sort_index'
+  spec.version       = SortIndex::VERSION
+  spec.authors       = ['Scott Pierce']
+  spec.email         = ['ddrscott@gmail.com']
+
+  spec.summary       = %q{Simple File wrapper to keep file contents unique and sorted as lines are added.}
+  spec.description   = <<-RDOC
+== Description ==
+Proof of concept to maintain a file with sorted and unique values.
+This could be helpful for building building indexes.
+
+Range#bsearch is used to determine if a line is already in the file and
+to determine where a line should be inserted. This means Ruby 2.0 is required.
+RDOC
+  spec.homepage      = 'https://github.com/ddrscott/sort_index'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'pry', '~> 0.10.3'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sort_index
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Pierce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: |
+  == Description ==
+  Proof of concept to maintain a file with sorted and unique values.
+  This could be helpful for building building indexes.
+
+  Range#bsearch is used to determine if a line is already in the file and
+  to determine where a line should be inserted. This means Ruby 2.0 is required.
+email:
+- ddrscott@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sort_index.rb
+- lib/sort_index/file.rb
+- lib/sort_index/version.rb
+- sort_index.gemspec
+homepage: https://github.com/ddrscott/sort_index
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple File wrapper to keep file contents unique and sorted as lines are
+  added.
+test_files: []
+has_rdoc: