motion-logger 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+vendor/Pods/Pods.xcodeproj/project.pbxproj 
+Gemfile.lock
+.repl_history
+build
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# motion-logger
+
+A thin wrapper of CocoaLumberjack for RubyMotion.
+
+Status: Basic features working
+
+## Usage
+
+```ruby
+file_logger = DDFileLogger.new
+file_logger.rollingFrequency = 60 * 60 * 24
+file_logger.logFileManager.maximumNumberOfLogFiles = 1
+Log.addLogger file_logger
+
+tty_logger = DDTTYLogger.sharedInstance
+Log.addLogger tty_logger
+
+Log.level = :warn
+
+Log.info "Hello World"
+Log.warn "WARNING!"
+Log.debug "Lah"
+Log.flush
+```
+
+## Setup
+
+Install the gem:
+
+```
+gem install motion-logger
+```
+
+Require the gem in Rakefile:
+
+```
+require 'rubygems'
+require 'motion-logger'
+
+Motion::Project::App.setup do |app|
+  app.name = 'MyApp'
+
+  # Only needed if you are not already using pods
+  app.pods do
+    dependency 'CocoaLumberjack'
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require 'rubygems'
+require 'motion-cocoapods'
+require 'motion-redgreen'
+require './lib/motion-logger'
+
+Motion::Project::App.setup do |app|
+  app.name = 'logger'
+
+  app.pods do
+    dependency 'CocoaLumberjack'
+  end
+end

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    true
+  end
+end

data/lib/logger/log.rb

@@ -0,0 +1,85 @@
+module LoggerClassMethods
+  FLAGS = {
+    :error    => (1<<0),   # 0...0001
+    :warn     => (1<<1),    # 0...0010
+    :info     => (1<<2),    # 0...0100
+    :verbose  => (1<<3), # 0...1000
+    :debug    => (1<<3)    # 0...1000
+  }
+  
+  LEVELS = {
+    :off      => 0,
+    :error    => FLAGS[:error],
+    :warn     => FLAGS[:error] | FLAGS[:warn],
+    :info     => FLAGS[:error] | FLAGS[:warn] | FLAGS[:info],
+    :verbose  => FLAGS[:error] | FLAGS[:warn] | FLAGS[:info] | FLAGS[:verbose],
+    :debug    => FLAGS[:error] | FLAGS[:warn] | FLAGS[:info] | FLAGS[:verbose]
+  }
+
+  def level=(level)
+    @level = level
+  end
+  
+  def level
+    @level
+  end
+
+  def async=(async)
+    @async = async
+  end
+  
+  def async
+    @async
+  end
+
+  def error(message)
+    __log(:error, message)
+  end
+
+  def warn(message)
+    __log(:warn, message)
+  end
+  
+  def info(message)
+    __log(:info, message)
+  end
+  
+  def debug(message)
+    __log(:verbose, message)
+  end
+  alias_method :verbose, :debug
+  
+  def logging?(flag)
+    (LEVELS[level] & FLAGS[flag]) > 0
+  end
+
+  protected
+  def __log(flag, message)
+    return unless logging?(flag)
+    raise ArgumentError, "flag must be one of #{FLAGS.keys}" unless FLAGS.keys.include?(flag)
+    async_enabled = self.async || (self.level == :error)
+
+    log(async_enabled, 
+      level:LEVELS[level], 
+      flag:FLAGS[flag], 
+      context:0, 
+      file:__FILE__, 
+      function:__method__, 
+      line:__LINE__, 
+      tag:0, 
+      format:message)
+  end
+end
+
+module Motion
+  class Log < DDLog
+    class << self
+      alias_method :flush, :flushLog
+    end
+
+    extend LoggerClassMethods
+
+    @async = true
+    @level = :info
+  end
+end

data/lib/logger/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module Logger
+    VERSION = "0.1.0"
+  end
+end

data/lib/motion-logger.rb

@@ -0,0 +1,14 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+require 'motion-cocoapods'
+
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.dirname(__FILE__), 'logger/*.rb')).each do |file|
+    app.files.unshift file
+  end
+
+  app.pods ||= Motion::Project::CocoaPods.new(app)
+  app.pods.dependency 'CocoaLumberjack'
+end

data/motion-logger.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/logger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Francis Chong"]
+  gem.email         = ["francis@ignition.hk"]
+  gem.description   = "A thin wrapper of CocoaLumberjack for RubyMotion."
+  gem.summary       = "A thin wrapper of CocoaLumberjack for RubyMotion."
+  gem.homepage      = "https://github.com/siuying/motion-logger"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "motion-logger"
+  gem.require_paths = ["lib"]
+  gem.version       = Motion::Logger::VERSION
+
+  gem.add_dependency 'motion-cocoapods', '>= 1.0.3'
+  gem.add_development_dependency 'motion-redgreen'
+end

data/spec/log_spec.rb

@@ -0,0 +1,41 @@
+describe "Motion::Log" do
+  Log = Motion::Log
+
+  before do
+    @file_logger = DDFileLogger.new
+    @file_logger.rollingFrequency = 60 * 60 * 24
+    @file_logger.logFileManager.maximumNumberOfLogFiles = 1
+    Log.addLogger @file_logger    
+  end
+
+  after do
+    Log.flush
+    @file_logger.logFileManager.unsortedLogFilePaths.each do |file|
+      File.delete(file)
+    end
+    Log.removeAllLoggers
+  end
+
+  describe "FileLogger" do
+    it "should log with specific levels" do
+      Log.level = :warn
+
+      Log.info "Hello World"
+      Log.warn "WARNING!"
+
+      Log.level = :info
+      Log.info "Foo"
+      Log.debug "Lah"
+      Log.flush
+
+      file = @file_logger.logFileManager.sortedLogFilePaths.first
+      logs = open(file).read
+      logs.should.not.be.nil
+      logs.should.not.include "Hello World"
+      logs.should.include "WARNING!"
+      logs.should.include "Foo"
+      logs.should.not.include "Lah"
+    end
+  end
+
+end

data/vendor/Podfile.lock

@@ -0,0 +1,6 @@
+PODS:
+  - CocoaLumberjack (1.3.3)
+
+DEPENDENCIES:
+  - CocoaLumberjack
+  - CocoaLumberjack

data/vendor/Pods/CocoaLumberjack/.gitignore

@@ -0,0 +1,24 @@
+# Xcode
+build/*
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+*.xcworkspace
+!default.xcworkspace
+xcuserdata
+profile
+*.moved-aside
+.DS_Store?
+Icon?
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes

data/vendor/Pods/CocoaLumberjack/.hgignore

@@ -0,0 +1,6 @@
+syntax: glob
+
+Xcode/*/build
+*.pbxuser
+*.mode1v3
+*.xcuserdatad

data/vendor/Pods/CocoaLumberjack/CocoaLumberjack.podspec

@@ -0,0 +1,18 @@
+Pod::Spec.new do |s|
+  s.name     = 'CocoaLumberjack'
+  s.version  = '1.3.1'
+  s.license  = 'BSD'
+  s.summary  = 'A fast & simple, yet powerful & flexible logging framework for Mac and iOS.'
+  s.homepage = 'https://github.com/robbiehanson/CocoaLumberjack'
+  s.author   = { 'Robbie Hanson' => 'robbiehanson@deusty.com' }
+  s.source   = { :git => 'https://github.com/robbiehanson/CocoaLumberjack.git',
+                 :tag => '1.3.1' }
+
+  s.description = 'It is similar in concept to other popular logging frameworks such as log4j, '   \
+                  'yet is designed specifically for objective-c, and takes advantage of features ' \
+                  'such as multi-threading, grand central dispatch (if available), lockless '      \
+                  'atomic operations, and the dynamic nature of the objective-c runtime.'
+
+  s.source_files = 'Lumberjack'
+  s.clean_paths = 'Benchmarking', 'Xcode'
+end

data/vendor/Pods/CocoaLumberjack/LICENSE.txt

@@ -0,0 +1,18 @@
+Software License Agreement (BSD License)
+
+Copyright (c) 2010, Deusty, LLC
+All rights reserved.
+
+Redistribution and use of this software in source and binary forms,
+with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above
+  copyright notice, this list of conditions and the
+  following disclaimer.
+
+* Neither the name of Deusty nor the names of its
+  contributors may be used to endorse or promote products
+  derived from this software without specific prior
+  written permission of Deusty, LLC.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/vendor/Pods/CocoaLumberjack/Lumberjack/DDASLLogger.h

@@ -0,0 +1,41 @@
+#import <Foundation/Foundation.h>
+#import <asl.h>
+
+#import "DDLog.h"
+
+/**
+ * Welcome to Cocoa Lumberjack!
+ * 
+ * The project page has a wealth of documentation if you have any questions.
+ * https://github.com/robbiehanson/CocoaLumberjack
+ * 
+ * If you're new to the project you may wish to read the "Getting Started" wiki.
+ * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted
+ * 
+ * 
+ * This class provides a logger for the Apple System Log facility.
+ * 
+ * As described in the "Getting Started" page,
+ * the traditional NSLog() function directs it's output to two places:
+ * 
+ * - Apple System Log
+ * - StdErr (if stderr is a TTY) so log statements show up in Xcode console
+ * 
+ * To duplicate NSLog() functionality you can simply add this logger and a tty logger.
+ * However, if you instead choose to use file logging (for faster performance),
+ * you may choose to use a file logger and a tty logger.
+**/
+
+@interface DDASLLogger : DDAbstractLogger <DDLogger>
+{
+	aslclient client;
+}
+
++ (DDASLLogger *)sharedInstance;
+
+// Inherited from DDAbstractLogger
+
+// - (id <DDLogFormatter>)logFormatter;
+// - (void)setLogFormatter:(id <DDLogFormatter>)formatter;
+
+@end

data/vendor/Pods/CocoaLumberjack/Lumberjack/DDASLLogger.m

@@ -0,0 +1,99 @@
+#import "DDASLLogger.h"
+
+#import <libkern/OSAtomic.h>
+
+/**
+ * Welcome to Cocoa Lumberjack!
+ * 
+ * The project page has a wealth of documentation if you have any questions.
+ * https://github.com/robbiehanson/CocoaLumberjack
+ * 
+ * If you're new to the project you may wish to read the "Getting Started" wiki.
+ * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted
+**/
+
+#if ! __has_feature(objc_arc)
+#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC).
+#endif
+
+
+@implementation DDASLLogger
+
+static DDASLLogger *sharedInstance;
+
+/**
+ * The runtime sends initialize to each class in a program exactly one time just before the class,
+ * or any class that inherits from it, is sent its first message from within the program. (Thus the
+ * method may never be invoked if the class is not used.) The runtime sends the initialize message to
+ * classes in a thread-safe manner. Superclasses receive this message before their subclasses.
+ *
+ * This method may also be called directly (assumably by accident), hence the safety mechanism.
+**/
++ (void)initialize
+{
+	static BOOL initialized = NO;
+	if (!initialized)
+	{
+		initialized = YES;
+		
+		sharedInstance = [[DDASLLogger alloc] init];
+	}
+}
+
++ (DDASLLogger *)sharedInstance
+{
+	return sharedInstance;
+}
+
+- (id)init
+{
+	if (sharedInstance != nil)
+	{
+		return nil;
+	}
+	
+	if ((self = [super init]))
+	{
+		// A default asl client is provided for the main thread,
+		// but background threads need to create their own client.
+		
+		client = asl_open(NULL, "com.apple.console", 0);
+	}
+	return self;
+}
+
+- (void)logMessage:(DDLogMessage *)logMessage
+{
+	NSString *logMsg = logMessage->logMsg;
+	
+	if (formatter)
+	{
+		logMsg = [formatter formatLogMessage:logMessage];
+	}
+	
+	if (logMsg)
+	{
+		const char *msg = [logMsg UTF8String];
+		
+		int aslLogLevel;
+		switch (logMessage->logLevel)
+		{
+			// Note: By default ASL will filter anything above level 5 (Notice).
+			// So our mappings shouldn't go above that level.
+			
+			case 1  : aslLogLevel = ASL_LEVEL_CRIT;    break;
+			case 2  : aslLogLevel = ASL_LEVEL_ERR;     break;
+			case 3  : aslLogLevel = ASL_LEVEL_WARNING; break;
+			default : aslLogLevel = ASL_LEVEL_NOTICE;  break;
+		}
+		
+		asl_log(client, NULL, aslLogLevel, "%s", msg);
+	}
+}
+
+- (NSString *)loggerName
+{
+	return @"cocoa.lumberjack.aslLogger";
+}
+
+@end

data/vendor/Pods/CocoaLumberjack/Lumberjack/DDAbstractDatabaseLogger.h

@@ -0,0 +1,102 @@
+#import <Foundation/Foundation.h>
+
+#import "DDLog.h"
+
+/**
+ * Welcome to Cocoa Lumberjack!
+ * 
+ * The project page has a wealth of documentation if you have any questions.
+ * https://github.com/robbiehanson/CocoaLumberjack
+ * 
+ * If you're new to the project you may wish to read the "Getting Started" wiki.
+ * https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted
+ * 
+ * 
+ * This class provides an abstract implementation of a database logger.
+ * 
+ * That is, it provides the base implementation for a database logger to build atop of.
+ * All that is needed for a concrete database logger is to extend this class
+ * and override the methods in the implementation file that are prefixed with "db_".
+**/
+
+@interface DDAbstractDatabaseLogger : DDAbstractLogger {
+@protected
+	NSUInteger saveThreshold;
+	NSTimeInterval saveInterval;
+	NSTimeInterval maxAge;
+	NSTimeInterval deleteInterval;
+	BOOL deleteOnEverySave;
+	
+	BOOL saveTimerSuspended;
+	NSUInteger unsavedCount;
+	dispatch_time_t unsavedTime;
+	dispatch_source_t saveTimer;
+	dispatch_time_t lastDeleteTime;
+	dispatch_source_t deleteTimer;
+}
+
+/**
+ * Specifies how often to save the data to disk.
+ * Since saving is an expensive operation (disk io) it is not done after every log statement.
+ * These properties allow you to configure how/when the logger saves to disk.
+ * 
+ * A save is done when either (whichever happens first):
+ * 
+ * - The number of unsaved log entries reaches saveThreshold
+ * - The amount of time since the oldest unsaved log entry was created reaches saveInterval
+ * 
+ * You can optionally disable the saveThreshold by setting it to zero.
+ * If you disable the saveThreshold you are entirely dependent on the saveInterval.
+ * 
+ * You can optionally disable the saveInterval by setting it to zero (or a negative value).
+ * If you disable the saveInterval you are entirely dependent on the saveThreshold.
+ * 
+ * It's not wise to disable both saveThreshold and saveInterval.
+ * 
+ * The default saveThreshold is 500.
+ * The default saveInterval is 60 seconds.
+**/
+@property (assign, readwrite) NSUInteger saveThreshold;
+@property (assign, readwrite) NSTimeInterval saveInterval;
+
+/**
+ * It is likely you don't want the log entries to persist forever.
+ * Doing so would allow the database to grow infinitely large over time.
+ * 
+ * The maxAge property provides a way to specify how old a log statement can get
+ * before it should get deleted from the database.
+ * 
+ * The deleteInterval specifies how often to sweep for old log entries.
+ * Since deleting is an expensive operation (disk io) is is done on a fixed interval.
+ * 
+ * An alternative to the deleteInterval is the deleteOnEverySave option.
+ * This specifies that old log entries should be deleted during every save operation.
+ * 
+ * You can optionally disable the maxAge by setting it to zero (or a negative value).
+ * If you disable the maxAge then old log statements are not deleted.
+ * 
+ * You can optionally disable the deleteInterval by setting it to zero (or a negative value).
+ * 
+ * If you disable both deleteInterval and deleteOnEverySave then old log statements are not deleted.
+ * 
+ * It's not wise to enable both deleteInterval and deleteOnEverySave.
+ * 
+ * The default maxAge is 7 days.
+ * The default deleteInterval is 5 minutes.
+ * The default deleteOnEverySave is NO.
+**/
+@property (assign, readwrite) NSTimeInterval maxAge;
+@property (assign, readwrite) NSTimeInterval deleteInterval;
+@property (assign, readwrite) BOOL deleteOnEverySave;
+
+/**
+ * Forces a save of any pending log entries (flushes log entries to disk).
+**/
+- (void)savePendingLogEntries;
+
+/**
+ * Removes any log entries that are older than maxAge.
+**/
+- (void)deleteOldLogEntries;
+
+@end