cocoapods-docstats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87c4bd82b1df485269337134a888ed01ba986bd4
+  data.tar.gz: 5bfaf03309849421df54d697f470a27bfcd65647
+SHA512:
+  metadata.gz: 19b28f197c4ebe40621f0dba361ab44cdafe156419c7ef81d014c1f21f183be22c2b445e742fd12491c14f4b64bf79fb181c5c126266821369fc50cbfc326f41
+  data.tar.gz: 7c4a1b213fb74f0dc35fd91dfb20230908c121c86d9b17a42d2fb0d1e46e7ba31f8b06a48088c2e69f445344b0bc52727c72bbb61757d5ec5137bfe8e5fb978a

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-docstats.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Boris Bügling <boris@icculus.org>
+
+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,12 @@
+# cocoapods-docstats
+
+CocoaPods plugin for showing documentation metrics of Pods.
+
+## Installation
+
+    $ gem install cocoapods-docstats
+
+## Usage
+
+    $ pod lib docstats
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cocoapods_docstats.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods_docstats.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cocoapods-docstats"
+  spec.version       = CocoapodsDocstats::VERSION
+  spec.authors       = ["Boris Bügling"]
+  spec.email         = ["boris@icculus.org"]
+  spec.description   = %q{CocoaPods plugin for showing documentation metrics of Pods.}
+  spec.summary       = %q{CocoaPods plugin for showing documentation metrics of Pods.}
+  spec.homepage      = "https://github.com/neonichu/cocoapods-docstats"
+  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_dependency "docstat"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/_utils.rb

@@ -0,0 +1,26 @@
+# allow logging of terminal commands
+
+def command command_to_run
+  puts " " + command_to_run.yellow if $log_all_terminal_commands
+  system command_to_run
+end
+
+# a nice puts
+
+def vputs text
+  puts text.green if $verbose
+end
+
+class Array
+  def listify
+    length < 2 ? first.to_s : "#{self[0..-2] * ', '} and #{last}"
+  end
+end
+
+module HashInit
+  def initialize(*h)
+    if h.length == 1 && h.first.kind_of?(Hash)
+      h.first.each { |k,v| send("#{k}=",v) }
+    end
+  end
+end

data/lib/cocoapods_docstats.rb

@@ -0,0 +1,3 @@
+module CocoapodsDocstats
+  VERSION = "0.0.1"
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,3 @@
+require 'spec_extensions'
+require '_utils'
+require 'pod/command/lib/docstats'

data/lib/pod/command/lib/docstats.rb

@@ -0,0 +1,109 @@
+module Pod
+  class Command
+    class Lib
+      class Docstats < Lib
+        self.summary = "Show documentation metrics of Pods."
+
+        self.description = <<-DESC
+          Show documentation metrics of Pods.
+        DESC
+
+        self.arguments = 'NAME'
+
+        def initialize(argv)
+          @output = './cocoapods-docstats/'
+          super
+        end
+
+        def docstat(docset_path)
+          require 'docstat'
+
+          stats  = DocStat.process(docset_path)
+          tokens = stats['containers'].map {|c| c['tokens']}.flatten
+          ratio  = stats['ratio']
+          puts "#{tokens.size} tokens, #{((ratio*1000).to_i/1000.0) * 100}% documented"
+        end
+
+        def generate_docset(path, spec)
+          headers = headers_for_spec_at_location(path, spec)
+          headers.map! { |header| Shellwords.escape header }
+
+          docset_command = [
+              "appledoc",
+              "--project-name #{spec.name}",                           # name in top left
+              "--project-company '#{spec.or_contributors_to_spec}'",   # name in top right
+              "--company-id com.cocoadocs.#{spec.name.downcase}",      # the id for the
+
+              "--project-version #{spec.version}",                      # project version
+              "--no-install-docset",                                    # don't make a duplicate
+
+              "--keep-intermediate-files",                              # space for now is OK
+              "--create-html",                                          # eh, nice to have
+              "--publish-docset",                                       # this should create atom
+
+              "--docset-feed-url http://www.cocoadocs.org/docsets/#{spec.name}/xcode-docset.atom",
+              "--docset-atom-filename xcode-docset.atom",
+
+              "--docset-package-url http://www.cocoadocs.org/docsets/#{spec.name}/docset.xar",
+              "--docset-package-filename docset",
+
+              "--docset-fallback-url http://www.cocoadocs.org/docsets/#{spec.name}",
+              "--docset-feed-name #{spec.name}",
+
+              # http://gentlebytes.com/appledoc-docs-examples-advanced/
+              "--keep-undocumented-objects",                         # not everyone will be documenting
+              "--keep-undocumented-members",                         # so we should at least show something
+              "--search-undocumented-doc",                           # uh? ( no idea what this does... )
+
+              "--output #{@output}",                                 # where should we throw stuff
+              *headers,
+              " >/dev/null"
+            ]
+
+            command docset_command.join(' ')
+        end
+
+        def headers_for_spec_at_location(path, spec)
+          pathlist = Pod::Sandbox::PathList.new( Pathname.new(path) )
+          headers = []
+
+          # https://github.com/CocoaPods/cocoadocs.org/issues/35
+          [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 }
+              else
+                puts "Skipping headers for #{internal_spec} on platform #{platform} (no headers found).".blue
+              end
+            end
+          end
+
+          headers.uniq
+        end
+
+        def podspecs_to_check
+          podspecs = Pathname.glob(Pathname.pwd + '*.podspec{.yaml,}')
+          raise Informative, "Unable to find a podspec in the working directory" if podspecs.count.zero?
+          podspecs
+        end
+
+        def run
+          podspecs_to_check.each do |path|
+            spec = Specification.from_file(path)
+
+            generate_docset(Dir.pwd, spec)
+
+            docset_path = File.join(@output, "com.cocoadocs.#{spec.name.downcase}." +
+                spec.name + '.docset')
+            docstat(docset_path)
+
+            FileUtils.rm_rf(@output)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec_extensions.rb

@@ -0,0 +1,39 @@
+module Pod
+    class Specification
+
+      def or_is_github?
+        self.homepage.include?("github.com") || (self.source[:git] && self.source[:git].include?("github.com"))
+      end
+
+      def or_git_ref
+        self.source[:tag] || self.source[:commit] || self.source[:branch] || 'master'
+      end
+
+      def or_user
+        return nil unless self.or_is_github?
+        self.homepage.split("/")[-2]
+      end
+
+      def or_repo
+        return nil unless self.or_is_github?
+        self.homepage.split("/")[-1]
+      end
+
+      def or_extensionless_homepage
+        return nil unless self.homepage
+        self.homepage.sub('http://', '').sub('https://', '').sub('www.', '').split("/")[0]
+      end
+
+      def or_contributors_to_spec
+        return self.authors if self.authors.is_a? String
+        return self.authors.listify if self.authors.is_a? Array
+        return self.authors.keys.listify if self.authors.is_a? Hash
+      end
+
+      def or_license
+        return self.license if self.license.is_a? String
+        return self.license[:type] if self.license.is_a? Hash
+        return "Unknown License"
+      end
+   end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-docstats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Boris Bügling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docstat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: CocoaPods plugin for showing documentation metrics of Pods.
+email:
+- boris@icculus.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cocoapods_docstats.gemspec
+- lib/_utils.rb
+- lib/cocoapods_docstats.rb
+- lib/cocoapods_plugin.rb
+- lib/pod/command/lib/docstats.rb
+- lib/spec_extensions.rb
+homepage: https://github.com/neonichu/cocoapods-docstats
+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 for showing documentation metrics of Pods.
+test_files: []