synchronisable 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46c5332c053921eb44021c59a846a1451eede185
-  data.tar.gz: d33c7cdb48f1266ebb3737a20c7a6c4b3688b12c
+  metadata.gz: 5e53ab569c0106db0a2e1f17b9446111c8dde193
+  data.tar.gz: caebb67d58390fddd864b91a8e8901904f5094bf
 SHA512:
-  metadata.gz: a42307f344f720d63a7519969481e94fffcc9a9010510cf39791ea43b93ad5e64304c80074aa1b5f5133d720fc16cbaf829650dfeb3da50d814efe3608eb72a4
-  data.tar.gz: 7b35e861d0ea8c002d4215b2965713c2c2ebb30f509f24e652f687f95e0237bb69be0dee671aa66fc944f4a714e417a9a4c85f59c1862f6d8f727879b0cff6f9
+  metadata.gz: 209cee6e20cf9f5edd9b52e105e1c6a9db92beb0fd66a91e1a5841c10594ac41195b2708c6ab8f04776a431b03253c606f6a2185503c8e43b8ff9dd1db74525b
+  data.tar.gz: bd26bb9a7a7377ff5c3778b9ae3cce6525b99fccee41c4a113680dce94dcadd2bbeb5822141478ee33ca85250a4c2e570c3e26caa59dc9f6b6d5a02111565a6d

data/Guardfile

@@ -6,9 +6,3 @@ guard :rspec, :all_on_start => false, :all_after_pass => false do
   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/TODO.md

@@ -17,6 +17,7 @@ Primary objectives
   - [x] sync with ids array
   - [ ] handle case when association type is a :hash
   - [ ] sync method for collection proxy (Model.where(condition).sync)
+- [ ] better specs for cases when we should fetch/find using complex params
 
 Think about
 ======================================
@@ -27,7 +28,7 @@ Secondary objectives
 ======================================
 - [x] option for verbose logging
 - [x] colorized STDOUT
-- [ ] actualize docs
+- [x] actualize docs
 
 
 The desired interface:
@@ -38,7 +39,7 @@ The desired interface:
 ```
 
 ```
-Match.sync(:include => {
++ Match.sync(:include => {
   :match_players => :player
 })
 + Model.sync([id1, ..., idn])

data/lib/synchronisable/bootstrap/i18n.rb

@@ -0,0 +1,11 @@
+require 'i18n'
+
+locale_paths = File.join(File.dirname(__FILE__),
+                         '..', '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]

data/lib/synchronisable/controller.rb

@@ -2,7 +2,7 @@ require 'colorize'
 
 require 'synchronisable/error_handler'
 require 'synchronisable/context'
-require 'synchronisable/input_parser'
+require 'synchronisable/input/parser'
 require 'synchronisable/source'
 require 'synchronisable/models/import'
 require 'synchronisable/helper/logging'
@@ -77,7 +77,7 @@ module Synchronisable
     #
     # @return [Synchronisable::Context] synchronization context
     #
-    # @see Synchronisable::InputParser
+    # @see Synchronisable::Input::Parser
     def call(data)
       sync do |context|
         error_handler = ErrorHandler.new(logger, context)
@@ -116,7 +116,7 @@ module Synchronisable
       @includes = options[:includes]
       @parent = options[:parent]
 
-      @input = InputParser.new(@model, @synchronizer)
+      @input = Input::Parser.new(@model, @synchronizer)
     end
 
     def sync

data/lib/synchronisable/gateway.rb

@@ -1,7 +1,5 @@
 module Synchronisable
   class Gateway
-    attr_reader :synchronizer
-
     def fetch(params = {})
       not_implemented :fetch
     end

data/lib/synchronisable/input/descriptor.rb

@@ -0,0 +1,54 @@
+module Synchronisable
+  module Input
+    # Provides a set of helper methods
+    # to describe user input.
+    #
+    # @api private
+    #
+    # @see Synchronisable::Input::Descriptor
+    class Descriptor
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def empty?
+        @data.blank?
+      end
+
+      def params?
+        @data.is_a?(Hash)
+      end
+
+      def remote_id?
+        @data.is_a?(String)
+      end
+
+      def local_id?
+        @data.is_a?(Integer)
+      end
+
+      def array_of_ids?
+         enumerable? && (
+          first_element.is_a?(String) ||
+          first_element.is_a?(Integer)
+        )
+      end
+
+      def element_class
+        first_element.try(:class)
+      end
+
+      private
+
+      def first_element
+        @data.try(:first)
+      end
+
+      def enumerable?
+        @data.is_a?(Enumerable)
+      end
+    end
+  end
+end

data/lib/synchronisable/input/parser.rb

@@ -0,0 +1,70 @@
+require 'synchronisable/input/descriptor'
+
+module Synchronisable
+  module Input
+    # Responsible for guessing the user input format.
+    #
+    # @api private
+    #
+    # @see Synchronisable::Input::Parser
+    class Parser
+      def initialize(model, synchronizer)
+        @model = model
+        @synchronizer = synchronizer
+      end
+
+      # Parses the user input.
+      #
+      # @param data [Array<Hash>, Array<String>, Array<Integer>, String, Integer]
+      #   synchronization data to handle.
+      #
+      # @return [Array<Hash>] array of hashes with remote attributes
+      def parse(data)
+        input = Descriptor.new(data)
+
+        result = case
+                 when input.empty?
+                   @synchronizer.fetch
+                 when input.params?
+                   find_or_fetch_by_params(input.data)
+                 when input.remote_id?
+                   @synchronizer.find(data)
+                 when input.local_id?
+                   find_by_local_id(data)
+                 when input.array_of_ids?
+                   find_by_array_of_ids(input)
+                 else
+                   result = data.dup
+                 end
+
+        [result].flatten.compact
+      end
+
+      private
+
+      def find_or_fetch_by_params(params)
+        sync_method = params.key?(:id) ? :find : :fetch
+        @synchronizer.send(sync_method, params)
+      end
+
+      def find_by_array_of_ids(input)
+        records = find_imports(input.element_class.name, input.data)
+        records.map { |r| @synchronizer.find(r.remote_id) }
+      end
+
+      def find_by_local_id(id)
+        import = @model.find_by(id: id).try(:import)
+        import ? @synchronizer.find(import.remote_id) : nil
+      end
+
+      def find_imports(class_name, ids)
+        case class_name
+        when 'Fixnum'
+          ids.map { |id| @model.find_by(id: id).try(&:import) }
+        when 'String'
+          ids.map { |id| Import.find_by(id: id) }
+        end
+      end
+    end
+  end
+end

data/lib/synchronisable/version.rb

@@ -2,7 +2,7 @@ module Synchronisable
   module VERSION
     MAJOR = 1
     MINOR = 1
-    PATCH = 3
+    PATCH = 4
     SUFFIX = nil
 
     STRING = [MAJOR, MINOR, PATCH, SUFFIX].compact.join('.')

data/lib/synchronisable.rb

@@ -8,7 +8,7 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/configurable'
 require 'active_support/concern'
 
-require 'i18n'
+require 'synchronisable/bootstrap/i18n'
 
 require 'synchronisable/version'
 require 'synchronisable/models/import'
@@ -16,15 +16,6 @@ require 'synchronisable/synchronizer'
 require 'synchronisable/model'
 require 'synchronisable/gateway'
 
-locale_paths = File.join(File.dirname(__FILE__),
-  'synchronisable', '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]
 
 module Synchronisable
   include ActiveSupport::Configurable

data/spec/dummy/app/gateways/stage_gateway.rb

@@ -1,8 +1,4 @@
 class StageGateway < GatewayBase
-  def id_key
-    :stage_id
-  end
-
   def source
     @source ||= [
       FactoryGirl.build(:remote_stage,
@@ -15,4 +11,26 @@ class StageGateway < GatewayBase
       )
     ]
   end
+
+  def fetch(params)
+    tournament_id = params[:tournament_id]
+
+    raise "missed parameter 'tournament_id'" unless tournament_id
+
+    source.select do |attrs|
+      attrs[:tour_id] = tournament_id
+    end
+  end
+
+  def find(params)
+    tournament_id, id = params[:tournament_id], params[:id]
+
+    raise "missed parameter 'tournament_id'" unless tournament_id
+    raise "missed parameter 'id'" unless id
+
+    source.find do |attrs|
+      attrs[:tour_id] = tournament_id &&
+      attrs[:stage_id] = id
+    end
+  end
 end

data/spec/dummy/app/gateways/tournament_gateway.rb

@@ -8,7 +8,16 @@ class TournamentGateway < GatewayBase
       FactoryGirl.build(:remote_tournament,
         :tour_id => 'tournament_0',
         :is_current => true,
-        :stages_ids => %w(stage_0 stage_1)
+        :stages_ids => [
+          {
+            id: 'stage_0',
+            tournament_id: 'tournament_0'
+          },
+          {
+            id: 'stage_1',
+            tournament_id: 'tournament_0'
+          }
+        ]
       )
     ]
   end

data/spec/models/stage_spec.rb

@@ -11,10 +11,12 @@ describe Stage do
     end
 
     describe 'skipping with before_sync hook' do
-      subject { -> { Stage.sync(remote_attrs, :includes => {}) } }
+      let!(:context) { Stage.sync(remote_attrs, :includes => {}) }
 
-      it { is_expected.to change { Stage.count }.by(2) }
-      it { is_expected.to change { Synchronisable::Import.count }.by(2) }
+      it 'skips hashes where name is "ignored"' do
+        expect(Stage.count).to eq(2)
+        expect(Synchronisable::Import.count).to eq(2)
+      end
     end
   end
 end

data/spec/models/team_spec.rb

@@ -121,7 +121,7 @@ describe Team do
     end
 
     context 'when remote id is not specified in attributes hash' do
-      it "return synchronization result that contains 1 error" do
+      it 'return synchronization result that contains 1 error' do
         result = Team.sync([remote_attrs.last])
         expect(result.errors.count).to eq(1)
       end

data/spec/spec_helper.rb

@@ -6,7 +6,6 @@ ENV['RAILS_ENV'] ||= 'test'
 require 'database_cleaner'
 require 'factory_girl'
 require 'factory_girl_sequences'
-require 'spork'
 
 if ENV['COVERAGE']
   require 'simplecov'
@@ -34,41 +33,36 @@ Dir[support_pattern].each   { |file| require file }
 
 ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
 
-Spork.prefork do
-  RSpec.configure do |config|
-    config.run_all_when_everything_filtered = true
-    config.filter_run focus: true
-    config.order = 'random'
-    config.include FactoryGirl::Syntax::Methods
-
-    config.before(:suite) do
-      begin
-        FactoryGirl.lint
-      ensure
-        DatabaseCleaner.clean_with(:truncation)
-      end
-    end
-
-    config.before(:each) { DatabaseCleaner.strategy = :transaction }
-
-    config.before(:each, js: true) do
-      DatabaseCleaner.strategy = :truncation
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run focus: true
+  config.order = 'random'
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    begin
+      FactoryGirl.lint
+    ensure
+      DatabaseCleaner.clean_with(:truncation)
     end
+  end
 
-    config.before(:each) { DatabaseCleaner.start }
-    config.after(:each)  { DatabaseCleaner.clean }
+  config.before(:each) { DatabaseCleaner.strategy = :transaction }
 
-    if ENV['RUN_SLOW_TESTS'] != 'true'
-      config.filter_run_excluding slow: true
-    end
+  config.before(:each, js: true) do
+    DatabaseCleaner.strategy = :truncation
   end
 
-  FactoryGirl.define do
-    %w(remote match team player match_player stage tournament).each do |prefix|
-      sequence(:"#{prefix}_id") { |n| "#{prefix}_#{n}" }
-    end
+  config.before(:each) { DatabaseCleaner.start }
+  config.after(:each)  { DatabaseCleaner.clean }
+
+  if ENV['RUN_SLOW_TESTS'] != 'true'
+    config.filter_run_excluding slow: true
   end
 end
 
-Spork.each_run do
+FactoryGirl.define do
+  %w(remote match team player match_player stage tournament).each do |prefix|
+    sequence(:"#{prefix}_id") { |n| "#{prefix}_#{n}" }
+  end
 end

data/spec/synchronisable/synchronisable_spec.rb

@@ -23,7 +23,7 @@ describe Synchronisable do
       context 'all' do
         before :all do
           Synchronisable.models = %w(
-            Stage Tournament Team
+            Tournament Team
             Match MatchPlayer Player
           )
         end
@@ -38,21 +38,25 @@ describe Synchronisable do
         it { is_expected.to change { Synchronisable::Import.count }.by(14) }
       end
 
-      # context 'when models setting is overriden in method call' do
-      #   before :all do
-      #     Synchronisable.models = %w(Team Match)
-      #   end
+      context 'when models setting is overriden in method call' do
+        before :all do
+          Synchronisable.models = %w(Team Match)
+        end
 
-      #   subject do
-      #     -> { Synchronisable.sync(Match, Player) }
-      #   end
+        subject do
+          -> { Synchronisable.sync(Match, Player) }
+        end
+
+        it { is_expected.to change { Match.count }.by(1) }
+        it { is_expected.to change { Team.count }.by(2) }
+        it { is_expected.to change { Player.count }.by(4) }
+        it { is_expected.to change { MatchPlayer.count }.by(4) }
 
-      #   it { is_expected.to change { Match.count }.by(1) }
-      #   it { is_expected.to change { Player.count }.by(22) }
-      #   it { is_expected.not_to change { Team.count }.by(2) }
+        it { is_expected.not_to change { Stage.count } }
+        it { is_expected.not_to change { Tournament.count } }
 
-      #   it { is_expected.to change { Synchronisable::Import.count }.by(5) }
-      # end
+        it { is_expected.to change { Synchronisable::Import.count }.by(11) }
+      end
     end
   end
 end

data/synchronisable.gemspec

@@ -35,7 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "mutant"
   spec.add_development_dependency "mutant-rspec"
-  spec.add_development_dependency "guard-spork"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synchronisable
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Vasiliy Yorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -234,20 +234,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-spork
-  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: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -301,6 +287,8 @@ files:
 - lib/generators/synchronisable/templates/initializer.rb
 - lib/synchronisable.rb
 - lib/synchronisable/attribute_mapper.rb
+- lib/synchronisable/bootstrap/i18n.rb
+- lib/synchronisable/configuration.rb
 - lib/synchronisable/context.rb
 - lib/synchronisable/controller.rb
 - lib/synchronisable/dsl/associations.rb
@@ -316,8 +304,8 @@ files:
 - lib/synchronisable/exceptions.rb
 - lib/synchronisable/gateway.rb
 - lib/synchronisable/helper/logging.rb
-- lib/synchronisable/input_descriptor.rb
-- lib/synchronisable/input_parser.rb
+- lib/synchronisable/input/descriptor.rb
+- lib/synchronisable/input/parser.rb
 - lib/synchronisable/locale/en.yml
 - lib/synchronisable/locale/ru.yml
 - lib/synchronisable/model.rb
@@ -451,7 +439,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provides base fuctionality (models, DSL) for AR synchronization with external

data/lib/synchronisable/input_descriptor.rb

@@ -1,52 +0,0 @@
-module Synchronisable
-  # Provides a set of helper methods
-  # to describe user input.
-  #
-  # @api private
-  #
-  # @see Synchronisable::InputParser
-  class InputDescriptor
-    attr_reader :data
-
-    def initialize(data)
-      @data = data
-    end
-
-    def empty?
-      @data.blank?
-    end
-
-    def params?
-      @data.is_a?(Hash)
-    end
-
-    def remote_id?
-      @data.is_a?(String)
-    end
-
-    def local_id?
-      @data.is_a?(Integer)
-    end
-
-    def array_of_ids?
-       enumerable? && (
-        first_element.is_a?(String) ||
-        first_element.is_a?(Integer)
-      )
-    end
-
-    def element_class
-      first_element.try(:class)
-    end
-
-    private
-
-    def first_element
-      @data.try(:first)
-    end
-
-    def enumerable?
-      @data.is_a?(Enumerable)
-    end
-  end
-end

data/lib/synchronisable/input_parser.rb

@@ -1,68 +0,0 @@
-require 'synchronisable/input_descriptor'
-
-module Synchronisable
-  # Responsible for guessing the user input format.
-  #
-  # @api private
-  #
-  # @see Synchronisable::InputDescriptor
-  class InputParser
-    def initialize(model, synchronizer)
-      @model = model
-      @synchronizer = synchronizer
-    end
-
-    # Parses the user input.
-    #
-    # @param data [Array<Hash>, Array<String>, Array<Integer>, String, Integer]
-    #   synchronization data to handle.
-    #
-    # @return [Array<Hash>] array of hashes with remote attributes
-    def parse(data)
-      input = InputDescriptor.new(data)
-
-      result = case
-               when input.empty?
-                 @synchronizer.fetch
-               when input.params?
-                 find_or_fetch_by_params(input.data)
-               when input.remote_id?
-                 @synchronizer.find(data)
-               when input.local_id?
-                 find_by_local_id(data)
-               when input.array_of_ids?
-                 find_by_array_of_ids(input)
-               else
-                 result = data.dup
-               end
-
-      [result].flatten.compact
-    end
-
-    private
-
-    def find_or_fetch_by_params(params)
-      sync_method = params.key?(:id) ? :find : :fetch
-      @synchronizer.send(sync_method, params)
-    end
-
-    def find_by_array_of_ids(input)
-      records = find_imports(input.element_class.name, input.data)
-      records.map { |r| @synchronizer.find(r.remote_id) }
-    end
-
-    def find_by_local_id(id)
-      import = @model.find_by(id: id).try(:import)
-      import ? @synchronizer.find(import.remote_id) : nil
-    end
-
-    def find_imports(class_name, ids)
-      case class_name
-      when 'Fixnum'
-        ids.map { |id| @model.find_by(id: id).try(&:import) }
-      when 'String'
-        ids.map { |id| Import.find_by(id: id) }
-      end
-    end
-  end
-end