cocoapods-appledoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2d851154165a0c464d427fcffa33daf7c65a9db
+  data.tar.gz: f20085f052c110ce9735c868dab8050b0080a428
+SHA512:
+  metadata.gz: 794c6de7cd804bfda512bd19b4c483cd3535f29cf08c0b11911db03d71c0fff49e2e370dd2830c2ecbd09b640e6e8df62ff9b6e313d151302db679e8fee1196f
+  data.tar.gz: 509cb92f67197d39187ba574e7317e8d813c9eee970e1e4ce88c9102f4d5ad567798a7b594d3c53f8df8345b3c98d6c2d752238bbf54438d52e46913692cdddf

data/.travis.yml

@@ -0,0 +1,10 @@
+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 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
+  - RVM_RUBY_VERSION=2.0.0-p247 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
+before_install:
+  - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
+  - source ~/.rvm/scripts/rvm && rvm use $RVM_RUBY_VERSION
+install: eval $RUBY_VERSION_SPECIFIC && rake bootstrap[use_bundle_dir]
+script: bundle exec rake specs

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GIT
+  remote: https://github.com/irrationalfab/PrettyBacon.git
+  revision: 1eeb06f7d381acd65414b86b42fdf3538faae01c
+  branch: master
+  specs:
+    prettybacon (0.0.2)
+      bacon (~> 1.2)
+
+PATH
+  remote: .
+  specs:
+    cocoapods-appledoc (0.1.0)
+      cocoapods (~> 0.34)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    bacon (1.2.0)
+    claide (0.7.0)
+    cocoapods (0.34.2)
+      activesupport (>= 3.2.15, < 4)
+      claide (~> 0.7.0)
+      cocoapods-core (= 0.34.2)
+      cocoapods-downloader (~> 0.7.2)
+      cocoapods-plugins (~> 0.3.1)
+      cocoapods-trunk (~> 0.3.0)
+      cocoapods-try (~> 0.4.1)
+      colored (~> 1.2)
+      escape (~> 0.0.4)
+      json_pure (~> 1.8)
+      nap (~> 0.8)
+      open4 (~> 1.3)
+      resolver (~> 0)
+      xcodeproj (~> 0.19.3)
+    cocoapods-core (0.34.2)
+      activesupport (>= 3.2.15)
+      fuzzy_match (~> 2.0.4)
+      json_pure (~> 1.8)
+      nap (~> 0.8.0)
+    cocoapods-downloader (0.7.2)
+    cocoapods-plugins (0.3.1)
+      nap
+    cocoapods-trunk (0.3.0)
+      json_pure (~> 1.8)
+      nap (>= 0.8)
+      netrc
+    cocoapods-try (0.4.1)
+    colored (1.2)
+    escape (0.0.4)
+    fuzzy_match (2.0.4)
+    i18n (0.6.11)
+    json_pure (1.8.1)
+    metaclass (0.0.4)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
+    mocha-on-bacon (0.2.1)
+      mocha (>= 0.9.8)
+    multi_json (1.10.1)
+    nap (0.8.0)
+    netrc (0.7.8)
+    open4 (1.3.4)
+    rake (10.3.2)
+    resolver (0.0.1)
+    xcodeproj (0.19.4)
+      activesupport (~> 3.0)
+      colored (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  bundler (~> 1.3)
+  cocoapods-appledoc!
+  mocha (~> 0.11.4)
+  mocha-on-bacon
+  prettybacon!
+  rake

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2013-2014 Orta Therox
+Copyright (c) 2014 Kyle Fuller
+
+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,22 @@
+# CocoaPods AppleDoc
+
+[![Build Status](https://travis-ci.org/CocoaPods/cocoapods-appledoc.png?branch=master)](https://travis-ci.org/CocoaPods/cocoapods-appledoc)
+
+CocoaPods plugin which allows you to generate documentation for a pod spec
+using AppleDoc.
+
+## Installation
+
+```bash
+$ gem install cocoapods-appledoc
+```
+
+## Usage
+
+```bash
+$ pod appledoc QueryKit
+
+Docset has been generated for QueryKit (0.8.3) and can be found in
+/Users/kylef/Desktop/QueryKit-0.8.3
+```
+

data/Rakefile

@@ -0,0 +1,13 @@
+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-appledoc.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods_appledoc.rb'
+
+Gem::Specification.new do |spec|
+  spec.name = 'cocoapods-appledoc'
+  spec.version = Pod::AppleDoc::VERSION
+  spec.authors = ['Orta Therox', 'Kyle Fuller']
+  spec.summary = 'CocoaPods plugin to build documentation for a pod.'
+  spec.homepage = 'https://github.com/CocoaPods/cocoapods-appledoc'
+  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_runtime_dependency 'cocoapods', '~> 0.34'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end
+

data/lib/cocoapods_appledoc.rb

@@ -0,0 +1,8 @@
+module Pod
+  module AppleDoc
+    VERSION = "0.1.0"
+
+    require 'pod/command/appledoc'
+  end
+end
+

data/lib/cocoapods_plugin.rb

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

data/lib/pod/command/appledoc.rb

@@ -0,0 +1,127 @@
+require 'shellwords'
+require 'cocoapods'
+
+module Pod
+  class Command
+    class Appledoc < Command
+      self.summary = 'Generate documentation for a pod using appledoc'
+      self.arguments = [
+        CLAide::Argument.new('NAME', false)
+      ]
+
+      def initialize(argv)
+        @name = argv.shift_argument
+        super
+      end
+
+      def validate!
+        super
+        help! "A spec name is required" unless @name
+        help! 'Please install appledoc first' if `which appledoc`.empty?
+      end
+
+      def download_location
+        File.join(APPLEDOC_DOWNLOAD_DIRECTORY, "#{@spec.name}-#{@spec.version}")
+      end
+
+      def download
+        downloader = Pod::Downloader.for_target(download_location, @spec.source)
+        downloader.download
+      end
+
+      def public_headers_files
+        headers = []
+
+        pathlist = Pod::Sandbox::PathList.new(Pathname.new(download_location))
+        [@spec, *@spec.recursive_subspecs].each do |internal_spec|
+          internal_spec.available_platforms.each do |platform|
+            consumer = Pod::Specification::Consumer.new(internal_spec, platform)
+            accessor = Pod::Sandbox::FileAccessor.new(pathlist, consumer)
+
+            if accessor.public_headers
+              headers += accessor.public_headers.map{ |filepath| filepath.to_s }
+            end
+          end
+        end
+
+        headers.uniq
+      end
+
+      def spec_authors
+        if @spec.authors.is_a?(Hash)
+          @spec.authors.keys.join(', ')
+        else
+          @spec.authors.to_s
+        end
+      end
+
+      def generate_docset
+        escaped_headers = public_headers_files.map do |header_file|
+          Shellwords.escape(header_file)
+        end
+
+        command = [
+          'appledoc',
+          "--company-id 'org.cocoadocs.#{@spec.name.downcase}'",
+          "--project-name '#{@spec.name}'",
+          "--project-company '#{spec_authors}'",
+          "--project-version '#{@spec.version}'",
+          '--keep-undocumented-objects',
+          '--keep-undocumented-members',
+          '--keep-intermediate-files',
+          '--no-install-docset', # Don't install the docset into Xcode
+          "--docset-feed-name #{@spec.name}",
+          "--docset-feed-url #{base_url}docsets/#{@spec.name}/xcode-docset.atom",
+          '--docset-package-filename docset',
+          "--docset-package-url #{base_url}docsets/#{@spec.name}/docset.xar",
+          '--create-html',
+          '--create-docset',
+          '--publish-docset',
+          "--output #{Shellwords.escape(output_location)}",
+          *escaped_headers
+        ]
+
+        system command.join(' ')
+      end
+
+      def output_location
+        File.join(Dir.pwd, "#{@spec.name}-#{@spec.version}")
+      end
+
+      def run
+        @spec = spec_with_path(@name) || spec_with_name(@name)
+
+        raise Informative, "Docset in #{output_location} already exists" if File.exist?(output_location)
+
+        download unless File.exist?(download_location)
+        generate_docset
+
+        UI.puts("Docset has been generated for #{@spec.name} (#{@spec.version}) and can be found in #{output_location}.".green)
+      end
+
+      def spec_with_path(path)
+        Spec.from_file(path)
+      rescue
+        nil
+      end
+
+      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
+
+      APPLEDOC_TMP_DIR = Pathname.new('/tmp/CocoaPods/AppleDoc')
+      APPLEDOC_DOWNLOAD_DIRECTORY = File.join(APPLEDOC_TMP_DIR, 'Sources')
+    end
+
+    def base_url
+      "http://cocoadocs.org/"
+    end
+  end
+end
+

data/spec/command/appledoc_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Spec::Appledoc do
+    describe "CLAide" do
+      it "registers it self" do
+        Command.parse(%w{ spec appledoc }).should.be.instance_of Command::Spec::Appledoc
+      end
+
+      it "presents the help if no spec is provided" do
+        command = Command.parse(%w{ spec appledoc })
+        should.raise CLAide::Help do
+          command.validate!
+        end.message.should.match /required/
+      end
+
+      it "errors if it cannot find a spec" do
+        SourcesManager.stubs(:search).returns(nil)
+        command = Command.parse(%w{ spec appledoc KFData })
+        should.raise Informative do
+          command.run
+        end.message.should.match /Unable to find a specification/
+      end
+
+      it "runs" do
+        command = Command.parse(%w{ spec appledoc KFData })
+        command.run
+      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,100 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-appledoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Orta Therox
+- Kyle Fuller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !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:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- cocoapods-appledoc.gemspec
+- lib/cocoapods_appledoc.rb
+- lib/cocoapods_plugin.rb
+- lib/pod/command/appledoc.rb
+- spec/command/appledoc_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CocoaPods/cocoapods-appledoc
+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.14
+signing_key: 
+specification_version: 4
+summary: CocoaPods plugin to build documentation for a pod.
+test_files:
+- spec/command/appledoc_spec.rb
+- spec/spec_helper.rb