cocoapods-docs 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05423ae7d52969f139283286ce324cc79d2269a0
-  data.tar.gz: 3a801a439917cd5fc09810109baf6a28458c1b63
+  metadata.gz: 7383ab357a4da6f1044dd1e0a01d6f48ed1d6144
+  data.tar.gz: 5877668cbc1049d6ff34450eb101560baa4edef9
 SHA512:
-  metadata.gz: 87a479dd511875e020ad3f51ab3a2f354ea4bec8db96bb8aea5735392477427f8822f8207f6c4a81688cbe728ae88eaaad675eab462ccf7782a3ca6d5e10d541
-  data.tar.gz: 1407e4b99f2b3610f4539be3d88f8f76835170b2358a59910c1729995a8d3876561652ed2aa3b3c39754c7480d74fa34f4f1ba1c96efea7db7b090f18026fa76
+  metadata.gz: ec8684b1a2e85e86b574bd1ad86a818ffd95d782db2dbc0e01f78be2a7d17bf0baa84af8e76c800cbca3638b2744466dcbef275d78289c21f835d38fd3735626
+  data.tar.gz: 118385703e61b294b6d735666d77d2adcfc0fef308f0951fddc07362f4293e506c7cc351b47a31820033391d5c645c24ee35b7666b5761784216427cee182308

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+ - .rubocop_cocoapods.yml

data/.rubocop_cocoapods.yml

@@ -0,0 +1,89 @@
+AllCops:
+  Include:
+    - ./Rakefile
+    - ./Gemfile
+    - ./*.gemspec
+  Exclude:
+    - ./spec/fixtures/**/*
+
+# At the moment not ready to be used
+# https://github.com/bbatsov/rubocop/issues/947
+Documentation:
+  Enabled: false
+
+#- CocoaPods -----------------------------------------------------------------#
+
+# We adopted raise instead of fail.
+SignalException:
+  EnforcedStyle: only_raise
+
+# They are idiomatic
+AssignmentInCondition:
+  Enabled: false
+
+# Allow backticks
+AsciiComments:
+  Enabled: false
+
+# Indentation clarifies logic branches in implementations
+IfUnlessModifier:
+  Enabled: false
+
+# No enforced convention here.
+SingleLineBlockParams:
+  Enabled: false
+
+# We only add the comment when needed.
+Encoding:
+  Enabled: false
+
+# Having these make it easier to *not* forget to add one when adding a new
+# value and you can simply copy the previous line.
+TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+# Clashes with CLAide Command#validate!
+GuardClause:
+  Enabled: false
+
+# Not always desirable: lib/claide/command/plugins_helper.rb:12:15
+Next:
+  Enabled: false
+
+#- CocoaPods support for Ruby 1.8.7 ------------------------------------------#
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Lambda:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+EachWithObject:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+#- CocoaPods specs -----------------------------------------------------------#
+
+# Allow for `should.match /regexp/`.
+AmbiguousRegexpLiteral:
+  Exclude:
+    - spec/**/*
+
+# Allow `object.should == object` syntax.
+Void:
+  Exclude:
+    - spec/**/*
+
+ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*
+
+UselessComparison:
+  Exclude:
+    - spec/**/*
+

data/.travis.yml

@@ -0,0 +1,25 @@
+# Sets Travis to run the Ruby specs on OS X machines to be as close as possible
+# to the user environment.
+#
+language: objective-c
+addons:
+ code_climate:
+   repo_token: 568c9fe1160fda8ad6e7fdedd70851c5741045de9101633e60dc76d61b7e3d1d   
+
+env:
+  - RVM_RUBY_VERSION=system
+  # - RVM_RUBY_VERSION=1.8.7-p358
+
+before_install:
+  - export LANG=en_US.UTF-8
+  - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
+  - source ~/.rvm/scripts/rvm
+  - if [[ $RVM_RUBY_VERSION != 'system' ]]; then rvm install $RVM_RUBY_VERSION; fi
+  - rvm use $RVM_RUBY_VERSION
+  - if [[ $RVM_RUBY_VERSION == 'system' ]]; then sudo gem install bundler --no-ri --no-rdoc; else gem install bundler --no-ri --no-rdoc; fi
+
+
+install:
+  - sudo bundle install --without=documentation
+
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.2.0
+
+##### Enhancements
+
+* Adopted new argument format of CLAide.  
+[Fabio Pelosin](https://github.com/fabiopelosin)
+
+
+## 0.1.0
+
+* Initial release.

data/Gemfile

@@ -1,4 +1,33 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
-# Specify your gem's dependencies in cocoapods-docs.gemspec
 gemspec
+
+group :development do
+  gem 'cocoapods',      :git => "https://github.com/CocoaPods/CocoaPods.git", :branch => 'master'
+  gem 'cocoapods-core', :git => "https://github.com/CocoaPods/Core.git", :branch => 'master'
+  gem 'claide',         :git => 'https://github.com/CocoaPods/CLAide.git', :branch => 'master'
+
+  gem 'bacon'
+  gem 'mocha'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+  gem 'vcr'
+  gem 'webmock'
+
+  if RUBY_VERSION >= '1.9.3'
+    gem 'codeclimate-test-reporter', :require => nil
+    gem 'rubocop'
+  end
+end
+
+group :debugging do
+  gem 'awesome_print'
+  gem 'kicker'
+  gem 'pry'
+  gem 'rb-fsevent'
+end
+
+group :ruby_1_8_7 do
+  gem 'activesupport', '< 4'
+  gem 'mime-types', '< 2.0'
+end

data/README.md

@@ -1,5 +1,9 @@
 # Cocoapods::Docs
 
+[![Build Status](https://img.shields.io/travis/CocoaPods/cocoapods-docs/master.svg?style=flat)](https://travis-ci.org/CocoaPods/cocoapods-docs)
+[![Coverage](https://img.shields.io/codeclimate/coverage/github/CocoaPods/cocoapods-docs.svg?style=flat)](https://codeclimate.com/github/CocoaPods/cocoapods-docs)
+[![Code Climate](https://img.shields.io/codeclimate/github/CocoaPods/cocoapods-docs.svg?style=flat)](https://codeclimate.com/github/CocoaPods/cocoapods-docs)
+
 Simple gem which offers convenient access to the documentation of a Pod via
 cocoadocs.org.
 
@@ -9,4 +13,4 @@ cocoadocs.org.
 
 ## Usage
 
-    $ pod doc POD_NAME
+    $ pod spec doc POD_NAME

data/Rakefile

@@ -1 +1,69 @@
-require "bundler/gem_tasks"
+# encoding: utf-8
+
+#-- Bootstrap --------------------------------------------------------------#
+
+desc 'Initializes your working copy to run the specs'
+task :bootstrap do
+  if system('which bundle')
+    title 'Installing gems'
+    sh 'bundle install'
+  else
+    $stderr.puts "\033[0;31m" \
+      "[!] Please install the bundler gem manually:\n" \
+      '    $ [sudo] gem install bundler'
+      "\e[0m"
+    exit 1
+  end
+end
+
+begin
+  require "bundler/gem_tasks"
+  task :default => :spec
+
+  #-- Specs ------------------------------------------------------------------#
+
+  desc 'Runs all the specs'
+  task :spec do
+    title 'Running Unit Tests'
+    files = FileList['spec/**/*_spec.rb'].shuffle.join(' ')
+    sh "bundle exec bacon #{files}"
+
+    title 'Checking code style...'
+    Rake::Task['rubocop'].invoke if RUBY_VERSION >= '1.9.3'
+  end
+
+  #-- Kick -------------------------------------------------------------------#
+
+  desc 'Automatically run specs for updated files'
+  task :kick do
+    exec 'bundle exec kicker -c'
+  end
+
+  #-- RuboCop ----------------------------------------------------------------#
+
+  if RUBY_VERSION >= '1.9.3'
+    require 'rubocop/rake_task'
+    RuboCop::RakeTask.new
+  end
+
+rescue LoadError
+  $stderr.puts "\033[0;31m" \
+    '[!] Some Rake tasks haven been disabled because the environment' \
+    ' couldn’t be loaded. Be sure to run `rake bootstrap` first.' \
+    "\e[0m"
+  $stderr.puts e.message
+  $stderr.puts e.backtrace
+  $stderr.puts
+end
+
+#-- Helpers ------------------------------------------------------------------#
+
+def title(title)
+  cyan_title = "\033[0;36m#{title}\033[0m"
+  puts
+  puts '-' * 80
+  puts cyan_title
+  puts '-' * 80
+  puts
+end
+

data/lib/cocoapods_docs.rb

@@ -1,3 +1,3 @@
 module CocoapodsDocs
-  VERSION = "0.0.1"
+  VERSION = '0.2.0'
 end

data/lib/pod/command/spec/doc.rb

@@ -2,13 +2,15 @@ module Pod
   class Command
     class Spec
       class Doc < Spec
-        self.summary = "Opens the web documentation of a Pod."
+        self.summary = 'Opens the web documentation of a Pod.'
 
         self.description = <<-DESC
           Opens the web documentation of the Pod with the given NAME.
         DESC
 
-        self.arguments = 'NAME'
+        self.arguments = [
+          CLAide::Argument.new('NAME', true),
+        ]
 
         def initialize(argv)
           @name = argv.shift_argument
@@ -17,7 +19,7 @@ module Pod
 
         def validate!
           super
-          help! "A Pod name is required." unless @name
+          help! 'A Pod name is required.' unless @name
         end
 
         def run

data/spec/command/spec/doc_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Spec::Doc do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w(spec doc)).should.be.instance_of Command::Spec::Doc
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,59 @@
+# Set up coverage analysis
+#-----------------------------------------------------------------------------#
+
+if RUBY_VERSION >= '1.9.3'
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.configure do |config|
+    config.logger.level = Logger::WARN
+  end
+  CodeClimate::TestReporter.start
+end
+
+# Set up
+#-----------------------------------------------------------------------------#
+
+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'
+
+# Helpers
+#-----------------------------------------------------------------------------#
+
+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

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fabio Pelosin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2014-08-20 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: Simple gem which offers convenient access to the documentation of a Pod
@@ -46,7 +46,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_cocoapods.yml"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +59,8 @@ files:
 - lib/cocoapods_docs.rb
 - lib/cocoapods_plugin.rb
 - lib/pod/command/spec/doc.rb
+- spec/command/spec/doc_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/irrationalfab/cocoapods-docs
 licenses:
 - MIT
@@ -65,19 +71,22 @@ 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
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Simple gem which offers convenient access to the documentation of a Pod via
   cocoadocs.org.
-test_files: []
+test_files:
+- spec/command/spec/doc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: