cocoapods-publish 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0be0019880f934bef106db34384a5762f5b4426697ab70b559f1f89e1b45ed2b
+  data.tar.gz: 25c491ca2bd69963e2b1228857a81fd5e430c4649c33f548d34beff7ccb9f341
+SHA512:
+  metadata.gz: 445fef65083834d5ac291ffc858e18a7d9799c96a0d5a44280b43d95873c5595b77c17ffb1e27d58b219e37249b0b199bae050801367f51bc01bbd60bfd28617
+  data.tar.gz: '0191e9af3e1ea0953000e6a24fc8171e3d7bd44e793ca5c807e437aa4aac9e7377a1e30463bedde8708cb4221756a729f43fd67e67c69981fd91db2aaa22cbd6'

data/.github/workflows/gem-cd-gpr.yml

@@ -0,0 +1,29 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ stable ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GITHUB_TOKEN}}
+        OWNER: KassyLab

data/.github/workflows/gem-cd-rubygems.yml

@@ -0,0 +1,28 @@
+name: Continuous Deployment
+
+on:
+  push:
+    branches: [ stable ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/gem-ci.yml

@@ -0,0 +1,22 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches-ignore: [ stable ]
+  pull_request:
+    branches-ignore: [ stable ]
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Build
+      run: gem build *.gemspec

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Kassy Lab
+
+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 @@
+# cocoapods-publish

data/cocoapods_publish.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods_publish.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cocoapods-publish"
+  spec.version       = Pod::Publish::VERSION
+  spec.authors       = ["Damien DANGLARD"]
+  spec.email         = ["damien.danglard@kassylab.com"]
+  spec.summary       = %q{Publish a Podspec in a Specs repo without linting it ("pod repo push" without linting).}
+  spec.homepage      = "https://github.com/KassyLab/cocoapods-publish"
+  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/repo/publish'

data/lib/cocoapods_publish.rb

@@ -0,0 +1,5 @@
+module Pod
+  module Publish
+    VERSION = '1.0.0'
+  end
+end

data/lib/pod/command/repo/publish.rb

@@ -0,0 +1,291 @@
+require 'tempfile'
+require 'fileutils'
+require 'active_support/core_ext/string/inflections'
+
+module Pod
+  class Command
+    class Repo < Command
+      class Publish < Repo
+        self.summary = 'Push new specifications to a spec-repo'
+
+        self.description = <<-DESC
+        Validates `NAME.podspec` or `*.podspec` in the current working dir,
+        creates a directory and version folder for the pod in the local copy of
+        `REPO` (#{Config.instance.repos_dir}/[REPO]), copies the podspec file into the
+        version directory, and finally it pushes `REPO` to its remote.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('REPO', true),
+          CLAide::Argument.new('NAME.podspec', false),
+        ]
+
+        def self.options
+          [
+            ['--allow-warnings', 'Allows pushing even if there are warnings'],
+            ['--use-libraries', 'Linter uses static libraries to install the spec'],
+            ['--use-modular-headers', 'Lint uses modular headers during installation'],
+            ["--sources=#{Pod::TrunkSource::TRUNK_REPO_URL}", 'The sources from which to pull dependent pods ' \
+             '(defaults to all available repos). Multiple sources must be comma-delimited'],
+            ['--local-only', 'Does not perform the step of pushing REPO to its remote'],
+            ['--no-private', 'Lint includes checks that apply only to public repos'],
+            ['--skip-import-validation', 'Lint skips validating that the pod can be imported'],
+            ['--skip-tests', 'Lint skips building and running tests during validation'],
+            ['--commit-message="Fix bug in pod"', 'Add custom commit message. Opens default editor if no commit ' \
+              'message is specified'],
+            ['--use-json', 'Convert the podspec to JSON before pushing it to the repo'],
+            ['--swift-version=VERSION', 'The `SWIFT_VERSION` that should be used when linting the spec. ' \
+             'This takes precedence over the Swift versions specified by the spec or a `.swift-version` file'],
+            ['--no-overwrite', 'Disallow pushing that would overwrite an existing spec'],
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          @allow_warnings = argv.flag?('allow-warnings')
+          @local_only = argv.flag?('local-only')
+          @repo = argv.shift_argument
+          @source = source_for_repo
+          @source_urls = argv.option('sources', config.sources_manager.all.map(&:url).join(',')).split(',')
+          @podspec = argv.shift_argument
+          @use_frameworks = !argv.flag?('use-libraries')
+          @use_modular_headers = argv.flag?('use-modular-headers', false)
+          @private = argv.flag?('private', true)
+          @message = argv.option('commit-message')
+          @commit_message = argv.flag?('commit-message', false)
+          @use_json = argv.flag?('use-json')
+          @swift_version = argv.option('swift-version', nil)
+          @skip_import_validation = argv.flag?('skip-import-validation', false)
+          @skip_tests = argv.flag?('skip-tests', false)
+          @allow_overwrite = argv.flag?('overwrite', true)
+          super
+        end
+
+        def validate!
+          super
+          help! 'A spec-repo name or url is required.' unless @repo
+          unless @source && @source.repo.directory?
+            raise Informative,
+                  "Unable to find the `#{@repo}` repo. " \
+                  'If it has not yet been cloned, add it via `pod repo add`.'
+          end
+        end
+
+        def run
+          open_editor if @commit_message && @message.nil?
+          check_if_push_allowed
+          validate_podspec_files
+          check_repo_status
+          update_repo
+          add_specs_to_repo
+          push_repo unless @local_only
+        end
+
+        #---------------------------------------------------------------------#
+
+        private
+
+        # @!group Push sub-steps
+
+        extend Executable
+        executable :git
+
+        # Open default editor to allow users to enter commit message
+        #
+        def open_editor
+          return if ENV['EDITOR'].nil?
+
+          file = Tempfile.new('cocoapods')
+          File.chmod(0777, file.path)
+          file.close
+
+          system("#{ENV['EDITOR']} #{file.path}")
+          @message = File.read file.path
+        end
+
+        # Temporary check to ensure that users do not push accidentally private
+        # specs to the master repo.
+        #
+        def check_if_push_allowed
+          if @source.is_a?(CDNSource)
+            raise Informative, 'Cannot push to a CDN source, as it is read-only.'
+          end
+
+          remotes, = Executable.capture_command('git', %w(remote --verbose), :capture => :merge, :chdir => repo_dir)
+          master_repo_urls = [
+            'git@github.com:CocoaPods/Specs.git',
+            'https://github.com/CocoaPods/Specs.git',
+          ]
+          is_master_repo = master_repo_urls.any? do |url|
+            remotes.include?(url)
+          end
+
+          if is_master_repo
+            raise Informative, 'To push to the CocoaPods master repo use ' \
+              "the `pod trunk push` command.\n\nIf you are using a fork of " \
+              'the master repo for private purposes we recommend to migrate ' \
+              'to a clean private repo. To disable this check remove the ' \
+              'remote pointing to the CocoaPods master repo.'
+          end
+        end
+
+        # Performs a full lint against the podspecs.
+        #
+        def validate_podspec_files
+          UI.puts "\nValidating #{'spec'.pluralize(count)}".yellow
+          podspec_files.each do |podspec|
+            validator = Validator.new(podspec, @source_urls)
+            validator.allow_warnings = @allow_warnings
+            validator.use_frameworks = @use_frameworks
+            validator.use_modular_headers = @use_modular_headers
+            validator.ignore_public_only_results = @private
+            validator.swift_version = @swift_version
+            validator.skip_import_validation = @skip_import_validation
+            validator.skip_tests = @skip_tests
+            validator.quick = true
+            begin
+              validator.validate
+            rescue => e
+              raise Informative, "The `#{podspec}` specification does not validate." \
+                                 "\n\n#{e.message}"
+            end
+            raise Informative, "The `#{podspec}` specification does not validate." unless validator.validated?
+          end
+        end
+
+        # Checks that the repo is clean.
+        #
+        # @raise  If the repo is not clean.
+        #
+        # @todo   Add specs for staged and unstaged files.
+        #
+        # @todo   Gracefully handle the case where source is not under git
+        #         source control.
+        #
+        # @return [void]
+        #
+        def check_repo_status
+          porcelain_status, = Executable.capture_command('git', %w(status --porcelain), :capture => :merge, :chdir => repo_dir)
+          clean = porcelain_status == ''
+          raise Informative, "The repo `#{@repo}` at #{UI.path repo_dir} is not clean" unless clean
+        end
+
+        # Updates the git repo against the remote.
+        #
+        # @return [void]
+        #
+        def update_repo
+          UI.puts "Updating the `#{@repo}' repo\n".yellow
+          git!(%W(-C #{repo_dir} pull))
+        end
+
+        # Commits the podspecs to the source, which should be a git repo.
+        #
+        # @note   The pre commit hook of the repo is skipped as the podspecs have
+        #         already been linted.
+        #
+        # @return [void]
+        #
+        def add_specs_to_repo
+          UI.puts "\nAdding the #{'spec'.pluralize(count)} to the `#{@repo}' repo\n".yellow
+          podspec_files.each do |spec_file|
+            spec = Pod::Specification.from_file(spec_file)
+            output_path = @source.pod_path(spec.name) + spec.version.to_s
+            message = if @message && !@message.empty?
+                        @message
+                      elsif output_path.exist?
+                        "[Fix] #{spec}"
+                      elsif output_path.dirname.directory?
+                        "[Update] #{spec}"
+                      else
+                        "[Add] #{spec}"
+                      end
+
+            if output_path.exist? && !@allow_overwrite
+              raise Informative, "#{spec} already exists and overwriting has been disabled."
+            end
+
+            FileUtils.mkdir_p(output_path)
+
+            if @use_json
+              json_file_name = "#{spec.name}.podspec.json"
+              json_file = File.join(output_path, json_file_name)
+              File.open(json_file, 'w') { |file| file.write(spec.to_pretty_json) }
+            else
+              FileUtils.cp(spec_file, output_path)
+            end
+
+            # only commit if modified
+            if repo_git('status', '--porcelain').include?(spec.name)
+              UI.puts " - #{message}"
+              repo_git('add', spec.name)
+              repo_git('commit', '--no-verify', '-m', message)
+            else
+              UI.puts " - [No change] #{spec}"
+            end
+          end
+        end
+
+        # Pushes the git repo against the remote.
+        #
+        # @return [void]
+        #
+        def push_repo
+          UI.puts "\nPushing the `#{@repo}' repo\n".yellow
+          repo_git('push', 'origin', 'HEAD')
+        end
+
+        #---------------------------------------------------------------------#
+
+        private
+
+        # @!group Private helpers
+
+        # @return result of calling the git! with args in repo_dir
+        #
+        def repo_git(*args)
+          git!(['-C', repo_dir] + args)
+        end
+
+        # @return [Pathname] The directory of the repository.
+        #
+        def repo_dir
+          @source.specs_dir
+        end
+
+        # @return [Array<Pathname>] The path of the specifications to push.
+        #
+        def podspec_files
+          if @podspec
+            path = Pathname(@podspec)
+            raise Informative, "Couldn't find #{@podspec}" unless path.exist?
+            [path]
+          else
+            files = Pathname.glob('*.podspec{,.json}')
+            raise Informative, "Couldn't find any podspec files in current directory" if files.empty?
+            files
+          end
+        end
+
+        # @return [Integer] The number of the podspec files to push.
+        #
+        def count
+          podspec_files.count
+        end
+
+        # Returns source for @repo
+        #
+        # @note If URL is invalid or repo doesn't exist, validate! will throw the error
+        #
+        # @return [Source]
+        #
+        def source_for_repo
+          config.sources_manager.source_with_name_or_url(@repo) unless @repo.nil?
+        rescue
+          nil
+        end
+
+        #---------------------------------------------------------------------#
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-publish
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Damien DANGLARD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-15 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:
+- damien.danglard@kassylab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-cd-gpr.yml"
+- ".github/workflows/gem-cd-rubygems.yml"
+- ".github/workflows/gem-ci.yml"
+- ".gitignore"
+- LICENSE
+- README.md
+- cocoapods_publish.gemspec
+- lib/cocoapods_plugin.rb
+- lib/cocoapods_publish.rb
+- lib/pod/command/repo/publish.rb
+homepage: https://github.com/KassyLab/cocoapods-publish
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Publish a Podspec in a Specs repo without linting it ("pod repo push" without
+  linting).
+test_files: []