declarative 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85ae72ce17160c8d0d6bbe197358967601d4565d
-  data.tar.gz: 28b480fc3526c9197fbe02899929c8a0cec4baa4
+  metadata.gz: 6e5c86877c99e99dfa9ce880df46435218fcc7a0
+  data.tar.gz: e4b808d37b26399bade9158a92040fb882a3c840
 SHA512:
-  metadata.gz: 6c2b2d5d60573417e5304f220cf3d1658bda2b5b52601b5ed554fb6447c1f62c5d4fad254c2b28dc68bf231aea8e0215bea5b565ade7189dfb6935efbf6fa534
-  data.tar.gz: 28abb6da89a87cbb256cce92327945641224cc077ef1f182451ce9695c02ed16aaeace1b5e56714ce948d9fafd4776de1312715893b07676ec0e8f1ca7ba6b44
+  metadata.gz: 92ec08dc8dcbe1939a657112edc880b977f16e5b786722a0af007f895399d28d9370415f3db81c2c71e5f270f5be6eeaa10d6b0bcf654f64683113ebe76d639a
+  data.tar.gz: e56d957d4b9b29695b861a7e3852cd66aac31f8f3fe0a01dfa343e054a38f6b4c98aa39dcce5f6e61157ac9a055a6d7cee1730ba8f804d003283db611ef280c1

data/CHANGES.md

@@ -1,3 +1,18 @@
+# 0.0.10
+
+* `Defaults.merge!` will now deprecate non-wrapped `Array` values. The following code is no longer valid (but still works).
+
+        defaults.merge!( list: [1,2] )
+
+    Instead, you need to wrap it in a command like `Variables::Append`.
+
+        defaults.merge!( list: Declarative::Variables::Append( [1,2] ) )
+
+    The reason for this change is to allow all kinds of operations with defaults variables, such as merges, overrides, append, prepend, and so on.
+
+* Introduce `Declarative::Variables.merge` to merge two sets of variables.
+* `Defaults` now uses `Variables` for merge/overide operations.
+
 # 0.0.9
 
 * Removing `uber` dependency.

data/declarative.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["apotonick@gmail.com"]
   spec.summary       = %q{DSL for nested schemas.}
   spec.description   = %q{DSL for nested generic schemas with inheritance and refining.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/apotonick/declarative"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/declarative.rb

@@ -4,6 +4,7 @@ require "declarative/heritage"
 require "declarative/defaults"
 require "declarative/schema"
 require "declarative/deep_dup"
+require "declarative/variables"
 
 module Declarative
 end

data/lib/declarative/deep_dup.rb

@@ -2,7 +2,7 @@ module Declarative
   class DeepDup
     def self.call(args)
       return Array[*dup_items(args)] if args.is_a?(Array)
-      return Hash[dup_items(args)] if args.is_a?(Hash)
+      return ::Hash[dup_items(args)] if args.is_a?(::Hash)
       args
     end
 
@@ -11,4 +11,4 @@ module Declarative
       arr.to_a.collect { |v| call(v) }
     end
   end
-end
+end

data/lib/declarative/defaults.rb

@@ -1,16 +1,18 @@
 module Declarative
+  # {Defaults} is a mutable DSL object that collects default directives via #merge!.
+  # Internally, it uses {Variables} to implement the merging of defaults.
   class Defaults
     def initialize
       @static_options  = {}
-      @dynamic_options = ->(*) { Hash.new }
+      @dynamic_options = ->(*) { {} }
     end
 
     # Set default values. Usually called in Schema::defaults.
     # This can be called multiple times and will "deep-merge" arrays, e.g. `_features: []`.
     def merge!(hash={}, &block)
-      @static_options = Merge.(@static_options, hash)
-
+      @static_options  = Variables.merge( @static_options, handle_array_and_deprecate(hash) )
       @dynamic_options = block if block_given?
+
       self
     end
 
@@ -19,24 +21,25 @@ module Declarative
       # TODO: allow to receive rest of options/block in dynamic block. or, rather, test it as it was already implemented.
       evaluated_options = @dynamic_options.(name, given_options)
 
-      options = Merge.(@static_options, evaluated_options)
-      options = options.merge(given_options)
+      options = Variables.merge( @static_options, handle_array_and_deprecate(evaluated_options) )
+      options = Variables.merge( options, handle_array_and_deprecate(given_options) ) # FIXME: given_options is not tested!
+    end
+
+    def handle_array_and_deprecate(variables)
+      wrapped = Defaults.wrap_arrays(variables)
+
+      warn "[Declarative] Defaults#merge! and #call still accept arrays and automatically prepend those. This is now deprecated, you should replace `ary` with `Declarative::Variables::Append(ary)`." if wrapped.any?
+
+      variables.merge(wrapped)
     end
 
-    # Private! Don't use this anywhere.
-    # Merges two hashes and joins same-named arrays. This is often needed
-    # when dealing with defaults.
-    class Merge
-      def self.call(a, b)
-        a = a.dup
-        b.each do |k, v|
-          a[k] = v and next unless a.has_key?(k)
-          a[k] = v and next unless a[k].is_a?(Array)
-          a[k] = a[k] += v # only for arrays.
-        end
-
-        a
-      end
+    # Wrap arrays in `variables` with Variables::Append so they get appended to existing
+    # same-named arrays.
+    def self.wrap_arrays(variables)
+      Hash[ variables.
+        find_all { |k,v| v.instance_of?(Array) }.
+        collect  { |k,v| [k, Variables::Append(v)] }
+      ]
     end
   end
 end

data/lib/declarative/definitions.rb

@@ -1,5 +1,5 @@
 module Declarative
-  class Definitions < Hash
+  class Definitions < ::Hash
     class Definition
       def initialize(name, options={}, &block)
         @options = options.dup
@@ -71,4 +71,4 @@ module Declarative
       options[:_nested_builder].(options)
     end
   end
-end
+end

data/lib/declarative/schema.rb

@@ -1,5 +1,6 @@
 require "declarative/definitions"
 require "declarative/defaults"
+require "declarative/variables"
 require "declarative/heritage"
 
 module Declarative
@@ -27,6 +28,10 @@ module Declarative
       def defaults(options={}, &block)
         heritage.record(:defaults, options, &block)
 
+        # Always convert arrays to Variables::Append instructions.
+        options = options.merge( Defaults.wrap_arrays(options) )
+        block   = wrap_arrays_from_block(block) if block_given?
+
         _defaults.merge!(options, &block)
       end
 
@@ -45,6 +50,8 @@ module Declarative
         default_options[:_defaults]       = _defaults
         default_options[:_nested_builder] = nested_builder if block
 
+        # options = options.merge( Defaults.wrap_arrays(options) )
+
         definitions.add(name, default_options.merge(options), &block)
       end
 
@@ -62,6 +69,16 @@ module Declarative
           class_eval(&options[:_block])
         end
       end
+
+      # When called, executes `block` and wraps all array values in Variables::Append.
+      # This is the default behavior in older versions and allows to provide arrays for
+      # default values that will be prepended.
+      def wrap_arrays_from_block(block)
+        ->(*args) {
+          options = block.(*args)
+          options.merge( Defaults.wrap_arrays( options ) )
+        }
+      end
     end
 
     module Feature
@@ -78,7 +95,7 @@ module Declarative
       def register_feature(mod)
         heritage.record(:register_feature, mod) # this is only for inheritance between decorators and modules!!! ("horizontal and vertical")
 
-        defaults.merge!(_features: [mod])
+        defaults.merge!( _features: Variables::Append([mod]) )
       end
     end
   end

data/lib/declarative/testing.rb

@@ -1,4 +1,14 @@
 module Declarative
+  def self.Inspect(obj)
+    string = obj.inspect
+
+    if obj.is_a?(Proc)
+      elements = string.split("/")
+      string = "#{elements.first}#{elements.last}"
+    end
+    string.gsub(/0x\w+/, "")
+  end
+
   module Inspect
     def inspect
       string = super
@@ -35,4 +45,4 @@ module Declarative
       super.extend(Declarative::Inspect)
     end
   end
-end
+end

data/lib/declarative/variables.rb

@@ -0,0 +1,38 @@
+module Declarative
+  # Implements the pattern of maintaining a hash of key/values (usually "defaults")
+  # that are mutated several times by user and library code (override defaults).
+  #
+  # The Variables instance then represents the configuration data to be processed by the
+  # using library (e.g. Representable or Trailblazer).
+  class Variables
+    class Proc < ::Proc
+    end
+
+    # @return Hash hash where `overrides` is merged onto `defaults` respecting Merge, Append etc.
+    def self.merge(defaults, overrides)
+      defaults = defaults.merge({}) # todo: use our DeepDup. # TODO: or how could we provide immutability?
+
+      overrides.each do |k, v|
+        if v.is_a?(Variables::Proc)
+          defaults[k] = v.( defaults[k] )
+        else
+          defaults[k] = v
+        end
+      end
+
+      defaults
+    end
+
+    def self.Merge(merged_hash)
+      Variables::Proc.new do |original|
+        (original || {}).merge( merged_hash )
+      end
+    end
+
+    def self.Append(appended_array)
+      Variables::Proc.new do |original|
+        (original || []) + appended_array
+      end
+    end
+  end # Variables
+end

data/lib/declarative/version.rb

@@ -1,3 +1,3 @@
 module Declarative
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/test/defaults_test.rb

@@ -63,26 +63,37 @@ class DefaultsOptionsTest < Minitest::Spec
   describe "multiple Defaults#merge!" do
     it "merges arrays automatically" do
       defaults.merge!(a: 1, b: 2)
-      defaults.merge!(      b: 3, _features: ["A"])
-      defaults.merge!(            _features: ["B", "C"])
+      defaults.merge!(      b: 3, _features: Declarative::Variables::Append(["A"]) )
+      defaults.merge!(            _features: Declarative::Variables::Append(["B", "C"]) )
       defaults.(nil, {}).inspect.must_equal "{:a=>1, :b=>3, :_features=>[\"A\", \"B\", \"C\"]}"
     end
 
     it "what" do
-      defaults.merge!(_features: ["A"]) do |name, options|
-        { _features: ["B", "D"] }
+      defaults.merge!( _features: Declarative::Variables::Append(["A"]) ) do |name, options|
+        { _features: Declarative::Variables::Append( ["B", "D"] ) }
       end
 
       defaults.(nil, {}).inspect.must_equal "{:_features=>[\"A\", \"B\", \"D\"]}"
     end
   end
-end
 
-class DefaultsMergeTest < Minitest::Spec
-  it do
-    a = { a: "a", features: ["b"] }
-    b = { a: "a", features: ["c", "d"], b: "b" }
+  describe "deprecation" do
+    require 'stringio'
+    before do
+      @old_stderr = $stderr
+      $stderr = StringIO.new
+    end
+
+    after { $stderr = @old_stderr }
+
+    it "prints deprecation twice" do
+      defaults.merge!( _features: ["A"] ) do |name, options|
+        { _features: ["B", "D"] }
+      end
 
-    Declarative::Defaults::Merge.(a, b).must_equal({:a=>"a", :features=>["b", "c", "d"], :b=>"b"})
+      defaults.(nil, {}).inspect.must_equal "{:_features=>[\"A\", \"B\", \"D\"]}"
+
+      $stderr.string.must_equal %{[Declarative] Defaults#merge! and #call still accept arrays and automatically prepend those. This is now deprecated, you should replace `ary` with `Declarative::Variables::Append(ary)`.\n}*2
+    end
   end
 end

data/test/variables_test.rb

@@ -0,0 +1,65 @@
+require "test_helper"
+
+class DSLOptionsTest < Minitest::Spec
+  let(:defaults) { { id: 1, connections: { first: 1, second: 2 }, list: [3] } }
+
+  Variables = Declarative::Variables
+
+  after do
+    Declarative::Inspect(defaults).must_equal %{{:id=>1, :connections=>{:first=>1, :second=>2}, :list=>[3]}}
+  end
+
+  #- Merge
+  it "merges Merge over original" do
+    options = Variables.merge(
+      defaults,
+      connections: Variables::Merge( second: 3, third: 4 )
+    )
+
+    options.must_equal( { id: 1, connections: { first: 1, second: 3, third: 4 }, :list=>[3] } )
+  end
+
+  it "accepts Procs" do
+    options = Variables.merge(
+      defaults,
+      connections: proc = ->(*) { raise }
+    )
+
+    options.must_equal( { id: 1, connections: proc, :list=>[3] } )
+  end
+
+  it "overrides original without Merge" do
+    options = Variables.merge(
+    defaults, connections: { second: 3, third: 4 } )
+
+    options.must_equal( { id: 1, connections: { second: 3, third: 4 }, :list=>[3] } )
+  end
+
+  it "creates new hash if original not existent" do
+    options = Variables.merge(
+      defaults,
+      bla: Variables::Merge( second: 3, third: 4 )
+    )
+
+    options.must_equal( {:id=>1, :connections=>{:first=>1, :second=>2}, :list=>[3], :bla=>{:second=>3, :third=>4}} )
+  end
+
+  #- Append
+  it "appends to Array" do
+    options = Variables.merge(
+      defaults,
+      list: Variables::Append( [3, 4, 5] )
+    )
+
+    options.must_equal( { id: 1, connections: { first: 1, second: 2 }, :list=>[3, 3, 4, 5] } )
+  end
+
+  it "creates new array if original not existent" do
+    options = Variables.merge(
+      defaults,
+      another_list: Variables::Append( [3, 4, 5] )
+    )
+
+    options.must_equal( { id: 1, connections: { first: 1, second: 2 }, :list=>[3], :another_list=>[3, 4, 5] } )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declarative
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-28 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,13 +74,15 @@ files:
 - lib/declarative/heritage.rb
 - lib/declarative/schema.rb
 - lib/declarative/testing.rb
+- lib/declarative/variables.rb
 - lib/declarative/version.rb
 - test/defaults_test.rb
 - test/definitions_test.rb
 - test/heritage_test.rb
 - test/schema_test.rb
 - test/test_helper.rb
-homepage: ''
+- test/variables_test.rb
+homepage: https://github.com/apotonick/declarative
 licenses:
 - MIT
 metadata: {}
@@ -100,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: DSL for nested schemas.
@@ -110,3 +112,4 @@ test_files:
 - test/heritage_test.rb
 - test/schema_test.rb
 - test/test_helper.rb
+- test/variables_test.rb