clowne 1.1.0 → 1.2.0

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,25 +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._
-- run [`after_clone`](after_clone.md) callbacks
-- __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`

data/docs/web/core/Footer.js

@@ -1,88 +0,0 @@
-/**
- * Copyright (c) 2017-present, Facebook, Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-const React = require('react');
-
-class Footer extends React.Component {
-  docUrl(doc, language) {
-    const baseUrl = this.props.config.baseUrl;
-    return baseUrl + 'docs/' + (language ? language + '/' : '') + doc;
-  }
-
-  pageUrl(doc, language) {
-    const baseUrl = this.props.config.baseUrl;
-    return baseUrl + (language ? language + '/' : '') + doc;
-  }
-
-  render() {
-    const currentYear = new Date().getFullYear();
-
-    const yearLabel = currentYear > 2018 ? `2018–${currentYear}` : currentYear;
-
-    return (
-      <footer className="nav-footer" id="footer">
-        <section className="sitemap">
-          <div className="footer--block">
-            <h5>Project</h5>
-            <div className="footer--list--item">
-              <a href={this.props.config.repoUrl} target="_blank">
-                GitHub
-              </a>
-            </div>
-            <div className="footer--list--item">
-              <a href={this.props.config.gemUrl} target="_blank">
-                RubyGems
-              </a>
-            </div>
-          </div>
-          {/* <div className="footer--block">
-            <h5>Community</h5>
-              <div className="footer--list--item">
-                <a href="https://discordapp.com/" target="_blank">Project Chat</a>
-              </div>
-              <div className="footer--list--item">
-                <a href="https://twitter.com/" target="_blank">
-                  Twitter
-                </a>
-              </div>
-          </div>
-          */}
-          <div className="footer--block">
-            <h5>Resources</h5>
-              <div className="footer--list--item">
-                <a href="https://evilmartians.com/chronicles/clowne-clone-ruby-models-with-a-smile" target="_blank">Clowne: clone Ruby models with a smile</a>
-              </div>
-          </div>
-          <div className="footer--block legals">
-            <p className="footer--copy">
-              <span className="copy">{yearLabel}</span>&nbsp;
-              <a href="https://evilmartians.com" target="_blank">Evil Martians</a>
-            </p>
-            <div className="footer--list--item">
-              <p>Released under the <a href="https://github.com/palkan/clowne/blob/master/LICENSE.txt" target="_blank">MIT license</a></p>
-            </div>
-            <div className="footer--list--item">
-              <p>Built with <a href="https://docusaurus.io" target="_blank">Docusaurus</a></p>
-            </div>
-          </div>
-        </section>
-        <div className="footer--humanoids">
-          <div className="humanoids">
-            <div className="humanoids__martian">
-              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 108 92"><path fill="#E2CBB5" d="M26 88L8 78l18-10"></path><path fill="#9FA628" d="M94 92v-6H44c-5.5 0-10-4.5-10-10s4.5-10 10-10h50V32c0-14-7.9-22-22-22H48c-14.1 0-22 8-22 22v60h68z"></path><circle fill="#FFF" cx="48" cy="50" r="8"></circle><circle fill="#FFF" cx="72" cy="50" r="8"></circle><circle fill="#BF6C35" cx="48" cy="50" r="4"></circle><circle fill="#BF6C35" cx="72" cy="50" r="4"></circle><g fill="#663F4C"><path d="M48 60c-5.5 0-10-4.5-10-10s4.5-10 10-10 10 4.5 10 10-4.5 10-10 10zm0-16c-3.3 0-6 2.7-6 6s2.7 6 6 6 6-2.7 6-6-2.7-6-6-6zM82 50c0 5.5-4.5 10-10 10s-10-4.5-10-10 4.5-10 10-10 10 4.5 10 10zm-16 0c0 3.3 2.7 6 6 6s6-2.7 6-6-2.7-6-6-6-6 2.7-6 6z"></path><path d="M102 8c-3.8 0-6-2.2-6-6 0-1.1-.9-2-2-2s-2 .9-2 2c0 2.2.5 4.1 1.5 5.7L88.2 13c-4-3.3-9.5-5-16.2-5H48c-6.7 0-12.2 1.7-16.2 4.9l-5.3-5.3C27.5 6.1 28 4.2 28 2c0-1.1-.9-2-2-2s-2 .9-2 2c0 3.8-2.2 6-6 6-1.1 0-2 .9-2 2s.9 2 2 2c2.2 0 4.1-.5 5.7-1.5l5.3 5.3c-3.2 4-4.9 9.5-4.9 16.2v34.8L3.9 78 24 89v3h4V32c0-12.9 7.1-20 20-20h24c12.9 0 20 7.1 20 20v32H44c-6.6 0-12 5.4-12 12s5.4 12 12 12h48v4h4v-8h-2l-4-8-4 8h-4l-4-8-4 8h-4l-4-8-4 8h-4l-4-8-4 8h-4l-4-8-3.1 6.2C37.1 80.7 36 78.5 36 76c0-4.4 3.6-8 8-8l4 8 4-8h4l4 8 4-8h4l4 8 4-8h4l4 8 4-8h8V32c0-6.7-1.7-12.2-4.9-16.2l5.3-5.3c1.6 1 3.5 1.5 5.7 1.5 1.1 0 2-.9 2-2s-1-2-2.1-2zM24 84.4L12.1 78 24 71.4v13z"></path></g></svg>
-            </div>
-            <div className="humanoids__human">
-              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 108 92"><path fill="#E2CBB5" d="M14 62v30h68v-6H32c-5.5 0-10-4.5-10-10s4.5-10 10-10h50v-4c4 0 8-3.6 8-8s-4-8-8-8V32c0-14-7.9-22-22-22H36c-14.1 0-22 8-22 22v14c-4 0-8 3.6-8 8s4 8 8 8z"></path><circle fill="#FFF" cx="36" cy="50" r="8"></circle><circle fill="#FFF" cx="60" cy="50" r="8"></circle><circle fill="#9FA628" cx="36" cy="50" r="4"></circle><circle fill="#9FA628" cx="60" cy="50" r="4"></circle><path fill="#BF6C35" d="M60 10H36c-14.1 0-22 8-22 22v2l4-4 6 6 6-6 6 6 6-6 6 6 6-6 6 6 6-6 6 6 6-6 4 4v-2c0-14-7.9-22-22-22z"></path><g fill="#663F4C"><path d="M36 60c-5.5 0-10-4.5-10-10s4.5-10 10-10 10 4.5 10 10-4.5 10-10 10zm0-16c-3.3 0-6 2.7-6 6s2.7 6 6 6 6-2.7 6-6-2.7-6-6-6zM60 60c-5.5 0-10-4.5-10-10s4.5-10 10-10 10 4.5 10 10-4.5 10-10 10zm0-16c-3.3 0-6 2.7-6 6s2.7 6 6 6 6-2.7 6-6-2.7-6-6-6z"></path><path d="M12 63.8V92h4V32c0-12.9 7.1-20 20-20h24c12.9 0 20 7.1 20 20v32H32c-6.6 0-12 5.4-12 12s5.4 12 12 12h48v4h4v-8H74v-1c0-1.7-1.3-3-3-3s-3 1.3-3 3v1h-6v-1c0-1.7-1.3-3-3-3s-3 1.3-3 3v1h-6v-1c0-1.7-1.3-3-3-3s-3 1.3-3 3v1h-6v-1c0-1.7-1.3-3-3-3s-3 1.3-3 3v1c-4 0-8-3.6-8-8s3.6-8 8-8h6v1c0 1.7 1.3 3 3 3s3-1.3 3-3v-1h6v1c0 1.7 1.3 3 3 3s3-1.3 3-3v-1h6v1c0 1.7 1.3 3 3 3s3-1.3 3-3v-1h6v1c0 1.7 1.3 3 3 3s3-1.3 3-3v-1h4v-4.2c5-.9 8-5 8-9.8s-3-8.9-8-9.8V32c0-15.3-8.7-24-24-24H36c-15.3 0-24 8.7-24 24v12.2c-5 .9-8 5-8 9.8s3 8.9 8 9.8zm72-15.5c2 .8 4 3 4 5.7s-2 4.8-4 5.7V48.3zm-72 0v11.3c-2-.8-4-3-4-5.7s2-4.7 4-5.6z"></path></g></svg>
-            </div>
-          </div>
-        </div>
-      </footer>
-    );
-  }
-}
-
-module.exports = Footer;

data/docs/web/i18n/en.json

@@ -1,141 +0,0 @@
-{
-  "_comment": "This file is auto-generated by write-translations.js",
-  "localized-strings": {
-    "next": "Next",
-    "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",
-    "basic_example": "Basic Example",
-    "clone_mapper": "Clone mapper",
-    "customization": "Customization",
-    "exclude_association": "Exclude Association",
-    "finalize": "Finalization",
-    "Finalize": "Finalize",
-    "from_v02_to_v10": "From v0.2.x to v1.0.0",
-    "implicit_cloner": "Implicit Cloner",
-    "include_association": "Include Association",
-    "init_as": "Initialize Cloning Target",
-    "Init As": "Init As",
-    "inline_configuration": "Inline Configuration",
-    "installation": "Installation & Configuration",
-    "nullify": "Nullify Attributes",
-    "Nullify": "Nullify",
-    "operation": "Operation",
-    "overview": "Overview",
-    "parameters": "Parameters",
-    "sequel": "Sequel",
-    "supported_adapters": "Supported Adapters",
-    "testing": "Testing",
-    "traits": "Traits",
-    "HISTORY": "HISTORY",
-    "README": "README",
-    "readme": "readme",
-    "CHANGES": "CHANGES",
-    "LICENSE": "LICENSE",
-    "CHANGELOG": "CHANGELOG",
-    "CONTRIBUTING": "CONTRIBUTING",
-    "History": "History",
-    "Readme": "Readme",
-    "extending-remarkable": "extending-remarkable",
-    "local-third-party-project-testing": "local-third-party-project-testing",
-    "publish": "publish",
-    "testing-changes-on-Docusaurus-itself": "testing-changes-on-Docusaurus-itself",
-    "CODE_OF_CONDUCT": "CODE_OF_CONDUCT",
-    "2016-03-11-blog-post": "Blog Title",
-    "2017-04-10-blog-post-two": "New Blog Post",
-    "2017-09-25-testing-rss": "Adding RSS Support - RSS Truncation Test",
-    "2017-09-26-adding-rss": "Adding RSS Support",
-    "2017-10-24-new-version-1.0.0": "New Version 1.0.0",
-    "doc1": "Latin-ish",
-    "Example Page": "Example Page",
-    "doc2": "document number 2",
-    "doc3": "This is document number 3",
-    "doc4": "Other Document",
-    "doc5": "Fifth Document",
-    "copy-sync": "copy-sync",
-    "copy": "copy",
-    "emptyDir-sync": "emptyDir-sync",
-    "emptyDir": "emptyDir",
-    "ensureDir-sync": "ensureDir-sync",
-    "ensureDir": "ensureDir",
-    "ensureFile-sync": "ensureFile-sync",
-    "ensureFile": "ensureFile",
-    "ensureLink-sync": "ensureLink-sync",
-    "ensureLink": "ensureLink",
-    "ensureSymlink-sync": "ensureSymlink-sync",
-    "ensureSymlink": "ensureSymlink",
-    "fs-read-write": "fs-read-write",
-    "move-sync": "move-sync",
-    "move": "move",
-    "outputFile-sync": "outputFile-sync",
-    "outputFile": "outputFile",
-    "outputJson-sync": "outputJson-sync",
-    "outputJson": "outputJson",
-    "pathExists-sync": "pathExists-sync",
-    "pathExists": "pathExists",
-    "readJson-sync": "readJson-sync",
-    "readJson": "readJson",
-    "remove-sync": "remove-sync",
-    "remove": "remove",
-    "writeJson-sync": "writeJson-sync",
-    "writeJson": "writeJson",
-    "changelog": "changelog",
-    "http_signing": "http_signing",
-    "Changelog": "Changelog",
-    "license": "license",
-    "ERROR-HANDLING": "ERROR-HANDLING",
-    "LIMITS": "LIMITS",
-    "block-bq-flat": "block-bq-flat",
-    "block-bq-nested": "block-bq-nested",
-    "block-code": "block-code",
-    "block-fences": "block-fences",
-    "block-heading": "block-heading",
-    "block-hr": "block-hr",
-    "block-html": "block-html",
-    "block-lheading": "block-lheading",
-    "block-list-flat": "block-list-flat",
-    "block-list-nested": "block-list-nested",
-    "block-ref-flat": "block-ref-flat",
-    "block-ref-nested": "block-ref-nested",
-    "block-tables-large": "block-tables-large",
-    "block-tables": "block-tables",
-    "inline-autolink": "inline-autolink",
-    "inline-backticks": "inline-backticks",
-    "inline-em-flat": "inline-em-flat",
-    "inline-em-nested": "inline-em-nested",
-    "inline-em-worst": "inline-em-worst",
-    "inline-entity": "inline-entity",
-    "inline-escape": "inline-escape",
-    "inline-html": "inline-html",
-    "inline-links-flat": "inline-links-flat",
-    "inline-links-nested": "inline-links-nested",
-    "inline-newlines-large": "inline-newlines-large",
-    "inline-newlines": "inline-newlines",
-    "rawtabs": "rawtabs",
-    "example": "example",
-    "parser": "parser",
-    "parsing_block": "parsing_block",
-    "parsing_core": "parsing_core",
-    "parsing_inline": "parsing_inline",
-    "plugins": "plugins",
-    "renderer": "renderer",
-    "AUTHORS": "AUTHORS",
-    "PULL_REQUEST_TEMPLATE": "PULL_REQUEST_TEMPLATE",
-    "Docs": "Docs",
-    "GitHub": "GitHub",
-    "Getting Started": "Getting Started",
-    "API": "API",
-    "Adapters": "Adapters",
-    "Advanced Options": "Advanced Options",
-    "Upgrade Notes": "Upgrade Notes"
-  },
-  "pages-strings": {
-    "Help Translate|recruit community translators for your project": "Help Translate",
-    "Edit this Doc|recruitment message asking to edit the doc source": "Edit",
-    "Translate this Doc|recruitment message asking to translate the docs": "Translate"
-  }
-}

data/docs/web/package.json

@@ -1,14 +0,0 @@
-{
-  "scripts": {
-    "examples": "docusaurus-examples",
-    "start": "docusaurus-start",
-    "build": "docusaurus-build",
-    "publish-gh-pages": "docusaurus-publish",
-    "write-translations": "docusaurus-write-translations",
-    "version": "docusaurus-version",
-    "rename-version": "docusaurus-rename-version"
-  },
-  "devDependencies": {
-    "docusaurus": "^1.0.5"
-  }
-}