synchronisable 0.0.2 → 0.0.3

data/lib/{synchronizable → synchronisable}/model/methods.rb

@@ -1,9 +1,9 @@
-require 'synchronizable/worker'
-require 'synchronizable/models/import'
+require 'synchronisable/worker'
+require 'synchronisable/models/import'
 
-module Synchronizable
+module Synchronisable
   module Model
-    # Methods that will be attached to synchronizable model class.
+    # Methods that will be attached to synchronisable model class.
     module Methods
       # Creates a new worker, that initiates synchronization
       # for this particular model.
@@ -21,7 +21,7 @@ module Synchronizable
       #
       # @param data [Array<Hash>] array of hashes with remote attributes.
       #
-      # @see Synchronizable::Worker
+      # @see Synchronisable::Worker
       #
       # @example Supplying array of hashes with remote attributes
       #   FooModel.sync([
@@ -48,7 +48,7 @@ module Synchronizable
 
       # Count of import records for this model.
       def imports_count
-        Import.where(synchronizable_type: self).count
+        Import.where(synchronisable_type: self).count
       end
     end
   end

data/lib/{synchronizable → synchronisable}/models/import.rb

@@ -1,11 +1,11 @@
-module Synchronizable
+module Synchronisable
   class Import < ActiveRecord::Base
-    belongs_to :synchronizable, polymorphic: true
+    belongs_to :synchronisable, polymorphic: true
 
     serialize :attrs, Hash
 
-    scope :with_synchronizable_type, ->(type) { where(synchronizable_type: type) }
-    scope :with_synchronizable_ids,  ->(ids)  { where(synchronizable_id: ids) }
+    scope :with_synchronisable_type, ->(type) { where(synchronisable_type: type) }
+    scope :with_synchronisable_ids,  ->(ids)  { where(synchronisable_id: ids) }
 
     scope :with_remote_id,  ->(id)  { where(remote_id: id.to_s) }
     scope :with_remote_ids, ->(ids) { where(remote_id: ids.map(&:to_s)) }
@@ -14,9 +14,9 @@ module Synchronizable
       with_remote_id(id).first
     end
 
-    def destroy_with_synchronizable
+    def destroy_with_synchronisable
       ActiveRecord::Base.transaction do
-        synchronizable.try :destroy
+        synchronisable.try :destroy
         destroy
       end
     end

data/lib/{synchronizable → synchronisable}/source.rb

@@ -1,4 +1,4 @@
-module Synchronizable
+module Synchronisable
   # Synchronization source.
   class Source
     attr_accessor :import_record
@@ -26,7 +26,7 @@ module Synchronizable
 
       @import_record = Import.find_by(
         :remote_id => @remote_id,
-        :synchronizable_type => @model
+        :synchronisable_type => @model
       )
 
       set_parent_attribute
@@ -37,7 +37,7 @@ module Synchronizable
     end
 
     def local_record
-      @import_record.try(:synchronizable)
+      @import_record.try(:synchronisable)
     end
 
     def dump_message

data/lib/{synchronizable → synchronisable}/synchronizer.rb

@@ -1,16 +1,16 @@
-require 'synchronizable/dsl/macro'
-require 'synchronizable/dsl/associations'
-require 'synchronizable/exceptions'
+require 'synchronisable/dsl/macro'
+require 'synchronisable/dsl/associations'
+require 'synchronisable/exceptions'
 
-module Synchronizable
+module Synchronisable
   # @abstract Subclass to create your model specific synchronizer class to
   #   setup synchronization attributes and behavior.
   #
-  # @see Synchronizable::DSL::Macro
-  # @see Synchronizable::SynchronizerDefault
+  # @see Synchronisable::DSL::Macro
+  # @see Synchronisable::SynchronizerDefault
   class Synchronizer
-    include Synchronizable::DSL::Macro
-    include Synchronizable::DSL::Associations
+    include Synchronisable::DSL::Macro
+    include Synchronisable::DSL::Associations
 
     SYMBOL_ARRAY_CONVERTER = ->(source) { (source || []).map(&:to_s) }
 
@@ -47,7 +47,7 @@ module Synchronizable
     # Lambda that returns a hash with remote attributes by id.
     #
     # @example Common use case
-    #   class FooSynchronizer < Synchronizable::Synchronizer
+    #   class FooSynchronizer < Synchronisable::Synchronizer
     #     find do |id|
     #       remote_source.find { |h| h[:foo_id] == id } }
     #     end
@@ -57,33 +57,33 @@ module Synchronizable
     # Lambda, that will be called before synchronization
     # of each record and its assocations.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     #
     # @return [Boolean] `true` to continue sync, `false` to cancel
     method :before_sync
     # Lambda, that will be called every time
     # after record and its associations is synchronized.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     method :after_sync
 
     # Lambda, that will be called before synchronization of each record.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     #
     # @return [Boolean] `true` to continue sync, `false` to cancel
     method :before_record_sync
 
     # Lambda, that will be called every time after record is synchronized.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     method :after_record_sync
 
     # Lambda, that will be called before each association sync.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     # @param id association remote id
-    # @param association [Synchronizable::DSL::Associations::Association]
+    # @param association [Synchronisable::DSL::Associations::Association]
     #   association builder
     #
     # @return [Boolean] `true` to continue sync, `false` to cancel
@@ -91,9 +91,9 @@ module Synchronizable
 
     # Lambda, that will be called every time after association if synchronized.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     # @param id association remote id
-    # @param association [Synchronizable::DSL::Associations::Association]
+    # @param association [Synchronisable::DSL::Associations::Association]
     #   association builder
     method :after_association_sync
 
@@ -159,7 +159,7 @@ module Synchronizable
         after.(*args) if after
       end
 
-      # Throws the {Synchronizable::MissedRemoteIdError} if given id isn't present.
+      # Throws the {Synchronisable::MissedRemoteIdError} if given id isn't present.
       #
       # @param id id to check
       #

data/lib/{synchronizable → synchronisable}/synchronizers/synchronizer_default.rb

@@ -1,6 +1,6 @@
-require 'synchronizable/synchronizer'
+require 'synchronisable/synchronizer'
 
-module Synchronizable
+module Synchronisable
   # Default synchronizer to be used when
   # model specific synchronizer is not defined.
   #

data/lib/{synchronizable → synchronisable}/version.rb

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

data/lib/{synchronizable → synchronisable}/worker.rb

@@ -1,9 +1,9 @@
-require 'synchronizable/error_handler'
-require 'synchronizable/context'
-require 'synchronizable/source'
-require 'synchronizable/models/import'
+require 'synchronisable/error_handler'
+require 'synchronisable/context'
+require 'synchronisable/source'
+require 'synchronisable/models/import'
 
-module Synchronizable
+module Synchronisable
   # Responsible for model synchronization.
   #
   # @api private
@@ -20,7 +20,7 @@ module Synchronizable
       # @overload run(model, data)
       # @overload run(model)
       #
-      # @return [Synchronizable::Context] synchronization context
+      # @return [Synchronisable::Context] synchronization context
       def run(model, *args)
         options = args.extract_options!
         data = args.first
@@ -35,7 +35,7 @@ module Synchronizable
     #   If not specified worker will try to get the data
     #   using `fetch` lambda/proc defined in corresponding synchronizer
     #
-    # @return [Synchronizable::Context] synchronization context
+    # @return [Synchronisable::Context] synchronization context
     def run(data)
       sync do |context|
         error_handler = ErrorHandler.new(@logger, context)
@@ -87,7 +87,7 @@ module Synchronizable
 
     # Method called by {#run} for each remote model attribute hash
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     #
     # @return [Boolean] `true` if synchronization was completed
     #   without errors, `false` otherwise
@@ -117,8 +117,8 @@ module Synchronizable
     def create_record_pair(source)
       local_record = @model.create!(source.local_attrs)
       import_record = Import.create!(
-        :synchronizable_id    => local_record.id,
-        :synchronizable_type  => @model.to_s,
+        :synchronisable_id    => local_record.id,
+        :synchronisable_type  => @model.to_s,
         :remote_id            => source.remote_id,
         :attrs                => source.local_attrs
       )
@@ -143,10 +143,10 @@ module Synchronizable
 
     # Synchronizes associations.
     #
-    # @param source [Synchronizable::Source] synchronization source
+    # @param source [Synchronisable::Source] synchronization source
     #
-    # @see Synchronizable::DSL::Associations
-    # @see Synchronizable::DSL::Associations::Association
+    # @see Synchronisable::DSL::Associations
+    # @see Synchronisable::DSL::Associations::Association
     def sync_associations(source)
       if verbose_logging? && source.associations.present?
         @logger.info "starting associations sync"
@@ -185,7 +185,7 @@ module Synchronizable
     end
 
     def verbose_logging?
-      Synchronizable.logging[:verbose]
+      Synchronisable.logging[:verbose]
     end
   end
 end

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

@@ -6,5 +6,5 @@ class Match < ActiveRecord::Base
 
   has_many :match_players, dependent: :destroy
 
-  synchronizable
+  synchronisable
 end

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

@@ -11,5 +11,5 @@ class MatchPlayer < ActiveRecord::Base
 
   validates :match, :player, presence: true
 
-  synchronizable
+  synchronisable
 end

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

@@ -1,5 +1,5 @@
 class Player < ActiveRecord::Base
   belongs_to :team
 
-  synchronizable
+  synchronisable
 end

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

@@ -3,5 +3,5 @@ class Stadium < ActiveRecord::Base
   # so synchronization worker is gonna try
   # to use remote attributes as is to create a record
 
-  synchronizable
+  synchronisable
 end

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

@@ -2,5 +2,5 @@ class Stage < ActiveRecord::Base
   belongs_to :tournament
   has_many :matches
 
-  synchronizable
+  synchronisable
 end

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

@@ -1,5 +1,5 @@
 class Team < ActiveRecord::Base
   has_many :players
 
-  synchronizable BreakConventionTeamSynchronizer
+  synchronisable BreakConventionTeamSynchronizer
 end

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

@@ -3,5 +3,5 @@ class Tournament < ActiveRecord::Base
 
   validates :name, :beginning, :ending, :presence => true
 
-  synchronizable
+  synchronisable
 end

data/spec/dummy/app/synchronizers/break_convention_team_synchronizer.rb

@@ -1,4 +1,4 @@
-class BreakConventionTeamSynchronizer < Synchronizable::Synchronizer
+class BreakConventionTeamSynchronizer < Synchronisable::Synchronizer
   @gateway = TeamGateway.new
 
   remote_id :maet_id

data/spec/dummy/app/synchronizers/match_synchronizer.rb

@@ -1,4 +1,4 @@
-class MatchSynchronizer < Synchronizable::Synchronizer
+class MatchSynchronizer < Synchronisable::Synchronizer
   @gateway = MatchGateway.new
 
   has_one :team, key: 'home_team_id'
@@ -39,12 +39,12 @@ class MatchSynchronizer < Synchronizable::Synchronizer
       match = source.local_record
       remote_player_ids = source.remote_attrs[ref_type.to_sym] || {}
 
-      player_imports = Synchronizable::Import
-        .with_synchronizable_type(Player)
+      player_imports = Synchronisable::Import
+        .with_synchronisable_type(Player)
         .with_remote_ids(remote_player_ids)
 
       local_player_ids = player_imports.map do |import|
-        import.synchronizable.id
+        import.synchronisable.id
       end
 
       local_player_ids.each do |player_id|
@@ -60,8 +60,8 @@ class MatchSynchronizer < Synchronizable::Synchronizer
       match_player = MatchPlayer.find_by(attrs)
       unless match_player
         remote_id = "#{attrs[:match_id]}_#{attrs[:player_id]}"
-        Synchronizable::Import.create!(
-          :synchronizable => MatchPlayer.create!(attrs),
+        Synchronisable::Import.create!(
+          :synchronisable => MatchPlayer.create!(attrs),
           :remote_id => remote_id,
           :attrs => attrs
         )

data/spec/dummy/app/synchronizers/player_synchronizer.rb

@@ -1,4 +1,4 @@
-class PlayerSynchronizer < Synchronizable::Synchronizer
+class PlayerSynchronizer < Synchronisable::Synchronizer
   @gateway = PlayerGateway.new
 
   remote_id :player_id

data/spec/dummy/app/synchronizers/stage_synchronizer.rb

@@ -1,4 +1,4 @@
-class StageSynchronizer < Synchronizable::Synchronizer
+class StageSynchronizer < Synchronisable::Synchronizer
   @gateway = StageGateway.new
 
   has_many :matches

data/spec/dummy/app/synchronizers/tournament_synchronizer.rb

@@ -1,4 +1,4 @@
-class TournamentSynchronizer < Synchronizable::Synchronizer
+class TournamentSynchronizer < Synchronisable::Synchronizer
   @gateway = TournamentGateway.new
 
   has_many :stages

data/spec/dummy/config/application.rb

@@ -7,7 +7,7 @@ require 'action_view/railtie'
 require 'sprockets/railtie'
 
 Bundler.require(*Rails.groups)
-require 'synchronizable'
+require 'synchronisable'
 
 module Dummy
   class Application < Rails::Application

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

@@ -1,2 +1,2 @@
-Synchronizable.configure do |config|
+Synchronisable.configure do |config|
 end

data/spec/dummy/db/migrate/20140422135244_create_imports.rb

@@ -1,8 +1,8 @@
 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.string  :synchronisable_type, null: false
+      t.integer :synchronisable_id, null: false
       t.text    :attrs
       t.string  :remote_id, null: false
 
@@ -10,12 +10,12 @@ class CreateImports < ActiveRecord::Migration
     end
 
     add_index :imports, :remote_id
-    add_index :imports, [:synchronizable_type, :synchronizable_id]
+    add_index :imports, [:synchronisable_type, :synchronisable_id]
   end
 
   def self.down
     remove_index :imports, :remote_id
-    remove_index :imports, [:synchronizable_type, :synchronizable_id]
+    remove_index :imports, [:synchronisable_type, :synchronisable_id]
     drop_table :imports
   end
 end

data/spec/dummy/db/schema.rb

@@ -14,8 +14,8 @@
 ActiveRecord::Schema.define(version: 20140507140039) do
 
   create_table "imports", force: true do |t|
-    t.string   "synchronizable_type", null: false
-    t.integer  "synchronizable_id",   null: false
+    t.string   "synchronisable_type", null: false
+    t.integer  "synchronisable_id",   null: false
     t.text     "attrs"
     t.string   "remote_id",           null: false
     t.datetime "created_at"
@@ -23,7 +23,7 @@ ActiveRecord::Schema.define(version: 20140507140039) do
   end
 
   add_index "imports", ["remote_id"], name: "index_imports_on_remote_id"
-  add_index "imports", ["synchronizable_type", "synchronizable_id"], name: "index_imports_on_synchronizable_type_and_synchronizable_id"
+  add_index "imports", ["synchronisable_type", "synchronisable_id"], name: "index_imports_on_synchronisable_type_and_synchronisable_id"
 
   create_table "match_players", force: true do |t|
     t.integer  "match_id"