cocoapods-dylint 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b4658775ee818d70e6eaee8d34a8b44d0c3e667
-  data.tar.gz: e69e6ec2f4b3958d61fdc1b42d51ad96ecebe434
+  metadata.gz: f9c0a644e9cd0acc1f2d7b1a020e135d48ce895e
+  data.tar.gz: 5803803ba9c3ed40c1e64751d147c4d691ba6817
 SHA512:
-  metadata.gz: ccd5e484f3cc3481a339dcfebe58d87263e41906cdd674c9544d70709cb3dd933cc0e35ac5d79271ee096c99ff9aacbc8a03098a10a5f5239b91d0e1c6e05437
-  data.tar.gz: ded5dce255d40479ad8375b52baa554b33ad8f0cb51cb343e0d6492f2ca2f83ef0c576dfe32d7acc0ca69855a76a1e86cf9c795d4a9c2c12c90dbce8c0cc3bee
+  metadata.gz: fbe3ac62b834e9cf087eafbf1dcea50e5ab928315943fba504aeac2b1fea94a1ace3dc7386e7bd70b3c648f6349647caad46d4fc1ce1087ddcb3014d7daf7a46
+  data.tar.gz: ad97a1b31e62ea5c470ef0b8d78149d5b686e7f33d9e4a75a155e55fba6793b1a09fa2cb09559e68c0dc7e1f526e8db0e66d37e75160b6de75d0a1d09f179473

data/cocoapods-dylint.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = CocoapodsDylint::VERSION
   spec.authors       = ['黄露洋']
   spec.email         = ['huangluyang@douyu.tv']
-  spec.description   = %q{Validates a Pod without simulator.}
-  spec.summary       = %q{Validates the Pod using the files in the working directory without simulator.}
+  spec.description   = 'Validates a Pod without simulator.'
+  spec.summary       = 'Validates the Pod using the files in the working directory without simulator.'
   spec.homepage      = 'http://gitlab.douyuios.com/douyu-ios/cocoapods-dylint'
   spec.license       = 'MIT'
 

data/lib/pod/command.rb

@@ -1 +1,2 @@
 require 'pod/command/lib/dylint'
+require 'pod/command/repo/dypush'

data/lib/pod/command/lib/dylint.rb

@@ -1,4 +1,5 @@
-require File.expand_path('../validator.rb', __FILE__)
+# require File.expand_path('../validator.rb', __FILE__)
+require 'validator'
 module Pod
   class Command
     # This is an example of a cocoapods plugin adding a top-level subcommand

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

@@ -0,0 +1,291 @@
+# require File.expand_path('../../../../validator.rb', __FILE__)
+require 'validator'
+module Pod
+  class Command
+    # This is an example of a cocoapods plugin adding a top-level subcommand
+    # to the 'pod' command.
+    #
+    # You can also create subcommands of existing or new commands. Say you
+    # wanted to add a subcommand to `list` to show newly deprecated pods,
+    # (e.g. `pod list deprecated`), there are a few things that would need
+    # to change.
+    #
+    # - move this file to `lib/pod/command/list/deprecated.rb` and update
+    #   the class to exist in the the Pod::Command::List namespace
+    # - change this class to extend from `List` instead of `Command`. This
+    #   tells the plugin system that it is a subcommand of `list`.
+    # - edit `lib/cocoapods_plugins.rb` to require this file
+    #
+    # @todo Create a PR to add your plugin to CocoaPods/cocoapods.org
+    #       in the `plugins.json` file, once your plugin is released.
+    #
+    class Repo < Command
+      class Dypush < 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` (~/.cocoapods/repos/[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'],
+            ['--sources=https://github.com/artsy/Specs,master', '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', 'Push JSON spec to repo'],
+            ['--swift-version=VERSION', 'The SWIFT_VERSION that should be used when linting the spec. ' \
+             'This takes precedence over a .swift-version file.'],
+          ].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')
+          @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)
+          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_master_repo
+          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_master_repo
+          remotes = `git -C "#{repo_dir}" remote -v 2>&1`
+          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 = DyValidator.new(podspec, @source_urls)
+            validator.allow_warnings = @allow_warnings
+            validator.use_frameworks = @use_frameworks
+            validator.ignore_public_only_results = @private
+            validator.swift_version = @swift_version
+            validator.skip_import_validation = @skip_import_validation
+            validator.skip_tests = @skip_tests
+            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
+          clean = `git -C "#{repo_dir}" status --porcelain  2>&1` == ''
+          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
+          UI.puts `git -C "#{repo_dir}" pull 2>&1`
+        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
+            if @message && !@message.empty?
+              message = @message
+            elsif output_path.exist?
+              message = "[Fix] #{spec}"
+            elsif output_path.dirname.directory?
+              message = "[Update] #{spec}"
+            else
+              message = "[Add] #{spec}"
+            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('-C', repo_dir, 'push', 'origin', 'master')
+        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

data/lib/pod/gem_version.rb

@@ -1,3 +1,3 @@
 module CocoapodsDylint
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-dylint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - 黄露洋
@@ -55,8 +55,9 @@ files:
 - lib/cocoapods_plugin.rb
 - lib/pod/command.rb
 - lib/pod/command/lib/dylint.rb
-- lib/pod/command/lib/validator.rb
+- lib/pod/command/repo/dypush.rb
 - lib/pod/gem_version.rb
+- lib/validator.rb
 - spec/command/dylint_spec.rb
 - spec/spec_helper.rb
 homepage: http://gitlab.douyuios.com/douyu-ios/cocoapods-dylint