ruby_motion_query 0.1.1 → 0.2.0

data/motion/ruby_motion_query/color.rb

@@ -1,14 +1,45 @@
 module RubyMotionQuery
   class RMQ
+    # @return [Color]
     def self.color
       Color
     end
 
+    # @return [Color]
     def color 
       Color
     end
   end
 
+  # @example
+  #   # Standard colors:
+  #
+  #   # In a stylesheet, you can just use color. Anywhere else these would be
+  #   # rmq.color.clear, etc
+  #
+  #   color.clear      
+  #   color.white      
+  #   color.light_gray 
+  #   color.gray       
+  #   color.dark_gray  
+  #   color.black      
+  #               
+  #   color.red        
+  #   color.green      
+  #   color.blue       
+  #   color.yellow     
+  #   color.orange     
+  #   color.purple     
+  #   color.brown      
+  #   color.cyan       
+  #   color.magenta    
+  #               
+  #   color.table_view 
+  #   color.scroll_view
+  #   color.flipside   
+  #   color.under_page 
+  #   color.light_text 
+  #   color.dark_text  
   class Color < UIColor
 
     class << self
@@ -36,6 +67,13 @@ module RubyMotionQuery
       alias :light_text    :lightTextColor                       
       alias :dark_text     :darkTextColor                        
 
+      # Add your own standard color
+      #
+      # @return [UIColor]
+      #
+      # @example
+      #   rmq.color.add_named(:foo, '#ffffff')
+      #   my_label.color = rmq.color.foo # or just color.foo in a stylesheet
       def add_named(key, hex_or_color)
         color = if hex_or_color.is_a?(String)
           Color.from_hex(hex_or_color)
@@ -48,7 +86,15 @@ module RubyMotionQuery
         end
       end
 
+      # Creates a color from a hex triplet
+      #
       # Thanks bubblewrap for this method
+      #
+      # @param hex with or without the #
+      # @return [UIColor]
+      # @example
+      #   color.from_hex('#ffffff')
+      #   color.from_hex('ffffff')
       def from_hex(hex_color)
         hex_color.gsub!("#", "")   
         case hex_color.size 
@@ -66,10 +112,18 @@ module RubyMotionQuery
         end 
       end 
 
+      # @return [UIColor]
+      #
+      # @example
+      #   rmq.color.from_rgba(255,255,255,0.5)
       def from_rgba(r,g,b,a)
         UIColor.colorWithRed((r/255.0), green: (g/255.0), blue: (b/255.0), alpha: a)
       end
 
+      # @return [UIColor]
+      #
+      # @example
+      #   rmq.color.from_hsva(100,140,80,1.0)
       def from_hsva(h,s,v,a)
         UIColor.alloc.initWithHue(h, saturation: s, brightness: v, alpha: a)
       end

data/motion/ruby_motion_query/data.rb

@@ -2,14 +2,19 @@ module RubyMotionQuery
   class ViewData
     attr_accessor :events, :style_name
 
+    # @return [Hash] Array of tag names assigned to to this view
     def tags
       @_tags ||= {}
     end
 
+    # @return [Array] Array of tag names assigned to to this view
     def tag_names
       tags.keys
     end
 
+    # *Do not* use this, use {RMQ#tag} instead: 
+    # @example
+    #   rmq(my_view).tag(:foo)
     def tag(*tag_or_tags)
       tag_or_tags.flatten!
       tag_or_tags.each do |tag_name|
@@ -17,6 +22,10 @@ module RubyMotionQuery
       end
     end
 
+    # Check if this view contains a specific tag
+    #
+    # @param tag_name name of tag to check
+    # @return [Boolean] true if this view has the tag provided
     def has_tag?(tag_name = nil)
       if tag_name
         tags.include?(tag_name)

data/motion/ruby_motion_query/device.rb

@@ -1,8 +1,11 @@
 module RubyMotionQuery
   class RMQ
+    # @return [Device]
     def device
       Device
     end
+
+    # @return [Device]
     def self.device
       Device
     end
@@ -10,14 +13,17 @@ module RubyMotionQuery
 
   class Device
     class << self
+      # @return [UIScreen]
       def screen
         UIScreen.mainScreen
       end
 
+      # @return [Numeric]
       def width
         @_width ||= Device.screen.bounds.size.width
       end
 
+      # @return [Numeric]
       def height
         @_height ||= Device.screen.bounds.size.height
       end
@@ -46,6 +52,7 @@ module RubyMotionQuery
         @_retina
       end
 
+      # @return :unknown or from ORIENTATIONS
       def orientation
         ORIENTATIONS[UIDevice.currentDevice.orientation] || :unknown
       end

data/motion/ruby_motion_query/enumerablish.rb

@@ -3,11 +3,15 @@ module RubyMotionQuery
     # I'm purposly not including Enumerable, 
     # please use to_a if you want one
 
+
+    # @return [RMQ]
     def <<(value)
       selected << value if value.is_a?(UIView)
       self
     end
 
+    # @return [RMQ]
+    #
     # @example
     #   rmq(UILabel)[3]
     #   or
@@ -17,54 +21,65 @@ module RubyMotionQuery
     end
     alias :eq :[]
 
+    # @return [RMQ]
     def each(&block)
       return self unless block
       RMQ.create_with_array_and_selectors(selected.each(&block), @selectors, @context)
     end
 
+    # @return [RMQ]
     def map(&block)
       return self unless block
       RMQ.create_with_array_and_selectors(selected.map(&block), @selectors, @context)
     end
     alias :collect :map
 
+    # @return [RMQ]
     def select(&block)
       return self unless block
       RMQ.create_with_array_and_selectors(selected.select(&block), @selectors, @context)
     end
 
+    # @return [RMQ]
     def detect(&block) # Unlike enumerable, detect and find are not the same. See find in transverse
       return self unless block
       RMQ.create_with_array_and_selectors(selected.select(&block), @selectors, @context)
     end
 
+    # @return [RMQ]
     def grep(&block)
       return self unless block
       RMQ.create_with_array_and_selectors(selected.grep(&block), @selectors, @context)
     end
 
+    # @return [RMQ]
     def reject(&block)
       return self unless block
       RMQ.create_with_array_and_selectors(selected.reject(&block), @selectors, @context)
     end
 
+    # @return [RMQ]
     def inject(o, &block)
       return self unless block
       RMQ.create_with_array_and_selectors(selected.inject(o, &block), @selectors, @context)
     end
     alias :reduce :inject
 
+    # @return [RMQ]
     def first
       RMQ.create_with_array_and_selectors([selected.first], @selectors, @context)
     end
+    # @return [RMQ]
     def last
       RMQ.create_with_array_and_selectors([selected.last], @selectors, @context)
     end
 
+    # @return [Array]
     def to_a
       selected
     end
 
+    # @return [Integer] number of views selected
     def length
       selected.length
     end

data/motion/ruby_motion_query/events.rb

@@ -1,5 +1,6 @@
 module RubyMotionQuery
   class RMQ
+    # @return [RMQ]
     def on(event, args = {}, &block)
       selected.each do |view|
         events(view).on(view, event, args, &block) 
@@ -8,6 +9,7 @@ module RubyMotionQuery
       self
     end
 
+    # @return [RMQ]
     def off(*events)
       selected.each do |view|
         events(view).off(events)

data/motion/ruby_motion_query/factory.rb

@@ -2,16 +2,19 @@ module RubyMotionQuery
   class RMQ
     # TODO question, should there be a rmq pool to reuse?
 
+    # @return [RMQ]
     def create_blank_rmq
       RMQ.create_with_array_and_selectors([], self.selectors, @context)
     end
 
+    # @return [RMQ]
     def create_rmq_in_context(*selectors)
       RMQ.create_with_selectors(selectors, @context)
     end
 
     class << self
 
+      # @return [RMQ]
       def create_with_selectors(selectors, context)
         RMQ.new.tap do |o|
           o.context = context
@@ -19,6 +22,7 @@ module RubyMotionQuery
         end
       end
 
+      # @return [RMQ]
       def create_with_array_and_selectors(array, selectors, context)
         RMQ.new.tap do |o|
           o.context = context

data/motion/ruby_motion_query/font.rb

@@ -1,10 +1,11 @@
-# Add custome app-wide fonts here
 module RubyMotionQuery
   class RMQ
+    # @return [Font]
     def self.font
       Font
     end
 
+    # @return [Font]
     def font
       Font
     end
@@ -12,24 +13,28 @@ module RubyMotionQuery
 
   class Font
     class << self
-      # One way to add your own fonts it to open up the Font class and add your
-      # own message.
-      #
-      # STANDARD_FONT = 'Helvetica Neue'
-      # def standard_at_size(size);
-      #   UIFont.fontWithName(STANDARD_NAME, size: size)
-      # end
-      # def standard_large ; @standard_large ||= standard_at_size(18) ; end
-      # def standard_medium ; @standard_medium ||= standard_at_size(12) ; end
 
-      
-      # Another way is to add named fonts:
+      # @example
+      #   # One way to add your own fonts it to open up the Font class and add your own
+      #   STANDARD_FONT = 'Helvetica Neue'
+      #   def standard_at_size(size);
+      #     UIFont.fontWithName(STANDARD_NAME, size: size)
+      #   end
+      #   def standard_large ; @standard_large ||= standard_at_size(18) ; end
+      #   def standard_medium ; @standard_medium ||= standard_at_size(12) ; end
+      #
       #
-      # Example
+      #   # Another way is to add named fonts:
       #   RubyMotionQuery::Font.add_named_font :large,  STANDARD_FONT, 44
       #
+      #   # In a stylesheet you can just do
+      #   font.add_named_font :large,  STANDARD_FONT, 44
+      #
       #   # The use like so in your stylesheet:
-      #     font = font.large
+      #   font = font.large
+      #
+      #   # The use like so anywhere else:
+      #   font = rmq.font.large
       def add_named(key, font_name_or_font, size = nil)
         font = if font_name_or_font.is_a?(UIFont)
           font_name_or_font
@@ -42,20 +47,34 @@ module RubyMotionQuery
         end
       end
 
+      # @param name [String] Name of font
+      # @param size [Float] Size of font
+      # @return [UIFont]
+      #
+      # @example
+      #   font = rmq.font.font_with_name('Helvetica Neue', 18)
       def font_with_name(name, size)
+        # TODO, should rename this to just with_name, so it's rmq.font.with_name
         UIFont.fontWithName(name, size: size)
       end
       alias :with_name :font_with_name
 
       # Use this in the console to get a list of font families
+      # @return [Array]
       def family_list
         UIFont.familyNames.sort
       end
 
+      # @return [Array]
       def for_family(family)
         UIFont.fontNamesForFamilyName(family)
       end
 
+      # @param size (Float)
+      # @return [UIFont] System font given size
+      #
+      # @example
+      #   font = rmq.font.system(18)
       def system(size = nil)
         UIFont.systemFontOfSize(size)
       end

data/motion/ruby_motion_query/format.rb

@@ -1,8 +1,11 @@
 module RubyMotionQuery
   class RMQ
+    # @return [Format]
     def format
       Format
     end
+
+    # @return [Format]
     def self.format
       Format
     end

data/motion/ruby_motion_query/image.rb

@@ -1,9 +1,11 @@
 module RubyMotionQuery
   class RMQ
+    # @return [ImageUtils]
     def self.image
       ImageUtils
     end
 
+    # @return [ImageUtils]
     def image
       ImageUtils
     end
@@ -12,10 +14,13 @@ module RubyMotionQuery
   class ImageUtils
     class << self
       DEFAULT_IMAGE_EXT = 'png'
+
+      # @return [UIImage]
       def resource_for_device(file_base_name, opts = {})
         resource( RMQ.device.four_inch? ? "#{file_base_name}-568h" : file_base_name, opts)
       end
 
+      # @return [UIImage]
       def resource(file_base_name, opts = {})
         ext = opts[:ext] || DEFAULT_IMAGE_EXT
         cached = opts[:cached]
@@ -30,6 +35,7 @@ module RubyMotionQuery
         end
       end
 
+      # @return [UIImage]
       def resource_resizable(file_base_name, opts)
         # TODO, also alloow short syntax, t: instead of top: etc
         ext = opts[:ext] || DEFAULT_IMAGE_EXT
@@ -37,7 +43,7 @@ module RubyMotionQuery
         image.resizableImageWithCapInsets([opts[:top], opts[:left], opts[:bottom], opts[:right]], resizingMode: UIImageResizingModeStretch) 
       end
 
-      # [FROM Sugarcube, thanks Sugarcube]
+      # Note: FROM Sugarcube, thanks Sugarcube
       #
       # Easily take a snapshot of a `UIView`.
       #
@@ -53,6 +59,8 @@ module RubyMotionQuery
       # It is guaranteed that `true` and `:all` will always have this behavior.  In
       # the future, if this argument becomes something that accepts multiple values,
       # those two are sacred.
+      #
+      # @return [UIImage]
       def from_view(view, use_content_size = false)
         scale = UIScreen.mainScreen.scale
         if use_content_size

data/motion/ruby_motion_query/position.rb

@@ -1,6 +1,7 @@
 module RubyMotionQuery
   class RMQ
 
+    # @return [RMQ]
     def move(opts) 
       # TODO, add centered and from_bottom and from_top, and bottom and top
       # TODO, add animate option
@@ -20,12 +21,7 @@ module RubyMotionQuery
     end
     alias :resize :move
 
-    def align(direction)
-      # TODO
-      # rmq(UILabel).align(:left)
-      # rmq(UILabel).align(:left, :top)
-    end
-
+    # @return [RMQ]
     def nudge(opts) 
       left = opts[:left] || opts[:l] || 0
       right = opts[:right] || opts[:r] || 0