melomel 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### Melomel 0.3.1
+* Removed requirement for adding a bang to the end of no-arg methods.
+
 ### Melomel 0.3.0
 * Added `Melomel.invoke_function()` for package level functions invocation. (Nikita Dudnik)
 

data/README.md

@@ -5,9 +5,9 @@ melomel.rb -- A Ruby interface to Melomel
 
 Melomel.rb is a library that allows Ruby to communicate with an application
 running within the Flash virtual machine. For more information on Melomel,
-visit the Melomel repository:
+visit the Melomel site:
 
-http://github.com/benbjohnson/melomel
+http://melomel.info
 
 Melomel.rb follows the rules of [Semantic Versioning](http://semver.org/) and
 uses [TomDoc](http://tomdoc.org/) for inline documentation.
@@ -23,101 +23,6 @@ Melomel needs to be embedded and running in the application you're trying to
 connect to. Please see the Melomel repository for instructions on installation.
 
 
-## GETTING STARTED
-
-The first step to using Melomel is to install the Flash SWC in your application.
-Once the SWC is in your application, setup in your Ruby project is simple.
-
-In your Ruby file, simply call the `connect()` method on `Melomel`:
-
-	require 'melomel'
-	Melomel.connect()
-
-The `connect()` method is a blocking method so it won't proceed until it's done.
-After it's connected, there are several actions you can perform:
-
-1. Create Object
-1. Get Class
-1. Get Property
-1. Set Property
-1. Invoke Method
-1. Invoke Function
-
-
-## API
-
-### Overview
-
-Melomel communicates to the Flash virtual machine over a socket connection
-using XML. The protocol is simple and is meant to proxy all data access calls
-to the Flash virtual machine. This means that only primitives (strings, numbers
-and booleans) are copied but all objects are accessed by reference. By proxying
-objects, all data stays in the Flash virtual machine and there are no syncing
-issues.
-
-### Create Object
-
-To create an object, use the `create_object()` method on `Melomel`:
-
-    point = Melomel.create_object('flash.geom.Point')
-
-The object returned is a proxy object so any actions performed on it in Ruby
-will be performed on the ActionScript object in the Flash virtual machine.
-
-### Get Class
-
-You can retrieve a class to call static methods and properties. Since classes
-are objects in ActionScript, they work identically in Melomel.
-
-    app = Melomel.get_class('mx.core.FlexGlobals')
-    app.topLevelApplication.name  = 'Melomel App!'
-
-This Flex 4 example updates the name of the application to "Melomel App!".
-
-### Get Property & Set Property
-
-Getting and setting properties is handled transparently when using the object
-proxies.
-
-    point = Melomel.create_object('flash.geom.Point')
-    point.x = 30
-    point.set_property('y') = 40
-	p "pos: #{point.x}, #{point.y}"
-	p "length: #{point.get_property('length')}"
-
-Property accessors on an object proxy are automatically used to retrieve the
-property value of the Flash object. You can also use the `get_property()`
-method when accessing properties and the `set_property()` method when mutating
-properties.
-
-### Invoke Method
-
-Invoking methods is also handled transparently when using object proxies.
-
-_IMPORTANT: There a catch! Methods without any parameters must have a bang
-(`!`) character appended to their method name when calling directly on an
-object proxy._
-
-	clipboard = Melomel.get_class('flash.desktop.Clipboard').generalClipboard
-	data = clipboard.getData('air:text')
-	data = clipboard.invoke_method('getData', 'air:text')
-	clipboard.clear!()
-	clipboard.invoke_method('clear')
-
-In this example, the `getData` method could be called on the object directly
-because it had more than one argument. The `clear` method, however, required
-that a bang character be appended to the name or that the `invoke_method` be
-used.
-
-### Invoke Function
-
-Invoking package level functions is also handled transparently.
-
-	className = Melomel.invoke_function('flash.utils.getQualifiedClassName', "Some string.")
-
-The className will contain "String".
-
-
 ## HACKING
 
 To get started with working with the source, start by running Bundler to get all

data/lib/melomel/object_proxy.rb

@@ -46,9 +46,6 @@ module Melomel
       # Methods with arguments are methods
       elsif args.length > 0
         return invoke_method(method_name, *args)
-      # Methods ending in '!' are methods
-      elsif last_char == '!'
-        return invoke_method(method_name.chop, *args)
       # Methods with no arguments are aliased to get_property
       else
         return get_property(method_name)

data/lib/melomel/version.rb

@@ -1,3 +1,3 @@
 module Melomel
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/test_integration.rb

@@ -20,6 +20,12 @@ class IntegrationTestCase < RunnerTestCase
     assert_equal 'bar', runner.foo
   end
 
+  # Tests the ability for a get_property to call a no-arg method if unavailable.
+  def test_should_get_property_passthrough
+    app = Melomel.get_class('mx.core.FlexGlobals').topLevelApplication
+    assert_equal 'ok', app.test()
+  end
+
   def test_should_set_property
     runner = Melomel.get_class('MelomelRunner')
     runner.name = 'Susy'

data/test/test_object_proxy.rb

@@ -40,9 +40,4 @@ class ObjectProxyTestCase < MiniTest::Unit::TestCase
     @proxy.expects(:invoke_method).with('foo', 'bar', 'baz')
     @proxy.foo('bar', 'baz')
   end
-  
-  def test_should_alias_methods_ending_in_bang_to_invoke_method
-    @proxy.expects(:invoke_method).with('foo')
-    @proxy.foo!()
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: melomel
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Ben Johnson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-20 00:00:00 -06:00
+date: 2010-09-27 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency