cocoapods-keys 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46fd2317903ff6b9b6d9117c6ba834e9ae6efe98
-  data.tar.gz: d8e127fdf8ab65eb8b446a011de5135db2057682
+  metadata.gz: 18be4c87abf2316d890e3cf029d415c0698c9f3e
+  data.tar.gz: 9f00ae2e7edfda4d6241d2902796fa14fbd18be0
 SHA512:
-  metadata.gz: fb52c1999ca9a2237615dd19fcd637535f8ccc26c0dc717625decb5cc5003adc39dbf46d19cdc65c4fc64f27f3272b6ea667615139b366d2e66fbd2c1205de46
-  data.tar.gz: e9b6925e32bf7ea4a19ad1c63ab51d29da2b89e94ff8860d47aaa253037658a6e83d64002dc8cfc4e25ea981c9d61c60debdb403334af404048bcae793003e4b
+  metadata.gz: b2e54f948ebe951f8258552859840c46be4894ddc84884b09d9931aac5da9ebc68d3adfe604c997da9a4fd325650c18f3fe29cde7b8a41400de4c53f2ab07837
+  data.tar.gz: ca51a2f69df3d96ef32acbf8899d81a2467686edc344b4141ee53942749693a96dfa9e0b561cd8019d7a8afd83b3400d22afd618607f127dcf0db6a408c148a6

data/.travis.yml

@@ -0,0 +1,3 @@
+language: objective-c
+install: bundle install --deployment
+script: bundle exec rake spec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocoapods-keys (1.0.2)
+    cocoapods-keys (1.1.0)
       osx_keychain
 
 GEM
@@ -10,9 +10,23 @@ GEM
     RubyInline (3.12.3)
       ZenTest (~> 4.3)
     ZenTest (4.11.0)
+    diff-lcs (1.2.5)
     osx_keychain (1.0.0)
       RubyInline (~> 3)
     rake (10.3.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
 
 PLATFORMS
   ruby
@@ -21,3 +35,4 @@ DEPENDENCIES
   bundler (~> 1.3)
   cocoapods-keys!
   rake
+  rspec

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cocoapods_keys.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "osx_keychain"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/cocoapods_keys.rb

@@ -1,3 +1,3 @@
 module CocoaPodsKeys
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/key_master.rb

@@ -1,11 +1,14 @@
 require 'set'
+require 'erb'
+require 'digest'
 
 module CocoaPodsKeys
   class KeyMaster
 
     attr_accessor :name, :interface, :implementation
 
-    def initialize(keyring)
+    def initialize(keyring, time=Time.now)
+      @time = time
       @keys = Hash[keyring.keychain_data.map { |(key, value)| [key[0].downcase + key[1..-1], value] }]
       @name = keyring.code_name + 'Keys'
       @used_indexes = Set.new
@@ -56,103 +59,17 @@ module CocoaPodsKeys
     end
 
     def generate_interface
-      erb = <<-SOURCE
-//
-// Generated by CocoaPods-Keys
-// on #{Time.now.strftime("%d/%m/%Y")}
-// For more information see https://github.com/cocoapods/cocoapods-keys
-//
-
-#import <Foundation/NSString.h>
-
-@interface <%= @name %> : NSObject
-<% @keys.each do |key, value| %>
-- (NSString *)<%= key %>;<% end %>
-
-@end
-SOURCE
-
-      render_erb(erb)
+      render_erb("Keys.h.erb")
     end
 
     def generate_implementation
-      require 'digest'
-
-      erb = <<-SOURCE
-//
-// Generated by CocoaPods-Keys
-// on #{Time.now.strftime("%d/%m/%Y")}
-// For more information see https://github.com/cocoapods/cocoapods-keys
-//
-
-#import <objc/runtime.h>
-#import <Foundation/NSDictionary.h>
-#import "<%= @name %>.h"
-
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wincomplete-implementation"
-
-@implementation <%= @name %>
-
-#pragma clang diagnostic pop
-
-+ (BOOL)resolveInstanceMethod:(SEL)name
-{
-  NSString *key = NSStringFromSelector(name);
-  NSString * (*implementation)(<%= name %> *, SEL) = NULL;
-<% @keys.each do |key, value| %>
-  if ([key isEqualToString:@"<%= key %>"]) {
-    implementation = _podKeys<%= Digest::MD5.hexdigest(key) %>;
-  }
-<% end %>
-  if (!implementation) {
-    return [super resolveInstanceMethod:name];
-  }
-
-  return class_addMethod([self class], name, (IMP)implementation, "@@:");
-}
-<% @keys.each do |key, value| %>
-static NSString *_podKeys<%= Digest::MD5.hexdigest(key) %>(<%= name %> *self, SEL _cmd)
-{
-  <% if @indexed_keys.length > 0 %>
-    <% if @indexed_keys[key].length > 0 %>
-      char cString[<%= @indexed_keys[key].length + 1 %>] = { <%= key_data_arrays[key] %>, '\\0' };
-    <% else %>
-      char cString[1] = { '\\0' };
-    <% end %>
-    return [NSString stringWithCString:cString encoding:NSUTF8StringEncoding];
-  <% else %>
-    return @"";
-  <% end %>
-}
-<% end %>
-
-static char <%= name %>Data[<%= @data_length %>] = "<%= @data %>";
-
-- (NSString *)description
-{
-  return [@{
-<%- @keys.each do |key, value| -%>
-            @"<%= key %>": self.<%= key %>,
-<%- end -%>
-  } description];
-}
-
-- (id)debugQuickLookObject
-{
-  return [self description];
-}
-
-@end
-SOURCE
-
-      render_erb(erb)
+      render_erb("Keys.m.erb")
     end
 
     :private
-
-    def render_erb(erb)
-      require 'erb'
+    
+    def render_erb(erb_template)
+      erb = IO.read(File.join(__dir__, "../templates", erb_template))
       ERB.new(erb, nil, '-').result(binding)
     end
 

data/lib/name_whisperer.rb

@@ -27,7 +27,7 @@ module CocoaPodsKeys
           Pathname.new(xcodeprojects[0]).basename.to_s
         else
           error_message = (xcodeprojects.length > 1) ? "found too many" : "couldn't find any"
-          puts "Hello there, we " + error_message + " xcodeprojects. Please give a name for this project."
+          puts "CocoaPods-Keys " + error_message + " Xcode projects. Please give a name for this project."
 
           answer = ""
           loop do

data/lib/plugin.rb

@@ -4,9 +4,9 @@ module CocoaPodsKeys
   class << self
     def podspec_for_current_project(spec_contents)
       local_user_options = user_options || {}
-      project = local_user_options.fetch("project", CocoaPodsKeys::NameWhisperer.get_project_name)
+      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 
+      raise Pod::Informative, "Could not load keyring" unless keyring
       key_master = KeyMaster.new(keyring)
 
       spec_contents.gsub!(/%%SOURCE_FILES%%/, "#{key_master.name}.{h,m}")
@@ -28,7 +28,13 @@ module CocoaPodsKeys
     end
 
     def user_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
     end
   end
 end
@@ -38,15 +44,20 @@ module Pod
     alias_method :install_before_cocoapods_keys!, :install!
 
     def install!
-      CocoaPodsKeys.setup
+      CocoaPodsKeys.setup if validates_for_keys
+
       install_before_cocoapods_keys!
     end
 
+    def validates_for_keys
+      Pod::Config.instance.podfile.plugins["cocoapods-keys"] != nil
+    end
+
     class Analyzer
       class SandboxAnalyzer
         alias_method :pod_state_before_cocoapods_keys, :pod_state
 
-        def pod_state(pod) 
+        def pod_state(pod)
           if pod == 'Keys'
             # return :added if we were, otherwise assume the Keys have :changed since last install, following my mother's "Better Safe than Sorry" principle.
             return :added if pod_added?(pod)
@@ -60,11 +71,11 @@ module Pod
   end
 
   class Specification
-    class << self 
+    class << self
       alias_method :from_string_before_cocoapods_keys, :from_string
 
       def from_string(spec_contents, path, subspec_name = nil)
-        if path.to_s.include? "Keys.podspec"
+        if path.basename.to_s =~ /\AKeys.podspec(?:.json)\Z/
           CocoaPodsKeys.podspec_for_current_project(spec_contents)
         end
         from_string_before_cocoapods_keys(spec_contents, path, subspec_name)

data/lib/preinstaller.rb

@@ -11,7 +11,7 @@ module CocoaPodsKeys
 
       options = @user_options || {}
       current_dir = Dir.getwd
-      project = options.fetch('project', CocoaPodsKeys::NameWhisperer.get_project_name)
+      project = options.fetch('project') { CocoaPodsKeys::NameWhisperer.get_project_name }
       keyring = KeyringLiberator.get_keyring_named(project) || KeyringLiberator.get_keyring(current_dir)
 
       keyring = CocoaPodsKeys::Keyring.new(project, current_dir, []) unless keyring

data/spec/fixtures/Keys_empty.h

@@ -0,0 +1,12 @@
+//
+// Generated by CocoaPods-Keys
+// on 11/03/2015
+// For more information see https://github.com/cocoapods/cocoapods-keys
+//
+
+#import <Foundation/NSString.h>
+
+@interface FakeKeys : NSObject
+
+
+@end

data/spec/fixtures/Keys_empty.m

@@ -0,0 +1,44 @@
+//
+// Generated by CocoaPods-Keys
+// on 11/03/2015
+// For more information see https://github.com/cocoapods/cocoapods-keys
+//
+
+#import <objc/runtime.h>
+#import <Foundation/NSDictionary.h>
+#import "FakeKeys.h"
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wincomplete-implementation"
+
+@implementation FakeKeys
+
+#pragma clang diagnostic pop
+
++ (BOOL)resolveInstanceMethod:(SEL)name
+{
+  NSString *key = NSStringFromSelector(name);
+  NSString * (*implementation)(FakeKeys *, SEL) = NULL;
+
+  if (!implementation) {
+    return [super resolveInstanceMethod:name];
+  }
+
+  return class_addMethod([self class], name, (IMP)implementation, "@@:");
+}
+
+
+static char FakeKeysData[] = "";
+
+- (NSString *)description
+{
+  return [@{
+  } description];
+}
+
+- (id)debugQuickLookObject
+{
+  return [self description];
+}
+
+@end

data/spec/key_master_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'key_master'
+require 'tmpdir'
+
+describe CocoaPodsKeys::KeyMaster do
+  let(:empty_keys_interface) {
+    IO.read(File.join(__dir__, "fixtures", "Keys_empty.h"))
+  }
+  
+  let(:empty_keys_implementation) {
+    IO.read(File.join(__dir__, "fixtures", "Keys_empty.m"))
+  }
+  
+  it "should work with an empty keyring" do
+    keyring = double("Keyring", keychain_data: [], code_name: "Fake")
+    keymaster = described_class.new(keyring, Time.new(2015, 3, 11))
+    expect(keymaster.name).to eq("FakeKeys")
+    expect(keymaster.interface).to eq(empty_keys_interface)
+    expect(keymaster.implementation).to eq(empty_keys_implementation)
+  end
+  
+  it "should generate valid empty objc files", requires_clang: true do
+    keyring = double("Keyring", keychain_data: [], code_name: "Fake")
+    keymaster = described_class.new(keyring, Time.new(2015, 3, 11))
+    expect(validate_syntax(keymaster)).to eq(true)
+  end
+
+  it "should escape backslashes" do
+    keyring = double("Keyring", keychain_data: [], code_name: "Fake")
+    keymaster = described_class.new(keyring, Time.new(2015, 3, 11))
+    keymaster.instance_variable_set(:@data, '\4')
+    expect(keymaster.generate_implementation).to include('"\\\4"')
+  end
+
+  it "should escape double-quotes" do
+    keyring = double("Keyring", keychain_data: [], code_name: "Fake")
+    keymaster = described_class.new(keyring, Time.new(2015, 3, 11))
+    keymaster.instance_variable_set(:@data, '"')
+    expect(keymaster.generate_implementation).to include('"\\""')
+  end
+
+  def validate_syntax(keymaster)
+    # write out the interface and the implementation to temp files
+    Dir.mktmpdir do |dir|
+      # create the header file
+      h_file = File.join(dir, "#{keymaster.name}.h")
+      IO.write(h_file, keymaster.interface)
+      # create the implementation file
+      m_file = File.join(dir, "#{keymaster.name}.m")
+      IO.write(m_file, keymaster.implementation)
+      # attempt to validate syntax with clang
+      Dir.chdir(dir)
+      system(`xcrun --sdk macosx --find clang`.strip, "-fsyntax-only", m_file)
+    end
+  end
+end

data/spec/keyring_liberator_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'keyring_liberator'
+require 'tmpdir'
+require 'keyring'
+
+include CocoaPodsKeys
+
+describe KeyringLiberator do
+  it "should get the keys directory" do
+    expect(KeyringLiberator.keys_dir).to end_with("cocoapods/keys")
+  end
+
+  it "should append a sha + .yaml when getting the yaml path" do
+    expect(KeyringLiberator.yaml_path_for_path("test")).to include("cocoapods/keys/")
+    expect(KeyringLiberator.yaml_path_for_path("test")).to end_with("098f6bcd4621d373cade4e832627b4f6.yml")
+  end
+
+  it "should find by name" do
+    keyring = Keyring.from_hash({ "name" => "test", "path" =>"testpath", "keys" => [] })
+    allow(KeyringLiberator).to receive(:get_all_keyrings).and_return([keyring])
+    expect(KeyringLiberator.get_keyring_named("test")).to equal(keyring)
+  end
+
+  it "should be nil if nothing found find by name" do
+    keyring = Keyring.from_hash({ "name" => "test", "path" =>"testpath", "keys" => [] })
+    allow(KeyringLiberator).to receive(:get_all_keyrings).and_return([keyring])
+    expect(KeyringLiberator.get_keyring_named("not found")).to be_falsey
+  end
+
+end

data/spec/plugin_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'cocoapods'
+require 'cocoapods-core'
+require 'plugin'
+#
+# include Pod
+#
+# describe Installer do
+#   it "only runs if the podfile has keys support" do
+#     installer = Installer.new(Sandbox.new("."), Podfile.new)
+#     installer.install!
+#   end
+#
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+def clang_available
+  # uses a shell to ensure we get a reasonable PATH
+  system("which -s clang")
+end
+
+RSpec.configure do |c|
+  # exclude tests requiring clang when it's unavailable
+  c.filter_run_excluding requires_clang: true unless clang_available
+end
+

data/templates/Keys.h.erb

@@ -0,0 +1,13 @@
+//
+// Generated by CocoaPods-Keys
+// on <%= @time.strftime("%d/%m/%Y") %>
+// For more information see https://github.com/cocoapods/cocoapods-keys
+//
+
+#import <Foundation/NSString.h>
+
+@interface <%= @name %> : NSObject
+<% @keys.each do |key, value| %>
+- (NSString *)<%= key %>;<% end %>
+
+@end

data/templates/Keys.m.erb

@@ -0,0 +1,65 @@
+//
+// Generated by CocoaPods-Keys
+// on <%= @time.strftime("%d/%m/%Y") %>
+// For more information see https://github.com/cocoapods/cocoapods-keys
+//
+
+#import <objc/runtime.h>
+#import <Foundation/NSDictionary.h>
+#import "<%= @name %>.h"
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wincomplete-implementation"
+
+@implementation <%= @name %>
+
+#pragma clang diagnostic pop
+
++ (BOOL)resolveInstanceMethod:(SEL)name
+{
+  NSString *key = NSStringFromSelector(name);
+  NSString * (*implementation)(<%= name %> *, SEL) = NULL;
+<% @keys.each do |key, value| %>
+  if ([key isEqualToString:@"<%= key %>"]) {
+    implementation = _podKeys<%= Digest::MD5.hexdigest(key) %>;
+  }
+<% end %>
+  if (!implementation) {
+    return [super resolveInstanceMethod:name];
+  }
+
+  return class_addMethod([self class], name, (IMP)implementation, "@@:");
+}
+<% @keys.each do |key, value| %>
+static NSString *_podKeys<%= Digest::MD5.hexdigest(key) %>(<%= name %> *self, SEL _cmd)
+{
+  <% if @indexed_keys.length > 0 %>
+    <% if @indexed_keys[key].length > 0 %>
+      char cString[<%= @indexed_keys[key].length + 1 %>] = { <%= key_data_arrays[key] %>, '\0' };
+    <% else %>
+      char cString[1] = { '\0' };
+    <% end %>
+    return [NSString stringWithCString:cString encoding:NSUTF8StringEncoding];
+  <% else %>
+    return @"";
+  <% end %>
+}
+<% end %>
+
+static char <%= name %>Data[<%= @data_length %>] = "<%= @data.gsub('\\', '\\\\\\').gsub('"', '\\"') if @data %>";
+
+- (NSString *)description
+{
+  return [@{
+<%- @keys.each do |key, value| -%>
+            @"<%= key %>": self.<%= key %>,
+<%- end -%>
+  } description];
+}
+
+- (id)debugQuickLookObject
+{
+  return [self description];
+}
+
+@end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-keys
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: osx_keychain
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A key value store for environment settings in Cocoa Apps.
 email:
 - orta.therox@gmail.com
@@ -62,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -82,6 +97,14 @@ files:
 - lib/pod/command/keys/rm.rb
 - lib/pod/command/keys/set.rb
 - lib/preinstaller.rb
+- spec/fixtures/Keys_empty.h
+- spec/fixtures/Keys_empty.m
+- spec/key_master_spec.rb
+- spec/keyring_liberator_spec.rb
+- spec/plugin_spec.rb
+- spec/spec_helper.rb
+- templates/Keys.h.erb
+- templates/Keys.m.erb
 homepage: https://github.com/cocoapods/cocoapods-keys
 licenses:
 - MIT
@@ -108,4 +131,10 @@ specification_version: 4
 summary: 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.
-test_files: []
+test_files:
+- spec/fixtures/Keys_empty.h
+- spec/fixtures/Keys_empty.m
+- spec/key_master_spec.rb
+- spec/keyring_liberator_spec.rb
+- spec/plugin_spec.rb
+- spec/spec_helper.rb