clowne 0.2.0 → 1.0.0

data/docs/web/pages/en/index.js

@@ -82,7 +82,7 @@ class HomeSplash extends React.Component {
         <div className="inner">
           <ProjectTitle />
           <PromoSection>
-            <Button href="/clowne/docs/installation.html">Getting Started</Button>
+            <Button href={docUrl("installation.html")}>Getting Started</Button>
           </PromoSection>
         </div>
       </SplashContainer>

data/docs/web/sidebars.json

@@ -3,29 +3,35 @@
     "Getting Started": [
       "installation",
       "basic_example",
-      "configuration",
+      "overview",
       "alternatives"
     ],
     "API": [
+      "operation",
       "include_association",
       "exclude_association",
       "nullify",
       "finalize",
+      "after_persist",
       "init_as",
       "traits",
-      "parameters",
-      "execution_order"
+      "parameters"
     ],
     "Adapters": [
       "supported_adapters",
       "active_record",
       "sequel"
     ],
-    "Features": [
+    "Advanced Options": [
       "implicit_cloner",
       "inline_configuration",
+      "clone_mapper",
       "architecture",
+      "testing",
       "customization"
+    ],
+    "Upgrade Notes": [
+      "from_v02_to_v10"
     ]
   }
 }

data/docs/web/siteConfig.js

@@ -8,8 +8,9 @@
 const siteConfig = {
   title: 'Clowne' /* title for your website */,
   tagline: 'A flexible gem for cloning your models',
-  url: 'https://github.com/palkan/clowne' /* your website url */,
-  baseUrl: '/clowne/' /* base url for your project */,
+  url: 'http://clowne.evilmartians.io' /* your website url */,
+  cname: 'clowne.evilmartians.io',
+  baseUrl: '/' /* base url for your project */,
   customDocsPath: '../docs',
   projectName: 'clowne',
   headerLinks: [
@@ -22,7 +23,7 @@ const siteConfig = {
   favicon: 'img/favicon/favicon.ico',
   /* colors for website */
   colors: {
-    primaryColor: '#111111', // '#ff5e5e'
+    primaryColor: '#9FA628', // '#ff5e5e'
     secondaryColor: '#e3e3e3',
   },
   // This copyright info is used in /core/Footer.js and blog rss/atom feeds.
@@ -33,12 +34,13 @@ const siteConfig = {
   // organizationName: 'deltice', // or set an env variable ORGANIZATION_NAME
   highlight: {
     // Highlight.js theme to use for syntax highlighting in code blocks
-    theme: 'ascetic',    
+    theme: 'atom-one-light',
   },
   scripts: ['https://buttons.github.io/buttons.js'],
   // You may provide arbitrary config keys to be used as needed by your template.
   repoUrl: 'https://github.com/palkan/clowne',
   gemUrl: 'https://rubygems.org/gems/clowne',
+  gaTrackingId: 'UA-104346673-2',
 };
 
 module.exports = siteConfig;

data/docs/web/static/css/custom.css

@@ -4,13 +4,13 @@
   font-weight: 400;
   font-style: normal;
   font-family: "Stem Text";
-  src: url("../fonts/StemText.woff") format("woff");
+  src: url("//cdn.evilmartians.com/front/fonts/subset-StemText-Regular.woff") format("woff");
 }
 @font-face {
   font-weight: 700;
   font-style: normal;
   font-family: "Stem Text";
-  src: url("../fonts/StemTextBold.woff") format("woff");
+  src: url("//cdn.evilmartians.com/front/fonts/subset-StemText-Bold.woff") format("woff");
 }
 
 @font-face {
@@ -49,16 +49,15 @@ footer .sitemap div {
 }
 
 .fixedHeaderContainer a {
-  color: #111; /* #ff5e5e; */
+  color: #9FA628;
 }
 
 header h2 {
-  color: #111; /* #ff5e5e; */
+  color: #9FA628;
   text-transform: uppercase;
 }
 
 .container .wrapper h2 {
-  color: #111; /* #ff5e5e; */
   font-weight: bold;
 }
 
@@ -66,6 +65,14 @@ header h2 {
   text-decoration: underline;
 }
 
+.projectTitle {
+  color: #111;
+}
+
+.projectTitleName {
+  color: #9FA628;
+}
+
 .mainContainer .wrapper a:hover {
   text-decoration: none;
 }
@@ -79,7 +86,7 @@ small {
 }
 
 .navigationSlider .slidingNav ul li a {
-  color: #111; /* #ff5e5e; */
+  color: #9FA628;
 }
 
 nav.toc .toggleNav .navGroup.navGroupActive {
@@ -91,9 +98,8 @@ nav.toc .toggleNav .navGroup.navGroupActive {
   margin-bottom: 30px;
 }
 
-/* Make ascetic theme comments a little bit darker */
-.hljs-comment, .hljs-quote, .hljs-meta, .hljs-deletion {
-  color: #a7a7a7;
+.hljs-doctag {
+  color: #a0a1a7;
 }
 
 @keyframes humanoids-blink{
@@ -226,4 +232,4 @@ footer h5{
 .mainContainer {
   background: none;
   border-top: 1px solid #e3e3e3;
-}
+}

data/gemfiles/activerecord42.gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'activerecord', '~> 4.2'
 gem 'sequel', '>= 5.0'
-gem 'sqlite3'
+gem 'sqlite3', '~> 1.3.6'
 
 gemspec path: '..'

data/gemfiles/jruby.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'activerecord-jdbcsqlite3-adapter', '~> 50.0'

data/gemfiles/railsmaster.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'arel', github: 'rails/arel'

data/lib/clowne.rb

@@ -9,11 +9,13 @@ 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'
   }.freeze
+  # rubocop:enable AlignHash
 
   class << self
     attr_reader :default_adapter, :raise_on_override
@@ -29,6 +31,7 @@ module Clowne
       elsif adapter.is_a?(Symbol)
         adapter_class = ADAPTERS[adapter]
         raise "Unknown adapter: #{adapter}" if adapter_class.nil?
+
         Clowne::Adapters.const_get(adapter_class).new
       else
         adapter

data/lib/clowne/adapters/active_record.rb

@@ -5,8 +5,7 @@ require 'clowne/ext/orm_ext'
 module Clowne
   module Adapters
     # Cloning adapter for ActiveRecord
-    class ActiveRecord < Base
-    end
+    class ActiveRecord < Base; end
   end
 end
 
@@ -15,4 +14,4 @@ ActiveSupport.on_load(:active_record) do
 end
 
 require 'clowne/adapters/active_record/associations'
-require 'clowne/adapters/active_record/association'
+require 'clowne/adapters/active_record/resolvers/association'

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

@@ -9,10 +9,6 @@ module Clowne
         class Base < Base::Association
           private
 
-          def clone_record(record)
-            record.dup
-          end
-
           def init_scope
             association
           end

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

@@ -9,7 +9,8 @@ module Clowne
           def call(record)
             child = association
             return record unless child
-            unless scope.nil?
+
+            unless declaration.scope.nil?
               warn(
                 '[Clowne] Has one association does not support scopes ' \
                 "(#{@association_name} for #{@source.class})"

data/lib/clowne/adapters/active_record/resolvers/association.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Clowne
+  module Adapters # :nodoc: all
+    class ActiveRecord
+      module Resolvers
+        class UnknownAssociation < StandardError; end
+
+        class Association
+          class << self
+            # rubocop: disable Metrics/ParameterLists
+            def call(source, record, declaration, adapter:, params:, **_options)
+              reflection = source.class.reflections[declaration.name.to_s]
+
+              if reflection.nil?
+                raise UnknownAssociation,
+                      "Association #{declaration.name} couldn't be found for #{source.class}"
+              end
+
+              cloner_class = Associations.cloner_for(reflection)
+
+              cloner_class.new(reflection, source, declaration, adapter, params).call(record)
+
+              record
+            end
+            # rubocop: enable Metrics/ParameterLists
+          end
+        end
+      end
+    end
+  end
+end
+
+Clowne::Adapters::ActiveRecord.register_resolver(
+  :association,
+  Clowne::Adapters::ActiveRecord::Resolvers::Association,
+  before: :nullify
+)

data/lib/clowne/adapters/base.rb

@@ -2,46 +2,34 @@
 
 require 'clowne/adapters/registry'
 
+require 'clowne/resolvers/init_as'
+require 'clowne/resolvers/nullify'
+require 'clowne/resolvers/finalize'
+require 'clowne/resolvers/after_persist'
+
 module Clowne
   module Adapters
     # ORM-independant adapter (just calls #dup).
     # Works with nullify/finalize.
     class Base
-      class << self
-        attr_reader :registry
-
-        def inherited(subclass)
-          # Duplicate registry
-          subclass.registry = registry.dup
-        end
-
-        def resolver_for(type)
-          registry.mapping[type] || raise("Uknown resolver #{type} for #{self}")
-        end
+      include Clowne::Adapters::Registry::Container
 
-        def register_resolver(type, resolver, after: nil, before: nil, prepend: nil)
-          registry.mapping[type] = resolver
-
-          if prepend
-            registry.unshift type
-          elsif after
-            registry.insert_after after, type
-          elsif before
-            registry.insert_before before, type
-          else
-            registry.append type
+      class << self
+        # Duplicate record and remember record <-> clone relationship in operation
+        # Cab be overrided in special adapter
+        # +record+:: Instance of record (ActiveRecord or Sequel)
+        def dup_record(record)
+          record.dup.tap do |clone|
+            operation = operation_class.current
+            operation.add_mapping(record, clone)
           end
         end
 
-        protected
-
-        attr_writer :registry
-      end
-
-      self.registry = Registry.new
-
-      def registry
-        self.class.registry
+        # Operation class which  using for cloning
+        # Cab be overrided in special adapter
+        def operation_class
+          Clowne::Utils::Operation
+        end
       end
 
       # Using a plan make full duplicate of record
@@ -50,19 +38,13 @@ module Clowne
       # +params+:: Custom params hash
       def clone(source, plan, params: {})
         declarations = plan.declarations
-        declarations.inject(init_record(dup_source(source))) do |record, (type, declaration)|
+        init_record = init_record(self.class.dup_record(source))
+
+        declarations.inject(init_record) do |record, (type, declaration)|
           resolver_for(type).call(source, record, declaration, params: params, adapter: self)
         end
       end
 
-      def resolver_for(type)
-        self.class.resolver_for(type)
-      end
-
-      def dup_source(source)
-        source.dup
-      end
-
       def init_record(record)
         # Override in custom adapters
         record
@@ -71,6 +53,23 @@ module Clowne
   end
 end
 
-require 'clowne/adapters/base/init_as'
-require 'clowne/adapters/base/nullify'
-require 'clowne/adapters/base/finalize'
+Clowne::Adapters::Base.register_resolver(
+  :init_as,
+  Clowne::Resolvers::InitAs,
+  prepend: true
+)
+
+Clowne::Adapters::Base.register_resolver(
+  :nullify,
+  Clowne::Resolvers::Nullify
+)
+
+Clowne::Adapters::Base.register_resolver(
+  :finalize, Clowne::Resolvers::Finalize,
+  after: :nullify
+)
+
+Clowne::Adapters::Base.register_resolver(
+  :after_persist, Clowne::Resolvers::AfterPersist,
+  after: :finalize
+)

data/lib/clowne/adapters/base/association.rb

@@ -9,16 +9,15 @@ module Clowne
         # +source+:: Instance of cloned object (ex: User.new(posts: posts))
         # +declaration+:: = Relation description
         #                   (ex: Clowne::Declarations::IncludeAssociation.new(:posts))
+        # +adapter+:: Clowne adapter
         # +params+:: = Instance of Hash
-        def initialize(reflection, source, declaration, params)
+        def initialize(reflection, source, declaration, adapter, params)
           @source = source
-          @scope = declaration.scope
-          @clone_with = declaration.clone_with
+          @declaration = declaration
+          @adapter = adapter
           @params = params
           @association_name = declaration.name.to_s
           @reflection = reflection
-          @cloner_options = declaration.params_proxy.permit(params: params, parent: source)
-          @cloner_options.merge!(traits: declaration.traits) if declaration.traits
         end
 
         def call(_record)
@@ -31,24 +30,24 @@ module Clowne
 
         def clone_one(child)
           cloner = cloner_for(child)
-          cloner ? cloner.call(child, cloner_options) : clone_record(child)
+          cloner ? cloner.call(child, cloner_options) : dup_record(child)
         end
 
         def with_scope
-          base_scope = init_scope
+          scope = declaration.scope
           if scope.is_a?(Symbol)
-            base_scope.__send__(scope)
+            init_scope.__send__(scope)
           elsif scope.is_a?(Proc)
-            base_scope.instance_exec(params, &scope) || base_scope
+            init_scope.instance_exec(params, &scope) || init_scope
           else
-            base_scope
+            init_scope
           end.to_a
         end
 
         private
 
-        def clone_record(_record)
-          raise NotImplementedError
+        def dup_record(record)
+          adapter.class.dup_record(record)
         end
 
         def init_scope
@@ -56,13 +55,23 @@ module Clowne
         end
 
         def cloner_for(child)
-          return clone_with if clone_with
+          return declaration.clone_with if declaration.clone_with
 
           return child.class.cloner_class if child.class.respond_to?(:cloner_class)
         end
 
-        attr_reader :source, :scope, :clone_with, :params, :association_name,
-                    :reflection, :cloner_options
+        def cloner_options
+          return @_cloner_options if defined?(@_cloner_options)
+
+          @_cloner_options = declaration.params_proxy.permit(
+            params: params, parent: source
+          ).tap do |options|
+            options[:adapter] = adapter
+            options.merge!(traits: declaration.traits) if declaration.traits
+          end
+        end
+
+        attr_reader :source, :declaration, :adapter, :params, :association_name, :reflection
       end
     end
   end