motion-kit 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b2b7891f4a764ec64a5a015e75cb609f161d744
-  data.tar.gz: ca6b9958b22c9dbc6d78efe6eaf9281878e1db98
+  metadata.gz: c1de6fcc1bebb1578ad6110741b7d5edb084c307
+  data.tar.gz: 2b21fc0a39cae00452ed4ef9fd709cfea10d51e1
 SHA512:
-  metadata.gz: 904f76837a3321502bccc36587931301d48d500ab597482df30d5541b218cb4de7cd7d21df78b3e4fa7d7e98b6d7e876e2926439ca4e761fa2345db9c258f419
-  data.tar.gz: c905dcff79b15598662c7cd2055ae8121cb763db31df07bca51d32002643b92ca942455242f514ddbdb14872a59c5326d73bb935fb11bea481a711bd392291bc
+  metadata.gz: ac2fd44e427fa6c0d91706b0243e4902ad66a402a1974e655e2e1cd2c6f882f083426f49ab8334d771748bb3e726d07eb25f3cd20a2b534bb8bc651dbfda1cd2
+  data.tar.gz: bc6d0928ca21a6af0b7876b882c5b704b40a41e2f04e8e1784835cd3e100deade600360268240a367aa2f7b9a05d8cd3f9d8817d65a3ccfc942576da620471a4

data/README.md

@@ -109,7 +109,7 @@ class SimpleLayout < MotionKit::Layout
 
     # note: there are better ways to set the center, see the frame helpers below
     center [CGRectGetMidX(superview.bounds), CGRectGetMidY(superview.bounds)]
-    text_alignment UITextAlignmentCenter
+    text_alignment NSTextAlignmentCenter
     text_color UIColor.whiteColor
 
     # if you prefer to use shorthands from another gem, you certainly can!
@@ -706,6 +706,47 @@ add UIView, :bar do
 end
 ```
 
+One common use case is to use a child layout to create many instances of the
+same layout that repeat, for instance a "row" of content.  In this case you will
+probably have many views with the same id, and you will not know the index of
+the container view that you want to add constraints to.  In this situation, use
+the `nearest`, `previous` or `next` method to find a container, sibling, or
+child view.
+
+`previous` and `next` are easy; they just search for a sibling view.  No
+superviews or subviews are searched.
+
+`nearest` will search child views, siblings, and superviews, in that order.  The
+"distance" is calculated as such:
+
+- the current view
+- subviews
+- siblings
+- superview
+- superview's siblings, or a child of the sibling (depth-first search)
+- continue up the tree
+
+See the AutoLayout sample app for an example of this usage.
+
+```ruby
+items.each do |item|
+  add UIView, :row do
+    add UIImageView, :avatar
+    add UILabel, :title
+  end
+end
+
+def title_style
+  constraints do
+    # center the view vertically
+    center.equals(nearest(:row))
+    # and place it to the right of the :avatar
+    left.equals(nearest(:avatar), :right).plus(8)
+    right.equals(nearest(:row)).minus(8)
+  end
+end
+```
+
 One pain point in working with constraints is determining when to add them to
 your views.  We tried really hard to figure out a way to automatically add them,
 but it's just an untenable problem (Teacup suffers from a similar conundrum).
@@ -731,8 +772,10 @@ class MainLayout < MK::Layout
     end
   end
 
-  # this method will be called from `UIViewController#updateViewConstraints`
+  # You should call this method from `UIViewController#updateViewConstraints`
+  # and pass in your controller
   def add_constraints(controller)
+    # guard against adding these constraints more than once
     unless @layout_constraints_added
       @layout_constraints_added = true
       constraints(:label) do

data/lib/motion-kit-cocoa/cocoa_util.rb

@@ -0,0 +1,74 @@
+module MotionKit
+  module_function
+
+  def siblings(view)
+    case view
+    when CALayer
+      view.superlayer ? view.superlayer.sublayers : []
+    else
+      view.superview ? view.superview.subviews : []
+    end
+  end
+
+  def children(view)
+    case view
+    when CALayer
+      view.sublayers
+    else
+      view.subviews
+    end
+  end
+
+  def parent(view)
+    case view
+    when CALayer
+      view.superlayer
+    else
+      view.superview
+    end
+  end
+
+  # - check view
+  # - check subviews (unless 'skip' is provided)
+  # - check siblings (skipping 'view')
+  # - go up to parent and repeat, skipping children
+  def nearest(view, skip=nil, &test)
+    return nil if view.nil?
+
+    if test.call(view)
+      return view
+    end
+
+    children = MotionKit.children(view)
+    siblings = MotionKit.siblings(view)
+    parent = MotionKit.parent(view)
+
+    found = nil
+
+    # only check the children starting at the "root", e.g. nearest hasn't been
+    # called recursively.
+    if !skip || skip == parent
+      children.each do |child|
+        found = nearest(child, &test)
+        break if found
+      end
+      return found if found
+    end
+
+    # siblings are closer than parents
+    # passing 'parent' means only check self and children
+    unless skip == parent
+      siblings.each do |sibling|
+        found = (sibling != view && nearest(sibling, parent, &test))
+        break if found
+      end
+    end
+
+    if found
+      found
+    elsif skip != parent
+      nearest(parent, true, &test)
+    end
+  end
+
+end

data/lib/motion-kit-cocoa/constraints/constraint.rb

@@ -303,8 +303,6 @@ module MotionKit
       def view_lookup(layout, view, target)
         if ! target || target.is_a?(MotionKit.base_view_class)
           target
-        elsif target.is_a?(ConstraintPlaceholder)
-          target.resolve(layout)
         elsif target == :self
           view
         elsif target == :superview

data/lib/motion-kit-cocoa/constraints/constraints_helpers.rb

@@ -10,32 +10,20 @@ module MotionKit
       target
     end
 
-    def first(name)
-      ConstraintPlaceholder.new(:first, name)
-    end
-
-    def last(name)
-      ConstraintPlaceholder.new(:last, name)
-    end
-
-    def nth(name, value)
-      ConstraintPlaceholder.new(:nth, name, value)
-    end
-
-    def x(value=nil, rel=nil)
+    def left(value=nil, rel=nil)
       target_constraint(:left, rel, value)
     end
-    alias left x
+    alias x left
 
-    def min_x(value=nil)
-      x(value, :gte)
+    def min_left(value=nil)
+      left(value, :gte)
     end
-    alias min_left min_x
+    alias min_x min_left
 
-    def max_x(value=nil)
-      x(value, :lte)
+    def max_left(value=nil)
+      left(value, :lte)
     end
-    alias max_left max_x
+    alias max_x max_left
 
     def leading(value=nil, rel=nil)
       target_constraint(:leading, rel, value)
@@ -85,20 +73,20 @@ module MotionKit
       trailing(value, :lte)
     end
 
-    def y(value=nil, rel=nil)
+    def top(value=nil, rel=nil)
       target_constraint(:top, rel, value)
     end
-    alias top y
+    alias y top
 
-    def min_y(value=nil)
-      y(value, :gte)
+    def min_top(value=nil)
+      top(value, :gte)
     end
-    alias min_top min_y
+    alias min_y min_top
 
-    def max_y(value=nil)
-      y(value, :lte)
+    def max_top(value=nil)
+      top(value, :lte)
     end
-    alias max_top max_y
+    alias max_y max_top
 
     def center_y(value=nil, rel=nil)
       target_constraint(:center_y, rel, value)
@@ -238,6 +226,9 @@ module MotionKit
     end
 
     def above(view)
+      unless view
+        raise ArgumentError.new("`#{view.inspect}` is not a valid target for making a `above` constraint.")
+      end
       constraint = Constraint.new(constraint_target.view, :bottom, :equal)
       constraint.equals(view, :top)
 
@@ -246,6 +237,9 @@ module MotionKit
     end
 
     def below(view)
+      unless view
+        raise ArgumentError.new("`#{view.inspect}` is not a valid target for making a `below` constraint.")
+      end
       constraint = Constraint.new(constraint_target.view, :top, :equal)
       constraint.equals(view, :bottom)
 
@@ -254,6 +248,9 @@ module MotionKit
     end
 
     def before(view)
+      unless view
+        raise ArgumentError.new("`#{view.inspect}` is not a valid target for making a `before` constraint.")
+      end
       constraint = Constraint.new(constraint_target.view, :right, :equal)
       constraint.equals(view, :left)
 
@@ -263,6 +260,9 @@ module MotionKit
     alias left_of before
 
     def after(view)
+      unless view
+        raise ArgumentError.new("`#{view.inspect}` is not a valid target for making a `after` constraint.")
+      end
       constraint = Constraint.new(constraint_target.view, :left, :equal)
       constraint.equals(view, :right)
 

data/lib/motion-kit-cocoa/constraints/constraints_target.rb

@@ -12,6 +12,14 @@ module MotionKit
       @constraints.concat(constraints)
     end
 
+    def ==(value)
+      if value.is_a?(ConstraintsTarget)
+        super
+      else
+        @view == value
+      end
+    end
+
     def apply_all_constraints(layout, target)
       @constraints.map do |mk_constraint|
         mk_constraint.resolve_all(layout, target).map do |constraint|

data/lib/motion-kit/helpers/base_layout.rb

@@ -276,6 +276,7 @@ module MotionKit
       objc_method_name, objc_method_args = objc_version(method_name, args)
       ruby_method_name, ruby_method_args = ruby_version(method_name, args)
 
+      objc_setter = objc_method_name && MotionKit.setter(objc_method_name)
       setter = MotionKit.setter(ruby_method_name)
       assign = "#{ruby_method_name}="
 
@@ -290,6 +291,8 @@ module MotionKit
         target.send(objc_method_name, *objc_method_args, &block)
       elsif args.empty? && target.respond_to?(ruby_method_name)
         target.send(ruby_method_name, *ruby_method_args, &block)
+      elsif objc_setter && target.respond_to?(objc_setter)
+        target.send(objc_setter, *objc_method_args, &block)
       elsif target.respond_to?(setter)
         target.send(setter, *args, &block)
       elsif target.respond_to?(assign)

data/lib/motion-kit/helpers/tree_layout.rb

@@ -287,6 +287,112 @@ module MotionKit
       element
     end
 
+    # Search for a sibling: the next sibling that has the given id
+    def next(element_id)
+      self.next(element_id, from: target)
+    end
+
+    def next(element_id, from: from_view)
+      unless is_parent_layout?
+        return parent_layout.next(element_id, from: from_view)
+      end
+      search = @elements[element_id]
+      if search.nil? || search.empty?
+        return nil
+      end
+
+      if from_view.is_a?(NSString)
+        from_view = self.get(from_view)
+      end
+
+      if from_view.is_a?(ConstraintsTarget)
+        from_view = from_view.view
+      end
+
+      searching = false
+      found = nil
+      MotionKit.siblings(from_view).each do |sibling|
+        if sibling == from_view
+          searching = true
+        elsif searching && search.include?(sibling)
+          found = sibling
+          break
+        end
+      end
+      return found
+    end
+
+    # Search for a sibling: the previous sibling that has the given id
+    def prev(element_id)
+      prev(element_id, from: target)
+    end
+
+    def prev(element_id, from: from_view)
+      unless is_parent_layout?
+        return parent_layout.prev(element_id, from: from_view)
+      end
+
+      search = @elements[element_id]
+      if search.nil? || search.empty?
+        return nil
+      end
+
+      if from_view.is_a?(NSString)
+        from_view = self.get(from_view)
+      end
+
+      if from_view.is_a?(ConstraintsTarget)
+        from_view = from_view.view
+      end
+
+      found = nil
+      MotionKit.siblings(from_view).each do |sibling|
+        if sibling == from_view
+          break
+        elsif search.include?(sibling)
+          # keep searching; prev should find the *closest* matching view
+          found = sibling
+        end
+      end
+      return found
+    end
+
+    # This searches for the "nearest" view with a given id.  First, all child
+    # views are checked.  Then the search goes up to the parent view, and its
+    # child views are checked.  This means *any* view that is in the parent
+    # view's hierarchy is considered closer than a view in a grandparent's
+    # hierarchy.  This is a "depth-first" search, so any subview that contains
+    # a view with the element id
+    #
+    # A--B--C--D*   Starting at D, E is closer than F, because D&E are siblings.
+    #  \  \  \-E    But F, G and H are closer than A or I, because they share a
+    #   \  \-F--G   closer *parent* (B).  The logic is, "B" is a container, and
+    #    \-I  \-H   all views in that container are in a closer family.
+    def nearest(element_id)
+      nearest(element_id, from: target)
+    end
+
+    def nearest(element_id, from: from_view)
+      unless is_parent_layout?
+        return parent_layout.nearest(element_id, from: from_view)
+      end
+
+      search = @elements[element_id]
+      if search.nil? || search.empty?
+        return nil
+      end
+
+      if from_view.is_a?(NSString)
+        from_view = self.get(from_view)
+      end
+
+      if from_view.is_a?(ConstraintsTarget)
+        from_view = from_view.view
+      end
+
+      MotionKit.nearest(from_view) { |test_view| search.include?(test_view) }
+    end
+
     # Removes a view (or several with the same name) from the hierarchy
     # and forgets it entirely.  Returns the views that were removed.
     def remove(element_id)

data/lib/motion-kit/util.rb

@@ -10,7 +10,11 @@ module MotionKit
   end
 
   def setter(method_name)
-    "set#{method_name[0].capitalize}#{method_name[1..-1]}:"
+    setter = "set#{method_name[0].capitalize}#{method_name[1..-1]}"
+    unless setter.end_with?(':')
+      setter << ':'
+    end
+    setter
   end
 
   def appearance_class

data/lib/motion-kit/version.rb

@@ -1,3 +1,3 @@
 module MotionKit
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

data/spec/ios/nearest_spec.rb

@@ -0,0 +1,80 @@
+describe 'MotionKit nearest element logic' do
+
+  before do
+    @subject = TestNearestLayout.new.build
+  end
+
+  it 'should support self_search' do
+    found = nil
+    @subject.self_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:self_search)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support child_search' do
+    found = nil
+    @subject.child_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:child_search)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support sibling_search' do
+    found = nil
+    @subject.sibling_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:sibling_search)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support siblings_child_search' do
+    found = nil
+    @subject.siblings_child_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:siblings_child_search)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support parent_search' do
+    found = nil
+    @subject.parent_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:parent_search)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support distant_search' do
+    found = nil
+    @subject.distant_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:distant_search)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support nearest(id, from: view)' do
+    found = nil
+    @subject.nearest_from_search
+    @subject.context(@subject.start_here) do
+      from_here = @subject.get(:from_here)
+      found = @subject.nearest(:nearest_from_search, from: from_here)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+  it 'should support nearest(id, from: id)' do
+    found = nil
+    @subject.nearest_from_search
+    @subject.context(@subject.start_here) do
+      found = @subject.nearest(:nearest_from_search, from: :from_here)
+    end
+    found.should == @subject.expected_to_find
+  end
+
+end

data/spec/ios/prev_next_spec.rb

@@ -0,0 +1,153 @@
+describe 'MotionKit prev/next element logic' do
+
+  before do
+    @subject = TestPrevNextLayout.new.build
+  end
+
+  it 'should find "nil" before "first"' do
+    found = nil
+    @subject.context(@subject.first_row) do
+      found = @subject.prev(:row)
+    end
+    found.should == nil
+  end
+
+  it 'should find "first" before "second"' do
+    found = nil
+    @subject.context(@subject.second_row) do
+      found = @subject.prev(:row)
+    end
+    found.should == @subject.first_row
+  end
+
+  it 'should find "second" before "third"' do
+    found = nil
+    @subject.context(@subject.third_row) do
+      found = @subject.prev(:row)
+    end
+    found.should == @subject.second_row
+  end
+
+  it 'should find "second" after "first"' do
+    found = nil
+    @subject.context(@subject.first_row) do
+      found = @subject.next(:row)
+    end
+    found.should == @subject.second_row
+  end
+
+  it 'should find "third" after "second"' do
+    found = nil
+    @subject.context(@subject.second_row) do
+      found = @subject.next(:row)
+    end
+    found.should == @subject.third_row
+  end
+
+  it 'should find "nil" after "third"' do
+    found = nil
+    @subject.context(@subject.third_row) do
+      found = @subject.next(:row)
+    end
+    found.should == nil
+  end
+
+  describe 'Using :from option' do
+
+    before do
+      @subject.from_search
+      @start_here = @subject.get(:start_here)
+    end
+
+    it 'should find "nil" before "first"' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.prev(:row, from: @subject.first_row)
+      end
+      found.should == nil
+    end
+
+    it 'should find "first" before "second"' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.prev(:row, from: @subject.second_row)
+      end
+      found.should == @subject.first_row
+    end
+
+    it 'should find "second" before "third"' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.prev(:row, from: @subject.third_row)
+      end
+      found.should == @subject.second_row
+    end
+
+    it 'should find "second" after "first"' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.next(:row, from: @subject.first_row)
+      end
+      found.should == @subject.second_row
+    end
+
+    it 'should find "third" after "second"' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.next(:row, from: @subject.second_row)
+      end
+      found.should == @subject.third_row
+    end
+
+    it 'should find "nil" after "third"' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.next(:row, from: @subject.third_row)
+      end
+      found.should == nil
+    end
+
+  end
+
+  describe 'Using :from option and symbols' do
+
+    before do
+      @subject.from_symbol_search
+      @start_here = @subject.get(:start_here)
+    end
+
+    it 'should find prev(:first_row, from: :second_row)' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.prev(:first_row, from: :second_row)
+      end
+      found.should == @subject.first_row
+    end
+
+    it 'should find next(:third_row, from: :second_row)' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.next(:third_row, from: :second_row)
+      end
+      found.should == @subject.third_row
+    end
+
+    it 'should find prev(:first_row, from: :third_row)' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.prev(:first_row, from: :third_row)
+      end
+      found.should == @subject.first_row
+    end
+
+    it 'should find next(:third_row, from: :first_row)' do
+      found = nil
+      @subject.context(@start_here) do
+        found = @subject.next(:third_row, from: :first_row)
+      end
+      found.should == @subject.third_row
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-kit
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Colin T.A. Gray
@@ -48,8 +48,8 @@ files:
 - lib/motion-kit/util.rb
 - lib/motion-kit/version.rb
 - lib/motion-kit-cocoa/calculator/view_calculator.rb
+- lib/motion-kit-cocoa/cocoa_util.rb
 - lib/motion-kit-cocoa/constraints/constraint.rb
-- lib/motion-kit-cocoa/constraints/constraint_placeholder.rb
 - lib/motion-kit-cocoa/constraints/constraints_helpers.rb
 - lib/motion-kit-cocoa/constraints/constraints_target.rb
 - lib/motion-kit-cocoa/helpers/accessibility_compat.rb
@@ -116,10 +116,12 @@ files:
 - spec/ios/memory_leak_spec.rb
 - spec/ios/motion_kit_id_spec.rb
 - spec/ios/motionkit_util_spec.rb
+- spec/ios/nearest_spec.rb
 - spec/ios/objc_selectors_spec.rb
 - spec/ios/orientation_helper_specs.rb
 - spec/ios/parent_layout_spec.rb
 - spec/ios/parent_spec.rb
+- spec/ios/prev_next_spec.rb
 - spec/ios/reapply_frame.rb
 - spec/ios/relative_layout.spec.rb
 - spec/ios/remove_layout_spec.rb
@@ -200,10 +202,12 @@ test_files:
 - spec/ios/memory_leak_spec.rb
 - spec/ios/motion_kit_id_spec.rb
 - spec/ios/motionkit_util_spec.rb
+- spec/ios/nearest_spec.rb
 - spec/ios/objc_selectors_spec.rb
 - spec/ios/orientation_helper_specs.rb
 - spec/ios/parent_layout_spec.rb
 - spec/ios/parent_spec.rb
+- spec/ios/prev_next_spec.rb
 - spec/ios/reapply_frame.rb
 - spec/ios/relative_layout.spec.rb
 - spec/ios/remove_layout_spec.rb

data/lib/motion-kit-cocoa/constraints/constraint_placeholder.rb

@@ -1,22 +0,0 @@
-module MotionKit
-  class ConstraintPlaceholder
-
-    def initialize(type, name, value=nil)
-      @type = type
-      @name = name
-      @value = value
-    end
-
-    def resolve(layout)
-      case @type
-      when :first
-        layout.get_view(@name)
-      when :last
-        layout.last_view(@name)
-      when :nth
-        layout.nth_view(@name, @value)
-      end
-    end
-
-  end
-end