mayday 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c78e754b1dc60b302813defb808feecea2b0d056
+  data.tar.gz: f2e8d5ef9935f9d5a132e04b2be0e2219aad00a5
+SHA512:
+  metadata.gz: 8ff4fe103f6da0e9ca701f807b81c9f7d9f38c360e511db50c5f604b75012ecd88bd2cd9923212bdb3bb5fbfd99ed551a0264852e0ff9e75921ce4e01b4a6ab4
+  data.tar.gz: 9439827e1a41aa7dd6aca66c268d88c06c80fe5327a87de0b59373d6066df108c8919f2c67a2e1e4a10e58b182a1bf2518d1b35c2825531cb86f9f9ab2ca23bf

data/.gitignore

@@ -0,0 +1,46 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Xcode
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+*.DS_Store
+
+
+# Spec
+spec/test_fixtures/
+Maydayfile_rspec_generated

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mayday.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Larsen
+
+MIT License
+
+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,80 @@
+Easily add custom warnings and errors to your Xcode project's build process.
+
+## Installation
+
+    $ 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`.
+
+```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*", :exclude => "Fixtures/SomeDir/Excluded/*"
+
+warning_regex "TODO", /^\/\/\s+TODO:.*$/
+
+# Do more complicated checks or return dynamic messages via blocks
+warning :line do |line|
+  line.length > 120 ? "Length of line #{line.length} is longer than 120 characters!" : false
+end
+
+# You can get the whole file, too
+error :file do |entire_file|
+  max_number_of_lines = 500
+  
+  number_of_code_or_comment_lines = entire_file.split("\n").select { |line| line.strip.length > 0 }.count
+  if number_of_code_or_comment_lines > max_number_of_lines
+    # Map line numbers to errors
+    { "1" => "File is #{number_of_code_or_comment_lines} lines long" }
+  else
+    false
+  end
+end
+
+```
+
+And then,
+
+    $ mayday
+
+### Options
+
+`warning`, `error`, `warning_regex`, and `error_regex` all accept an options hash with any of the following options
+
+* `language` limits to files in the provided language. Accepts `"swift"` and `"objective-c"`.
+  * `warning :line, :language => "swift" do ...`
+* `files` limits to files that have an absolute path that matches the provided [globs](http://en.wikipedia.org/wiki/Glob_(programming)). Accepts an array.
+  * `warning_regex "Foo!", /^barbaz$/, :files => ["*.h"] do ...`
+* `exclusions` doesn't run on files that have an absolute path that matches the provided [globs](http://en.wikipedia.org/wiki/Glob_(programming)). Accepts an array.
+  * `warning :line, :exclude => ["*/Pods/*"] do ...` **Note, Pods are excluded by default by mayday**
+
+## Benchmarking
+
+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
+
+## 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.
+
+
+## Uninstallation
+
+    $ 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:
+
+Please make sure to follow our general coding style and add test coverage for new features!

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/mayday

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'clamp'
+require 'mayday'
+
+Clamp do
+  
+  self.default_subcommand = "up"
+
+  MAYDAY_FILE_PATH = "Maydayfile"
+
+  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!"
+    end
+  end
+
+  subcommand "down", "Remove the warnings and errors from Maydayfile into your Xcode project" do
+    def execute
+      puts "Removing mayday from your project..."
+      Mayday::UserDefinitions.new(MAYDAY_FILE_PATH).down
+      puts "Done!"
+    end
+  end
+
+  subcommand "benchmark", "Output benchmark results of running your Maydayfile errors and warnings on your Xcode project" do
+    def execute
+      Mayday::UserDefinitions.new(MAYDAY_FILE_PATH).benchmark
+    end
+  end
+end

data/lib/mayday/abstract_flag/error.rb

@@ -0,0 +1,7 @@
+require "mayday/abstract_flag"
+
+module Mayday
+  class Error < AbstractFlag
+
+  end
+end

data/lib/mayday/abstract_flag/warning.rb

@@ -0,0 +1,11 @@
+require "mayday/error"
+
+module Mayday
+  class Warning < Error
+
+    def message_prefix
+      "warning: "
+    end
+
+  end
+end

data/lib/mayday/abstract_flag.rb

@@ -0,0 +1,90 @@
+require 'sourcify'
+
+module Mayday
+  class AbstractFlag
+
+    @@function_names = []
+    
+    def initialize(block, options={})
+      @block = block
+
+      @include_file_globs = Array(options[:files])
+      @exclude_file_globs = Array(options[:exclude])
+
+      if options[:language]
+        language = options[:language].to_s
+        if language == "swift"
+          @include_file_globs << "*.swift"
+        elsif language == "objective-c"
+          @include_file_globs << "*.{h,m}"
+        else
+          puts "Unrecognized language '#{language}'".red
+          abort
+        end
+      end
+
+      @exclude_file_globs << "*Pods/*"
+    end
+
+    def message_prefix
+      ""
+    end
+
+    def block_string
+      case @block
+      when String
+        @block
+      when Proc
+        @block.to_source
+      else
+        raise TypeError, "#{self.class}'s block has invalid type of #{@block.class}"
+      end
+    end
+
+    def function_def_string
+      <<-CODE
+def #{function_name}(file_path, file_contents)
+  #{file_fn_match_lines("file_path")}
+
+  line_number_to_warning_hash = lambda do 
+    #{block_string}.call(file_contents)
+  end.call
+
+  if line_number_to_warning_hash && line_number_to_warning_hash.keys.count > 0
+    final_warning_array = []
+    line_number_to_warning_hash.map do |line_number, warning_str|
+      final_warning_array << "\#{file_path}:\#{line_number}: #{message_prefix}\#{warning_str} [Wmayday]"  
+    end
+    final_warning_array.join("\n")
+  else
+    false
+  end
+end
+CODE
+    end
+
+    def file_fn_match_lines(file_path_var_name)
+      @file_fn_match_lines ||= begin
+        includes_chunk = @include_file_globs.map do |file_glob|
+          "return unless File.fnmatch(\"#{file_glob}\", #{file_path_var_name})"
+        end.join("\n")
+
+        excludes_chunk = @exclude_file_globs.map do |file_glob|
+          "return if File.fnmatch(\"#{file_glob}\", #{file_path_var_name})"
+        end.join("\n")
+
+        includes_chunk + "\n" + excludes_chunk
+      end
+    end
+    private :file_fn_match_lines
+
+    def function_name
+      @function_name ||= begin
+        # Enforce uniqueness 
+        candidate_function_name = "abstract_flag_matcher_#{rand(10000)}"
+        @@function_names.include?(candidate_function_name) ? function_name : candidate_function_name
+      end
+    end
+
+  end
+end

data/lib/mayday/error.rb

@@ -0,0 +1,7 @@
+require "mayday/abstract_flag"
+
+module Mayday
+  class Error < AbstractFlag
+
+  end
+end

data/lib/mayday/reader.rb

@@ -0,0 +1,108 @@
+require 'mayday/target_integrator'
+require 'mayday/script_generator'
+require 'mayday/abstract_flag/warning'
+require 'mayday/abstract_flag/error'
+
+require 'pathname'
+
+module Mayday
+  class Reader
+
+    def initialize(mayday_file)
+      @mayday_file = mayday_file
+      @script_generator = ScriptGenerator.new
+    end
+
+    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
+    end
+
+    def xcode_proj(xcode_proj_path)
+      real_xcodeproj_path = File.join(Pathname.new(@mayday_file.path).realpath.parent, xcode_proj_path)
+      @xcode_proj = Xcodeproj::Project.open(real_xcodeproj_path)
+    end
+
+    def warning_regex(message, regex, options={})
+      abstract_flag_regex(Warning, message, regex, options)
+    end
+
+    def error_regex(message, regex, options={})
+      abstract_flag_regex(Error, message, regex, options)
+    end
+
+    def validate_xcode_proj
+      unless @xcode_proj
+        puts "No Xcode project specified in #{@mayday_file.path}. Specify one using xcode_proj 'Path/To/MyProject.xcodeproj'".red
+        abort
+      end
+    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|
+  line =~ Regexp.new('#{regex}') ? "#{message}" : nil
+end
+      CODE
+      abstract_flag(klass, :line, block, options)
+    end
+    private :abstract_flag_regex
+
+    def warning(type, options={}, &block)
+      abstract_flag(Warning, type, block, options)
+    end
+    private :warning
+
+    def error(type, options={}, &block)
+      abstract_flag(Error, type, block, options)
+    end
+    private :error
+
+    def abstract_flag(klass, type, block, options={})
+      block_str = case block
+      when String
+        block
+      when Proc
+        block.to_source
+      else
+        raise TypeError, "#{self.class}'s block has invalid type of #{@block.class}"
+      end
+
+      final_block = case type
+                    when :line
+                      <<-CODE 
+lambda do |file_contents|
+  hash = {}
+  lines = file_contents.split("\n")
+  lines.each_with_index do |line, line_number| 
+    message = #{block_str}.call(line)
+    hash[line_number + 1] = message if message
+  end
+  hash
+end
+                        CODE
+                    when :file
+                      block
+                    end
+
+      @script_generator.flags << klass.new(final_block, options)
+    end
+    private :abstract_flag
+
+  end
+end

data/lib/mayday/script_generator.rb

@@ -0,0 +1,74 @@
+require "mayday/abstract_flag/error"
+require "mayday/abstract_flag/warning"
+
+require 'pathname'
+
+module Mayday
+  class ScriptGenerator
+
+    attr_accessor :flags
+
+    def initialize
+      self.flags = []
+    end
+
+    def to_ruby(opts={})
+      opts[:exit_after] = true if opts[:exit_after] == nil;
+      opts[:output] = true if opts[:output] == nil;
+
+      function_defs = flags.map(&:function_def_string).join
+      exit_chunk = if opts[:exit_after]
+        <<-CODE
+if #{any_errors_variable_name}
+  exit(1)
+else
+  exit
+end
+          CODE
+      else
+        ""
+      end
+
+      call_flag_functions_chunk = call_flag_functions_string("file", opts[:output])
+
+# Return the final code blob
+
+      <<-CODE
+# encoding: utf-8
+Encoding.default_external = "utf-8"
+
+#{function_defs}
+
+Dir[ENV["SRCROOT"] + "/**/*.{m,h,swift}"].each do |filename|
+  # Could be a dir with .m, like Underscore.m's dir
+  if (File.file?(filename))
+    file = File.open(filename, 'r')
+    #{call_flag_functions_chunk}
+  end
+end
+
+#{exit_chunk}
+        CODE
+    end
+
+    def call_flag_functions_string(file_var_name, output)
+      "file_contents = file.read\n" + flags.map do |flag|
+        any_errors_line = flag.class == Mayday::Error ? "#{any_errors_variable_name} = true" : ""
+        <<-CODE
+abstract_flag_output = #{flag.function_name}(#{file_var_name}.path, file_contents)
+if abstract_flag_output && #{output}
+  puts abstract_flag_output
+  #{any_errors_line}
+end
+           CODE
+      end.join("\n")
+    end
+    private :call_flag_functions_string
+
+    def any_errors_variable_name
+      "@any_errors"
+    end
+    private :any_errors_variable_name
+
+  end
+end

data/lib/mayday/target_integrator.rb

@@ -0,0 +1,69 @@
+require 'xcodeproj'
+
+module Mayday
+  class TargetIntegrator
+
+    def initialize(project, script_generator, target_name)
+      @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'
+        @project.save
+      end
+    end
+
+    def deintegrate
+      phase = existing_mayday_build_phase_for_native_target(native_target_to_integrate)
+      phase.remove_from_project if phase
+      @project.save
+    end
+
+    def runs_successfully?
+      ENV["SRCROOT"] = @project.path.parent.to_s
+      eval(@script_generator.to_ruby(:exit_after => false, :output => false))
+      true
+    end
+
+    def benchmark
+      ENV["SRCROOT"] = @project.path.parent.to_s
+
+      require 'benchmark'
+      Benchmark.bm(7) do |benchmarker| 
+        benchmarker.report('Mayday') { eval(@script_generator.to_ruby(:exit_after => false, :output => false)) }
+      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
+      end
+
+      if native_target
+        native_target
+      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
+        abort
+      end
+    end
+    private :native_target_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 }
+    end
+    private :existing_mayday_build_phase_for_native_target
+
+    def mayday_build_phase_name
+      'Generate Mayday Flags'
+    end
+    private :mayday_build_phase_name
+
+  end
+end

data/lib/mayday/user_definitions.rb

@@ -0,0 +1,42 @@
+require 'mayday/reader'
+require 'colored'
+
+module Mayday
+  class UserDefinitions
+
+    def initialize(mayday_file_path)
+      @mayday_file_path = mayday_file_path
+    end
+
+    def up
+      mayday_file do |file|
+        Reader.new(file).to_target_integrator.integrate
+      end
+    end
+
+    def down
+      mayday_file do |file|
+        Reader.new(file).to_target_integrator.deintegrate
+      end
+    end
+
+    def benchmark
+      mayday_file do |file|
+        Reader.new(file).to_target_integrator.benchmark
+      end
+    end
+
+    def mayday_file
+      unless File.exist?(@mayday_file_path)
+        puts "No file found at path ./#{@mayday_file_path}".red
+        abort
+      end
+
+      file = File.open(@mayday_file_path)
+      yield file
+      file.close
+    end
+    private :mayday_file
+
+  end 
+end

data/lib/mayday/version.rb

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

data/lib/mayday/warning.rb

@@ -0,0 +1,11 @@
+require "mayday/error"
+
+module Mayday
+  class Warning < Error
+
+    def message_prefix
+      "warning: "
+    end
+
+  end
+end

data/lib/mayday.rb

@@ -0,0 +1,2 @@
+require "mayday/version"
+require "mayday/user_definitions"

data/mayday.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mayday/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mayday"
+  spec.version       = Mayday::VERSION
+  spec.authors       = ["Mark Larsen"]
+  spec.email         = ["larse503@gmail.com"]
+  spec.summary       = %q{Custom warnings and errors}
+  spec.description   = %q{Custom warnings and errors}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+
+  spec.add_dependency 'clamp', '~> 0.6.3'
+  spec.add_dependency 'colored', '~> 1.2'
+  spec.add_dependency 'sourcify', '~> 0.6.0rc4'
+  spec.add_dependency 'xcodeproj', '~> 0.19.3'
+end