playwright-cli 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91812a60a063511be0abece0c33ffe5bdf9d5a710298773cfafd136ad85c035
-  data.tar.gz: 93b6ba02d18968e70e481b6a47e1258ad0da71da2f90fe3db433fa9588de9d13
+  metadata.gz: 368e6d76fcbddcc447c51c1aa01f2b026db700402fcc1bfa548a18968e1ffa35
+  data.tar.gz: 49222ff68b9e74a729f4e2992407b2c9eba996345b1e9649a064c4d456985c39
 SHA512:
-  metadata.gz: e4d1da5ba351dc60e7d7b5969c77b3b5deaadf88e9fe132aab53e8dea08f048d976393f35ee4bb03ece138c36cc6228201204a3a3aa7f7e5f995fcd3d996ee34
-  data.tar.gz: 635dcdca8ad6dbcd9c9c0df00e49bd93cd0841032deb3133f51de373c3fc0bcefedd3dbbab7f2371d3c5c8f31d63a7007a89fd5abd13763546d95fa559a37d64
+  metadata.gz: dbb18e3e1632c70d251650d6c5c0c7f159b457948537824fef5af96908b0f64ab77056c361fb54408c81e98203db5bdda9aaa4c850b519b06849019d50b5e5cf
+  data.tar.gz: 4dfaa28467dfdd1f5e0a82ec6494c899e79ae22a50d58f33dcbb0e803aa67a1e1ff36694189c3e70ba3736295866f45abc3704372c15d0f2adc4abccaa25138e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    playwright-cli (0.1.14)
+    playwright-cli (0.1.16)
       colorize (~> 0.1)
       git (~> 1.3)
       hanami-cli (~> 0.1)

data/README.md

@@ -5,11 +5,30 @@ Ruby command line applications. It's first goal is to provide a solid generator
 for building command line apps in Ruby. It's built on top of [Hanami::CLI](https://github.com/hanami/cli),
 so all of their documentation applies here as well.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Check The Version](#check-the-version)
+- [Create An App](#create-an-app)
+- [Helpers](#helpers)
+  - [Display](#display)
+  - [Ask](#ask)
+  - [OS](#os)
+- [Arguments & Options](#arguments--options)
+  - [Validations](#validations)
+- [Edit An App](#edit-an-app)
+- [List Apps](#list-apps)
+- [Delete An App](#delete-an-app)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Installation
 
 Install this gem with:
-
+```shell
     $ gem install playwright-cli
+```
 
 ## Usage
 
@@ -17,7 +36,7 @@ Install this gem with:
 
 To check the version:
 ```shell
-$ playwright -v #=> 0.1.14
+  $ playwright -v #=> 0.1.16
 ```
 
 ### Create An App
@@ -32,46 +51,46 @@ you should replace. The `#call` method is what is ultimately run.
 It will look something like this:
 
 ```ruby
-#!/usr/bin/env ruby
+  #!/usr/bin/env ruby
 
-require 'bundler/inline'
-gemfile do
-  source 'https://rubygems.org'
-  gem 'playwright-cli', require: 'playwright/cli'
-end
+  require 'bundler/inline'
+  gemfile do
+    source 'https://rubygems.org'
+    gem 'playwright-cli', require: 'playwright/cli'
+  end
 
-module MyScript
-  module CLI
-    module Commands
-      extend Playwright::CLI::Registry
+  module MyScript
+    module CLI
+      module Commands
+        extend Playwright::CLI::Registry
 
-      class Root < Playwright::CLI::Command
-        desc "Says a greeting to the name given. This is an example."
+        class Root < Playwright::CLI::Command
+          desc "Says a greeting to the name given. This is an example."
 
-        argument :name, required: true, desc: 'Whom shall I greet?'
+          argument :name, required: true, desc: 'Whom shall I greet?'
 
-        example [
-          "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
-        ]
+          example [
+            "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
+          ]
 
-        def call(name:, **)
-          puts "Why, hello #{name}!"
-        end
+          def call(name:, **)
+            display.print "Why, hello #{name}!"
+          end
 
-      end
+        end
 
-      register_root Root
+        register_root Root
 
+      end
     end
   end
-end
 
-Playwright::CLI.new(MyScript::CLI::Commands).call
+  Playwright::CLI.new(MyScript::CLI::Commands).call
 
 ```
 
 ```shell
-$ my-script tom #=> Why, hello tom!
+  $ my-script tom #=> Why, hello tom!
 ```
 Most of this code is simply wrapping [Hanami::CLI](https://github.com/hanami/cli), so their documentation
 will be the best source of information for you in handling arguments and options.
@@ -87,49 +106,49 @@ as in the example below.
 Hanami::CLI is built for more intricate command line apps, so playwright allows
 you to generate that as well.
 ```shell
-$ playwright g my-script --type=expanded
+  $ playwright g my-script --type=expanded
 ```
 This will give you a mostly similar main class:
 
 ```ruby
-#!/usr/bin/env ruby
+  #!/usr/bin/env ruby
+
+  require 'bundler/inline'
+  gemfile do
+    source 'https://rubygems.org'
+    gem 'playwright-cli', require: 'playwright/cli'
+  end
 
-require 'bundler/inline'
-gemfile do
-  source 'https://rubygems.org'
-  gem 'playwright-cli', require: 'playwright/cli'
-end
+  require_relative 'lib/version'
 
-require_relative 'lib/version'
+  module MyScript
+    module CLI
+      module Commands
+        extend Playwright::CLI::Registry
 
-module MyScript
-  module CLI
-    module Commands
-      extend Playwright::CLI::Registry
+        class Greet < Playwright::CLI::Command
+          desc "Says a greeting to the name given. This is an example."
 
-      class Greet < Playwright::CLI::Command
-        desc "Says a greeting to the name given. This is an example."
+          argument :name, required: true, desc: 'Whom shall I greet?'
 
-        argument :name, required: true, desc: 'Whom shall I greet?'
+          example [
+            "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
+          ]
 
-        example [
-          "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
-        ]
+          def call(name:, **)
+            display.print "Why, hello #{name}!"
+          end
 
-        def call(name:, **)
-          puts "Why, hello #{name}!"
         end
 
-      end
-
-      register 'greet', Greet
-      register 'version', Version, aliases: ['v', '-v', '--version']
+        register 'greet', Greet
+        register 'version', Version, aliases: ['v', '-v', '--version']
 
+      end
     end
   end
-end
 
-Playwright::CLI.new(MyScript::CLI::Commands).call
+  Playwright::CLI.new(MyScript::CLI::Commands).call
 ```
 It will also give you a new file structure with an example (version) command:
 ```
@@ -146,36 +165,36 @@ with aliases.
 
 Version class simply looks like this:
 ```ruby
-module MyScript
-  module CLI
+  module MyScript
+    module CLI
+
+      VERSION = "0.0.1"
 
-    VERSION = "0.0.1"
+      module Commands
+        extend Playwright::CLI::Registry
 
-    module Commands
-      extend Playwright::CLI::Registry
+        class Version < Playwright::CLI::Command
+          desc "Responds with the version number."
 
-      class Version < Playwright::CLI::Command
-        desc "Responds with the version number."
+          example ["#=> #{VERSION}"]
 
-        example ["#=> #{VERSION}"]
+          def call(**)
+            display.print VERSION
+          end
 
-        def call(**)
-          puts VERSION
         end
 
       end
-
     end
   end
-end
 ```
 
 This is useful for command line apps that will have multiple functions. This
 example would let you do:
 
 ```shell
-$ my-script greet tom #=> Why, hello tom!
-$ my-script version #=> 0.0.1
+  $ my-script greet tom #=> Why, hello tom!
+  $ my-script version #=> 0.0.1
 ```
 
 ### Helpers
@@ -195,11 +214,11 @@ 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
+  class Greet < Playwright::CLI::Command
+    def call(**)
+      display.print "Hello!", color: :blue
+    end
   end
-end
 ```
 
 #### Ask
@@ -209,11 +228,11 @@ The Ask helper has 3 actions, `question`, `boolean_question`, and
 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]"
+  class Greet < Playwright::CLI::Command
+    def call(**)
+      ask.boolean_question "What's your name?" #=> "What's your name? [yn]"
+    end
   end
-end
 ```
 
 #### OS
@@ -222,12 +241,25 @@ 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'
+  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
-end
+```
+
+
+### Arguments & Options
+
+#### Validations
+
+You can add validations to your arguments and options by passing a proc or an
+array of procs to your argument or option declaration. The script will throw an
+error if the proc evaluates to false
+
+```
+ argument :url, validations: Proc.new { |url| URL_REGEX =~ url }
 ```
 
 ### Edit An App
@@ -238,7 +270,7 @@ editor to use when opening one of your playwright scripts.
 Use:
 
 ```shell
-$ echo $EDITOR
+  $ echo $EDITOR
 ```
 
 To see what playwright will default to. You can update this in your ~/.bashrc
@@ -249,7 +281,7 @@ In the future, I plan on allowing that to be a config you can set
 To edit an app:
 
 ```shell
-$ playwright edit my-script
+  $ playwright edit my-script
 ```
 
 `e` can be used instead of `edit`.
@@ -259,7 +291,7 @@ $ playwright edit my-script
 To see all Playwright apps, use:
 
 ```shell
-$ playwright list
+  $ playwright list
 ```
 
 `l`, `-l`, `--list` can be used instead of `list`.
@@ -269,7 +301,7 @@ $ playwright list
 Deleting a playwright app is simply:
 
 ```shell
-$ playwright destroy my-script
+  $ playwright destroy my-script
 ```
 
 `delete` or `d` can be used instead of `destroy`

data/lib/ext/hanami/option.rb

@@ -0,0 +1,11 @@
+module Hanami
+  class CLI
+    class Option
+
+      def validations
+        options[:validations] || []
+      end
+
+    end
+  end
+end

data/lib/ext/hanami/parser.rb

@@ -0,0 +1,42 @@
+module Hanami
+  class CLI
+    module Parser
+
+      # Copied and adjusted from hanami/cli codebase to handle validations
+      def self.call(command, arguments, names)
+
+        command.arguments.map.with_index do |arg, idx|
+          arg_value = arguments[idx]
+          unless [*arg.validations].all? { |validation| validation.call(arg_value) }
+            return Result.failure "Error: Invalid argument provided: #{arg_value}" if arg_value
+          end
+        end
+
+        parsed_options = {}
+
+        OptionParser.new do |opts|
+          command.options.each do |option|
+            opts.on(*option.parser_options) do |value|
+              # This conditional enforces validations
+              if option.validations.all? { |validation| validation.call(value) }
+                parsed_options[option.name.to_sym] = value
+              else
+                return Result.failure "Error: Invalid option provided: #{option.name}"
+              end
+            end
+          end
+
+          opts.on_tail("-h", "--help") do
+            return Result.help
+          end
+        end.parse!(arguments)
+
+        parsed_options = command.default_params.merge(parsed_options)
+        parse_required_params(command, arguments, names, parsed_options)
+      rescue ::OptionParser::ParseError
+        return Result.failure
+      end
+
+    end
+  end
+end

data/lib/ext/hanami.rb

@@ -0,0 +1,2 @@
+require_relative 'hanami/option'
+require_relative 'hanami/parser'

data/lib/playwright/cli/version.rb

@@ -2,6 +2,6 @@ require 'hanami/cli'
 
 module Playwright
   class CLI < Hanami::CLI
-    VERSION = "0.1.15"
+    VERSION = "0.1.16"
   end
 end

data/lib/playwright/cli.rb

@@ -8,6 +8,8 @@ require 'os'
 require 'uri'
 require 'pathname'
 
+require_relative '../ext/hanami.rb'
+
 module Playwright
   class CLI < Hanami::CLI
     ROOT_PATH = Pathname.new(File.expand_path('../..', File.dirname(__FILE__)))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Mike Gregory
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -173,6 +173,9 @@ files:
 - lib/assets/templates/script_readme_template.erb
 - lib/assets/templates/simple_script_template.erb
 - lib/assets/templates/version_subcommand_template.erb
+- lib/ext/hanami.rb
+- lib/ext/hanami/option.rb
+- lib/ext/hanami/parser.rb
 - lib/playwright/cli.rb
 - lib/playwright/cli/command.rb
 - lib/playwright/cli/commands.rb