declarative 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f743b248235864a196f81afcba519e36856edad
-  data.tar.gz: 1c53f46fbefe9d256f7f06d39327413b01f8c2d6
+  metadata.gz: 777087a37a008f6db451fe0d998180119cef3a43
+  data.tar.gz: 9dc8ca151863c9c438c9fd45f3784472c0270e7e
 SHA512:
-  metadata.gz: 69271f1ac66235fd31c267665a9da238211f7d97518a0b3dc6945f5a2d845048456386d5bf7e4d969d58ad37c26ba7ea7e31eeccbaad361917717179f5f6a81a
-  data.tar.gz: eb72aec864a51461c98774eedfa138aefd1591b8b7b7655d6e6d342465f66c37386c5f00f3c085f15bd94f7178d76a31c98f3a1e8da5e17a67f0bd7aa07372e0
+  metadata.gz: 3ad76a30355469122e73ef454c393f6f1827648687b5a507f7e066100be68c180562133cae14b37160313e92cecb8838d437b9da3dcac38d037f5b86d9645819
+  data.tar.gz: a1a0cd8836cdd1eb93da1dd0ea5d782cc39fc82f650625f26ec550e9430e7ccc8438ef5a41fefef11add1336c320fd889e97367ee2c302ea56ada71732cb56e5

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.0.4
+
+* Restructured modules, there's always a public `DSL` module now, etc.
+
 # 0.0.3
 
 * Internals, only.

data/README.md

@@ -70,7 +70,7 @@ Override `::nested_builder` to define your own way of doing that.
 
 ```ruby
 class Model
-  include Declarative::Schema
+  extend Declarative::Schema
 
   def self.default_nested_class
     Model
@@ -92,7 +92,7 @@ You can automatically include modules into all nested schemas by using `::featur
 
 ```ruby
 class Model
-  include Declarative::Schema
+  extend Declarative::Schema
   feature Bla
 ```
 
@@ -100,7 +100,7 @@ class Model
 
 ```ruby
 class Model
-  include Declarative::Schema
+  extend Declarative::Schema
   defaults visible: true
 ```
 

data/lib/declarative.rb

@@ -1,31 +1,9 @@
 require "declarative/version"
 require "declarative/definitions"
+require "declarative/heritage"
 require "declarative/defaults"
 require "declarative/schema"
+require "declarative/deep_dup"
 
 module Declarative
-  module DSL
-    def heritage
-      @heritage ||= Heritage.new
-    end
-  end
-
-  module Inheritance
-    def included(includer)
-      heritage.(includer)
-    end
-  end
-
-
-  class Heritage < Array
-    def record(method, name, options=nil, &block)
-      self << {method: method, args: [name, options ? options.dup : nil].compact, block: block} # DISCUSS: options.dup.
-    end
-
-    def call(inheritor)
-      each do |cfg|
-        inheritor.send(cfg[:method], *cfg[:args], &cfg[:block])
-      end
-    end
-  end
 end

data/lib/declarative/deep_dup.rb

@@ -0,0 +1,14 @@
+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)
+      args
+    end
+
+  private
+    def self.dup_items(arr)
+      arr.to_a.collect { |v| call(v) }
+    end
+  end
+end

data/lib/declarative/definitions.rb

@@ -2,15 +2,22 @@ module Declarative
   class Definitions < Hash
     class Definition
       def initialize(name, options={}, &block)
-        @options = options.clone
+        @options = options.dup
         @options[:name] = name.to_s
       end
 
-      attr_reader :options # TODO: are we gonna keep this?
-
       def [](name)
         @options[name]
       end
+
+      def merge!(hash) # TODO: this should return a new Definition instance.
+        @options.merge!(hash)
+        self
+      end
+
+      def merge(hash) # TODO: should be called #copy.
+        DeepDup.(@options).merge(hash)
+      end
     end
 
     def initialize(definition_class)
@@ -34,7 +41,7 @@ module Declarative
 
       if options.delete(:inherit) and parent_property = get(name)
         base    = parent_property[:nested]
-        options = parent_property.options.merge(options) # TODO: Definition#merge
+        options = parent_property.merge(options) # TODO: Definition#merge
       end
 
       if options[:_nested_builder]

data/lib/declarative/heritage.rb

@@ -0,0 +1,36 @@
+module Declarative
+  class Heritage < Array
+    def record(method, *args, &block)
+      self << {method: method, args: DeepDup.(args), block: block} # DISCUSS: options.dup.
+    end
+
+    def call(inheritor)
+      each do |cfg|
+        inheritor.send(cfg[:method], *cfg[:args], &cfg[:block])
+      end
+    end
+
+
+    module DSL
+      def heritage
+        @heritage ||= Heritage.new
+      end
+    end
+
+    # To be extended into classes using Heritage. Inherits the heritage.
+    module Inherited
+      def inherited(subclass)
+        super
+        heritage.(subclass)
+      end
+    end
+
+    # To be included into modules using Heritage. When included, inherits the heritage.
+    module Included
+      def included(mod)
+        super
+        heritage.(mod)
+      end
+    end
+  end
+end

data/lib/declarative/schema.rb

@@ -10,6 +10,13 @@ module Declarative
   #
   # Requirements to includer: ::default_nested_class, override building with ::nested_builder.
   module Schema
+    def self.extended(extender)
+      extender.extend DSL                 # ::property
+      extender.extend Feature             # ::feature
+      extender.extend Heritage::DSL       # ::heritage
+      extender.extend Heritage::Inherited # ::included
+    end
+
     module DSL
       def property(name, options={}, &block)
         heritage.record(:property, name, options, &block)
@@ -53,17 +60,6 @@ module Declarative
       end
     end
 
-    module Heritage
-      def heritage
-        @heritage ||= ::Declarative::Heritage.new
-      end
-
-      def inherited(subclass) # DISCUSS: this could be in Decorator? but then we couldn't do B < A(include X) for non-decorators, right?
-        super
-        heritage.(subclass)
-      end
-    end
-
     module Feature
       # features are registered as defaults using _features, which in turn get translated to
       # Class.new... { feature mod } which makes it recursive in nested schemas.

data/lib/declarative/version.rb

@@ -1,3 +1,3 @@
 module Declarative
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/definitions_test.rb

@@ -77,6 +77,26 @@ class DefinitionsTest < Minitest::Spec
 
 
     schema.inspect.must_equal '{"artist"=>#<Declarative::Definitions::Definition: @options={:cool=>true, :nested=>{"name"=>#<Declarative::Definitions::Definition: @options={:name=>"name"}>, "band"=>#<Declarative::Definitions::Definition: @options={:crazy=>nil, :nested=>{"location"=>#<Declarative::Definitions::Definition: @options={:name=>"location"}>, "genre"=>#<Declarative::Definitions::Definition: @options={:name=>"genre"}>}, :name=>"band", :normal=>false}>}, :name=>"artist", :uncool=>false}>, "id"=>#<Declarative::Definitions::Definition: @options={:unique=>false, :value=>1, :name=>"id"}>}'
+  end
+
+  it "#add with nested options followed by inherit: true" do
+    schema.add :id, deserializer: options = { render: false }
+    schema.add :id, inherit: true
+
+    schema.get(:id)[:deserializer][:parse] = true
+
+    options.must_equal(render: false)
+  end
+end
+
+
+class DefinitionTest < Minitest::Spec
+  let (:definition) { Declarative::Definitions::Definition.new(:name) }
 
+  it "#merge does return deep copy" do
+    options = { render: false }
+    merged = definition.merge(options)
+    definition.merge!(render: true)
+    merged.must_equal(:name=>"name", render: false)
   end
 end

data/test/heritage_test.rb

@@ -1,17 +1,34 @@
 require "test_helper"
 
 class HeritageTest < Minitest::Spec
+  P = Proc.new{}.extend(Declarative::Inspect)
   # #record
   module RepresenterA
-    extend Declarative::DSL
+    extend Declarative::Heritage::DSL
 
     # one arg.
     heritage.record(:representation_wrap=, true)
     # 2 args.
     heritage.record(:property, :name, enable: true)
     # 3 args.
-    heritage.record(:property, :id, {}, &Proc.new{}.extend(Declarative::Inspect))
+    heritage.record(:property, :id, {}, &P)
   end
 
-  it { RepresenterA.heritage.inspect.must_equal "[{:method=>:representation_wrap=, :args=>[true], :block=>nil}, {:method=>:property, :args=>[:name, {:enable=>true}], :block=>nil}, {:method=>:property, :args=>[:id, {}], :block=>#<Proc:@heritage_test.rb:13>}]" }
+  it { RepresenterA.heritage.inspect.must_equal "[{:method=>:representation_wrap=, :args=>[true], :block=>nil}, {:method=>:property, :args=>[:name, {:enable=>true}], :block=>nil}, {:method=>:property, :args=>[:id, {}], :block=>#<Proc:@heritage_test.rb:4>}]" }
+
+
+  describe "dup of arguments" do
+    module B
+      extend Declarative::Heritage::DSL
+
+      options = {render: true, nested: {render: false}}
+
+      heritage.record(:property, :name, options, &P)
+
+      options[:parse] = true
+      options[:nested][:parse] = false
+    end
+
+    it { B.heritage.inspect.must_equal "[{:method=>:property, :args=>[:name, {:render=>true, :nested=>{:render=>false}}], :block=>#<Proc:@heritage_test.rb:4>}]" }
+  end
 end

data/test/schema_test.rb

@@ -2,9 +2,7 @@ require "test_helper"
 
 class SchemaTest < Minitest::Spec
   class Decorator
-    extend Declarative::Schema::DSL
-    extend Declarative::Schema::Feature # TODO: make automatic
-    extend Declarative::Schema::Heritage # TODO: make automatic
+    extend Declarative::Schema
 
     def self.default_nested_class
       Decorator
@@ -38,8 +36,6 @@ class SchemaTest < Minitest::Spec
   it do
     Concrete.extend(Declarative::Inspect::Schema)
     Concrete.inspect
-    pp Concrete.definitions.get(:artist).options
-    # pp Concrete.definitions.get(:artist)[:nested].definitions.get(:band)[:nested].definitions
     Concrete.inspect.gsub(/\s/, "").must_equal 'Schema:{
     "links"=>#<Declarative::Definitions::Definition:@options={:render_nil=>true,:as=>"LINKS",:name=>"links"}>,
     "artist"=>#<Declarative::Definitions::Definition:@options={:render_nil=>true,:as=>"ARTIST",:cool=>true,:nested=>Schema:{
@@ -60,7 +56,6 @@ class SchemaTest < Minitest::Spec
   it do
     InheritingConcrete.extend(Declarative::Inspect::Schema)
     InheritingConcrete.inspect
-    pp InheritingConcrete.definitions.get(:artist).options
     # pp InheritingConcrete.definitions.get(:artist)[:nested].definitions.get(:band)[:nested].definitions
     InheritingConcrete.inspect.gsub(/\s/, "").must_equal 'Schema:{
     "links"=>#<Declarative::Definitions::Definition:@options={:render_nil=>true,:as=>"LINKS",:name=>"links"}>,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declarative
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-31 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -82,8 +82,10 @@ files:
 - Rakefile
 - declarative.gemspec
 - lib/declarative.rb
+- lib/declarative/deep_dup.rb
 - lib/declarative/defaults.rb
 - lib/declarative/definitions.rb
+- lib/declarative/heritage.rb
 - lib/declarative/schema.rb
 - lib/declarative/testing.rb
 - lib/declarative/version.rb