runways 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e982aaecae5159992f07d2a5edbc6be3c37d9ca02658cfd0077f8d05eccc7e63
-  data.tar.gz: 70535c84bcdad8ef21a0c9c950119b784b7420e786229ecf1fb90b5aaecb077c
+  metadata.gz: 38f45a3b612a1641cfbef86e72e0521c7f6488473724aa94df6b9740ce329d54
+  data.tar.gz: 1f768cc190fe9ce380e63a72dd4720556c96e1bd94c3adde4d01111af7b0b699
 SHA512:
-  metadata.gz: 10d215260565f79d4e378facdac4c6a63b409553f109a0a53f689be57bd48bd3d0f2084e5ddcfca669831b9c54bc2034285ef7fc772095928787fd2c3b8c76d3
-  data.tar.gz: 5725e891dc785f52d2ac395f08b10b13556749b99423eedf5bc36acb1b2a7d569dc7cd368f8711b596fb5d5bdd289cd202a15fc025dea6c7c454cea2d585b358
+  metadata.gz: ca1b07e2162af7aeca9d6fc378b2534a58959fe4668356095e3a656c1a27357f22be74d9b8fdcb5c79ae3aa2384d1477de7c698b6086eb0411b5bb89bac2a69f
+  data.tar.gz: '083596ed81e0dd1486782ac3b61c17f7a2a23933d84cfbf7b359a79cb0b081f711776a2d70d976b0eb12e755a310b747a9ced7a2c01c0fc5fcd4697ab78839e9'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    runways (0.1.6)
+    runways (0.1.7)
       activerecord (~> 5.2)
       grpc (~> 1.16)
       grpc-tools (~> 1.16)
@@ -23,10 +23,10 @@ GEM
       tzinfo (~> 1.1)
     arel (9.0.0)
     concurrent-ruby (1.1.3)
-    google-protobuf (3.6.1)
+    google-protobuf (3.6.1-universal-darwin)
     googleapis-common-protos-types (1.0.2)
       google-protobuf (~> 3.0)
-    grpc (1.16.0)
+    grpc (1.16.0-universal-darwin)
       google-protobuf (~> 3.1)
       googleapis-common-protos-types (~> 1.0.0)
     grpc-tools (1.16.0)

data/README.md

@@ -1,5 +1,4 @@
 # Runways
-
 Runways is a gRPC based ruby application. It will setup the basic project structure with active_record ORM.
 
 ## Installation
@@ -10,7 +9,7 @@ Install Runways at the command prompt:
 
 Create a new runways application:
 
-  $ runways hello
+  $ runways new hello
 
 Run the following rake task to update protobuf files:
 
@@ -48,7 +47,7 @@ Everyone interacting in the Runways project’s codebases, issue trackers, chat
 - [ ] Setup logging
 - [ ] Use ActiveRecord generators to handle ActiveRecord related tasks ( ex: generate migration, migrate, rollback )
 - [ ] Create runways controller
-- [ ] Refactor generator code
+- [x] Refactor generator code
 - [ ] Refactor code to generate protobuf files when the application is initialized
 - [x] Handle loading the server without DbConfig setup
 - [ ] Handle DbConfig in the ActiveRecord style
@@ -56,3 +55,7 @@ Everyone interacting in the Runways project’s codebases, issue trackers, chat
 - [x] Handle file loading like how rails handles it
 - [ ] Accept package name from command line
 - [ ] Don't hard code port
+- [ ] Figure out how to handle nil values in the GRPC request
+- [ ] Add callbacks for RPC's
+- [ ] Test for streaming rpcs
+- [ ] How to generalize interceptors for simple & streaming rpcs

data/exe/runways

@@ -2,4 +2,4 @@
 
 require 'runways'
 
-AppStructure.start
+Runways::CLI.start(ARGV)

data/lib/runways.rb

@@ -3,6 +3,9 @@ require "active_record"
 require "runways/version"
 require "runways/generators/app_structure_generator"
 require "runways/dependencies"
+require "runways/cli"
+require "runways/interceptors/base_interceptor"
+require "runways/interceptors/benchmark_interceptor"
 
 module Runways
   # Your code goes here...

data/lib/runways/cli.rb

@@ -0,0 +1,10 @@
+module Runways
+  class CLI < Thor
+    desc "new name", "provide name for the framework"
+    def new(app_name)
+      puts "building framework #{app_name}"
+
+      AppStructure.start([app_name])
+    end
+  end
+end

data/lib/runways/generators/app_structure_generator.rb

@@ -9,91 +9,198 @@ class AppStructure < Thor::Group
     File.dirname(__FILE__)
   end
 
-  def create_basic_app_structure
-    root_directory = name.to_s
-    app_directory = root_directory + "/app"
-    models_directory = app_directory + "/models"
-    controller_directory = app_directory + "/controllers"
-    db_directory = root_directory + "/db"
-    migration_directory = db_directory + "/migrate"
-    lib_directory = root_directory + "/lib"
-    lib_protos_directory = lib_directory + "/protos"
-    tasks_directory = lib_directory + "/tasks"
-    config_directory = root_directory + "/config"
-    test_directory = root_directory + "/test"
+  def root_directory
+    app_name = name.to_s
+    empty_directory(app_name)
+    path = app_name
+
+    app_directory(path)
+    db_directory(path)
+    lib_directory(path)
+    proto_directory(path)
+    config_directory(path)
+    test_directory(path)
+
+    generate_gemfile(path)
+    generate_rake_file(path)
+    generate_server_file(path)
+
+    run_protoc_cmd(path)
+    run_bundle_install(path)
+  end
+
+  private
+  def app_directory(path)
+    path += "/app"
+    empty_directory(path)
 
-    create_following_dirs([
-      root_directory, app_directory, config_directory,
-      lib_directory, lib_protos_directory, tasks_directory,
-      models_directory, controller_directory,
-      db_directory, migration_directory, test_directory,
-    ])
+    models_directory(path)
   end
 
-  def generate_proto_file
-    # generate from template
-    template("templates/proto.tt", "#{name}/proto/#{name}.proto")
+  def models_directory(path)
+    path += "/models"
+    empty_directory(path)
+
+    generate_application_record(path)
   end
 
-  def generate_gemfile
-    template("templates/gemfile.tt", "#{name}/Gemfile")
+  def generate_application_record(path)
+    path += "/"
+    template_name = "application_record"
+    generate_template(path: path, template_name: template_name, extenstion: 'rb')
   end
 
-  def generate_db_rake_file
-    template("templates/db_rake.tt", "#{name}/lib/tasks/db.rake")
+  def db_directory(path)
+    path += "/db"
+    empty_directory(path)
+
+    migration_directory(path)
   end
 
-  def generate_rake_file
-    template("templates/rakefile.tt", "#{name}/Rakefile")
+  def migration_directory(path)
+    path += "/migrate"
+    empty_directory(path)
   end
 
-  def generate_application_record
-    template(
-      "templates/application_record.tt",
-      "#{name}/app/models/application_record.rb"
+  def lib_directory(path)
+    path += "/lib"
+    empty_directory(path)
+
+    protos_directory(path)
+    tasks_directory(path)
+
+    generate_service_file(path)
+  end
+
+  def protos_directory(path)
+    path += "/protos"
+    empty_directory(path)
+  end
+
+  def tasks_directory(path)
+    path += "/tasks"
+    empty_directory(path)
+
+    generate_db_rake_file(path)
+    generate_protofub_rake_file(path)
+  end
+
+  def generate_db_rake_file(path)
+    path += "/"
+    generate_template(
+      path: path, extenstion: 'rake', template_name: 'db'
     )
   end
 
-  def generate_service_file
-    template(
-      "templates/service.tt",
-      "#{name}/lib/#{name.underscore}_service.rb"
+  def generate_protofub_rake_file(path)
+    path += "/"
+    generate_template(
+      path: path, extenstion: 'rake', template_name: 'generate_protobuf_files'
     )
   end
 
-  def generate_server_file
-    template(
-      "templates/server.tt",
-      "#{name}/#{name.underscore}_server.rb"
+  def generate_service_file(path)
+    path += "/"
+    file_name = "#{name.underscore}_service"
+
+    generate_template(
+      path: path, file_name: file_name,
+      extenstion: 'rb', template_name: "service"
     )
   end
 
-  def generate_db_config_file
-    template("templates/db_config.tt", "#{name}/config/db_config.rb")
+  def proto_directory(path)
+    path += "/proto"
+    empty_directory(path)
+
+    generate_proto_file(path)
   end
 
-  def generate_protofub_file
-    template("templates/protobuf_rake.tt", "#{name}/lib/tasks/generate_protobuf_files.rake")
+  def generate_proto_file(path)
+    path += "/"
+    generate_template(
+      path: path, extenstion: 'proto', template_name: 'proto', file_name: name
+    )
   end
 
-  def generate_test_client_file
-    template("templates/test_client.tt", "#{name}/test/test_client.rb")
+  def config_directory(path)
+    path += "/config"
+    empty_directory(path)
+
+    generate_db_config_file(path)
+    generate_application_config_file(path)
   end
 
-  def generate_application_file
-    template("templates/application_config.tt", "#{name}/config/application.rb")
+  def generate_db_config_file(path)
+    path += "/"
+    generate_template(
+      path: path, extenstion: 'rb', template_name: 'db_config'
+    )
   end
 
-  def run_protoc_cmd
-    inside(name) do
+  def generate_application_config_file(path)
+    path += "/"
+    generate_template(
+      path: path, extenstion: 'rb', template_name: 'application'
+    )
+  end
+
+  def test_directory(path)
+    path += "/test"
+    empty_directory(path)
+
+    generate_test_client_file(path)
+  end
+
+  def generate_test_client_file(path)
+    path += "/"
+    generate_template(
+      path: path, extenstion: 'rb', template_name: 'test_client'
+    )
+  end
+
+  def generate_gemfile(path)
+    path += "/"
+    generate_template(
+      path: path, template_name: 'Gemfile'
+    )
+  end
+
+  def generate_rake_file(path)
+    path += "/"
+    generate_template(
+      path: path, template_name: 'Rakefile'
+    )
+  end
+
+  def generate_server_file(path)
+    path += "/"
+    generate_template(
+      path: path, template_name: 'server',
+      file_name: name + "_server", extenstion: 'rb'
+    )
+  end
+
+  def run_protoc_cmd(path)
+    inside(path) do
       run ("grpc_tools_ruby_protoc -I proto --ruby_out=lib/protos --grpc_out=lib/protos proto/#{name.underscore}.proto")
     end
   end
 
-  private
-  def create_following_dirs(dir_paths)
-    dir_paths.each do |dir_path|
-      empty_directory(dir_path)
+  def run_bundle_install(path)
+    inside(path) do
+      run ("bundle install")
     end
   end
+
+  def templates_directory
+    "templates"
+  end
+
+  def generate_template(path:, template_name:, extenstion: '', file_name: nil)
+    template(
+      path.sub(name, templates_directory) + template_name + ".tt",
+      path + ( file_name ? file_name : template_name ) + ( extenstion.present? ? '.' + extenstion : extenstion )
+    )
+  end
 end

data/lib/runways/generators/templates/server.tt

@@ -14,10 +14,14 @@ class <%= name.camelize %>Server
     private
 
     def start_grpc_server
-      @server = GRPC::RpcServer.new(pool_size: 5)
+			# Available interceptors Runways::BenchmarkInterceptor
+      @server = GRPC::RpcServer.new(
+			  pool_size: 5,
+				interceptors: []
+			)
       @server.add_http2_port('0.0.0.0:50052', :this_port_is_insecure)
-      @server.handle(<%= name.camelize %>Service)
-      @server.run_till_terminated
+			@server.handle(<%= name.camelize %>Service)
+			@server.run_till_terminated
     end
   end
 end

data/lib/runways/interceptors/base_interceptor.rb

@@ -0,0 +1,23 @@
+module Runways
+  class BaseInterceptor < ::GRPC::ServerInterceptor
+    def all_request_responses(request: nil, call: nil, method: nil)
+      yield
+    end
+
+    def request_response(request: nil, call: nil, method: nil, &block)
+      all_request_responses(request: request, call: call, method: method, &block)
+    end
+
+    def client_streamer(request: nil, call: nil, method: nil, &block)
+      all_request_responses(request: request, call: call, method: method, &block)
+    end
+
+    def server_streamer(request: nil, call: nil, method: nil, &block)
+      all_request_responses(request: request, call: call, method: method, &block)
+    end
+
+    def bidi_streamer(request: nil, call: nil, method: nil, &block)
+      all_request_responses(request: request, call: call, method: method, &block)
+    end
+  end
+end

data/lib/runways/interceptors/benchmark_interceptor.rb

@@ -0,0 +1,11 @@
+module Runways
+  class BenchmarkInterceptor < BaseInterceptor
+    def all_request_responses(request: nil, call: nil, method: nil)
+      realtime = Benchmark.realtime do
+        yield
+      end
+
+      puts "Completed in #{realtime} secs"
+    end
+  end
+end

data/lib/runways/version.rb

@@ -1,3 +1,3 @@
 module Runways
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runways
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - NG
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2018-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,19 +115,22 @@ files:
 - bin/setup
 - exe/runways
 - lib/runways.rb
+- lib/runways/cli.rb
 - lib/runways/dependencies.rb
 - lib/runways/generators/app_structure_generator.rb
-- lib/runways/generators/templates/application_config.tt
-- lib/runways/generators/templates/application_record.tt
-- lib/runways/generators/templates/db_config.tt
-- lib/runways/generators/templates/db_rake.tt
+- lib/runways/generators/templates/app/models/application_record.tt
+- lib/runways/generators/templates/config/application.tt
+- lib/runways/generators/templates/config/db_config.tt
 - lib/runways/generators/templates/gemfile.tt
-- lib/runways/generators/templates/proto.tt
-- lib/runways/generators/templates/protobuf_rake.tt
+- lib/runways/generators/templates/lib/service.tt
+- lib/runways/generators/templates/lib/tasks/db.tt
+- lib/runways/generators/templates/lib/tasks/generate_protobuf_files.tt
+- lib/runways/generators/templates/proto/proto.tt
 - lib/runways/generators/templates/rakefile.tt
 - lib/runways/generators/templates/server.tt
-- lib/runways/generators/templates/service.tt
-- lib/runways/generators/templates/test_client.tt
+- lib/runways/generators/templates/test/test_client.tt
+- lib/runways/interceptors/base_interceptor.rb
+- lib/runways/interceptors/benchmark_interceptor.rb
 - lib/runways/version.rb
 - runways.gemspec
 homepage: https://github.com