ruby-ray 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fa98312ac698f1368bcdba806e12551eefde2b21f1a4bfcf817c08e73b42628
-  data.tar.gz: f8b61fe51c4ed5aa22ec12be7b28cd9bf6be9ad4e367c49e12b343969e53a41d
+  metadata.gz: 255d912e394ce3694f1ad4f46b1d26aafb8dd728b890b8d0939a6446f96a7cb3
+  data.tar.gz: 6bc5a985c7796c9a077193757b6a99344340298bacf13bf3d67256bdba469e20
 SHA512:
-  metadata.gz: c3d87dd7beea1015e61a589089195749b812e7197fe1333c934682afa581140d23a0bde99853ef0ac9a40ce99b68d2452436158438e347a4e7775a162c6759ed
-  data.tar.gz: '048da58bfdf3d105083cb9e7feb532ee37e29ac3f2ab94f5b670950a4b0eb35e1b827f8eec0ef2378d31f410f1bd3dfe78c41cc14662a1200fffcdac65281627'
+  metadata.gz: 6f35df59ebb4b5161d68077f4dfcf013c3349ec54de260dd9e6bea9a712c63498e6b2700ac8e89efc2b079c926465035663f30ae649ccbab32f1227c17c65c80
+  data.tar.gz: 8bb13fb068393ad54559061da0db21efd3405d1ba13a9bad9b6d279dec4e38d6dd967e369198c98322bc680f3cd546da59f02fca9389d16f5b3b6cbeaff9c76f

data/.github/workflows/{main.yml → tests.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: Tests
 
 on: [push,pull_request]
 

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Changelog
+
+All notable changes to `ruby-ray` will be documented in this file.
+
+## [0.3.0] - 2021-02-11
+
+- more payloads
+
 ## [0.2.0] - 2021-02-11
 
 - Relax activesupport dependency

data/README.md

@@ -1,5 +1,9 @@
 # Debug with Ray to fix problems faster
 
+![Gem](https://img.shields.io/gem/v/ruby-ray)
+![Tests](https://github.com/spatie/ruby-ray/workflows/Tests/badge.svg)
+![Downloads](https://img.shields.io/gem/dt/ruby-ray)
+
 This gem can be installed in any Ruby application to send messages to [the Ray app](https://myray.app).
 
 ## Documentation

data/examples/class_name.rb

@@ -0,0 +1,7 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Class name')
+
+ray.class_name('this is a string')
+ray.class_name(5)
+ray.class_name(0..5)

data/examples/colors.rb

@@ -1,6 +1,6 @@
 require_relative "../lib/ray"
 
-# ray.new_screen('Colors')
+ray.new_screen('Colors')
 
 ray('this is green').green
 ray('this is orange').orange

data/examples/demo.rb

@@ -0,0 +1,3 @@
+require_relative "../lib/ray"
+
+ray('demo')

data/examples/json.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Json')
+
+ray.to_json('string', ['a', 'b', 'c'])

data/examples/size.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/ray"
+
+ray.new_screen('Size')
+
+ray('Small item').small
+ray('Large item').large

data/examples/visibility.rb

@@ -6,7 +6,7 @@ ray('collapsed by default').hide
 
 ray = ray('updating this message in two seconds')
 sleep(2)
-ray.send('updated message');
+ray.send('updated message')
 
 ray = ray('removing this item in two seconds')
 sleep(2)

data/lib/ray.rb

@@ -21,6 +21,8 @@ require_relative "ray/payloads/show_app_payload"
 require_relative "ray/payloads/custom_payload"
 require_relative "ray/payloads/notify_payload"
 require_relative "ray/payloads/create_lock_payload"
+require_relative "ray/payloads/size_payload"
+require_relative "ray/payloads/json_string_payload"
 
 module Ray
   class Ray
@@ -53,6 +55,14 @@ module Ray
       color 'gray'
     end
 
+    def small
+      size 'sm'
+    end
+
+    def large
+      size 'lg'
+    end
+
     def new_screen(name = '')
       payload = Payloads::NewScreenPayload.new(name)
 
@@ -99,6 +109,30 @@ module Ray
       send_request payload
     end
 
+    def size(size)
+      payload = Payloads::SizePayload.new(size)
+
+      send_custom payload
+    end
+
+    def class_name(anything)
+      send_custom(anything.class.to_s, 'Class name')
+    end
+
+    def to_json(*args)
+      payloads = args.map do |arg|
+        Payloads::JsonStringPayload.new(arg)
+      end
+
+      send_request payloads
+    end
+
+    def pass(argument)
+      send argument
+
+      return argument
+    end
+
     def pause
       lockName = rand(10 ** 12).to_s
 

data/lib/ray/origin/origin.rb

@@ -0,0 +1,18 @@
+module Ray
+  module Origin
+    class Origin
+
+      def initialize(file, lineNumber)
+        @file = file
+        @lineNumber = lineNumber
+      end
+
+      def to_hash
+        {
+          file: @file,
+          line_number: @lineNumber,
+        }
+      end
+    end
+  end
+end

data/lib/ray/origin/origin_factory.rb

@@ -0,0 +1,20 @@
+require_relative "origin"
+
+module Ray
+  module Origin
+    class OriginFactory
+      def get_origin
+        location = self.get_location
+
+        Origin.new(
+          location ? location.absolute_path: nil,
+          location ? location.lineno : nil,
+        )
+      end
+
+      def get_location
+        caller_locations.find { |location| ! location.path.include? "ruby-ray/lib" }
+      end
+    end
+  end
+end

data/lib/ray/payloads/json_string_payload.rb

@@ -0,0 +1,21 @@
+module Ray
+  module Payloads
+    class JsonStringPayload < Payload
+
+      def initialize(value)
+        @value = value
+      end
+
+      def type
+        'json_string'
+      end
+
+      def content
+        {
+          value: @value.to_json,
+        }
+      end
+
+    end
+  end
+end

data/lib/ray/payloads/payload.rb

@@ -1,9 +1,10 @@
+require_relative "../origin/origin_factory"
+
 module Ray
   module Payloads
     class Payload
 
-      def initialize(*args)
-      end
+      def initialize(*args) end
 
       def type
         raise NotImplementedError, 'You must define the `type` method in your Payload'
@@ -13,6 +14,17 @@ module Ray
         {}
       end
 
+      def to_hash
+        {
+          type: self.type,
+          content: self.content,
+          origin: self.get_origin.to_hash
+        }
+      end
+
+      def get_origin
+        Origin::OriginFactory.new.get_origin
+      end
     end
   end
 end

data/lib/ray/payloads/size_payload.rb

@@ -0,0 +1,22 @@
+module Ray
+  module Payloads
+    class SizePayload < Payload
+
+      def initialize(size)
+        @size = size
+      end
+
+      def type
+        'size'
+      end
+
+      def content
+        {
+          size: @size,
+        }
+      end
+
+    end
+  end
+end
+

data/lib/ray/request.rb

@@ -11,15 +11,9 @@ module Ray
     end
 
     def payload_contents
+
       return @payloads.map do |payload|
-        {
-          type: payload.type,
-          content: payload.content,
-          origin: {
-            file: "the file",
-            line_number: "123",
-          },
-        }
+        payload.to_hash
       end
     end
   end

data/lib/ray/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ray
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ray
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Freek Van der Herten
@@ -33,7 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/SECURITY.md"
-- ".github/workflows/main.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -43,16 +43,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/class_name.rb
 - examples/colors.rb
 - examples/custom.rb
+- examples/demo.rb
 - examples/general.rb
-- examples/newScreen.rb
+- examples/json.rb
+- examples/new_screen.rb
 - examples/notify.rb
 - examples/pause.rb
+- examples/size.rb
 - examples/visibility.rb
 - lib/ray.rb
 - lib/ray/client.rb
 - lib/ray/errors/stop_execution_requested.rb
+- lib/ray/origin/origin.rb
+- lib/ray/origin/origin_factory.rb
 - lib/ray/payload_factory.rb
 - lib/ray/payloads/bool_payload.rb
 - lib/ray/payloads/color_payload.rb
@@ -61,12 +67,14 @@ files:
 - lib/ray/payloads/hide_app_payload.rb
 - lib/ray/payloads/hide_payload.rb
 - lib/ray/payloads/int_payload.rb
+- lib/ray/payloads/json_string_payload.rb
 - lib/ray/payloads/new_screen_payload.rb
 - lib/ray/payloads/notify_payload.rb
 - lib/ray/payloads/null_payload.rb
 - lib/ray/payloads/payload.rb
 - lib/ray/payloads/remove_payload.rb
 - lib/ray/payloads/show_app_payload.rb
+- lib/ray/payloads/size_payload.rb
 - lib/ray/payloads/string_payload.rb
 - lib/ray/request.rb
 - lib/ray/version.rb