db_binary_search 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b18dd20f169cd30905d627d4b12541f7337e318
+  data.tar.gz: 054ddf798975a297cd62fe6c48d260bea69ca30a
+SHA512:
+  metadata.gz: ee9e6b53bef4f1395f0e69be994d080317e80f1b55d2e0cd25c7f2a67960e6ccaca119865a83c4c6db416723ab77957a24aa97f5ab3a1531051490e1088ef322
+  data.tar.gz: 09e6222d049611b7d9d0818ce80c9903efe574d34a571a8b03ce3b6d59fef7009f3d1de04095be191563d63b46837f253c47ec233041770557bfd198bd8b5c89

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug
+.byebug_history
+spec/test.sqlite3

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.14.3
+script:
+  - bundle install
+  - bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrew@caoos.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrew Crookston
+
+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,99 @@
+# DBBinarySearch
+
+![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)
+[![CI Status](http://img.shields.io/travis/acrookston/db_binary_search.svg?style=flat)](https://travis-ci.org/acrookston/db_binary_search)
+[![codebeat badge](https://codebeat.co/badges/24f76413-0c57-410c-9e90-45b5309e6442)](https://codebeat.co/projects/github-com-acrookston-db_binary_search)
+[![codecov](https://codecov.io/gh/acrookston/db_binary_search/branch/master/graph/badge.svg)](https://codecov.io/gh/acrookston/db_binary_search)
+
+
+An Active Support concern extending Active Record with the ability to binary
+search a table for use with non-indexed, chronologically sorted tables.
+
+The gem allows you to avoid slow database scans if you have an
+auto-incrementing primary key running in parallel with a column which
+you want to search.
+
+For example if you have a log table with a lot of records and it has the
+typical rails setup with `id` and `created_at` columns. You want to locate
+a specific date but the `created_at` column is not indexed, you can use
+db_binary_search to locate a row based on `created_at` faster than letting
+the database scan the entire column/table for the record.
+
+Unlike a regular binary search algorithm which generally looks for an
+exact value, this method will return the closest matching primary key.
+
+## Prerequisites
+
+This approach will only work if you have an automatically incrementing
+(or similar) primary key column and a chronologically sorted column to search,
+e.g. a rails created_at column which doesn't change.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'db_binary_search'
+```
+
+And then execute:
+
+```
+    $ bundle
+```
+
+Or install it yourself as:
+
+```
+    $ gem install db_binary_search
+```
+
+## Usage
+
+First include the `DBBinarySearch` concern into your `ActiveRecord`
+model, then call the `binary_search` class method to search for the id.
+
+```
+binary_search(column, value, lower_id=nil, upper_id=nil)
+```
+
+- `column` a symbol, is the table column to search for.
+- `value` a comparable value of same type as `column`, the value you are searching for.
+- `lower_id` optional primary key value to start searching lower bound at.
+- `upper_id` optional primary key value to start searching upper bound at.
+
+Full example:
+
+```
+class Log < ActiveRecord::Base
+  include DBBinarySearch
+end
+
+id = Log.binary_search(:created_at, DateTime.parse("2017-01-07 00:00:00"))
+# use id...
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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/arookston/db_binary_search.
+
+If you're making a big change, please open an Issue first, so we can discuss. Otherwise:
+
+- Fork it
+- Run setup `bin/setup`
+- Make your changes
+- Run tests (`bundle exec rake spec`)
+- Send me a pull request
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Bundler.require
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "db_binary_search"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/db_binary_search.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_binary_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_binary_search"
+  spec.version       = DBBinarySearch::VERSION
+  spec.authors       = ["Andrew Crookston"]
+  spec.email         = ["andrew@caoos.com"]
+
+  spec.summary       = %q{An Active Support concern extending Active Record with the ability to binary search a table for use with non-indexed, chronologically sorted tables.}
+  spec.description   = %q{
+    The gem allows you to avoid slow database scans if you have an
+    auto-incrementing primary key running in parallel with a column which
+    you want to search.
+  }
+  spec.homepage      = "http://github.com/acrookston/db_binary_search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "sqlite3-ruby"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "codecov"
+end
+

data/lib/db_binary_search/version.rb

@@ -0,0 +1,3 @@
+module DBBinarySearch
+  VERSION = "1.0.0"
+end

data/lib/db_binary_search.rb

@@ -0,0 +1,33 @@
+require "db_binary_search/version"
+require 'active_record'
+
+module DBBinarySearch
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def binary_search(column, value, lower_id=nil, upper_id=nil)
+      lower_id = self.first.id unless lower_id
+      upper_id = self.last.id unless upper_id
+
+      if lower_id >= upper_id
+        return upper_id
+      else
+        mid_id = lower_id + ((upper_id - lower_id) / 2.0).floor
+        row = where(["`#{primary_key}` >= ?", mid_id]).limit(1).first
+
+        return upper_id unless row
+
+        column_value = row.send(column)
+
+        if column_value > value
+          return binary_search(column, value, lower_id, mid_id)
+        elsif column_value < value
+          return binary_search(column, value, mid_id + 1, upper_id)
+        else
+          return mid_id
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: db_binary_search
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Crookston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    The gem allows you to avoid slow database scans if you have an\n
+  \   auto-incrementing primary key running in parallel with a column which\n    you
+  want to search.\n  "
+email:
+- andrew@caoos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db_binary_search.gemspec
+- lib/db_binary_search.rb
+- lib/db_binary_search/version.rb
+homepage: http://github.com/acrookston/db_binary_search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: An Active Support concern extending Active Record with the ability to binary
+  search a table for use with non-indexed, chronologically sorted tables.
+test_files: []