cocoapods-try 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59846a9b4b264d248b3179fbd131845ad5e8c105
+  data.tar.gz: fd0b200c55f3009cb0f4bd9d06d29122d0e8decb
+SHA512:
+  metadata.gz: c453c8f582e5680eadb629a994fae354718f7ecffa39ca9054a9f6aa30aa2ad690ffceb2af0bd6c4b466bea5e2ef61312f5d73b7eec6136cd7d0d9896f970ef9
+  data.tar.gz: 4aeb31d49f8005375f06b8826e0641ce94169e401bd33a8f9656a6f0dadfd832ba3cd10aba095c3b44364f325b4f55674278da1922d7df82ff0b4b2a633a2c65

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+language: objective-c
+env:
+  # This is what 10.8.x comes with and we want to support that.
+  - RVM_RUBY_VERSION=system NOEXEC_DISABLE=1 RUBY_VERSION_SPECIFIC='sudo gem install bundler --no-ri --no-rdoc' GIT_AUTHOR_NAME=CocoaPods GIT_AUTHOR_EMAIL=cocoapods@example.com PYTHONPATH=/usr/local/lib/python2.7/site-packages
+  - RVM_RUBY_VERSION=1.8.7-p358 NOEXEC_DISABLE=1 RUBY_VERSION_SPECIFIC='sudo ln -s /usr/bin/llvm-gcc-4.2 /usr/bin/gcc-4.2' SSL_CERT_FILE=/usr/local/share/cacert.pem GIT_AUTHOR_NAME=CocoaPods GIT_AUTHOR_EMAIL=cocoapods@example.com PYTHONPATH=/usr/local/lib/python2.7/site-packages
+before_install:
+  - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
+  - sh -c 'if [ "$RVM_RUBY_VERSION" != "system" ]; then rvm install $RVM_RUBY_VERSION --without-tcl --without-tk; fi'
+  - source ~/.rvm/scripts/rvm && rvm use $RVM_RUBY_VERSION
+install: eval $RUBY_VERSION_SPECIFIC && bundle install --path ./travis_bundle_dir
+script: bundle exec rake specs

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Cocoapods::Try Changelog
+
+## Master

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'cocoapods'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'mocha', '~> 0.11.4'
+  gem 'rake'
+  gem 'prettybacon', :git => 'https://github.com/irrationalfab/PrettyBacon.git', :branch => 'master'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 CocoaPods Dev Team
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,15 @@
+# Cocoapods try
+
+[![Build Status](https://travis-ci.org/CocoaPods/cocoapods-try.png?branch=master)](https://travis-ci.org/CocoaPods/cocoapods-try)
+
+CocoaPods plugin which allows to quickly try the demo project of a Pod.
+
+## Installation
+
+    $ git clone THIS_REPO_URL
+    $ cd THIS_REPO
+    $ rake install
+
+## Usage
+
+    $ pod try POD_NAME

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+def specs(dir)
+  FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+end
+
+desc "Runs all the specs"
+task :specs do
+  sh "bundle exec bacon #{specs('**')}"
+end
+
+task :default => :specs

data/cocoapods-docs.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods_try.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cocoapods-try"
+  spec.version       = CocoapodsTry::VERSION
+  spec.authors       = ["CocoaPods Dev Team"]
+  spec.summary       = %q{CocoaPods plugin which allows to quickly try the demo project of a Pod.}
+  spec.homepage      = "https://github.com/cocoapods/cocoapods-try"
+  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"
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1 @@
+require 'pod/command/try'

data/lib/cocoapods_try.rb

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

data/lib/pod/command/try.rb

@@ -0,0 +1,218 @@
+module Pod
+  class Command
+
+    # The pod try command.
+    #
+    class Try < Command
+      self.summary = "Try a Pod!"
+
+      self.description = <<-DESC
+          Donwloads the Pod with the given NAME and opens its project.
+      DESC
+
+      self.arguments = 'NAME'
+
+      def initialize(argv)
+        @name = argv.shift_argument
+        super
+      end
+
+      def validate!
+        super
+        help! "A Pod name is required." unless @name
+      end
+
+      def run
+        spec = spec_with_name(@name)
+        update_specs_repos
+        UI.title "Trying #{spec.name}" do
+          pod_dir = install_pod(spec, TRY_TMP_DIR)
+          proj = pick_demo_project(pod_dir)
+          file = install_podfile(proj)
+          if file
+            open_project(file)
+          else
+            UI.puts "Unable to locate a project for #{spec.name}"
+          end
+        end
+      end
+
+      public
+
+      # Helpers
+      #-----------------------------------------------------------------------#
+
+      # @return [Pathname]
+      #
+      TRY_TMP_DIR = Pathname.new('/tmp/CocoaPods/Try')
+
+      # Returns the specification of the last version of the Pod with the given
+      # name.
+      #
+      # @param  [String] name
+      #         The name of the pod.
+      #
+      # @return [Specification] The specification.
+      #
+      def spec_with_name(name)
+        set = SourcesManager.search(Dependency.new(name))
+        if set
+          set.specification.root
+        else
+          raise Informative, "Unable to find a specification for `#{name}`"
+        end
+      end
+
+      # Installs the specification in the given directory.
+      #
+      # @param  [Specification] The specification of the Pod.
+      # @param  [Pathname] The directory of the sandbox where to install the
+      #         Pod.
+      #
+      # @return [Pathname] The path where the Pod was installed
+      #
+      def install_pod(spec, dir)
+        sandbox = Sandbox.new(dir)
+        specs = { :ios => spec, :osx => spec }
+        installer = Installer::PodSourceInstaller.new(sandbox, specs)
+        installer.aggressive_cache = config.aggressive_cache?
+        installer.install!
+        TRY_TMP_DIR + spec.name
+      end
+
+      # Picks a project suitable for the demo purposes in the given directory.
+      # To decide the project simple heuristics are used according to the name,
+      # if no project is found this method raises and `Informative` otherwise
+      # if more than one project is found the choice is presented to the user.
+      #
+      # @param  [#to_s] dir
+      #         The path where to look for projects.
+      #
+      # @return [String] The path of the project.
+      #
+      def pick_demo_project(dir)
+        glob_match = Dir.glob("#{dir}/**/*.xcodeproj")
+        glob_match = glob_match.reject { |p| p.include?('Pods.xcodeproj') }
+        if glob_match.count == 0
+          raise Informative, "Unable to find any project in the source files" \
+            "of the Pod: `#{dir}`"
+        elsif glob_match.count == 1
+          glob_match.first
+        elsif (selection = filter_array(glob_match, "demo")).count == 1
+          selection.first
+        elsif (selection = filter_array(glob_match, "example")).count == 1
+          selection.first
+        else
+          message = "Which project would you like to open"
+          selection_array = glob_match.map do |p|
+            Pathname.new(p).relative_path_from(dir).to_s
+          end
+          index = choose_from_array(selection_array, message)
+          glob_match[index]
+        end
+      end
+
+      # Performs a CocoaPods installation for the given project if Podfile is found.
+      # Shells out to avoid issues with the config of the process running the
+      # try command.
+      #
+      # @return [String] proj
+      #         The path of the project.
+      #
+      # @return [String] The path of the file to open, in other words the
+      #         workspace of the installation or the given project.
+      #
+      def install_podfile(proj)
+        return unless proj
+        dirname = Pathname.new(proj).dirname
+        podfile = dirname + 'Podfile'
+        if podfile.exist?
+          Dir.chdir(dirname) do
+            perform_cocoapods_installation
+            proj.chomp(File.extname(proj.to_s)) + '.xcworkspace'
+          end
+        else
+          proj
+        end
+      end
+
+      public
+
+      # Private Helpers
+      #-----------------------------------------------------------------------#
+
+      # @return [void] Updates the specs repo unless disabled by the config.
+      #
+      def update_specs_repos
+        unless config.skip_repo_update?
+          UI.section 'Updating spec repositories' do
+            SourcesManager.update
+          end
+        end
+      end
+
+      # Opens the project at the given path.
+      #
+      # @return [String] path
+      #         The path of the project.
+      #
+      # @return [void]
+      #
+      def open_project(path)
+        UI.puts "Opening '#{path}'"
+        `open "#{path}"`
+      end
+
+      # Selects the entries in the given array which includes the given string
+      # (case insensitive check).
+      #
+      # @param  [Array] array
+      #         The array to filter.
+      #
+      # @param  [String] string
+      #         The string that should be used to filter the array.
+      #
+      # @return [Array] The selection.
+      #
+      def filter_array(array, string)
+        array.select { |p| p.downcase.include?(string.downcase) }
+      end
+
+      # Presents a choice among the elements of an array to the user.
+      #
+      # @param  [Array<#to_s>] array
+      #         The list of the elements among which the user should make his
+      #         choice.
+      #
+      # @param  [String] message
+      #         The message to display to the user.
+      #
+      # @return [Fixnum] The index of the chosen array item.
+      #
+      # @todo   This method was duplicated from the spec subcommands
+      #
+      def choose_from_array(array, message)
+        array.each_with_index do |item, index|
+          UI.puts "#{ index + 1 }: #{ item }"
+        end
+        UI.puts "#{message} [1-#{array.count}]?"
+        index = STDIN.gets.chomp.to_i - 1
+        if index < 0 || index > array.count
+          raise Informative, "#{ index + 1 } is invalid [1-#{array.count}]"
+        else
+          index
+        end
+      end
+
+      # @return [void] Performs a CocoaPods installation in the working
+      #         directory.
+      #
+      def perform_cocoapods_installation
+        UI.puts `pod install`
+      end
+
+      #-------------------------------------------------------------------#
+
+    end
+  end
+end

data/spec/command/try_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Try do
+
+    #-------------------------------------------------------------------------#
+
+    describe "CLAide" do
+      it "registers it self" do
+        Command.parse(%w{ try }).should.be.instance_of Command::Try
+      end
+
+      it "presents the help if no name is provided" do
+        command = Pod::Command.parse(['try'])
+        should.raise CLAide::Help do
+          command.validate!
+        end.message.should.match /A Pod name is required/
+      end
+
+      it "runs" do
+        Config.instance.skip_repo_update = false
+        command = Pod::Command.parse(['try', 'ARAnalytics'])
+        Installer::PodSourceInstaller.any_instance.expects(:install!)
+        command.expects(:update_specs_repos)
+        command.expects(:pick_demo_project).returns("/tmp/Proj.xcodeproj")
+        command.expects(:open_project).with('/tmp/Proj.xcodeproj')
+        command.run
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    describe "Helpers" do
+
+      before do
+        @sut = Pod::Command.parse(['try'])
+      end
+
+      it "returns the spec with the given name" do
+        spec = @sut.spec_with_name('ARAnalytics')
+        spec.name.should == "ARAnalytics"
+      end
+
+      it "installs the pod" do
+        Installer::PodSourceInstaller.any_instance.expects(:install!)
+        spec = stub(:name => 'ARAnalytics')
+        path = @sut.install_pod(spec, '/tmp/CocoaPods/Try')
+        path.should == Pathname.new("/tmp/CocoaPods/Try/ARAnalytics")
+      end
+
+      describe "#pick_demo_project" do
+        it "raises if no demo project could be found" do
+          projects = []
+          Dir.stubs(:glob).returns(projects)
+          should.raise Informative do
+            @sut.pick_demo_project(stub())
+          end.message.should.match /Unable to find any project/
+        end
+
+        it "picks a demo project" do
+          projects = ['Demo.xcodeproj']
+          Dir.stubs(:glob).returns(projects)
+          path = @sut.pick_demo_project(stub())
+          path.should == "Demo.xcodeproj"
+        end
+
+        it "is not case sensitive" do
+          projects = ['demo.xcodeproj']
+          Dir.stubs(:glob).returns(projects)
+          path = @sut.pick_demo_project(stub())
+          path.should == "demo.xcodeproj"
+        end
+
+        it "considers also projects named example" do
+          projects = ['Example.xcodeproj']
+          Dir.stubs(:glob).returns(projects)
+          path = @sut.pick_demo_project(stub())
+          path.should == "Example.xcodeproj"
+        end
+
+        it "returns the project if only one is found" do
+          projects = ['Lib.xcodeproj']
+          Dir.stubs(:glob).returns(projects)
+          path = @sut.pick_demo_project(stub())
+          path.should == "Lib.xcodeproj"
+        end
+
+        it "asks the user which project would like to open if not a single suitable one is found" do
+          projects = ['Lib_1.xcodeproj', 'Lib_2.xcodeproj']
+          Dir.stubs(:glob).returns(projects)
+          @sut.stubs(:choose_from_array).returns(0)
+          path = @sut.pick_demo_project(stub(:cleanpath=>''))
+          path.should == "Lib_1.xcodeproj"
+        end
+      end
+
+      describe "#install_podfile" do
+        it "returns the original project if no Podfile could be found" do
+          Pathname.any_instance.stubs(:exist?).returns(false)
+          proj = "/tmp/Project.xcodeproj"
+          path = @sut.install_podfile(proj)
+          path.should == proj
+        end
+
+        it "performs an installation and returns the path of the Podfile" do
+          Pathname.any_instance.stubs(:exist?).returns(true)
+          proj = "/tmp/Project.xcodeproj"
+          @sut.expects(:perform_cocoapods_installation)
+          path = @sut.install_podfile(proj)
+          path.should == "/tmp/Project.xcworkspace"
+        end
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'cocoapods'
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-try
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CocoaPods Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cocoapods-docs.gemspec
+- lib/cocoapods_plugin.rb
+- lib/cocoapods_try.rb
+- lib/pod/command/try.rb
+- spec/command/try_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cocoapods/cocoapods-try
+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.0.3
+signing_key: 
+specification_version: 4
+summary: CocoaPods plugin which allows to quickly try the demo project of a Pod.
+test_files:
+- spec/command/try_spec.rb
+- spec/spec_helper.rb