youyouaidi 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0d8a7918c5ccc52c7b51c259aef312e9c0c4b74
+  data.tar.gz: 4e280e52b10d17e1adebe93986e353078d90de18
+SHA512:
+  metadata.gz: 31b9dbba81a25d1923a44ca05b731d4b7762c3fbde742f36259269d781e10e45d9911042d385891f828fae2469f09d8913d0dfd74022b05d67f12a742d77950f
+  data.tar.gz: e162eb97d5f4609ebd91389ba0907134a0e5f1761764139730f9cfcedb4562561ea14edc6b2dc895a7d1a0a584d43b3fec32837d55b63e803ebce72c2f8471cd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+
+group :test do
+  gem 'rake', '~> 10.1'
+end
+
+# Specify your gem's dependencies in youyouaidi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolas Fricke
+
+MIT License
+
+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,45 @@
+# Youyouaidi
+
+Ruby Gem `Youyouaidi` offers a UUID class for parsing, validating and converting UUIDs into / from shorter representations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'youyouaidi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install youyouaidi
+
+## Usage
+
+```ruby
+uuid_string = '550e8400-e29b-41d4-a716-446655440000' # A valid UUID in string format
+uuid_short  = '_oGOAbD9fsFFEHWSMal1v'                # Same UUID in its short format
+
+Youyouaidi::UUID.valid_uuid? uuid_string # => true
+
+uuid = UUID uuid_string   # creates new Youyouaidi::UUID object, patches Youyouaidi::UUID.new uuid_string into kernel.
+# => #<Youyouaidi::UUID:0x0000010150bb60 @converter=Youyouaidi::Converter, @uuid="550e8400-e29b-41d4-a716-446655440000">
+# or alternatively a short UUID can be passed
+uuid = UUID uuid_short    # creates similar Youyouaidi::UUID object
+# => #<Youyouaidi::UUID:0x0000010150bb60 @converter=Youyouaidi::Converter, @uuid="550e8400-e29b-41d4-a716-446655440000">
+
+uuid.to_s                 # Returns the string representation of the UUID object
+# => '550e8400-e29b-41d4-a716-446655440000'
+uuid.to_short_s           # Returns the short string representation of the UUID object
+# => '_oGOAbD9fsFFEHWSMal1v', alias for method: #to_param
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/youyouaidi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/kernel_patch.rb

@@ -0,0 +1,7 @@
+require 'youyouaidi'
+
+module Kernel
+  def UUID(uuid_param)
+    Youyouaidi::UUID.new uuid_param
+  end
+end

data/lib/youyouaidi.rb

@@ -0,0 +1,8 @@
+require 'youyouaidi/version'
+require 'kernel_patch'
+
+module Youyouaidi
+  # Your code goes here...
+  require 'youyouaidi/uuid'
+  require 'youyouaidi/converter'
+end

data/lib/youyouaidi/converter.rb

@@ -0,0 +1,43 @@
+# Based on Base62 module by sinefunc
+# => https://github.com/sinefunc/base62
+class Youyouaidi::Converter
+  class << self
+    def encode(uuid)
+      base_encode uuid.to_i
+    end
+
+    def decode(encoded_uuid)
+      base_decode encoded_uuid
+    end
+
+    private
+      BASE = ('0'..'9').to_a + ('a'..'z').to_a + ('A'..'Z').to_a + %w(_ - +)
+
+      def base_encode(numeric)
+        raise ArgumentError, "`#{numeric}' needs to be a Numeric" unless numeric.is_a? Numeric
+
+        return '0' if numeric == 0
+        s = ''
+
+        while numeric > 0
+          s << BASE[numeric.modulo(BASE.size)]
+          numeric /= BASE.size
+        end
+        s.reverse
+      end
+
+      def base_decode(encoded_numeric)
+        s = encoded_numeric.to_s.reverse.split('')
+
+        total = 0
+        s.each_with_index do |char, index|
+          if ord = BASE.index(char)
+            total += ord * (BASE.size ** index)
+          else
+            raise ArgumentError, "`#{encoded_numeric}' has `#{char}' which is not valid"
+          end
+        end
+        total
+      end
+  end
+end

data/lib/youyouaidi/uuid.rb

@@ -0,0 +1,38 @@
+class Youyouaidi::UUID
+  attr_reader :uuid
+
+  def initialize(uuid_param, options = {})
+    @converter = options[:converter] || Youyouaidi::Converter
+    if self.class.valid_uuid? uuid_param
+      @uuid = uuid_param.to_s
+    else
+      @uuid = decode_short_string uuid_param
+      raise ArgumentError.new "`#{uuid_param}' could not be converted to valid UUID" unless self.class.valid_uuid? @uuid
+    end
+  end
+
+  def to_i
+    @uuid.gsub('-', '').hex
+  end
+
+  def to_s
+    @uuid
+  end
+
+  def to_short_string
+    @converter.encode self
+  end
+  alias_method :to_param, :to_short_string
+
+  private
+  def decode_short_string(short_uuid_string)
+    uuid = @converter.decode(short_uuid_string).to_i.to_s(16)
+    "#{uuid[0,8]}-#{uuid[8,4]}-#{uuid[12,4]}-#{uuid[16,4]}-#{uuid[20,12]}"
+  end
+
+  class << self
+    def valid_uuid?(uuid_canidate)
+      (uuid_canidate.to_s =~ /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i) == 0
+    end
+  end
+end

data/lib/youyouaidi/version.rb

@@ -0,0 +1,3 @@
+module Youyouaidi
+  VERSION = '0.0.2'
+end

data/spec/kernel_patch_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Kernel do
+  describe '.UUID' do
+    let(:valid_uuid) { '550e8400-e29b-41d4-a716-446655440000' }
+    let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+    let(:action) { UUID param }
+
+    subject { action }
+
+
+    shared_examples_for 'a valid UUID object' do
+      it { should be_a Youyouaidi::UUID }
+      its(:to_s) { should eq valid_uuid }
+    end
+
+    context 'initialized via valid uuid' do
+      let(:param) { valid_uuid }
+      it_behaves_like 'a valid UUID object'
+    end
+
+    context 'initialized via vaild encoded uuid' do
+      let(:param) { encoded_uuid }
+      it_behaves_like 'a valid UUID object'
+    end
+
+    context 'initialized with invalid param' do
+      let(:param) { 'KEKSE' }
+      subject { -> { action } }
+      it { should raise_error ArgumentError }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rspec'
+
+require 'bundler'
+Bundler.require
+
+require 'youyouaidi'
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # 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'
+
+  # Raise error when using old :should expectation syntax.
+  # config.raise_errors_for_deprecations!
+end

data/spec/youyouaidi/converter_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Youyouaidi::Converter do
+  let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+  let(:uuid_bignum) { 113059749145936325402354257176981405696 }
+  let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+
+  describe 'use case' do
+    subject { described_class.decode described_class.encode(uuid_bignum) }
+
+    it { should eq uuid_bignum }
+  end
+
+  describe 'methods' do
+    let(:uuid) { Youyouaidi::UUID.new uuid_string }
+
+    describe '.encode' do
+      subject { described_class.encode uuid }
+
+      it { should eq encoded_uuid }
+    end
+
+    describe '.decode' do
+      subject { described_class.decode encoded_uuid }
+
+      it { should eq uuid_bignum }
+    end
+  end
+end

data/spec/youyouaidi_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Youyouaidi do
+  describe Youyouaidi::UUID do
+    describe '.new' do
+      let(:param) { '' }
+      subject { Youyouaidi::UUID.new param }
+
+      context 'with valid uuid string' do
+        let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
+
+        it { should be_a Youyouaidi::UUID }
+      end
+
+      context 'with uuid in short format' do
+          let(:param) { '_oGOAbD9fsFFEHWSMal1v' }
+          let(:decoded_uuid) { '550e8400-e29b-41d4-a716-446655440000' }
+
+          it { should be_a Youyouaidi::UUID }
+          its(:to_s) { should eq decoded_uuid }
+      end
+
+      context 'with invalid uuid string' do
+        let(:param) { 'Kekse' }
+
+        it 'raises error' do
+          expect { Youyouaidi::UUID.new param }.to raise_error ArgumentError
+        end
+      end
+
+      context 'with non-string input' do
+        let(:param) { 1234 }
+
+        it 'raises error' do
+          expect { Youyouaidi::UUID.new param }.to raise_error ArgumentError
+        end
+      end
+    end
+
+    describe '#to_s' do
+      let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+      let(:uuid) { Youyouaidi::UUID.new uuid_string }
+      subject { uuid.to_s }
+
+      it { should be_a String }
+      it { should eq uuid_string }
+    end
+
+    describe '#to_i' do
+      let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+      let(:uuid) { Youyouaidi::UUID.new uuid_string }
+      subject { uuid.to_i }
+
+      it { should be_a Bignum }
+      it { should eq 113059749145936325402354257176981405696 }
+    end
+
+    shared_examples_for 'method for short format' do
+      let(:uuid_string) { '550e8400-e29b-41d4-a716-446655440000' }
+      let(:encoded_uuid) { '_oGOAbD9fsFFEHWSMal1v' }
+      let(:uuid) { Youyouaidi::UUID.new uuid_string }
+
+      let(:action) { uuid.send method }
+      subject { action }
+
+      it { should be_a String }
+      it { should eq encoded_uuid }
+    end
+    describe '#to_short_string' do
+      let(:method) { :to_short_string }
+      it_behaves_like 'method for short format'
+    end
+    describe '#to_param' do
+      let(:method) { :to_param }
+      it_behaves_like 'method for short format'
+    end
+
+    describe '.valid_uuid?' do
+      let(:param) { '' }
+      subject { Youyouaidi::UUID.valid_uuid? param }
+
+      context 'with valid uuid' do
+        let(:param) { '550e8400-e29b-41d4-a716-446655440000' }
+
+        it { should be_true }
+      end
+
+      context 'with invalid uuid' do
+        invalid_uuids = ['Kekse', 'aa550e8400-e29b-41d4-a716-446655440000']
+
+        invalid_uuids.each do |invalid_uuid|
+          it "should return false for `#{invalid_uuid}`" do
+            expect(Youyouaidi::UUID.valid_uuid? invalid_uuid).to eq false
+          end
+        end
+      end
+    end
+  end
+end

data/youyouaidi.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'youyouaidi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'youyouaidi'
+  spec.version       = Youyouaidi::VERSION
+  spec.authors       = ['Nicolas Fricke']
+  spec.email         = ['mail@nicolasfricke.de']
+  spec.summary       = %q{UUID class}
+  spec.description   = %q{Youyouaidi offers a UUID class for parsing, validating and encoding UUIDs}
+  spec.homepage      = 'https://github.com/nicolas-fricke/youyouaidi'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: youyouaidi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nicolas Fricke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Youyouaidi offers a UUID class for parsing, validating and encoding UUIDs
+email:
+- mail@nicolasfricke.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kernel_patch.rb
+- lib/youyouaidi.rb
+- lib/youyouaidi/converter.rb
+- lib/youyouaidi/uuid.rb
+- lib/youyouaidi/version.rb
+- spec/kernel_patch_spec.rb
+- spec/spec_helper.rb
+- spec/youyouaidi/converter_spec.rb
+- spec/youyouaidi_spec.rb
+- youyouaidi.gemspec
+homepage: https://github.com/nicolas-fricke/youyouaidi
+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.2.2
+signing_key: 
+specification_version: 4
+summary: UUID class
+test_files:
+- spec/kernel_patch_spec.rb
+- spec/spec_helper.rb
+- spec/youyouaidi/converter_spec.rb
+- spec/youyouaidi_spec.rb
+has_rdoc: