uuids 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab2fee573db51b09e456f46051b38e4a4bb191a9
-  data.tar.gz: 86a0819f977fb1866d60c286bffda28d090285c5
+  metadata.gz: 3d62f7dd03a435e8bba46acb72812918a4eba1b0
+  data.tar.gz: 3e94d4a3a0633b637b8c71a1bacec93f9d843f11
 SHA512:
-  metadata.gz: 360f89779357fc89de36f625aac37ea2f8d16516e981f3428f92fe49574c43b11b2982769a02403630e9a18e1abf2f501d8c10e6d87330d819006a698757b2cc
-  data.tar.gz: d88f464eeb0923ea24a0405f4aa4a45b4630beaea14ab14afdbff61817d29aaa53a80dd703418ee091c632e366ca7db10a52e43693dc77bc2d2e390ee7a06b1e
+  metadata.gz: 1d637e584a7da88119ded6750a33ebf69fc3acaf29292a4ed550eef08a3907ee71a35d41229c058eb97f28b29259de6db41e6eaa2662c46f7aada4fe981d95fa
+  data.tar.gz: 723ad1cd61231f1984fb4ef327052b195a86ab892b20fc81e3bc3da07c5d3f0bfaef793d44dd3c66db558473c55258ac1244d02e59cb4e30d6d6e5485d5b3743

data/.rubocop.yml

@@ -3,6 +3,10 @@ AllCops:
     - 'spec/dummy/**/*'
     - 'Rakefile'
 
+Lint/Eval:
+  Exclude:
+    - 'spec/**/*'
+
 Lint/HandleExceptions:
   Exclude:
     - 'spec/**/*'

data/README.rdoc

@@ -9,29 +9,27 @@
 
 == About
 
-The gem adds addressing ActiveRecord objects by {UUID}[http://en.wikipedia.org/wiki/Universally_Unique_Identifier]s following the {RFC4122}[http://www.ietf.org/rfc/rfc4122.txt]
+The gem allows addressing ActiveRecord objects by {UUID}[http://en.wikipedia.org/wiki/Universally_Unique_Identifier]s following the {RFC4122}[http://www.ietf.org/rfc/rfc4122.txt]
 standard.
 
-It provides:
-
-<tt>Uuids::Uuid</tt>:: A model of UUIDs associated with various records.
-<tt>Uuids::Base</tt>:: A module provides ActiveRecord class helpers +has_uuids+ and +has_many+ (with <tt>uuid: true</tt> option).
-
-The gem is a {mountable Rails engine}[http://guides.rubyonrails.org/engines.html#generating-an-engine].
+The gem requires Ruby 2.1+ and ActiveRecord 3.1+. It doesn't depend on full
+stack Rails and can be used in domain apps based on ActiveRecord.
 
 === Pattern
 
-This model allows adressing records by some UUID (not the ID).
-It is expected any UUID is assigned to one record, but a record can be
+The module allows adressing records by UUID(s) instead of ID. A record can be
 identified by many UUIDs.
 
-If necessary any referred record can be merged with another one.
-All you need is to reassign all UUIDs to merged record and outer associations
-remains valid.
+This makes it possible to merge records without touching external to the
+records.
+
+For merging records it's sufficient to:
 
-A **UUID** should be neither deleted, no changed. It can only be reassigned to
-another resource. On ther other hand, the outer record should be merged to
-another one (reassign UUIDs) to prevent existance of UUIDs assigned to nothing.
+* reassign all their uuids to the united record.
+* destroy old records, which no uuid refers to.
+
+Whatever external models are referred by uuid to the deleted records, that
+references remains valid and will lead to the united record.
 
 === Example
 
@@ -48,11 +46,6 @@ will authomatically lead to merged record via old UUID.
 
 Now the model of cities should **know nothing about outer models** that use it.
 
-=== Translations
-
-Error messages are translated to English and Russian (see <tt>config/locales</tt>).
-Translations to other languages are welcome.
-
 == Installation
 
 Add this line to your application's Gemfile:
@@ -69,25 +62,27 @@ Or install it yourself as:
 
 == Initialization
 
-To initialize the module you need to copy and run uuid's db migrations.
-
-=== Rails application
+After installation you should copy and run uuid's db migration into your module.
 
-Run from a command line in application root:
+When you install the module to a final application, the migration should be
+installed to `db/migrate` path directly.
 
-    $ rake uuids:install
+    $ uuids install
 
-=== Rails mountable engine
+When you install the module to another gem as a part of its environment,
+the migration isn't a part of your project. It only needed for testing
+your gem in a proper environment.
 
-Run from a command line in application root:
+In this case the migration should be installed to a dummy app in a
+`spec/dummy/db/migrate` folder. Do it with the `-d` key:
 
-    $ rake app:uuids:install
+    $ uuids install -d
 
 == Usage
 
 === Adding UUIDs to models
 
-Add the assotiation to your AR model:
+Add the assotiation to your AR model with a `has_uuids` helper:
 
     class City < ActiveRecord::Base
       include Uuids::Base
@@ -97,30 +92,31 @@ Add the assotiation to your AR model:
 This will add methods:
 
 +#uuids+:: List of <tt>Uuids::Uuid</tt> objects referred to the record.
-+#uuid+:: main UUID for the record - a value of the first +uuids+ (ordered by value).
 <tt>#uuid=(value)</tt>:: assigns the UUID (an alias for <tt>#uuids.new value: value</tt>).
++#uuid+:: main UUID for the record - a value of the first +uuids+ (ordered by value).
 <tt>.by_uuid(*values)</tt>:: A scope for selecting unique records by UUID.
 
 The first uuid is added by default. It can also be set manually:
     
-    # UUID is generated by default
+    # UUID generated by default:
     city = City.create!
     city.uuid.nil?
     # => false
 
-    # UUID is assigned manually
-    city = City.create! uuid: "6d9456a9-8f54-4ff7-ba0d-9854f1954417"
+    # UUID(s) assigned manually:
+    city = City.create! uuids: "6d9456a9-8f54-4ff7-ba0d-9854f1954417"
     city.uuid
     # => "6d9456a9-8f54-4ff7-ba0d-9854f1954417"
 
-The destruction of object is forbidden if it has a +uuid+. You should reassign
-all object's UUIDs to another object in advance.
+Destruction of object is forbidden while it has a +uuid+. You should reassign
+all object's UUIDs to another record in advance.
 
 === Referring model by UUID
 
 Instead of <tt>ActiveRecord::Associations</tt> +belongs_to+, +has_one+ and
 +has_many+, you should define custom methods explicitly.
 
+    # db/migrate/*_create_streets.rb
     class CreateStreetsTable < ActiveRecord::Migration
       def change
         create_table :streets do |t|
@@ -130,6 +126,7 @@ Instead of <tt>ActiveRecord::Associations</tt> +belongs_to+, +has_one+ and
       end
     end
 
+    # app/models/street.rb
     class Street < ActiveRecord::Base
 
       scope :by_city, ->(city) { City.by_uuid(city.uuid) }

data/Rakefile

@@ -1,44 +1,30 @@
 begin
-  require "bundler/setup"
+  require "bundler/gem_tasks"
 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"
+  system "gem install bundler"
+  system "bundle install"
 end
 
+# Adds bundler tasks
 Bundler::GemHelper.install_tasks
 
-APP_RAKEFILE = File.expand_path "../spec/dummy/Rakefile", __FILE__
-load "rails/tasks/engine.rake"
-
-require "bundler/gem_tasks"
+# Adds RSpec tasks.
 require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
 
-RSpec::Core::RakeTask.new :spec
+# Adds dummy:db tasks.
+load "spec/dummy/Rakefile"
 
-task :default do
-  system "rake db:migrate RAILS_ENV=test"
+# Declares gem's own tasks.
+desc "Runs test suite."
+task default: %w(dummy:db:migrate dummy:db:reset) do
   system "bundle exec rspec spec"
 end
 
+desc "Runs code metrics."
 task :check do
   system "coveralls report"
   system "rubocop"
-  system "metric_fu"
   system "inch --pedantic"
-  system "rails_best_practices"
+  system "metric_fu"
 end

data/app/models/uuids/uuid.rb

@@ -20,6 +20,7 @@ module Uuids
   #     uuid.update_attributes! record: another_record
   #
   class Uuid < ActiveRecord::Base
+    self.table_name = :uuids_uuids
 
     # A format for UUID following RFC4122
     UUID_FORMAT = /[a-z\d]{8}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{12}/

data/bin/uuids

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require "uuids"
+
+# Runs the generator.
+#
+# @example
+#     $ uuids install
+#
+# To see additional options call
+#
+#     $ uuids install -h
+#
+Uuids::Generators::Install.start

data/lib/uuids/base/has_uuids.rb

@@ -24,7 +24,7 @@ module Uuids
         #     # => #<ActiveRecord::Relation ...>
         #
         # Params:
-        # <tt>values</tt>:: a list of string uuids values to select records by.
+        # <tt>*values</tt>:: a list of uuids to select records by.
         #
         # Returns the <tt>ActiveRecord::Relation</tt> object.
         #
@@ -76,8 +76,8 @@ module Uuids
       # <tt>values</tt>:: an array of uuids string values to assign.
       #
       def uuids=(*values)
-        first_value = values.first
-        list        = first_value.is_a?(Array) ? first_value : values
+        first = values.first
+        list  = first.is_a?(Array) ? first : values
         list.each { |value| self.uuid = value }
       end
 

data/lib/uuids/generators/install/migration.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require_relative "../install"
+
+module Uuids
+  module Generators
+    class Install
+
+      # Description for migration to copy.
+      #
+      # @example
+      #     migration = Migration.new(
+      #       "/uuids/db/migrate/20141016112506_create_uuids_uuids.rb"
+      #     )
+      #     migration.source
+      #     # => "/uuids/db/migrate/20141016112506_create_uuids_uuids.rb"
+      #     migration.target
+      #     # => "20150101000001_create_uuids_uuids.uuids.rb"
+      #     migration.content
+      #     # => returns uuids content.
+      #
+      class Migration
+
+        # A source file for migration.
+        attr_reader :source
+
+        # Initializes the migration from given source file.
+        #
+        # @example
+        #     migration = Migration.new(
+        #       "/uuids/db/migrate/20141016112506_create_uuids_uuids.rb"
+        #     )
+        #
+        # Params:
+        # +source+:: A file name to initalize a migration from.
+        #
+        def initialize(source)
+          @source = source
+        end
+
+        # Returns a target file name to copy the migration to.
+        def target
+          @target ||= "#{ timestamp }#{ basename }.uuids.rb"
+        end
+
+        # Returns the migration content .
+        def content
+          @content ||= File.read source
+        end
+
+        private
+
+        def timestamp
+          @timestamp ||= Time.now.utc.strftime "%Y%m%d%H%M%S"
+        end
+
+        def basename
+          @basename ||= File.basename(source, ".rb")[14..-1]
+        end
+      end
+    end
+  end
+end

data/lib/uuids/generators/install.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require "thor"
+
+module Uuids
+
+  # A namespace for +Uuids+ thor-based generators.
+  module Generators
+
+    # An installer for the module. Copies module migration to external gem.
+    #
+    # @example
+    #     installer = Uuids::Generators::Install.start [], { dummy: true }
+    #     # => creates `spec/dummy/db/migrage/{timestamp}_uuids_uuids.uuids.rb
+    #
+    # Options:
+    # <tt>dummy:</tt> (optional, boolean, default: false)
+    #     ... flag to copy migrations to a dummy app. If not set, the migration
+    #     will be added to the root `db/migrate` folder.
+    #
+    # Adds the "uuids" gem's migration to a module that uses the gem.
+    #
+    class Install < Thor::Group
+      include Thor::Actions
+
+      class_option(
+        :dummy,
+        aliases: "-d",
+        default: false,
+        desc: "Copy migrations to dummy (`spec/dummy/db/migrate`) folder.",
+        required: false,
+        type: :boolean
+      )
+
+      class_option(
+        :folder,
+        aliases: "-f",
+        desc: "A folder to copy migrations to (`given_folder/db/migrate`).",
+        required: false,
+        type: :string
+      )
+
+      # Creates a folder for migrations.
+      def prepare_folder
+        empty_directory dir, skip: true
+      end
+
+      # Copies migrations to proper folder
+      def copy_migrations
+        migrations.each do |migration|
+          FileUtils.copy_file(
+            migration.source,
+            "#{ destination_root }/#{ dir }#{ migration.target }",
+            migration.content
+          )
+        end
+      end
+
+      private
+
+      def dir
+        @dir ||= "#{ folder || dummy || "" }db/migrate/"
+      end
+
+      def folder
+        @folder ||= begin
+          folder = options["folder"]
+          folder ? "#{ folder }/" : nil
+        end
+      end
+
+      def dummy
+        @dummy ||= "spec/dummy/" if options["dummy"]
+      end
+
+      def sources
+        @sources ||= Dir[File.expand_path "../../db/migrate/*.rb"]
+      end
+
+      def migrations
+        @migrations ||= sources.map { |source| Migration.new source }
+      end
+    end
+  end
+end

data/lib/uuids/version.rb

@@ -2,5 +2,5 @@
 module Uuids
 
   # Current release.
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/uuids.rb

@@ -1,8 +1,10 @@
-require "rails"
+# Dependencies
+require "active_record"
+require "i18n"
 require "securerandom"
-require "uuids/engine"
-require "uuids/base"
 
-# Namespace for a module
-module Uuids
+# Loads gem content.
+root = File.expand_path "../..", __FILE__
+%w(lib app).each do |dir|
+  Dir[File.join(root, dir, "/**/*.rb")].each { |f| require f }
 end

data/spec/dummy/Rakefile

@@ -1,6 +1,19 @@
-# 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.
+# ==============================================================================
+# Loads ActiveRecord tasks for dummy db.
+# ==============================================================================
 
-require File.expand_path('../config/application', __FILE__)
+require "active_record"
+require "bundler/setup"
 
-Rails.application.load_tasks
+namespace :dummy do
+
+  task :environment do
+    require_relative "config/environment.rb"
+  end
+
+  namespace :db do
+    task load_config: :environment
+  end
+
+  load "active_record/railties/databases.rake"
+end

data/spec/dummy/config/database.yml

@@ -1,25 +1,9 @@
-# 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.
+# ==============================================================================
+# ActiveRecord connections settings for corresponding environments.
+# ==============================================================================
+---
 test:
-  <<: *default
-  database: db/test.sqlite3
-
-production:
-  <<: *default
-  database: db/production.sqlite3
+  adapter:  :sqlite3
+  database: spec/dummy/db/test.sqlite3
+  pool:     5
+  timeout:  5000

data/spec/dummy/config/environment.rb

@@ -1,5 +1,29 @@
-# Load the Rails application.
-require File.expand_path('../application', __FILE__)
+# ==============================================================================
+# Configures database and establishes ActiveRecord connections.
+# ==============================================================================
 
-# Initialize the Rails application.
-Rails.application.initialize!
+# Loads all initializers including Dummy::Application and Dummy::SeedLoader.
+Dir[File.expand_path("../initializers/*.rb", __FILE__)].each { |f| require f }
+
+# Paths to dummy and application roots.
+root     = Dummy.root
+app_root = Dummy.app_root
+
+# Configures databases and establishes ActiveRecord connections.
+Dummy::Application.configure do |config|
+
+  # Paths to database and migrations
+  database_yml = File.read(File.join root, "config/database.yml")
+  migrations   = [root, app_root].map { |path| File.join(path, "db/migrate") }
+
+  # Config setting
+  config.database_configuration = YAML.load database_yml
+  config.db_dir                 = File.join(root, "db")
+  config.env                    = ENV["ENV"] || :test
+  config.fixtures_path          = File.join(app_root, "spec/fixtures")
+  config.migrations_paths       = migrations
+  config.root                   = root
+  config.seed_loader            = Dummy::SeedLoader.new
+
+  # ActiveRecord connections established authomatically after yielding the block
+end

data/spec/dummy/config/initializers/application.rb

@@ -0,0 +1,37 @@
+require "active_record"
+
+module Dummy
+
+  # Storage for application settings.
+  #
+  # @example
+  #     Dummy::Application.configure do |config|
+  #       config.env = :test
+  #     end
+  #
+  class Application
+    class << self
+
+      # Configuration settings wrapper for the
+      # <tt>ActiveRecord::Tasks::DatabaseTasks</tt>.
+      #
+      # Establishes AR connection after configuration.
+      #
+      def configure
+        yield tasks
+        base.configurations = tasks.database_configuration
+        base.establish_connection(tasks.env)
+      end
+
+      private
+
+      def base
+        @base ||= ActiveRecord::Base
+      end
+
+      def tasks
+        @tasks ||= ActiveRecord::Tasks::DatabaseTasks
+      end
+    end
+  end
+end

data/spec/dummy/config/initializers/dummy.rb

@@ -0,0 +1,13 @@
+# Namespace for dummy module.
+module Dummy
+
+  # Path to dummy root.
+  def self.root
+    @root ||= File.expand_path "../../..", __FILE__
+  end
+
+  # Path to application root.
+  def self.app_root
+    @app_root ||= File.expand_path "../..", root
+  end
+end

data/spec/dummy/config/initializers/seed_loader.rb

@@ -0,0 +1,44 @@
+require_relative "dummy"
+
+module Dummy
+
+  # Loads dummy application and then loads seeds from both root and dummy
+  # applications.
+  #
+  # @example
+  #     SeedLoader.new.load_seed
+  #
+  class SeedLoader
+
+    # List of files to be loaded.
+    attr_accessor :seed_files
+
+    # Initializes the loader with files to be loaded.
+    def initialize
+
+      # Adds dummy application.
+      self.seed_files = [File.join(root, "lib/dummy.rb")]
+
+      # Adds dummy seed if exists.
+      self.seed_files += Dir[File.join(root, "db/seed.rb")]
+
+      # Adds root application seed if exists.
+      self.seed_files += Dir[File.join(app_root, "db/seed.rb")]
+    end
+
+    # Loads seed files.
+    def load_seed
+      seed_files.each { |file| require file }
+    end
+
+    private
+
+    def root
+      @root ||= Dummy.root
+    end
+
+    def app_root
+      @app_root ||= Dummy.app_root
+    end
+  end
+end

data/spec/dummy/lib/dummy.rb

@@ -0,0 +1,16 @@
+# ==============================================================================
+# Configures ActiveRecord and loads dummy with gem application.
+# ==============================================================================
+
+# Configures environment.
+# Among others loads the +Dummy+ module from `config/initializers/dummy.rb`
+require_relative "../config/environment"
+
+# Loads lib folder content.
+Dir[File.join(Dummy.root, "lib/**/*.rb")].each { |f| require f }
+
+# Loads app folder content.
+Dir[File.join(Dummy.root, "app/**/*.rb")].each { |f| require f }
+
+# Loads application.
+Dir[File.join(Dummy.app_root, "lib/*.rb")].each { |f| require f }

data/spec/{support/initializers → initializers}/database_cleaner.rb

@@ -1,11 +1,7 @@
 require "database_cleaner"
-require "rspec/rails"
 
 RSpec.configure do |config|
 
-  # stop wrapping each of test examples within a transaction
-  config.use_transactional_fixtures = false
-
   config.before :suite do
     DatabaseCleaner.clean_with :truncation
   end

data/spec/{support/initializers/factory_girl_rails.rb → initializers/factory_girl.rb}

@@ -1,4 +1,4 @@
-require "factory_girl_rails"
+require "factory_girl"
 
 RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods