peto 0.2.5 → 0.2.6

data/README.rdoc

@@ -1,5 +1,29 @@
 = peto
 
+peto is a RPC code generator.
+Defining types and procedures on RPC from contract files.
+Contract file is simple YAML format.
+
+  name: foo
+  types:
+    human: [name:string, age:integer]
+  procedures:
+    find_human:
+      args: [id:integer]
+      returns: [found:human]
+      errors: [human not found, invalid id]
+
+peto generates some codes.
+* human.rb : human's structure class
+* foo.rb : procedure class. this has find_human, find_human_response, find_human_error_human_not_found, find_human_error_invalid_id
+
+Use Foo class methods to create hash and send it as JSON string for RPC.
+
+
+peto has a Rails helper module.
+Look examples/rails_app and use it, if you want to create Rails RPC server.
+
+
 == Usage
 
 installing:
@@ -31,13 +55,7 @@ use foo.rb:
   user = Peto::User.new(:name => "alice", :age => 23, :animals=>[cat, dog])
 
   # generating procedure hash
-  p Peto::Foo.set_user(user) # => { :procedure=>"set_user",
-                                    :args=>{ :user=>{ :name=>"alice",
-                                                      :age=>23,
-                                                      :animals=>[
-                                                        Peto::Animal({:name=>"cat"}),
-                                                        Peto::Animal({:name=>"dog"})
-                                                      ]}}}
+  Peto::Foo.set_user(user)
 
 == in Rails
 
@@ -96,7 +114,7 @@ run server
 
   % rails server
 
-post next json to http://server/foo/
+post next JSON to http://server/foo/
   {
     "procedure" : "set_user",
     "args" : {
@@ -106,6 +124,9 @@ post next json to http://server/foo/
     }
   }
 
+this JSON string is created by
+  ActiveSupport::JSON.encode(Peto::Foo.set_user(user))
+
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/bin/peto

@@ -12,10 +12,11 @@ OptionParser.new do |opt|
   opt.on("-o output directory") {|value| options[:output] = value }
   opt.parse!(ARGV)
 end
-input = ARGV.pop
+input = ARGV.shift
+language = ARGV.shift
 
 if input.nil?
-  puts "usage:\n  % peto contract.yml"
+  puts "usage:\n  % peto contract.yml rb"
   exit
 end
 
@@ -23,5 +24,5 @@ options[:output] = File.dirname(input) if options[:output].nil?
 
 peto = Peto::Master.new
 peto.load(input)
-peto.generate(options[:output])
+peto.generate(language, options[:output])
 

data/examples/rails_app/config/application.rb

@@ -17,7 +17,6 @@ module RailsApp
 
     # generated files by peto
     config.autoload_paths += %W(#{config.root}/contracts/generated)
-    config.autoload_paths += %W(#{config.root}/../../lib)
 
     # Only load the plugins named here, in the order given (default is alphabetical).
     # :all can be used as a placeholder for all plugins not explicitly named.

data/examples/rails_app/config/environment.rb

@@ -3,7 +3,3 @@ require File.expand_path('../application', __FILE__)
 
 # Initialize the rails application
 RailsApp::Application.initialize!
-
-#ActionController::Base.param_parsers[Mime::Type::lookup("application/json")] = Proc.new {
-#  ActiveSupport::JSON.decode(data)
-#}

data/examples/rails_app/contracts/generated/rb/animal.rb

@@ -0,0 +1,39 @@
+require "peto/mixin/peto_class"
+
+module Peto
+  class Animal
+    include PetoClass
+
+    def self.create(hash_args)
+      instance = new
+      instance.name = hash_args["name"]
+      return instance
+    end
+
+    def initialize(args={})
+      @name = nil
+
+      set_args(args)
+      raise_errors unless valid?
+    end
+
+    attr_reader :name
+
+    def name=(value)
+      @name = value
+      raise_errors unless valid?
+    end
+
+    def members
+      [:name]
+    end
+
+    def types
+      {:name => String}
+    end
+
+    def arrays
+      {}
+    end
+  end
+end

data/examples/rails_app/contracts/generated/rb/foo.rb

@@ -0,0 +1,93 @@
+require "peto/mixin/peto_errorable"
+
+
+module Peto
+  class Foo
+    extend PetoErrorable
+
+    # set_user methods
+
+    def self.set_user(user)
+      set_user_valid?(user)
+      return {
+        :procedure => "set_user",
+        :args => {
+          :user => hashize(user),
+        }
+      }
+    end
+
+    def self.set_user_valid?(user)
+      invalid_type("user", User, user) unless user.class == User
+      raise_errors unless errors.empty?
+    end
+
+    def self.set_user_hash_to_args(hash_args)
+      args = []
+      args.push(User.create(hash_args["user"]))
+      return args
+    end
+
+
+    # set_user_response methods
+
+    def self.set_user_response(a,b)
+      set_user_response_valid?(a,b)
+      return {
+        :procedure => "set_user_response",
+        :args => {
+          :a => hashize(a),
+          :b => hashize(b),
+        }
+      }
+    end
+
+    def self.set_user_response_valid?(a,b)
+      invalid_type("a", Fixnum, a) unless a.class == Fixnum
+      invalid_type("b", String, b) unless b.class == String
+      raise_errors unless errors.empty?
+    end
+
+    def self.set_user_response_hash_to_args(hash_args)
+      args = []
+      args.push(Fixnum.create(hash_args["a"]))
+      args.push(String.create(hash_args["b"]))
+      return args
+    end
+
+
+    # set_user_error_invalid_user methods
+
+    def self.set_user_error_invalid_user(message)
+      set_user_error_invalid_user_valid?(message)
+      return {
+        :procedure => "set_user_error_invalid_user",
+        :args => {
+          :message => hashize(message),
+        }
+      }
+    end
+
+    def self.set_user_error_invalid_user_valid?(message)
+      invalid_type("message", String, message) unless message.class == String
+      raise_errors unless errors.empty?
+    end
+
+    def self.set_user_error_invalid_user_hash_to_args(hash_args)
+      args = []
+      args.push(String.create(hash_args["message"]))
+      return args
+    end
+
+
+
+    def self.hashize(var)
+      return var if primitive_type?(var.class)
+      var.to_hash
+    end
+
+    def self.primitive_type?(type)
+      [Fixnum,String].include?(type)
+    end
+  end
+end

data/examples/rails_app/contracts/generated/rb/user.rb

@@ -0,0 +1,53 @@
+require "peto/mixin/peto_class"
+
+module Peto
+  class User
+    include PetoClass
+
+    def self.create(hash_args)
+      instance = new
+      instance.name = hash_args["name"]
+      instance.age = hash_args["age"]
+      instance.animals = hash_args["animals"].map {|arg| Animal.create(arg) }
+      return instance
+    end
+
+    def initialize(args={})
+      @name = nil
+      @age = nil
+      @animals = [] # for Animal
+
+      set_args(args)
+      raise_errors unless valid?
+    end
+
+    attr_reader :name
+    attr_reader :age
+    attr_reader :animals
+
+    def name=(value)
+      @name = value
+      raise_errors unless valid?
+    end
+    def age=(value)
+      @age = value
+      raise_errors unless valid?
+    end
+    def animals=(value)
+      @animals = value
+      raise_errors unless valid?
+    end
+
+    def members
+      [:name,:age,:animals]
+    end
+
+    def types
+      {:name => String,:age => Fixnum,:animals => Array}
+    end
+
+    def arrays
+      {:animals => Animal}
+    end
+  end
+end

data/lib/peto/generator.rb

@@ -18,9 +18,12 @@ class String
   end
 end
 
-def atomic_types
+def rb_primitive_types
   [Fixnum, String]
 end
+def as_primitive_types
+  ["int", "String", "Number", "uint", "Boolean"]
+end
 
 module Peto
   class Generator

data/lib/peto/master.rb

@@ -1,7 +1,8 @@
 require "pathname"
 require "yaml"
-require "peto/generator"
+require "fileutils"
 require "term/ansicolor"
+require "peto/generator"
 
 class String
   include Term::ANSIColor
@@ -16,15 +17,16 @@ module Peto
     end
     attr_reader :contract
 
-    def parse
+    def parse(language)
       (@contract["types"]||{}).inject({}) {|result, type|
-        result.merge!(Generator.new(@contract).generate_class(TEMPLATE_DIR + "/rb_classes.erb", type))
-      }.merge!(Generator.new(@contract).generate_procedure(TEMPLATE_DIR + "/rb_procedures.erb"))
+        result.merge!(Generator.new(@contract).generate_class(TEMPLATE_DIR + "/#{language}_classes.erb", type))
+      }.merge!(Generator.new(@contract).generate_procedure(TEMPLATE_DIR + "/#{language}_procedures.erb"))
     end
 
-    def generate(output_dir=nil)
-      parse.each do |name, content|
-        filepath = File.join(output_dir||File::dirname(@filename), "#{name}.rb")
+    def generate(language, output_dir=nil)
+      raise "language is nil" if language.nil?
+      parse(language).each do |name, content|
+        filepath = File.join(output_dir||File::dirname(@filename), language, "#{name}.#{language}")
         write(filepath, content)
       end
     end
@@ -38,6 +40,7 @@ module Peto
           print "   update".white.bold
         end
       else
+        FileUtils.mkdir_p(File.dirname(filepath))
         print "   create".green.bold
       end
       print " "

data/lib/peto/rake_task.rb

@@ -6,6 +6,8 @@ module Peto
   class RakeTask < ::Rake::TaskLib
     attr_accessor :contracts
     attr_accessor :output_dir
+    attr_accessor :languages
+
     attr_accessor :name
     attr_accessor :fail_on_error
     attr_accessor :failure_message
@@ -13,6 +15,8 @@ module Peto
     def initialize(*args)
       @contracts ||= []
       @output_dir ||= "./"
+      @languages ||= []
+
       @name ||= :peto
       @fail_on_error ||= true
 
@@ -26,15 +30,17 @@ module Peto
             puts "No contracts"
           else
             begin
-              self.contracts = [contracts] if contracts.class == String
-              contracts.each do |contract|
-                peto = Peto::Master.new
-                peto.load(contract)
-                peto.generate(output_dir)
+              languages.each do |language|
+                self.contracts = [contracts] if contracts.class == String
+                contracts.each do |contract|
+                  peto = Peto::Master.new
+                  peto.load(contract)
+                  peto.generate(language, output_dir)
+                end
               end
-            rescue
-              puts failure_message if failure_message
-              raise "peto failed" if fail_on_error
+            #rescue
+            #  puts failure_message if failure_message
+            #  raise "peto failed" if fail_on_error
             end
           end
         end

data/lib/templates/as_classes.erb

@@ -0,0 +1,60 @@
+<%- name = @target[:name].camelize -%>
+<%- args = @target[:args] -%>
+import peto.*;
+
+package peto
+{
+	class <%= name %>
+	{
+		public static function create(hash_args):<%=name%>
+		{
+			var instance:<%= name %> = new <%= name %>;
+			<%- args.each do |arg| -%>
+				<%- if rb_primitive_types.include?(arg[:type].constantize) -%>
+			instance.<%=arg[:name]%> = hash_args.<%= arg[:name]%>;
+				<%- elsif arg[:array_type] -%>
+			for each ( var arg:Object in hash_args.<%= arg[:name]%>)
+				instance.<%=arg[:name]%>.push(<%=arg[:array_type]%>.create(arg));
+				<%- else -%>
+			instance.<%=arg[:name]%> = <%=arg[:type]%>.create(hash_args.<%= arg[:name]%>);
+				<%- end -%>
+			<%- end -%>
+			return instance;
+		}
+
+		public function <%=name%>(<%= args.map{|arg| "#{arg[:name]}:#{arg[:type]}"}.join(",") %>)
+		{
+		<%- args.each do |arg| -%>
+			this.<%= arg[:name] %> = <%= arg[:name] %>;
+		<%- end -%>
+		}
+
+		<%- args.each do |arg| -%>
+		private var <%= arg[:name] %>:<%= arg[:type] %>;
+		public function get <%= arg[:name] %>():<%= arg[:type] %>
+		{
+			return <%= arg[:name] %>;
+		}
+		public function set <%= arg[:name] %>(value:<%= arg[:type] %>)
+		{
+			<%= arg[:name] %> = value;
+		}
+		<%- end -%>
+
+		public function toHash():Object
+		{
+			var hash:Object = new Object;
+			<%- args.each do |arg| -%>
+				<%- if rb_primitive_types.include?(arg[:type].constantize) -%>
+			hash_args["<%= arg[:name]%>"] = <%=arg[:name]%>;
+				<%- elsif arg[:array_type] -%>
+			for each ( var arg:<%= arg[:array_type]%> in <%= arg[:name]%>)
+				hash_args["<%= arg[:name]%>"] = <%=arg[:name]%>.toHash():
+				<%- else -%>
+			hash_args["<%= arg[:name]%>"] = <%=arg[:name]%>.toHash():
+				<%- end -%>
+			<%- end -%>
+			return hash;
+		}
+	}
+}

data/lib/templates/as_procedures.erb

@@ -0,0 +1,55 @@
+<%-
+  def comma_args(args)
+    args.map{|arg| arg[:name]}.join(",")
+  end
+  def comma_args_with_type(args)
+    args.map{|arg| "#{arg[:name]}:#{arg[:type]}"}.join(",")
+  end
+-%>
+
+import peto.*;
+
+package peto
+{
+	class <%= class_name %>
+	{
+		<%- each_procedures do |name, args| -%>
+		// <%=name%> methods
+
+		public static function <%= name %>(<%= comma_args_with_type(args) %>):Object
+		{
+			return {
+				procedure : "<%=name%>",
+				args : {
+				<%- args.each do |arg| -%>
+					<%=arg[:name]%> : hashize(<%=arg[:name]%>),
+				<%- end -%>
+				}
+			}
+		}
+
+		public static function <%= name %>_hash_to_args(hash_args:Object):Array
+		{
+			var args:Array = new Array();
+			<%- args.each do |arg| -%>
+			args.push(<%=arg[:type]%>.create(hash_args.<%=arg[:name]%>));
+			<%- end -%>
+			return args;
+		}
+
+		<%- end -%>
+
+		public static function hashize(var:Object):Object
+		{
+			if ( isPrimitiveType(typeof(var)) )
+				return var;
+			else
+				return var.toHash();
+		}
+
+		public static function isPrimitiveType(type):Boolean
+		{
+			[<%=as_primitive_types.join(",")%>].indexOf?(type) != -1;
+		}
+	}
+}

data/lib/templates/rb_classes.erb

@@ -9,7 +9,7 @@ module Peto
     def self.create(hash_args)
       instance = new
       <%- args.each do |arg| -%>
-        <%- if atomic_types.include?(arg[:type].constantize) -%>
+        <%- if rb_primitive_types.include?(arg[:type].constantize) -%>
       instance.<%=arg[:name]%> = hash_args["<%= arg[:name]%>"]
       <%- elsif arg[:array_type] -%>
       instance.<%=arg[:name]%> = hash_args["<%= arg[:name]%>"].map {|arg| <%=arg[:array_type]%>.create(arg) }

data/lib/templates/rb_procedures.erb

@@ -44,12 +44,12 @@ module Peto
     <%- end -%>
 
     def self.hashize(var)
-      return var if atomic_type?(var.class)
+      return var if primitive_type?(var.class)
       var.to_hash
     end
 
-    def self.atomic_type?(type)
-      [<%=atomic_types.join(",")%>].include?(type)
+    def self.primitive_type?(type)
+      [<%=rb_primitive_types.join(",")%>].include?(type)
     end
   end
 end

data/test/test_peto.rb

@@ -25,8 +25,8 @@ class TestPeto < Test::Unit::TestCase
         @peto.load("test/contracts/generating.yml")
       end
       should "returns string by loaded contract" do
-        assert_equal Hash, @peto.parse.class
-        @peto.parse.each do |name, content|
+        assert_equal Hash, @peto.parse(:rb).class
+        @peto.parse(:rb).each do |name, content|
           assert_equal String, name.class
           assert_equal String, content.class
         end
@@ -38,7 +38,7 @@ class TestPeto < Test::Unit::TestCase
     setup do
       @peto = Peto::Master.new
       @peto.load("test/contracts/generating.yml")
-      @generated = @peto.parse
+      @generated = @peto.parse(:rb)
     end
     should "be readable as ruby" do
       @generated.each do |filepath, content|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Toshiyuki Hirooka
@@ -81,6 +81,8 @@ files:
 - lib/peto/rails/rails_controller_helper.rb
 - lib/peto/rails/rails_controller_test_helper.rb
 - lib/peto/rake_task.rb
+- lib/templates/as_classes.erb
+- lib/templates/as_procedures.erb
 - lib/templates/rb_classes.erb
 - lib/templates/rb_procedures.erb
 - test/contracts/generating.yml
@@ -112,6 +114,9 @@ files:
 - examples/rails_app/contracts/generated/animal.rb
 - examples/rails_app/contracts/generated/aho.rb
 - examples/rails_app/contracts/generated/user.rb
+- examples/rails_app/contracts/generated/rb/animal.rb
+- examples/rails_app/contracts/generated/rb/user.rb
+- examples/rails_app/contracts/generated/rb/foo.rb
 - examples/rails_app/contracts/generated/foo.rb
 - examples/rails_app/contracts/generated/iasdaho.rb
 has_rdoc: true
@@ -174,5 +179,8 @@ test_files:
 - examples/rails_app/contracts/generated/animal.rb
 - examples/rails_app/contracts/generated/aho.rb
 - examples/rails_app/contracts/generated/user.rb
+- examples/rails_app/contracts/generated/rb/animal.rb
+- examples/rails_app/contracts/generated/rb/user.rb
+- examples/rails_app/contracts/generated/rb/foo.rb
 - examples/rails_app/contracts/generated/foo.rb
 - examples/rails_app/contracts/generated/iasdaho.rb