with_uid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d747828b5e3863195c2e917d4200b05beba20a5
+  data.tar.gz: febb7d85430c7e84b407c2a464946161881e3b78
+SHA512:
+  metadata.gz: d59aeebfed8b0978c04fd6662b5183a2349401e2f8dfe5fae4a8032cfe380870a45db6c90b89e238ca35b836c033b5b6dad6071e6be77e909bfc1756a6d66708
+  data.tar.gz: 039e22e97d175a0bee1b98c2498372d0ddf91778b01076ff8d75ad9aeec152a4c4da85d31f05a5dcf56dfd4f0b14c86e7aa10fdcc0f54b2f84fa37562676664c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.0
+script: bundle exec rspec spec
+env: CODECLIMATE_REPO_TOKEN=

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,108 @@
+[![Build Status](https://travis-ci.org/SPBTV/with_uid.svg)](https://travis-ci.org/SPBTV/with_uid)
+
+# WithUid
+
+Generate customizable uid for your ActiveRecord models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'with_uid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install with_uid
+
+## Usage
+
+Add `uid` column to your model:
+
+    $ rails generate migration AddUidToUser uid:string -s
+
+Include WithUid module:
+
+```ruby
+class User < ActiveRecord::Base
+  include WithUid
+
+  generate_uid
+end
+```
+
+This will generate RFC 4122 compatible uid. You may specify
+block to generate `uid` according your own rule. This block
+would be executed in `User` instance context.
+
+```ruby
+class User < ActiveRecord::Base
+  include WithUid
+
+  generate_uid do
+    full_name.parameterize
+  end
+end
+```
+
+If you want to generate uid based on some `ActiveRecord` attribute
+there is a helper for that:
+
+```ruby
+class Post < ActiveRecord::Base
+  include WithUid
+
+  humanize_uid_with(:title)
+end
+```
+
+If humanized attribute is not uniq it will add some random suffix
+at the end.
+
+You can customize suffix as well:
+
+```ruby
+class Post < ActiveRecord::Base
+  include WithUid
+
+  humanize_uid_with(:title, suffix: ->(post) { post.author.uid } )
+end
+```
+
+It's also possible to add prefix to each uid:
+
+```ruby
+class Post < ActiveRecord::Base
+  include WithUid
+
+  generate_uid(prefix: 'post_')
+end
+```
+
+Both `prefix` and `suffix` may be a `String` or a `Proc`.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/SPBTV/with_uid/fork )
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+##License
+
+Copyright 2014 SPB TV AG
+
+Licensed under the Apache License, Version 2.0 (the ["License"](LICENSE)); you may not use this file except in compliance with the License.
+
+You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/with_uid.rb

@@ -0,0 +1,137 @@
+require 'active_support/concern'
+require 'securerandom'
+require 'with_uid/version'
+require 'with_uid/uid_generator'
+require 'with_uid/uid_validator'
+
+# Allow to generate nice uids for ActiveRecord objects
+#
+module WithUid
+  extend ActiveSupport::Concern
+
+  included do
+    validates :uid, presence: true
+    validates :uid, uniqueness: true, unless: :skip_uid_uniqueness?
+    validates :uid, :'with_uid/uid' => true
+  end
+
+  module ClassMethods
+    # Find record by uid
+    #
+    # @param uid [String]
+    # @return [ActiveRecord::Base]
+    # @raise [ActiveRecord::RecordNotFound] if no such record
+    # @see #find_by!
+    #
+    def by_uid!(uid)
+      find_by!(uid: uid)
+    end
+
+    # Find record by uid
+    #
+    # @param uid [String]
+    # @return [ActiveRecord::Base, nil]
+    # @see #find_by
+    #
+    def by_uid(uid)
+      find_by(uid: uid)
+    end
+
+    # Generate uid for given model
+    #
+    # @yieldreturn [String] generated uid. So you may specify the
+    #   way of generating uid.
+    # @param [Hash]
+    # @option options [String, Proc] :prefix ('') prefix for uid
+    #   inserted for each generated uid.
+    # @option options [String, Proc] :suffix (random string) for uid
+    #   inserted if uid is not uniq.
+    # @return [void]
+    #
+    # @example without block
+    #   class User < ActiveRecord::Base
+    #     generate_uid(prefix: ->(user) { user.sex })
+    #   end
+    #
+    # @example with block using user's name
+    #   class User < ActiveRecord::Base
+    #     generate_uid(prefix: 'user_') do
+    #       WithUid.format(name)
+    #     end
+    #   end
+    #
+    # If no block given it will generate uid according RFC 4122.
+    # You are free to customize this uid with +:prefix+.
+    #
+    # @example RFC 4122 uid
+    #   class User < ActiveRecord::Base
+    #     generate_uid
+    #   end
+    #
+    def generate_uid(**options, &block)
+      before_validation do
+        if block_given?
+          generate_uid(**options, &block)
+        else
+          generate_uid(**options.merge(suffix: '')) do
+            SecureRandom.uuid
+          end
+        end
+      end
+    end
+
+    # Generate uid using record's attribute
+    #
+    # @param attr [Symbol] attribute name
+    # @param options [Hash] @see #generate_uid
+    # @return [void]
+    #
+    # @example
+    #   class User < ActiveRecord::Base
+    #     humanize_uid_with(:name, prefix: 'user_')
+    #   end
+    #   user = User.create(name: 'Tema Bolshakov')
+    #   user.uid #=> "tema_bolshakov"
+    #
+    def humanize_uid_with(attr, **options)
+      generate_uid(**options) do
+        value = send(attr)
+        WithUid.format(value) if value.present?
+      end
+    end
+  end
+
+  # If you are not interested in uid uniqeness
+  # redefine this method in your model
+  # @example
+  #   class User < ActiveRecord::Base
+  #     humanize_uid_with(:name, prefix: 'user_')
+  #
+  #     def skip_uid_uniqueness?
+  #       true
+  #     end
+  #   end
+  #
+  def skip_uid_uniqueness?
+    false
+  end
+
+  def self.format(str)
+    I18n.transliterate(str.to_s).parameterize
+  end
+
+  # @api private
+  def generate_uid(**options, &block)
+    fail LocalJumpError, 'no block given' unless block_given?
+    return if uid.present?
+
+    self.uid = uid_generator(**options, &block).detect do |uid|
+      !self.class.exists?(uid: uid)
+    end
+  end
+
+  # @api private
+  def uid_generator(**options, &block)
+    UidGenerator.new(self, **options, &block)
+  end
+end

data/lib/with_uid/uid_generator.rb

@@ -0,0 +1,55 @@
+require 'active_support/core_ext/object/blank'
+
+module WithUid
+  # @api private
+  class UidGenerator
+    include Enumerable
+
+    attr_reader :context, :generator
+
+    def initialize(context, ** options, &generator)
+      @context = context
+      @generator = generator
+      @suffix = options[:suffix]
+      @prefix = options[:prefix]
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      yield uid(prefix)
+      loop do
+        next_uid = uid(prefix, suffix)
+        yield next_uid
+      end
+    end
+
+    def suffix
+      with_default(@suffix) do
+        "_#{SecureRandom.hex(3)}"
+      end
+    end
+
+    def prefix
+      with_default(@prefix) do
+        ''
+      end
+    end
+
+    private
+
+    def uid(prefix, suffix = nil)
+      [prefix, context.instance_eval(&generator), suffix].join
+    end
+
+    def with_default(value)
+      if value.respond_to?(:call)
+        value.call(context)
+      elsif value.nil?
+        yield
+      else
+        value
+      end
+    end
+  end
+end

data/lib/with_uid/uid_validator.rb

@@ -0,0 +1,21 @@
+require 'active_model/validator'
+
+module WithUid
+  # Validates uid
+  # @example required uid
+  #   validates :id, 'with_uid/uid' => true
+  #
+  # @example optional uid
+  #   validates :id, 'with_uid/uid' => { }allow_blank: true }
+  #
+  class UidValidator < ActiveModel::EachValidator
+    REGEX = /\A[0-9a-z\-_\.]+\z/i
+
+    def validate_each(record, attribute, value)
+      return if options.fetch(:allow_blank, false) && value.blank?
+      return if value =~ REGEX
+
+      record.errors[attribute] << options.fetch(:message, 'invalid format')
+    end
+  end
+end

data/lib/with_uid/version.rb

@@ -0,0 +1,3 @@
+module WithUid
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # 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://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
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+end

data/spec/support/model_with_uid.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+require 'with_uid'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ':memory:'
+)
+ActiveRecord::Base.connection
+  .create_table('model_with_uids', temporary: true) do |t|
+  t.string :name, :uid
+end
+
+class ModelWithUid < ActiveRecord::Base
+  self.primary_key = :id
+  include WithUid
+
+  generate_uid
+end

data/spec/with_uid/uid_generator_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+require 'with_uid/uid_generator'
+require 'ostruct'
+
+RSpec.describe WithUid::UidGenerator do
+  let(:name) { 'The name' }
+  let(:suffix) { '_suffix' }
+  let(:prefix) { 'prefix_' }
+  let(:binding) do
+    OpenStruct.new(name: name)
+  end
+
+  def generator(**options)
+    WithUid::UidGenerator.new(binding, **options) do
+      "#{name}-42"
+    end
+  end
+
+  context 'yielding' do
+    it 'yield uids' do
+      uids = generator(prefix: prefix, suffix: suffix).each
+      uid_from_block = uids.next
+      uid_with_suffix = uids.next
+
+      expect(uid_from_block).to eq "#{prefix}#{name}-42"
+      expect(uid_with_suffix).to eq "#{prefix}#{name}-42#{suffix}"
+    end
+
+    it 'yield uids without prefix' do
+      uids = generator(suffix: suffix).each
+      uid_from_block = uids.next
+      uid_with_suffix = uids.next
+
+      expect(uid_from_block).to eq "#{name}-42"
+      expect(uid_with_suffix).to eq "#{name}-42#{suffix}"
+    end
+
+    it 'with empty suffix' do
+      uids = generator(suffix: '').each
+      uid_from_block = uids.next
+      uid_with_suffix = uids.next
+
+      expect(uid_from_block).to eq "#{name}-42"
+      expect(uid_with_suffix).to eq "#{name}-42"
+    end
+  end
+
+  describe '#suffix' do
+    it 'default value is nil' do
+      suffix = generator.suffix
+
+      expect(suffix.size).to eq(7)
+    end
+
+    it 'default value is callable' do
+      suffix_generator = ->(context) { "#{context.name}:foo_bar" }
+      suffix = generator(suffix: suffix_generator).suffix
+
+      expect(suffix).to eq 'The name:foo_bar'
+    end
+
+    it 'default value' do
+      suffix = generator(suffix: '32').suffix
+
+      expect(suffix).to eq '32'
+    end
+  end
+
+  describe '#prefix' do
+    it 'default value is nil' do
+      prefix = generator.prefix
+
+      expect(prefix).to eq('')
+    end
+
+    it 'default value is callable' do
+      prefix_generator = ->(context) { "#{context.name}:foo_bar" }
+      prefix = generator(prefix: prefix_generator).prefix
+
+      expect(prefix).to eq 'The name:foo_bar'
+    end
+
+    it 'default value' do
+      prefix = generator(prefix: '32').prefix
+
+      expect(prefix).to eq '32'
+    end
+  end
+end

data/spec/with_uid/uid_validator_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'ostruct'
+require 'with_uid'
+require 'active_model'
+
+RSpec.describe WithUid::UidValidator do
+  ModelWithRequiredUid = Struct.new(:uid) do
+    include ActiveModel::Model
+    include ActiveModel::Validations
+
+    validates :uid, 'with_uid/uid' => true
+  end
+
+  ModelWithOptionalUid = Struct.new(:uid) do
+    include ActiveModel::Validations
+
+    validates :uid, 'with_uid/uid' => { allow_blank: true }
+  end
+
+  context 'model with required uid' do
+    subject(:model) { ModelWithRequiredUid.new }
+
+    it 'is invalid if uid is empty string' do
+      model.uid = ''
+
+      expect(model).to be_invalid
+    end
+
+    it 'is invalid if uid is nil' do
+      model.uid = nil
+
+      expect(model).to be_invalid
+    end
+
+    it 'is valid if uid is present' do
+      model.uid = '123'
+
+      expect(model).to be_valid
+    end
+
+    it 'is invalid if uid is present and contains forbidden chars' do
+      model.uid = ':/.123'
+
+      expect(model).to be_invalid
+    end
+  end
+
+  context 'model with optional uid' do
+    subject(:model) { ModelWithOptionalUid.new }
+
+    it 'is valid if uid is empty string' do
+      model.uid = ''
+
+      expect(model).to be_valid
+    end
+
+    it 'is valid if uid is nil' do
+      model.uid = nil
+
+      expect(model).to be_valid
+    end
+
+    it 'is valid if uid is present' do
+      model.uid = '123'
+
+      expect(model).to be_valid
+    end
+
+    it 'is invalid if uid is present and contains forbidden chars' do
+      model.uid = ':/.123'
+
+      expect(model).to be_invalid
+    end
+  end
+end

data/spec/with_uid_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'support/model_with_uid'
+
+RSpec.describe WithUid do
+  describe '.format' do
+    it do
+      formatted = WithUid.format('[The] unFormaTTEd, — String! & punctuations')
+      expect(formatted).to eq('the-unformatted-string-punctuations')
+    end
+  end
+
+  context 'generation' do
+    specify 'without block' do
+      model = ModelWithUid.new(name: 'b37')
+      expect do
+        model.valid?
+      end.to change {
+        model.uid
+      }.from(nil)
+    end
+
+    it 'success' do
+      model = ModelWithUid.new(name: 'b37')
+
+      model.generate_uid do
+        "#{name}-42"
+      end
+
+      expect(model.uid).to eq 'b37-42'
+    end
+
+    it 'set uid manual' do
+      model = ModelWithUid.new(uid: 'bbc', name: 'BBC')
+
+      model.generate_uid do
+        "#{name}-42"
+      end
+
+      expect(model.uid).to eq('bbc')
+    end
+
+    it 'run callbacks' do
+      model = ModelWithUid.new(uid: 'bbc', name: 'BBC')
+
+      expect(model).to receive(:generate_uid)
+
+      model.valid?
+    end
+  end
+end

data/with_uid.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'with_uid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'with_uid'
+  spec.version       = WithUid::VERSION
+  spec.authors       = ['Tema Bolshakov', 'Others']
+  spec.email         = ['abolshakov@spbtv.com']
+  spec.summary       = 'Generate customizable uid for your ActiveRecord models'
+  spec.description   = 'Generate customizable uid for your ActiveRecord models'
+  spec.homepage      = 'https://github.com/SPBTV/with_uid'
+  spec.license       = 'Apache License, Version 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4'
+  spec.add_dependency 'activemodel', '>= 4'
+  spec.add_development_dependency 'activerecord', '~> 4.2'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: with_uid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tema Bolshakov
+- Others
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Generate customizable uid for your ActiveRecord models
+email:
+- abolshakov@spbtv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/with_uid.rb
+- lib/with_uid/uid_generator.rb
+- lib/with_uid/uid_validator.rb
+- lib/with_uid/version.rb
+- spec/spec_helper.rb
+- spec/support/model_with_uid.rb
+- spec/with_uid/uid_generator_spec.rb
+- spec/with_uid/uid_validator_spec.rb
+- spec/with_uid_spec.rb
+- with_uid.gemspec
+homepage: https://github.com/SPBTV/with_uid
+licenses:
+- Apache License, Version 2.0
+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
+signing_key: 
+specification_version: 4
+summary: Generate customizable uid for your ActiveRecord models
+test_files:
+- spec/spec_helper.rb
+- spec/support/model_with_uid.rb
+- spec/with_uid/uid_generator_spec.rb
+- spec/with_uid/uid_validator_spec.rb
+- spec/with_uid_spec.rb
+has_rdoc: