shatter-rb 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564bbc6ee68afe29dbe4466769257f1d433c4a2b59903bb3f3b776f3269dfe51
-  data.tar.gz: b3b7a0dcb2a1da8c81c3bdeb5ed89187825bf20c8357efa7332c417a2c3c2924
+  metadata.gz: f44b926ef9ef04ce878e7fd7a178560dc4f60038360627c8ed9cffa2dfba6eb3
+  data.tar.gz: cc4471e4f4d4da99db000efc779402673fe4fd843393cef0d9e5d62826952007
 SHA512:
-  metadata.gz: f8e8ff85420ef7537b745e10893162d8386e40bcd7cc00e471920fc3e3d50868ab4104af7c4d42c82464f146f794658673211082945ea96934d093bb4ec0509d
-  data.tar.gz: 7b0d10b9f797a01dd4efb161413094134ed6d20bad41ada4628ea6da7cc31a255fcfa5844957e4e0aa175a9890fbd8fa944da597575676badebcbe15faeecbf7
+  metadata.gz: f3422d6cd07a1977b6d2d8f293932716f3dea5ce8ce39bee5d925efae211c9163e4a3f0e06f566b7f983f6719a9b80db949fd76da08d8a4191a2ba047d011a53
+  data.tar.gz: e76434e400acaa9e0796d068b7ee792bdcdd866e2ea2c85d13bf5f2851a571fad696dbdd892d205d52ee789607cd655335eec4e8cae7dc6ff9e7dd23f7d394e8

data/.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 
+npx --no -- commitlint --edit 

data/.rubocop.yml

@@ -4,6 +4,10 @@ require:
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.1
+  Exclude:
+    - vendor/bundle/**/*
+    - exe/**/*
+    - Guardfile
 
 Style/StringLiterals:
   Enabled: true

data/.ruby-version

@@ -1 +1 @@
-3.2.0
+3.1.0

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.0
+ruby 3.1.0

data/Gemfile

@@ -4,5 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in shatter.gemspec
 gemspec
-
-gem "zookeeper", "~>1.5.4", github: 'EricRoos/zookeeper'

data/Gemfile.lock

@@ -1,39 +1,71 @@
-GIT
-  remote: https://github.com/EricRoos/zookeeper.git
-  revision: e024228fc1c3c22cd3b0854ff15ad0d53a98c4ae
-  specs:
-    zookeeper (1.5.4)
-
 PATH
   remote: .
   specs:
-    shatter-rb (0.0.2)
+    shatter-rb (0.1.0)
       concurrent-ruby (~> 1.1)
       erb (~> 2.2.0)
       puma (~> 6.0)
       rack (~> 3.0)
+      rack-cors (~> 1.1)
       thor (~> 1.2.1)
+      zeitwerk
       zk (~> 1.10)
+      zookeeper (~> 1.5.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     cgi (0.3.6)
+    coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     erb (2.2.3)
       cgi
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     json (2.6.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
     nio4r (2.5.8)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     puma (6.0.2)
       nio4r (~> 2.0)
     rack (3.0.3)
+    rack-cors (1.1.1)
+      rack (>= 2.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.6.1)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -66,22 +98,33 @@ GEM
     rubocop-rspec (2.16.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     thor (1.2.1)
     unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
     zk (1.10.0)
       zookeeper (~> 1.5.0)
+    zookeeper (1.5.5)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  guard
+  guard-rspec
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.16.0)
   shatter-rb!
-  zookeeper (~> 1.5.4)!
+  simplecov
 
 BUNDLED WITH
    2.4.1

data/Guardfile

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -1,30 +1,88 @@
-# Shatter
 
-TODO: Delete this and the text below, and describe your gem
+![shatter-banner](https://user-images.githubusercontent.com/1334489/211411749-49d3377f-e413-4838-bae7-60705688b514.png#gh-light-mode-only)
+![shatter-banner-darkmode](https://user-images.githubusercontent.com/1334489/211412250-0660c441-31f1-4d74-87f8-5118ccebffa0.png#gh-dark-mode-only)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shatter`. To experiment with that code, run `bin/console` for an interactive prompt.
+<p align='center'>
+An async first RPC app server built in Ruby. Supported by DRb, Puma, and Zookeeper.
+</p>
 
-## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Why
 
-Install the gem and add to the application's Gemfile by executing:
+Small apps are very common and RPC is a great simple alternative to REST, GraphQL, SOAP, and others. Shatter allows you to very simply, without too much opinion, define your business functions and invoke them with a premade HTTP endpoint. 
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## Whats needed
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+* Ruby3.1 and later
+* A box to run it on
+* Zookeeper instance
+* Optional: Extra server to run the service layer across different boxes.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-## Usage
+## Developing
 
-TODO: Write usage instructions here
+### Installation
+Start with creating your project directory.
+```
+mkdir MyApp
+```
 
-## Development
+Create a new Gemfile and `bundle install`.
+```ruby
+source "https://rubygems.org"
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+gem 'shatter-rb'
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Create the project with:
+```
+bundle exec shatter new <AppName>
+```
+For now, app name should be in provided in UpperCamelCase.
+
+
+Init zookeeper with the required keys needed
+```ruby
+bundle exec shatter init_service_discovery
+```
+
+
+Finally, you start shatter by running both the web server and service applications.
+
+```bash
+bin/service
+bin/server
+```
+
+Congrats! Shatter is up and running!
+
+### Testing things out
+
+Included in the setup is one example `HelloWorldFunction` to show you how things work. You can invoke it with curl like:
+
+```
+curl -i -X POST -d '{}' localhost:9292/hello_world
+```
+
+Check the `location` header in the response and follow that url till your response is ready. The Javascript client does all this for you, however.
+
+
+You can check out a demo js script here:
+https://github.com/EricRoos/shatter/blob/main/javascript/dist/demo.js
+
+
+
+### Front end things
+
+We suggest you use Vite to setup your front end. Shatter comes with the ability to export your functions to a typescript definition that will give you a configured out of the box client ready for use. No need for wiring yourself except for importing whats generated.
+
+You can generate your typescript with:
+
+```
+  bundle exec shatter generate_typescript --path web/src/
+```
+
+Assuming you have setup your javascript based front end at ./web
 
 ## Contributing
 
@@ -37,3 +95,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Shatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shatter/blob/master/CODE_OF_CONDUCT.md).
+
+## Attribution
+
+Shatter logo provided by: <a href='https://pngtree.com/so/Beautiful'>Beautiful png from pngtree.com/</a>

data/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}

data/example_app/Gemfile

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
-gem 'shatter', path: '..'
-gem "zookeeper", "~>1.5.4", github: 'EricRoos/zookeeper'
+gem "shatter-rb", path: ".."
 
 gem "foreman", "~> 0.87.2"

data/example_app/Gemfile.lock

@@ -1,21 +1,16 @@
-GIT
-  remote: https://github.com/EricRoos/zookeeper.git
-  revision: e024228fc1c3c22cd3b0854ff15ad0d53a98c4ae
-  specs:
-    zookeeper (1.5.4)
-
 PATH
   remote: ..
   specs:
-    shatter (0.1.0)
+    shatter-rb (0.0.2)
       concurrent-ruby (~> 1.1)
       erb (~> 2.2.0)
-      pg (~> 1.4)
       puma (~> 6.0)
       rack (~> 3.0)
-      rackup (~> 0.2.3)
+      rack-cors (~> 1.1)
       thor (~> 1.2.1)
+      zeitwerk
       zk (~> 1.10)
+      zookeeper (~> 1.5.4)
 
 GEM
   remote: https://rubygems.org/
@@ -26,25 +21,23 @@ GEM
       cgi
     foreman (0.87.2)
     nio4r (2.5.8)
-    pg (1.4.5)
     puma (6.0.2)
       nio4r (~> 2.0)
     rack (3.0.3)
-    rackup (0.2.3)
-      rack (>= 3.0.0.beta1)
-      webrick
+    rack-cors (1.1.1)
+      rack (>= 2.0.0)
     thor (1.2.1)
-    webrick (1.7.0)
+    zeitwerk (2.6.6)
     zk (1.10.0)
       zookeeper (~> 1.5.0)
+    zookeeper (1.5.5)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   foreman (~> 0.87.2)
-  shatter!
-  zookeeper (~> 1.5.4)!
+  shatter-rb!
 
 BUNDLED WITH
    2.4.1

data/example_app/app/application.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Application < Shatter::Web::Application
+end

data/example_app/app/functions/hello_world_function.rb

@@ -1,19 +1,11 @@
-require "pg"
-require "shatter/service/function"
-require "shatter/service/function_params"
+# frozen_string_literal: true
 
-module MyApp
-  module Functions
-    class HelloWorldFunction < Shatter::Service::Function
+class HelloWorldFunction < Shatter::Service::Function
+  define_param :name, nullable: false, type: "string"
+  define_param :number, nullable: false, type: "integer"
 
-      define_param :name, nullable: false, type: 'string'
-      define_param :number, nullable: false, type: 'integer'
-
-
-      def invoke
-        params.to_h => name:, number:
-        { result: "Hello #{name}, your number is #{number || 'unknown'}.", error: nil, }
-      end
-    end
+  def invoke
+    params.to_h => name:, uuid:
+    { result: "Hello #{name}", error: nil, uuid: }
   end
-end
+end

data/example_app/app/service_definition.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './functions/hello_world_function'
-
-module MyApp
-  class ServiceDefinition < Shatter::Service::ServiceDefinition
-    register_function :hello_world, MyApp::Functions::HelloWorldFunction
-  end
+class ServiceDefinition < Shatter::Service::ServiceDefinition
+  register_function :hello_world, HelloWorldFunction
 end

data/example_app/application.rb

@@ -1,6 +1,8 @@
-module MyApp
+# frozen_string_literal: true
+
+module ExampleApp
   class Application < Shatter::Web::Application
   end
 end
 
-require_relative './app/service_definition'
+require_relative "./app/service_definition"

data/example_app/bin/service

@@ -10,7 +10,7 @@ require_relative "../config/environment"
 begin
   Shatter::Service::Base.init
 rescue Interrupt => e
-  Shatter::Service::Base.close
-rescue SignalException => e
+  puts e.message
+  puts e.backtrace
   Shatter::Service::Base.close
 end

data/example_app/config/environment.rb

@@ -1,9 +1,15 @@
-Shatter::Config.zookeeper_host = "localhost:2181"
-Shatter::Config.initial_delay = 100
-Shatter::Config.missing_result_delay = 100
-Shatter::Config.service_port = ENV.fetch('SHATTER_SERVICE_PORT') { 8787 }
+# frozen_string_literal: true
 
-require_relative '../application'
+Shatter.config do |config|
+  config.root = File.expand_path("..", __dir__)
+  config.zookeeper_host = "localhost:2181"
+  config.initial_delay = 100
+  config.missing_result_delay = 100
+  config.service_port = ENV.fetch("SHATTER_SERVICE_PORT", 8787)
+  config.autoload_paths = %w[app app/functions]
+end
 
-Shatter::Service::Base.service_definition = MyApp::ServiceDefinition
-Shatter::Web::Server.application = MyApp::Application
+Shatter.load
+
+Shatter::Service::Base.service_definition = ServiceDefinition
+Shatter::Web::Server.application = Application

data/example_app/config.ru

@@ -2,8 +2,16 @@
 
 require "bundler/setup"
 require "shatter"
+require "rack/cors"
 
 require_relative "./config/environment"
 
 use Rack::CommonLogger
+
+use Rack::Cors do
+  allow do
+    origins "*"
+    resource "*", headers: :any, methods: %i[get post patch put], expose: %w[delay location]
+  end
+end
 run Shatter::Web::Server

data/exe/console

@@ -8,5 +8,5 @@ $stdout.sync = true
 require_relative "../config/environment"
 require_relative "../application"
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/exe/shatter

@@ -1,7 +1,11 @@
 #!/usr/bin/env ruby
-require 'shatter'
-require 'thor'
-require 'erb'
+# frozen_string_literal: true
+
+require "shatter"
+require "thor"
+require "erb"
+require "fileutils"
+require 'zk'
 $stdout.sync = true
 
 def safe_makedir(path)
@@ -11,54 +15,60 @@ end
 class ShatterCLI < Thor
   desc "init_service_discovery", "Sets up required keys for service discovery to work properly"
 
+  desc "init_service_discovery", "creates necessary keys in zookeeper"
   def init_service_discovery
+    Shatter.load_environment
     zk = ZK.new(Shatter::Config.zookeeper_host)
-    zk.create('/shater_service_instances')
-    zk.create('/shatter::response_data_locations')
+    [ 
+      Shatter::Util.instances_key,
+      Shatter::Util.zookeeper_response_key_root,
+    ].each do |key|
+      next if zk.exists?(key)
+      zk.create(key)
+    end
     zk.close
   end
 
+  desc "generate_typescript", "generates typescript defs of your service definition"
+  option :path
+  def generate_typescript
+    Shatter.load_environment
+    File.open("#{Shatter.root}/#{options[:path]}/Client.ts", "w") { |f| f.write(ServiceDefinition.to_typescript) }
+  end
+
   desc "new APP_NAME", "scaffold a new shatter app"
   def new(app_name)
     puts "Generating new Shatter APP - #{app_name}"
 
     puts "Updating Gemfile"
-    FileUtils.cp("#{__dir__}/../templates/Gemfile.template","./Gemfile")
+    ::FileUtils.cp("#{__dir__}/../templates/Gemfile.template", "./Gemfile")
     system("bundle install")
 
     puts "Generating scripts"
-    FileUtils.mkdir("./bin", noop: Dir.exist?('./bin'))
+    FileUtils.mkdir("./bin", noop: Dir.exist?("./bin"))
     FileUtils.cp("#{__dir__}/../bin/service", "./bin/service", verbose: true)
     FileUtils.cp("#{__dir__}/../bin/server", "./bin/server", verbose: true)
 
     puts "Generating boilerplate"
 
     application_code = ERB.new(File.read("#{__dir__}/../templates/application.erb")).result(binding)
-    File.open("./application.rb", "w") do |f|
-      f.write application_code
-    end
+    safe_makedir("./app")
+    File.write("./app/application.rb", application_code)
 
     FileUtils.cp("#{__dir__}/../templates/config.ru", "./config.ru", verbose: true)
     FileUtils.cp("#{__dir__}/../templates/docker-compose.yml.example", "./docker-compose.yml", verbose: true)
 
-    safe_makedir('./app')
 
     service_definition = ERB.new(File.read("#{__dir__}/../templates/service_definition.rb.erb")).result(binding)
-    File.open("./app/service_definition.rb", "w") do |f|
-      f.write service_definition
-    end
+    File.write("./app/service_definition.rb", service_definition)
 
-    safe_makedir('./app/functions')
+    safe_makedir("./app/functions")
     sample_function = ERB.new(File.read("#{__dir__}/../templates/hello_world_function.rb.erb")).result(binding)
-    File.open("./app/functions/hello_world_function.rb", "w") do |f|
-      f.write sample_function
-    end
-    safe_makedir('./config')
+    File.write("./app/functions/hello_world_function.rb", sample_function)
+    safe_makedir("./config")
 
     environment_config = ERB.new(File.read("#{__dir__}/../templates/environment.rb.erb")).result(binding)
-    File.open("./config/environment.rb", "w") do |f|
-      f.write environment_config
-    end
+    File.write("./config/environment.rb", environment_config)
   end
 end
-ShatterCLI.start(ARGV)
+ShatterCLI.start(ARGV)

data/lib/shatter/config.rb

@@ -3,10 +3,20 @@
 module Shatter
   class Config
     class << self
-      attr_accessor :zookeeper_host
-      attr_accessor :initial_delay
-      attr_accessor :missing_result_delay
-      attr_accessor :service_port
+      attr_accessor :zookeeper_host, :service_port, :root, :reload_classes
+      attr_writer :autoload_paths, :initial_delay, :missing_result_delay
+
+      def autoload_paths
+        @autoload_paths ||= []
+      end
+
+      def initial_delay
+        @initial_delay || 100
+      end
+
+      def missing_result_delay
+        @missing_result_delay || 100
+      end
     end
   end
 end