motional 0.1.0

data/lib/motional/library.rb

@@ -0,0 +1,32 @@
+# -*- encoding : utf-8 -*-
+
+module MotionAL
+  #
+  # A wrapper of ALAssetLibrary class.
+  #
+  #   An instance of ALAssetsLibrary provides access to the videos and photos that are under the control of the Photos application.
+  #   The library includes those that are in the Saved Photos album, those coming from iTunes, and those that were directly imported into the device. You use it to retrieve the list of all asset groups and to save images and videos into the Saved Photos album.
+  #
+  # And added some convinience methods.
+  #
+  class Library
+    # @return [Class] An alias of MotionAL::Group class
+    attr_reader :groups
+
+    # @return [MotionAL::Library] Singleton instance.
+    def self.instance
+      Dispatch.once { @@instance ||= new }
+      @@instance
+    end
+
+    def initialize 
+      @groups = MotionAL::Group
+    end
+
+    # An instance of ALAssetLibrary.
+    # @return [ALAssetsLibrary]
+    def al_asset_library
+      @al_asset_library ||= ALAssetsLibrary.new
+    end
+  end
+end

data/lib/motional/representation.rb

@@ -0,0 +1,101 @@
+# -*- encoding : utf-8 -*-
+
+module MotionAL
+  #
+  # A wrapper of ALRepresentation class.
+  #
+  #   An ALAssetRepresentation object encapsulates one of the representations of a given ALAsset object.
+  #   A given asset in the library may have more than one representation. For example, if a camera provides RAW and JPEG versions of an image, the resulting asset will have two representations—one for the RAW file and one for the JPEG file.
+  #
+  # And added some convinience methods.
+  #
+  class Representation
+    attr_reader :asset, :al_asset_representation
+    
+    # @param asset [MotionAL::Asset] A parent asset.
+    # @param al_asset_representation [ALAssetRepresentation] An instance of ALAssetRepresentation.
+    def initialize(asset, al_asset_representation)
+      @asset = asset
+      @al_asset_representation = al_asset_representation
+    end
+
+    # return a NSConcreteData(kind of NSData) object for the representation file.
+    #
+    # support only jpeg and png.
+    #
+    # @return [NSConcreteData]
+    def data
+      ui_image = UIImage.imageWithCGImage(self.cg_image)
+      if self.filename =~ /.jpe?g$/i
+        NSData.alloc.initWithData(UIImageJPEGRepresentation(ui_image, 0.0))
+      elsif self.filename =~ /.png$/i
+        NSData.alloc.initWithData(UIImagePNGRepresentation(ui_image))
+      else
+        nil
+      end
+    end
+
+    # @param options [Hash] described for CGImageSourceCreateWithData or CGImageSourceCreateWithURL.
+    # @return [CGImageRef] A full resolution CGImage of the representation.
+    def cg_image_with_options(options)
+      @al_asset_representation.CGImageWithOptions(options)
+    end
+
+    # The orientation of the representation.
+    #
+    # @return [Symbol] :up, :down :left, :right, :up_mirrored, :down_mirrored, :left_mirrored or :right_mirrored
+    #
+    # @see MotionAL.asset_orientations
+    def orientation
+      MotionAL.asset_orientations.key(@al_asset.valueForProperty(ALAssetPropertyOrientation))
+    end
+
+    # A CGImage of the representation.
+    #
+    # @return [CGImageRef] 
+    # @return [nil] When the representation has no CGImage.
+    def full_resolution_image
+      @al_asset_representation.fullResolutionImage
+    end
+    alias_method :cg_image, :full_resolution_image
+
+    # A CGImage of the representation that is appropriate for displaying full screen.
+    #
+    # @return [CGImageRef]
+    # @return [nil] When the representation has no CGImage.
+    def full_screen_image
+      @al_asset_representation.fullScreenImage
+    end
+
+    # Metadata of the representation.
+    #
+    # @return [Hash] A multidimensional hash.
+    # @return [nil] When the representation has no metadata or incompatible metadata.
+    def metadata
+      @al_asset_representation.metadata
+    end
+
+    class << self
+      private
+      # wrapper for method
+      # @!macro [attach] make_wrapper
+      #   The representation's $1
+      #
+      #   @method $1
+      #   @return [$2]
+      def make_wrapper_for_method(method_name, type_of_return)
+        define_method(method_name) do 
+          @al_asset_representation.send(method_name)
+        end
+      end
+    end
+
+    make_wrapper_for_method(:scale, "Float")
+    make_wrapper_for_method(:dimensions, "CGSize")
+    make_wrapper_for_method(:filename, "String")
+    make_wrapper_for_method(:size, "Fixnum")
+    make_wrapper_for_method(:url, "NSURL")
+    make_wrapper_for_method(:UTI, "String")
+    alias_method :name, :filename
+  end
+end

data/lib/motional/representations.rb

@@ -0,0 +1,55 @@
+# -*- encoding : utf-8 -*-
+
+module MotionAL
+  #
+  # A collection of representations. 
+  # Representations belongs to the asset.
+  #
+  class Representations
+    # @param asset [MotionAL::Asset]
+    def initialize(asset)
+      @asset = asset
+    end
+
+    # Find a representation by a specified representation UTI.
+    #
+    # @param representation_uti [String] A representation's UTI
+    # @return [nil]
+    #
+    # @yield [representation]
+    # @yieldparam representation [MotionAL::Representation] A found representation.
+    #
+    # @example
+    #   asset.representations.find_by_uti(representation_uti) do |rep|
+    #     p rep.filename
+    #   end
+    def find_by_uti(representation_uti, &block)
+      al_rep = @asset.al_asset.representationForUTI(representation_uti)
+      if al_rep
+        block.call(Representation.new(@asset, al_rep))
+      else
+        nil # not found
+      end
+    end
+
+    # Find and enumerate representations of the asset.
+    #
+    # @return [nil]
+    #
+    # @yield [representation]
+    # @yieldparam representation [MotionAL::Representation] A found representation.
+    #
+    # @example
+    #   asset.representations.find_all do |rep|
+    #     p rep.filename
+    #   end
+    def find_all(&block)
+      @asset.representation_utis.each do |uti|
+        find_by_uti(uti) do |rep|
+          block.call(rep)
+        end
+      end
+    end
+    alias_method :each, :find_all
+  end
+end

data/lib/motional/version.rb

@@ -0,0 +1,3 @@
+class MotionAL
+  VERSION = "0.1.0"
+end

data/motional.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'motional/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "motional"
+  spec.version       = MotionAL::VERSION
+  spec.authors       = ["akahigeg"]
+  spec.email         = ["akahigeg@gmail.com"]
+  spec.description   = %q{AssetLibrary framework wrapper for RubyMotion}
+  spec.summary       = %q{AssetLibrary framework wrapper for RubyMotion}
+  spec.homepage      = "https://github.com/akahigeg/motional"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "motion-redgreen"
+end

data/spec/motional/asset_spec.rb

@@ -0,0 +1,274 @@
+# -*- encoding : utf-8 -*-
+
+describe MotionAL::Asset do
+  before do
+    @library = MotionAL.library
+
+    MotionAL::Asset.find_all do |asset, error|
+      @existent_asset = asset if asset.asset_type == :photo && @existent_asset.nil?
+      @existent_video_asset = asset if asset.asset_type == :video && @existent_video_asset.nil?
+    end
+    wait_async(0.5)
+
+    @video_url = NSBundle.mainBundle.URLForResource('sample', withExtension:"mp4")
+
+    MotionAL::Group.find_all do |group, error|
+      @test_group = group if group.name == TEST_GROUP_NAME
+    end
+    wait_async
+
+    MotionAL::Group.find_camera_roll do |group, error|
+      @saved_photos = group
+    end
+    wait_async
+  end
+
+  shared "asset creation" do
+    it "should create new asset" do
+      @calling_create_method.should.change do
+        wait_async(0.5)
+        @saved_photos.assets.count(:all)
+      end
+    end
+  end
+
+  describe ".create" do
+    describe "when pass a CGImage with metadata" do
+      before do
+        @calling_create_method = Proc.new do
+          MotionAL::Asset.create(@existent_asset.full_resolution_image, @existent_asset.metadata)
+        end
+      end
+
+      behaves_like "asset creation"
+    end
+
+    describe "when pass a CGImage with orientation" do
+      before do
+        @calling_create_method = Proc.new do
+          MotionAL::Asset.create(@existent_asset.full_resolution_image, orientation: :up)
+        end
+      end
+
+      behaves_like "asset creation"
+    end
+
+    describe "when pass a NSData" do
+      before do
+        @calling_create_method = Proc.new do
+          MotionAL::Asset.create(@existent_asset.data, @existent_asset.metadata)
+        end
+      end
+
+      behaves_like "asset creation"
+    end
+
+    describe "when pass a video path" do
+      before do
+        @calling_create_method = Proc.new do
+          MotionAL::Asset.create(@video_url)
+        end
+      end
+
+      behaves_like "asset creation"
+    end
+  end
+
+  describe "#save_new" do
+    describe "when pass a NSData" do
+      before do
+        @calling_create_method = Proc.new do
+          @new_asset = nil
+          @existent_asset.save_new(@existent_asset.data, @existent_asset.metadata) {|a| @new_asset = a }
+          wait_async(0.5)
+        end
+      end
+
+      behaves_like "asset creation"
+
+      it "new asset have the 'original_asset'" do
+        @new_asset.original_asset.filename.should == @existent_asset.filename
+      end
+    end
+
+    describe "when pass a video path" do
+      before do
+        @calling_create_method = Proc.new do
+          @new_asset = @existent_video_asset.save_new(@video_url)
+        end
+      end
+
+      behaves_like "asset creation"
+    end
+  end
+
+  describe "#update" do
+    describe "when pass a NSData" do
+      before do
+        @calling_update_method = Proc.new do
+          @existent_asset.update(@existent_asset.data, @existent_asset.metadata)
+        end
+      end
+
+      it "should not create new asset" do
+        @calling_update_method.should.not.change do
+          @saved_photos.assets.count(:all)
+        end
+      end
+    end
+
+    describe "when pass a video path" do
+      before do
+        @calling_update_method = Proc.new do
+          @existent_video_asset.update(@video_url)
+        end
+      end
+
+      it "should not create new asset" do
+        @calling_update_method.should.not.change do
+          @saved_photos.assets.count(:all)
+        end
+      end
+    end
+  end
+
+  describe "#find_by_url" do
+    it "should find the Asset" do
+      asset = nil
+      MotionAL::Asset.find_by_url(@existent_asset.url) do |asset| 
+        asset = asset
+      end
+      wait_async
+
+      asset.should.instance_of MotionAL::Asset
+    end
+
+    it "should return nil when unknown url given" do
+      url = NSURL.URLWithString("http://hogehoge")
+      asset = nil
+      MotionAL::Asset.find_by_url(url) {|a| asset = a }
+      wait_async
+
+      asset.should.be.nil
+    end
+
+    it "should accept url string" do
+      asset = nil
+      MotionAL::Asset.find_by_url(@existent_asset.url.absoluteString) do |asset|
+        asset = asset
+      end
+      wait_async
+
+      asset.url.should.equal @existent_asset.url
+    end
+  end
+
+  describe "#all" do
+    it "should avail order asc" do
+      assets = []
+
+      MotionAL::Asset.find_all(order: :asc) {|a| assets << a }
+      wait_async
+
+      assets.size.should > 1
+      assets.first.url.should.equal @existent_asset.url
+    end
+
+    it "should avail order desc" do
+      assets = []
+
+      MotionAL::Asset.find_all(order: :desc) {|a| assets << a }
+      wait_async
+
+      assets.size.should > 1
+      assets.last.url.should.equal @existent_asset.url
+    end
+
+    it "should avail group option" do
+      assets_a = []
+      assets_b = []
+
+      MotionAL::Asset.find_all {|a| assets_a << a }
+      MotionAL::Asset.find_all(group: @test_group) {|a| assets_b << a }
+      wait_async
+
+      assets_a.size.should.equal @saved_photos.assets.count(:all)
+      assets_a.size.should.not.equal assets_b.size
+    end
+
+    it "should avail indexset option" do
+      indexset = NSMutableIndexSet.indexSetWithIndexesInRange(1..2)
+      assets = []
+
+      MotionAL::Asset.find_all(indexset: indexset) {|a| assets << a }
+      wait_async
+
+      assets.size.should.equal 2
+
+      # @saved_photos.assets[1].url.should.equal assets.first.url
+    end
+
+    it "should avail indexset option with order option" do
+      indexset = NSMutableIndexSet.indexSetWithIndexesInRange(1..3)
+      assets = []
+
+      MotionAL::Asset.find_all(indexset: indexset, order: :desc) {|a| assets << a }
+      wait_async
+
+      assets.size.should.equal 3
+
+      # @saved_photos.assets[1..3].reverse.first.url.should.equal assets.first.url
+    end
+
+    it "should avail filter option" do
+      assets = []
+      photos = []
+
+      MotionAL::Asset.find_all(filter: :all) {|a| assets << a }
+      MotionAL::Asset.find_all(filter: :photo) {|a| photos << a }
+      wait_async
+
+      assets.size.should.not.equal photos.size
+    end
+    # TODO: limit and offset option
+  end
+
+  describe "#editable?" do
+    it "asset is created by this App should be editable" do
+      @existent_asset.should.be.editable
+    end
+  end
+
+  describe "#representation" do
+    it "should be default representation" do
+      @existent_asset.representation.should == @existent_asset.default_representation
+    end
+  end
+
+  describe "#representations" do
+    it "should instance of Representations" do
+      @existent_asset.representations.should.instance_of MotionAL::Representations
+    end
+
+    it "should have Representation instance" do
+      @existent_asset.representations.find_all do |rep|
+        @rep = rep
+      end
+      @rep.should.instance_of MotionAL::Representation
+    end
+  end
+
+  describe "#asset_type" do
+    it "should be human readable" do
+      @existent_asset.asset_type.should.equal :photo
+    end
+  end
+
+  describe "#orientation" do
+    it "should be human readable" do
+      @existent_asset.orientation.should.equal :up
+    end
+  end
+
+  # TODO: what's happen when treat raw file
+end