playwright-cli 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf6b0773f6e0c4cf167238c7be5822a05edc46a5a91b0695d4af614404e31fe
-  data.tar.gz: cfa4ecbf6a0008335b7eb50be5dee2072868c0ff90b04b2bf82635801727c457
+  metadata.gz: c70812c6e97a5e0351036b1f32cc533e7833d59ad46c32efb16b6cdc8e167023
+  data.tar.gz: c39ef6a202fed3feeb7015d1f0adbfdfe29fd42f41a4493555e4e67b28f2d5d0
 SHA512:
-  metadata.gz: 3316da2a6707077cd299168c5b32579dbba6e0f90c08a771caaf919545a1f356fab67c20e5f510d08ca3b14c9f5504dedddf2abefd212d67562fa18678e5af9b
-  data.tar.gz: fbd942ca4ef8b5e72d334c47420fb3a9900f87043e8b263de072a191a64ba8536c2e105f724d8c6b39e92acbd09150096260106d7812163d4e8b70fb0555514d
+  metadata.gz: bbffdc6bdb10897709564e578ea6b9312dd2a2c0f8a468a5c80b9a7d0e98624c5a5fcc72bfef381ca55492d3bbcfa4b54a24bce7e6e8d50d0bb606ba3c22ac36
+  data.tar.gz: 2c93bab7b6fc00a73d48fc5f3eae2f332ae8ec1cd9468bc8aa9998269381d6a343fbe7d6287156e982d2e4671c6e57e956acbb9a6b4cbf38fa7db3aee787d4e9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    playwright-cli (0.1.1)
+    playwright-cli (0.1.3)
       colorize (~> 0.1)
       hanami-cli (~> 0.1)
 
@@ -18,6 +18,7 @@ GEM
     hanami-utils (1.1.2)
       concurrent-ruby (~> 1.0)
       transproc (~> 1.0)
+    memfs (1.0.0)
     method_source (0.9.0)
     pry (0.9.12.6)
       coderay (~> 1.0)
@@ -47,6 +48,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  memfs (~> 1.0)
   playwright-cli!
   pry (~> 0.9.0)
   pry-nav (~> 0.2.4)

data/lib/assets/templates/expanded_script_template.erb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'playwright/cli'
+require_relative 'lib/version'
+
+module <%= klass_name %>
+  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."
+
+        argument :name, required: true, desc: 'Whom shall I greet?'
+
+        example [
+          "\"Johnny Boy\" #=> Why, hello Johnny Boy!"
+        ]
+
+        def call(name:, **)
+          puts "Why, hello #{name}!"
+        end
+
+      end
+
+      register 'greet', Greet
+      register 'version', Version, aliases: ['v', '-v', '--version']
+
+    end
+  end
+end
+
+Playwright::CLI.new(<%= klass_name %>::CLI::Commands).call

data/lib/assets/templates/{new_script.erb → simple_script_template.erb}

@@ -7,7 +7,7 @@ module <%= klass_name %>
     module Commands
       extend Playwright::CLI::Registry
 
-      class Greet < Playwright::CLI::Command
+      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?'
@@ -22,7 +22,7 @@ module <%= klass_name %>
 
       end
 
-      register 'greet', Greet
+      register_root Root
 
     end
   end

data/lib/assets/templates/version_subcommand_template.erb

@@ -0,0 +1,22 @@
+module <%= klass_name %>
+  module CLI
+
+    VERSION = "0.0.1"
+
+    module Commands
+      extend Playwright::CLI::Registry
+
+      class Version < Playwright::CLI::Command
+        desc "Responds with the version number."
+
+        example ["#=> #{VERSION}"]
+
+        def call(**)
+          puts VERSION
+        end
+
+      end
+
+    end
+  end
+end

data/lib/playwright/cli.rb

@@ -13,19 +13,28 @@ module Playwright
     PLAYS_BIN_PATH = File.join(PLAYS_PATH, 'bin')
     TEMPLATES_PATH = File.join(ROOT_PATH, 'lib', 'assets', 'templates')
 
+    require "playwright/cli/configuration"
     require "playwright/cli/utils"
     require "playwright/cli/commands"
     require "playwright/cli/registry"
     require "playwright/cli/template"
     require "playwright/cli/version"
 
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
     def self.call(*args)
       new(Commands).call(*args)
     end
-    
+
     def call(arguments: ARGV, out: $stdout)
       result = commands.get(arguments)
-      
+
       if !result.found? && commands.has_root?
         result = commands.get_root(arguments)
         command, args = parse(result, out)

data/lib/playwright/cli/commands.rb

@@ -2,13 +2,15 @@ module Playwright
   class CLI < Hanami::CLI
     module Commands
       extend Hanami::CLI::Registry
-      require 'playwright/cli/commands/version'
-      require 'playwright/cli/commands/generate'
       require 'playwright/cli/commands/destroy'
+      require 'playwright/cli/commands/edit'
+      require 'playwright/cli/commands/generate'
+      require 'playwright/cli/commands/version'
 
-      register "version", Version, aliases: ['v', '-v', '--version']
-      register "generate", Generate, aliases: ['g', 'new']
       register "destroy", Destroy, aliases: ['delete', 'd']
+      register "edit", Edit, aliases: ['e']
+      register "generate", Generate, aliases: ['g', 'new']
+      register "version", Version, aliases: ['v', '-v', '--version']
     end
   end
 end

data/lib/playwright/cli/commands/destroy/command.rb

@@ -6,7 +6,7 @@ module Playwright
       class Destroy < Hanami::CLI::Command
         class Command
           include Utils::Display
-          include Utils::ScriptFiles
+          include Utils::FileManager
 
           TEMPLATE_FILE = 'new_script.erb'.freeze
           PATH_BIN_DIR = File.join('/', 'usr', 'local', 'bin').freeze
@@ -21,19 +21,7 @@ module Playwright
           end
 
           def run
-            validate!
-            destroy_script
-          end
-
-          private
-
-          def validate!
-            script_path_and_file?
-          end
-
-          def destroy_script
-            delete_playwright_script
-            display.color_print "Playwright script \"#{@name}\" destroyed!"
+            file_manager.uninstall_script @name
           end
 
         end

data/lib/playwright/cli/commands/edit.rb

@@ -0,0 +1,24 @@
+require 'playwright/cli/commands/edit/command'
+
+module Playwright
+  class CLI < Hanami::CLI
+    module Commands
+      extend Hanami::CLI::Registry
+
+      class Edit < Hanami::CLI::Command
+        desc "Opens your editor to playwright command."
+
+        argument :name, required: true, desc: 'Script name'
+
+        example [
+          "my-script # opens your editor to my-script"
+        ]
+
+        def call(name: nil, **)
+          Command.run(name)
+        end
+      end
+
+    end
+  end
+end

data/lib/playwright/cli/commands/edit/command.rb

@@ -0,0 +1,27 @@
+module Playwright
+  class CLI < Hanami::CLI
+    module Commands
+      extend Hanami::CLI::Registry
+
+      class Edit < Hanami::CLI::Command
+        class Command
+          include Utils::Display
+          include Utils::FileManager
+
+          def self.run(name)
+            new(name).run
+          end
+
+          def initialize(name)
+            @name = name
+          end
+
+          def run
+            file_manager.open_editor script_name: @name
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/playwright/cli/commands/generate.rb

@@ -9,13 +9,14 @@ module Playwright
         desc "Builds a template for a new playwright command."
 
         argument :name, required: true, desc: 'Script name'
+        option :type, default: 'simple', values: %w[ expanded simple ]
 
         example [
           "my-new-script\n# script will be called with my-new-script\n# class will be called MyNewScript"
         ]
 
-        def call(name: nil, **)
-          Command.run(name)
+        def call(name:, type:, **)
+          Command.run(name, type.to_sym)
         end
       end
 

data/lib/playwright/cli/commands/generate/command.rb

@@ -1,3 +1,5 @@
+require 'playwright/cli/template'
+
 module Playwright
   class CLI < Hanami::CLI
     module Commands
@@ -7,77 +9,22 @@ module Playwright
         class Command
           include Utils::Display
           include Utils::Ask
-          include Utils::ScriptFiles
+          include Utils::FileManager
 
           TEMPLATE_FILE = 'new_script.erb'.freeze
           PATH_BIN_DIR = File.join('/', 'usr', 'local', 'bin').freeze
 
-          def self.run(name)
-            new(name).run
+          def self.run(name, type)
+            new(name, type).run
           end
 
-          def initialize(name)
-            @template = Playwright::CLI::Template.new(file: TEMPLATE_FILE, script_name: name)
+          def initialize(name, type)
             @name = name
+            @type = type
           end
 
           def run
-            valid? do
-              create_script
-              set_permissions
-              symlink_into_path
-              open_editor
-            end
-          end
-
-          private
-
-          def valid?
-            validate!
-            yield
-          end
-
-          def validate!
-            if symlink_path_and_file? && !script_path_and_file?
-              display.error "There is already a script in your #{PATH_BIN_DIR} with that name!"
-            elsif script_path_and_file?
-              if ask.boolean_question "This playwright script already exists! Overwrite it?"
-                delete_playwright_script
-              else
-                display.abort "Aborting Operation."
-              end
-            end
-            true
-          end
-
-          def create_script
-            if script_path_and_file?
-              display.error "This script already exists!"
-            end
-            FileUtils.mkdir_p(Playwright::CLI::PLAYS_BIN_PATH)
-            FileUtils.touch(script_path_and_file)
-            File.write(script_path_and_file, @template.render)
-            display.color_print "New File Created: #{script_path_and_file}"
-          end
-
-          def set_permissions
-            FileUtils.chmod "u+x", script_path_and_file
-            display.color_print "Executable Permissions Set!"
-          end
-
-          def symlink_into_path
-            delete_symlink_path_file
-            FileUtils.symlink(script_path_and_file, symlink_path_and_file)
-            display.color_print "Symlink Created!"
-          end
-
-          def open_editor
-            `$EDITOR #{script_path_and_file}`
-            if $?.success?
-              display.color_print "Opening script in your editor..."
-            else
-              display.error "Could not open Editor!"
-            end
+            file_manager.install_script script_name: @name, type: @type
           end
 
         end

data/lib/playwright/cli/configuration.rb

@@ -0,0 +1,17 @@
+module Playwright
+  class CLI
+    class Configuration
+      attr_accessor :home_dir,
+                    :executable_path_dir
+
+      DEFAULT_HOME = ENV['HOME']
+      DEFAULT_EXECUTABLE_PATH_DIR = File.join('/', 'usr', 'local', 'bin')
+
+      def initialize
+        @home_dir = DEFAULT_HOME
+        @executable_path_dir = DEFAULT_EXECUTABLE_PATH_DIR
+      end
+
+    end
+  end
+end

data/lib/playwright/cli/template.rb

@@ -1,24 +1,39 @@
+require 'playwright/cli/utils/file_manager'
+
 module Playwright
   class CLI < Hanami::CLI
     class Template
 
-      attr_reader :script_name
+      attr_reader :script_name, :out_file, :type
 
-      def initialize(file:, script_name:)
-        @script_name = script_name
-        @file = File.join(Playwright::CLI::TEMPLATES_PATH, file)
-      end
+      SIMPLE_TYPE = :simple
+      SIMPLE_TEMPLATE = 'simple_script_template.erb'
+      EXPANDED_TYPE = :expanded
+      EXPANDED_TEMPLATE = 'expanded_script_template.erb'
+      SUBCOMMAND_TYPE = :subcommand
+      SUBCOMMAND_TEMPLATE = 'version_subcommand_template.erb'
 
-      def klass_name
-        @script_name.split(/[A-Z\-\_\/]/).map(&:capitalize).join
+      TEMPLATE_MAP = {
+        SIMPLE_TYPE => SIMPLE_TEMPLATE,
+        EXPANDED_TYPE => EXPANDED_TEMPLATE,
+        SUBCOMMAND_TYPE => SUBCOMMAND_TEMPLATE
+      }
+
+      def initialize(name:, out_file:, type: SIMPLE_TYPE, klass_name: nil)
+        @script_name = name
+        @out_file = out_file
+        @template_file = File.join(Playwright::CLI::TEMPLATES_PATH, TEMPLATE_MAP[type])
+        @klass_name = klass_name
       end
 
-      def contents
-        File.read @file
+      def klass_name
+        @klass_name || @script_name.gsub('.rb', '').split(/[A-Z\-\_\/]/).map(&:capitalize).join
       end
 
       def render
-        ERB.new(contents).result(binding)
+        contents = File.read(@template_file)
+        text = ERB.new(contents).result(binding)
+        File.write(out_file, text)
       end
 
     end

data/lib/playwright/cli/utils.rb

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

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

@@ -18,7 +18,8 @@ module Playwright
 
           def boolean_question question
             display.color_print "#{question} [yn]", color: DEFAULT_COLOR
-            response = STDIN.gets.chomp.strip.downcase.to_sym
+            response = $stdin.gets
+            sanitized_response = response.chomp.strip.downcase.to_sym if response && response.length > 0
             boolean_response_map[response]
           end
 

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

@@ -0,0 +1,212 @@
+require 'playwright/cli/utils/ask'
+require 'playwright/cli/utils/display'
+require 'playwright/cli/configuration'
+require 'playwright/cli/template'
+
+module Playwright
+  class CLI < Hanami::CLI
+    module Utils
+      module FileManager
+
+        def file_manager
+          @file_manager ||= FileManager.new
+        end
+
+        class FileManager
+          include Display
+          include Ask
+
+          attr_reader :script_name, :type
+
+          def initialize script_name: nil, type: nil
+            @script_name = script_name
+            @type = type
+          end
+
+          def install_script script_name:, type:
+            @script_name = script_name
+            @type = type
+            create_script_files
+            set_permissions
+            write_template
+            create_symlink
+            open_editor
+          end
+
+          def uninstall_script script_name
+            @script_name = script_name
+            delete_script_files
+          end
+
+          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
+          end
+
+          def script_name_rb
+            "#{script_name}.rb"
+          end
+
+          private
+
+          def self.playwright_parent_dir
+            Playwright::CLI.configuration.home_dir
+          end
+
+          def self.executable_path_dir
+            Playwright::CLI.configuration.executable_path_dir
+          end
+
+          def self.dot_playwright_dir
+            File.join playwright_parent_dir, '.playwright'
+          end
+
+          def self.plays_dir
+            File.join dot_playwright_dir, 'plays'
+          end
+
+          def self.config_file
+            File.join dot_playwright_dir, 'config.rb'
+          end
+
+          def self.create_file_structure
+            FileUtils.mkdir_p(plays_dir)
+            FileUtils.touch(config_file)
+          end
+
+          def self.path
+            ENV['PATH'].split(':')
+          end
+
+          def self.all_commands_in_path
+            @all_commands_in_path ||= path.map do |path_dir|
+              Dir["#{path_dir}/*"].map { |executable| executable.split('/').last }
+            end.flatten
+          end
+# ==============================================================================
+# LAZY ATTRIBUTES
+# ==============================================================================
+
+          def template
+            @template ||= Template.new(name: script_name_rb, out_file: executable_file, type: type)
+          end
+
+# ==============================================================================
+# PATHS & PATH PREDICATES
+# ==============================================================================
+
+          def root_dir
+            File.join self.class.plays_dir, script_name
+          end
+
+          def root_dir_exists?
+            File.exists? root_dir
+          end
+
+          def executable_file
+            File.join root_dir, script_name_rb
+          end
+
+          def executable_file_exists?
+            File.exists? executable_file
+          end
+
+          def symlink_file
+            File.join self.class.executable_path_dir, script_name
+          end
+
+          def symlink_file_exists?
+            File.symlink? symlink_file
+          end
+
+          def script_lib_dir
+            File.join root_dir, 'lib'
+          end
+
+          def version_subcommand_file
+            File.join script_lib_dir, 'version.rb'
+          end
+
+  # ==============================================================================
+  # CREATE METHODS
+  # ==============================================================================
+
+          def create_script_files
+            validate_before_create_script_files!
+            self.class.create_file_structure
+            FileUtils.mkdir_p root_dir
+            display.color_print "New Directory Created: #{root_dir}"
+            FileUtils.touch executable_file
+            display.color_print "New File Created: #{executable_file}"
+            create_expanded_files if type == :expanded
+          end
+
+          def create_expanded_files
+            FileUtils.mkdir_p script_lib_dir
+            FileUtils.touch version_subcommand_file
+          end
+
+          def set_permissions
+            FileUtils.chmod "u+x", executable_file
+            display.color_print "Executable Permissions Set: #{executable_file}"
+          end
+
+          def write_template
+            template.render
+            if type == Template::EXPANDED_TYPE
+              new_template = Template.new(
+                name: 'version.rb',
+                out_file: version_subcommand_file,
+                type: Template::SUBCOMMAND_TYPE,
+                klass_name: template.klass_name
+              )
+              new_template.render
+            end
+          end
+
+          def create_symlink
+            FileUtils.symlink(executable_file, symlink_file)
+            display.color_print "New Symlink Created: #{symlink_file} from #{executable_file}"
+          end
+
+          def validate_before_create_script_files!
+            if self.class.all_commands_in_path.include?(script_name)
+              display.error "There is already a script in your $PATH with that name!"
+            elsif executable_file_exists?
+              if ask.boolean_question "This playwright script already exists! Overwrite it?"
+                delete_playwright_script
+              else
+                display.abort "Aborting Operation."
+              end
+            end
+          end
+
+  # ==============================================================================
+  # DELETE METHODS
+  # ==============================================================================
+
+          def delete_script_files
+            validate_before_delete_script_files!
+            FileUtils.rm_rf root_dir
+            FileUtils.rm symlink_file
+            display.color_print "Playwright script '#{script_name}' destroyed!"
+          end
+
+          def validate_before_delete_script_files!
+            if symlink_file_exists? && !root_dir_exists?
+              display.error "The script named '#{script_name}' is not a playright script!"
+            elsif !root_dir_exists?
+              display.error "No play with that name exists!"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/playwright/cli/version.rb

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

data/playwright-cli.gemspec

@@ -36,6 +36,7 @@ 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_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.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Mike Gregory
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: memfs
+  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
@@ -127,21 +141,26 @@ files:
 - bin/console
 - bin/setup
 - exe/playwright
-- lib/assets/templates/new_script.erb
+- lib/assets/templates/expanded_script_template.erb
+- lib/assets/templates/simple_script_template.erb
+- lib/assets/templates/version_subcommand_template.erb
 - lib/playwright/cli.rb
 - lib/playwright/cli/command.rb
 - lib/playwright/cli/commands.rb
 - lib/playwright/cli/commands/destroy.rb
 - lib/playwright/cli/commands/destroy/command.rb
+- lib/playwright/cli/commands/edit.rb
+- lib/playwright/cli/commands/edit/command.rb
 - lib/playwright/cli/commands/generate.rb
 - lib/playwright/cli/commands/generate/command.rb
 - lib/playwright/cli/commands/version.rb
+- lib/playwright/cli/configuration.rb
 - lib/playwright/cli/registry.rb
 - lib/playwright/cli/template.rb
 - lib/playwright/cli/utils.rb
 - lib/playwright/cli/utils/ask.rb
 - lib/playwright/cli/utils/display.rb
-- lib/playwright/cli/utils/script_files.rb
+- lib/playwright/cli/utils/file_manager.rb
 - lib/playwright/cli/version.rb
 - playwright-cli.gemspec
 homepage: https://github.com/mgreg90/playwright-cli

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

@@ -1,40 +0,0 @@
-module Playwright
-  class CLI < Hanami::CLI
-    module Utils
-      module ScriptFiles
-
-        PATH_BIN_DIR = File.join('/', 'usr', 'local', 'bin').freeze
-
-        def script_path_and_file
-          File.join Playwright::CLI::PLAYS_BIN_PATH, @name
-        end
-
-        def script_path_and_file?
-          File.exists? script_path_and_file
-        end
-
-        def symlink_path_and_file
-          File.join PATH_BIN_DIR, @name
-        end
-
-        def symlink_path_and_file?
-          File.exists? symlink_path_and_file
-        end
-
-        def delete_playwright_script
-          delete_script_file
-          delete_symlink_path_file
-        end
-
-        def delete_script_file
-          FileUtils.rm script_path_and_file  if script_path_and_file?
-        end
-
-        def delete_symlink_path_file
-          FileUtils.rm symlink_path_and_file if symlink_path_and_file?
-        end
-
-      end
-    end
-  end
-end