faastruby 0.4.15 → 0.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a06282c038c0af5a31802c852b845e637df02b9fcbcd0b345383ae6ccb5b6e6a
-  data.tar.gz: c7515040c1c137287364e98aff7f54c6899829048f09b9c1e6a713a80b55a261
+  metadata.gz: 6e1be30dd9f54e8b0c0f65e0d7fa3f579675f8fd428801e45770b3f4940ca8b2
+  data.tar.gz: 05d2262fd80bb23904c82157d21d51b0fa8640b2bdd0dca411d2b8547c921119
 SHA512:
-  metadata.gz: 010c57047b4d4a2e5b16d3a335d4b161ea6ea4227e8a30b85cfb43177b5762c9063f74339a7fe3b906c425833a549a33aa7cfa6ab92fb5a9d3c8002ecf97c565
-  data.tar.gz: ecfa98457cf79f02359706b95527c9c21192f95accb4e825b06732f29363f325cb48296d820b326e0a4e00971eec96e35947aa4e896652998f85bd147b8b1162
+  metadata.gz: 8a7a836d1f7b3e57facbd428d719d309d6649f5f65c5e6f0ed5a98170d99962f5e55055dd76164a78ed9002894b2695e1f066790f0470fdf175c0c2b0d56438e
+  data.tar.gz: bcaa943d337a47d2aa328b5af0abe3c3af79917f5a72b5add6b92fdd39a5064510be932c576cfb3c5a4025e64b494a6cdb75ebd5dc06f7ebaffc60b8f28da408

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.4.16 - Feb 4 2019
+- Add support for function templates
+- Add cli_version to `faastruby.yml`
+
+## 0.4.15 - Feb 2 2019
+- Add support for Crystal 0.27.1 and Ruby 2.6.1
+
 ## 0.4.14 - Feb 1 2019
 - Ruby functions now use a spec helper from `faastruby` gem.
 - Crystal functions now use the shard `faastruby-spec-helper` to assist on tests.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    faastruby (0.4.14)
+    faastruby (0.4.16)
       colorize (~> 0.8)
       faastruby-rpc (~> 0.2.1)
       oj (~> 3.6)

data/README.md

@@ -1,7 +1,9 @@
 [![Gem Version](https://badge.fury.io/rb/faastruby.svg)](https://badge.fury.io/rb/faastruby)
 [![Build Status](https://travis-ci.org/FaaStRuby/faastruby-cli.svg?branch=master)](https://travis-ci.org/FaaStRuby/faastruby-cli)
 
-[Changelog](https://github.com/FaaStRuby/faastruby-cli/blob/master/CHANGELOG.md)
+* Looking for help? [Ask a question](https://meta.stackoverflow.com/questions/ask?tags=FaaStRuby,Serverless,Ruby,FaaS).
+
+* [Changelog](https://github.com/FaaStRuby/faastruby-cli/blob/master/CHANGELOG.md)
 
 # faastruby-cli
 

data/lib/faastruby/cli.rb

@@ -5,6 +5,8 @@ require 'zip'
 require 'colorize'
 require 'faastruby/cli/commands'
 require 'faastruby/cli/package'
+require 'faastruby/cli/template'
+require 'erb'
 
 module FaaStRuby
   FAASTRUBY_YAML = 'faastruby.yml'
@@ -23,22 +25,22 @@ module FaaStRuby
         return
       end
       start_server(args) if command == 'server'
-      check_version
+      # check_version
       check_region
       error("Unknown command: #{command}") unless FaaStRuby::Command::COMMANDS.has_key?(command)
       FaaStRuby::Command::COMMANDS[command].new(args).run
     end
 
-    def self.check_version
-      latest = RestClient.get('https://faastruby.io/gem/minimum.txt').body rescue '0.0.1'
-      if Gem::Version.new(FaaStRuby::VERSION) < Gem::Version.new(latest)
-        FaaStRuby.error([
-          "You are using an old version of the gem. Please run 'gem update faastruby'.".red,
-          "Installed version: #{FaaStRuby::VERSION}",
-          "Latest version: #{latest}"
-        ], color: nil)
-      end
-    end
+    # def self.check_version
+    #   latest = RestClient.get('https://faastruby.io/gem/minimum.txt').body rescue '0.0.1'
+    #   if Gem::Version.new(FaaStRuby::VERSION) < Gem::Version.new(latest)
+    #     FaaStRuby.error([
+    #       "You are using an old version of the gem. Please run 'gem update faastruby'.".red,
+    #       "Installed version: #{FaaStRuby::VERSION}",
+    #       "Latest version: #{latest}"
+    #     ], color: nil)
+    #   end
+    # end
 
     def self.check_region
       ENV['FAASTRUBY_REGION'] ||= DEFAULT_REGION

data/lib/faastruby/cli/commands/function/new.rb

@@ -7,18 +7,25 @@ module FaaStRuby
           @missing_args = []
           FaaStRuby::CLI.error(@missing_args, color: nil) if missing_args.any?
           @function_name = @args.shift
-          @base_dir = "./#{@function_name}"
           parse_options
-          @options['template_path'] ||= 'templates/ruby'
-          @options['template'] ||= 'example'
+          @base_dir ||= @function_name
           @options['runtime_name'] ||= 'ruby'
           @options['runtime_version'] ||= '2.5.3'
-          @yaml_content = yaml_for(@options['runtime_name'])
+          @options['template'] ||= FaaStRuby::Template.new(type: 'local', source: Template.gem_template_path_for('example', runtime: @options['runtime_name']))
         end
 
         def run
-          dir_exists? unless @options['force']
-          copy_template
+          @options['template'].install(to: @base_dir, force: @options['force'])
+          faastruby_yaml = "#{@base_dir}/faastruby.yml"
+          if File.file?(faastruby_yaml)
+            @yaml_content = YAML.load(File.read(faastruby_yaml))
+            @yaml_content['name'] = @function_name
+            @options['runtime_name'], @options['runtime_version'] = @yaml_content['runtime']&.split(':')
+            @options['runtime_name'] ||= 'ruby'
+            @options['runtime_version'] ||= '2.5.3'
+          else
+            @yaml_content = yaml_for(@options['runtime_name'])
+          end
           write_yaml
           post_tasks(@options['runtime_name'])
         end
@@ -27,9 +34,19 @@ module FaaStRuby
           "new".light_cyan + " FUNCTION_NAME [--blank] [--force] [--runtime]" +
           <<-EOS
 
-    --blank              # Create a blank function
-    --force              # Continue if directory already exists and overwrite files
-    --runtime            # Choose the runtime. Options are: #{SUPPORTED_RUNTIMES.join(', ')}
+    --blank
+        Create a blank function
+    --force
+        Continue if directory already exists and overwrite files
+    -g
+        Initialize a Git repository.
+    --runtime
+        Choose the runtime. Options are: #{SUPPORTED_RUNTIMES.join(', ')}
+    --template TYPE(local|git|github):SOURCE
+        Use another function as template. Examples:
+          --template local:/path/to/folder
+          --template git:git@github.com:user/repo.git
+          --template github:user/repo
 EOS
         end
 
@@ -44,28 +61,32 @@ EOS
           while @args.any?
             option = @args.shift
             case option
+            when '-g'
+              @options['git_init'] = true
+            when '--template'
+              FaaStRuby::CLI.error("Option '--template' can't be used with '--blank' or '--runtime'.".red) if @options['runtime'] || @options['blank_template']
+              template = @args.shift
+              type, source = template.split(':')
+              @options['template'] = FaaStRuby::Template.new(type: type, source: source)
             when '--runtime'
+              FaaStRuby::CLI.error("Option '--template' can't be used with '--blank' or '--runtime'.".red) if @options['template']
               @options['runtime'] = @args.shift
               @options['runtime_name'], @options['runtime_version'] = @options['runtime'].split(':')
-              @options['template_path'] = "templates/#{@options['runtime_name']}"
+              template_name = @options['blank_template'] ? 'example-blank' : 'example'
+              @options['template'] = FaaStRuby::Template.new(type: 'local', source: Template.gem_template_path_for('example', runtime: @options['runtime_name']))
               FaaStRuby::CLI.error(["Unsupported runtime: #{@options['runtime']}".red, "Supported values are #{SUPPORTED_RUNTIMES.join(", ")}"], color: nil) unless SUPPORTED_RUNTIMES.include?(@options['runtime'])
             when '-f', '--force'
               @options['force'] = true
             when '--blank'
-              @options['template'] = 'example-blank'
+              FaaStRuby::CLI.error("Option '--template' can't be used with '--blank' or '--runtime'.".red) if @options['template']
+              @options['blank_template'] = true
+              @options['template'] = FaaStRuby::Template.new(type: 'local', source: Template.gem_template_path_for('example-blank', runtime: @options['runtime_name'] || 'ruby'))
             else
               FaaStRuby::CLI.error(["Unknown argument: #{option}".red, usage], color: nil)
             end
           end
         end
 
-        def dir_exists?
-          return unless File.directory?(@base_dir)
-          print "The folder '#{@function_name}' already exists. Overwrite files? [y/N] "
-          response = STDIN.gets.chomp
-          FaaStRuby::CLI.error("Cancelled", color: nil) unless response == 'y'
-        end
-
         def missing_args
           if @args.empty?
             @missing_args << "Missing argument: FUNCTION_NAME".red
@@ -74,28 +95,6 @@ EOS
           @missing_args
         end
 
-        def copy_template
-          source = "#{Gem::Specification.find_by_name("faastruby").gem_dir}/#{@options['template_path']}/#{@options['template']}"
-          FileUtils.mkdir_p(@base_dir)
-          FileUtils.cp_r("#{source}/.", "#{@base_dir}/")
-          case @options['runtime_name']
-          when 'ruby'
-            puts "+ d #{@base_dir}".green
-            puts "+ d #{@base_dir}/spec".green
-            puts "+ f #{@base_dir}/spec/handler_spec.rb".green
-            puts "+ f #{@base_dir}/spec/spec_helper.rb".green
-            puts "+ f #{@base_dir}/Gemfile".green
-            puts "+ f #{@base_dir}/handler.rb".green
-          when 'crystal'
-            puts "+ d #{@base_dir}".green
-            puts "+ d #{@base_dir}/spec".green
-            puts "+ f #{@base_dir}/spec/handler_spec.cr".green
-            puts "+ f #{@base_dir}/spec/spec_helper.cr".green
-            puts "+ d #{@base_dir}/src".green
-            puts "+ f #{@base_dir}/src/handler.cr".green
-          end
-        end
-
         def yaml_for(runtime_name)
           case runtime_name
           when 'crystal'
@@ -106,6 +105,7 @@ EOS
             test_command = 'rspec'
           end
           {
+            'cli_version' => FaaStRuby::VERSION,
             'name' => @function_name,
             'runtime' => @options['runtime'] || 'ruby:2.5.3',
             'test_command' => test_command,
@@ -115,10 +115,12 @@ EOS
         end
 
         def write_yaml
-          write_file("#{@base_dir}/faastruby.yml", @yaml_content.to_yaml)
+          write_file("#{@function_name}/faastruby.yml", @yaml_content.to_yaml)
         end
 
         def post_tasks(runtime_name)
+          update_readme
+          puts `git init #{@base_dir}` if @options['git_init']
           case runtime_name
           when 'ruby'
             bundle_install
@@ -130,6 +132,13 @@ EOS
           end
         end
 
+        def update_readme
+          file_path = "#{@base_dir}/README.md"
+          return false unless File.file?(file_path)
+          readme = File.read(file_path)
+          File.write(file_path, ERB.new(readme).result(binding))
+        end
+
         def bundle_install
           spinner = spin("Installing gems...")
           system("bundle install --gemfile=#{@base_dir}/Gemfile > /dev/null")

data/lib/faastruby/cli/template.rb

@@ -0,0 +1,90 @@
+module FaaStRuby
+  class Template
+    TYPES = ['local', 'git', 'github']
+    def self.gem_template_path_for(name, runtime:)
+      "#{Gem::Specification.find_by_name("faastruby").gem_dir}/templates/#{runtime}/#{name}"
+    end
+
+    attr_accessor :type, :source, :target
+    def initialize(type:, source:)
+      FaaStRuby::CLI.error(["Unknown template type: '#{type}'. Valid types are:", TYPES], color: nil) unless TYPES.include?(type)
+      @type = type
+      @source = source
+    end
+
+    def install(to:, force: false)
+      @target = to
+      @force = force
+      FaaStRuby::CLI.error("Could not determine the target path for template '#{type}:#{source}'. Please report this bug at https://github.com/FaaStRuby/faastruby-cli/issues", color: nil) unless target
+      return install_from_folder(source) if local?
+      return install_from_git(source) if git?
+      return install_from_github if github?
+    end
+
+    def install_from_github
+      repo = "git@github.com:/#{source}.git"
+      install_from_git(repo)
+    end
+
+    def install_from_git(repo)
+      local_dir = Dir.mktmpdir
+      git_pull(repo, local_dir)
+      install_from_folder(local_dir)
+    ensure
+      FileUtils.remove_entry local_dir
+    end
+
+    def git_pull(repo, local_dir)
+      FaaStRuby::CLI.error("Could not clone repository #{repo} into #{local_dir}") unless
+        system("git clone #{repo} #{local_dir}")
+    end
+
+    def install_from_folder(folder)
+      # puts "installing from folder #{folder}"
+      if File.directory?(target)
+        puts "! d #{target}".yellow
+      else
+        FileUtils.mkdir_p(target)
+        puts "+ d #{target}".green
+      end
+      Dir.glob("**/*", base: folder).each do |entry|
+        full_source_path = "#{folder}/#{entry}"
+        full_target_path = "#{target}/#{entry}"
+        create_dir(full_target_path) if File.directory?(full_source_path)
+        copy_file(source: full_source_path, destination: full_target_path) if File.file?(full_source_path)
+      end
+      
+    end
+
+    def create_dir(dir)
+      if File.directory?(dir)
+        puts "! d #{dir}".yellow
+      else
+        FileUtils.mkdir_p(dir)
+        puts "+ d #{dir}".green
+      end
+    end
+
+    def copy_file(source:, destination:)
+      if File.file?(destination) && !@force
+        print "File '#{destination}' already exists. Overwrite? [y/N] "
+        answer = STDIN.gets.chomp
+        return(puts "[skipped] #{destination}") unless ['y', 'Y'].include?(answer)
+      end
+      FileUtils.cp(source, destination)
+      puts "+ f #{destination}".green
+    end
+
+    def local?
+      type == 'local'
+    end
+
+    def git?
+      type == 'git'
+    end
+
+    def github?
+      type == 'github'
+    end
+  end
+end

data/lib/faastruby/version.rb

@@ -1,3 +1,3 @@
 module FaaStRuby
-  VERSION = '0.4.15'
+  VERSION = '0.4.16'
 end

data/templates/crystal/example-blank/README.md

@@ -0,0 +1,22 @@
+# <%= @function_name %>
+One Paragraph of function description goes here.
+## Getting started
+### Prerequisites
+* [FaaStRuby](https://faastruby.io) version <%= FaaStRuby::VERSION %> or higher.
+```
+# To install
+~$ gem install faastruby
+
+# To update
+~$ gem update faastruby
+```
+### How to deploy this function
+```
+~$ cd FUNCTION_FOLDER
+~/FUNCTION_FOLDER$ faastruby deploy-to WORKSPACE_NAME
+```
+### How to use this function as a template
+```
+~$ faastruby new FUNCTION_NAME --template github:user/repository
+```
+

data/templates/crystal/example/README.md

@@ -0,0 +1,22 @@
+# <%= @function_name %>
+One Paragraph of function description goes here.
+## Getting started
+### Prerequisites
+* [FaaStRuby](https://faastruby.io) version <%= FaaStRuby::VERSION %> or higher.
+```
+# To install
+~$ gem install faastruby
+
+# To update
+~$ gem update faastruby
+```
+### How to deploy this function
+```
+~$ cd FUNCTION_FOLDER
+~/FUNCTION_FOLDER$ faastruby deploy-to WORKSPACE_NAME
+```
+### How to use this function as a template
+```
+~$ faastruby new FUNCTION_NAME --template github:user/repository
+```
+

data/templates/ruby/example-blank/README.md

@@ -0,0 +1,22 @@
+# <%= @function_name %>
+One Paragraph of function description goes here.
+## Getting started
+### Prerequisites
+* [FaaStRuby](https://faastruby.io) version <%= FaaStRuby::VERSION %> or higher.
+```
+# To install
+~$ gem install faastruby
+
+# To update
+~$ gem update faastruby
+```
+### How to deploy this function
+```
+~$ cd FUNCTION_FOLDER
+~/FUNCTION_FOLDER$ faastruby deploy-to WORKSPACE_NAME
+```
+### How to use this function as a template
+```
+~$ faastruby new FUNCTION_NAME --template github:user/repository
+```
+

data/templates/ruby/example/README.md

@@ -0,0 +1,22 @@
+# <%= @function_name %>
+One Paragraph of function description goes here.
+## Getting started
+### Prerequisites
+* [FaaStRuby](https://faastruby.io) version <%= FaaStRuby::VERSION %> or higher.
+```
+# To install
+~$ gem install faastruby
+
+# To update
+~$ gem update faastruby
+```
+### How to deploy this function
+```
+~$ cd FUNCTION_FOLDER
+~/FUNCTION_FOLDER$ faastruby deploy-to WORKSPACE_NAME
+```
+### How to use this function as a template
+```
+~$ faastruby new FUNCTION_NAME --template github:user/repository
+```
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faastruby
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.4.16
 platform: ruby
 authors:
 - Paulo Arruda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -255,6 +255,7 @@ files:
 - lib/faastruby/cli/commands/workspace/list.rb
 - lib/faastruby/cli/credentials.rb
 - lib/faastruby/cli/package.rb
+- lib/faastruby/cli/template.rb
 - lib/faastruby/function.rb
 - lib/faastruby/server.rb
 - lib/faastruby/server/concurrency_controller.rb
@@ -270,17 +271,21 @@ files:
 - lib/faastruby/spec_helper.rb
 - lib/faastruby/version.rb
 - lib/faastruby/workspace.rb
+- templates/crystal/example-blank/README.md
 - templates/crystal/example-blank/spec/handler_spec.cr
 - templates/crystal/example-blank/spec/spec_helper.cr
 - templates/crystal/example-blank/src/handler.cr
+- templates/crystal/example/README.md
 - templates/crystal/example/spec/handler_spec.cr
 - templates/crystal/example/spec/spec_helper.cr
 - templates/crystal/example/src/handler.cr
 - templates/ruby/example-blank/Gemfile
+- templates/ruby/example-blank/README.md
 - templates/ruby/example-blank/handler.rb
 - templates/ruby/example-blank/spec/handler_spec.rb
 - templates/ruby/example-blank/spec/spec_helper.rb
 - templates/ruby/example/Gemfile
+- templates/ruby/example/README.md
 - templates/ruby/example/handler.rb
 - templates/ruby/example/spec/handler_spec.rb
 - templates/ruby/example/spec/spec_helper.rb