clowne 0.1.0.beta1 → 0.1.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d56daf439132f64870a49326ff8afe5465691b7
-  data.tar.gz: b273e7e236eee799de5a5ea7386c05d26a173b04
+  metadata.gz: b833f076ba69c9b626d4038e977e4a40d8de8dbb
+  data.tar.gz: 271303497d931c2773c8c4f948baacfa9819cd4a
 SHA512:
-  metadata.gz: d55650b452063d8eeadbcc3c4a2c1c648c3b5d7c18905ac2d0f7dee05e734358dd19798f7382b284676b693628dcde4fb237e937ce0fafd68f4b2ba860c183fd
-  data.tar.gz: 35463db710e77b7320ff114d1b1fd011ccf9d7405216565420b885ee9b989be8ce734b17ec7c3dbd07017326a1921b0fe4632afff141603f2b41520cce60d238
+  metadata.gz: f4df02c8872ecdc0b1f70fd74a12549065aaf85cd6922b2648043905f3eba9d4bf415716a11b5f0a8f458d7c59d11edbe590e2e1c92f3328887ab9da38c7de1b
+  data.tar.gz: '0683a5756b9797ac8c2a9cd60a4adbd29c214b9dbd55ef3fd736e2e05b414a7b0d92493edcde7e9a109434ceb67ca557cc55953ec08f1caad2a2c35e13ac1439'

data/.rubocop.yml

@@ -14,10 +14,6 @@ Rails:
 Naming/AccessorMethodName:
   Enabled: false
 
-Naming/ClassAndModuleCamelCase:
-  Exclude:
-    - 'spec/**/*.rb'
-
 Style/TrivialAccessors:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,8 +1,6 @@
 # Change log
 
-## master
-
-## 0.1.0.beta1 (2018-01-08)
+## master branch
 
 - Initial version. ([@ssnickolay][], [@palkan][])
 

data/README.md

@@ -1,10 +1,11 @@
 [![Gem Version](https://badge.fury.io/rb/clowne.svg)](https://badge.fury.io/rb/clowne)
 [![Build Status](https://travis-ci.org/palkan/clowne.svg?branch=master)](https://travis-ci.org/palkan/clowne)
+[![Code Climate](https://codeclimate.com/github/palkan/clowne.svg)](https://codeclimate.com/github/palkan/clowne)
 [![Test Coverage](https://codeclimate.com/github/palkan/clowne/badges/coverage.svg)](https://codeclimate.com/github/palkan/clowne/coverage)
 
 # Clowne
 
-**NOTE**: this is the documentation for pre-release version **0.1.0.beta1**.
+**NOTICE**: gem is currently under heavy development, we plan to release the first version 'till the end of the year. 
 
 A flexible gem for cloning your models. Clowne focuses on ease of use and provides the ability to connect various ORM adapters (currently only ActiveRecord is supported).
 
@@ -64,7 +65,7 @@ class UserCloner < Clowne::Cloner
   include_association :posts
 
   nullify :login
-
+  
   # params here is an arbitrary hash passed into cloner
   finalize do |_source, record, params|
     record.email = params[:email]
@@ -81,38 +82,33 @@ end
 and call it
 
 ```ruby
-cloned = UserCloner.call(User.last, { email: "fake@example.com" })
-cloned.persisted?
+clone = UserCloner.call(User.last, { email: "fake@example.com" })
+clone.persisted?
 # => false
-cloned.save!
-cloned.login
+clone.save!
+clone.login
 # => nil
-cloned.email
+clone.email
 # => "fake@example.com"
 
 # associations:
-cloned.posts.count == User.last.posts.count
+clone.posts.count == User.last.posts.count
 # => true
-cloned.profile.name
+clone.profile.name
 # => nil
 ```
 
 ## <a name="features">Features
 
 - [Configuration](#configuration)
-- [Include association](#include_association)
-- - [Inline configuration](#config-inline)
 - [Include one association](#include_association)
 - - [Scope](#include_association_scope)
 - - [Options](#include_association_options)
-- - [Multiple associations](#include_associations)
 - [Exclude association](#exclude_association)
-- - [Multiple associations](#exclude_associations)
 - [Nullify attribute(s)](#nullify)
 - [Execute finalize block](#finalize)
 - [Traits](#traits)
 - [Execution order](#execution_order)
-- [ActiveRecord DSL](#ar_dsl)
 - [Customization](#customization)
 
 ### <a name="configuration"></a>Configuration
@@ -124,39 +120,6 @@ You can configure the default adapter for cloners:
 Clowne.default_adapter = :active_record
 ```
 
-#### <a name="config-inline"></a>Inline Configuration
-
-You can also enhance the cloner configuration inline (i.e. add dynamic declarations):
-
-```ruby
-cloned = UserCloner.call(User.last) do
-  exclude_association :profile
-
-  finalize do |source, record|
-    record.email = "clone_of_#{source.email}"
-  end
-end
-
-cloned.email
-# => "clone_of_john@example.com"
-
-# associations:
-cloned.posts.size == User.last.posts.size
-# => true
-cloned.profile
-# => nil
-```
-
-Inline enhancement doesn't affect the _global_ configuration, so you can use it without any fear.
-
-Thus it's also possible to clone objects without any cloner classes at all by using `Clowne::Cloner`:
-
-```ruby
-cloned = Clowne::Cloner.call(user) do
-  # anything you want!
-end
-```
-
 ### <a name="include_association"></a>Include one association
 
 Powerful declaration for including model's association.
@@ -260,23 +223,6 @@ UserCloner.call(user)
 
 **Notice: if custom cloner is not defined, clowne tries to find default cloner and use it. (PostCloner for previous example)**
 
-#### <a name="include_associations"></a>Include multiple association
-
-It's possible to include multiple associations at once with default options and scope
-
-```ruby
-class User < ActiveRecord::Base
-  has_many :accounts
-  has_many :posts
-end
-
-class UserCloner < Clowne::Cloner
-  adapter :active_record
-
-  include_associations :accounts, :posts
-end
-```
-
 ### <a name="exclude_association"></a>Exclude association
 
 Exclude association from copying
@@ -322,10 +268,6 @@ clone.comments.empty? #=> true
 Why so? That allows to have deterministic cloning plans when combining multiple traits
 (or inheriting cloners).
 
-#### <a name="exclude_associations"></a>Exclude multiple association
-
-It's possible to exclude multiple associations the same way as `include_associations` but with `exclude_associations`
-
 ### <a name="nullify"></a>Nullify attribute(s)
 
 Nullify attributes:
@@ -437,38 +379,6 @@ For ActiveRecord:
 - run `finalize` blocks
 The order of `finalize` blocks is the order they've been written.
 
-### <a name="ar_dsl"></a>Active Record DSL
-
-Clowne provides an optional ActiveRecord integration which allows you to configure cloners in your models and adds a shortcut to invoke cloners (`#clowne` method). (Note: that's exactly the way [`amoeba`](https://github.com/amoeba-rb/amoeba) works).
-
-To enable this integration you must require `"clowne/adapters/active_record/dsl"` somewhere in your app, e.g. in initializer:
-
-```ruby
-# config/initializers/clowne.rb
-require "clowne/adapters/active_record/dsl"
-```
-
-Now you can specify cloning configs in your AR models:
-
-```ruby
-class User < ActiveRecord::Base
-  clowne_config do
-    include_associations :profile
-
-    nullify :email
-
-    # whatever available for your cloners,
-    # active_record adapter is set implicitly here
-  end
-end
-```
-
-And then you can clone objects like this:
-
-```ruby
-cloned_user = user.clowne(traits: my_traits, **params)
-```
-
 ### <a name="customization"></a>Customization
 
 Clowne is built with extensibility in mind. You can create your own DSL commands and resolvers.

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

@@ -5,16 +5,10 @@ module Clowne
     class ActiveRecord
       module Associations
         class HasOne < Base
-          # rubocop: disable Metrics/MethodLength
           def call(record)
             child = association
             return record unless child
-            unless scope.nil?
-              warn(
-                '[Clowne] Has one association does not support scopes ' \
-                "(#{@association_name} for #{@source.class})"
-              )
-            end
+            warn '[Clowne] Has one association does not support scopes' unless scope.nil?
 
             child_clone = clone_one(child)
             child_clone[:"#{reflection.foreign_key}"] = nil
@@ -22,7 +16,6 @@ module Clowne
 
             record
           end
-          # rubocop: enable Metrics/MethodLength
         end
       end
     end

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

@@ -6,10 +6,7 @@ module Clowne
       module Associations
         class Noop < Base
           def call(record)
-            warn(
-              "[Clowne] Reflection #{reflection.class.name} is not supported "\
-              "(#{@association_name} for #{@source.class})"
-            )
+            warn("[Clowne] Reflection #{reflection.class.name} is not supported")
             record
           end
         end

data/lib/clowne/cloner.rb

@@ -38,8 +38,8 @@ module Clowne # :nodoc: all
         @traits[name].extend_with(block)
       end
 
-      # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
-      # rubocop: disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop: disable Metrics/AbcSize
+      # rubocop: disable Metrics/MethodLength
       def call(object, **options)
         raise(UnprocessableSourceError, 'Nil is not cloneable object') if object.nil?
 
@@ -56,13 +56,11 @@ module Clowne # :nodoc: all
             plan_with_traits(traits)
           end
 
-        plan = Clowne::Planner.enhance(plan, Proc.new) if block_given?
-
         adapter.clone(object, plan, params: options)
       end
 
-      # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
-      # rubocop: enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop: enable Metrics/AbcSize
+      # rubocop: enable Metrics/MethodLength
 
       def default_plan
         return @default_plan if instance_variable_defined?(:@default_plan)

data/lib/clowne/declarations/exclude_association.rb

@@ -11,6 +11,11 @@ module Clowne
 
       def compile(plan)
         plan.remove_from(:association, name)
+
+        # update all_associations plan
+        all_associations = plan.get(:all_associations)
+        return if all_associations.nil?
+        all_associations.except! name
       end
     end
   end

data/lib/clowne/declarations/include_association.rb

@@ -16,6 +16,8 @@ module Clowne
       end
 
       def compile(plan)
+        # Clear `#include_all`
+        plan.remove(:all_associations)
         plan.add_to(:association, name, self)
       end
 

data/lib/clowne/planner.rb

@@ -5,7 +5,10 @@ require 'clowne/plan'
 module Clowne
   class Planner # :nodoc: all
     class << self
-      # Compile plan for cloner with traits
+      # Params:
+      # +cloner+:: Cloner object
+      # +init_plan+:: Init plan
+      # +traits+:: List of traits if any
       def compile(cloner, traits: nil)
         declarations = cloner.declarations.dup
 
@@ -16,16 +19,6 @@ module Clowne
         end
       end
 
-      # Extend previously compiled plan with an arbitrary block
-      # NOTE: It doesn't modify the plan itself but return a copy
-      def enhance(plan, block)
-        trait = Clowne::Declarations::Trait.new.tap { |t| t.extend_with(block) }
-
-        trait.compiled.each_with_object(plan.dup) do |declaration, new_plan|
-          declaration.compile(new_plan)
-        end
-      end
-
       private
 
       def compile_traits(cloner, traits)

data/lib/clowne/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clowne
-  VERSION = '0.1.0.beta1'
+  VERSION = '0.1.0.pre1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clowne
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.pre1
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,6 @@ files:
 - lib/clowne/adapters/active_record/associations/has_many.rb
 - lib/clowne/adapters/active_record/associations/has_one.rb
 - lib/clowne/adapters/active_record/associations/noop.rb
-- lib/clowne/adapters/active_record/dsl.rb
 - lib/clowne/adapters/base.rb
 - lib/clowne/adapters/base/finalize.rb
 - lib/clowne/adapters/base/nullify.rb

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Clowne
-  module Adapters
-    # Extend ActiveRecord with Clowne DSL and methods
-    module ActiveRecordDSL
-      module InstanceMethods # :nodoc:
-        # Shortcut to call class's cloner call with self
-        def clowne(*args)
-          self.class.cloner_class.call(self, *args)
-        end
-      end
-
-      module ClassMethods # :nodoc:
-        def clowne_config(options = {}, &block)
-          if options.delete(:inherit) != false && superclass.respond_to?(:cloner_class)
-            parent_cloner = superclass.cloner_class
-          end
-
-          parent_cloner ||= Clowne::Cloner
-          cloner = instance_variable_set(:@_clowne_cloner, Class.new(parent_cloner))
-          cloner.adapter :active_record
-          cloner.instance_exec(&block)
-        end
-      end
-    end
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ::ActiveRecord::Base.extend Clowne::Adapters::ActiveRecordDSL::ClassMethods
-  ::ActiveRecord::Base.include Clowne::Adapters::ActiveRecordDSL::InstanceMethods
-end