pm_swipe_cells 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee6464bf2068b46c6ce13f5c7958273cc76cad4
-  data.tar.gz: 3941a0599b9f77c78c6640317eed2dc033d71c69
+  metadata.gz: 13bba2955e371e6eebd622d359bab7d84541f681
+  data.tar.gz: caffab3a5c8b128f21184238ea7637662c49beca
 SHA512:
-  metadata.gz: 88361179a72a5e3122e511f159c540830bdb6dd60126bb039d82a84350f3ee94fc9afb28f5e33d67556f0f80d11c1bb8f7d123991a7b4ce05054e139eb25b346
-  data.tar.gz: a6439286b24ee59a4d300dfe052660ded58a2639eb7f5a818551b522432829c05e7476f59f2031111534c17b134dde6260b458468f5ed8fc2eaf810674b20e88
+  metadata.gz: 9ac17f4f8492dcf0476f2303e0786709987589c27cdf18245ffd10b1f6e47fd37f756f64b848a7ea096c09bdb2292323c6a772fb460123033b366439442e02ea
+  data.tar.gz: 3589af61e92e9d024b345e1f55fdd19dc719ab15671b2f28fde69a56a0b8b9eaf6b124beecd846df994471ad17887dd6b300146935165b8e432a51dab8cd04e0

data/README.md

@@ -0,0 +1,169 @@
+# PMSwipeCells
+
+This gem provides a wrapper which easily integrates the swipeable content view and buttons of [SWTableViewCell](https://github.com/CEWendel/SWTableViewCell) into the [ProMotion](https://github.com/clearsightstudio/ProMotion) framework for RubyMotion.
+
+<p align="center"><img src="http://i.imgur.com/njKCjK8.gif"/></p>
+
+## Installation
+
+First, add to your Gemfile:
+```ruby
+gem 'pm_swipe_cells'
+```
+
+Then:
+
+```sh-session
+$ bundle
+$ rake pod:install
+```
+
+# Functionality and Features
+*Fucntionality and Features write-up (and the accompanying GIFs) is taken directly from the [SWTableViewCell] repo. All credit to [CEWendel](https://github.com/CEWendel)*
+
+##Functionality
+###Right Utility Buttons
+Utility buttons that become visible on the right side of the Table View Cell when the user swipes left. This behavior is similar to that seen in the iOS apps Mail and Reminders.
+
+<p align="center"><img src="http://i.imgur.com/gDZFRpr.gif"/></p>
+
+###Left Utility Buttons
+Utility buttons that become visible on the left side of the Table View Cell when the user swipes right. 
+
+<p align="center"><img src="http://i.imgur.com/qt6aISz.gif"/></p>
+
+## Features
+* Dynamic utility button scalling. As you add more buttons to a cell, the other buttons on that side get smaller to make room
+* Smart selection: The cell will pick up touch events and either scroll the cell back to center or fire the delegate method `- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath` 
+<p align="center"><img src="http://i.imgur.com/TYGx9h8.gif"/></p>
+So the cell will not be considered selected when the user touches the cell while utility buttons are visible, instead the cell will slide back into place (same as iOS 7 Mail App functionality)
+* Create utilty buttons with either a title or an icon along with a RGB color
+* Tested on iOS 6.1 and above, including iOS 7
+
+
+# Usage
+
+PMSwipeCells works by adding a custom cell class to your project and hooking into certain methods on PM::TableScreen. 
+
+To use, just add a few extra lines to the `table_data` hash in a PM:TableScreen. In each cell you'd like to be swipeable, specify the `cell_class:` as `SwipeableCell` and add a `properties:` hash which includes a `right_buttons` and/or `left_buttons` array.
+
+Each array takes up to 4 parameters, one of which is required:
+   
+- **Required**
+    + *action*: The action you want that button to perform, passed as a Symbol.
+        
+        * **Remember to also implement each action in your PM::TableScreen controller!**
+
+- **Recommended**
+    
+    + *color*: A UIColor for the button's background (defaults to UIColor.blueColor).
+    
+    + *title*: The text displayed on the button (defaults to the action name).
+
+- **Optional**
+    
+    + *arguments*: Arguments to be passed to the action. Use a hash if multiple.
+        
+        * **If no argument is set, but your cell action takes a single parameter, the cell will be passed to your action (see `remove` example)
+
+You can add only right buttons, only left_buttons or place buttons on both sides of a cell.
+
+# Example Code
+
+Here's an example of it in use:
+
+```ruby
+class TestScreen < PM::TableScreen
+# This example creates 25 cells, all with swipeable button.
+
+    def table_data
+        [{
+          cells: [*0..25].map do |test|
+            {
+              cell_class: SwipeableCell,
+              title: "Test Cell",
+              properties: {
+                right_buttons: [
+                  {
+                    title: "Share",
+                    action: :share,
+                    color: UIColor.greenColor
+                  }
+                ],
+                left_buttons: [
+                  {
+                    title: "Remove",
+                    action: :remove,
+                    color: UIColor.redColor
+                  },
+                  {
+                    title: "Archive",
+                    action: :archive,
+                    color: UIColor.blueColor,
+                    arguments:
+                      {
+                        foo: "bar!"
+                      }
+                  }
+                ]
+              }
+            }
+          end
+        }]
+    end
+
+
+  def share
+    NSLog "#{__method__.capitalize} button tapped!"
+  end
+
+  def remove(cell)
+    NSLog "#{__method__.capitalize} button tapped for cell #{cell}"
+  end
+
+  def archive(opts = {})
+    NSLog "#{__method__.capitalize} button tapped, with arguments #{opts}"
+  end
+
+end
+```
+
+
+
+# Additional Methods
+
+Cells of the SwipeableCell class have two additional methods available; `close` and `show_buttons(:side)`. While the touch interactions to show/hide swipe buttons are automatically enabled, I find it helpful to be able to programmatically reveal them. For example, it can be helpful to show a cell sliding open and closed alongside a tooltip or walkthrough the first time a user opens a screen.
+
+Calling `show_buttons`, which takes either `:left` or `:right` as an argument will slide the cell open, revealing the buttons on the specified side. As luck would have it, calling `close` on a cell will then slide it closed.
+
+# Additional Notes
+
+PMSwipeCell pre-configures your PM::TableScreen to act as the cell's delegate, however if you need to change this you can manually specific a delegate controller by passing the `delegate` arguments into the cell's `properties` hash. 
+    
+- **Note that changing this requires that you then implement the delegate actions and the cell actions in your delegate controller**
+
+You can add as many buttons to each side as you'd like, however after 3 buttons you're in danger of your cell sliding off the page. Keep to 2 or 3 buttons to be safe!
+
+### Cell Delegate Actions
+
+If you decide to use your own delegate controller, there are two delegate actions which need to be implemented depending on which side(s) you placed buttons on.
+
+```ruby
+    def swipeableTableViewCell(cell, didTriggerLeftUtilityButtonWithIndex: index)
+        NSLog "A Left button was pressed for cell #{cell}"
+        NSLog "The action which should be implemented is #{cell.left_buttons[index][:action]}"
+        NSLog "The accompanying arguments are #{cell.left_buttons[index][:arguments]}" unless cell.left_buttons[index][:arguments].nil?
+    end
+
+    def swipeableTableViewCell(cell, didTriggerRightUtilityButtonWithIndex: index)
+        NSLog "A RIGHT button was pressed for cell #{cell}"
+        NSLog "The action which should be implemented is #{cell.right_buttons[index][:action]}"
+        NSLog "The accompanying arguments are #{cell.right_buttons[index][:arguments]}" unless cell.right_buttons[index][:arguments].nil?
+    end
+```
+
+###Gotchas
+
+#### Seperator Insets
+* If you have left utility button on iOS 7, I recommend changing your Table View's seperatorInset so the seperator stretches the length of the screen
+<pre> tableView.separatorInset = UIEdgeInsetsMake(0, 0, 0, 0); </pre>

data/lib/pm_swipe_cells/pm_table_screen.rb

@@ -1,28 +1,32 @@
 module ProMotion
+
   class TableScreen < TableViewController
 
     def on_cell_created(cell, data)
       super
-      cell.setDelegate(self)
-      cell.config(right_cells: data[:properties][:right_cells], left_cells: data[:properties][:left_cells]) if cell.respond_to?(:config)
+
+      cell.setDelegate((data[:delegate].nil? ? self : data[:delegate])) if cell.respond_to?(:"setDelegate:")
+      if data[:properties]
+        cell.config(right_buttons: data[:properties][:right_buttons], left_buttons: data[:properties][:left_buttons]) if cell.respond_to?(:config)
+      end
     end
 
     def tableView(tableView, cellForRowAtIndexPath: indexPath)
       cell = super
-      cell.index_path = indexPath
+      cell.index_path = indexPath if cell.respond_to?(:index_path)
       cell
     end
 
     def swipeableTableViewCell(cell, didTriggerRightUtilityButtonWithIndex: index)
-      trigger_action(cell.right_cells[index][:action], cell.right_cells[index][:arguments], cell.index_path) if (cell.right_cells and cell.right_cells[index])
+      trigger_action(cell.right_buttons[index][:action], cell.right_buttons[index][:arguments], cell.index_path) if (cell.right_buttons and cell.right_buttons[index])
     end
 
 
-  def swipeableTableViewCell(cell, didTriggerLeftUtilityButtonWithIndex: index)
-     trigger_action(cell.left_cells[index][:action], cell.left_cells[index][:arguments], cell.index_path) if (cell.left_cells and cell.left_cells[index])
-  end
-
+    def swipeableTableViewCell(cell, didTriggerLeftUtilityButtonWithIndex: index)
+      trigger_action(cell.left_buttons[index][:action], cell.left_buttons[index][:arguments], cell.index_path) if (cell.left_buttons and cell.left_buttons[index])
+    end
 
   end
+
 end
 

data/lib/pm_swipe_cells/swipeable_cell.rb

@@ -1,47 +1,63 @@
 class SwipeableCell < SWTableViewCell
 
-  attr_accessor :left_cells, :right_cells, :index_path
+  attr_accessor :left_buttons, :right_buttons, :index_path
 
-   def add_right_cells(cells_to_add = {})
-    right_cells_array = Array.new
+
+   def add_right_buttons(cells_to_add = {})
+    @right_buttons_array = Array.new
     cells_to_add.each do |opts|
-      right_cells_array.sw_addUtilityButtonWithColor(opts[:color], title: opts[:title].to_s.capitalize)
+      opts[:title] ||= opts[:action].to_s
+      opts[:color] ||= UIColor.blueColor
+      @right_buttons_array.sw_addUtilityButtonWithColor(opts[:color], title: opts[:title].to_s.capitalize)
     end
-    right_cells_array
+    @right_buttons_array
   end
 
-  def add_left_cells(cells_to_add = {})
-    left_cells_array = Array.new
+  def add_left_buttons(cells_to_add = {})
+    @left_buttons_array = Array.new
     cells_to_add.each do |opts|
-      left_cells_array.sw_addUtilityButtonWithColor(opts[:color], title: opts[:title].to_s.capitalize)
+      opts[:title] ||= opts[:action].to_s
+      opts[:color] ||= UIColor.blueColor
+      @left_buttons_array.sw_addUtilityButtonWithColor(opts[:color], title: opts[:title].to_s.capitalize)
     end
-    left_cells_array
+    @left_buttons_array
   end
 
 
   def config(opts = {})
-    @right_cells = opts[:right_cells] if opts[:right_cells]
-    @left_cells = opts[:left_cells] if opts[:left_cells]
-     if @right_cells
-      self.rightUtilityButtons = add_right_cells(@right_cells)
+    @right_buttons = opts[:right_buttons] if opts[:right_buttons]
+    @left_buttons = opts[:left_buttons] if opts[:left_buttons]
+    [@right_buttons, @left_buttons].each {|x| add_index_path_argument(x) unless x.nil?}
+     if @right_buttons
+      self.rightUtilityButtons = add_right_buttons(@right_buttons)
     end
-    if @left_cells
-      self.leftUtilityButtons = add_left_cells(@left_cells)
+    if @left_buttons
+      self.leftUtilityButtons = add_left_buttons(@left_buttons)
     end
   end
 
+
   def close
     self.hideUtilityButtonsAnimated(true)
   end
 
 
   def show_buttons(side)
-    case side
-    when "right", :right
-      showRightUtilityButtonsAnimated(true)
-    when "left", :left
-       showLeftUtilityButtonsAnimated(true)
+    self.send("show#{side.to_s.capitalize}UtilityButtonsAnimated", true) if self.respond_to?("show#{side.to_s.capitalize}UtilityButtonsAnimated")
+  end
+
+
+private
+
+  def add_index_path_argument(buttons)
+    buttons.each do |x|
+      arity = self.delegate.method(x[:action]).arity
+      if arity == 1 and x[:arguments].nil?
+        x[:arguments] = self
+      end
     end
- end
+  end
+
+
 
 end

data/lib/pm_swipe_cells.rb

@@ -1,5 +1,5 @@
 unless defined?(Motion::Project::Config)
-  raise "This file must be required within a RubyMotion project Rakefile."
+  raise "pm_swipe_cells must be required within a RubyMotion project Rakefile."
 end
 
 require 'motion-cocoapods'
@@ -7,17 +7,20 @@ require 'motion-cocoapods'
 
 Motion::Project::App.setup do |app|
 
-# app.name = "pm_swipe_cells"
-
-  app.pods do
-    pod 'SWTableViewCell'
-  end
+  app.name = "pm_swipe_cells"
 
   # lib_dir_path = File.dirname(File.expand_path(__FILE__))
   # app.files.unshift(Dir.glob(File.join(lib_dir_path, "timestamps/**/*.rb")))
 
   Dir.glob(File.join(File.dirname(__FILE__), 'pm_swipe_cells/*.rb')).each do |file|
-    app.files.unshift(file)
+    # app.files.unshift(file)
+    app.files << file
   end
 
-end
+  app.pods do
+    pod 'SWTableViewCell', '~> 0.3.7'
+  end
+
+
+end
+

data/lib/version/version.rb

@@ -0,0 +1,3 @@
+module PMSwipeCell
+  VERSION = '0.0.3'
+end

metadata

@@ -1,26 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: pm_swipe_cells
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brian Egan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
-dependencies: []
-description: It's cool. I'll add more soon.
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ProMotion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: motion-cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: motion-stump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: motion-redgreen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: motion_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily add animated swipeable content view to ProMotion TableScreen cells
+  (using pod 'SWTableViewCells')
 email: brianegan@outlook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/pm_swipe_cells.rb
 - lib/pm_swipe_cells/pm_table_screen.rb
 - lib/pm_swipe_cells/swipeable_cell.rb
-- pm_swipe_cells-0.0.1.gem
-- pm_swipe_cells.gemspec
+- lib/version/version.rb
 homepage: https://github.com/Brian-Egan/pm_swipeable_cells
 licenses:
 - MIT
@@ -44,6 +129,6 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Easily add SWTableViewCells to Rubymotion - Promotion projects
+summary: Add customizable swipe actions to ProMotion table cells
 test_files: []
 has_rdoc: 

data/pm_swipe_cells.gemspec

@@ -1,14 +0,0 @@
-# -*- encoding: utf-8 -*-
-Gem::Specification.new do |gem|
-  gem.name        = "pm_swipe_cells"
-  gem.version     = '0.0.2'
-  gem.summary     = "Easily add SWTableViewCells to Rubymotion - Promotion projects"
-  gem.description = "It's cool. I'll add more soon."
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.require_paths = ["lib"]
-  gem.homepage    = "https://github.com/Brian-Egan/pm_swipeable_cells"
-  gem.authors     = ["Brian Egan"]
-  gem.email       = "brianegan@outlook.com"
-  gem.license     = "MIT"
-end