playwright-cli 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d15ffbd0519e6d34a44de4d25c24d474ceb484d2197de04daa2844f9569e68e
-  data.tar.gz: ba61f21062a324708dbdb9608af6fa521e985861ce7c13ee8b50b6ef8e43374f
+  metadata.gz: 7d87579b2ff3473151b43b2ba48189ecc51ac5191d0ca04f25854e312304b0ab
+  data.tar.gz: e0c6dabc8b3744c2e6e9017f9b16ef07bcea7abf0d630f28cc5d3f928e84c3b6
 SHA512:
-  metadata.gz: 809012d19a8010bf1284a2bc27cb2ce52c85289008792b97d4872ef79fceaf1b85e463ab25c33c47bd6af7f171a5c92a237d64ea92d8764f7c9e5c966d706a17
-  data.tar.gz: fa839b93644993dbf016a0bfde9e1eb4ad74294ccb31aacfac0aa5c0fc18b2a8c0f70f24cb43c94ce358730797e848d7d8fbcc584643b3ce4e58f0addee73493
+  metadata.gz: fbc645bc301c06dc95c08799927c5975540b9b972128629ece2f829c523508ebaa0c25b321f38810f5fb8fd3fa9c5317ea795b350d719adeae7acaeaca6dabfc
+  data.tar.gz: 7f69dee107031ac44616a9c29fb1d494d082172db9409fcad23ce9a72c2384f23ab38cc9837d2d39e9e4ef6b4a0487aab1364d3e94a1d3e93bfef61e5d4374c5

data/.gitignore

@@ -12,3 +12,5 @@
 /plays/
 .ruby-version
 .commit-msg
+*.gem
+.trello

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    playwright-cli (0.1.6)
+    playwright-cli (0.1.8)
       colorize (~> 0.1)
       hanami-cli (~> 0.1)
 
@@ -20,6 +20,7 @@ GEM
       transproc (~> 1.0)
     memfs (1.0.0)
     method_source (0.9.0)
+    os (1.0.0)
     pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -49,6 +50,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   memfs (~> 1.0)
+  os (~> 1.0)
   playwright-cli!
   pry (~> 0.9.0)
   pry-nav (~> 0.2.4)

data/README.md

@@ -161,6 +161,57 @@ $ my-script greet tom #=> Why, hello tom!
 $ my-script version #=> 0.0.1
 ```
 
+### Helpers
+
+Inside of your command, you have access to a few helper objects to make
+interactions easier. You can see any of your helpers actions by calling the
+`#actions` method on it.
+
+#### Display
+
+The Display helper has 3 actions, `print`, `error`, and `abort`. Each takes a
+message as the first argument and can optionally take a color. `error` and
+`abort` also exit the program.
+
+`abort` should be used over `error` only if the user has triggered the exit.
+A good example would be if you ask a user, "File already exists? Overwrite it?
+[yn]" and they choose 'n'
+
+```ruby
+class Greet < Playwright::CLI::Command
+  def call(**)
+    display.print "Hello!", color: :blue
+  end
+end
+```
+
+#### Ask
+
+The Ask helper has 3 actions, `question`, `boolean_question`, and
+`url_question`. Each takes a message as the only argument. `boolean_question`
+and `url_question` validate the response. `question` does not.
+
+```ruby
+class Greet < Playwright::CLI::Command
+  def call(**)
+    ask.boolean_question "What's your name?" #=> "What's your name? [yn]"
+  end
+end
+```
+
+#### OS
+
+The OS helper has 2 actions, `open_url` and `open_editor`. `open_url` takes a
+url and an optional name. `open_editor` takes a path and an optional name.
+
+```ruby
+class Greet < Playwright::CLI::Command
+  def call(**)
+    os.open_url url: 'http://google.com', name: 'google'
+    os.open_editor path: Dir.pwd, name: 'working directory'
+  end
+end
+```
 
 ### Edit An App
 

data/lib/assets/templates/expanded_script_template.erb

@@ -18,7 +18,7 @@ module <%= klass_name %>
         ]
 
         def call(name:, **)
-          puts "Why, hello #{name}!"
+          display.print "Why, hello #{name}!"
         end
 
       end

data/lib/assets/templates/simple_script_template.erb

@@ -17,7 +17,7 @@ module <%= klass_name %>
         ]
 
         def call(name:, **)
-          puts "Why, hello #{name}!"
+          display.print "Why, hello #{name}!"
         end
 
       end

data/lib/assets/templates/version_subcommand_template.erb

@@ -12,7 +12,7 @@ module <%= klass_name %>
         example ["#=> #{VERSION}"]
 
         def call(**)
-          puts VERSION
+          display.print VERSION
         end
 
       end

data/lib/playwright/cli.rb

@@ -2,6 +2,9 @@ require 'hanami/cli'
 require 'colorize'
 require 'fileutils'
 require 'erb'
+require 'os'
+require 'uri'
+require 'pathname'
 
 # TODO: Remove this
 require 'pry'

data/lib/playwright/cli/command.rb

@@ -5,6 +5,7 @@ module Playwright
     class Command < Hanami::CLI::Command
       include CLI::Utils::Ask
       include CLI::Utils::Display
+      include CLI::Utils::OS
     end
   end
 end

data/lib/playwright/cli/utils.rb

@@ -1,6 +1,8 @@
 require 'playwright/cli/utils/ask'
 require 'playwright/cli/utils/display'
 require 'playwright/cli/utils/file_manager'
+require 'playwright/cli/utils/os'
+require 'playwright/cli/utils/util'
 
 module Playwright
   class CLI < Hanami::CLI

data/lib/playwright/cli/utils/ask.rb

@@ -1,3 +1,4 @@
+require 'playwright/cli/utils/util'
 require 'playwright/cli/utils/display'
 
 module Playwright
@@ -9,20 +10,33 @@ module Playwright
           @ask ||= Ask.new
         end
 
-        class Ask
+        class Ask < Util
           include Display
 
-          DEFAULT_COLOR = :blue
+          DEFAULT_COLOR = :light_blue
           TRUE_RESPONSE = :y
           FALSE_RESPONSE = :n
 
-          def boolean_question question
-            display.color_print "#{question} [yn]", color: DEFAULT_COLOR
-            response = $stdin.gets
+          def boolean_question user_question
+            response = question "#{user question} [yn]"
             sanitized_response = response.chomp.strip.downcase.to_sym if response && response.length > 0
             boolean_response_map[response]
           end
 
+          def url_question user_question
+            response = question user_question
+            if response =~ URI::regexp
+              response
+            else
+              display.error "Invalid URL!"
+            end
+          end
+
+          def question user_question
+            display.print "#{user_question} ", color: DEFAULT_COLOR, method: :print
+            $stdin.gets
+          end
+
           private
 
           def boolean_response_map

data/lib/playwright/cli/utils/display.rb

@@ -1,3 +1,4 @@
+require 'playwright/cli/utils/util'
 module Playwright
   class CLI < Hanami::CLI
     module Utils
@@ -7,8 +8,8 @@ module Playwright
           @display ||= Display.new
         end
 
-        class Display
-          
+        class Display < Util
+
           InvalidPrintMethod = Class.new StandardError
 
           VALID_PRINT_METHODS = [:p, :puts, :print]
@@ -17,19 +18,19 @@ module Playwright
           ERROR_COLOR = :red
 
           def error msg, msg2 = nil
-            color_print msg, color: :red
-            color_print "Action Cancelled.", color: ERROR_COLOR
-            color_print msg2, color: ERROR_COLOR if msg2
-            exit
+            print msg, color: :red
+            print "Action Cancelled.", color: ERROR_COLOR
+            print msg2, color: ERROR_COLOR if msg2
+            exit 1
           end
 
           def abort msg = nil
-            color_print msg, color: WARNING_COLOR if msg
-            color_print "Action Cancelled.", color: WARNING_COLOR
-            exit
+            print msg, color: WARNING_COLOR if msg
+            print "Action Cancelled.", color: WARNING_COLOR
+            exit 1
           end
 
-          def color_print msg, method: :puts, color: DEFAULT_COLOR
+          def print msg, method: :puts, color: DEFAULT_COLOR
             validate_print_method!(method)
             msg = msg.send(color) if defined?(Colorize)
             send(method, msg)

data/lib/playwright/cli/utils/file_manager.rb

@@ -1,5 +1,6 @@
 require 'playwright/cli/utils/ask'
 require 'playwright/cli/utils/display'
+require 'playwright/cli/utils/os'
 require 'playwright/cli/configuration'
 require 'playwright/cli/template'
 
@@ -40,12 +41,7 @@ module Playwright
 
           def open_editor script_name: nil
             @script_name ||= script_name
-            %x[$EDITOR #{root_dir}]
-            if $?.success?
-              display.color_print "Opening `#{@script_name}` in your editor..."
-            else
-              display.error "Could not open Editor!"
-            end
+            os.open_editor name: @script_name, path: root_dir
           end
 
           def script_name_rb
@@ -140,9 +136,9 @@ module Playwright
             validate_before_create_script_files!
             self.class.create_file_structure
             FileUtils.mkdir_p root_dir
-            display.color_print "New Directory Created: #{root_dir}"
+            display.print "New Directory Created: #{root_dir}"
             FileUtils.touch executable_file
-            display.color_print "New File Created: #{executable_file}"
+            display.print "New File Created: #{executable_file}"
             create_expanded_files if type == :expanded
           end
 
@@ -153,7 +149,7 @@ module Playwright
 
           def set_permissions
             FileUtils.chmod "u+x", executable_file
-            display.color_print "Executable Permissions Set: #{executable_file}"
+            display.print "Executable Permissions Set: #{executable_file}"
           end
 
           def write_template
@@ -171,7 +167,7 @@ module Playwright
 
           def create_symlink
             FileUtils.symlink(executable_file, symlink_file)
-            display.color_print "New Symlink Created: #{symlink_file} from #{executable_file}"
+            display.print "New Symlink Created: #{symlink_file} from #{executable_file}"
           end
 
           def validate_before_create_script_files!
@@ -194,7 +190,7 @@ module Playwright
             validate_before_delete_script_files!
             FileUtils.rm_rf root_dir
             FileUtils.rm symlink_file
-            display.color_print "Playwright script '#{script_name}' destroyed!"
+            display.print "Playwright script '#{script_name}' destroyed!"
           end
 
           def validate_before_delete_script_files!

data/lib/playwright/cli/utils/os.rb

@@ -0,0 +1,36 @@
+require 'playwright/cli/utils/util'
+require 'playwright/cli/utils/display'
+
+module Playwright
+  class CLI < Hanami::CLI
+    module Utils
+      module OS
+
+        def os
+          @os ||= OS.new
+        end
+
+        class OS < Util
+          include Display
+
+          def open_url url:, name: URI(url).host
+            if %x[ #{::OS.open_file_command} #{url} ]
+              display.print "Opening #{name} in your default browser..."
+            else
+              display.error "Failed to open your browser!"
+            end
+          end
+
+          def open_editor path:, name: Pathname.new(path).base
+            if %x[ $EDITOR #{path} ]
+              display.print "Opening #{name} in your default editor..."
+            else
+              display.error "Failed to open your editor!"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/playwright/cli/utils/util.rb

@@ -0,0 +1,13 @@
+module Playwright
+  class CLI < Hanami::CLI
+    module Utils
+      class Util
+
+        def actions
+          self.class.public_instance_methods - Object.public_instance_methods
+        end
+
+      end
+    end
+  end
+end

data/lib/playwright/cli/version.rb

@@ -1,5 +1,5 @@
 module Playwright
   class CLI < Hanami::CLI
-    VERSION = "0.1.6"
+    VERSION = "0.1.8"
   end
 end

data/playwright-cli.gemspec

@@ -36,7 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",    "~> 3.0"
   spec.add_development_dependency "pry",      "~> 0.9.0"
   spec.add_development_dependency "pry-nav",  "~> 0.2.4"
-  spec.add_development_dependency "memfs",  "~> 1.0"
+  spec.add_development_dependency "memfs",    "~> 1.0"
+  spec.add_development_dependency "os",       "~> 1.0"
 
   spec.add_runtime_dependency "hanami-cli",   "~>0.1"
   spec.add_runtime_dependency "colorize",     "~>0.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Mike Gregory
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hanami-cli
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +175,8 @@ files:
 - lib/playwright/cli/utils/ask.rb
 - lib/playwright/cli/utils/display.rb
 - lib/playwright/cli/utils/file_manager.rb
+- lib/playwright/cli/utils/os.rb
+- lib/playwright/cli/utils/util.rb
 - lib/playwright/cli/version.rb
 - playwright-cli.gemspec
 homepage: https://github.com/mgreg90/playwright-cli