rubiclifier 0.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd4ba1b9ad523fe07ff82c350cb25fdbc4e888b05d3706acb65939af67fb3fed
-  data.tar.gz: b99ec401e3abe0a155c7548babe520dad1385ab64151162237bb92a3080361a6
+  metadata.gz: 8d6ce2340c532ee4fb852c7039096830969ea1e45e5de1ad61d1a127fb4b8cec
+  data.tar.gz: cd172e3bbafc3f12ab49e9604461925c663fa6a2beeb29dd98e0f44815171979
 SHA512:
-  metadata.gz: e543847ffc6a0f3a9de7a6fdc19355bd5a13157f721c3924d1b5e9ac839f8d7e56660e63aca4a21f497b31dc4393fb7ffa0af02ed8692d21c4e8cf497e3e2199
-  data.tar.gz: b3b203e291003208172f463cb2d9241fb7b99b5ad2e185513b0002701d1c4466c71bed82497d14671fa7f7b3281e20fea2623e0af4fb0971e55e94a761c5fdae
+  metadata.gz: 26e52fec6adaa98607ff9f2c60452689918899dd3fb725a8fe77923682f50aea357327e843468668e000c93020b287111dd69c8516952fa76de777ea3d60cd69
+  data.tar.gz: a355033e4c0aac8214030b9be3fe1c58210a6578870b93b656186401cc43916f925ad968d2dd3556e75eb0297f8f4e259c9af64623766b8a5a338e23bf285081

data/bin/rubiclifier

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/cli/rubiclifier_cli.rb"
+
+RubiclifierCli.new(ARGV).call

data/lib/args.rb

@@ -11,7 +11,7 @@ module Rubiclifier
       args[0]
     end
 
-    def subcommand
+    def first_option
       args[1]
     end
 

data/lib/base_application.rb

@@ -10,12 +10,13 @@ module Rubiclifier
 
     def initialize(args)
       @args = Args.new(args)
-      DB.hydrate(data_directory, migrations_location)
+      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
+      setup_or_fail if needs_setup?
       run_application
     end
 
@@ -33,16 +34,12 @@ module Rubiclifier
     def not_setup
     end
 
-    def is_background_service?
-      raise NotImplementedError
-    end
-
-    def sends_notifications?
-      raise NotImplementedError
+    def features
+      []
     end
 
     def settings
-      raise NotImplementedError
+      []
     end
 
     def executable_name
@@ -50,7 +47,7 @@ module Rubiclifier
     end
 
     def data_directory
-      raise NotImplementedError
+      raise NotImplementedError if Feature.enabled?(Feature::DATABASE)
     end
 
     def migrations_location
@@ -61,14 +58,48 @@ module Rubiclifier
       []
     end
 
+    private
+
+    def all_brew_dependencies
+      @abd ||= [
+        ("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")
+      end
+    end
+
+    def brew_installed_or_fail
+      unless system("which brew &> /dev/null")
+        puts
+        puts("You must install Homebrew in order to install these dependencies: #{all_brew_dependencies.join(", ")}".red)
+        puts("Go to https://brew.sh/")
+        exit
+      end
+    end
+
+    def all_features
+      [
+        (Feature::DATABASE if !settings.empty?)
+      ].concat(features).compact.uniq
+    end
+
+    def needs_setup?
+      !all_brew_dependencies.empty? || !settings.empty? || Feature.enabled?(Feature::BACKGROUND)
+    end
+
     def setup_or_fail
       if args.command == "setup" || args.boolean("setup", "s")
-        puts("Installing brew dependencies...")
-        all_brew_dependencies = [
-          "sqlite",
-          ("terminal-notifier" if sends_notifications?)
-        ].concat(brew_dependencies).compact
-        system("brew install #{all_brew_dependencies.join(" ")}")
+        unless all_brew_dependencies.empty?
+          brew_installed_or_fail
+          puts("Installing brew dependencies...")
+          system("brew install #{all_brew_dependencies.join(" ")}")
+        end
 
         puts
 
@@ -80,26 +111,24 @@ module Rubiclifier
 
         puts
 
-        if is_background_service?
+        if Feature.enabled?(Feature::BACKGROUND)
           setup_as_background_service
         else
-          puts("Finished setup! Run with `#{executable_name}`".green)
+          puts("Finished setup! Run with `".green + "#{executable_name}" + "`".green)
         end
         exit
-      end
-
-      unless settings.all?(&:is_setup?)
+      elsif !settings.all?(&:is_setup?) || !brew_dependencies_installed?
         not_setup
         puts
-        puts("Oops! You must finish setup first by running with the `--setup` option.".red)
-        puts("  `#{executable_name} --setup`".red)
+        puts("Oops! You must finish setup first.".red)
+        puts("  `".red + "#{executable_name} --setup" + "`".red)
         exit
       end
     end
 
     def setup_as_background_service
-      puts("It's recommended that you set this up as a system service with serviceman. You can check it out here: https://git.rootprojects.org/root/serviceman".blue)
-      puts("Set #{executable_name} to run on startup with `serviceman add --name #{executable_name} #{executable_name}`".blue)
+      puts("It's recommended that you set this up as a system service with serviceman. You can check it out here: https://git.rootprojects.org/root/serviceman".yellow)
+      puts("Set #{executable_name} to run on startup with `".yellow + "serviceman add --name #{executable_name} #{executable_name}" + "`".yellow)
       puts
       print("Would you like this script to set it up for you? (y/n) ")
       if STDIN.gets.chomp.downcase == "y"

data/lib/cli/rubiclifier_cli.rb

@@ -0,0 +1,69 @@
+require "rubiclifier"
+
+class RubiclifierCli < Rubiclifier::BaseApplication
+  attr_reader :project_name
+  private :project_name
+
+  def show_help
+    puts
+    puts("rubiclifier helps you generate new Ruby CLI and background service tools")
+    puts
+    puts("Usage:")
+    puts("  rubiclifier --help                              | Shows this help menu")
+    puts("  rubiclifier new [project_name]                  | Creates a new rubiclifier project")
+    puts("                   --background                   |   Generate with background service setup steps")
+    puts("                   --database                     |   Generate with a persistent database")
+    puts('                   --homebrew "[first [second]]"  |   Require specific homebrew kegs')
+    puts("                   --notifications                |   Generate with notification functionality")
+    puts("                   --settings                     |   Generate with persistent setting functionality")
+    puts
+    exit
+  end
+
+  def run_application
+    case args.command
+    when "new"
+      create_project
+    else
+      show_help
+    end
+  end
+
+  private
+
+  def create_project
+    @project_name = args.first_option
+    validate_project_name
+    system("mkdir -p #{project_name}")
+    system("cp -R \"#{File.dirname(__FILE__)}/../../project_template/.\" #{project_name}")
+    system("cp \"#{File.dirname(__FILE__)}/../../project_template/.gitignore\" #{project_name}")
+    Dir.glob("#{project_name}/**/*.erb").each do |template_file|
+      hydrate_template_file(template_file)
+      system("mv #{template_file} #{template_file.sub(/\.erb$/, "").sub("PROJECT_NAME", project_name)}")
+    end
+    unless template_hydrator.feature_enabled?(Rubiclifier::Feature::DATABASE)
+      system("rm #{project_name}/migrations.rb")
+    end
+    puts("Finished creating project #{project_name}! Build out the application in #{project_name}/lib/#{project_name}.rb".green)
+  end
+
+  def validate_project_name
+    if project_name.nil?
+      puts("You must specify a project name.".red)
+      exit
+    elsif !project_name.match(/^[a-z_]+$/)
+      puts("Your project name must be lowercase letters and _".red)
+      exit
+    end
+  end
+
+  def hydrate_template_file(template_file)
+    template_string = File.read(template_file)
+    output = template_hydrator.hydrate(template_string)
+    File.write(template_file, output)
+  end
+
+  def template_hydrator
+    @template_hydrator ||= TemplateHydrator.new(args, project_name)
+  end
+end

data/lib/cli/template_hydrator.rb

@@ -0,0 +1,47 @@
+require "rubiclifier"
+
+class TemplateHydrator
+  attr_reader :args, :project_name
+  private :args
+
+  def initialize(args, project_name)
+    @args = args
+    @project_name = project_name
+  end
+
+  def hydrate(template_string)
+    ERB.new(template_string, nil, "-").result(binding)
+  end
+
+  def project_name_camel_case
+    @pnsc ||= project_name.split("_").collect(&:capitalize).join
+  end
+
+  def include_settings?
+    args.boolean("settings")
+  end
+
+  def brew_dependencies
+    args.string("homebrew")&.split(" ") || []
+  end
+
+  def uses_brew?
+    !brew_dependencies.empty?
+  end
+
+  def features
+    @features ||= [
+      (Rubiclifier::Feature::BACKGROUND if args.boolean("background")),
+      (Rubiclifier::Feature::DATABASE if (args.boolean("database") || include_settings?)),
+      (Rubiclifier::Feature::NOTIFICATIONS if args.boolean("notifications")),
+    ].compact
+  end
+
+  def needs_setup?
+    !features.empty? || uses_brew?
+  end
+
+  def feature_enabled?(feature)
+    features.include?(feature)
+  end
+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

@@ -0,0 +1,20 @@
+module Rubiclifier
+  module Feature
+    BACKGROUND = "BACKGROUND"
+    DATABASE = "DATABASE"
+    NOTIFICATIONS = "NOTIFICATIONS"
+    IDLE_DETECTION = "IDLE_DETECTION"
+
+    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/rubiclifier.rb

@@ -1,8 +1 @@
-require_relative "./args.rb"
-require_relative "./base_api.rb"
-require_relative "./base_application.rb"
-require_relative "./cipher.rb"
-require_relative "./colorized_strings.rb"
-require_relative "./database.rb"
-require_relative "./notification.rb"
-require_relative "./setting.rb"
+Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").each {|file| require file }

data/lib/setting.rb

@@ -12,14 +12,19 @@ module Rubiclifier
     end
 
     def populate
-      print("What's the #{label}? #{explanation_text}")
-      input = if is_secret
-                STDIN.noecho(&:gets).chomp.tap { puts }
-              else
-                STDIN.gets.chomp
-              end
-      if input == ""
-        input = nil
+      input = nil
+      loop do
+        print("What's the #{label}? #{explanation_text}".blue)
+        input = if is_secret
+                  STDIN.noecho(&:gets).chomp.tap { puts }
+                else
+                  STDIN.gets.chomp
+                end
+        if input == ""
+          input = nil
+          puts("This value can't be empty.".red) unless nullable
+        end
+        break if input || nullable
       end
       DB.save_setting(key, input, is_secret: is_secret) unless input.nil?
     end

data/project_template/.gitignore

@@ -0,0 +1,4 @@
+.byebug_history
+Gemfile.lock
+Brewfile.lock.json
+*.gem

data/project_template/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rubiclifier"

data/project_template/PROJECT_NAME.gemspec.erb

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = "<%= project_name %>"
+  s.version     = File.read("VERSION").strip
+  s.licenses    = ["MIT"]
+  s.summary     = "SUMMARY HERE"
+  s.authors     = ["AUTHOR NAME"]
+  s.email       = "AUTHOR EMAIL"
+  s.files       = Dir.glob("{lib}/**/*") + ["Gemfile"]
+  s.homepage    = "https://rubygems.org/gems/<%= project_name %>"
+  s.metadata    = { "source_code_uri" => "https://github.com/PATH_TO_PROJECT" }
+  s.require_path = "lib"
+  s.platform    = Gem::Platform::RUBY
+  s.executables = ["<%= project_name %>"]
+  s.post_install_message = <<MSG
+
+\e[32mThanks for installing <%= project_name %>!\e[0m
+\e[32mSet it up by running `\e[0m<%= project_name %> --setup\e[32m`\e[0m
+
+MSG
+end

data/project_template/VERSION

@@ -0,0 +1 @@
+0.1.0

data/project_template/bin/PROJECT_NAME.erb

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

data/project_template/lib/PROJECT_NAME.rb.erb

@@ -0,0 +1,61 @@
+require "rubiclifier"
+
+class <%= project_name_camel_case %> < Rubiclifier::BaseApplication
+  def show_help
+    puts
+    puts("DESCRIPTION")
+    puts
+    puts("Usage:")
+    puts("  <%= project_name %> --help                      | Shows this help menu")
+    <%- if needs_setup? -%>
+    puts("  <%= project_name -%> --setup                     | Runs setup")
+    <%- end -%>
+    puts("  <%= project_name %> command --option <argument> | Executes command")
+    puts
+    exit
+  end
+
+  def run_application
+    while true
+      puts "Running!"
+      sleep 5
+    end
+  end
+  <%- if !features.empty? -%>
+
+  def features
+    [<%= features.map { |f| "Rubiclifier::Feature::#{f}" }.join(", ") %>]
+  end
+  <%- end -%>
+  <%- if include_settings? -%>
+
+  def settings
+    @settings ||= [
+      Rubiclifier::Setting.new("username", "username", explanation: ->{"find it at this url"}, nullable: true),
+      Rubiclifier::Setting.new("password", "password", explanation: "input hidden", is_secret: true)
+    ]
+  end
+  <%- end -%>
+  <%- if needs_setup? -%>
+
+  def executable_name
+    "<%= project_name %>"
+  end
+  <%- end -%>
+  <%- if feature_enabled?(Rubiclifier::Feature::DATABASE) -%>
+
+  def data_directory
+    "~/.<%= project_name %>"
+  end
+
+  def migrations_location
+    "#{File.expand_path(File.dirname(__FILE__) + "/..")}/migrations.rb"
+  end
+  <%- end -%>
+  <%- if uses_brew? -%>
+
+  def brew_dependencies
+    <%= brew_dependencies.inspect %>
+  end
+  <%- end -%>
+end

data/project_template/lib/api.rb

@@ -0,0 +1,4 @@
+require "rubiclifier"
+
+class Api < Rubiclifier::BaseApi
+end

data/project_template/migrations.rb

@@ -0,0 +1,7 @@
+migrations = []
+migrations << <<SQL
+  CREATE TABLE IF NOT EXISTS test (
+    id INT PRIMARY KEY
+  );
+SQL
+migrations

metadata

@@ -1,31 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: rubiclifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kyle Grinstead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: kyleag@hey.com
-executables: []
+executables:
+- rubiclifier
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- bin/rubiclifier
 - lib/args.rb
 - lib/base_api.rb
 - lib/base_application.rb
 - lib/cipher.rb
+- lib/cli/rubiclifier_cli.rb
+- lib/cli/template_hydrator.rb
 - lib/colorized_strings.rb
 - lib/database.rb
+- lib/feature.rb
+- lib/idle_detector.rb
 - lib/notification.rb
 - lib/rubiclifier.rb
 - lib/setting.rb
+- project_template/.gitignore
+- project_template/Gemfile
+- project_template/Gemfile.lock
+- project_template/PROJECT_NAME.gemspec.erb
+- project_template/VERSION
+- project_template/bin/PROJECT_NAME.erb
+- project_template/lib/PROJECT_NAME.rb.erb
+- project_template/lib/api.rb
+- project_template/migrations.rb
 homepage: https://rubygems.org/gems/rubiclifier
 licenses:
 - MIT