RubyGems - rucola - Versions diffs - 0.0.3 → 0.5.0 - Mend

rucola 0.0.3 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

data/ChangeLog +468 -0
data/History.txt +25 -0
data/License.txt +1 -1
data/Manifest.txt +32 -0
data/README.txt +9 -67
data/Rakefile +39 -31
data/TODO +10 -18
data/app_generators/rucola/rucola_generator.rb +15 -8
data/app_generators/rucola/templates/Rakefile.erb +35 -7
data/app_generators/rucola/templates/config/boot.rb +0 -1
data/app_generators/rucola/templates/config/dependencies.rb +31 -0
data/app_generators/rucola/templates/config/environment.rb +0 -1
data/app_generators/rucola/templates/config/environments/debug.rb +13 -1
data/app_generators/rucola/templates/config/environments/release.rb +15 -1
data/app_generators/rucola/templates/config/environments/test.rb +7 -1
data/app_generators/rucola/templates/misc/rb_main.rb.erb +12 -1
data/app_generators/rucola/templates/project.pbxproj.erb +4 -0
data/app_generators/rucola/templates/script/console +10 -0
data/app_generators/rucola/templates/test/controllers/test_application_controller.rb +22 -10
data/app_generators/rucola/templates/test/test_helper.rb +1 -0
data/bin/rucola +4 -2
data/lib/rucola/dependencies.rb +241 -0
data/lib/rucola/dependencies/exclusions.rb +20 -0
data/lib/rucola/dependencies/override_require_and_gem.rb +30 -0
data/lib/rucola/dependencies/resolver.rb +68 -0
data/lib/rucola/fsevents.rb +108 -0
data/lib/rucola/initializer.rb +149 -117
data/lib/rucola/log.rb +61 -0
data/lib/rucola/nib.rb +3 -3
data/lib/rucola/reloader.rb +39 -0
data/lib/rucola/ruby_debug.rb +27 -0
data/lib/rucola/rucola_support.rb +1 -2
data/lib/rucola/rucola_support/core_ext.rb +4 -2
data/lib/rucola/rucola_support/core_ext/objc.rb +9 -4
data/lib/rucola/rucola_support/core_ext/objc/nsimage.rb +22 -0
data/lib/rucola/rucola_support/core_ext/ruby.rb +11 -4
data/lib/rucola/rucola_support/core_ext/ruby/file.rb +11 -0
data/lib/rucola/rucola_support/core_ext/ruby/kernel.rb +16 -0
data/lib/rucola/rucola_support/core_ext/ruby/object.rb +47 -0
data/lib/rucola/rucola_support/core_ext/ruby/string.rb +8 -0
data/lib/rucola/rucola_support/notifications/notifications.rb +26 -28
data/lib/rucola/rucola_support/rc_app.rb +18 -0
data/lib/rucola/tasks/dependencies.rake +49 -0
data/lib/rucola/tasks/deploy.rake +131 -0
data/lib/rucola/tasks/main.rake +39 -6
data/lib/rucola/tasks/xcode.rake +54 -11
data/lib/rucola/test_case.rb +138 -0
data/lib/rucola/test_helper.rb +11 -5
data/lib/rucola/version.rb +2 -2
data/lib/rucola/xcode.rb +39 -9
data/rucola_generators/controller/templates/test_controller_template.rb.erb +19 -7
data/rucola_generators/simple_model/USAGE +5 -0
data/rucola_generators/simple_model/simple_model_generator.rb +54 -0
data/rucola_generators/simple_model/templates/simple_model.rb.erb +2 -0
data/rucola_generators/simple_model/templates/test_simple_model.rb.erb +11 -0
data/rucola_generators/window_controller/templates/test_window_controller_template.rb.erb +24 -13
data/test/fixtures/dependencies/foo.rb +2 -0
data/test/fixtures/dependencies/foo/bar.rb +0 -0
data/test/fixtures/dependencies/foo/baz.rb +0 -0
data/test/fixtures/dependencies/requires_fileutils.rb +1 -0
data/test/fixtures/some_reloadable_class.rb +4 -0
data/test/test_core_ext.rb +80 -0
data/test/test_dependencies.rb +205 -0
data/test/test_fsevents.rb +152 -0
data/test/test_helper.rb +30 -1
data/test/test_initializer.rb +56 -23
data/test/test_log.rb +44 -0
data/test/test_objc_core_ext.rb +23 -0
data/test/test_rc_app.rb +5 -0
data/test/test_reloader.rb +28 -0
data/test/test_rucola_generator.rb +7 -0
data/test/test_simple_model_generator.rb +48 -0
data/test/test_xcode.rb +85 -5
data/website/index.html +17 -91
data/website/index.txt +14 -81
data/website/template.rhtml +1 -1
metadata +120 -76

data/lib/rucola/tasks/deploy.rake ADDED

@@ -0,0 +1,131 @@
+require 'uri'
+namespace :deploy do
+  DEPLOY_NAME = "#{APPNAME}_#{APPVERSION}"
+  PKG = File.join('pkg', "#{DEPLOY_NAME}.dmg")
+  directory 'pkg'
+  desc "Package the application as a disk image"
+  task :package => :pkg do
+    FileUtils.rm(PKG) if File.exist?(PKG)
+    puts 'Creating Image...'
+    sh "hdiutil create -volname '#{DEPLOY_NAME}' -srcfolder 'build/Release/#{TARGET}' '#{PKG}'"
+    puts ''
+  end
+  desc "Write a new appcast rss file"
+  task :sparkle_appcast => :pkg do
+    check_if_sparkle_info_exists!
+    puts "Creating appcast..."
+    appcast_filename = File.basename(INFO_PLIST['SUFeedURL'])
+    appcast = %{
+<?xml version="1.0" encoding="utf-8"?>
+<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle">
+  <channel>
+    <title>#{APPNAME} Changelog</title>
+    <link>#{INFO_PLIST['SUFeedURL']}</link>
+    <description>#{INFO_PLIST['SUAppDescription']}</description>
+    <language>en</language>
+    <item>
+      <title>#{APPNAME} - #{APPVERSION}</title>
+      <description>#{INFO_PLIST['SUPublicReleaseNotesURL']}#{DEPLOY_NAME}_release_notes.html</description>
+      <pubDate>#{Time.now}</pubDate>
+      <enclosure url="#{INFO_PLIST['SUPublicReleaseURL']}#{DEPLOY_NAME}.dmg" length="#{File.size(PKG)}" type="application/octet-stream"/>
+    </item>
+  </channel>
+</rss>}.sub(/^\n/, '')
+    File.open("pkg/#{appcast_filename}", 'w') { |f| f.write appcast }
+    puts "created: pkg/#{appcast_filename}\n\n"
+  end
+  desc "Write a new release notes html file. Looks for ReleaseNotes/#{DEPLOY_NAME}"
+  task :release_notes => :pkg do
+    begin
+      require 'RedCloth'
+    rescue LoadError
+      puts "Unable write the release notes html, because the RedCloth gem was not found."
+      exit
+    end
+    puts "Creating release notes..."
+    changelog = File.join(SOURCE_ROOT, 'ReleaseNotes', DEPLOY_NAME)
+    body = RedCloth.new(File.read(changelog))
+    html = %{
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <body>
+    #{body.to_html}
+  </body>
+</html>
+    }.sub(/^\n/, '').gsub(/\t/, '    ').gsub(/\n+/, "\n")
+    File.open("pkg/#{DEPLOY_NAME}_release_notes.html", 'w') { |f| f.write html }
+    puts "created: pkg/#{DEPLOY_NAME}_release_notes.html\n\n"
+  end
+  desc 'Removes the pkg/ directory.'
+  task :clean do
+    build_dir = 'pkg/'
+    if File.exist? build_dir
+      puts "Removing #{build_dir}"
+      FileUtils.rm_rf build_dir
+    end
+  end
+  desc "Upload pkg/ files. Specify the uri's with the constants PUBLISH_URI & APPCAST_URI."
+  task :upload do
+    if File.exist? PKG
+      puts "\nUploading: #{PKG}"
+      do_upload(PUBLISH_URI, PKG)
+      puts "\n\n"
+    end
+    appcast_path = "pkg/#{File.basename(INFO_PLIST['SUFeedURL'])}" if INFO_PLIST['SUFeedURL']
+    if appcast_path and File.exist?(appcast_path)
+      puts "\nUploading: #{appcast_path}"
+      do_upload(APPCAST_URI, appcast_path)
+      puts "\n\n"
+    end
+    release_notes_path = "pkg/#{DEPLOY_NAME}_release_notes.html"
+    if File.exist? release_notes_path
+      puts "\nUploading: #{release_notes_path}"
+      do_upload(APPCAST_URI, release_notes_path)
+      puts "\n\n"
+    end
+  end
+  private
+  def check_if_sparkle_info_exists!
+    [
+      ['SUFeedURL', 'http://mydomain.com/my_app/appcast.xml'],
+      ['SUAppDescription', 'My terrific application!'],
+      ['SUPublicReleaseNotesURL', 'http://mydomain.com/my_app/', "Don't forget the last '/' which specifies that it's a directory.\nThe constructed url would look like: http://mydomain.com/my_app/my_app_1.1_release_notes.html"],
+      ['SUPublicReleaseURL', 'http://mydomain.com/files/my_app/', "Don't forget the last '/' which specifies that it's a directory.\nThe constructed url would look like: http://mydomain.com/files/my_app/my_app_1.1.dmg"],
+    ].each { |x| check_sparkle_for_key(*x) }
+  end
+  def check_sparkle_for_key(key, example_value, notes = nil)
+    if INFO_PLIST[key].nil?
+      puts "In order to create a sparkle appcast, you need to specify the value for '#{key}' in the Info.plist file."
+      puts "Eg:\n\n  <key>#{key}</key>\n  <string>#{example_value}</string>"
+      puts "\nNote:\n#{notes}" if notes
+      exit
+    end
+  end
+  # calls the upload method based on the scheme
+  def do_upload(uri, file)
+    send(uri.scheme, uri, file, File.basename(file))
+  end
+  def scp(uri, file, dest_file)
+    sh "scp -P #{ uri.port || '22' } #{file} #{uri.userinfo}@#{uri.host}:#{uri.path}/#{dest_file}"
+  end
+end

data/lib/rucola/tasks/main.rake CHANGED

@@ -6,12 +6,39 @@ require 'rucola/nib'
 require 'rucola/rucola_support'
 # set the env, default to debug if we are running a rake task.
-ENV['RUBYCOCOA_ENV']  ||= 'debug'
-ENV['RUBYCOCOA_ROOT'] ||= SOURCE_ROOT
+if ARGV[0] && %w{ release deploy }.include?(ARGV[0])
+  mode = 'release'
+else
+  ENV['RUBYCOCOA_ENV']  ||= 'debug'
+  ENV['RUBYCOCOA_ROOT'] ||= SOURCE_ROOT
+  mode = ENV['RUBYCOCOA_ENV']
+end
+puts "Running in mode: #{mode}\n\n"
-require 'rucola/initializer'
+# Load the applications Info.plist file
+INFO_PLIST = OSX::NSDictionary.dictionaryWithContentsOfFile(File.join(SOURCE_ROOT, 'Info.plist'))
-puts "RUNNING IN MODE: #{RUBYCOCOA_ENV.upcase}\n\n"
+# Set some application defaults for the rake tasks
+APPNAME    = INFO_PLIST['CFBundleExecutable']
+APPVERSION = INFO_PLIST['CFBundleVersion']
+TARGET     = "#{APPNAME}.app"
+# Now that the env is set let initializer do it's work
+require 'rucola/initializer'
+# Load the configuration
+module Rucola
+  class Initializer
+    class << self
+      def run
+        yield instance.configuration
+      end
+    end
+  end
+end
+CONFIGURATION = Rucola::Configuration.new
+Rucola::Initializer.instance.instance_variable_set(:@configuration, CONFIGURATION)
+CONFIGURATION.load_environment_configuration!
 # FIXME: We also need to check if the user uses a frozen rc framework
 RUBYCOCOA_FRAMEWORK = OSX::NSBundle.bundleWithIdentifier('com.apple.rubycocoa').bundlePath.to_s
@@ -20,14 +47,20 @@ RUBYCOCOA_FRAMEWORK = OSX::NSBundle.bundleWithIdentifier('com.apple.rubycocoa').
 # Get all the tasks
 Dir["#{File.dirname(__FILE__)}/*.rake"].each {|file| load file unless ['main.rake'].include? File.basename(file) }
-Dir[(ENV['RUBYCOCOA_ROOT'] + '/vendor/plugins/*/tasks/*.rake').to_s].each { |r| load r }
+Dir[(SOURCE_ROOT + '/vendor/plugins/*/tasks/*.rake').to_s].each { |r| load r }
 task :default => 'xcode:build'
 desc 'Runs all the clean tasks'
-task :clean => 'xcode:clean'
+task :clean => ['xcode:clean', 'dependencies:clean', 'deploy:clean']
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/*/test_*.rb']
   t.options = '-rr'
   t.verbose = true
 end
+desc 'Update any missing/changed files, if you updated from an earlier version of Rucola.1'
+task :update do
+  sh "cd .. && rucola #{File.basename(SOURCE_ROOT)}"
+end

data/lib/rucola/tasks/xcode.rake CHANGED

@@ -1,3 +1,10 @@
+desc "Shortcut for doing a release build"
+task :release do
+  RUBYCOCOA_ENV = 'release'
+  Rake::Task['xcode:build'].invoke
+end
+# we should probably rename this namespace and task to 'build'
 namespace :xcode do
   def config
@@ -8,27 +15,36 @@ namespace :xcode do
     # get the users build dir
     prefs = OSX::NSUserDefaults.standardUserDefaults
     prefs.addSuiteNamed 'com.apple.xcode'
-    prefs['PBXApplicationwideBuildSettings']['SYMROOT'] || './build'
+    # first check if there are any xcode prefs at all.
+    if prefs['PBXApplicationwideBuildSettings']
+      prefs['PBXApplicationwideBuildSettings']['SYMROOT'] || './build'
+    else
+      './build'
+    end
   end
   def build_root
     File.expand_path("#{build_dir}/#{config}/#{TARGET}")
   end
+  def executable
+    "#{build_root}/Contents/MacOS/#{APPNAME}"
+  end
   desc 'Builds the application'
   task :build do
-    executable = "#{build_root}/Contents/MacOS/#{APPNAME}"
+    # First check if we're in release and need to bundle anything
+    Rake::Task['dependencies:copy'].invoke if RUBYCOCOA_ENV == 'release'
     # For now let's do xcodebuild everytime.
     # Otherwise nibs that are updated will not be updated in the bundle...
     sh "xcodebuild -configuration #{config}"
-    # unless File.exists?(executable)
-    #   sh "xcodebuild -configuration #{config}"
-    # else
-    #   puts "Build already exists, skipping. (Use clean if you really really want a new build.)\n\n"
-    # end
+    Rake::Task['xcode:run'].invoke unless ENV['DONT_START_RUBYCOCOA_APP']
+  end
+  desc 'Run a build'
+  task :run do
     # Make sure the app is brought to the front once launched.
     Thread.new(executable) do |executable|
       sleep 0.025 until OSX::NSWorkspace.sharedWorkspace.launchedApplications.any? {|dict| dict['NSApplicationName'] == APPNAME }
@@ -36,12 +52,39 @@ namespace :xcode do
     end
     # launch app with the correct env set
-    sh "RUBYCOCOA_ENV='#{RUBYCOCOA_ENV}' RUBYCOCOA_ROOT='#{RUBYCOCOA_ROOT}' #{executable}"
+    if RUBYCOCOA_ENV == 'release'
+      sh executable
+    else
+      sh "RUBYCOCOA_ENV='#{RUBYCOCOA_ENV}' RUBYCOCOA_ROOT='#{RUBYCOCOA_ROOT}' #{executable}"
+    end
   end
   desc 'Removes the build'
   task :clean do
-    puts "Removing #{build_root}"
-    FileUtils.rm_rf build_root
+    if File.exist? build_dir
+      puts "Removing #{build_dir}"
+      FileUtils.rm_rf build_dir
+    end
+  end
+  namespace :frameworks do
+    desc "Add any framework in vendor/frameworks which isn't in the project yet to the project and bundle it"
+    task :update do
+      if File.exist? 'vendor/frameworks'
+        project = Rucola::Xcode.new File.join(SOURCE_ROOT, "#{APPNAME}.xcodeproj")
+        framework_names = project.frameworks.map { |f| f.last['name'] }
+        changes = false
+        FileList['vendor/frameworks/*.framework'].each do |framework|
+          framework_name = File.basename(framework)
+          unless framework_names.include?(framework_name)
+            changes = true
+            puts "Adding #{framework_name} to project."
+            project.add_framework(framework_name, framework)
+            project.bundle_framework(framework_name)
+          end
+        end
+        project.save if changes
+      end
+    end
   end
 end

data/lib/rucola/test_case.rb ADDED

@@ -0,0 +1,138 @@
+class OSX::NSObject
+  class << self
+    # An array of defined ib_outlets.
+    #
+    # Only used in test cases.
+    def defined_ib_outlets
+      @defined_ib_outlets ||= []
+    end
+    # Override ib_outlets so we can store which ones need to be defined.
+    #
+    # Only used in test cases.
+    def ib_outlets(*outlets)
+      defined_ib_outlets.concat(outlets.flatten)
+    end
+    alias_method :ib_outlet, :ib_outlets
+  end
+end
+module Rucola
+  module TestCase
+    # Defines the controller that will be tested.
+    #
+    #   class ApplicationController < OSX::NSObject
+    #     ib_outlet :window
+    #     ib_outlets :tableView, :searchField
+    #     ib_outlets :textField
+    #   end
+    #
+    #   class TestFoo < Test::Unit::TestCase
+    #     tests ApplicationController
+    #
+    #     def after_setup
+    #       ib_outlets :window => mock("Main Window"),
+    #                  :tableView => OSX::NSTableView.alloc.init,
+    #                  :searchField => OSX::NSSearchField.alloc.init
+    #
+    #       window.stubs(:title => 'Main Window')
+    #       tableView.addTableColumn OSX::NSTableColumn.alloc.init
+    #       searchField.stringValue = "foo"
+    #     end
+    #
+    #     def test_something
+    #       p controller # => #<ApplicationController:0xdfa1ce class='ApplicationController' id=0x1e8d0e0>
+    #       p window.title # => "Main Window"
+    #       p tableView.tableColumns # => #<NSCFArray [#<OSX::NSTableColumn:0xdf9d0a class='NSTableColumn' id=0x1e90d00>]>
+    #       p searchField # => #<OSX::NSSearchField:0xdfa43a class='NSSearchField' id=0x1e84cb0>
+    #
+    #       # Note that we haven't set the textField ib_outlet to anything else in the after_setup method,
+    #       # so it will be a stub which responds to everything by returning nil.
+    #       p textField # => #<Mock:textField>
+    #     end
+    #   end
+    def tests(class_to_be_tested)
+      @class_to_be_tested = class_to_be_tested
+      include Rucola::TestCase::InstanceMethods
+    end
+    module InstanceMethods
+      # Sets up the ib_outlets to all be stubs which respond to everything with nil.
+      #
+      # In your test use #after_setup to do any custom setup.
+      def setup
+        class_to_be_tested.defined_ib_outlets.each do |outlet|
+          ib_outlet(outlet, stub_everything(outlet.to_s))
+        end
+        after_setup if respond_to? :after_setup
+      end
+      # Sets the ib_outlets and instance to be tested to nil at the end of the test.
+      #
+      # In your test use #after_teardown to do any custom teardown.
+      def teardown
+        class_to_be_tested.defined_ib_outlets.each do |outlet|
+          instance_to_be_tested.instance_variable_set("@#{outlet}", nil)
+        end
+        @instance_to_be_tested = nil
+        after_teardown if respond_to? :after_teardown
+      end
+      # Returns the class that's to be tested.
+      def class_to_be_tested
+        self.class.instance_variable_get(:@class_to_be_tested)
+      end
+      # An instance of the class that's to be tested.
+      def instance_to_be_tested
+        @instance_to_be_tested ||= class_to_be_tested.alloc.init
+      end
+      alias_method :controller, :instance_to_be_tested
+      # Lets you get an instance variable from the instance.
+      #
+      #   obj.instance_variable_set(:@some_attr, 'foo')
+      #   assigns(:some_attr) # => 'foo'
+      #
+      # You can also set an instance variable in the instance.
+      #
+      #   obj.assigns(:some_attr, 'bar')
+      #   obj.instance_variable_get(:@some_attr) # => 'bar'
+      def assigns(name, obj = nil)
+        obj.nil? ? instance_to_be_tested.instance_variable_get("@#{name}") : instance_to_be_tested.instance_variable_set("@#{name}", obj)
+      end
+      # Defines instance variables in the instance which represent the ib_outlets.
+      # It basically just sets the instance variables, but also creates shorcut accessors to get at them from your tests.
+      #
+      #   def after_setup
+      #     ib_outlet :textField, OSX::NSTextField.alloc.init
+      #     p textField # => #<OSX::NSTextField:0xdfa3f4 class='NSTextField' id=0x1e842b0>
+      #   end
+      #
+      # Note that not every class can be instantiated in a test.
+      # So you can also supply something like a mock.
+      def ib_outlet(name, obj)
+        unless respond_to? name
+          self.class.class_eval do
+            define_method(name) { assigns(name) }
+            private name
+          end
+        end
+        assigns(name, obj)
+      end
+      # Shortcut method to defined multiple ib_outlets by supplying a hash.
+      #
+      #   def after_setup
+      #     ib_outlets :window => mock("Main Window"),
+      #                :tableView => OSX::NSTableView.alloc.init,
+      #                :searchField => OSX::NSSearchField.alloc.init
+      #   end
+      def ib_outlets(outlets)
+        outlets.each {|k,v| ib_outlet(k, v) }
+      end
+    end
+  end
+end
+Test::Unit::TestCase.send(:extend, Rucola::TestCase)

data/lib/rucola/test_helper.rb CHANGED

@@ -9,12 +9,10 @@ class Object
   end
 end
-module OSX
+module OSX #:nodoc:
   # Allows methods to be overriden with a different arity.
   #
-  # TODO: Check with Laurent if this is bad?
-  # Otherwise we should maybe override the stub method to set this to true
-  # when the object is a subclass of OSX::NSObject and set it to false again after the stubbing.
+  # FIXME: This seems to destroy the #super_init etc from working
   def self._ignore_ns_override; true; end
   class NSObject
@@ -68,4 +66,12 @@ module OSX
       res
     end
   end
-end
+end
+# Sets the RUBYCOCOA_ENV for the duration of the block.
+def with_env(env)
+  before = Rucola::RCApp.env
+  Rucola::RCApp.stubs(:env).returns(env)
+  yield
+  Rucola::RCApp.stubs(:env).returns(before)
+end