motion-kit 0.9.4 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff9ff05dc542edf1cf722b6959a0d52d4a16d34c
-  data.tar.gz: f9afc6aa8839fb471bfe7dcb8ac44766260b4ddd
+  metadata.gz: ca8bcc4c3162610c0090bb119ed03e2c1ebf5484
+  data.tar.gz: 002fd919664672e8b07fc6a56ac8103e4d61b75b
 SHA512:
-  metadata.gz: aabf1ad8ebf3a7a231d314823048c9b87d08e5a1b06a87a8c3fe60f7f87398073a136bbdd58985d974276b3b1f0d2e66d669125a158f0d87a675c76c64eb0cd3
-  data.tar.gz: 58c9e0bcf282924128803765e8cf2fede6620f6bf2360bc643429e1704fa4abfb2fd4e9b71683294badb1042004b0fc8e0f3b858771546375baef47103f26165
+  metadata.gz: 125fd67fafeeccbed6778c15281a9bdd4f1e4cb48d28f57edd18dec56089345cec1069a3a7b2c407e194efe8241d9c6285179fff28354078467810027e1239b5
+  data.tar.gz: 85d2bf979800eee4f63d2114fc0cda48a2a2918ee0b2a8f9f2a38828e97f482b571ef6e4702930ddc2d17ddecdd0f22368a35a79c99e817fd6f3c829a1764bb2

data/README.md

@@ -43,6 +43,12 @@ be replaced with a new project, rather than upgraded or refactored.
 
 ## Usage
 
+Install:
+
+```ruby
+gem install 'motion-kit'
+```
+
 From your controller you will instantiate a `MotionKit::Layout` instance, and
 request views from it.  `layout.view` is the root view, and it's common to
 assign this to `self.view` in your `loadView` method.  You'll also want to hook
@@ -346,8 +352,9 @@ module MotionKit
 end
 ```
 
-For your own custom classes, you can provide a Layout class by calling the
-`targets` method in your class body.
+For your own custom classes, or built-in classes that don't already have a
+`Layout` class defined, you can provide a Layout class by calling the `targets`
+method in your class body.
 
 ```ruby
 # Be sure to extend an existing Layout class, otherwise you'll lose a lot of
@@ -494,59 +501,7 @@ be using Cocoa's Auto Layout system instead.  This is the recommended way to set
 your frames, now that Apple is introducing multiple display sizes.  But beware,
 Auto Layout can be frustrating... :-/
 
-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).
-
-Essentially, the problem comes down to this: you will often want to set
-constraints that are related to the view controller's `view`, but those must be
-created/set *after* `controller.view = @layout.view`.  Without doing some crazy
-method mangling on NS/UIView we just can't do this automatically
-
-Long story short: If you need to create constraints that refer to the controller
-view, you need to use a separate method that is called after the view hierarchy
-is created.
-
-```ruby
-class MainLayout < UIViewLayout
-
-  def layout
-    add UILabel, :label do
-      constraints do
-        x 0
-        width('100%')
-      end
-    end
-  end
-
-  def add_constraints(controller)
-    unless @layout_constraints_added
-      @layout_constraints_added = true
-      constraints(:label) do
-        top.equals(controller.topLayoutGuide)
-      end
-    end
-  end
-
-end
-
-class MainController < UIViewController
-
-  def loadView
-    @layout = MainLayout.new
-    self.view = @layout
-  end
-
-  # for the constraints to work reliably they should be added in this method:
-  def updateViewConstraints
-    @layout.add_constraints(self)  # !!!
-    super
-  end
-
-end
-```
-
-OK, with that hack out of the way, on to the examples!
+Here are some examples to get started:
 
 ```ruby
 constraints do
@@ -633,50 +588,61 @@ add UIView, :bar do
 end
 ```
 
-### Frames
+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).
+
+Essentially, the problem comes down to this: you will often want to set
+constraints that are related to the view controller's `view`, but those must be
+created/set *after* `controller.view = @layout.view`.  Without doing some crazy
+method mangling on NS/UIView we just can't do this automatically
 
-There are lots of frame helpers for NSView and UIView subclasses:
+Long story short: If you need to create constraints that refer to the controller
+view, you need to use a separate method that is called after the view hierarchy
+is created.
 
 ```ruby
-# most direct
-frame [[0, 0], [320, 568]]
-# using relative sizes (relative to superview)
-frame [[5, 5], ['100% - 10', '100% - 10']]
+class MainLayout < UIViewLayout
 
-# same, but using separate methods
-origin [5, 5]
-x 5
-y 5
-size ['100% - 10', '100% - 10']
-width '100% - 10'
-height '100% - 10'
+  def layout
+    add UILabel, :label do
+      constraints do
+        x 0
+        width('100%')
+      end
+    end
+  end
 
-size ['90%', '90%']
-center ['50%', '50%']
+  # this method will be called from `UIViewController#updateViewConstraints`
+  def add_constraints(controller)
+    unless @layout_constraints_added
+      @layout_constraints_added = true
+      constraints(:label) do
+        top.equals(controller.topLayoutGuide)
+      end
+    end
+  end
 
-# you can position the view *relative to other views*, either the superview or
-# *any* other view.
-from_bottom_right size: [100, 100]  # 100x100pt in the BR corner
-from_bottom size: ['100%', 32]  # full width, 32pt height
-from_top_right left: 5
+end
 
-# from_top_left      from_top       from_top_right
-# from_left         from_center         from_right
-# from_bottom_left  from_bottom  from_bottom_right
+class MainController < UIViewController
 
-# these require another view
-foo = self.get(:foo)
-above foo, up: 8
-#      above
-# before   after
-# left_of  right_of
-#      below
-relative_to foo, down: 5, right: 5
-from_bottom_left foo, up: 5, left: 5
+  def loadView
+    @layout = MainLayout.new
+    self.view = @layout
+  end
+
+  # for the constraints to work reliably they should be added in this method:
+  def updateViewConstraints
+    @layout.add_constraints(self)
+    super
+  end
+
+end
 ```
 
 
-### Some handy tricks
+### Some handy tricks and Features
 
 #### Orientation specific styles
 
@@ -731,6 +697,7 @@ def login_button_style
 end
 ```
 
+
 #### Apply styles via module
 
 ```ruby
@@ -760,6 +727,22 @@ class LoginLayout < MotionKit::Layout
 end
 ```
 
+
+#### Setting a custom root view
+
+If you need to use a custom root view, you can use the `root` method from within
+the `layout` method.  When you create or assign the root view this way, you must
+assign subviews and styles *inside* a block that you pass to `root`.
+
+```ruby
+def layout
+  root(SomeOtherViewclass) do
+    add UILabel
+  end
+end
+```
+
+
 # Contributing
 
 We welcome your contributions! Please be sure to run the specs before you do,

data/lib/motion-kit/calculate.rb

@@ -57,7 +57,7 @@ module MotionKit
       y_offset = 0
 
       if amount.is_a?(Hash)
-        if amount.fetch(:relative, false)
+        if amount[:relative]
           if amount.key?(:x)
             x = amount[:x]
           else
@@ -91,7 +91,7 @@ module MotionKit
         else
           if amount.key?(:right)
             x_offset = -my_size.width
-            x = amount.fetch(:right, view.frame.origin.x)
+            x = amount[:right]
           elsif amount.key?(:x) || amount.key?(:left)
             x = amount[:x] || amount[:left]
           elsif dimension == :center
@@ -103,7 +103,7 @@ module MotionKit
 
           if amount.key?(:bottom)
             y_offset = -my_size.height
-            y = amount.fetch(:bottom, view.frame.origin.y)
+            y = amount[:bottom]
           elsif amount.key?(:y) || amount.key?(:top)
             y = amount[:y] || amount[:top]
           elsif dimension == :center

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

@@ -8,7 +8,7 @@ module MotionKit
   # delegated to the 'apply' method, which accepts a method name, arguments, and
   # an optional block to set the new context.
   #
-  # The ViewLayout subclass defines methods that are appropriate for adding and
+  # The TreeLayout subclass defines methods that are appropriate for adding and
   # removing views to a view hierarchy.
   class BaseLayout
     # Class methods reside in base_layout_class_methods.rb
@@ -167,7 +167,7 @@ module MotionKit
       begin
         target = self.target
       rescue NoContextError => e
-        raise NoMethodError.new(method_name)
+        raise NoMethodError.new("undefined method `#{method_name}' for #{self}:#{self.class}", method_name)
       end
 
       if args.length == 2 && args[1].is_a?(Hash) && !args[1].empty?
@@ -188,7 +188,7 @@ module MotionKit
       if block
         apply_with_context(method_name, *args, &block)
       else
-        apply_with_target(method_name, *args)
+        apply_with_target(method_name, *args, &block)
       end
     end
 
@@ -215,7 +215,7 @@ module MotionKit
       end
     end
 
-    def apply_with_target(method_name, *args)
+    def apply_with_target(method_name, *args, &block)
       setter = MotionKit.setter(method_name)
       assign = "#{method_name}="
       if args.length == 2 && args[1].is_a?(Hash) && !args[1].empty?
@@ -234,24 +234,24 @@ module MotionKit
       #   combined getter/setter (`layer(val)`)
       # - lastly, try again after converting to camelCase
       if long_method_name && target.respond_to?(long_method_name)
-        target.send(long_method_name, *long_method_args)
+        target.send(long_method_name, *long_method_args, &block)
       elsif args.empty? && target.respond_to?(method_name)
-        target.send(method_name, *args)
+        target.send(method_name, *args, &block)
       elsif target.respond_to?(setter)
-        target.send(setter, *args)
+        target.send(setter, *args, &block)
       elsif target.respond_to?(assign)
-        target.send(assign, *args)
+        target.send(assign, *args, &block)
       elsif target.respond_to?(method_name)
-        target.send(method_name, *args)
+        target.send(method_name, *args, &block)
       # UIAppearance classes are a whole OTHER thing; they never return 'true'
       elsif target.is_a?(MotionKit.appearance_class)
-        target.send(setter, *args)
+        target.send(setter, *args, &block)
       # Finally, try again with camel case if there's an underscore.
       elsif method_name.include?('_')
         objc_name = MotionKit.objective_c_method_name(method_name)
         self.apply(objc_name, *args)
       else
-        target.send(setter, *args)
+        target.send(setter, *args, &block)
         # raise ApplyError.new("Cannot apply #{method_name.inspect} to instance of #{target.class.name} (from #{@layout_delegate && @layout_delegate.class})")
       end
     end

data/lib/motion-kit/layouts/{view_layout.rb → tree_layout.rb}

@@ -1,14 +1,12 @@
-# @provides MotionKit::ViewLayout
+# @provides MotionKit::TreeLayout
 # @requires MotionKit::BaseLayout
 module MotionKit
-  # A sensible parent class for any View-like layout class. Platform agnostic.
-  # Any platform-specific tasks are offloaded to child views (add_child,
-  # remove_child).
-  # Actually, "view like" is misleading, since technically it only assumes "tree
-  # like". You could use a ViewLayout subclass to construct a hierarchy
+  # A sensible parent class for any Tree-like layout class. Platform agnostic.
+  # Any platform-specific tasks are offloaded to child elements (add_child,
+  # remove_child). You could use a TreeLayout subclass to construct a hierarchy
   # representing a family tree, for instance. But that would be a silly use of
   # MotionKit.
-  class ViewLayout < BaseLayout
+  class TreeLayout < BaseLayout
 
     class << self
 
@@ -159,9 +157,9 @@ module MotionKit
       return self
     end
 
-    # Delegates to `create` to instantiate a view and run a layout block, and
-    # adds the view to the current view on the view stack.  If no view exists on
-    # the stack, a default root view can be created if that has been enabled.
+    # Instantiates a view via `create` and adds the view to the current target.
+    # If no view exists on the stack, a default root view can be created if that
+    # has been enabled.  The block is run in the context of the new view.
     def add(element, element_id=nil, &block)
       # make sure we have a target - raises NoContextError if none exists
       self.target
@@ -171,7 +169,11 @@ module MotionKit
         create_default_root_context
       end
       self.apply(:add_child, element)
-      create(element, element_id, &block)
+      create(element, element_id)
+
+      if block
+        context(element, &block)
+      end
 
       element
     end
@@ -278,7 +280,7 @@ module MotionKit
         if @assign_root
           create_default_root_context
         else
-          NSLog('Warning! No root view was set in ViewLayout#layout. Did you mean to call `root`?')
+          NSLog('Warning! No root view was set in TreeLayout#layout. Did you mean to call `root`?')
         end
       end
       run_deferred(@view)
@@ -311,11 +313,11 @@ module MotionKit
     # Accepts a view instance, a class (which is instantiated with 'new') or a
     # `ViewLayout`, which returns the root view.
     def initialize_view(elem)
-      if elem.is_a?(Class) && elem < ViewLayout
+      if elem.is_a?(Class) && elem < TreeLayout
         elem = elem.new_child(@layout, nil, self).view
       elsif elem.is_a?(Class)
         elem = elem.new
-      elsif elem.is_a?(ViewLayout)
+      elsif elem.is_a?(TreeLayout)
         elem = elem.view
       end
 

data/lib/motion-kit/version.rb

@@ -1,3 +1,3 @@
 module MotionKit
-  VERSION = '0.9.4'
+  VERSION = '0.9.6'
 end

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

@@ -395,11 +395,11 @@ module MotionKit
     end
 
     def attribute=(value)
-      raise NoMethodError.new('attribute=')
+      raise NoMethodError.new("undefined method `#{:attribute=}' for #{self}:#{self.class}", :attribute=)
     end
 
     def attribute2=(value)
-      raise NoMethodError.new('attribute2=')
+      raise NoMethodError.new("undefined method `#{:attribute2=}' for #{self}:#{self.class}", :attribute2=)
     end
 
     def constant=(constant)

data/lib/motion-kit-cocoa/layouts/cagradientlayer_layout.rb

@@ -1,12 +1,12 @@
 # @provides MotionKit::CAGradientLayerLayout
 # @requires MotionKit::CALayerLayout
-# @requires MotionKit::ViewLayout
+# @requires MotionKit::TreeLayout
 module MotionKit
   class CAGradientLayerLayout < CALayerLayout
     targets CAGradientLayer
 
     def colors(values)
-      target.colors = values.map { |color| color.is_a?(UIColor) ? color.CGColor : color }
+      target.colors = values.map { |color| color.is_a?(MotionKit.color_class) ? color.CGColor : color }
     end
 
   end

data/lib/motion-kit-cocoa/layouts/calayer_layout.rb

@@ -1,7 +1,7 @@
 # @provides MotionKit::CALayerLayout
-# @requires MotionKit::ViewLayout
+# @requires MotionKit::TreeLayout
 module MotionKit
-  class CALayerLayout < ViewLayout
+  class CALayerLayout < TreeLayout
     targets CALayer
 
     # platform specific default root view

data/lib/motion-kit-ios/ios_util.rb

@@ -13,6 +13,10 @@ module MotionKit
     UIView
   end
 
+  def color_class
+    UIColor
+  end
+
   def no_intrinsic_metric
     UIViewNoIntrinsicMetric
   end

data/lib/motion-kit-ios/layouts/uiview_layout.rb

@@ -1,8 +1,8 @@
 # @provides MotionKit::Layout
 # @provides MotionKit::UIViewLayout
-# @requires MotionKit::ViewLayout
+# @requires MotionKit::TreeLayout
 module MotionKit
-  class Layout < ViewLayout
+  class Layout < TreeLayout
 
     # platform specific default root view
     def default_root

data/lib/motion-kit-ios/layouts/uiview_layout_frame.rb

@@ -107,7 +107,7 @@ module MotionKit
       if f.is_a?(Hash)
         f = f.merge(relative: true)
       end
-      f = MotionKit.calculate(calculate_view, :frame, f, from_view)
+      f = MotionKit.calculate(calculate_view, :frame, f, target.superview)
       f.origin.x += o.x
       f.origin.y += o.y
 
@@ -272,18 +272,27 @@ module MotionKit
 
     # The first arg can be a view or a frame
     # @example
+    #   frame above(view, [[0, 0], [100, 20]])
+    #   frame above(:view, x: 0, y: 0, width: 100, height: 20)
+    #   frame above(:view, down: 0, right: 0, width: 100, height: 20)
     def above(from_view, f={})
       _calculate_frame(f, from: from_view, relative_to: { x: :reset, y: :above })
     end
 
     # The first arg can be a view or a frame
     # @example
+    #   frame below(view, [[0, 0], [100, 20]])
+    #   frame below(:view, x: 0, y: 0, width: 100, height: 20)
+    #   frame below(:view, down: 0, right: 0, width: 100, height: 20)
     def below(from_view, f={})
       _calculate_frame(f, from: from_view, relative_to: { x: :reset, y: :below })
     end
 
     # The first arg can be a view or a frame
     # @example
+    #   frame before(view, [[0, 0], [100, 20]])
+    #   frame before(:view, x: 0, y: 0, width: 100, height: 20)
+    #   frame before(:view, down: 0, right: 0, width: 100, height: 20)
     def before(from_view, f={})
       _calculate_frame(f, from: from_view, relative_to: { x: :before, y: :reset })
     end
@@ -291,6 +300,9 @@ module MotionKit
 
     # The first arg can be a view or a frame
     # @example
+    #   frame after(view, [[0, 0], [100, 20]])
+    #   frame after(:view, x: 0, y: 0, width: 100, height: 20)
+    #   frame after(:view, down: 0, right: 0, width: 100, height: 20)
     def after(from_view, f={})
       _calculate_frame(f, from: from_view, relative_to: { x: :after, y: :reset })
     end
@@ -298,6 +310,9 @@ module MotionKit
 
     # The first arg must be a view
     # @example
+    #   frame relative_to(view, [[0, 0], [100, 20]])
+    #   frame relative_to(:view, x: 0, y: 0, width: 100, height: 20)
+    #   frame relative_to(:view, down: 0, right: 0, width: 100, height: 20)
     def relative_to(from_view, f)
       _calculate_frame(f, from: from_view, relative_to: { x: :reset, y: :reset })
     end

data/lib/motion-kit-osx/layouts/nsmenu_layout.rb

@@ -1,8 +1,8 @@
 # @provides MotionKit::MenuLayout
 # @provides MotionKit::NSMenuLayout
-# @requires MotionKit::ViewLayout
+# @requires MotionKit::TreeLayout
 module MotionKit
-  class MenuLayout < ViewLayout
+  class MenuLayout < TreeLayout
 
     # A more sensible name for the menu that is created.
     def menu

data/lib/motion-kit-osx/layouts/nsview_layout.rb

@@ -1,8 +1,8 @@
 # @provides MotionKit::Layout
 # @provides MotionKit::NSViewLayout
-# @requires MotionKit::ViewLayout
+# @requires MotionKit::TreeLayout
 module MotionKit
-  class Layout < ViewLayout
+  class Layout < TreeLayout
 
     # platform specific default root view
     def default_root

data/lib/motion-kit-osx/layouts/nswindow_layout.rb

@@ -1,8 +1,8 @@
 # @provides MotionKit::WindowLayout
 # @provides MotionKit::NSWindowLayout
-# @requires MotionKit::ViewLayout
+# @requires MotionKit::TreeLayout
 module MotionKit
-  class WindowLayout < ViewLayout
+  class WindowLayout < TreeLayout
 
     # A more sensible name for the window that is created.
     def window

data/lib/motion-kit-osx/osx_util.rb

@@ -9,6 +9,10 @@ module MotionKit
     NSView
   end
 
+  def color_class
+    NSColor
+  end
+
   def no_intrinsic_metric
     NSViewNoInstrinsicMetric
   end

data/lib/motion-kit.rb

@@ -5,6 +5,7 @@ end
 
 require 'dbt'
 
+
 Motion::Project::App.setup do |app|
   core_lib = File.join(File.dirname(__FILE__), 'motion-kit')
   cocoa_lib = File.join(File.dirname(__FILE__), 'motion-kit-cocoa')

data/spec/ios/apply_styles_spec.rb

@@ -14,6 +14,7 @@ describe "Layouts automatically apply styles" do
   it "should apply all styles" do
     @subject.get(:logo).text.should == 'MK'
     @subject.get(:label).text.should == ':label'
+    @subject.get(:label).numberOfLines.should == 2
     @subject.get(:label).font.pointSize.should == 16
     @subject.get(:label).textColor.should == UIColor.blackColor
   end

data/spec/ios/frame_helper_spec.rb

@@ -524,6 +524,17 @@ describe 'Frame helpers' do
     @view.frame.size.height.should == @view_size.height
   end
 
+  it 'should support setting the frame via `from_top(view, width: "100%")`' do
+    @layout.context(@view) do
+      retval = @layout.frame @layout.from_top(@another_view, x: 1, y: 1, width: '100%')
+      retval.should == @view.frame
+    end
+    @view.frame.origin.x.should == @another_view.frame.origin.x + (@another_view.frame.size.width - @view.frame.size.width) / 2 + 1
+    @view.frame.origin.y.should == @another_view.frame.origin.y + 1
+    @view.frame.size.width.should == @superview_size.width
+    @view.frame.size.height.should == @view_size.height
+  end
+
   it 'should support setting the frame via `from_top_right`' do
     @layout.context(@view) do
       retval = @layout.frame @layout.from_top_right()

data/spec/ios/uibutton_layout_spec.rb

@@ -21,4 +21,17 @@ describe 'UIButton Layout and objc-style selectors' do
     @layout.get(:button).imageForState(UIControlStateHighlighted).should == TestButtonLayout::HIGHLIGHTED_IMAGE
   end
 
+  it 'should set the titleLabel font' do
+    font = @layout.get(:button).titleLabel.font
+    should_be_font = UIFont.fontWithName(TestButtonLayout::FONT, size: TestButtonLayout::SIZE)
+
+    font.familyName.should == should_be_font.familyName
+    font.pointSize.should == should_be_font.pointSize
+  end
+
+  it 'should set the titleLabel textAlignment' do
+    alignment = @layout.get(:button).titleLabel.textAlignment
+    alignment.should == NSTextAlignmentCenter
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-kit
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.6
 platform: ruby
 authors:
 - Colin T.A. Gray
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dbt
@@ -38,7 +38,7 @@ files:
 - lib/motion-kit/layouts/base_layout.rb
 - lib/motion-kit/layouts/base_layout_class_methods.rb
 - lib/motion-kit/layouts/parent.rb
-- lib/motion-kit/layouts/view_layout.rb
+- lib/motion-kit/layouts/tree_layout.rb
 - lib/motion-kit/motion-kit.rb
 - lib/motion-kit/object.rb
 - lib/motion-kit/util.rb