clowne 1.0.0 → 1.4.0

data/lib/clowne/rspec/clone_association.rb

@@ -20,10 +20,9 @@ module Clowne
           extract_options! options
         end
 
-        # rubocop: disable Metrics/AbcSize
         def match(expected, _actual)
           @actual = plan.declarations
-                        .find { |key, decl| key == :association && decl.name == expected }
+            .find { |key, decl| key == :association && decl.name == expected }
 
           return false if @actual.nil?
 
@@ -60,10 +59,10 @@ module Clowne
             expected_params[param] = options.fetch(param, UNDEFINED)
           end
 
-          raise ArgumentError, 'Lambda scope is not supported' if
+          raise ArgumentError, "Lambda scope is not supported" if
             expected_params[:scope].is_a?(Proc)
 
-          raise ArgumentError, 'Lambda params is not supported' if
+          raise ArgumentError, "Lambda params is not supported" if
             expected_params[:params].is_a?(Proc)
         end
 

data/lib/clowne/rspec/clone_associations.rb

@@ -9,8 +9,8 @@ module Clowne
 
         def convert_actual_to_an_array
           @actual = plan.declarations
-                        .select { |key, _| key == :association }
-                        .map { |_, decl| decl.name }
+            .select { |key, _| key == :association }
+            .map { |_, decl| decl.name }
         end
       end
     end

data/lib/clowne/rspec/helpers.rb

@@ -27,7 +27,7 @@ module Clowne
       end
 
       def non_cloner_message
-        'expected a cloner to be passed to `expect(...)`, ' \
+        "expected a cloner to be passed to `expect(...)`, " \
         "but got #{actual_formatted}"
       end
     end

data/lib/clowne/rspec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require 'clowne/rspec/helpers'
-require 'clowne/rspec/clone_associations'
-require 'clowne/rspec/clone_association'
+require "clowne/rspec/helpers"
+require "clowne/rspec/clone_associations"
+require "clowne/rspec/clone_association"

data/lib/clowne/utils/clone_mapper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'clowne/ext/record_key'
+require "clowne/ext/record_key"
 
 module Clowne
   module Utils

data/lib/clowne/utils/operation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'clowne/utils/clone_mapper'
+require "clowne/utils/clone_mapper"
 
 module Clowne
   module Utils
@@ -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!
@@ -66,17 +74,21 @@ module Clowne
       end
 
       def save
-        warn '[DEPRECATION] `save` is deprecated.  Please use `persist` instead.'
+        warn "[DEPRECATION] `save` is deprecated.  Please use `persist` instead."
         @clone.save
       end
 
       def save!
-        warn '[DEPRECATION] `save!` is deprecated.  Please use `persist!` instead.'
+        warn "[DEPRECATION] `save!` is deprecated.  Please use `persist!` instead."
         @clone.save!
       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/utils/params.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'clowne/ext/lambda_as_proc'
+require "clowne/ext/lambda_as_proc"
 
 module Clowne
   module Utils

data/lib/clowne/version.rb

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

data/lib/clowne.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-require 'clowne/version'
-require 'clowne/declarations'
-require 'clowne/cloner'
+require "clowne/version"
+require "clowne/declarations"
+require "clowne/cloner"
 
-require 'clowne/adapters/base'
+require "clowne/adapters/base"
 
 # Declarative models cloning
 module Clowne
   # List of built-in adapters
-  # rubocop:disable AlignHash
   ADAPTERS = {
-    base:          'Base',
-    active_record: 'ActiveRecord',
-    sequel:        'Sequel'
+    base: "Base",
+    active_record: "ActiveRecord",
+    sequel: "Sequel"
   }.freeze
-  # rubocop:enable AlignHash
+  # rubocop:enable Layout/AlignHash
 
   class << self
     attr_reader :default_adapter, :raise_on_override
@@ -40,5 +39,5 @@ module Clowne
   end
 end
 
-require 'clowne/adapters/active_record' if defined?(::ActiveRecord)
-require 'clowne/adapters/sequel' if defined?(::Sequel)
+require "clowne/adapters/active_record" if defined?(::ActiveRecord)
+require "clowne/adapters/sequel" if defined?(::Sequel)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: clowne
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 - Sverchkov Nikolay
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-02-26 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +31,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,56 +65,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.61'
+        version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.61'
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.31'
+        version: 1.4.0
 description: A flexible gem for cloning your models.
 email:
 - palkan@evilmartians.com
@@ -119,11 +139,14 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".gitattributes"
+- ".github/workflows/rspec-jruby.yml"
+- ".github/workflows/rspec-truffle.yml"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rufo"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -132,45 +155,37 @@ files:
 - bin/console
 - bin/setup
 - clowne.gemspec
+- docs/.nojekyll
 - docs/.rubocop.yml
+- docs/CNAME
+- docs/README.md
+- docs/_sidebar.md
 - docs/active_record.md
+- docs/after_clone.md
 - docs/after_persist.md
-- docs/alternatives.md
 - docs/architecture.md
-- docs/basic_example.md
+- docs/assets/docsify.min.js
+- docs/assets/prism-ruby.min.js
+- docs/assets/styles.css
+- docs/assets/vue.css
 - docs/clone_mapper.md
 - docs/customization.md
 - docs/exclude_association.md
 - docs/finalize.md
 - docs/from_v02_to_v1.md
+- docs/getting_started.md
 - docs/implicit_cloner.md
 - docs/include_association.md
+- docs/index.html
 - docs/init_as.md
 - docs/inline_configuration.md
-- docs/installation.md
 - docs/nullify.md
 - docs/operation.md
-- docs/overview.md
 - docs/parameters.md
 - docs/sequel.md
 - docs/supported_adapters.md
 - docs/testing.md
 - docs/traits.md
-- docs/web/.gitignore
-- docs/web/README.md
-- docs/web/core/Footer.js
-- docs/web/i18n/en.json
-- docs/web/package.json
-- docs/web/pages/en/help.js
-- docs/web/pages/en/index.js
-- docs/web/pages/en/users.js
-- docs/web/sidebars.json
-- docs/web/siteConfig.js
-- docs/web/static/css/custom.css
-- docs/web/static/fonts/FiraCode-Medium.woff
-- docs/web/static/fonts/FiraCode-Regular.woff
-- docs/web/static/img/favicon/favicon.ico
-- docs/web/yarn.lock
 - gemfiles/activerecord42.gemfile
 - gemfiles/jruby.gemfile
 - gemfiles/railsmaster.gemfile
@@ -178,6 +193,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 +218,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 +234,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
@@ -231,10 +249,15 @@ files:
 - lib/clowne/utils/params.rb
 - lib/clowne/utils/plan.rb
 - lib/clowne/version.rb
-homepage: https://github.com/palkan/clowne
+homepage: https://github.com/clowne-rb/clowne
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://github.com/clowne-rb/clowne/issues
+  changelog_uri: https://github.com/clowne-rb/clowne/blob/master/CHANGELOG.md
+  documentation_uri: https://clowne.evilmartians.io/
+  homepage_uri: https://clowne.evilmartians.io/
+  source_code_uri: http://github.com/clowne-rb/clowne
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -250,9 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: A flexible gem for cloning your models.
+summary: A flexible gem for cloning your models
 test_files: []

data/.travis.yml

@@ -1,55 +0,0 @@
-sudo: false
-language: ruby
-
-notifications:
-  email: false
-
-before_install:
-  - gem update --system
-  - gem install bundler
-
-before_script:
-  # Only generate coverage report for the specified job
-  - if [ "$CC_REPORT" == "true" ]; then curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter; fi
-  - if [ "$CC_REPORT" == "true" ]; then chmod +x ./cc-test-reporter; fi
-  - if [ "$CC_REPORT" == "true" ]; then ./cc-test-reporter before-build; fi
-script:
-  - bundle exec rake
-  - if [ "$CC_REPORT" == "true" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
-  - if [ "$DEPLOY_ME" == "true" ]; then (cd ./docs/web && yarn && yarn run build); fi
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: jruby-9.2.5.0
-      gemfile: gemfiles/jruby.gemfile
-    - rvm: jruby-9.1.15.0
-      gemfile: gemfiles/jruby.gemfile
-    - rvm: 2.5.0
-      gemfile: Gemfile
-    - rvm: 2.4.3
-      gemfile: Gemfile
-      env:
-        - CC_REPORT=true
-        - DEPLOY_ME=true
-    - rvm: 2.4.1
-      gemfile: gemfiles/activerecord42.gemfile
-    - rvm: 2.3.1
-      gemfile: Gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: jruby-9.2.5.0
-      gemfile: gemfiles/jruby.gemfile
-    - rvm: jruby-9.1.15.0
-      gemfile: gemfiles/jruby.gemfile
-deploy:
-  provider: pages
-  skip_cleanup: true
-  github_token: $GITHUB_TOKEN
-  local_dir: "./docs/web/build/clowne"
-  on:
-    branch: master
-    condition: $DEPLOY_ME = true

data/docs/alternatives.md

@@ -1,26 +0,0 @@
----
-id: alternatives
-title: Motivation & Alternatives
----
-
-### Why did we decide to build our own cloning gem instead of using the existing solutions?
-
-First, the existing solutions turned out not to be stable and flexible enough for us.
-
-Secondly, they are Rails-only (or, more precisely, ActiveRecord-only).
-
-Nevertheless, thanks to [amoeba](https://github.com/amoeba-rb/amoeba) and [deep_cloneable](https://github.com/moiristo/deep_cloneable) for inspiration.
-
-For ActiveRecord we support amoeba-like [in-model configuration](active_record.md) and you can add missing DSL declarations yourself [easily](customization.md).
-
-We also provide an ability to specify cloning [configuration in-place](inline_configuration.md) like `deep_clonable` does.
-
-So, we took the best of these too and brought to the outside-of-Rails world.
-
-### Why build a gem to clone models at all?
-
-That's a good question. Of course, you can write plain old Ruby services do handle the cloning logic. But for complex models hierarchies, this approach has major disadvantages: high code complexity and lack of re-usability.
-
-The things become even worse when you deal with STI models and different cloning contexts.
-
-That's why we decided to build a specific cloning tool.

data/docs/basic_example.md

@@ -1,83 +0,0 @@
----
-id: basic_example
-title: Basic Example
----
-
-Assume that you have the following model:
-
-```ruby
-class User < ActiveRecord::Base
-  # create_table :users do |t|
-  #  t.string :login
-  #  t.string :email
-  #  t.timestamps null: false
-  # end
-
-  has_one :profile
-  has_many :posts
-end
-
-class Profile < ActiveRecord::Base
-  # create_table :profiles do |t|
-  #   t.string :name
-  # end
-end
-
-class Post < ActiveRecord::Base
-  # create_table :posts
-end
-```
-
-Let's declare our cloners first:
-
-```ruby
-class UserCloner < Clowne::Cloner
-  adapter :active_record
-
-  include_association :profile, clone_with: SpecialProfileCloner
-  include_association :posts
-
-  nullify :login
-
-  # params here is an arbitrary Hash passed into cloner
-  finalize do |_source, record, params|
-    record.email = params[:email]
-  end
-end
-
-class SpecialProfileCloner < Clowne::Cloner
-  adapter :active_record
-
-  nullify :name
-end
-```
-
-Now you can use `UserCloner` to clone existing records:
-
-```ruby
-user = User.last
-# => <#User id: 1, login: 'clown', email: 'clown@circus.example.com'>
-
-operation = UserCloner.call(user, email: 'fake@example.com')
-# => <#Clowne::Utils::Operation...>
-
-operation.to_record
-# => <#User id: nil, login: nil, email: 'fake@example.com'>
-
-operation.persist!
-# => true
-
-cloned = operation.to_record
-# => <#User id: 2, login: nil, email: 'fake@example.com'>
-
-cloned.login
-# => nil
-cloned.email
-# => "fake@example.com"
-
-# associations:
-cloned.posts.count == user.posts.count
-# => true
-cloned.profile.name
-# => nil
-```

data/docs/installation.md

@@ -1,46 +0,0 @@
----
-id: installation
-title: Installation & Configuration
----
-
-## Installation
-
-To install Clowne with RubyGems:
-
-```ruby
-gem install clowne
-```
-
-Or add this line to your application's Gemfile:
-
-```ruby
-gem 'clowne'
-```
-
-## Configuration
-
-Basic cloner implementation looks like:
-
-```ruby
-class SomeCloner < Clowne::Cloner
-  adapter :active_record # or adapter Clowne::Adapters::ActiveRecord
-  # some implementation ...
-end
-```
-
-You can configure the default adapter for cloners:
-
-```ruby
-# put to initializer
-# e.g. config/initializers/clowne.rb
-Clowne.default_adapter = :active_record
-```
-
-and skip explicit adapter declaration
-
-```ruby
-class SomeCloner < Clowne::Cloner
-  # some implementation ...
-end
-```
-See the list of [available adapters](supported_adapters.md).

data/docs/overview.md

@@ -1,24 +0,0 @@
----
-id: overview
-title: Overview
----
-
-In [the basic example](basic_example.md), you can see that Clowne consists of flexible DSL which is used in a class inherited of `Clowne::Cloner`.
-
-You can combinate this DSL via [`traits`](traits.md) and make a cloning plan which exactly you want.
-
-**We strongly recommend [`write tests`](testing.md) to cover resulting cloner logic**
-
-Cloner class returns [`Operation`](operation.md) instance as a result of cloning. The operation provides methods to save cloned record. You can wrap this call to a transaction if it is necessary.
-
-## Execution Order
-
-The order of cloning actions depends on the adapter (i.e., could be customized).
-
-All built-in adapters have the same order and what happens when you call `Operation#persist`:
-- init clone (see [`init_as`](init_as.md)) (empty by default)
-- [`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._
-- __SAVE CLONED RECORD__
-- run [`after_persist`](after_persist.md) callbacks

data/docs/web/.gitignore

@@ -1,11 +0,0 @@
-node_modules
-.DS_Store
-lib/core/metadata.js
-lib/core/MetadataBlog.js
-website/translated_docs
-website/build/
-website/yarn.lock
-website/node_modules
-
-website/i18n/*
-!website/i18n/en.json

data/docs/web/README.md

@@ -1,6 +0,0 @@
-# Clowne Docs
-
-1. Install `node` and `yarn`
-2. `$ yarn` - install frontend deps
-3. `$ yarn run start --port 3002`
-4. `$ open http://localhost:3002`