mediator 0.0.1 → 0.1.0

data/README.md

@@ -21,7 +21,7 @@ I sit between your domain model and the cold, cruel world.
 
 ## License (MIT)
 
-Copyright 2011 John Barnette (code@jbarnette.com)
+Copyright 2011-2012 Audiosocket (tech@audiosocket.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/mediator/parser.rb

@@ -15,40 +15,71 @@ class Mediator
       (options && options[:value]) || data[selector] || data[selector.to_s]
     end
 
-    def has? name
-      !!get(name)
+    def has? name, options = nil
+      selector = (options && options[:from]) || name
+      (options && options.has_key?(:value)) || data.has_key?(selector) || data.has_key?(selector.to_s)
     end
 
     def id name, options = {}
       key "#{name}_id", options.merge(from: name)
     end
 
+    def ids name, options = {}
+      if name[-1] == "s" and !options[:from]
+        id_name = "#{name[0..-2]}_ids"
+      else
+        id_name = "#{name}_ids"
+      end
+
+      options[:from] ||= name
+
+      key id_name, options
+    end
+
     def key name, options = nil, &block
       if name[-1] == "?"
         name = name[0..-2].intern
       end
 
-      value = get name, options
+      return unless has? name, options
 
+      value = get name, options
       return if empty? value, options
-      mediator.set name, block ? block[value] : value
+
+      value = block ? block[value] : value
+
+      mediator.set name, value unless empty? value, options
     end
 
-    def obj name, options = nil, &block
+    def many name, options = nil, &block
       data = get name, options
       subj = (options && options[:subject]) || mediator.get(name)
 
-      return if empty? data, options or subj.nil?
+      data.map { |d| sub subj[data.index d], d, options, &block }.
+        reject { |v| empty? v, options }
+    end
 
-      Mediator[subj, mediator].parse data
-      block[subj] if block
+    def one name, options = nil, &block
+      data = get name, options
+      subj = (options && options[:subject]) || mediator.get(name)
 
-      subj
+      sub subj, data, options, &block
     end
 
     def union name, options = nil, &block
       (options ||= {}).merge! value: self.data
-      obj name, options, &block
+      one name, options, &block
+    end
+
+    private
+
+    def sub subj, data, options, &block
+      return if empty? data, options or subj.nil?
+
+      Mediator[subj, mediator].parse data
+      block[subj] if block
+
+      subj
     end
   end
 end

data/lib/mediator/processor.rb

@@ -2,7 +2,7 @@ class Mediator
   class Processor
     def empty? value, options = nil
       !(options && options[:empty]) &&
-        (value.nil? || value.respond_to?(:empty?) && value.empty?)
+        (value.nil? || (value.respond_to?(:empty?) && value.empty?))
     end
   end
 end

data/lib/mediator/renderer.rb

@@ -19,6 +19,18 @@ class Mediator
       key name, options.merge(from: "#{name}_id")
     end
 
+    def ids name, options = {}
+      unless options[:from]
+        if name[-1] == "s"
+          options = options.merge(from: "#{name[0..-2]}_ids")
+        else
+          options = options.merge(from: "#{name}_ids")
+        end
+      end
+
+      key name, options
+    end
+
     def key name, options = nil, &block
       if name[-1] == "?"
         (options ||= {})[:from] = name
@@ -28,26 +40,38 @@ class Mediator
       value = get name, options
       return if empty? value, options
 
-      data[name] = block ? block[value] : value
+      value = block ? block[value] : value
+
+      data[name] = value unless empty? value, options
     end
 
-    def obj name, options = nil, &block
+    def many name, options = nil, &block
       value = get name, options
-      return if empty? value, options
+      data[name] = value.map { |v| sub v, options, &block }.
+        reject { |v| empty? v, options }
+    end
 
-      if value
-        rendered = Mediator[value, mediator].render
-        munged   = block ? block[rendered] : rendered
-        merge    = options && options[:merge]
+    def one name, options = nil, &block
+      value = get name, options
+      return if empty? value, options
+ 
+      value = sub value, options, &block 
+      return if empty? value, options
 
-        merge ? data.merge!(munged) : data[name] = munged
-        munged
-      end
+      options && options[:merge] ? data.merge!(value) : data[name] = value
     end
 
     def union name, options = nil, &block
       (options ||= {}).merge! merge: true
-      obj name, options, &block
+      one name, options, &block
     end
+
+    private
+
+    def sub value, options, &block
+      rendered = Mediator[value, mediator].render
+      block ? block[rendered] : rendered
+    end
+
   end
 end

data/lib/mediator.rb

@@ -60,19 +60,24 @@ class Mediator
     parent && (parent.subject == subject || parent.inside?(subject))
   end
 
-  # Two-way mediation. Mediators whose parsing and rendering
-  # operations are identical should override and consistently call
-  # `super`. `mediator` will be `parser` or `renderer`. The default
-  # implementation raises NotImplementedError.
-
-  def mediate! mediator
-    raise NotImplementedError
-  end
-
   # Is this mediator nested inside a `parent`?
 
-  def nested?
-    !!parent
+  def nested? candidate = nil, &block
+    if candidate && block
+      raise Error, "Can't provide both a candidate and a block."
+    end
+
+    if !parent
+      false
+    elsif !candidate && !block
+      true
+    elsif candidate  && (candidate === parent.subject)
+      true
+    elsif block && block[parent]
+      true
+    else
+      parent.nested? candidate, &block
+    end
   end
 
   # Called after rendering. Subclasses can override to transform raw
@@ -93,11 +98,10 @@ class Mediator
   end
 
   # The actual parse implementation. Subclasses should override and
-  # consistently call `super`. The default implementation calls
-  # `mediate!`.
+  # consistently call `super`.
 
   def parse! parser
-    mediate! parser
+    raise NotImplementedError
   end
 
   # Construct a parser instance for `data`. The parser will be passed
@@ -119,11 +123,10 @@ class Mediator
   end
 
   # The actual render implementation. Subclasses should override and
-  # consistently call `super`. The default implementation calls
-  # `mediate!`.
+  # consistently call `super`.
 
   def render! renderer
-    mediate! renderer
+    raise NotImplementedError
   end
 
   # Construct a renderer instance. The renderer will be passed to the

data/mediator.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |gem|
-  gem.authors       = ["John Barnette"]
-  gem.email         = ["code@jbarnette.com"]
+  gem.authors       = ["Audiosocket"]
+  gem.email         = ["tech@audiosocket.com"]
   gem.description   = "A go-between for models."
   gem.summary       = "Translates models to and from primitive representations."
-  gem.homepage      = "https://github.com/jbarnette/mediator"
+  gem.homepage      = "https://github.com/audiosocket/mediator"
 
   gem.files         = `git ls-files`.split "\n"
   gem.test_files    = `git ls-files -- test/*`.split "\n"
   gem.name          = "mediator"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.1"
+  gem.version       = "0.1.0"
 
   gem.required_ruby_version = ">= 1.9.2"
 end

data/test/mediator_parser_test.rb

@@ -29,18 +29,58 @@ describe Mediator::Parser do
     end
   end
 
+  describe "ids" do
+    it "translates name to subject.name_ids" do
+      p = Mediator::Parser.new @mediator, foo: [5, 6, 7]
+
+      p.ids :foo
+      assert_equal [5, 6, 7], @subject.foo_ids
+    end
+
+    it "removes plurial" do
+      p = Mediator::Parser.new @mediator, foos: [5, 6, 7]
+
+      p.ids :foos
+      assert_equal [5, 6, 7], @subject.foo_ids
+    end
+
+    it "can be clever with plurial if told to" do
+      p = Mediator::Parser.new @mediator, boxen: [5, 6, 7]
+
+      p.ids :box, from: :boxen
+      assert_equal [5, 6, 7], @subject.box_ids
+    end
+  end
+
   describe "key" do
     before do
-      @parser = Mediator::Parser.new @mediator,
+      @data = {
         emptystring: "", emptyarray: [], isnil: nil,
-        predicate: true
+        somevalue: :gni, predicate: true, othernil: nil
+      }
+      @parser = Mediator::Parser.new @mediator, @data
+    end
+
+    it "parses some values" do
+      @parser.key :somevalue
+
+      assert_equal :gni, @subject.somevalue
+    end
+
+    it "sets unconditionally with empty: true and data holds an empty value for that key." do
+      @subject.othernil = :not_nil
+
+      assert @data.has_key?(:othernil)
+      @parser.key :othernil, empty: true
+      assert_nil @subject.othernil
     end
 
-    it "sets unconditionally with empty: true" do
+    it "does not touch a key with empty: true when data does not have that key defined." do
       @subject.foo = :foo
 
+      refute @data.has_key?(:foo)
       @parser.key :foo, empty: true
-      assert_nil @subject.foo
+      assert_equal :foo, @subject.foo
     end
 
     it "removes trailing '?' from predicates" do
@@ -48,7 +88,6 @@ describe Mediator::Parser do
       assert @subject.predicate
     end
 
-
     it "can pull from the options hash" do
       @parser.key :foo, value: :bar
       assert_equal :bar, @subject.foo
@@ -66,6 +105,11 @@ describe Mediator::Parser do
       @parser.key :isnil
       assert_nil @subject.isnil # heh
     end
+
+    it "ignores nil or empty values returned by blocks" do
+      @parser.key(:somevalue) { |p| nil }
+      assert_nil @subject.foo # heh
+    end
   end
 
   describe "key with actual data" do
@@ -98,7 +142,7 @@ describe Mediator::Parser do
     end
   end
 
-  describe "obj" do
+  describe "one" do
     before do
       Top  = Class.new OpenStruct
       Nest = Class.new OpenStruct
@@ -108,7 +152,7 @@ describe Mediator::Parser do
 
         def parse! p
           p.key :foo
-          p.obj :nest
+          p.one :nest
         end
       end
 
@@ -137,6 +181,41 @@ describe Mediator::Parser do
     end
   end
 
+  describe "many" do
+    before do
+      Many   = Class.new OpenStruct
+      Nested = Class.new OpenStruct 
+
+      Class.new Mediator do
+        accept Many
+
+        def parse! p
+          p.many :nest
+        end
+      end
+
+      Class.new Mediator do
+        accept Nested
+
+        def parse! p
+          p.key :baz
+        end
+      end
+    end
+
+    it "delegates to an array of nested mediator" do
+      s      = Many.new
+      s.nest = [ Nested.new, Nested.new ]
+
+      m = Mediator[s]
+      d = { nest: [ { baz: "baz!" }, { baz: "blup?" } ] }
+
+      m.parse d
+
+      assert_equal d[:nest].map { |v| v[:baz] },  s.nest.map { |v| v.baz }
+    end
+  end
+
   describe "union" do
     it "uses the same data as its parent" do
       First  = Class.new OpenStruct

data/test/mediator_renderer_test.rb

@@ -12,6 +12,144 @@ describe Mediator::Renderer do
     assert_equal Hash.new, Mediator::Renderer.new(nil).data
   end
 
+  describe "id" do
+    it "grabs an id" do
+      c = Class.new Mediator do
+        def render! r
+          r.id :foo
+        end
+      end
+
+      x = OpenStruct.new foo_id: 5
+      m = c.new x
+      r = { foo: 5 }
+
+      assert_equal r, m.render
+    end
+  end
+
+  describe "ids" do
+    it "grabs an array of ids" do
+      c = Class.new Mediator do
+        def render! r
+          r.ids :foo
+        end
+      end
+
+      x = OpenStruct.new foo_ids: [5, 6, 7]
+      m = c.new x
+      r = { foo: [5, 6, 7] }
+
+      assert_equal r, m.render
+    end
+
+    it "removes plurial" do
+      c = Class.new Mediator do
+        def render! r
+          r.ids :foos
+        end
+      end
+
+      x = OpenStruct.new foo_ids: [5, 6, 7]
+      m = c.new x
+      r = { foos: [5, 6, 7] }
+
+      assert_equal r, m.render
+    end
+
+    it "can be clever with plurial if told to" do
+      c = Class.new Mediator do
+        def render! r
+          r.ids :boxen, from: "box_ids"
+        end
+      end
+
+      x = OpenStruct.new box_ids: [5, 6, 7]
+      m = c.new x
+      r = { boxen: [5, 6, 7] }
+
+      assert_equal r, m.render
+    end
+  end
+
+  describe "many" do
+    it "grabs a collection from the subject" do
+      c = Class.new Mediator do
+        def render! r
+          r.many :foo
+        end
+      end
+
+      d = Class.new Mediator do
+        accept OpenStruct
+
+        def render! r
+          r.key :bar
+        end
+      end
+
+      x = OpenStruct.new bar: "gni"
+      y = OpenStruct.new bar: "gno"
+      s = OpenStruct.new foo: [x, y]
+      m = c.new s
+      d = m.render
+
+      r = { foo: [ { bar: "gni" }, { bar: "gno" } ] }
+      assert_equal r, d
+    end
+
+    it "can alter values" do
+      c = Class.new Mediator do
+        def render! r
+          r.many(:foo) { |v| { bar: v[:bar].upcase } }
+        end
+      end
+
+      d = Class.new Mediator do
+        accept OpenStruct
+
+        def render! r
+          r.key :bar
+        end
+      end
+
+      x = OpenStruct.new bar: "gni"
+      y = OpenStruct.new bar: "gno"
+      s = OpenStruct.new foo: [x, y]
+      m = c.new s
+      d = m.render
+
+      r = { foo: [ { bar: "GNI" }, { bar: "GNO" } ] }
+      assert_equal r, d
+    end
+
+    it "removes empty values" do
+      c = Class.new Mediator do
+        def render! r
+          r.many :foo
+        end
+      end
+
+      d = Class.new Mediator do
+        accept OpenStruct
+
+        def render! r
+          r.key :bar if subject.bar == "gni"
+        end
+      end
+
+      x = OpenStruct.new bar: "gni"
+      y = OpenStruct.new bar: "gno"
+      s = OpenStruct.new foo: [x, y]
+      m = c.new s
+      d = m.render
+
+      r = { foo: [ { bar: "gni" } ] }
+      assert_equal r, d
+    end
+  end
+
+
   describe "key" do
     it "grabs the value from the subject" do
       c = Class.new Mediator do
@@ -55,6 +193,20 @@ describe Mediator::Renderer do
       assert_equal Hash.new, d
     end
 
+    it "ignores nil or empty values returned by blocks" do
+      c = Class.new Mediator do
+        def render! r
+          r.key(:foo) { |p| nil }
+        end
+      end
+
+      s = OpenStruct.new foo: "bar"
+      m = c.new s
+      d = m.render
+
+      assert_equal Hash.new, d
+    end
+
     it "optionally allows empty values" do
       c = Class.new Mediator do
         def render! r
@@ -114,11 +266,11 @@ describe Mediator::Renderer do
     end
   end
 
-  describe "obj" do
+  describe "one" do
     it "allows mediation of an associated object" do
       c = Class.new Mediator do
         def render! r
-          r.obj :foo
+          r.one :foo
         end
       end
 

data/test/mediator_test.rb

@@ -32,6 +32,34 @@ describe Mediator do
       assert Mediator.new(:s, m).nested?
     end
 
+    it "can test if it is nested inside a specific parent's subject." do
+      m = OpenStruct.new bar: "gni"
+      n = Mediator.new m, :t
+      o = Mediator.new :u, n
+
+      refute n.nested? m
+      assert o.nested? m
+      assert o.nested? OpenStruct
+    end
+
+    it "can test up in inheritance tree." do
+      m = OpenStruct.new bar: "gni"
+      n = Mediator.new m, :t
+      o = Mediator.new :u, n
+      v = Mediator.new :u, o
+
+      assert v.nested? m
+    end
+
+    it "accepts an arbitrary block to test against parent." do
+      m = OpenStruct.new bar: "gni"
+      n = Mediator.new m, :t
+      o = Mediator.new :u, n
+
+      refute o.nested? { |p| p.subject.bar == "gno" }
+      assert o.nested? { |p| p.subject.bar == "gni" }
+    end
+
     it "can narrow inside? by checking subjects" do
       m = Mediator.new :s, :c
       n = Mediator.new :t, m
@@ -65,20 +93,6 @@ describe Mediator do
       assert_equal :bar, s.foo
     end
 
-    it "falls back on mediate!" do
-      c = Class.new Mediator do
-        def mediate! m
-          m.key :foo
-        end
-      end
-
-      s = OpenStruct.new
-      m = c.new s
-
-      m.parse foo: :bar
-      assert_equal :bar, s.foo
-    end
-
     it "always returns the subject" do
       c = Class.new Mediator do
         def parse! p

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: mediator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
-- John Barnette
+- Audiosocket
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-17 00:00:00.000000000Z
+date: 2012-05-17 00:00:00.000000000Z
 dependencies: []
 description: A go-between for models.
 email:
-- code@jbarnette.com
+- tech@audiosocket.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -33,7 +33,7 @@ files:
 - test/mediator_parser_test.rb
 - test/mediator_renderer_test.rb
 - test/mediator_test.rb
-homepage: https://github.com/jbarnette/mediator
+homepage: https://github.com/audiosocket/mediator
 licenses: []
 post_install_message: 
 rdoc_options: []