mayday 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c78e754b1dc60b302813defb808feecea2b0d056
-  data.tar.gz: f2e8d5ef9935f9d5a132e04b2be0e2219aad00a5
+  metadata.gz: bead9398a12d7fac991556b67b4af793675ef6a0
+  data.tar.gz: 7627a3a3648e2c8655a70df4d3e0856f05b3a6fc
 SHA512:
-  metadata.gz: 8ff4fe103f6da0e9ca701f807b81c9f7d9f38c360e511db50c5f604b75012ecd88bd2cd9923212bdb3bb5fbfd99ed551a0264852e0ff9e75921ce4e01b4a6ab4
-  data.tar.gz: 9439827e1a41aa7dd6aca66c268d88c06c80fe5327a87de0b59373d6066df108c8919f2c67a2e1e4a10e58b182a1bf2518d1b35c2825531cb86f9f9ab2ca23bf
+  metadata.gz: 473733c6f78fa151001c7517f6fe271a3f142978ec8239802b645653461794dbeab2e5a4ab77d34b29d869c75fab30f1ca630aad6d69b21e3ebd3d1bb4267951
+  data.tar.gz: 424758711041f7e6ed420077a2f941eb6f2106e775d4af2f9ef98cc906759184dde684c03520e82e2a91830dc7006b0896610a50bea4ed2a737d495ece8af776

data/.travis.yml

@@ -0,0 +1,19 @@
+language: objective-c
+script: bundle exec rspec
+
+# Sets Travis to run the Ruby specs on OS X machines which are required to
+# build the native extensions of Xcodeproj.
+
+env:
+  - RVM_RUBY_VERSION=system
+
+before_install:
+  - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
+  - source ~/.rvm/scripts/rvm
+  - if [[ $RVM_RUBY_VERSION != 'system' ]]; then rvm install $RVM_RUBY_VERSION; fi
+  - rvm use $RVM_RUBY_VERSION
+  - if [[ $RVM_RUBY_VERSION == 'system' ]]; then export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future; fi
+  - if [[ $RVM_RUBY_VERSION == 'system' ]]; then sudo gem install bundler --no-ri --no-rdoc; else gem install bundler --no-ri --no-rdoc; fi
+
+install:
+  - bundle install --without=documentation --path ./travis_bundle_dir

data/README.md

@@ -1,29 +1,41 @@
-Easily add custom warnings and errors to your Xcode project's build process.
+[![Gem Version](https://badge.fury.io/rb/mayday.svg)](http://badge.fury.io/rb/mayday)
+[![Build Status](https://travis-ci.org/marklarr/mayday.svg?branch=master)](https://travis-ci.org/marklarr/mayday)
 
-## Installation
 
-    $ gem install mayday
+Easily add custom warnings and errors to your Xcode project's build process
+
+## Installation
+```sh
+$ gem install mayday
+```
 
 ## Usage
 
-Create a Maydayfile at the root of your project, defining your warnings and errors using `warning`, `error`, `warning_regex`, and `error_regex`.
+Create a Maydayfile
+
+```sh
+$ mayday init
+```
+
+Add some warning and error checks to that file
 
 ```ruby
 # Maydayfile
 
 # Required
 xcode_proj "CoolApp.xcodeproj"
-# Required. This will most likely be the same name as your project.
-main_target "CoolApp"
 
 # Use regular expressions to define errors or warnings on a line-by-line basis
+error_regex "Please remove Copyright boilerplate", /^\/\/  Copyright \(c\).*$/, :files => "*AppDelegate*"
+warning_regex "TODO", /^\/\/\s+TODO:.*$/
+```
 
-error_regex "Please remove Copyright boilerplate", /^\/\/  Copyright \(c\).*$/, :files => "*AppDelegate*", :exclude => "Fixtures/SomeDir/Excluded/*"
+You can do more advanced checks, too, with blocks
 
-warning_regex "TODO", /^\/\/\s+TODO:.*$/
+``` ruby
+# Maydayfile
 
-# Do more complicated checks or return dynamic messages via blocks
-warning :line do |line|
+warning :line, :exclude => "Fixtures/SomeDir/Excluded/*" do |line|
   line.length > 120 ? "Length of line #{line.length} is longer than 120 characters!" : false
 end
 
@@ -39,12 +51,21 @@ error :file do |entire_file|
     false
   end
 end
-
 ```
 
-And then,
+When you're ready, run
+
+```sh
+$ mayday
+```    
+
+Next time you build your project, your errors and warnings will be flagged
 
-    $ mayday
+![Mayday warnings and errors in Xcode](https://raw.githubusercontent.com/marklarr/mayday/master/docs/example.jpg?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6bWFya2xhcnIvbWF5ZGF5L21hc3Rlci9kb2NzL2V4YW1wbGUuanBnIiwiZXhwaXJlcyI6MTQxNDM5MDIxNH0%3D--e7969b95aea1bc76749ae9226d2ac5ffef0cf322)
+
+![Mayday warnings and errors in Xcode, inline](https://raw.githubusercontent.com/marklarr/mayday/master/docs/example_inline.jpg?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6bWFya2xhcnIvbWF5ZGF5L21hc3Rlci9kb2NzL2V4YW1wbGVfaW5saW5lLmpwZyIsImV4cGlyZXMiOjE0MTQzOTAzMzh9--bc9abbe40843317e7b6a30a9521ebf6ae457ece2)
+
+Since Ruby is installed by default on OSX, the warnings and errors will work for anybody building your project, even if they don't have RVM, RubyGems, or mayday.
 
 ### Options
 
@@ -61,20 +82,27 @@ And then,
 
 You may be concerned about how much overhead this will add to your build process. To see how quickly your `mayday` checks execute, use 
 
-     $ mayday benchmark
+```sh
+$ mayday benchmark
+```
 
 ## Caveats
 
-* Since `mayday` uses [sourcify]() to write your custom `warning` and `errors` blocks to a build phase, all [gotchas in sourcify](https://github.com/ngty/sourcify#gotchas) apply to your blocks.
-* Generating efficient code to write into the build phase is difficult. `MayDay::ScriptGenerator#to_ruby` could definitely by optimized.
+* `mayday` uses [sourcify]() to write your custom `warning` and `errors` blocks to a build phase, all [gotchas in sourcify](https://github.com/ngty/sourcify#gotchas) apply to your blocks.
+* `mayday` copies your custom blocks, line for line, into a build phase, so all variables inside of them must be of local scope. Anything defined outside of a custom block will not be included in the build phase.
+* Gems cannot but used inside of custom blocks, only vanilla, system Ruby.
+* If your custom blocks have errors in them that aren't found until they're executed (which is done whenever you call `mayday`), the stack trace won't be very helpful in debugging (because there is no source map from the build phase back to your `Maydayfile` code)
+* Generating efficient code to write into the build phase is difficult. The code generated by `MayDay::ScriptGenerator#to_ruby` could definitely be optimized.
 
 
 ## Uninstallation
 
-    $ mayday down
+```sh
+$ mayday down
+```
 
 ## Contributing
 
-We'd love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a [new Github issue](https://github.com/venmo/synx/issues/new) if you find bugs or have questions. :octocat:
+We'd love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a [new GitHub issue](https://github.com/marklarr/mayday/issues/new) if you find bugs or have questions. :octocat:
 
 Please make sure to follow our general coding style and add test coverage for new features!

data/bin/mayday

@@ -2,6 +2,7 @@
 
 require 'clamp'
 require 'mayday'
+require 'colorize'
 
 Clamp do
   
@@ -9,11 +10,19 @@ Clamp do
 
   MAYDAY_FILE_PATH = "Maydayfile"
 
+  subcommand "init", "Creates a new Maydayfile" do
+    def execute
+      puts "Creating a new Maydayfile..."
+      Mayday::UserDefinitions.new(MAYDAY_FILE_PATH).init
+      puts "Done!".green
+    end
+  end
+
   subcommand "up", "Integrate the warnings and errors from Maydayfile into your Xcode project" do
     def execute
       puts "Integrating mayday into your project..."
       Mayday::UserDefinitions.new(MAYDAY_FILE_PATH).up
-      puts "Done!"
+      puts "Done!".green
     end
   end
 
@@ -21,7 +30,7 @@ Clamp do
     def execute
       puts "Removing mayday from your project..."
       Mayday::UserDefinitions.new(MAYDAY_FILE_PATH).down
-      puts "Done!"
+      puts "Done!".green
     end
   end
 

data/lib/mayday/reader.rb

@@ -16,12 +16,7 @@ module Mayday
     def to_target_integrator
       instance_eval(@mayday_file.read, @mayday_file.path, 0)
       validate_xcode_proj
-      validate_main_target_name
-      TargetIntegrator.new(@xcode_proj, @script_generator, @main_target_name)
-    end
-
-    def main_target(main_target_name)
-      @main_target_name = main_target_name
+      TargetIntegrator.new(@xcode_proj, @script_generator)
     end
 
     def xcode_proj(xcode_proj_path)
@@ -45,14 +40,6 @@ module Mayday
     end
     private :validate_xcode_proj
 
-    def validate_main_target_name
-      unless @main_target_name
-        puts "No main target specified in #{@mayday_file.path}. Specify one using main_target_name 'My Target'".red
-        abort
-      end
-    end
-    private :validate_xcode_proj
-
     def abstract_flag_regex(klass, message, regex, options={})
       block = <<-CODE
 lambda do |line|
@@ -80,7 +67,7 @@ end
       when Proc
         block.to_source
       else
-        raise TypeError, "#{self.class}'s block has invalid type of #{@block.class}"
+        raise TypeError, "#{klass}'s block has invalid type of #{@block.class}"
       end
 
       final_block = case type

data/lib/mayday/target_integrator.rb

@@ -3,25 +3,28 @@ require 'xcodeproj'
 module Mayday
   class TargetIntegrator
 
-    def initialize(project, script_generator, target_name)
+    def initialize(project, script_generator)
       @project = project
       @script_generator = script_generator
-      @target_name = target_name
     end
 
     def integrate
       if runs_successfully?
-        phase = existing_mayday_build_phase_for_native_target(native_target_to_integrate) || native_target_to_integrate.new_shell_script_build_phase(mayday_build_phase_name)
-        phase.shell_path = "/usr/bin/ruby"
-        phase.shell_script = @script_generator.to_ruby
-        phase.show_env_vars_in_log = '0'
+        native_targets_to_integrate.each do |native_target_to_integrate|
+          phase = existing_mayday_build_phase_for_native_target(native_target_to_integrate) || native_target_to_integrate.new_shell_script_build_phase(mayday_build_phase_name)
+          phase.shell_path = "/usr/bin/ruby"
+          phase.shell_script = @script_generator.to_ruby
+          phase.show_env_vars_in_log = '0'
+        end
         @project.save
       end
     end
 
     def deintegrate
-      phase = existing_mayday_build_phase_for_native_target(native_target_to_integrate)
-      phase.remove_from_project if phase
+      native_targets_to_integrate.each do |native_target_to_integrate|
+        phase = existing_mayday_build_phase_for_native_target(native_target_to_integrate)
+        phase.remove_from_project if phase
+      end
       @project.save
     end
 
@@ -40,20 +43,19 @@ module Mayday
       end
     end
 
-    def native_target_to_integrate
-      native_target = @project.targets.detect do |target|
-        target.is_a?(Xcodeproj::Project::Object::PBXNativeTarget) && target.name == @target_name
+    def native_targets_to_integrate
+      native_targets = @project.targets.select do |target|
+        target.is_a?(Xcodeproj::Project::Object::PBXNativeTarget)
       end
 
-      if native_target
-        native_target
+      if native_targets.count > 0
+        native_targets
       else
-        valid_target_names = @project.targets.select { |target| target.is_a?(Xcodeproj::Project::Object::PBXNativeTarget) }.map(&:name)
-        puts "Could not find a target named #{@target_name} in #{@project.path}. Available targets: #{valid_target_names.join(", ")}".red
+        puts "Could not find any native targets that have no target dependencies".red
         abort
       end
     end
-    private :native_target_to_integrate
+    private :native_targets_to_integrate
 
     def existing_mayday_build_phase_for_native_target(native_target)
       native_target.shell_script_build_phases.detect { |bp| bp.name == mayday_build_phase_name }

data/lib/mayday/user_definitions.rb

@@ -8,6 +8,22 @@ module Mayday
       @mayday_file_path = mayday_file_path
     end
 
+    def init
+      if File.exist?(@mayday_file_path)
+        puts "#{@mayday_file_path} already exists".red
+        abort
+      else
+        File.open(@mayday_file_path, 'w') do |file|
+          file.write <<-CODE
+xcode_proj '#{nearby_xcodeproj}'
+
+warning_regex 'TODO:', /\\s+\\/\\/\\s?TODO:/
+          CODE
+          puts "#{@mayday_file_path} created".green
+        end
+      end
+    end
+
     def up
       mayday_file do |file|
         Reader.new(file).to_target_integrator.integrate
@@ -28,7 +44,7 @@ module Mayday
 
     def mayday_file
       unless File.exist?(@mayday_file_path)
-        puts "No file found at path ./#{@mayday_file_path}".red
+        puts "No #{@mayday_file_path} found".red
         abort
       end
 
@@ -38,5 +54,12 @@ module Mayday
     end
     private :mayday_file
 
+    def nearby_xcodeproj
+      nearby = Dir["**/*.xcodeproj"].reject { |xcodeproj_path| xcodeproj_path =~ /Pods\//}.first
+      puts "Xcodeproj couldn't be found".yellow unless nearby
+      nearby
+    end
+    private :nearby_xcodeproj
+
   end 
 end

data/lib/mayday/version.rb

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

data/spec/fixtures/Fixtures/FixturesTests/FixturesTests.swift

@@ -13,7 +13,7 @@ class FixturesTests: XCTestCase {
     
     override func setUp() {
         super.setUp()
-        // Put setup code here. This method is called before the invocation of each test method in the class.
+        // Put setup code here. This method is called before the invocation of each test method in the class. // Put setup code here. This method is called before the invocation of each test method in the class.
     }
     
     override func tearDown() {

data/spec/fixtures/Maydayfile

@@ -1,5 +1,4 @@
 xcode_proj "Fixtures/Fixtures.xcodeproj"
-main_target "Fixtures"
 
 warning :line, :language => "swift" do |line|
   line.length > 120 ? "Length of line #{line.length} is longer than 120 characters!" : false

data/spec/fixtures/Maydayfile_ruby_error

@@ -1,5 +1,4 @@
 xcode_proj "Fixtures/Fixtures.xcodeproj"
-main_target "Fixtures"
 
 warning :line, :language => "swift" do |line|
   raise "error"

data/spec/mayday/user_definitions_spec.rb

@@ -2,14 +2,16 @@ require 'spec_helper'
 
 describe Mayday::UserDefinitions do
 
-  def parse_build_output
-    output =`xcodebuild -project spec/test_fixtures/Fixtures/Fixtures.xcodeproj/ -scheme Fixtures -configuration Debug`
+  def parse_build_output(opts={})
+    extra_test_flags = opts[:test] ? "-sdk iphonesimulator test" : ""
+    output =`xcodebuild -project spec/test_fixtures/Fixtures/Fixtures.xcodeproj/ -scheme Fixtures -configuration Debug #{extra_test_flags}`
     exitstatus = $?.exitstatus
     files_to_lines_to_warnings_hash = {}
     output.split("\n").each do |line|
       matches = line.match(/((.+):([0-9]+):\s(.+))/)
       if matches
-        file_path = matches[2]
+        # Get path relative to spec/test_fixtures
+        file_path = matches[2].split("/spec/").last
         line_number = matches[3]
         flag_message = matches[4]          
 
@@ -42,36 +44,40 @@ describe Mayday::UserDefinitions do
   let(:files_to_lines_to_warnings_hash) { @parsed_build_output[:files_to_lines_to_warnings_hash] }
 
   describe "#up" do
-    describe "after running xcodebuild" do 
-      before(:all) do
-          user_definitions = Mayday::UserDefinitions.new(FIXTURES_TEST_MAYDAY_FILE_PATH)
-          user_definitions.up
-          @parsed_build_output = parse_build_output
-      end
+    before(:all) do
+      user_definitions = Mayday::UserDefinitions.new(FIXTURES_TEST_MAYDAY_FILE_PATH)
+      user_definitions.up
+    end
 
-      it "should have failed the build" do
-        expect(@parsed_build_output[:exitstatus]).to_not eq(0)
-      end
+    [{}, {:test => true}].each do |options|
 
-      it "should have output all files with warnings or errors in them" do
-        expect(files_to_lines_to_warnings_hash.count).to eq(3)
-      end
+      describe "after running xcodebuild on the main target with #{options}" do 
+        before(:all) { @parsed_build_output = parse_build_output(options) }
+
+        it "should have failed the build" do
+          expect(@parsed_build_output[:exitstatus]).to_not eq(0)
+        end
 
-      it "should have, for every file, output all of the warnings or errors in them" do
-        some_object_h_flags = files_to_lines_to_warnings_hash['/Users/marklarsen/github.com/mayday/spec/test_fixtures/Fixtures/Fixtures/SomeDir/SomeObject.h']
-        app_delegate_swift_flags = files_to_lines_to_warnings_hash['/Users/marklarsen/github.com/mayday/spec/test_fixtures/Fixtures/Fixtures/AppDelegate.swift']
-        long_file_m_flags = files_to_lines_to_warnings_hash['/Users/marklarsen/github.com/mayday/spec/test_fixtures/Fixtures/Fixtures/SomeDir/LongFile.m']
+        it "should have output all files with warnings or errors in them" do
+          expect(files_to_lines_to_warnings_hash.count).to eq(4)
+        end
 
-        expect(some_object_h_flags.count).to eq(1)
-        expect(app_delegate_swift_flags.count).to eq(9)
-        expect(long_file_m_flags.count).to eq(1)
+        it "should have, for every file, output all of the warnings or errors in them" do
+          some_object_h_flags = files_to_lines_to_warnings_hash['test_fixtures/Fixtures/Fixtures/SomeDir/SomeObject.h']
+          app_delegate_swift_flags = files_to_lines_to_warnings_hash['test_fixtures/Fixtures/Fixtures/AppDelegate.swift']
+          long_file_m_flags = files_to_lines_to_warnings_hash['test_fixtures/Fixtures/Fixtures/SomeDir/LongFile.m']
+
+          expect(some_object_h_flags.count).to eq(1)
+          expect(app_delegate_swift_flags.count).to eq(9)
+          expect(long_file_m_flags.count).to eq(1)
+        end
       end
-    end
 
-    describe "when using a Maydayfile containing Ruby errors" do
-      it "should raise the exception to the user when they try to 'up'" do
-        user_definitions = Mayday::UserDefinitions.new(FIXTURES_TEST_MAYDAY_FILE_RUBY_ERROR_PATH)
-        expect { user_definitions.up }.to raise_error("error")
+      describe "when using a Maydayfile containing Ruby errors" do
+        it "should raise the exception to the user when they try to 'up'" do
+          user_definitions = Mayday::UserDefinitions.new(FIXTURES_TEST_MAYDAY_FILE_RUBY_ERROR_PATH)
+          expect { user_definitions.up }.to raise_error("error")
+        end
       end
     end
   end
@@ -95,6 +101,37 @@ describe Mayday::UserDefinitions do
     end
   end
 
+  describe "#init" do
+    describe "Maydayfile doesn't exist" do
+      before(:all) do
+        @mayday_file_doesnt_exist_path = "Maydayfile_doesnt_exist"
+        FileUtils.rm_rf(@mayday_file_doesnt_exist_path)
+        user_definitions = Mayday::UserDefinitions.new(@mayday_file_doesnt_exist_path)
+        user_definitions.init
+      end
+
+      after(:all) do
+        FileUtils.rm_rf(@mayday_file_doesnt_exist_path)
+      end
+
+      it "should create a valid Maydayfile prefilled with the nearest xcodeproject" do
+        user_definitions = Mayday::UserDefinitions.new(@mayday_file_doesnt_exist_path)
+        user_definitions.up
+        user_definitions.down
+      end
+    end
+
+    describe "Maydayfile already exists" do
+      it "should keep the Maydayfile as-is and abort" do
+        before_file_contents = File.open(FIXTURES_TEST_MAYDAY_FILE_PATH) { |file| file.read }
+        user_definitions = Mayday::UserDefinitions.new(FIXTURES_TEST_MAYDAY_FILE_PATH)
+        lambda { user_definitions.init }.should raise_error SystemExit
+        after_file_contents = File.open(FIXTURES_TEST_MAYDAY_FILE_PATH) { |file| file.read }
+        expect(before_file_contents).to eq(after_file_contents)
+      end
+    end
+  end
+
   describe "#benchmark" do
     it "should show benchmark data for the mayday build phase" do
       user_definitions = Mayday::UserDefinitions.new(FIXTURES_TEST_MAYDAY_FILE_PATH)
@@ -127,19 +164,6 @@ describe Mayday::UserDefinitions do
   describe "when the Maydayfile has no xcode_proj defined" do
     it "should abort" do
       mayday_file = create_mayday_file do
-        main_target "hey"
-        warning { |line| return nil }
-        error { |line| return "ERROR!" }
-      end
-
-      lambda { Mayday::UserDefinitions.new(mayday_file.path).up }.should raise_error SystemExit
-    end
-  end
-
-  describe "when the Maydayfile has no main_target_name defined" do
-    it "should abort" do
-      mayday_file = create_mayday_file do
-        xcode_proj "../spec/test_fixtures/Maydayfile"
         warning { |line| return nil }
         error { |line| return "ERROR!" }
       end
@@ -152,20 +176,7 @@ describe Mayday::UserDefinitions do
     it "should abort" do
       mayday_file = create_mayday_file do
         xcode_proj "Hi.xcodeproj"
-        main_target_name "wut"
-        warning { |line| return nil }
-        error { |line| return "ERROR!" }
-      end
 
-      lambda { Mayday::UserDefinitions.new(mayday_file.path).up }.should raise_error SystemExit
-    end
-  end
-
-  describe "when the Maydayfile cannot find the main_target_name defined" do
-    it "should abort" do
-      mayday_file = create_mayday_file do
-        xcode_proj "../spec/test_fixtures/Maydayfile"
-        main_target_name "Nonexistent"
         warning { |line| return nil }
         error { |line| return "ERROR!" }
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mayday
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mark Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,11 +131,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/mayday
+- docs/example.jpg
+- docs/example_inline.jpg
 - lib/mayday.rb
 - lib/mayday/abstract_flag.rb
 - lib/mayday/abstract_flag/error.rb