github-ds 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06371d875489add31a6dada7ff308cee7355759a
+  data.tar.gz: 1cfaebb92a0ca5d4b75a71d89a4dcaf9fbda6634
+SHA512:
+  metadata.gz: 65ce5774cd9519de0383bd3597c277246a977a038bec24cbe945d21b55116d1211487b98134170adb4a9851eb44addb1aa40d38004d09b4e756c3fdd43d79d5b
+  data.tar.gz: 2af9c3b7bc6fd3eaa5543f7c8272afca16afc3e639df64f83074d8ed740c91de37f69ef33c45544fc85bbce1febefeb1e5be92981ff36aef32faefede2d992a9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

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 nunemaker@gmail.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/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+## Contributing
+
+[fork]: https://github.com/github/github-ds/fork
+[pr]: https://github.com/github/github-ds/compare
+[style]: https://github.com/styleguide/ruby
+[code-of-conduct]: CODE_OF_CONDUCT.md
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
+
+## Submitting a pull request
+
+0. [Fork][fork] and clone the repository
+0. Configure and install the dependencies: `script/bootstrap`
+0. Make sure the tests pass on your machine: `script/test`
+0. Create a new branch: `git checkout -b my-branch-name`
+0. Make your change, add tests, and make sure the tests still pass
+0. Push to your fork and [submit a pull request][pr]
+0. Pat your self on the back and wait for your pull request to be reviewed and merged.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Follow the [style guide][style].
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Resources
+
+- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in github-ds.gemspec
+gemspec
+
+gem "rails", "~> #{ENV['RAILS_VERSION'] || '5.0.2'}"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 GitHub, Inc.
+
+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,201 @@
+# GitHub::DS
+
+`GitHub::DS` is a collection of Ruby libraries for working with SQL on top of ActiveRecord's connection.
+
+* `GitHub::KV` is a key/value data store backed by MySQL.
+* `GitHub::SQL` is for building and executing a SQL query. This class uses ActiveRecord's connection class, but provides a better API for bind values and raw data access.
+* `GitHub::Result` makes it easier to bake in resiliency through the use of a Result object instead of raising exceptions.
+
+**Current Status**: Used in production extensively at GitHub. Because of this, all changes will be thoroughly vetted, which could slow down the process of contributing. We will do our best to actively communicate status of pull requests with any contributors. If you have any substantial changes that you would like to make, it would be great to first [open an issue](http://github.com/github/github-ds/issues/new) to discuss them with us.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github-ds'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github-ds
+
+## Usage
+
+Below is a taste of what you can do with these libraries. If you want to see more, check out the [examples directory](./examples/).
+
+### GitHub::KV
+
+First, you'll need to create the `key_values` table using the included Rails migration generator.
+
+```
+rails generate github:kv:active_record
+rails db:migrate
+```
+
+Once you have created and executed the migration, KV can do neat things like this:
+
+```ruby
+require "pp"
+require "github/kv"
+
+# Create new instance using ActiveRecord's default connection.
+kv = GitHub::KV.new { ActiveRecord::Base.connection }
+
+# Get a key.
+pp kv.get("foo")
+#<GitHub::Result:0x3fd88cd3ea9c value: nil>
+
+# Set a key.
+kv.set("foo", "bar")
+# nil
+
+# Get the key again.
+pp kv.get("foo")
+#<GitHub::Result:0x3fe810d06e4c value: "bar">
+
+# Get multiple keys at once.
+pp kv.mget(["foo", "bar"])
+#<GitHub::Result:0x3fccccd1b57c value: ["bar", nil]>
+
+# Check for existence of a key.
+pp kv.exists("foo")
+#<GitHub::Result:0x3fd4ae55ce8c value: true>
+
+# Check for existence of key that does not exist.
+pp kv.exists("bar")
+#<GitHub::Result:0x3fd4ae55c554 value: false>
+
+# Check for existence of multiple keys at once.
+pp kv.mexists(["foo", "bar"])
+#<GitHub::Result:0x3ff1e98e18e8 value: [true, false]>
+
+# Set a key's value if the key does not already exist.
+pp kv.setnx("foo", "bar")
+# false
+
+# Delete a key.
+pp kv.del("bar")
+# nil
+
+# Delete multiple keys at once.
+pp kv.mdel(["foo", "bar"])
+# nil
+```
+
+### GitHub::SQL
+
+```ruby
+# Select, insert, update, delete or whatever you need...
+statement = "INSERT INTO example_key_values (`key`, `value`) VALUES (:key, :value)"
+GitHub::SQL.run statement, key: "foo", value: "bar"
+
+statement = "SELECT value FROM example_key_values WHERE `key` = :key"
+GitHub::SQL.value select_statement, key: "foo"
+
+# Or slowly build up a query based on conditionals...
+sql = GitHub::SQL.new "SELECT `VALUE` FROM example_key_values"
+
+key = ENV["KEY"]
+unless key.nil?
+  sql.add "WHERE `key` = :key", key: key
+end
+
+limit = ENV["LIMIT"]
+unless limit.nil?
+  sql.add "ORDER BY `key` ASC"
+  sql.add "LIMIT :limit", limit: limit.to_i
+end
+
+p sql.results
+```
+
+### GitHub::Result
+
+```ruby
+def do_something
+  1
+end
+
+def do_something_that_errors
+  raise "noooooppppeeeee"
+end
+
+result = GitHub::Result.new { do_something }
+p result.ok? # => true
+p result.value! # => 1
+
+result = GitHub::Result.new { do_something_that_errors }
+p result.ok? # => false
+p result.value { "default when error happens" } # => "default when error happens"
+begin
+  result.value! # raises exception because error happened
+rescue => error
+  p result.error
+  p error
+end
+
+# Outputs Step 1, 2, 3
+result = GitHub::Result.new {
+  GitHub::Result.new { puts "Step 1: success!" }
+}.then { |value|
+  GitHub::Result.new { puts "Step 2: success!" }
+}.then { |value|
+  GitHub::Result.new { puts "Step 3: success!" }
+}
+p result.ok? # => true
+
+# Outputs Step 1, 2 and stops.
+result = GitHub::Result.new {
+  GitHub::Result.new { puts "Step 1: success!" }
+}.then { |value|
+  GitHub::Result.new {
+    puts "Step 2: failed!"
+    raise
+  }
+}.then { |value|
+  GitHub::Result.new {
+    puts "Step 3: should not get here because previous step failed!"
+  }
+}
+p result.ok? # => false
+```
+
+## Caveats
+
+### GitHub::KV Expiration
+
+KV supports expiring keys and obeys expiration when performing operations, but does not actually purge expired rows. At GitHub, we use [pt-archiver](https://www.percona.com/doc/percona-toolkit/2.1/pt-archiver.html) to nibble expired rows. We configure it to do a replica lag check and use the following options:
+
+* **index_name**: `"index_key_values_on_expires_at"`
+* **limit**: `1000`
+* **where**: `"expires_at <= NOW()"`
+
+## Development
+
+After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `script/test` to run the tests. You can also run `script/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `script/install`. To release a new version, update the version number in `version.rb`, commit, and then run `script/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/github/github-ds. 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. We recommend reading the [contributing guide](./CONTRIBUTING.md) as well.
+
+## Roadmap
+
+Nothing currently on our radar other than continued maintenance. Have a big idea? [Let us know](http://github.com/github/github-ds/issues/new).
+
+## Maintainers
+
+| pic | @mention |
+|---|---|
+| ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64) | [@jnunemaker](https://github.com/jnunemaker) |
+| ![@charliesome](https://avatars3.githubusercontent.com/u/179065?s=64) | [@charliesome](https://github.com/charliesome) |
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/examples/example_setup.rb

@@ -0,0 +1,38 @@
+require "pp"
+require "pathname"
+root_path = Pathname(__FILE__).dirname.join("..").expand_path
+lib_path  = root_path.join("lib")
+$:.unshift(lib_path)
+
+require "active_record"
+
+attempts = 0
+begin
+  ActiveRecord::Base.establish_connection({
+    adapter: "mysql2",
+    database: "github_ds_test",
+  })
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS `key_values`")
+  require "generators/github/ds/templates/migration"
+  ActiveRecord::Migration.verbose = false
+  CreateKeyValuesTable.up
+rescue ActiveRecord::NoDatabaseError
+  raise if attempts >= 1
+  ActiveRecord::Base.establish_connection({
+    adapter: "mysql2",
+  })
+  ActiveRecord::Base.connection.execute("CREATE DATABASE `github_ds_test`")
+  attempts += 1
+  retry
+end
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS `example_key_values`")
+ActiveRecord::Base.connection.execute(<<-SQL)
+  CREATE TABLE `example_key_values` (
+    `id` bigint(20) NOT NULL AUTO_INCREMENT,
+    `key` varchar(255) NOT NULL,
+    `value` blob NOT NULL,
+    PRIMARY KEY (`id`),
+    UNIQUE KEY `index_key_values_on_key` (`key`)
+  ) ENGINE=InnoDB DEFAULT CHARSET=utf8
+SQL

data/examples/kv.rb

@@ -0,0 +1,45 @@
+require File.expand_path("../example_setup", __FILE__)
+require "github/kv"
+
+# Create new instance using ActiveRecord's default connection.
+kv = GitHub::KV.new { ActiveRecord::Base.connection }
+
+# Get a key.
+pp kv.get("foo")
+#<GitHub::Result:0x3fd88cd3ea9c value: nil>
+
+# Set a key.
+kv.set("foo", "bar")
+# nil
+
+# Get the key again.
+pp kv.get("foo")
+#<GitHub::Result:0x3fe810d06e4c value: "bar">
+
+# Get multiple keys at once.
+pp kv.mget(["foo", "bar"])
+#<GitHub::Result:0x3fccccd1b57c value: ["bar", nil]>
+
+# Check for existence of a key.
+pp kv.exists("foo")
+#<GitHub::Result:0x3fd4ae55ce8c value: true>
+
+# Check for existence of key that does not exist.
+pp kv.exists("bar")
+#<GitHub::Result:0x3fd4ae55c554 value: false>
+
+# Check for existence of multiple keys at once.
+pp kv.mexists(["foo", "bar"])
+#<GitHub::Result:0x3ff1e98e18e8 value: [true, false]>
+
+# Set a key's value if the key does not already exist.
+pp kv.setnx("foo", "bar")
+# false
+
+# Delete a key.
+pp kv.del("bar")
+# nil
+
+# Delete multiple keys at once.
+pp kv.mdel(["foo", "bar"])
+# nil