rucola 0.0.3 → 0.5.0

data/lib/rucola/log.rb

@@ -0,0 +1,61 @@
+require 'singleton'
+
+module Rucola
+  # The Log class is basically a wrapper around NSLog. It is a singleton class so you should get an instance using the instance
+  # class method instead of new.
+  #
+  #   Rucola::Log.instance.fatal("Couldn't initialize application.")
+  #
+  # The Log class is generally accessed through the log method on Kernel.
+  #
+  #   log.debug("%d exceptions caught, giving up", exceptions.length)
+  class Log
+    DEBUG = 0
+    INFO = 1
+    WARN = 2
+    ERROR = 3
+    FATAL = 4
+    UNKNOWN = 5
+    SILENT = 9
+    
+    include Singleton
+    
+    # Holds the current log level
+    attr_accessor :level
+    
+    # Creates a new Log instance. Don't call this directly, call instance instead.
+    #
+    #   log.instance
+    def initialize
+      @level = level_for_env
+    end
+    
+    def debug(*args); log(DEBUG, *args); end
+    def info(*args); log(INFO, *args); end
+    def warn(*args); log(WARN, *args); end
+    def error(*args); log(ERROR, *args); end
+    def fatal(*args); log(FATAL, *args); end
+    def unknown(*args); log(UNKNOWN, *args); end
+    
+    # Returns default log level for the application environment.
+    #
+    #   log.level_for_env #=> Log::ERROR
+    def level_for_env
+      case RCApp.env
+      when 'test'
+        SILENT
+      when 'debug'
+        DEBUG
+      when 'release'
+        ERROR
+      end
+    end
+    
+    # Writes a message to the log is the current loglevel is equal or greater than the message_level.
+    #
+    #   log.log(Log::DEBUG, "This is a debug message")
+    def log(message_level, *args)
+      OSX.NSLog(*args) if message_level >= level
+    end
+  end
+end

data/lib/rucola/nib.rb

@@ -2,7 +2,7 @@ require 'osx/cocoa'
 require 'fileutils'
 
 module Rucola
-  module Nib
+  module Nib  #:nodoc:
     
     def self.backup(path)
       nib = File.dirname(path)
@@ -18,7 +18,7 @@ module Rucola
       FileUtils.cp_r(nib, backup)
     end
     
-    class Classes
+    class Classes #:nodoc:
       attr_reader :data
       
       def self.open(classes_nib_path)
@@ -53,7 +53,7 @@ module Rucola
       
     end
     
-    class KeyedObjects
+    class KeyedObjects #:nodoc:
       attr_reader :data
       
       def self.open(path)

data/lib/rucola/reloader.rb

@@ -0,0 +1,39 @@
+require 'rucola/fsevents'
+require 'rubynode'
+
+module Rucola
+  # The +Reloader+ watches the app/controllers path and reloads
+  # a class if it notices that a file has been changed.
+  module Reloader
+    class << self
+      # Start watching app/controllers for a file modification and reload that class.
+      def start!
+        Rucola::FSEvents.start_watching(Rucola::RCApp.controllers_path, Rucola::RCApp.models_path) do |events|
+          events.each { |event| reload(event.last_modified_file) }
+        end
+      end
+      
+      # Reload a file (class).
+      def reload(file)
+        klass = File.to_const(file)
+        begin
+          File.read(file).parse_to_nodes
+          
+          log.debug "Reloading class #{klass.name}:"
+          
+          i_methods = klass.instance_methods(false)
+          log.debug "- Undefining instance methods: #{i_methods.inspect}"
+          i_methods.each { |mname| klass.send(:undef_method, mname) }
+          
+          c_methods = klass.original_class_methods
+          log.debug "- Undefining class methods: #{c_methods.inspect}"
+          c_methods.each { |mname| klass.metaclass.send(:undef_method, mname) }
+          
+          Kernel.load(file)
+        rescue SyntaxError => e
+          log.error "WARNING: Reloading the class #{klass.name} would have caused a parse error:\n#{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/rucola/ruby_debug.rb

@@ -0,0 +1,27 @@
+module Kernel
+  def debugger(steps = 1); end
+end
+
+module Rucola
+  module Debugger
+    def self.use! #:nodoc:
+      Kernel.module_eval do
+        # If enabled in the Configuration (default in `debug` environment is on), calling #debugger will try to load the ruby-debug gem.
+        # In other modes however any call to #debugger will be ignored.
+        # However, for performance reasons you still might want to take out any calls in a release build.
+        def debugger(steps = 1)
+          rucola_load_ruby_debug(steps)
+        end
+        
+        private
+        
+        def rucola_load_ruby_debug(steps) #:nodoc:
+          require 'ruby-debug'
+          debugger(steps)
+        rescue LoadError
+          log.error "The ruby-debug gem is needed to be able to use the debugger, but it wasn't found."
+        end
+      end
+    end
+  end
+end

data/lib/rucola/rucola_support.rb

@@ -1,5 +1,4 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$:.unshift(File.dirname(__FILE__)) #unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'rucola_support/rc_app'
 require 'rucola_support/initialize_hooks'

data/lib/rucola/rucola_support/core_ext.rb

@@ -1,2 +1,4 @@
-require 'rucola_support/core_ext/ruby'
-require 'rucola_support/core_ext/objc'
+$:.unshift(File.dirname(__FILE__))
+
+require 'core_ext/ruby'
+require 'core_ext/objc'

data/lib/rucola/rucola_support/core_ext/objc.rb

@@ -1,4 +1,9 @@
-Dir[File.dirname(__FILE__) + "/objc/*.rb"].sort.each do |path|
-  filename = File.basename(path)
-  require "rucola_support/core_ext/objc/#{filename}"
-end
+# Dir[File.dirname(__FILE__) + "/objc/*.rb"].sort.each do |path|
+#   filename = File.basename(path)
+#   require "rucola_support/core_ext/objc/#{filename}"
+# end
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'objc/nsimage'
+require 'objc/nsobject'

data/lib/rucola/rucola_support/core_ext/objc/nsimage.rb

@@ -0,0 +1,22 @@
+class OSX::NSImage
+  class << self
+    # This implementation adds app/assets to the search domain.
+    # So if for instance you have an image app/assets/some_img.png,
+    # you can then use OSX::NSImage.imageNamed('some_img') and it will be found.
+    def imageNamed(name)
+      if @assets_files.nil?
+        @assets_files = {}
+        Dir.glob("#{Rucola::RCApp.assets_path}/*.*").each do |file|
+          basename = File.basename(file).gsub(/\..*/, '')
+          @assets_files[basename] = file
+        end
+      end
+    
+      if image_file = (@assets_files[name.to_s] || @assets_files[name.to_s.gsub(/\..*/, '')])
+        alloc.initWithContentsOfFile image_file
+      else
+        super_imageNamed(name)
+      end
+    end
+  end
+end

data/lib/rucola/rucola_support/core_ext/ruby.rb

@@ -1,4 +1,11 @@
-Dir[File.dirname(__FILE__) + "/ruby/*.rb"].sort.each do |path|
-  filename = File.basename(path)
-  require "rucola_support/core_ext/ruby/#{filename}"
-end
+# Dir[File.dirname(__FILE__) + "/ruby/*.rb"].sort.each do |path|
+#   filename = File.basename(path)
+#   require "rucola_support/core_ext/ruby/#{filename}"
+# end
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'ruby/file'
+require 'ruby/object'
+require 'ruby/string'
+require 'ruby/kernel'

data/lib/rucola/rucola_support/core_ext/ruby/file.rb

@@ -0,0 +1,11 @@
+class File
+  class << self
+    # Returns the constant version of the file that is referred to.
+    #
+    #   File.to_const("/some/path/foo_bar_controller.rb") # => FooBarController
+    def to_const(file)
+      file.match /(\w+)\.\w*$/
+      $1.to_const
+    end
+  end
+end

data/lib/rucola/rucola_support/core_ext/ruby/kernel.rb

@@ -0,0 +1,16 @@
+require 'rucola/log'
+
+module Kernel
+  # Returns a logger instance
+  #
+  # Examples:
+  #
+  #   log.level = Rucola::Log::DEBUG
+  #   log.info "Couldn't load preferences, using defaults"
+  #   log.debug "Initiating primary foton drive…"
+  #
+  # For more information see the Rucola::Log class.
+  def log
+    Rucola::Log.instance
+  end
+end

data/lib/rucola/rucola_support/core_ext/ruby/object.rb

@@ -0,0 +1,47 @@
+class Object
+  # Returns a class's metaclass.
+  #
+  #   class FooBar; end
+  #   p FooBar.metaclass # => #<Class:FooBar>
+  def self.metaclass
+    class << self; self; end
+  end
+  
+  # Returns an array of all the class methods that were added by extending the class.
+  #
+  #  class FooBar; end
+  #
+  #  module Baz
+  #    def a_new_class_method; end
+  #  end
+  #  FooBar.extend(Baz)
+  #
+  #  FooBar.extended_class_methods # => ['a_new_class_method']
+  def self.extended_class_methods
+    metaclass.included_modules.map { |mod| mod.instance_methods }.flatten.uniq
+  end
+  
+  # Returns an array of all the class methods that were defined in this class
+  # without the ones that were defined in it's superclasses.
+  #
+  #  class FooBar
+  #    def self.a_original_class_method
+  #    end
+  #  end
+  #
+  #  class FooBarSubclass < FooBar
+  #    def self.a_original_class_method_in_a_subclass
+  #    end
+  #  end
+  #
+  #  FooBarSubclass.own_class_methods # => ['a_original_class_method_in_a_subclass']
+  def self.own_class_methods
+    metaclass.instance_methods - superclass.metaclass.instance_methods
+  end
+  
+  # Returns an array of all the class methods that were defined in only this class,
+  # so without class methods from any of it's superclasses or from extending it.
+  def self.original_class_methods
+    own_class_methods - extended_class_methods
+  end
+end

data/lib/rucola/rucola_support/core_ext/ruby/string.rb

@@ -18,4 +18,12 @@ class String
       end
     end
   end
+  
+  # Returns the constant that this string refers to.
+  #
+  #  "FooBar".to_const # => FooBar
+  #  "foo_bar".to_const # => FooBar
+  def to_const
+    Object.const_get(camel_case)
+  end
 end

data/lib/rucola/rucola_support/notifications/notifications.rb

@@ -1,34 +1,32 @@
 require 'osx/cocoa'
 
 module Rucola
-  module Notifications
-    # This Notifications module will add a class method called +notify_on+, which registers
-    # your object for the given notification and executes the given block when the
-    # notification is posted to the OSX::NSNotificationCenter.defaultCenter.
-    #
-    #   class FooController < OSX::NSObject
-    #
-    #     notify_on OSX::NSApplicationDidFinishLaunchingNotification do |notification|
-    #       puts "Application did finish launching."
-    #       p notification
-    #     end
-    #
-    #     # code
-    #
-    #   end
-    #   
-    #   In addition to notify_on, you also get a method called notify which allows you to specify methods
-    #   to be invoked when a notification is posted.
-    #     
-    #     class FooController < OSX::NSObject
-    #       notify :some_method, :when => :application_did_finish_launching
-    #     
-    #       def some_method(notification)
-    #         puts "Application finished launching"
-    #       end
-    #     end
-
-
+  module Notifications #:nodoc:
+      # This Notifications module will add a class method called +notify_on+, which registers
+      # your object for the given notification and executes the given block when the
+      # notification is posted to the OSX::NSNotificationCenter.defaultCenter.
+      #
+      #   class FooController < OSX::NSObject
+      #
+      #     notify_on OSX::NSApplicationDidFinishLaunchingNotification do |notification|
+      #       puts "Application did finish launching."
+      #       p notification
+      #     end
+      #
+      #     # code
+      #
+      #   end
+      #   
+      #   In addition to notify_on, you also get a method called notify which allows you to specify methods
+      #   to be invoked when a notification is posted.
+      #     
+      #     class FooController < OSX::NSObject
+      #       notify :some_method, :when => :application_did_finish_launching
+      #     
+      #       def some_method(notification)
+      #         puts "Application finished launching"
+      #       end
+      #     end
       module ClassMethods
         # Add prefix shortcuts as a hash.
         #

data/lib/rucola/rucola_support/rc_app.rb

@@ -2,6 +2,16 @@ require 'rucola/info_plist'
 
 module Rucola
   module RCApp
+    # Returns the current RUBYCOCOA_ENV, which normally is 'debug' during development, test in the tests and 'release' in a release.
+    def env; RUBYCOCOA_ENV; end
+    module_function :env
+    def test?; env == 'test'; end
+    module_function :test?
+    def debug?; env == 'debug'; end
+    module_function :debug?
+    def release?; env == 'release'; end
+    module_function :release?
+    
     # Returns the path to the current source root of the application.
     #
     # So in debug & test mode this will point to your development source root.
@@ -106,5 +116,13 @@ module Rucola
       Rucola::InfoPlist.open((RUBYCOCOA_ROOT + 'config/Info.plist').to_s).app_name
     end
     module_function :app_name
+    
+    # Returns the path to the application support directory for this application.
+    #
+    #   Rucola::RCApp.application_support_path #=> '/Users/eddy/Library/Application Support/MyApp/'
+    def application_support_path
+      File.join File.expand_path('~/Library/Application Support'), app_name
+    end
+    module_function :application_support_path
   end
 end

data/lib/rucola/tasks/dependencies.rake

@@ -0,0 +1,49 @@
+require 'rucola/dependencies'
+
+namespace :dependencies do
+  THIRD_PARTY_DIR = (SOURCE_ROOT + '/vendor/third_party/').to_s
+  
+  def dependencies_holder
+    deps = Rucola::Dependencies.load((SOURCE_ROOT + '/config/dependencies.rb').to_s)
+    deps.resolve!
+    deps
+  end
+  
+  def file_types
+    if ENV['FILE_TYPES']
+      ENV['FILE_TYPES'].split(',').map {|t| t.strip.to_sym }
+    else
+      CONFIGURATION.dependency_types
+    end
+  end
+  
+  desc "Lists all the dependencies and their required files. Use the FILE_TYPES env var to specify which files you'd like to include."
+  task :list do
+    Rucola::Dependencies.verbose = false
+    
+    str = ''
+    dependencies_holder.dependencies.each do |dep|
+      str += "\nDependency '#{dep.pretty_print_name}' requires the following files:\n\n"
+      dep.required_files_of_types(file_types).each { |file| str += "  #{file.full_path}\n" }
+    end
+    puts str
+  end
+  
+  desc "Copies all the required files to 'vendor/third_party/'."
+  task :copy do
+    # Check if we have enough info to do a copy
+    if file_types.is_a?(Symbol) or !file_types.empty?
+      FileUtils.mkdir_p(THIRD_PARTY_DIR) unless File.exist?(THIRD_PARTY_DIR)
+      $VERBOSE = nil # we don't want all the warnings about constant being redefined.
+      dependencies_holder.copy_to(THIRD_PARTY_DIR, :types => file_types)
+    end
+  end
+  
+  desc "Removes the 'vendor/third_party/' directory."
+  task :clean do
+    if File.exist? THIRD_PARTY_DIR
+      puts "Removing #{THIRD_PARTY_DIR}"
+      FileUtils.rm_rf(THIRD_PARTY_DIR)
+    end
+  end
+end