bean 0.0.1 → 0.0.2

data/.gitignore

@@ -1,2 +1,6 @@
+.yardoc/
+doc/
+pkg/
+
 *.gem
 

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2011 dan sinclair
+
+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 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/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/gempackagetask'
+require 'yard'
+
+spec = eval(File.open("bean.gemspec").read)
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', 'LICENSE']
+  t.options = ['--main', 'README.md', '--no-private']
+end
+
+task :tag do
+  sh "git tag -m 'Tagging release: #{Bean::VERSION}' -a v#{Bean::VERSION}"
+end
+
+namespace :gem do
+  desc 'Upload gem to rubygems.org'
+  task :push => [:package, :tag] do
+    sh "gem push pkg/bean-#{Bean::VERSION}.gem"
+  end
+end

data/bean.gemspec

@@ -5,16 +5,19 @@ require 'bean/version'
 Gem::Specification.new do |s|
   s.name = 'bean'
   s.version = Bean::VERSION
+  s.platform = Gem::Platform::RUBY
 
   s.authors = ['dan sinclair']
   s.email = ['dj2@everburning.com']
 
-  s.homepage = 'http://github.com/dj2/Bean.git'
+  s.homepage = 'http://github.com/dj2/Bean'
   s.summary = 'Cocoa Additions for MacRuby Applications'
   s.description = s.summary
 
   s.required_ruby_version = '>=1.9.2'
 
+  s.add_development_dependency 'yard'
+
   s.files = `git ls-files`.split("\n")
   s.require_paths = ['lib']
 end

data/lib/bean.rb

@@ -1,10 +1,11 @@
+require 'bean/nsindexset_additions'
+require 'bean/nsmutableurlrequest_additions'
 require 'bean/nsnotificationcenter_additions'
 require 'bean/nstableview_additions'
 require 'bean/nstextfield_additions'
 require 'bean/nstoolbaritem_additions'
 require 'bean/nsurl_connection_additions'
 require 'bean/nsuserdefaults_additions'
-require 'bean/nsview_additions'
 require 'bean/nsxmlnode_additions'
 
 require 'bean/table_data_source'

data/lib/bean/nsindexset_additions.rb

@@ -0,0 +1,22 @@
+# Extensions to the NSIndexSet class
+class NSIndexSet
+  include Enumerable
+
+  #
+  # Iterate over each of the items in the NSIndexSet
+  #
+  # @example
+  #   s = NSIndexSet.indexSetWithIndexesInRange(NSMakeRange(0, 10))
+  #   s.each { |i| puts i }
+  #
+  # @yield [i] Provides the current index to the given block
+  # @yieldparam [Fixnum] i The index
+  # @return [nil]
+  def each
+    i = self.firstIndex
+    until i == NSNotFound
+      yield i
+      i = self.indexGreaterThanIndex(i)
+    end
+  end
+end

data/lib/bean/nsmutableurlrequest_additions.rb

@@ -0,0 +1,29 @@
+# Extensions to the NSMutableRequest class
+class NSMutableURLRequest
+  #
+  # Create a POST request
+  #
+  # @example
+  #   req = NSMutableURLRequest.post("https://example.com",
+  #                                  :body => "foo=1&bar=2&baz=3",
+  #                                  :head => { 'Content-Type' => 'application/x-www-form-urlencoded' })
+  #
+  # @param url [String] The domain to post too
+  # @param opts [Hash] Any options for the post
+  # @option opts [String] :body The body to send with the POST request
+  # @option opts [Hash] :head Any headers to send with the request
+  # @return [NSMutableURLRequest] The request object
+  def self.post(url, opts)
+    req = NSMutableURLRequest.requestWithURL(NSURL.URLWithString(url))
+    req.setHTTPMethod('POST')
+
+    if opts[:head]
+      opts[:head].each_pair do |k, v|
+        req.setValue(v, forHTTPHeaderField:k)
+      end
+    end
+
+    req.setHTTPBody(opts[:body].to_data) if opts[:body]
+    req
+  end
+end

data/lib/bean/nsnotificationcenter_additions.rb

@@ -1,10 +1,37 @@
+# Extensions to the NSNotificationCenter class
 class NSNotificationCenter
+  #
+  # Post a notification to the default center.
+  #
+  # NSNotificationCenter.post provides a convenience wrapper around
+  # posting messages to the defaultCenter.
+  #
+  # @example
+  #   NSNotificationCenter.post(:name => :my_message, :info => {:hi => 1})
+  #
+  # @param options [Hash] Options for the notification
+  # @option options [String|Symbol] :name The notification name to send
+  # @option options [String] :object The object to send
+  # @option options [String] :info The userInfo to send
+  # @return [nil]
   def self.post(options)
     NSNotificationCenter.defaultCenter.postNotificationName(options[:name],
                                                      object:options[:object],
                                                    userInfo:options[:info])
   end
 
+  #
+  # Setup an observer for the given notification and execute block when seen. Then
+  # block will be passed the notification object.
+  #
+  # @example
+  #   NSNotificationCenter.observe(:my_message) do |notice|
+  #     puts "My Message Received: #{notice.userInfo.inspect}"
+  #   end
+  #
+  # @param name [String|Symbol] The notification name to listen for
+  # @param blk [Proc] The block to execute when notification is +received
+  # @return [nil]
   def self.observe(name, &blk)
     @observers ||= []
     @observers << Class.new do

data/lib/bean/nstableview_additions.rb

@@ -1,13 +1,27 @@
+# Extensions to the NSTableView class
 class NSTableView
-  alias dataSource= setDataSource
   alias reload reloadData
 
+  #
+  # Helper for adding a double click handler to the table
+  #
+  # The block will be called and provided the sender, clicked column and clicked row
+  #
+  # @param blk [Proc] The block to execute
+  # @return [Nil]
   def on_double_click(&blk)
     @on_double_action = blk
     def self.performDoubleAction(sender); @on_double_action.call(sender, self.clickedColumn, self.clickedRow); end
     setDoubleAction("performDoubleAction:")
   end
 
+  #
+  # Helper for adding a click handler to the table
+  #
+  # The block will be called and provided the sender, clicked column and clicked row
+  #
+  # @param blk [Proc] The block to execute
+  # @return [Nil]
   def on_click(&blk)
     @on_action = blk
     def self.performAction(sender); @on_action.call(sender, self.clickedColumn, self.clickedRow); end

data/lib/bean/nstextfield_additions.rb

@@ -1,3 +1,4 @@
+# Extensions to the NSTextField class
 class NSTextField
   alias to_s stringValue
   alias to_f floatValue

data/lib/bean/nstoolbaritem_additions.rb

@@ -1,4 +1,12 @@
+# Extensions to the NSToolbarItem class
 class NSToolbarItem
+  #
+  # Shortcut for adding an on click handler to the toolbar item.
+  #
+  # The provided block will be provided the sender when executed.
+  #
+  # @param blk [Proc] The block to execute on click
+  # @return [Nil]
   def on_click(&blk)
     @on_action = blk
     def self.performAction(sender); @on_action.call(sender); end

data/lib/bean/nsurl_connection_additions.rb

@@ -1,4 +1,15 @@
+# Extensions to the NSURLConnection class
 class NSURLConnection
+  #
+  # Helper method for creating a NSURLConnection.
+  #
+  # Using this method will cause the URL Connection to use itself
+  # as the delegate. You can then add error and success handlers to
+  # be called when the download is finished.
+  #
+  # @param req [NSURLRequest] The URL Request
+  # @param blk [Proc] The success block to hookup
+  # @return [NSURLConnection] The URL Connection
   def initWithRequest(req, &blk)
     @error = nil
     @response = nil
@@ -10,33 +21,59 @@ class NSURLConnection
     initWithRequest(req, delegate:self)
   end
 
+  #
+  # Attach an error handler to the connection.
+  #
+  # The error handler will be executed in case of a connection
+  # error. The handler can be attached after the connection is
+  # completed.
+  #
+  # @param blk [Proc] The block to execute
+  # @return [Nil]
+  def on_error(&blk)
+    @on_error = blk
+    @on_error.call(@error) if @error
+  end
+
+  #
+  # Attach a success handler to the connection.
+  #
+  # The success handler will be executed when the connection is
+  # complete. The handler can be attached after the connection is
+  # completed.
+  #
+  # @param blk [Proc] The block to execute
+  # @return [Nil]
+  def on_success(&blk)
+    @on_success = blk
+    @on_success.call(@response) if @response
+  end
+
+  # Response received callback
+  # @api private
   def connection(conn, didReceiveResponse:resp)
     @data.setLength(0)
   end
 
+  # Data received callback
+  # @api private
   def connection(conn, didReceiveData:rcv)
     @data.appendData(rcv)
   end
 
+  # Connection failed callback
+  # @api private
   def connection(conn, didFailWithError:error)
     return unless @on_error
     @on_error.call(error)
     @error = error
   end
 
+  # Connection finished callback
+  # @api private
   def connectionDidFinishLoading(conn)
     @response = NSString.alloc.initWithData(@data, encoding:NSUTF8StringEncoding)
     @on_success.call(@response) if @on_success
     @data = nil
   end
-
-  def on_error(&blk)
-    @on_error = blk
-    @on_error.call(@error) if @error
-  end
-
-  def on_success(&blk)
-    @on_success = blk
-    @on_success.call(@response) if @response
-  end
 end

data/lib/bean/nsuserdefaults_additions.rb

@@ -1,16 +1,53 @@
+# Extensions to the NSUserDefaults class
 class NSUserDefaults
-  def self.[]=(key,value)
+  #
+  # Shortcut for setting a key/value into the standardUserDefaults
+  #
+  # @example
+  #    NSUserDefaults[:foo] = 'bar'
+  #
+  # @param key [String|Symbol] The key to set
+  # @param value [Object] The object to set
+  # @return [Nil]
+  def self.[]=(key, value)
     standardUserDefaults[key] = value
   end
 
+  #
+  # Shortcut for retrieving a key from the standardUserDefaults
+  #
+  # @example
+  #    NSUserDefaults[:foo]
+  #
+  # @param key [String|Symbol] The key to retrieve
+  # @return [Object] The value for the given key
   def self.[](key)
     standardUserDefaults[key]
   end
 
+  #
+  # Short cut for deleting a key from the standardUserDefaults
+  #
+  # @example
+  #    NSUserDefaults.delete(:foo)
+  #
+  # @param key [String|Symbol] The key to delete
+  # @return [Nil]
   def delete(key)
     standardUserDefaults.delete(key)
   end
 
+  #
+  # Helper method for setting data into the user defaults
+  #
+  # If the value is provided, the given key will be set. If the value
+  # is nil the given key will be deleted.
+  #
+  # This method always synchronizes the defaults.
+  #
+  # @param key [String|Symbol] The key to set or delete
+  # @param value [Object|Nil] The value to set
+  # @return [Nil]
   def []=(key, value)
     if value
       setObject(value, forKey:key.to_s)
@@ -20,17 +57,35 @@ class NSUserDefaults
     sync
   end
 
+  #
+  # Helper method for retrieving an object from the defaults
+  #
+  # @note I'm not using the standard MacRuby sugaring here as
+  #       I need to to_s the key. Keeps everything constent.
+  #
+  # @param key [String|Symbol] The key to retrieve
+  # @return [Object] The value for the given key
   def [](key)
     objectForKey(key.to_s)
   end
 
+  #
+  # Helper to remove an object from the defaults.
+  #
+  # This method always synchronizes the defaults.
+  #
+  # @param key [String|Symbol] The key to remove.
+  # @return [Nil]
   def delete(key)
-    removeObjectForKey(key)
+    removeObjectForKey(key.to_s)
     sync
   end
 
   private
 
+  #
+  # Wrapper for synchronize that outputs a message on failure.
+  # @api private
   def sync
     puts "Failed to synchronize" unless synchronize
   end

data/lib/bean/nsxmlnode_additions.rb

@@ -1,10 +1,20 @@
+# Extensions to the NSXMLNode class
 class NSXMLNode
   alias to_xml XMLString
 
+  #
+  # Returns the child at the given index.
+  #
+  # @param key [Fixnum] The child index to retrieve
+  # @return [NSXMLNode] The node at the given child index.
   def [](key)
     childAtIndex(key)
   end
 
+  #
+  # Returns the number of children for this code
+  #
+  # @return [Fixnum] The number of child nodes
   def length
     childCount
   end

data/lib/bean/table_data_source.rb

@@ -1,21 +1,49 @@
-class TableDataSource
-  attr_reader :data
+module Bean
+  # A simple table data source. Provided an array it will handle the needed
+  # calbacks for the table.
+  class TableDataSource
+    # The data to provide to the table
+    attr_reader :data
 
-  def initialize(data)
-    @data = data
-  end
+    #
+    # Create the table data source
+    #
+    # The elements of the provided data source either need to
+    # respond to [] and provide each of the needed keys or,
+    # need to respond to methods based on the key names.
+    #
+    # @param data [Array] The data to be provided to the table
+    # @return [Bean::TableDataSource] The new data source
+    def initialize(data)
+      @data = data
+    end
 
-  def numberOfRowsInTableView(tableView)
-    data.length
-  end
+    #
+    # Returns the number of rows in the table
+    # @api private
+    def numberOfRowsInTableView(table)
+      data.length
+    end
+
+    #
+    # Returns the value for the given row and column of the table
+    # @api private
+    def tableView(table, objectValueForTableColumn:column, row:i)
+      ident = column.identifier
 
-  def tableView(view, objectValueForTableColumn:column, row:i)
-    ident = column.identifier
+      if data[i].respond_to?(:[])
+        data[i][ident.intern]
+      elsif data[i].respond_to?(ident.to_sym)
+        data[i].send(ident.to_sym)
+      end
+    end
 
-    if data[i].respond_to?(:[])
-      data[i][ident.intern]
-    elsif data[i].respond_to?(ident.to_sym)
-      data[i].send(ident.to_sym)
+    #
+    # Sorts the data based on the current table sort descriptors
+    # @api private
+    def tableView(table, sortDescriptorsDidChange:old_descriptors)
+      data.sortUsingDescriptors(table.sortDescriptors)
+      table.reloadData
     end
   end
-end
+end

data/lib/bean/version.rb

@@ -1,3 +1,6 @@
+#
+# Any non-cocoa additions will be added in the Bean module.
 module Bean
-  VERSION = '0.0.1'
-end
+  # The current version of Bean
+  VERSION = '0.0.2'
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: bean
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - dan sinclair
@@ -15,10 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 -04:00
+date: 2011-03-26 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
 description: Cocoa Additions for MacRuby Applications
 email: 
 - dj2@everburning.com
@@ -30,21 +40,24 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- README
+- LICENSE
+- README.md
+- Rakefile
 - bean.gemspec
 - lib/bean.rb
+- lib/bean/nsindexset_additions.rb
+- lib/bean/nsmutableurlrequest_additions.rb
 - lib/bean/nsnotificationcenter_additions.rb
 - lib/bean/nstableview_additions.rb
 - lib/bean/nstextfield_additions.rb
 - lib/bean/nstoolbaritem_additions.rb
 - lib/bean/nsurl_connection_additions.rb
 - lib/bean/nsuserdefaults_additions.rb
-- lib/bean/nsview_additions.rb
 - lib/bean/nsxmlnode_additions.rb
 - lib/bean/table_data_source.rb
 - lib/bean/version.rb
 has_rdoc: true
-homepage: http://github.com/dj2/Bean.git
+homepage: http://github.com/dj2/Bean
 licenses: []
 
 post_install_message: 
@@ -53,29 +66,25 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 55
       segments: 
       - 1
       - 9
       - 2
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Cocoa Additions for MacRuby Applications

data/lib/bean/nsview_additions.rb

@@ -1,3 +0,0 @@
-class NSView
-  alias hidden? isHidden
-end