jets 1.0.1 → 1.0.2

data/lib/jets/commands/import/cheatsheet.rb

@@ -0,0 +1,35 @@
+class Jets::Commands::Import
+  class Cheatsheet
+    def self.create(rack_repo_url)
+      new(rack_repo_url).create
+    end
+
+    def initialize(rack_repo_url)
+      @rack_repo_url = rack_repo_url
+    end
+
+    def create
+      path = File.expand_path("./templates/", File.dirname(__FILE__)) + "/submodules-cheatsheet.md"
+      basename = File.basename(path)
+      dest = "#{Jets.root}#{basename}"
+      cheatsheet = Jets::Erb.result(path, cheatsheet_vars)
+      FileUtils.mkdir_p(File.dirname(dest))
+      IO.write(dest, cheatsheet)
+      puts "Created #{basename} to help with using submodules."
+    end
+
+    def cheatsheet_vars
+      import_command = ARGV[0]
+      {
+        import_command: import_command,
+        rack_repo_url: @rack_repo_url,
+        jets_project_repo_url: jets_project_repo_url,
+      }
+    end
+
+    def jets_project_repo_url
+      # Thanks: https://stackoverflow.com/questions/4089430/how-can-i-determine-the-url-that-a-local-git-repository-was-originally-cloned-fr/4089452
+      `git config --get remote.origin.url`.strip rescue 'https://github.com/user/repo'
+    end
+  end
+end

data/lib/jets/commands/import/rail.rb

@@ -28,6 +28,13 @@ CODE
       end
     end
 
+    def copy_database_yaml
+      src = "#{Jets.root}config/database.yml"
+      dest = "#{Jets.root}rack/config/database.yml"
+      puts "Copying #{src} to #{dest}"
+      FileUtils.cp(src, dest)
+    end
+
     def finish_message
       puts <<~EOL
         #{"="*30}

data/lib/jets/commands/import/sequence.rb

@@ -4,65 +4,81 @@ require 'active_support/core_ext/string'
 require 'thor'
 require 'bundler'
 
-class Jets::Commands::Import::Sequence < Thor::Group
-  include Thor::Actions
-  argument :source
+class Jets::Commands::Import
+  class Sequence < Thor::Group
+    include Thor::Actions
+    argument :source
 
-private
-  def clone_project
-    check_git_installed
+  private
+    def clone_project
+      if File.exist?(rack_folder)
+        abort "The folder #{rack_folder} already exists.  Please remove it first if you want to import a project."
+      end
+
+      check_git_installed
+      if @options[:submodule]
+        git_submodule
+      else
+        git_clone
+      end
+    end
+
+    def git_submodule
+      puts "Adding project as a submodule"
+      run "git submodule add --force #{repo_url} #{rack_folder}"
+      Cheatsheet.create(repo_url)
+    end
 
-    command = "git clone #{repo_url} #{rack_folder}"
-    puts "=> #{command}"
-    if File.exist?(rack_folder)
-      abort "The folder #{rack_folder} already exists."
-    else
+    def git_clone
+      command = "git clone #{repo_url} #{rack_folder}"
+      # Thor's run already puts out the command, so no need to puts
       run command
+      run "rm -rf #{Jets.root}rack/.git"
     end
-  end
 
-  def copy_project
-    puts "Creating rack folder"
-    template_path = File.expand_path(@source)
-    set_source_paths(template_path)
-    directory ".", rack_folder
-  end
+    def copy_project
+      puts "Creating rack folder"
+      template_path = File.expand_path(@source)
+      set_source_paths(template_path)
+      directory ".", rack_folder
+    end
 
-  def set_source_paths(*paths)
-    # Using string with instance_eval because block doesnt have access to
-    # path at runtime.
-    self.class.instance_eval %{
-      def self.source_paths
-        #{paths.flatten.inspect}
-      end
-    }
-  end
+    def set_source_paths(*paths)
+      # Using string with instance_eval because block doesnt have access to
+      # path at runtime.
+      self.class.instance_eval %{
+        def self.source_paths
+          #{paths.flatten.inspect}
+        end
+      }
+    end
 
-  # normalize repo_url
-  def repo_url
-    if @source.include?('github.com')
-      @source # leave as is, user has provided full github url
-    else
-      "https://github.com/#{@source}"
+    # normalize repo_url
+    def repo_url
+      if @source.include?('github.com')
+        @source # leave as is, user has provided full github url
+      else
+        "https://github.com/#{@source}"
+      end
     end
-  end
 
-  def repo?
-    @source.include?('github.com')
-  end
+    def repo?
+      @source.include?('github.com')
+    end
 
-  def check_git_installed
-    return unless repo_url.include?('http') || repo_url.include?('git@')
-    unless git_installed?
-      abort "Unable to detect git installation on your system.  Git needs to be installed in order to clone the project."
+    def check_git_installed
+      return unless repo_url.include?('http') || repo_url.include?('git@')
+      unless git_installed?
+        abort "Unable to detect git installation on your system.  Git needs to be installed in order to clone the project."
+      end
     end
-  end
 
-  def git_installed?
-    system("type git > /dev/null 2>&1")
-  end
+    def git_installed?
+      system("type git > /dev/null 2>&1")
+    end
 
-  def rack_folder
-    "#{Jets.root}rack"
+    def rack_folder
+      "#{Jets.root}rack"
+    end
   end
 end

data/lib/jets/commands/import/templates/submodules-cheatsheet.md

@@ -0,0 +1,89 @@
+# Git Submodule Cheatsheet
+
+Git submodules take a little bit of getting used to. This is a cheatsheet for Git Submodules to help learn how to use them.  This file was generated as part of the `jets <%= @import_command %>` command.
+
+## Cheatsheet Summary
+
+The important submodule commands are:
+
+### On fresh clone project
+
+    git clone <%= @jets_project_repo_url %>
+    git submodule init # required on a fresh clone, or update won't do anything
+    git submodule update # syncs submodule rack folder with what parent project has as commits
+
+### Updating
+
+After doing a git pull on the Jets main project, you might notice changes to the submodule rack folder, you can update the rack folder with:
+
+    git submodule update # syncs submodule rack folder with what parent project has as commits
+
+## More Details
+
+The rest of the guide will explain in a little more detail submodules.
+
+## What are Git Submodules?
+
+Git submodules are a way to have a subfolder in your project be managed as a separate git repo.  The submodule folder is its own separate git repo and has its own history. The parent git project references a commit from the submodule project to sync up the subfolder accordingly.  Using submodules allows you to include a rack subfolder project into your Jets project code base and managed the rack project as a separate git repo.
+
+By using the `--submodule` option when you run the `jets import` command, Jets imports the rack project to the rack folder as a submodule.  This allows you to keep development of the rack project independent from the development of the Jets project. This is a useful setup if you are testing [Jets Mega Mode](http://rubyonjets.com/docs/megamode/) for more extended periods of time.
+
+We'll show you how to managed and sync the `rack` submodule folder with the parent Jets project folder.
+
+### rack submodule
+
+A rack folder was added to your Jets project as a git submodule.  Essentially this command was run.
+
+    git submodule add --force <%= @rack_repo_url %> rack
+
+The rack submodule folder gets immediately synced as a part of that `git submodule add` command.  This has already happened as part of the `jets <%= @import_command %>, we're just explaining the underlying command in case you're interested.
+
+### Fresh Clone
+
+**IMPORTANT**: On a fresh clone of your project, submodule folders do not automatically update and appear "empty".  This can be confusing for people who don't use submodules often. So here are the commands to update and sync the submodule folder:
+
+    git clone <%= @jets_project_repo_url %>
+    git submodule init # important to run init or next update will do nothing
+    git submodule update # after this the rack folder will no longer be empty
+                         # and will have code from <%= @rack_repo_url %>
+
+### Remove submodule
+
+If you ever decide to remove the submodule from your project, here are the commands.
+
+    git submodule deinit rack
+    git rm rack
+    # then add and commit your changes
+
+## Updating Projects
+
+The typical workflow is to go into the rack folder and run `git pull` to update the submodule folder to the latest changes. Then you cd back up to the main Jets project folder and run `git add`.  This updates the project submodule commit reference, which then allows others to pull down the changes and resync the submodules to the same commit. We'll go through some examples to help explain:
+
+### Updating rack folder submodule
+
+Here's an example where we will update the rack submodule folder to the latest `master` branch. Remember the master branch refers to the `rack` submodule folder of the <%= @rack_repo_url %> in this case.
+
+    cd my-jets-project # root of the Jets project
+    cd rack # in the submodule now, which contains a different repo history
+    git checkout master # on a fresh clone, the submodule folder will point to a specific git sha instead of a branch
+    git pull # get latest changes in master
+    cd .. # back to parent Jets project
+    git status # notice, it'll say: modified:  rack (new commits)
+    git add rack # updates the main projects' reference to the submodule git commit
+    git commit -m "update rack submodule"
+    git push # send your changes to everyone else
+
+Eventually, later another developer will pull down your changes on the Jets project and notice that the submodules have been updated.  When he runs a `git pull` and then does a `git status` he'll notice this:
+
+    $ git pull # another developer pulled down the changes
+    $ git st # notice the changes
+        modified:   rack (new commits)
+    $ git diff # another way a summary of the changes in the rack project
+    Submodule rack 6b0fb3a..4f6ea3f (rewind):
+      < test commit in rack submodule project
+
+This is when the developer will need to resync the rack submodule folder. He does it with this:
+
+    git submodule update # updates the rack folder to the commit that the parent is referencing
+
+That's it!

data/lib/jets/db.rb

@@ -0,0 +1,9 @@
+module Jets::Db ; end
+
+# Thanks: https://makandracards.com/makandra/42521-detecting-if-a-ruby-gem-is-loaded
+return unless File.exist?("#{Jets.root}config/database.yml")
+
+require "active_record"
+specs = Gem.loaded_specs
+require "mysql2" if specs.key?('mysql2')
+require "pg" if specs.key?('pg')

data/lib/jets/version.rb

@@ -1,3 +1,3 @@
 module Jets
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/vendor/jets-gems/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jets-gems.gemspec
+gemspec

data/vendor/jets-gems/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    jets-gems (0.1.0)
+      gems
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    gems (1.1.1)
+      json
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  jets-gems!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/vendor/jets-gems/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tung Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/vendor/jets-gems/README.md

@@ -0,0 +1,19 @@
+# Jets Gems
+
+[Jets](http://rubyonjets.com/) is a Ruby Serverless Framework on AWS Lambda.  allows you to create serverless applications with a beautiful language: Ruby. It includes everything required to build an application and deploy it to AWS Lambda. Jets makes serverless simple.
+
+The jets-gems library works with Jets to download and extract pre-compiled gems that work on AWS Lambda.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [tongueroo/jets-gems](https://github.com/tongueroo/jets-gems)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/vendor/{lambdagem → jets-gems}/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
 
-RSpec::Core::RakeTask.new
+task :default => :spec

data/vendor/jets-gems/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jets/gems"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/vendor/jets-gems/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/vendor/jets-gems/jets-gems.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jets/gems/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jets-gems"
+  spec.version       = Jets::Gems::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = %q{Library manages pre-compiled Lambda Gems for Jets Ruby Serverless Framework}
+  spec.homepage      = "https://github.com/tongueroo/jets-gems"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "gems"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end