clowne 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b3c79ac97f903ed3f2c1f8ae8b894dd7c4f3c4da5ab28350e59482ef08714e
-  data.tar.gz: af3aa849d2ba1dfdc34f8edbb612c384bafefd21d2ef74f2842e659af4690867
+  metadata.gz: 50a2126fd3d4f4581bb9d06a1d53489dab431e2285683cba815df66a683d154a
+  data.tar.gz: 973bebd26c7e8e33807d6a4a3438d5f72aefb540bbbf4ce4d5aecfcf58761893
 SHA512:
-  metadata.gz: bbf985fe91770d1d34ae133492ba58aadc7eeab15b3dcc6f122db94d6e48e42dd8c885c4b145da2325583a98143d28464b128c7f34174a13f4922a72a340cfff
-  data.tar.gz: f47be4fac65591d29754756e2dd59a002d1eec0fcbfd661d2619f113020d97a7f1630d0d738cb3d2c9a7496d4302e2a0e888a3d537c9dcb2fed0053db72ee1db
+  metadata.gz: db3a1a9e38b180a2a5ad6cd490fe9852f074de4484df91ff62525fb88497a2785ef9307745a264bcb082a42ff9f1be95848534a949a78c96e591141c24fefea1
+  data.tar.gz: 565def47871791088a954d8ffd7ea374de91d37844fcc3bed97f35c6e299d65bd14f3c817906815b79544a7080a456058ed46dbf375d5d200ba7956b79149ac3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 1.1.0 (2019-03-20)
+
+
+- Add `after_clone` declaration. ([@elardo][])
+- Add opporotunity to include belongs_to association for active_record adapter. ([@madding][])
+
 ## 1.0.0 (2019-02-26)
 
 - Return `Operation` instance as a rusult of cloning. ([@ssnickolay][])
@@ -36,3 +42,5 @@ See [migration guide](https://clowne.evilmartians.io/docs/from_v02_to_v10.html)
 
 [@palkan]: https://github.com/palkan
 [@ssnickolay]: https://github.com/ssnickolay
+[@elardo]: https://github.com/elardo
+[@madding]: https://github.com/madding

data/README.md

@@ -114,10 +114,10 @@ Take a look at our [documentation](https://clowne.evilmartians.io) for more info
 
 ### Supported ORM adapters
 
-Adapter                                   |1:1         | 1:M         | M:M                     |
-------------------------------------------|------------|-------------|-------------------------|
-[Active Record](https://clowne.evilmartians.io/clowne/docs/active_record.html)  | has_one    | has_many    | has_and_belongs_to|
-[Sequel](https://clowne.evilmartians.io/clowne/docs/sequel.html)                | one_to_one | one_to_many | many_to_many     |
+Adapter                                   |1:1         |*:1         | 1:M         | M:M                     |
+------------------------------------------|------------|------------|-------------|-------------------------|
+[Active Record](https://clowne.evilmartians.io/clowne/docs/active_record.html)  | has_one    | belongs_to | has_many    | has_and_belongs_to|
+[Sequel](https://clowne.evilmartians.io/clowne/docs/sequel.html)                | one_to_one | -          | one_to_many | many_to_many     |
 
 ## Maintainers
 

data/docs/after_clone.md

@@ -0,0 +1,56 @@
+---
+id: after_clone
+title: After Clone
+---
+
+The `after_clone` callbacks can help you to make additional operations on cloned record, like checking it with some business logic or actualizing cloned record attributes, before it will be saved to the database. Also it can help to avoid unneeded usage of [`after_persist`](after_persist.md) callbacks, and additional queries to database.
+
+Examples:
+
+```ruby
+class User < ActiveRecord::Base
+  # create_table :users do |t|
+  #   t.string :login
+  #   t.integer :draft_count
+  # end
+
+  has_many :posts # all user's posts
+end
+
+class Post < ActiveRecord::Base
+  # create_table :posts do |t|
+  #   t.integer :user_id
+  #   t.boolean :is_draft
+  # end
+
+  scope :draft, -> { where is_draft: true }
+end
+
+class UserCloner < Clowne::Cloner
+# clone user and his posts, which is drafts
+  include_association :posts, scope: :draft
+
+  after_clone do |_origin, clone, **|
+    # actualize user attribute
+    clone.draft_count = clone.posts.count
+  end
+end
+```
+
+`after_clone` runs when you call `Operation#to_record` or [`Operation#persist`]('operation.md) (or `Operation#persist!`)
+
+```ruby
+# prepare data
+user = User.create
+3.times { Post.create(user: user, is_draft: false) }
+2.times { Post.create(user: user, is_draft: true) }
+
+operation = UserCloner.call(user)
+# => <#Clowne::Utils::Operation ...>
+
+clone = operation.to_record
+# => <#User id: nil, draft_count: 2 ...>
+
+clone.draft_count == user.posts.draft.count
+# => true
+```

data/docs/include_association.md

@@ -23,6 +23,13 @@ The declaration supports additional arguments:
 include_association name, scope, options
 ```
 
+### Supported Associations
+
+Adapter                                   |1:1         |*:1         | 1:M         | M:M                     |
+------------------------------------------|------------|------------|-------------|-------------------------|
+[Active Record](https://clowne.evilmartians.io/clowne/docs/active_record.html)  | has_one    | belongs_to | has_many    | has_and_belongs_to|
+[Sequel](https://clowne.evilmartians.io/clowne/docs/sequel.html)                | one_to_one | -          | one_to_many | many_to_many     |
+
 ## Scope
 
 Scope can be a:
@@ -121,3 +128,9 @@ end
 ```
 
 **NOTE:** in that case, it's not possible to provide custom scopes and options.
+
+### Belongs To association
+
+You can include belongs_to association, but will do it carefully.
+If you have loop by relations in your models, when you clone it will raise SystemStackError.
+Check this [test](https://github.com/palkan/clowne/blob/master/spec/clowne/integrations/active_record_belongs_to_spec.rb) for instance.

data/docs/overview.md

@@ -20,5 +20,6 @@ All built-in adapters have the same order and what happens when you call `Operat
 - [`clone associations`](include_association.md)
 - [`nullify`](nullify.md) attributes
 - run [`finalize`](finalize.md) blocks. _The order of [`finalize`](finalize.md) blocks is the order they've been written._
+- run [`after_clone`](after_clone.md) callbacks
 - __SAVE CLONED RECORD__
 - run [`after_persist`](after_persist.md) callbacks

data/docs/web/i18n/en.json

@@ -5,6 +5,7 @@
     "previous": "Previous",
     "tagline": "A flexible gem for cloning your models",
     "active_record": "Active Record",
+    "after_clone": "After Clone",
     "after_persist": "After Persist",
     "alternatives": "Motivation & Alternatives",
     "architecture": "Architecture",

data/docs/web/sidebars.json

@@ -12,6 +12,7 @@
       "exclude_association",
       "nullify",
       "finalize",
+      "after_clone",
       "after_persist",
       "init_as",
       "traits",

data/lib/clowne/adapters/active_record/associations.rb

@@ -2,6 +2,7 @@
 
 require 'clowne/adapters/active_record/associations/base'
 require 'clowne/adapters/active_record/associations/noop'
+require 'clowne/adapters/active_record/associations/belongs_to'
 require 'clowne/adapters/active_record/associations/has_one'
 require 'clowne/adapters/active_record/associations/has_many'
 require 'clowne/adapters/active_record/associations/has_and_belongs_to_many'
@@ -11,6 +12,7 @@ module Clowne
     class ActiveRecord
       module Associations
         AR_2_CLONER = {
+          belongs_to: BelongsTo,
           has_one: HasOne,
           has_many: HasMany,
           has_and_belongs_to_many: HABTM

data/lib/clowne/adapters/active_record/associations/belongs_to.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Clowne
+  module Adapters # :nodoc: all
+    class ActiveRecord
+      module Associations
+        class BelongsTo < Base
+          # rubocop: disable Metrics/MethodLength
+          def call(record)
+            child = association
+            return record unless child
+
+            unless declaration.scope.nil?
+              warn(
+                '[Clowne] Belongs to association does not support scopes ' \
+                "(#{@association_name} for #{@source.class})"
+              )
+            end
+
+            child_clone = clone_one(child)
+            record.__send__(:"#{association_name}=", child_clone)
+            record
+          end
+          # rubocop: enable Metrics/MethodLength
+        end
+      end
+    end
+  end
+end

data/lib/clowne/adapters/base.rb

@@ -6,6 +6,7 @@ require 'clowne/resolvers/init_as'
 require 'clowne/resolvers/nullify'
 require 'clowne/resolvers/finalize'
 require 'clowne/resolvers/after_persist'
+require 'clowne/resolvers/after_clone'
 
 module Clowne
   module Adapters
@@ -70,6 +71,11 @@ Clowne::Adapters::Base.register_resolver(
 )
 
 Clowne::Adapters::Base.register_resolver(
-  :after_persist, Clowne::Resolvers::AfterPersist,
+  :after_clone, Clowne::Resolvers::AfterClone,
   after: :finalize
 )
+
+Clowne::Adapters::Base.register_resolver(
+  :after_persist, Clowne::Resolvers::AfterPersist,
+  after: :after_clone
+)

data/lib/clowne/adapters/sequel/operation.rb

@@ -24,7 +24,9 @@ module Clowne
         def to_record
           return @_record if defined?(@_record)
 
-          @_record = @records[key(@clone)].to_model
+          @_record = @records[key(@clone)].to_model.tap do
+            run_after_clone
+          end
         end
       end
     end

data/lib/clowne/declarations.rb

@@ -31,3 +31,4 @@ require 'clowne/declarations/include_association'
 require 'clowne/declarations/nullify'
 require 'clowne/declarations/trait'
 require 'clowne/declarations/after_persist'
+require 'clowne/declarations/after_clone'

data/lib/clowne/declarations/after_clone.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Clowne
+  module Declarations
+    class AfterClone < Base # :nodoc: all
+      attr_reader :block
+
+      def initialize
+        raise ArgumentError, 'Block is required for after_clone' unless block_given?
+
+        @block = Proc.new
+      end
+
+      def compile(plan)
+        plan.add(:after_clone, self)
+      end
+    end
+  end
+end
+
+Clowne::Declarations.add :after_clone, Clowne::Declarations::AfterClone

data/lib/clowne/resolvers/after_clone.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Clowne
+  class Resolvers
+    module AfterClone # :nodoc: all
+      def self.call(source, record, declaration, params:, **_options)
+        operation = Clowne::Utils::Operation.current
+        operation.add_after_clone(
+          proc do
+            declaration.block.call(source, record, params)
+          end
+        )
+        record
+      end
+    end
+  end
+end

data/lib/clowne/utils/operation.rb

@@ -35,12 +35,17 @@ module Clowne
       attr_reader :mapper
 
       def initialize(mapper)
-        @blocks = []
+        @after_clone_blocks = []
+        @after_persist_blocks = []
         @mapper = mapper
       end
 
       def add_after_persist(block)
-        @blocks.unshift(block)
+        @after_persist_blocks.unshift(block)
+      end
+
+      def add_after_clone(block)
+        @after_clone_blocks.unshift(block)
       end
 
       def add_mapping(origin, clone)
@@ -48,7 +53,10 @@ module Clowne
       end
 
       def to_record
-        @clone
+        return @_record if defined?(@_record)
+
+        run_after_clone
+        @_record = @clone
       end
 
       def persist!
@@ -76,7 +84,11 @@ module Clowne
       end
 
       def run_after_persist
-        @blocks.each(&:call)
+        @after_persist_blocks.each(&:call)
+      end
+
+      def run_after_clone
+        @after_clone_blocks.each(&:call)
       end
     end
   end

data/lib/clowne/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clowne
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clowne
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - clowne.gemspec
 - docs/.rubocop.yml
 - docs/active_record.md
+- docs/after_clone.md
 - docs/after_persist.md
 - docs/alternatives.md
 - docs/architecture.md
@@ -178,6 +179,7 @@ files:
 - lib/clowne/adapters/active_record.rb
 - lib/clowne/adapters/active_record/associations.rb
 - lib/clowne/adapters/active_record/associations/base.rb
+- lib/clowne/adapters/active_record/associations/belongs_to.rb
 - lib/clowne/adapters/active_record/associations/has_and_belongs_to_many.rb
 - lib/clowne/adapters/active_record/associations/has_many.rb
 - lib/clowne/adapters/active_record/associations/has_one.rb
@@ -202,6 +204,7 @@ files:
 - lib/clowne/adapters/sequel/specifications/after_persist_does_not_support.rb
 - lib/clowne/cloner.rb
 - lib/clowne/declarations.rb
+- lib/clowne/declarations/after_clone.rb
 - lib/clowne/declarations/after_persist.rb
 - lib/clowne/declarations/base.rb
 - lib/clowne/declarations/exclude_association.rb
@@ -217,6 +220,7 @@ files:
 - lib/clowne/ext/string_constantize.rb
 - lib/clowne/ext/yield_self_then.rb
 - lib/clowne/planner.rb
+- lib/clowne/resolvers/after_clone.rb
 - lib/clowne/resolvers/after_persist.rb
 - lib/clowne/resolvers/finalize.rb
 - lib/clowne/resolvers/init_as.rb