synchronisable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c6231d919aeea7c551da1351dba4db462798844
+  data.tar.gz: ec360d12bced3a06caaa0a7ab9d1e14ab0c04f98
+SHA512:
+  metadata.gz: a5a2d9ac8417ffd54525181be9e0e14115c45db9bec1782a2b2b2e92be55c1b39540d0a050eacf5f18ed55b794ca8878d5e0e276ff61e64d08da1671809fa63e
+  data.tar.gz: 3872b79375882a55d5b4cbc5631b2dc2f96413047e18c0e09692a149242dcfa6b137e925755399b580bf3250f7dcd23cb90a21af65b2cf459c23a5cdd652dbc8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--format Nc

data/.ruby-version

@@ -0,0 +1,2 @@
+2.1.0
+

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'
+gem 'byebug'
+gem 'pry-byebug'
+
+gem 'rspec-nc' if RUBY_PLATFORM =~ /darwin/

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+guard 'spork' do
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vasiliy Yorkin
+
+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,22 @@
+[![Build Status](https://travis-ci.org/vyorkin/synchronizable.png?branch=master)](https://travis-ci.org/vyorkin/synchronizable)
+
+# Synchronizable
+
+Provides base fuctionality (models, DSL) for AR synchronization with external resources (apis, services etc)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'synchronizable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synchronizable
+
+## Usage
+

data/Rakefile

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

data/TODO.md

@@ -0,0 +1,20 @@
+Primary objectives
+======================================
+* general tests (DONE)
+* except/only (DONE)
+* sync method (DONE)
+* dependent syncronization & mapping (DONE)
+* tests for Synchronizable.sync (DONE)
+* destroy_missed
+* worker.rb refactoring
+* integrate with travis, stillmaintained, gemnasium
+* write a good README
+* extended interface
+  * sync with include
+  * sync with ids array
+  * sync method for collection proxy (Model.where(condition).sync)
+
+Secondary objectives
+======================================
+* option for verbose logging (DONE)
+* colorized STDOUT

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/generators/synchronizable/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Generates (but does not run) a migration to add an imports table.

data/lib/generators/synchronizable/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Synchronizable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Generates (but does not run) a migration to add an imports table.'
+
+    def create_migration_file
+      migration_template 'create_imports_migration.rb', 'db/migrate/create_imports.rb'
+    end
+
+    def create_initializer_file
+      copy_file 'initializer.rb', 'config/initializers/synchronizable.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/synchronizable/templates/create_imports_migration.rb

@@ -0,0 +1,21 @@
+class CreateImports < ActiveRecord::Migration
+  def self.up
+    create_table :imports do |t|
+      t.string  :synchronizable_type, null: false
+      t.integer :synchronizable_id, null: false
+      t.text    :attrs
+      t.string  :remote_id, null: false
+
+      t.timestamps
+    end
+
+    add_index :imports, :remote_id
+    add_index :imports, [:synchronizable_type, :synchronizable_id]
+  end
+
+  def self.down
+    remove_index :imports, :remote_id
+    remove_index :imports, [:synchronizable_type, :synchronizable_id]
+    drop_table :imports
+  end
+end

data/lib/generators/synchronizable/templates/initializer.rb

@@ -0,0 +1,14 @@
+Synchronizable.configure do |config|
+  # Logging configuration
+  #
+  # config.logging = {
+  #   :verbose  => true,
+  #   :colorize => true
+  # }
+
+  # If you want to restrict synchronized models.
+  # By default it will try to sync all models that have
+  # a `synchronizable` dsl instruction.
+  #
+  # config.models = %w(Foo Bar)
+end

data/lib/synchronizable.rb

@@ -0,0 +1,92 @@
+require 'active_record'
+
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/object/deep_dup'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/configurable'
+require 'active_support/concern'
+
+require 'i18n'
+
+require 'synchronizable/version'
+require 'synchronizable/models/import'
+require 'synchronizable/synchronizer'
+require 'synchronizable/model'
+
+locale_paths = File.join(File.dirname(__FILE__),
+  'synchronizable', 'locale', '*.yml')
+
+Dir[locale_paths].each { |path| I18n.load_path << path }
+I18n.backend.load_translations unless defined?(Rails)
+
+I18n.config.enforce_available_locales = true
+I18n.default_locale = :en
+I18n.available_locales = [:en, :ru]
+
+# The desired interface:
+# ><(((*>
+#
+# + Model.sync
+# + Model.sync([{},...])
+#
+# Match.sync(:include => {
+#   :match_players => :player
+# })
+# Model.sync([id1, ..., idn])
+#
+# Model.where(condition).sync
+# Match.where(condition).sync(:include => {
+#   :match_players => :player
+# })
+
+module Synchronizable
+  include ActiveSupport::Configurable
+
+  config_accessor :models do
+    {}
+  end
+  config_accessor :logging do
+    {
+      :verbose  => true,
+      :colorize => true
+    }
+  end
+
+  # Syncs models that is defined in {Synchronizable#models}
+  #
+  # @param models [Array] array of models that should be synchronized.
+  #   This take a precedence over models defined in {Synchronizable#models}.
+  #   If this parameter is not specified and {Synchronizable#models} is empty,
+  #   than it will try to sync only those models which have a corresponding synchronizers.
+  #
+  # @return [Array<[Synchronizable::Context]>] array of synchronization contexts
+  #
+  # @see Synchronizable::Context
+  def self.sync(*models)
+    source = source_models(models)
+    source.map(&:sync)
+  end
+
+  private
+
+  def self.source_models(models)
+    source = models.present? ? models : default_models
+    source = source.present? ? source : find_models
+  end
+
+  def self.default_models
+    models.map(&:safe_constantize).compact
+  end
+
+  def self.find_models
+    ActiveRecord::Base.descendants.select do |model|
+      model.included_modules.include?(Synchronizable::Model)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include Synchronizable::Model
+end

data/lib/synchronizable/context.rb

@@ -0,0 +1,25 @@
+module Synchronizable
+  # Synchronization context.
+  class Context
+    attr_accessor :model, :errors,
+                  :before, :after, :deleted
+
+    def initialize(model, parent)
+      @model, @parent  = model, parent
+      @errors = []
+      @before, @after, @deleted = 0, 0, 0
+    end
+
+    # @return [String] summary synchronization info.
+    def summary_message
+      I18n.t('messages.result',
+        :model   => model,
+        :parent  => @parent.try(:model),
+        :before  => before,
+        :after   => after,
+        :deleted => deleted,
+        :errors  => errors.count
+      )
+    end
+  end
+end

data/lib/synchronizable/dsl/associations.rb

@@ -0,0 +1,57 @@
+require 'synchronizable/dsl/associations/has_one'
+require 'synchronizable/dsl/associations/has_many'
+
+module Synchronizable
+  module DSL
+    module Associations
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :associations
+        self.associations = {}
+      end
+
+      module ClassMethods
+        [HasOne, HasMany].each do |klass|
+          macro = klass.to_s.demodulize.underscore.to_sym
+          define_method(macro) do |name, options = {}|
+            klass.create(self, name, options)
+          end
+        end
+
+        # Builds hash with association as key and array of ids as value.
+        #
+        # @param attrs [Hash] local record attributes
+        #
+        # @return [Hash<Synchronizable::Association, Array>] associations hash
+        #
+        # @raise [MissedAssocationsError] raised when the given
+        #   attributes hash doesn't required associations
+        def associations_for(attrs)
+          ensure_required_associations(attrs)
+          intersection = self.associations.map { |key, _| key } & attrs.keys
+
+          Hash[intersection.map { |key|
+            [self.associations[key], [*attrs[key].dup]]
+          }]
+        end
+
+        private
+
+        def ensure_required_associations(attrs)
+          missing = required_associations - attrs.keys
+          if missing.present?
+            raise MissedAssociationsError, I18n.t(
+              'errors.missed_associations',
+              keys: missing, attrs: attrs
+            )
+          end
+        end
+
+        def required_associations
+          self.associations.select { |_, a| a.required }.map(&:key)
+        end
+      end
+    end
+  end
+end