visionmedia-ruby-php-bridge 1.1.0

data/History.rdoc

@@ -0,0 +1,8 @@
+
+=== 1.1.0 / 2009-08-10
+
+* php('array(1,2)') is not equiv to php('$return = array(1,2)')
+
+=== 0.0.1 / 2009-08-10
+
+* Initial release

data/Manifest

@@ -0,0 +1,18 @@
+History.rdoc
+lib/ruby-php-bridge/bridge.rb
+lib/ruby-php-bridge/import.rb
+lib/ruby-php-bridge/version.rb
+lib/ruby-php-bridge.rb
+Manifest
+php/php-ruby-bridge.php
+Rakefile
+README.rdoc
+ruby-php-bridge.gemspec
+spec/import_spec.rb
+spec/ruby-php-bridge_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake
+Todo.rdoc

data/README.rdoc

@@ -0,0 +1,67 @@
+
+= Ruby -> PHP Bridge
+
+The Ruby PHP bridge is a tiny library providing a JSON bridge 
+between the two languages. Any code which can be converted to JSON
+can be passed between the two. In both cases the '$return' variable
+may be set in order to convert it to the other language.
+
+  PHP::Bridge.eval '$return = array("any", "data", "here");'
+  # => ['any', 'data', 'here']
+  
+OR
+
+  require 'ruby-php-bridge/import'
+  php '$return = array("something")'
+  # => ['something']
+  
+OR
+
+  require 'ruby-php-bridge/import'
+  php 'array("something")'
+  # => ['something']
+  
+OR
+
+  bridge = PHP::Bridge.new
+  bridge << '$a  = "hello";'
+  bridge << '$a .= " there";'
+  bridge << '$return = $a;'
+  bridge.eval
+  # => ['hello there']
+  
+As you can see in one of the examples above, '$return =' is prepended
+when not present, providing a cleaner API.
+
+== PHP -> Ruby Bridge
+
+A small PHP library functions similarily, providing
+a bridge to Ruby, which is located in php/php-ruby-bridge.php
+
+  ruby('$return = ["any", "data", "here"]')
+  // => array('any', 'data', 'here')
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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 OR COPYRIGHT HOLDERS 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,15 @@
+
+$:.unshift 'lib'
+require 'ruby-php-bridge'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "ruby-php-bridge", PHP::Bridge::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Ruby to PHP / PHP to Ruby bridge"
+  p.runtime_dependencies = []
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/Todo.rdoc

@@ -0,0 +1,12 @@
+
+== Major:
+
+* Nothing
+
+== Minor:
+
+* Nothing
+
+== Brainstorming:
+
+* Nothing

data/lib/ruby-php-bridge.rb

@@ -0,0 +1,26 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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 OR COPYRIGHT HOLDERS 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.
+#++
+
+require 'json'
+require 'ruby-php-bridge/bridge'
+require 'ruby-php-bridge/version'

data/lib/ruby-php-bridge/bridge.rb

@@ -0,0 +1,66 @@
+
+module PHP
+  class Bridge
+    
+    #--
+    # Constants
+    #++
+    
+    BIN = 'php'
+    
+    ##
+    # PHP source string.
+    
+    attr_accessor :source
+    
+    ##
+    # Initial bridge.
+    
+    def initialize
+      @source = ''
+    end
+    
+    ##
+    # PHP source string.
+    
+    def to_s
+      source
+    end
+    
+    ##
+    # Append _source_.
+    
+    def << source
+      @source << source
+    end
+    
+    ##
+    # Evaluate string against the PHP binary.
+    
+    def eval
+      Bridge.eval to_s
+    end
+    
+    ##
+    # Execute _source_ returning the raw JSON output.
+    
+    def self.execute source
+      `#{BIN} -r '#{source << "\n echo json_encode(isset($return) ? (array) $return : array());"}'`
+    end
+    
+    ##
+    # Evaluate _source_ returning a ruby object.
+    
+    def self.eval source
+      source = '$return = ' << source unless source.empty? || source.include?('$return')
+      JSON.parse execute(source)
+    end
+    
+    module Delegates
+      def php source
+        ::PHP::Bridge.eval source
+      end
+    end
+    
+  end
+end

data/lib/ruby-php-bridge/import.rb

@@ -0,0 +1,4 @@
+
+require 'ruby-php-bridge'
+
+include PHP::Bridge::Delegates

data/lib/ruby-php-bridge/version.rb

@@ -0,0 +1,6 @@
+
+module PHP
+  class Bridge
+    VERSION = '1.1.0'
+  end
+end

data/php/php-ruby-bridge.php

@@ -0,0 +1,21 @@
+<?php
+
+define('RUBY_BRIDGE_VERSION', '1.1.0');
+define('RUBY_BRIDGE_BIN', 'ruby');
+
+/**
+ * Execute ruby $source, returning the JSON
+ * decoded object.
+ *
+ * @param string $source
+ * @return string
+ */
+
+function ruby($source) {
+  $ruby  = "require 'rubygems'\n";
+  $ruby .= "require 'json'\n";
+  $ruby .= $source;
+  $ruby .= "\n puts \$return.nil? ? '{}' : \$return.to_json";
+  $ruby = str_replace("'", '"', $ruby);
+  return json_decode(shell_exec(RUBY_BRIDGE_BIN . " -e '{$ruby}'"));
+}

data/ruby-php-bridge.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-php-bridge}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-08-10}
+  s.description = %q{Ruby to PHP / PHP to Ruby bridge}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["lib/ruby-php-bridge/bridge.rb", "lib/ruby-php-bridge/import.rb", "lib/ruby-php-bridge/version.rb", "lib/ruby-php-bridge.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.rdoc", "lib/ruby-php-bridge/bridge.rb", "lib/ruby-php-bridge/import.rb", "lib/ruby-php-bridge/version.rb", "lib/ruby-php-bridge.rb", "Manifest", "php/php-ruby-bridge.php", "Rakefile", "README.rdoc", "ruby-php-bridge.gemspec", "spec/import_spec.rb", "spec/ruby-php-bridge_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ruby-php-bridge", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruby-php-bridge}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby to PHP / PHP to Ruby bridge}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/import_spec.rb

@@ -0,0 +1,8 @@
+
+require 'ruby-php-bridge/import'
+
+describe "#php" do
+  it "should be a shortcut to PHP::Bridge.eval" do
+    php('$return = "test";').should == PHP::Bridge.eval('$return = "test";')
+  end
+end

data/spec/ruby-php-bridge_spec.rb

@@ -0,0 +1,62 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe PHP::Bridge do
+  before :each do
+    @bridge = PHP::Bridge.new
+  end
+  
+  describe "VERSION" do
+    it "should be a valid triple" do
+      PHP::Bridge::VERSION.should match(/\d+\.\d+\.\d+/)
+    end
+  end
+  
+  describe "#to_s" do
+    it "should return the source" do
+      @bridge.source = 'test'
+      @bridge.to_s.should include('test')
+    end
+  end
+  
+  describe "#<<" do
+    it "should append source" do
+      @bridge << 'foo'
+      @bridge << 'bar'
+      @bridge.to_s.should include('foobar')
+    end
+  end
+  
+  describe "#eval" do
+    it "should evaluate the source" do
+      @bridge << '$return = "test";'
+      @bridge.eval.first.should == 'test'
+    end
+  end
+  
+  describe ".eval" do
+    it "should return a ruby object" do
+      result = PHP::Bridge.eval <<-PHP
+        $array = array('foo' => 'bar');
+        $return = $array;
+      PHP
+      result['foo'].should == 'bar'
+    end
+    
+    it "should return empty array when nothing is present" do
+      PHP::Bridge.eval('').should be_empty
+    end
+    
+    it "should work with strings" do
+      PHP::Bridge.eval('$return = "foo";').first.should == 'foo'
+    end
+    
+    it "should escape quotes" do
+      PHP::Bridge.eval("$return = 'foo';").first.should == 'foo'
+    end
+    
+    it "should prepend '$return = ' when it is not present" do
+      PHP::Bridge.eval('"foo";').first.should == 'foo'
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib' 
+require 'rubygems'
+require 'ruby-php-bridge'

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: visionmedia-ruby-php-bridge
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby to PHP / PHP to Ruby bridge
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/ruby-php-bridge/bridge.rb
+- lib/ruby-php-bridge/import.rb
+- lib/ruby-php-bridge/version.rb
+- lib/ruby-php-bridge.rb
+- README.rdoc
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- History.rdoc
+- lib/ruby-php-bridge/bridge.rb
+- lib/ruby-php-bridge/import.rb
+- lib/ruby-php-bridge/version.rb
+- lib/ruby-php-bridge.rb
+- Manifest
+- php/php-ruby-bridge.php
+- Rakefile
+- README.rdoc
+- ruby-php-bridge.gemspec
+- spec/import_spec.rb
+- spec/ruby-php-bridge_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- Todo.rdoc
+has_rdoc: false
+homepage: ""
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ruby-php-bridge
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ruby-php-bridge
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby to PHP / PHP to Ruby bridge
+test_files: []
+