mayday 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 528e45a5424cea26dc7661b18baa77c21989e5a0
-  data.tar.gz: f2191fb65a8b7de70a7ef74b5bee6622dfe07818
+  metadata.gz: 54fd6eae0019921ad08a561b8608c07cc05434be
+  data.tar.gz: 8458b2fac4814310e1adf39f4c577218c5410a3b
 SHA512:
-  metadata.gz: f18702d705d8456491604b27e208cdebafa6fc64b7237ca44065516350c198dac4153acf62043d2ed94cdeeefedb547cbfe6d62608c61a13551c0dab7fc2301d
-  data.tar.gz: 8124aa4272be0943a239c97e7a54fe3ddddd6318fdbaf4492b4b87c8ef90cf384f1596806e80d465ad6c7f1d1fc57c898a9bad450b61534c132cbadeed5ef7be
+  metadata.gz: 16bae0fba41a1e56aba29ab7daed21d295cb9006c970adcadf5ebb8b87e6f3b34997c65666812af5b4647db3adfbf4315d939186e44a19876d8342b2a53be4da
+  data.tar.gz: ee96131376be5dabc33ec5dce2c823c2266616263e495b48dc2b5248868b880b4d0928be4579cc786eb4575c155a6f2398fe0d94e214d94d2ddcde3a52b4bcff

data/README.md

@@ -78,6 +78,10 @@ Since Ruby is installed by default on OSX, the warnings and errors will work for
 * `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**
 
+## Cookbook
+
+For some ideas on how to start using mayday, see the [cookbook](https://github.com/marklarr/mayday/blob/master/docs/Cookbook.md)
+
 ## 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 
@@ -94,7 +98,6 @@ $ mayday benchmark
 * 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
 
 ```sh

data/docs/Cookbook.md

@@ -0,0 +1,46 @@
+# Cookbook
+
+The mayday cookbook contains common warning/error checks that are ready to use out-of-the-box and can be customized as you please.
+
+* [Reminders](#reminders)
+* [Lint](#lint)
+
+## Reminders
+
+```ruby
+# Warning for TODO comments
+warning_regex 'TODO', /\s*\/\/\s*TODO:/
+```
+
+```ruby
+# Warning for FIXME comments
+warning_regex 'FIXME', /\s*\/\/\s*FIXME:/
+```
+
+## Lint
+
+```ruby
+# Warning for lines that are more than 120 columns long
+warning :line { |line| line.length > 120 ? "Line is #{line.length} columns long" : false }
+```
+
+```ruby
+# Warning for files that are more than 500 lines long
+warning :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
+```
+
+```ruby
+# Warning for Copyright placed at the beginning of every file
+warning_regex "Please remove Copyright boilerplate", /^\/\/  Copyright \(c\).*$/
+```
+

data/lib/mayday/reader.rb

@@ -13,6 +13,11 @@ module Mayday
       @script_generator = ScriptGenerator.new
     end
 
+    def require(lib_name)
+      super
+      @script_generator.libs_to_require << lib_name
+    end
+
     def to_target_integrator
       instance_eval(@mayday_file.read, @mayday_file.path, 0)
       validate_xcode_proj
@@ -23,14 +28,17 @@ module Mayday
       real_xcodeproj_path = File.join(Pathname.new(@mayday_file.path).realpath.parent, xcode_proj_path)
       @xcode_proj = Xcodeproj::Project.open(real_xcodeproj_path)
     end
+    private :xcode_proj
 
     def warning_regex(message, regex, options={})
       abstract_flag_regex(Warning, message, regex, options)
     end
+    private :warning_regex
 
     def error_regex(message, regex, options={})
       abstract_flag_regex(Error, message, regex, options)
     end
+    private :error_regex
 
     def validate_xcode_proj
       unless @xcode_proj

data/lib/mayday/script_generator.rb

@@ -6,16 +6,18 @@ require 'pathname'
 module Mayday
   class ScriptGenerator
 
-    attr_accessor :flags
+    attr_accessor :flags, :libs_to_require
 
     def initialize
       self.flags = []
+      self.libs_to_require = []
     end
 
     def to_ruby(opts={})
       opts[:exit_after] = true if opts[:exit_after] == nil;
       opts[:output] = true if opts[:output] == nil;
 
+      require_lines = libs_to_require.map { |lib_to_require| "require '#{lib_to_require}'" }.join("\n")
       function_defs = flags.map(&:function_def_string).join
       exit_chunk = if opts[:exit_after]
         <<-CODE
@@ -37,6 +39,8 @@ end
 # encoding: utf-8
 Encoding.default_external = "utf-8"
 
+#{require_lines}
+
 #{function_defs}
 
 Dir[ENV["SRCROOT"] + "/**/*.{m,h,swift}"].each do |filename|

data/lib/mayday/target_integrator.rb

@@ -51,7 +51,7 @@ module Mayday
       if native_targets.count > 0
         native_targets
       else
-        puts "Could not find any native targets that have no target dependencies".red
+        puts "Could not find any native targets".red
         abort
       end
     end

data/lib/mayday/version.rb

@@ -1,3 +1,3 @@
 module Mayday
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/mayday.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'clamp', '~> 0.6.3'
   spec.add_dependency 'colorize', '~> 0.7.3'
   spec.add_dependency 'sourcify', '~> 0.6.0rc4'
-  spec.add_dependency 'xcodeproj', '~> 0.19.3'
+  spec.add_dependency 'xcodeproj', '~> 0.20'
 end

data/spec/fixtures/Maydayfile

@@ -1,6 +1,11 @@
+require 'cmath'
+
 xcode_proj "Fixtures/Fixtures.xcodeproj"
 
+CMath.sin(2)
+
 warning :line, :language => "swift" do |line|
+  CMath.sin(2)
   line.length > 120 ? "Length of line #{line.length} is longer than 120 characters!" : false
 end
 

data/spec/mayday/user_definitions_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe Mayday::UserDefinitions do
 
   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}`
+    extra_test_flags = opts[:test] ? "test" : ""
+    output =`xcodebuild -project spec/test_fixtures/Fixtures/Fixtures.xcodeproj/ -scheme Fixtures -sdk iphonesimulator #{extra_test_flags}`
     exitstatus = $?.exitstatus
     files_to_lines_to_warnings_hash = {}
     output.split("\n").each do |line|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mayday
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mark Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: '0.20'
 description: Custom warnings and errors
 email:
 - larse503@gmail.com
@@ -137,6 +137,7 @@ files:
 - README.md
 - Rakefile
 - bin/mayday
+- docs/Cookbook.md
 - docs/example.jpg
 - docs/example_inline.jpg
 - lib/mayday.rb