k_ordered_flake 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c32ca1c257d6089baebf97e5ac59566a366ea86
+  data.tar.gz: 5b771f6e237843d12f47f4cbb127bd1e19b0cc9f
+SHA512:
+  metadata.gz: 59cde81626ca61550a23e3c2bae13c4b6a622a42321caeaa7f60f09627bb4ebc34e6f88b9082ab06e41e234e683cc3bc4afaa1859ac446913e65bc4bce3db8e8
+  data.tar.gz: 8c8ac2e057d80eff5a82b4e04ee5ab666b93fb2f7cfc81ffcf6125a25c24820b10f44bfea0043bc8446e7e75092df7235b4d67ca814da914fdb5787f3b0f01c0

data/.gitignore

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

data/.travis.yml

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

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:latest
+
+RUN apt-get update -qq && apt-get upgrade -y && apt-get install -y build-essential libpq-dev
+RUN apt-get install -y nodejs less vim aptitude
+
+ENV APP_HOME /k_ordered_flake
+ENV PORT 3000
+
+RUN mkdir $APP_HOME
+
+WORKDIR $APP_HOME
+
+ADD . $APP_HOME/
+
+RUN bundle install
+
+EXPOSE $PORT

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,41 @@
+# KOrderedFlake
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/k_ordered_flake`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k_ordered_flake'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install k_ordered_flake
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/k_ordered_flake.
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "k_ordered_flake"
+
+# 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

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/k_ordered_flake.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'k_ordered_flake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "k_ordered_flake"
+  spec.version       = KOrderedFlake::VERSION
+  spec.authors       = ["R.J. Osborne"]
+  spec.email         = ["rjo1970@gmail.com"]
+
+  spec.summary       = %q{A K-Ordered snowflake implementation}
+  spec.description   = %q{K-Ordered values are alphabetically sortable by human-observable time, yet requires no server coordination}
+  spec.homepage      = "https://github.com/rjo1970/k_ordered_flake"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+#  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = "RubyGems.org"
+#  else
+#    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+#  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "concurrent-ruby", "~> 1.0.1"
+  spec.add_dependency "macaddr", '~> 1.7', '>= 1.7.1'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/k_ordered_flake.rb

@@ -0,0 +1,63 @@
+require "concurrent"
+require "k_ordered_flake/version"
+require "k_ordered_flake/exceptions"
+require "date"
+require "macaddr"
+require "digest"
+
+module KOrderedFlake
+
+  def self.epoc
+    DateTime.now.strftime('%Q').to_i
+  end
+
+  def self.identity
+    mac = Mac.address.split(':').join('')
+    code = Digest::SHA1.hexdigest(mac)[28..-1]
+    code.to_i(16)
+  end
+
+  STATE = Concurrent::Atom.new({
+    time: self.epoc,
+    identity: self.identity,
+    counter: 0 })
+
+  DIGITS = ('0'..'9').to_a + ('A'..'Z').to_a + ('a'..'z').to_a
+
+  def self.to_base_62(x)
+    result = []
+    while x > 61
+      y = x % 62
+      x /= 62
+      result.unshift self::DIGITS[y]
+    end
+    result.unshift self::DIGITS[x]
+    result.join ""
+  end
+
+  def self.clock(state, time)
+    s = state.clone
+    if (time == s[:time])
+      s[:counter] = (s[:counter] + 1) % 65536
+      raise KOrderedFlake::CounterOverflowException.new("Too many increments per millisecond") if s[:counter] == 0
+    elsif time > s[:time]
+      s[:counter] = 0
+      s[:time] = time
+    else
+      raise KOrderedFlake::TimeDiscontinuityException.new("Time may not run backwards #{state[:time]} > #{time}")
+    end
+    s
+  end
+
+  def self.encode(state)
+    x = (state[:time] << 64) + (state[:identity] << 16) + state[:counter]
+    self.to_base_62(x)
+  end
+
+  def self.flake
+    t = self.epoc
+    sample = self::STATE.swap(t) { |s, t| self.clock(s, t) }
+    self.encode(sample)
+  end
+
+end

data/lib/k_ordered_flake/exceptions.rb

@@ -0,0 +1,7 @@
+module KOrderedFlake
+  class TimeDiscontinuityException < StandardError
+  end
+
+  class CounterOverflowException < StandardError
+  end
+end

data/lib/k_ordered_flake/version.rb

@@ -0,0 +1,3 @@
+module KOrderedFlake
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: k_ordered_flake
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- R.J. Osborne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: macaddr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: K-Ordered values are alphabetically sortable by human-observable time,
+  yet requires no server coordination
+email:
+- rjo1970@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- k_ordered_flake.gemspec
+- lib/k_ordered_flake.rb
+- lib/k_ordered_flake/exceptions.rb
+- lib/k_ordered_flake/version.rb
+homepage: https://github.com/rjo1970/k_ordered_flake
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A K-Ordered snowflake implementation
+test_files: []