rubiclifier 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8006a6f6bcedfd7d4d3d895087075047087e8c45f63f9277bb89fe9b9ab56d22
-  data.tar.gz: 79dffda0fae0cc0ac1c0da0c0d0f87e02c91600527c952ae5b82dfdd514d9cdb
+  metadata.gz: 28017918c897dbe2c073355b9a7fb68b868a76c7d171089fab957b63943bb106
+  data.tar.gz: f183ea8e536a1a889c3c210aa88f3b103276858bbb8e713b7a84d95e23f272a9
 SHA512:
-  metadata.gz: 472aaa011d7bec45d40485654a3ee37035a274c9647c05462ac93ac91ca173ab8d76fa416ba7f4630c4c7800871ae001f02861a2d124fd13a2bd7b62883093ef
-  data.tar.gz: e62fcfcf2b68486056ee0687eb3b643d62f86f1443aa83fcd620e2a956f9afc16a46428173eb21d214c1fbf908813938a4a050a644724b4cdfb755122bda9834
+  metadata.gz: 397b8a9dceedab109ef2335e6ad0d243bd355b1b776ef39120efbe181e075baba6cc55d597af05651feaada5ef3dff69572cabab4395437b24988dc058a0865a
+  data.tar.gz: 37f1383afa0fcd7d9a62803af517ef7136e8c546c9721a89be07500ef5e56ae9eafcd23c764fc27c087230852dbf0d374f9957f4cfbbe59918dab18ce7a4bb30

data/Gemfile

@@ -4,3 +4,9 @@ gemspec
 
 gem "httparty"
 gem "sqlite3"
+gem "sinatra"
+
+group :test do
+  gem "byebug"
+  gem "rspec"
+end

data/bin/rubiclifier

@@ -2,4 +2,4 @@
 
 require_relative "../lib/cli/rubiclifier_cli.rb"
 
-RubiclifierCli.new(ARGV).call
+RubiclifierCli.new(ARGV, __FILE__.split("/").last).call

data/lib/base_application.rb

@@ -5,28 +5,43 @@ require_relative "./setting.rb"
 
 module Rubiclifier
   class BaseApplication
-    attr_reader :args
-    private :args
+    attr_reader :args, :executable_name
+    private :args, :executable_name
 
-    def initialize(args)
+    def initialize(args, executable_name)
       @args = Args.new(args)
-      DB.hydrate(data_directory, migrations_location) if feature_enabled?(Feature::DATABASE)
+      @executable_name = executable_name
+      Feature.set_enabled(all_features)
+      DB.hydrate(data_directory, migrations_location) if Feature.enabled?(Feature::DATABASE)
     end
 
     def call
       show_help if args.command == "help" || args.boolean("help", "h")
       setup_or_fail if needs_setup?
-      run_application
+      if Feature.enabled?(Feature::SERVER)
+        run_server
+      else
+        run_application
+      end
     end
 
     def show_help
       raise NotImplementedError
     end
 
+    def run_server
+      raise NotImplementedError
+    end
+
     def run_application
       raise NotImplementedError
     end
 
+    def run_server
+      server_class.hydrate
+      server_class.run!
+    end
+
     def additional_setup
     end
 
@@ -41,12 +56,8 @@ module Rubiclifier
       []
     end
 
-    def executable_name
-      raise NotImplementedError
-    end
-
     def data_directory
-      raise NotImplementedError if feature_enabled?(Feature::DATABASE)
+      raise NotImplementedError if Feature.enabled?(Feature::DATABASE)
     end
 
     def migrations_location
@@ -61,14 +72,15 @@ module Rubiclifier
 
     def all_brew_dependencies
       @abd ||= [
-        ("sqlite" if feature_enabled?(Feature::DATABASE)),
-        ("terminal-notifier" if feature_enabled?(Feature::NOTIFICATIONS))
+        ("sqlite" if Feature.enabled?(Feature::DATABASE)),
+        ("terminal-notifier" if Feature.enabled?(Feature::NOTIFICATIONS)),
+        ("sleepwatcher" if Feature.enabled?(Feature::IDLE_DETECTION))
       ].concat(brew_dependencies).compact
     end
 
     def brew_dependencies_installed?
       all_brew_dependencies.all? do |dep|
-        system("brew list #{dep} &> /dev/null")
+        system("/usr/local/bin/brew list #{dep} &> /dev/null")
       end
     end
 
@@ -88,7 +100,7 @@ module Rubiclifier
     end
 
     def needs_setup?
-      !all_brew_dependencies.empty? || !settings.empty? || feature_enabled?(Feature::BACKGROUND)
+      !all_brew_dependencies.empty? || !settings.empty? || Feature.enabled?(Feature::BACKGROUND)
     end
 
     def setup_or_fail
@@ -109,7 +121,7 @@ module Rubiclifier
 
         puts
 
-        if feature_enabled?(Feature::BACKGROUND)
+        if Feature.enabled?(Feature::BACKGROUND)
           setup_as_background_service
         else
           puts("Finished setup! Run with `".green + "#{executable_name}" + "`".green)
@@ -141,9 +153,5 @@ module Rubiclifier
         puts("Finished setup!".green)
       end
     end
-
-    def feature_enabled?(feature)
-      all_features.include?(feature)
-    end
   end
 end

data/lib/cli/rubiclifier_cli.rb

@@ -1,4 +1,4 @@
-require "rubiclifier"
+require_relative "../rubiclifier.rb"
 
 class RubiclifierCli < Rubiclifier::BaseApplication
   attr_reader :project_name
@@ -14,6 +14,7 @@ class RubiclifierCli < Rubiclifier::BaseApplication
     puts("                   --background                   |   Generate with background service setup steps")
     puts("                   --database                     |   Generate with a persistent database")
     puts('                   --homebrew "[first [second]]"  |   Require specific homebrew kegs')
+    puts("                   --idle-detection               |   Generate with ability to detect if user is idle")
     puts("                   --notifications                |   Generate with notification functionality")
     puts("                   --settings                     |   Generate with persistent setting functionality")
     puts
@@ -44,6 +45,10 @@ class RubiclifierCli < Rubiclifier::BaseApplication
     unless template_hydrator.feature_enabled?(Rubiclifier::Feature::DATABASE)
       system("rm #{project_name}/migrations.rb")
     end
+    unless template_hydrator.feature_enabled?(Rubiclifier::Feature::SERVER)
+      system("rm #{project_name}/lib/server.rb")
+      system("rm -rf #{project_name}/public")
+    end
     puts("Finished creating project #{project_name}! Build out the application in #{project_name}/lib/#{project_name}.rb".green)
   end
 

data/lib/cli/template_hydrator.rb

@@ -1,4 +1,4 @@
-require "rubiclifier"
+require_relative "../rubiclifier.rb"
 
 class TemplateHydrator
   attr_reader :args, :project_name
@@ -33,7 +33,9 @@ class TemplateHydrator
     @features ||= [
       (Rubiclifier::Feature::BACKGROUND if args.boolean("background")),
       (Rubiclifier::Feature::DATABASE if (args.boolean("database") || include_settings?)),
+      (Rubiclifier::Feature::IDLE_DETECTION if args.boolean("idle-detection")),
       (Rubiclifier::Feature::NOTIFICATIONS if args.boolean("notifications")),
+      (Rubiclifier::Feature::SERVER if args.boolean("server")),
     ].compact
   end
 

data/lib/database.rb

@@ -12,6 +12,7 @@ module Rubiclifier
     end
 
     def self.conn
+      Feature.fail_unless_enabled(Feature::DATABASE)
       @conn
     end
 

data/lib/feature.rb

@@ -3,5 +3,19 @@ module Rubiclifier
     BACKGROUND = "BACKGROUND"
     DATABASE = "DATABASE"
     NOTIFICATIONS = "NOTIFICATIONS"
+    IDLE_DETECTION = "IDLE_DETECTION"
+    SERVER = "SERVER"
+
+    def self.set_enabled(features)
+      @enabled = features
+    end
+
+    def self.enabled?(feature)
+      @enabled.include?(feature)
+    end
+
+    def self.fail_unless_enabled(feature)
+      raise "Looks like you're trying to use feature 'Rubiclifier::Feature::#{feature}' without specifying it in your features." unless Feature.enabled?(feature)
+    end
   end
 end

data/lib/idle_detector.rb

@@ -0,0 +1,19 @@
+require_relative "./feature.rb"
+
+module Rubiclifier
+  class IdleDetector
+    def self.set_idle_seconds_threshold(idle_seconds_threshold)
+      @idle_seconds_threshold = idle_seconds_threshold
+    end
+
+    def self.idle_seconds_threshold
+      @idle_seconds_threshold || 120
+    end
+
+    def self.is_idle?
+      Feature.fail_unless_enabled(Feature::IDLE_DETECTION)
+      seconds_idle = `/usr/local/sbin/sleepwatcher -g`.to_i / 10
+      seconds_idle > idle_seconds_threshold
+    end
+  end
+end

data/lib/notification.rb

@@ -1,8 +1,12 @@
+require_relative "./feature.rb"
+
 module Rubiclifier
   class Notification
     attr_reader :title, :message, :subtitle, :icon, :url
     private :title, :message, :subtitle, :icon, :url
+
     def initialize(title, message, subtitle = nil, icon = nil, url = nil)
+      Feature.fail_unless_enabled(Feature::NOTIFICATIONS)
       @title = title
       @message = message
       @subtitle = subtitle

data/lib/server.rb

@@ -0,0 +1,13 @@
+require 'sinatra/base'
+
+module Rubiclifier
+  class Server < Sinatra::Base
+    def self.hydrate
+      raise NotImplementedError
+    end
+
+    get "/" do
+      redirect("/index.html")
+    end
+  end
+end

data/project_template/bin/PROJECT_NAME.erb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "<%= project_name %>"
+require_relative "../lib/<%= project_name %>.rb"
 
-<%= project_name_camel_case %>.new(ARGV).call
+<%= project_name_camel_case %>.new(ARGV, __FILE__.split("/").last).call

data/project_template/lib/PROJECT_NAME.rb.erb

@@ -1,4 +1,7 @@
 require "rubiclifier"
+<%- if feature_enabled?(Rubiclifier::Feature::SERVER) -%>
+require_relative "./server.rb"
+<%- end -%>
 
 class <%= project_name_camel_case %> < Rubiclifier::BaseApplication
   def show_help
@@ -15,12 +18,18 @@ class <%= project_name_camel_case %> < Rubiclifier::BaseApplication
     exit
   end
 
+  <%- if feature_enabled?(Rubiclifier::Feature::SERVER) -%>
+  def server_class
+    Server
+  end
+  <%- else -%>
   def run_application
     while true
       puts "Running!"
       sleep 5
     end
   end
+  <%- end -%>
   <%- if !features.empty? -%>
 
   def features
@@ -36,12 +45,6 @@ class <%= project_name_camel_case %> < Rubiclifier::BaseApplication
     ]
   end
   <%- end -%>
-  <%- if needs_setup? -%>
-
-  def executable_name
-    "<%= project_name %>"
-  end
-  <%- end -%>
   <%- if feature_enabled?(Rubiclifier::Feature::DATABASE) -%>
 
   def data_directory

data/project_template/lib/server.rb

@@ -0,0 +1,8 @@
+require "rubiclifier"
+
+class Server < Rubiclifier::Server
+  def self.hydrate
+    set :public_folder, "#{File.expand_path(File.dirname(__FILE__) + "/..")}/public"
+    set :port, 5000
+  end
+end

data/project_template/public/index.html.erb

@@ -0,0 +1,12 @@
+<!doctype html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title><%= project_name %></title>
+  </head>
+
+  <body>
+    <h1><%= project_name %></h1>
+  </body>
+</html>

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubiclifier
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kyle Grinstead
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email: kyleag@hey.com
 executables:
 - rubiclifier
@@ -28,8 +28,10 @@ files:
 - lib/colorized_strings.rb
 - lib/database.rb
 - lib/feature.rb
+- lib/idle_detector.rb
 - lib/notification.rb
 - lib/rubiclifier.rb
+- lib/server.rb
 - lib/setting.rb
 - project_template/.gitignore
 - project_template/Gemfile
@@ -39,13 +41,15 @@ files:
 - project_template/bin/PROJECT_NAME.erb
 - project_template/lib/PROJECT_NAME.rb.erb
 - project_template/lib/api.rb
+- project_template/lib/server.rb
 - project_template/migrations.rb
+- project_template/public/index.html.erb
 homepage: https://rubygems.org/gems/rubiclifier
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/MrGrinst/rubiclifier
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,9 +64,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Easily spin up new Ruby CLI applications with built-in backgrounding and
   data storage.