cocoapods-keys 1.2.1 → 1.3.0

data/lib/keyring.rb

@@ -1,21 +1,21 @@
-require "osx_keychain"
+require 'osx_keychain'
 
 module CocoaPodsKeys
   class Keyring
     attr_accessor :keys, :path, :name
 
-    def initialize(name, path, keys=[])
-      @name = name
+    def initialize(name, path, keys = [])
+      @name = name.to_s
       @path = path
       @keys = keys
     end
 
     def self.from_hash(hash)
-      new(hash["name"], hash["path"], hash["keys"])
+      new(hash['name'], hash['path'], hash['keys'])
     end
 
     def to_hash
-      { "keys" => @keys, "path" => @path, "name" => @name }
+      { 'keys' => @keys, 'path' => @path, 'name' => @name }
     end
 
     def code_name
@@ -23,7 +23,7 @@ module CocoaPodsKeys
     end
 
     def self.keychain_prefix
-      "cocoapods-keys-"
+      'cocoapods-keys-'
     end
 
     def save(key, value)
@@ -37,6 +37,5 @@ module CocoaPodsKeys
         @keys.map { |key| [key, keychain[self.class.keychain_prefix + name, key]] }
       ]
     end
-
   end
 end

data/lib/keyring_liberator.rb

@@ -1,40 +1,39 @@
-require "digest"
-require "yaml"
-require "pathname"
+require 'digest'
+require 'yaml'
+require 'pathname'
 
 module CocoaPodsKeys
   class KeyringLiberator
-
     # Gets given a gives back a Keyring for the project
     # by basically parsing it out of ~/.cocoapods/keys/"pathMD5".yml
 
     def self.keys_dir
-       Pathname.new("~/.cocoapods/keys/").expand_path.to_s
+      Pathname('~/.cocoapods/keys/').expand_path
     end
 
     def self.yaml_path_for_path(path)
-      sha = Digest::MD5.hexdigest(path)
-      File.join(keys_dir, sha + '.yml')
+      sha = Digest::MD5.hexdigest(path.to_s)
+      keys_dir + (sha + '.yml')
     end
 
     def self.get_keyring(path)
       get_keyring_at_path(yaml_path_for_path(path))
     end
-    
+
     def self.get_keyring_named(name)
-      self.get_all_keyrings.find { |k| k.name == name }
+      get_all_keyrings.find { |k| k.name == name }
     end
 
     def self.save_keyring(keyring)
-      `mkdir -p #{keys_dir}`
+      keys_dir.mkpath
 
-      File.open(yaml_path_for_path(keyring.path), 'w') {|f| f.write(YAML::dump(keyring.to_hash)) }
+      yaml_path_for_path(keyring.path).open('w') { |f| f.write(YAML.dump(keyring.to_hash)) }
     end
 
     def self.get_all_keyrings
-      return [] unless Dir.exist? keys_dir
+      return [] unless keys_dir.directory?
       rings = []
-      Dir.glob(keys_dir + "/*.yml").each do |path|
+      Pathname.glob(keys_dir + '*.yml').each do |path|
         rings << get_keyring_at_path(path)
       end
       rings
@@ -43,8 +42,7 @@ module CocoaPodsKeys
     private
 
     def self.get_keyring_at_path(path)
-      Keyring.from_hash(YAML.load(File.read(path))) if File.exist?(path)
+      Keyring.from_hash(YAML.load(path.read)) if path.file?
     end
-
   end
 end

data/lib/name_whisperer.rb

@@ -1,44 +1,40 @@
 require 'cocoapods'
 
 module CocoaPodsKeys
-    class NameWhisperer
-
-      def self.get_project_name()
-        podfile = Pod::Podfile.from_file("Podfile") rescue nil
-        if podfile
-          user_xcodeproj = xcodeproj_from_podfile(podfile)
-        end
-        user_xcodeproj ||= self.search_folders_for_xcodeproj
-        user_xcodeproj.gsub(".xcodeproj", "")
+  class NameWhisperer
+    def self.get_project_name
+      podfile = Pod::Config.instance.podfile
+      if podfile
+        user_xcodeproj = xcodeproj_from_podfile(podfile)
       end
+      user_xcodeproj ||= search_folders_for_xcodeproj
+      user_xcodeproj.basename('.xcodeproj')
+    end
 
-    :private
+    private
 
-      def self.xcodeproj_from_podfile(podfile)
-        if podfile.target_definition_list.length > 0
-          return podfile.target_definition_list[0].user_project_path
-        end
-        nil
+    def self.xcodeproj_from_podfile(podfile)
+      unless podfile.target_definition_list.empty?
+        return podfile.target_definition_list.first.user_project_path
       end
+    end
 
-      def self.search_folders_for_xcodeproj
-        xcodeprojects = Dir.glob("**/**/*.xcodeproj")
-        if xcodeprojects.length == 1
-          Pathname.new(xcodeprojects[0]).basename.to_s
-        else
-          error_message = (xcodeprojects.length > 1) ? "found too many" : "couldn't find any"
-          puts "CocoaPods-Keys " + error_message + " Xcode projects. Please give a name for this project."
-
-          answer = ""
-          loop do
-            print " > "
-            answer = STDIN.gets.chomp
-            break if answer.length > 0
-          end
-          answer
-
+    def self.search_folders_for_xcodeproj
+      xcodeprojects = Pathname.glob('**/*.xcodeproj')
+      if xcodeprojects.length == 1
+        Pathname(xcodeprojects.first).basename
+      else
+        error_message = (xcodeprojects.length > 1) ? 'found too many' : "couldn't find any"
+        UI.puts 'CocoaPods-Keys ' + error_message + ' Xcode projects. Please give a name for this project.'
+
+        answer = ''
+        loop do
+          UI.print ' > '
+          answer = UI.gets.strip
+          break if answer.length > 0
         end
+        answer
       end
-
     end
+  end
 end

data/lib/plugin.rb

@@ -1,48 +1,65 @@
 require 'cocoapods-core'
+require 'fileutils'
+require 'active_support/core_ext/hash/indifferent_access'
 
 module CocoaPodsKeys
   class << self
+    include FileUtils
 
     def setup
       require 'preinstaller'
 
       PreInstaller.new(user_options).setup
-      
+
+      keys_path = Pod::Config.instance.installation_root + 'Pods/CocoaPodsKeys/'
+
       # move our podspec in to the Pods
-      `mkdir Pods/CocoaPodsKeys` unless Dir.exists? "Pods/CocoaPodsKeys"
-      podspec_path = File.join(__dir__, "../templates", "Keys.podspec.json")
-      `cp "#{podspec_path}" Pods/CocoaPodsKeys`
-      
+      mkdir_p keys_path
+      podspec_path = Pathname(__dir__) + '../templates' + 'Keys.podspec.json'
+      cp podspec_path, keys_path
+
       # Get all the keys
       local_user_options = user_options || {}
-      project = local_user_options.fetch("project") { CocoaPodsKeys::NameWhisperer.get_project_name }
-      keyring = KeyringLiberator.get_keyring_named(project) || KeyringLiberator.get_keyring(Dir.getwd)
-      raise Pod::Informative, "Could not load keyring" unless keyring
-  
+      project = local_user_options.fetch('project') { CocoaPodsKeys::NameWhisperer.get_project_name }
+      keyring = KeyringLiberator.get_keyring_named(project) || KeyringLiberator.get_keyring(Pathname.pwd)
+      raise Pod::Informative, 'Could not load keyring' unless keyring
+
       # Create the h & m files in the same folder as the podspec
       key_master = KeyMaster.new(keyring)
-      interface_file = File.join("Pods/CocoaPodsKeys", key_master.name + '.h')
-      implementation_file = File.join("Pods/CocoaPodsKeys", key_master.name + '.m')
-   
+      interface_file = keys_path + (key_master.name + '.h')
+      implementation_file = keys_path + (key_master.name + '.m')
+
       File.write(interface_file, key_master.interface)
       File.write(implementation_file, key_master.implementation)
-      
+
       # Add our template podspec
-      if user_options["target"]
-        # Support correct scoping for a target
-        target = podfile.root_target_definitions.map(&:children).flatten.find do |target|
-          target.label == "Pods-" + user_options["target"].to_s
-        end
-              
-        if target
-          target.store_pod 'Keys', :path => 'Pods/CocoaPodsKeys/'
-        else
-          puts "Could not find a target named '#{user_options["target"]}' in your Podfile. Stopping Keys.".red
+      add_keys_to_pods(keys_path, user_options)
+    end
+
+    def add_keys_to_pods(keys_path, options)
+      keys_targets = options['target'] || options['targets']
+
+      if keys_targets
+        # Get a list of targets, even if only one was specified
+        keys_target_list = ([] << keys_targets).flatten
+
+        # Iterate through each target specified in the Keys plugin
+        keys_target_list.each do |keys_target|
+          # Find a matching Pod target
+          pod_target = podfile.root_target_definitions.flat_map(&:children).find do |target|
+            target.label == "Pods-#{keys_target}"
+          end
+
+          if pod_target
+            pod_target.store_pod 'Keys', :path => keys_path.to_path
+          else
+            Pod::UI.puts "Could not find a target named '#{keys_target}' in your Podfile. Stopping keys".red
+          end
         end
 
       else
         # otherwise let it go in global
-        podfile.pod 'Keys', :path => 'Pods/CocoaPodsKeys/'
+        podfile.pod 'Keys', :path => keys_path.to_path
       end
     end
 
@@ -53,13 +70,10 @@ module CocoaPodsKeys
     end
 
     def user_options
-      options = podfile.plugins["cocoapods-keys"]
+      options = podfile.plugins['cocoapods-keys']
       # Until CocoaPods provides a HashWithIndifferentAccess, normalize the hash keys here.
       # See https://github.com/CocoaPods/CocoaPods/issues/3354
-      options.inject({}) do |normalized_hash, (key, value)|
-        normalized_hash[key.to_s] = value
-        normalized_hash
-      end
+      options.with_indifferent_access
     end
   end
 end
@@ -74,7 +88,7 @@ module Pod
     end
 
     def validates_for_keys
-      Pod::Config.instance.podfile.plugins["cocoapods-keys"] != nil
+      podfile && podfile.plugins && !podfile.plugins['cocoapods-keys'].nil?
     end
   end
 end

data/lib/pod/command/keys.rb

@@ -1,13 +1,12 @@
 module Pod
   class Command
-
     class Keys < Command
       require 'pod/command/keys/list'
       require 'pod/command/keys/set'
       require 'pod/command/keys/get'
       require 'pod/command/keys/rm'
 
-      self.summary = "A key value store for environment settings in Cocoa Apps."
+      self.summary = 'A key value store for environment settings in Cocoa Apps.'
 
       self.description = <<-DESC
         CocoaPods Keys will store sensitive data in your Mac's keychain. Then on running pod install they will be installed into your app's source code via the Pods library.
@@ -15,7 +14,6 @@ module Pod
 
       self.abstract_command = true
       self.default_subcommand = 'list'
-
     end
   end
 end

data/lib/pod/command/keys/get.rb

@@ -1,12 +1,11 @@
-require "keyring_liberator"
-require "name_whisperer"
+require 'keyring_liberator'
+require 'name_whisperer'
 
 module Pod
   class Command
     class Keys
-
       class Get < Keys
-        self.summary = "Print a values of a key."
+        self.summary = 'Print a values of a key.'
 
         self.description = <<-DESC
             Outputs the value of a key to SDTOUT
@@ -26,33 +25,31 @@ module Pod
         def validate!
           super
           verify_podfile_exists!
-          help! "A key name is required for lookup." unless @key_name
+          help! 'A key name is required for lookup.' unless @key_name
         end
 
         def run
           keyring = get_current_keyring
-          if !keyring
-            $stderr.puts "Could not find a project for this folder"
-            return
+          unless keyring
+            raise Informative, 'Could not find a project for this folder'
           end
 
           if keyring.keys.include? @key_name
             data = keyring.keychain_data
-            puts data[@key_name]
+            UI.puts data[@key_name]
           else
-            $stderr.puts "Could not find value"
+            raise Informative, 'Could not find value'
           end
         end
 
         def get_current_keyring
-          current_dir = Dir.getwd
+          current_dir = Pathname.pwd
           keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
           if !keyring && @project_name
             return CocoaPodsKeys::KeyringLiberator.get_keyring_named @project_name
           end
           keyring
         end
-
       end
     end
   end

data/lib/pod/command/keys/list.rb

@@ -3,9 +3,8 @@ require 'keyring_liberator'
 module Pod
   class Command
     class Keys
-
       class List < Keys
-        self.summary = "Lists all known keys and values."
+        self.summary = 'Lists all known keys and values.'
 
         self.description = <<-DESC
           Shows all the current keys and values for your current working directory.
@@ -14,41 +13,39 @@ module Pod
         DESC
 
         def run
-            # List all settings for current app
-            this_keyring = CocoaPodsKeys::KeyringLiberator.get_keyring(Dir.getwd)
-            if this_keyring
-              display_current_keyring this_keyring
-            end
-
-            # List all known bundle ids
-
-            all_keyrings = CocoaPodsKeys::KeyringLiberator.get_all_keyrings()
-            all_keyrings.each do |keyring|
-              display_keyring(keyring) if !this_keyring || keyring.path != this_keyring.path
-            end
+          # List all settings for current app
+          this_keyring = CocoaPodsKeys::KeyringLiberator.get_keyring(Pathname.pwd)
+          if this_keyring
+            display_current_keyring this_keyring
+          end
+
+          # List all known bundle ids
+
+          all_keyrings = CocoaPodsKeys::KeyringLiberator.get_all_keyrings
+          all_keyrings.each do |keyring|
+            display_keyring(keyring) if !this_keyring || keyring.path != this_keyring.path
+          end
         end
 
         def display_current_keyring(keyring)
-          puts "Keys for #{keyring.name}"
+          UI.puts "Keys for #{keyring.name}"
           data = keyring.keychain_data
           data.each_with_index do |(key, value), index|
-            prefix = (index == data.length - 1) ? " └ ": " ├ "
-            puts prefix + " #{key} - #{ value}"
+            prefix = (index == data.length - 1) ? ' └ ' : ' ├ '
+            UI.puts prefix + " #{key} - #{ value}"
           end
-          puts ""
+          UI.puts
         end
 
         def display_keyring(keyring)
-          puts "#{keyring.name} - #{keyring.path}"
+          UI.puts "#{keyring.name} - #{keyring.path}"
           if keyring.keys.length == 1
-            puts " └ " + keyring.keys[0]
+            UI.puts ' └ ' + keyring.keys[0]
           else
-            puts " └ " + keyring.keys[0...-1].join(" ") + " & " + keyring.keys[-1]
+            UI.puts ' └ ' + keyring.keys[0...-1].join(' ') + ' & ' + keyring.keys[-1]
           end
-          puts ""
+          UI.puts
         end
-
-        
       end
     end
   end

data/lib/pod/command/keys/rm.rb

@@ -1,13 +1,13 @@
-require "keyring_liberator"
-require "keyring"
-require "name_whisperer"
+require 'keyring_liberator'
+require 'keyring'
+require 'name_whisperer'
+require 'shellwords'
 
 module Pod
   class Command
     class Keys
-
       class Rm < Keys
-        self.summary = "Remove a key-value pair from a project."
+        self.summary = 'Remove a key-value pair from a project.'
 
         self.description = <<-DESC
             Remove a key, and it's value from a project
@@ -26,45 +26,44 @@ module Pod
         def validate!
           super
           verify_podfile_exists!
-          help! "A key name is required for lookup." unless @key_name
+          help! 'A key name is required for lookup.' unless @key_name
         end
 
         def run
           keyring = get_current_keyring
-          if !keyring
-            $stderr.puts "Could not find a project to remove the key from."
-            return
+          unless keyring
+            raise Informative, 'Could not find a project to remove the key from.'
           end
 
           if keyring.keys.include? @key_name
-            keyring.save(@key_name, "")
+            keyring.save(@key_name, '')
             keyring.keys.delete @key_name
             CocoaPodsKeys::KeyringLiberator.save_keyring(keyring)
 
             prefix = CocoaPodsKeys::Keyring.keychain_prefix
-            delete_generic = `security delete-generic-password -a #{@key_name} -l #{prefix+keyring.name} 2>&1`
+            login = prefix + keyring.name
+            delete_generic = `security delete-generic-password -a #{@key_name.shellescape} -l #{login.shellescape} 2>&1`
 
-            if delete_generic.include? "security: SecKeychainSearchCopyNext: The specified item could not be found in the keychain."
-              $stderr.puts "Removed value for #{@key_name}, but could not delete from Keychain."
-            elsif delete_generic.include? "password has been deleted."
-              $stderr.puts "Removed value for #{@key_name}, and deleted associated key in Keychain."
+            if delete_generic.include? 'security: SecKeychainSearchCopyNext: The specified item could not be found in the keychain.'
+              raise Informative, "Removed value for #{@key_name}, but could not delete from Keychain."
+            elsif delete_generic.include? 'password has been deleted.'
+              raise Informative, "Removed value for #{@key_name}, and deleted associated key in Keychain."
             else
-              $stderr.puts "Removed value for #{@key_name}."
+              raise Informative, "Removed value for #{@key_name}."
             end
           else
-            $stderr.puts "Could not find key named #{@key_name}."
+            raise Informative, "Could not find key named #{@key_name}."
           end
         end
 
         def get_current_keyring
-          current_dir = Dir.getwd
+          current_dir = Pathname.pwd
           keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
           if !keyring && @project_name
             return CocoaPodsKeys::KeyringLiberator.get_keyring_named @project_name
           end
           keyring
         end
-
       end
     end
   end