uuids 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fa4c647a7c49ca3c8dc977ef4eecdb8c98d8c65
+  data.tar.gz: 5ef6df5ecc81765ed887afb31ee8c9c76f065930
+SHA512:
+  metadata.gz: e5a8eb30e3fb60615ad8ed955a9978519e73c3aefbb5db98413228fdcdc64f40d6d74d33ed7c35fb7e8c51854fdf38bdd39929dbc942bc3094816b153c0b1ebe
+  data.tar.gz: 581d68f4bc69eb48b28050f746cc744d89493b6cb156706cbf536767269ec1a16965ffcf37e665ffef58de4a55f73393cd6e43618e74b1aeb08e43f3b0cccbc1

data/.rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'Rakefile'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/RescueException:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'spec/**/*'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'db/**/*'
+
+Style/EmptyLinesAroundBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'db/**/*'
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'Gemfile'
+    - '*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Exclude:
+    - 'spec/**/*'

data/LICENSE.rdoc

@@ -0,0 +1,21 @@
+= The MIT License
+
+Copyright (c) 2014 Andrew Kozin, https://github.com/nepalez
+
+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.rdoc

@@ -0,0 +1,154 @@
+= UUIDs
+
+{<img src="http://img.shields.io/gem/v/uuids.svg?style=flat" alt="Gem Version" />}[https://rubygems.org/gems/uuids]
+{<img src="http://img.shields.io/travis/nepalez/uuids.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/uuids]
+{<img src="http://img.shields.io/codeclimate/github/nepalez/uuids.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/uuids]
+{<img src="http://img.shields.io/gemnasium/nepalez/uuids.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/uuids]
+{<img src="http://img.shields.io/coveralls/nepalez/uuids.svg?style=flat" alt="Coverage Status" />}[https://coveralls.io/r/nepalez/uuids]
+{<img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" />}[https://github.com/nepalez/uuids/blob/master/LICENSE.rdoc]
+
+== About
+
+Defines a model +Uuid+ to store {UUIDs}[http://en.wikipedia.org/wiki/Universally_Unique_Identifier] assigned to various AR records.
+
+It is expected any uuid is assigned to one record, but a record can be
+identified by many uuids.
+
+The gem is a {mountable Rails engine}[http://guides.rubyonrails.org/engines.html#generating-an-engine].
+
+=== Pattern
+
+This model allows refering records by some uuid (not the id).
+
+If necessary any referred record can be merged with another one.
+If you reassign all their uuids to merged record then any references remains
+valid without tracking and changing them before merge.
+
+A uuid should be neither deleted, no changed. It can only be reassigned to
+another resource. The records can be deleted 
+
+* by merging to another ones;
+* by explicitly marking as deleted without physical removal.
+
+=== Example
+
+Suppose you have models referred to cities. One day you discover
+a duplication among cities: the "New York" and the "NEW YORK".
+
+You should:
+
+* reassign both uuids to "New York";
+* safely remove the "NEW YORK" record.
+
+You needn't track all records that refer to "NEW YORK". All those references
+will authomatically lead to merged record via old uuid.
+
+=== Standards
+
+The Uuid is generated authomatically following the
+{RFC4122}[http://www.ietf.org/rfc/rfc4122.txt] standard. The generation uses the
++sequrerandom+ Ruby library.
+
+This allows keeping all uuids in one model and referring to any record whatever
+type it has.
+
+=== Models
+
+A model <tt>Uuids::Uuid</tt> has two attributes: +value+ and +record+.
+Only the +record+ can (and must) be set and changed.
+The readonly +value+ (the uuid itself) is assigned by default.
+
+=== Translations
+
+Error messages are translated to English and Russian (see `config/locales`).
+Translations to other languages are welcome.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem "uuids"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uuids
+
+Then run from a command line in application root:
+
+    $ rake uuids:install
+
+== Usage
+
+Add the assotiation to your AR model:
+
+    class YourModel < ActiveRecord::Base
+      has_many :uuids, class_name: "Uuids::Uuid", as: :record, dependent: :destroy
+      ...
+    end
+
+Note the <tt>dependent: :destroy</tt> condition! It prevents a record from
+destruction before a corresponding uuids reassigned to another record.
+
+Then add a callback for uuid creation:
+
+    class YourModel < ActiveRecord::Base
+      ...
+      # create the uuid by default
+      before_create -> { uuids.new }
+      ...
+    end
+
+Now you can add reference to your model via uuid:
+
+    class CreateAnotherModelTable < ActiveRecord::Migration
+      def change
+        create_table :another_models do |t|
+          t.string :your_model_uuid, limit: 36
+        end
+        add_index :another_models, :your_model_uuid
+      end
+    end
+
+    class AnotherModel < ActiveRecord::Base
+
+      def your_model
+        @your_model ||= YourModel.join(:uuids).where(uuids: { value: your_model_uuid }).first
+      end
+
+      def your_model=(value)
+        @your_model_uuid ||= Uuids::Uuid.find_by_record(value)
+      end
+    end
+
+== Uninstallation
+
+Run from a command line in application root:
+
+    $ rake uuids:uninstall
+
+== Contributing
+
+1. Fork it ( https://github.com/nepalez/uuids/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 a new Pull Request
+
+== TODO
+
+Redefine AR::Base class methods +has_one+ and +has_many+ to allow reference
+by uuid:
+
+    class MyModel < ActiveRecord::Base
+      extend Uuids
+
+      has_one :another_model, uuid: true
+    end
+
+== License
+
+The plugin is distributed under {MIT license}[https://github.com/nepalez/uuids/blob/master/LICENSE.rdoc]

data/Rakefile

@@ -0,0 +1,41 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+begin
+  require "rdoc/task"
+rescue LoadError
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Uuids"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include "README.rdoc"
+  rdoc.rdoc_files.include "lib/**/*.rb"
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_RAKEFILE = File.expand_path "../spec/dummy/Rakefile", __FILE__
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new :spec
+task :default do
+  sh "bundle exec rake db:migrate RAILS_ENV=test"
+  sh "bundle exec rspec spec"
+end
+
+task full: [:default] do
+  sh "rubocop"
+  sh "metric_fu"
+  sh "inch"
+end

data/app/models/uuids/uuid.rb

@@ -0,0 +1,53 @@
+module Uuids
+
+  # Stores uuids assigned to corresponding records.
+  #
+  # == Attributes:
+  #
+  # +value+:: A value of uuid as defined in
+  #           {RFC4122}[http://www.ietf.org/rfc/rfc4122.txt].
+  #           Assigned by default on creation. Cannot be set or edited manually.
+  # +record+:: An AR record the uuid is assigned to.
+  #            Required attribute. Can be changed.
+  #
+  # == Examples:
+  #
+  #     # Create the uuid
+  #     uuid = Uuids::Uuid.create! record: some_record
+  #
+  #     # Find a record by uuid
+  #     Uuid.find_by_value(uuid.value).record # => some_record
+  #
+  #     # Reassigns a uuid to another record
+  #     uuid.update_attributes! record: another_record
+  #
+  class Uuid < ActiveRecord::Base
+
+    belongs_to     :record, polymorphic: true
+    validate       :record_present?
+    before_destroy :forbid_destruction
+
+    # Assigns a #value by default.
+    def initialize(*)
+      super
+      write_attribute :value, SecureRandom.uuid
+    end
+
+    private
+
+    # Disables value assignment.
+    attr_writer :value
+
+    # Validates record presence with a custom error message.
+    def record_present?
+      return if record
+      errors.add :record, :blank, uuid: value
+    end
+
+    # Forbids destruction of the record.
+    def forbid_destruction
+      errors.add :base, :destruction_forbidden
+      false
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  activerecord:
+    errors:
+      models:
+        uuids/uuid:
+          attributes:
+            base:
+              destruction_forbidden: "Destruction of UUID is forbidden. Instead of destruction reassign the UUID to another record!"
+            record:
+              blank: "Define a record the UUID: %{uuid} is assigned to!"

data/config/locales/ru.yml

@@ -0,0 +1,10 @@
+ru:
+  activerecord:
+    errors:
+      models:
+        uuids/uuid:
+          attributes:
+            base:
+              destruction_forbidden: "Удаление UUID запрещено. Вместо удаления перенаправьте UUID на другую запись!"
+            record:
+              blank: "Укажите запись, на которую ссылается UUID: %{uuid}!"

data/db/migrate/20141016112506_create_uuids_uuids.rb

@@ -0,0 +1,9 @@
+class CreateUuidsUuids < ActiveRecord::Migration
+  def change
+    create_table :uuids_uuids do |t|
+      t.string     :value,  limit: 36, null: false
+      t.references :record, polymorphic: true, null: false, index: true
+    end
+    add_index :uuids_uuids, :value, unique: true
+  end
+end

data/lib/tasks/uuids_tasks.rake

@@ -0,0 +1,41 @@
+namespace :uuids do
+
+  desc "Installs the uuids gem inside a Rails application"
+  task install: %w(install:migrations) do
+    sh "rake db:migrate SCOPE=uuids"
+  end
+
+  desc "Uninstalls and removes the uuids gem from a Rails application"
+  task :uninstall do
+    sh "rake db:rollback SCOPE=uuids"
+    say do
+      remove_from_file "Gemfile", /gem\s+["|']uuids["|']/
+      Dir["*.gemspec"].each do |gemspec|
+        remove_from_file gemspec, /_dependency\s+["|']uuids["|']/
+      end
+    end
+    sh "bundle"
+  end
+
+  def remove_from_file(name, regex)
+    say_with_time name do
+      temp = File.read(name).split("\n")
+        .reject { |line| line[regex] }.join("\n")
+      File.write(name, temp)
+    end
+  end
+
+  def say
+    print "== Removing the 'uuids' gem" \
+          " ===================================================\n"
+    yield
+    print "\n"
+  end
+
+  def say_with_time(name)
+    start = Time.now.to_f
+    print "-- remove from #{ name }\n"
+    yield
+    print "   -> #{ (Time.now.to_f - start).round(4) }s\n"
+  end
+end

data/lib/uuids/engine.rb

@@ -0,0 +1,12 @@
+module Uuids
+
+  # Rails Engine settings
+  class Engine < ::Rails::Engine
+    isolate_namespace Uuids
+
+    config.generators do |generator|
+      generator.test_framework :rspec, fixture: true, view_specs: true
+      generator.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+  end
+end

data/lib/uuids/version.rb

@@ -0,0 +1,4 @@
+# Current release.
+module Uuids
+  VERSION = "0.0.1"
+end

data/lib/uuids.rb

@@ -0,0 +1,7 @@
+require "rails"
+require "securerandom"
+require "uuids/engine"
+
+# Namespace for a module
+module Uuids
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/record.rb

@@ -0,0 +1,3 @@
+class Record < ActiveRecord::Base
+  has_many :uuids, class_name: "Uuids::Uuid", as: :record
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "uuids"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end