motion-imager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f6d2878f59fe01cecde3fbf9ad89433797a22d6
+  data.tar.gz: 4d2ab3633368bebf2ae9412a388fa0b229618bb5
+SHA512:
+  metadata.gz: 7e6387e8a8d39a8fa5c2efbed5c03d477ab9d4e3a00ca91fbce00cc54e6bc66ea2d2df7d4432c7ee4847970862497f769edaedf50b470d0bd1ddee1dd3bb623e
+  data.tar.gz: 2dbcc3f1d147930cdcef0013f4fb7d60ee3efcf3d26a82d607400fdcba331b2c1ff400143b28a9870671b92765e49955b2f444c89e92815fc67ec98ad344649b

data/README.md

@@ -0,0 +1,122 @@
+# motion-imager
+
+motion-imager is a RubyMotion DSL in top of [JTSImageViewController](https://github.com/jaredsinclair/JTSImageViewController) allowing you to easily create a "light-box" type view for users to view an image and interact with it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-imager'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-imager
+
+## Usage
+
+Using a UIImage:
+
+```ruby
+MotionImager.new({
+  image: UIImage.imageNamed('something'),
+  presenting_from: WeakRef.new(self),
+})
+```
+
+Using a URL:
+
+```ruby
+MotionImager.new({
+  # OR an instance of NSURL
+  url: 'https://www.google.com/images/srpr/logo11w.png',
+  placeholder: 'my_placeholder_image',
+  presenting_from: WeakRef.new(self),
+})
+
+```
+
+Showing a lightbox with text. This view is only text, no image.
+
+```ruby
+MotionImager.new({
+  presenting_from: WeakRef.new(self),
+  transition: :original,
+  mode: :alt_text,
+  text: "This is a cool image",
+})
+
+```
+
+Documentation for all available options:
+
+```ruby
+{
+  # A local image reference.
+  # Can also be a String that will be turned into a UIImage
+  # REQUIRED id not specifying `url`
+  image: UIImage.imageNamed('something'),
+
+  # A url can be any displayable image on iOS.
+  # Can also be an instance of NSURL
+  # REQUIRED if not specifying `image`
+  url: 'https://www.google.com/images/srpr/logo11w.png',
+  
+  # Placeholder image that will be displayed during the image download time.
+  # Can also be an instance of UIImage
+  # OPTIONAL
+  placeholder: 'my_placeholder.png',
+
+  # What view controller to show the lightbox from.
+  # REQUIRED. Should almost ALWAYS be `WeakRef.new(self)`
+  presenting_from: WeakRef.new(self),
+  
+  # Two image transitions are supported:
+  #  :original - displays the image zooming from it's original position on the screen
+  #  :off_screen - slides the image in from off screen.
+  # OPTIONAL. Defaults to `:original`
+  transition: :original,
+  
+  # Two modes are supported:
+  #  :image - only dislays the image
+  #  :alt_text - displays text instead of an image. Requires `text` to be set
+  # OPTIONAL. Defaults to `:image`
+  mode: :image,
+  
+  # Sets the text for the image when using mode: :alt_text.
+  # OPTIONAL
+  text: "Some Text",
+
+  # Sets the animation and style of the background while in lightbox mode
+  # Options supported are:
+  #  none:, scaled:, blurred:, scaled_blurred:
+  # OPTIONAL. Defaults to :scaled
+  background: :scaled_blurred,
+  
+  # The frame of the originating view on the screen.
+  # If set and in :original transition, the full-screen image
+  # will zoom from this location on the screen.
+  # OPTIONAL
+  rect: my_thumbnail.frame,
+  
+  # The the superview of the rect you set above.
+  # OPTIONAL
+  view: view
+}
+```
+
+## Roadmap
+
+1. Add convenience constructors like: `MotionImager.url({})`, `MotionImager.image({})`, and `MotionImager.text({})`
+2. Tests. :)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/motion-imager.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'motion-cocoapods'
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "motion-imager/**/*.rb")))
+
+  app.pods do
+    pod 'JTSImageViewController', '~> 1.4'
+  end
+end

data/lib/motion-imager/motion-imager.rb

@@ -0,0 +1,63 @@
+class MotionImager
+
+  def initialize(args={})
+    show(args)
+  end
+
+  def show(args={})
+    controller(args).showFromViewController(args[:presenting_from],
+      transition: transitions[args[:transition]] || JTSImageViewControllerTransition_FromOriginalPosition
+    )
+  end
+
+  def controller(args = {})
+    JTSImageViewController.alloc.initWithImageInfo(image_info(args),
+                 mode: modes[args[:mode]] || JTSImageViewControllerMode_Image,
+      backgroundStyle: backgrounds[args[:background]] || JTSImageViewControllerBackgroundStyle_Scaled
+    )
+  end
+
+  def image_info(args = {})
+    JTSImageInfo.new.tap do |i|
+      if args[:image]
+        args[:image] = UIImage.imageNamed(args[:image]) if args[:image].is_a?(String)
+        i.image = args[:image]
+      elsif args[:url]
+        args[:url] = NSURL.URLWithString(args[:url]) if args[:url].is_a?(String)
+        if args[:placeholder]
+          args[:placeholder] = UIImage.imageNamed(args[:placeholder]) if args[:placeholder].is_a?(String)
+          i.placeholderImage = args[:placeholder]
+        end
+        i.imageURL = args[:url]
+      end
+      i.altText = args[:text] if args[:text]
+      i.referenceRect = args[:rect] if args[:rect]
+      i.referenceView = args[:view] if args[:view]
+    end
+  end
+
+  def transitions
+    {
+      original: JTSImageViewControllerTransition_FromOriginalPosition,
+      off_screen: JTSImageViewControllerTransition_FromOffscreen
+    }
+  end
+
+  def modes
+    {
+      image: JTSImageViewControllerMode_Image,
+      alt_text: JTSImageViewControllerMode_AltText
+    }
+  end
+
+  def backgrounds
+    {
+      none: JTSImageViewControllerBackgroundOption_None,
+      scaled: JTSImageViewControllerBackgroundOption_Scaled,
+      blurred: JTSImageViewControllerBackgroundOption_Blurred,
+      scaled_blurred: JTSImageViewControllerBackgroundOption_Scaled | JTSImageViewControllerBackgroundOption_Blurred
+    }
+  end
+
+end
+

data/lib/motion-imager/version.rb

@@ -0,0 +1,3 @@
+module MotionImager
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: motion-imager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Rickert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: motion-cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.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'
+description: 'An interactive iOS image viewer that does it all: double tap to zoom,
+  flick to dismiss, et cetera.'
+email:
+- mjar81@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-imager.rb
+- lib/motion-imager/motion-imager.rb
+- lib/motion-imager/version.rb
+homepage: https://github.com/OTGApps/motion-imager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A RubyMotion DSL for JTSImageViewController, a "light box" for iOS. It's
+  similar to image viewers you may have seen in apps like Twitter, Tweetbot, and others.
+  It presents an image in a full-screen interactive view. Users can pan and zoom,
+  and use Tweetbot-style dynamic gestures to dismiss it with a fun flick.
+test_files: []