lazy-uuid 0.5.0

data/lib/lazy-uuid/version.rb

@@ -0,0 +1,3 @@
+module LazyUuid
+  VERSION = '0.5.0'
+end

data/spec/factories/uuid_factory.rb

@@ -0,0 +1,43 @@
+require 'securerandom'
+require 'lazy-uuid/uuid'
+
+FactoryGirl.define do
+  factory :uuid_str, class: String do
+    trait :no_dashes do
+      after(:build) do |uuid_str|
+        uuid_str.delete!('-')
+      end
+    end
+
+    initialize_with { SecureRandom.uuid }
+  end
+
+  factory :uuid_value, class: String do
+    transient do
+      association :source, :factory => :uuid_str, :strategy => :build
+    end
+
+    initialize_with { source.delete('-').scan(/../).map(&:hex).pack('C*') }
+  end
+
+  factory :uuid, class: Uuid do
+    transient do
+      source nil
+    end
+
+    initialize_with do
+      case source
+        when nil
+          Uuid.generate
+        when Uuid
+          Uuid.new(source.value)
+        else
+          if source.length == 16
+            Uuid.new(source)
+          else
+            Uuid.new(build(:uuid_value, :source => source))
+          end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+if RUBY_PLATFORM != 'java'
+  # Code Climate test coverage.
+  begin
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+  rescue
+    # Continue without Code Climate test coverage.
+  end
+end
+
+require 'rspec'
+require 'factory_girl'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Include FactoryGirl for building test objects.
+  config.include FactoryGirl::Syntax::Methods
+end
+
+# Include the library.
+require_relative '../lib/lazy-uuid'
+
+# Include factories.
+FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryGirl.find_definitions

data/spec/uuid_spec.rb

@@ -0,0 +1,457 @@
+require_relative 'spec_helper'
+
+RSpec::Matchers.define :be_a_valid_uuid_string do
+  match do |actual|
+    !!/^\A[0-9a-f]{8}(-?)[0-9a-f]{4}\1[1-5][0-9a-f]{3}\1[89ab][0-9a-f]{3}\1[0-9a-f]{12}\z$/i.match(actual)
+  end
+
+  description do
+    'be a valid UUID string'
+  end
+
+  failure_message do |actual|
+    "expected that #{actual} would be a valid UUID string"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected that #{actual} would not be a valid UUID string"
+  end
+end
+
+RSpec.describe Uuid do
+
+  describe '::DEFAULT' do
+    subject { Uuid::DEFAULT }
+
+    it 'is all zeroes' do
+      is_expected.to eq("\x0" * 16)
+    end
+
+    it 'is frozen' do
+      is_expected.to be_frozen
+    end
+  end
+  
+  describe '#initialize' do
+    context 'with a valid value' do
+      let(:uuid_value) { build(:uuid_value) }
+      subject(:uuid) { described_class.new(uuid_value) }
+
+      describe 'the value' do
+        subject { uuid.value }
+
+        it 'is stored' do
+          is_expected.to eq uuid_value
+        end
+      end
+    end
+
+    context 'with an invalid value' do
+      let(:uuid_value) { 'foobar' }
+
+      it 'throws an ArgumentError' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '.generate' do
+    subject(:uuid) { described_class.generate }
+
+    describe 'the value' do
+      subject { uuid.value }
+
+      # The UUID standards don't allow generated UUID to be all zeroes.
+      it 'is not DEFAULT' do
+        is_expected.to_not eq("\x0" * 16)
+      end
+
+      # The chances of two randomly generated UUIDs being identical is virtually impossible.
+      it 'is random' do
+        other = build(:uuid)
+        is_expected.to_not eq other
+      end
+    end
+
+    describe 'the string' do
+      subject { uuid.to_s }
+
+      it 'is valid' do
+        is_expected.to be_a_valid_uuid_string
+      end
+    end
+  end
+
+  describe '.parse' do
+    subject { described_class.parse(uuid_str) }
+
+    context 'with a valid argument' do
+      context 'with dashes' do
+        let(:uuid_str) { build(:uuid_str) }
+
+        it 'parses correctly' do
+          is_expected.to eq uuid_str
+        end
+      end
+
+      context 'without dashes' do
+        let(:uuid_str) { build(:uuid_str, :no_dashes) }
+
+        it 'parses correctly' do
+          is_expected.to eq uuid_str
+        end
+      end
+    end
+
+    context 'with a malformed string' do
+      let(:uuid_str) { 'foobar' }
+
+      it 'returns nil' do
+        is_expected.to be_nil
+      end
+    end
+
+    context 'with an invalid argument' do
+      let(:uuid_str) { 5 }
+
+      it 'raises an ArgumentError' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with newlines' do
+      let(:uuid_str) { "\n" + build(:uuid_str) + "\n" }
+
+      it 'returns nil' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  describe '#value' do
+    let(:uuid) { build(:uuid) }
+    subject(:value) { uuid.value }
+
+    it 'is a string' do
+      is_expected.to be_a String
+    end
+
+    it 'is frozen' do
+      is_expected.to be_frozen
+    end
+
+    it 'is 16 bytes' do
+      expect(value.length).to be 16
+    end
+  end
+
+  describe '#eql?' do
+    let(:uuid) { build(:uuid) }
+    subject { uuid.eql?(other) }
+
+    context 'with two identical UUIDs' do
+      let(:other) { build(:uuid, :source => uuid) }
+
+      it 'returns true' do
+        is_expected.to eq true
+      end
+    end
+
+    context 'with two different UUIDs' do
+      let(:other) { build(:uuid) }
+
+      it 'returns false' do
+        is_expected.to eq false
+      end
+    end
+
+    context 'without a UUID' do
+      let(:other) { 'foobar' }
+
+      it 'returns false' do
+        is_expected.to eq false
+      end
+    end
+  end
+
+  describe '#==' do
+    let(:uuid) { build(:uuid) }
+    subject { uuid == other }
+
+    context 'with equal UUIDs' do
+      let(:other) { build(:uuid, :source => uuid) }
+      
+      it 'is true' do
+        is_expected.to be true
+      end
+    end
+
+    context 'with the same instance' do
+      let(:other) { uuid }
+      
+      it 'is true' do
+        is_expected.to be true
+      end
+    end
+
+    context 'with unequal UUIDs' do
+      let(:other) { build(:uuid) }
+      
+      it 'is false' do
+        is_expected.to be false
+      end
+    end
+
+    context 'with nil' do
+      let(:other) { nil }
+      
+      it 'is false' do
+        is_expected.to be false
+      end
+    end
+
+    context 'with a malformed string' do
+      let(:other) { 'foobar' }
+      
+      it 'is false' do
+        is_expected.to be false
+      end
+    end
+
+    context 'with a non-string' do
+      let(:other) { 5 }
+      
+      it 'is false' do
+        is_expected.to be false
+      end
+    end
+
+    context 'with identical value' do
+      let(:other) { uuid.value }
+      
+      it 'is true' do
+        is_expected.to be true
+      end
+    end
+
+    context 'with identical string' do
+      let(:other) { uuid.to_s }
+      
+      it 'is true' do
+        is_expected.to be true
+      end
+    end
+  end
+
+  describe '#<=>' do
+    let(:lesser) { 'de305d54-75b4-431b-adb2-eb6b9e546014' }
+    let(:greater) { 'de305d54-75b4-431b-adb2-eb6b9e546020' }
+    subject { first <=> second }
+
+    context 'with an equal UUID' do
+      let(:first)  { build(:uuid) }
+      let(:second) { build(:uuid, :source => first) }
+
+      it 'is 0' do
+        is_expected.to eq 0
+      end
+    end
+
+    context 'with the same instance' do
+      let(:first)  { build(:uuid) }
+      let(:second) { first }
+
+      it 'is 0' do
+        is_expected.to eq 0
+      end
+    end
+
+    context 'with a lesser UUID' do
+      let(:first)  { build(:uuid, :source => greater) }
+      let(:second) { build(:uuid, :source => lesser) }
+
+      it 'is 1' do
+        is_expected.to eq 1
+      end
+    end
+
+    context 'with a greater UUID' do
+      let(:first)  { build(:uuid, :source => lesser) }
+      let(:second) { build(:uuid, :source => greater) }
+
+      it 'is -1' do
+        is_expected.to eq(-1)
+      end
+    end
+
+    context 'with nil' do
+      let(:first)  { build(:uuid) }
+      let(:second) { nil }
+
+      it 'is nil' do
+        is_expected.to be_nil
+      end
+    end
+
+    context 'with a number' do
+      let(:first)  { build(:uuid) }
+      let(:second) { 500 }
+
+      it 'is nil' do
+        is_expected.to be_nil
+      end
+    end
+
+    context 'with an identical value' do
+      let(:first)  { build(:uuid) }
+      let(:second) { first.value }
+
+      it 'is 0' do
+        is_expected.to eq 0
+      end
+    end
+
+    context 'with a lesser value' do
+      let(:first)  { build(:uuid, :source => greater) }
+      let(:second) { build(:uuid_value, :source => lesser) }
+
+      it 'is 1' do
+        is_expected.to eq 1
+      end
+    end
+
+    context 'with a greater value' do
+      let(:first)  { build(:uuid, :source => lesser) }
+      let(:second) { build(:uuid_value, :source => greater) }
+
+      it 'is -1' do
+        is_expected.to eq(-1)
+      end
+    end
+
+    context 'with an equal string' do
+      let(:first)  { build(:uuid) }
+      let(:second) { first.to_s }
+
+      it 'is 0' do
+        is_expected.to eq 0
+      end
+    end
+
+    context 'with a lesser string' do
+      let(:first)  { build(:uuid, :source => greater) }
+      let(:second) { lesser }
+
+      it 'is 1' do
+        is_expected.to eq 1
+      end
+    end
+
+    context 'with a greater string' do
+      let(:first)  { build(:uuid, :source => lesser) }
+      let(:second) { greater }
+
+      it 'is -1' do
+        is_expected.to eq(-1)
+      end
+    end
+
+    context 'with an invalid string' do
+      let(:first)  { build(:uuid) }
+      let(:second) { 'foobar' }
+
+      it 'is nil' do
+        is_expected.to be_nil
+      end
+    end
+  end
+
+  describe '#hash' do
+    let(:uuid) { build(:uuid) }
+    subject { uuid.hash }
+
+    it 'is a Fixnum' do
+      is_expected.to be_a Fixnum
+    end
+
+    context 'with identical UUIDs' do
+      let(:first)  { build(:uuid) }
+      let(:second) { build(:uuid, :source => first) }
+
+      it 'returns identical values' do
+        expect(first.hash).to eq(second.hash)
+      end
+    end
+
+    context 'with different UUIDs' do
+      let(:first)  { build(:uuid) }
+      let(:second) { build(:uuid) }
+
+      it 'returns different values' do
+        expect(first.hash).to_not eq(second.hash)
+      end
+    end
+  end
+
+  describe '#to_s' do
+    let(:uuid_str) { build(:uuid_str) }
+    let(:uuid) { build(:uuid, :source => uuid_str) }
+    subject { uuid.to_s }
+
+    it 'is a String' do
+      is_expected.to be_a String
+    end
+
+    it 'is a valid UUID string' do
+      is_expected.to be_a_valid_uuid_string
+    end
+
+    it 'equals the initial value' do
+      is_expected.to eq uuid_str
+    end
+
+    it 'contains dashes' do
+      is_expected.to include '-'
+    end
+
+    context 'with bytes less than 16' do
+      let(:uuid_str) { '05305d54-7502-431b-adb2-eb6b9e546000' }
+      let(:uuid) { build(:uuid, :source => uuid_str) }
+
+      it 'pads with zeroes' do
+        is_expected.to eq uuid_str
+      end
+    end
+
+    context 'with dashes set to false' do
+      let(:uuid_str) { build(:uuid_str, :no_dashes) }
+      subject { uuid.to_s(false) }
+
+      it 'is a String' do
+        is_expected.to be_a String
+      end
+
+      it 'is a valid UUID string' do
+        is_expected.to be_a_valid_uuid_string
+      end
+
+      it 'equals the initial value' do
+        is_expected.to eq uuid_str
+      end
+
+      it 'does not contain dashes' do
+        is_expected.not_to include '-'
+      end
+
+      context 'with bytes less than 16' do
+        let(:uuid_str) { '05305d547502431badb2eb6b9e546000' }
+        let(:uuid) { build(:uuid, :source => uuid_str) }
+
+        it 'pads with zeroes' do
+          is_expected.to eq uuid_str
+        end
+      end
+    end
+  end
+
+end