jobly 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dfd28e13f7a8721263780b81e03fd6906dbca241723f9cf69077022d98c0558
-  data.tar.gz: 1634628adb87ba6674e368a154a9c1a87db89ee8ba1c11dae5a5fbb185a5ebd6
+  metadata.gz: 1cf3d3077df95fb824e2012b4d381f262ebfce21968c08ded075240ae8861856
+  data.tar.gz: 89dc7fcfef708b922c8a3297dce7c4be2c7948b6c5f5ffcf7a8a666286837695
 SHA512:
-  metadata.gz: 01ed0fe3c87cab6f2b29033bc01e49ab33e15222760e3acc61bcfecf7ea85e0787d4e360e95b339ce3f5ca5c3ea84f4ca69a1ed47d14cad3124fc895a61a9ec3
-  data.tar.gz: 82d84d080205679692ea3e7310b89fc1262b5a55e3011bd253c9d8740bedbe224a3e22ff685a2d60b7da9d89da9c6f632392b3dcedc8ad38b0c6c8c45f44ea71
+  metadata.gz: e44878130cb1cc5ebd8d4ff044bc3d73a9435fb49fb52eee1074e893460e07a621d43f382501be1b63d9aa9d9df897ffee3d88030c058db9f88c6ac266829864
+  data.tar.gz: 401daa2e8a8d6277452e62a9d2964b48155564006a2aff7752c3fef8a36200ec48678bd94fc78377c8a3d8df1005645b80cde4c30d5a016b7fe7765cec730663

data/README.md

@@ -27,7 +27,7 @@ Installation
 
     $ gem install jobly
 
-Or with the official [Jobly docker image][2].
+Or with the official [Jobly docker image][docker].
 
 
 What's in the Box
@@ -47,10 +47,19 @@ sidekiq backgronud jobs system. It includes the following components:
 Documentation
 --------------------------------------------------
 
-- Visit the [Jobly documentation][1].
-- Visit the [interactive demo on Katacoda][3].
+- Visit the [Jobly documentation][docs].
+- Visit the [interactive demo on Katacoda][katacoda].
 
 
-[1]: https://jobly.dannyb.co
-[2]: https://github.com/dannyben/docker-jobly
-[3]: https://www.katacoda.com/dannyb/scenarios/jobly
+Contributing / Support
+--------------------------------------------------
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
+
+[docs]: https://jobly.dannyb.co
+[docker]: https://github.com/dannyben/docker-jobly
+[katacoda]: https://www.katacoda.com/dannyb/scenarios/jobly
+[issues]: https://github.com/DannyBen/jobly/issues

data/bin/jobly

@@ -1,18 +1,17 @@
 #!/usr/bin/env ruby
 require 'colsole'
+require 'pretty_trace/enable-trim'
 include Colsole
 
-begin
-  require 'jobly'
-  require 'jobly/boot'
+require 'jobly'
+require 'jobly/boot'
 
-  router = Jobly::CLI.router
+PrettyTrace.filter [
+  %r[commands/run],
+  %r[mister_bin],
+  %r[bin/jobly],
+  %r[bin/ruby],
+]
 
-  exit router.run ARGV
-
-rescue => e
-  puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!txtred!#{e.class}: #{e.message}"
-  say! "Run with !txtpur!DEBUG=1!txtrst! for backtrace details" unless ENV['DEBUG']
-  exit 1
-end
+router = Jobly::CLI.router
+exit router.run ARGV

data/lib/jobly.rb

@@ -5,8 +5,10 @@ requires 'jobly/polyfills'
 requires 'jobly/extensions'
 requires 'jobly/refinements'
 requires 'jobly/job_extensions'
+requires 'jobly/helpers'
+
+require 'jobly/helpers'
 require 'jobly/exceptions'
-require 'jobly/logging'
 require 'jobly/log'
 require 'jobly/sidekiq'
 require 'jobly/module_functions'

data/lib/jobly/helpers.rb

@@ -0,0 +1,15 @@
+module Jobly
+  # This module includes all the modules that are needed for a Jobly::Job
+  # It may also be included by the user, in a non-job context (for example,
+  # in code inside the ./app folder).
+  module Helpers
+    def self.included(klass)
+      klass.class_eval do
+        include Logging
+        include Settings
+        include Shell
+        include Slack
+      end
+    end
+  end
+end

data/lib/jobly/helpers/README.md

@@ -0,0 +1,8 @@
+Note that although these files are in a separate folder, the modules they 
+define are **using the main `Jobly` namespace** - so caution is required
+when adding additional files.
+
+This is done on purpose, since these modules may also be included by the
+user, and we would like the users to have a simple `include Jobly::Slack`
+rather than `include Jobly::Helpers::Slack`.
+

data/lib/jobly/helpers/settings.rb

@@ -0,0 +1,24 @@
+require 'sting'
+
+module Jobly
+  module Settings
+    def settings
+      @settings ||= settings!
+    end
+
+    def settings!
+      settings = Sting.new
+
+      files = [
+        "#{Jobly.full_config_path}/settings",
+        "#{Jobly.full_config_path}/settings.#{Jobly.environment}"
+      ]
+
+      files.each do |file|
+        settings << file if File.exist? "#{file}.yml"
+      end
+
+      settings
+    end
+  end
+end

data/lib/jobly/helpers/shell.rb

@@ -0,0 +1,9 @@
+require 'tty-command'
+
+module Jobly
+  module Shell
+    def shell
+      @shell ||= TTY::Command.new(output: logger, color: false)
+    end
+  end
+end

data/lib/jobly/helpers/slack.rb

@@ -0,0 +1,43 @@
+require 'slack-notifier'
+
+module Jobly
+  module Slack
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def slack_channel(channel = nil)
+        if channel
+          @slack_channel = channel
+        else
+          @slack_channel ||= Jobly.slack_channel
+        end
+      end
+
+      def slack_user(user = nil)
+        if user
+          @slack_user = user
+        else
+          @slack_user ||= Jobly.slack_user
+        end
+      end
+    end
+
+    def slack
+      @slack ||= slack!
+    end
+
+  private
+
+    def slack!
+      raise ArgumentError, "Slack webhook is not set" unless Jobly.slack_webhook
+      opts = {
+        channel: self.class.slack_channel,
+        username: self.class.slack_user
+      }
+      ::Slack::Notifier.new Jobly.slack_webhook, opts
+    end
+
+  end
+end

data/lib/jobly/job.rb

@@ -2,12 +2,13 @@ module Jobly
   class Job
     include Sidekiq::Worker
     include Sidekiq::Status::Worker
-    include Jobly::Logging  # must come after Sidekiq::Worker
     include JobExtensions::OptionAccessors
     include JobExtensions::Actions
     include JobExtensions::Solo
-    include JobExtensions::Slack
-    include JobExtensions::Shell
+
+    # Helpers must come after Sidekiq::Worker since they both bring logger
+    # and our logger is the king of loggers
+    include Helpers
 
     using KeywordArgs
     using ToSlug

data/lib/jobly/templates/full/app/other_class.rb

@@ -0,0 +1,13 @@
+class OtherClass
+  # If you have classes that do not inherit from Jobly::Job you can still
+  # gain access to the helpers by including them.
+
+  # Include all helpers
+  include Jobly::Helpers
+
+  # Or, include only what you need
+  # include Jobly::Logging
+  # include Jobly::Slack
+  # include Jobly::Shell
+  # include Jobly::Settings
+end

data/lib/jobly/version.rb

@@ -1,3 +1,3 @@
 module Jobly
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,57 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: jobly
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mister_bin
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: pretty_trace
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '0.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -164,34 +156,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sting
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: tty-command
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: slack-notifier
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: mister_bin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Execute background jobs and build tasks on this sidekiq-based job server
 email: db@dannyben.com
 executables:
@@ -215,15 +249,18 @@ files:
 - lib/jobly/config.ru
 - lib/jobly/exceptions.rb
 - lib/jobly/extensions/integer.rb
+- lib/jobly/helpers.rb
+- lib/jobly/helpers/README.md
+- lib/jobly/helpers/logging.rb
+- lib/jobly/helpers/settings.rb
+- lib/jobly/helpers/shell.rb
+- lib/jobly/helpers/slack.rb
 - lib/jobly/job.rb
 - lib/jobly/job_extensions/actions.rb
 - lib/jobly/job_extensions/option_accessors.rb
-- lib/jobly/job_extensions/shell.rb
-- lib/jobly/job_extensions/slack.rb
 - lib/jobly/job_extensions/solo.rb
 - lib/jobly/jobs.rb
 - lib/jobly/log.rb
-- lib/jobly/logging.rb
 - lib/jobly/module_functions.rb
 - lib/jobly/polyfills/hash.rb
 - lib/jobly/refinements/argument_converters.rb
@@ -235,6 +272,7 @@ files:
 - lib/jobly/templates/full/Gemfile
 - lib/jobly/templates/full/Procfile
 - lib/jobly/templates/full/app/job.rb
+- lib/jobly/templates/full/app/other_class.rb
 - lib/jobly/templates/full/config/jobly.rb
 - lib/jobly/templates/full/envrc.example
 - lib/jobly/templates/full/jobs/hello.rb

data/lib/jobly/job_extensions/shell.rb

@@ -1,11 +0,0 @@
-require 'tty-command'
-
-module Jobly
-  module JobExtensions
-    module Shell
-      def shell
-        @shell ||= TTY::Command.new(output: logger, color: false)
-      end
-    end
-  end
-end

data/lib/jobly/job_extensions/slack.rb

@@ -1,45 +0,0 @@
-require 'slack-notifier'
-
-module Jobly
-  module JobExtensions
-    module Slack
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        def slack_channel(channel = nil)
-          if channel
-            @slack_channel = channel
-          else
-            @slack_channel ||= Jobly.slack_channel
-          end
-        end
-
-        def slack_user(user = nil)
-          if user
-            @slack_user = user
-          else
-            @slack_user ||= Jobly.slack_user
-          end
-        end
-      end
-
-      def slack
-        @slack ||= slack!
-      end
-
-    private
-
-      def slack!
-        raise ArgumentError, "Slack webhook is not set" unless Jobly.slack_webhook
-        opts = {
-          channel: self.class.slack_channel,
-          username: self.class.slack_user
-        }
-        ::Slack::Notifier.new Jobly.slack_webhook, opts
-      end
-
-    end
-  end
-end