rails-new 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c9f63a1b56bb93b9c6dc1d89d5ebe14879a8d13
-  data.tar.gz: 99d8b62c1d513aad577c3ce5eaa4ad6fe475d7ca
+  metadata.gz: 4796dc67275bd498094319869adcf14864198733
+  data.tar.gz: 3cbdcf5b99f8be252ae5699c90e8df4d23302107
 SHA512:
-  metadata.gz: 3a4baaa51b7061979600127f22f7d33bc2e057a68339c22733121f2aca381c8eea598cc1f2df7719b7367b28562f2ca0c3c456c15b701316dccae421fa718921
-  data.tar.gz: 7049d2579403dba12865fd432af8330a96fff260c012790861d70a40fd776e08bb941d1cd4950673d02a5058b13a9bc7f56a82ab3e12341a2802199c3d01d2f3
+  metadata.gz: 06e7ac0ab0068a4c92b32ad51c19f94f21130066bb4202af19573213f16786886ca54901d95601c7ff51a6169e37f9c0cf18d90486c11f9291acb7867e173831
+  data.tar.gz: 05a97a083d462f38d886b2f5ebcaa9f07a2411a08d940209b177c2b6b2cba06a67a6e29a74343407887142b0fd8cec8f4e338709227a6598184c70eac7f363b5

data/README.md

@@ -1,38 +1,44 @@
 # Rails New
 
-This is a wrapper over `rails new` attached to a privately managed repository of templates on `http://rails-new.herokuapp.com/admin`. We don't store the templates itself but a reference to his repository location (only GIT supported right now). The main objective of this repository is to be to able to put in a single place how the template should be using.
+This is a wrapper over `rails new` attached to a repository of rails application templates located on <http://rails-new.herokuapp.com>. This repository stores templates to be used with this gem as a client. The main objective is to be able to make something like this:
 
-For example, this url: <http://rails-new.herokuapp.com/api/v1/templates/julio/base.json> returns:
+```bash
+$ rails-new my-organization/application my-new-project
+```
+
+or even have the ability to have two or more rails templates related to specific things:
+
+```bash
+$ rails-new my-organization/api my-new-api
+```
+
+To accomplish this, the repository exposes a public API using your username and the template name. For example, this url: <http://rails-new.herokuapp.com/api/v1/templates/julio/application.json> returns the data for the stored template `julio/application` created by the user `julio` and named `application`:
 
 ```json
 {
   "template": {
     "id": 1,
-    "name": "base",
-    "git_repository": "https://github.com/juliogarciag/rails-template.git",
+    "name": "application",
+    "git_repository": "https://github.com/juliogarciag/rails-template",
+    "git_branch": "master",
     "main_file_location": "template.rb",
+    "updated_at": "2015-03-15T06:51:57.106Z",
     "arguments": [
       {
         "id": 1,
-        "key": "--skip-test-unit",
+        "key": "--skip-spring",
         "has_value": false,
         "value": ""
       },
       {
         "id": 2,
-        "key": "--skip-turbolinks",
+        "key": "--skip-test-unit",
         "has_value": false,
         "value": ""
       },
       {
         "id": 3,
-        "key": "--skip-bundle",
-        "has_value": false,
-        "value": ""
-      },
-      {
-        "id": 4,
-        "key": "--skip-spring",
+        "key": "--skip-turbolinks",
         "has_value": false,
         "value": ""
       }
@@ -41,15 +47,12 @@ For example, this url: <http://rails-new.herokuapp.com/api/v1/templates/julio/ba
 }
 ```
 
-This json represents the arguments needed for this template, the repository where this is stored and the location of the template file inside of the the repository.
+This json represents the arguments needed for this template, the repository where this is stored and the location of the template file inside of the the repository. The point is to be able to use it from this gem (or from somewhere else) to do two things (of many) that are very complex with Rails application templates:
 
-The fact that is privately managed is just temporal. To make it public, we should need to improve the UI and improve the security to completely remove the chance of shell execution through the pass of parameters or some other arguments. Because we are not totally sure yet of the security of that system, the system is kept privately.
+- Tie arguments (`--skip-turbolinks`, `--skip-test-unit`, etc) to the template. If you build a template that heavily rely on RSpec, you may want to make `--skip-test-unit` required as an argument. In normal usage, you should need to add the argument aside from the template argument.
+- `rails new -m URL` is broken by design. The command only works with super simple templates that doesn't use erb templates or copy files from somewhere else. This gem downloads the template with all the files needed to run and runs it from the file system, avoiding the problem with using urls.
 
-The main point of this gem is to allow to use that template in this way:
-
-```bash
-rails-new julio/base my-new-project
-```
+And, additionally, and this is more of a side-effect, this allows us to share Rails templates built in whatever way you want with everyone.
 
 ## Installation
 
@@ -61,6 +64,11 @@ Install running:
 
 Run `rails-new --help` for instructions.
 
+## Current Caveats
+
+- Right now, before running the `rails new...` command built with the template, the gem asks for confirmation of the command because there's always the chance of injection in maybe unexpected ways we can't simply assume don't exist. (If you can think of a way to avoid doing this, it will be really useful)
+- All templates are readable by everyone right now. We didn't think of a way to authenticate some template request right now without complicating the flow yet. This is just temporal.
+
 ## Contributing with Templates while private
 
 Create an issue with the git repository of the template, the location inside it, the name of the user you want to keep the repository within, the name of the template and the arguments you expect the template to be called with. This is just temporal until we figure out how to make it more user-friendly and secure at the same time.

data/bin/rails-new

@@ -5,6 +5,8 @@ require "thor/group"
 require 'httparty'
 require 'tmpdir'
 
+require_relative '../lib/rails_new'
+
 class RailsNewWrapper < Thor::Group
   desc "run `rails new` with the requirements of the template"
 
@@ -18,14 +20,8 @@ class RailsNewWrapper < Thor::Group
     :desc => "The application name to pass to Rails",
     :required => true
 
-  RAILS_NEW_API_SERVER = ENV['RAILS_NEW_API_SERVER'] || "https://rails-new.herokuapp.com"
-
-  TEMPLATE_URL = -> template_key do
-    "#{RAILS_NEW_API_SERVER}/api/v1/templates/#{template_key}.json"
-  end
-
   def request_template_data
-    url = TEMPLATE_URL[template_key]
+    url = RailsNew::Api.template_url_for(template_key)
 
     say "Fetching template data from ", :green, false
     say url, :blue
@@ -50,7 +46,7 @@ class RailsNewWrapper < Thor::Group
 
       say "Cloning git repository ", :green, false
       say @git_repository, :blue
-      Kernel.system "git clone -b #{@git_branch} #{@git_repository} #{temp_dir}"
+      Kernel.system %w{git clone -b #{@git_branch} #{@git_repository} #{temp_dir}}
 
       command = [
         "rails", "new", @app_name, "-m", template_location, *@arguments, *extra_rails_arguments

data/lib/rails_new/api.rb

@@ -0,0 +1,11 @@
+module RailsNew
+  module Api
+    extend self
+
+    API_SERVER = ENV['RAILS_NEW_API_SERVER'] || "https://rails-new.herokuapp.com"
+
+    def template_url_for(template_key)
+      "#{API_SERVER}/api/v1/templates/#{template_key}.json"
+    end
+  end
+end

data/lib/rails_new/version.rb

@@ -0,0 +1,3 @@
+module RailsNew
+  VERSION = "0.0.5"
+end

data/lib/rails_new.rb

@@ -0,0 +1,4 @@
+module RailsNew
+end
+
+require_relative './rails_new/api'

data/{rails-new-gem.gemspec → rails-new.gemspec}

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rails/new/gem/version'
+require 'rails_new/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rails-new"
-  spec.version       = Rails::New::Gem::VERSION
+  spec.version       = RailsNew::VERSION
   spec.authors       = ["juliogarciag"]
   spec.email         = ["julioggonz@gmail.com"]
   spec.summary       = %q{A Rails template installation command.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-new
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,9 +80,11 @@ files:
 - README.md
 - Rakefile
 - bin/rails-new
-- lib/rails/new/gem.rb
-- lib/rails/new/gem/version.rb
-- rails-new-gem.gemspec
+- lib/rails_new.rb
+- lib/rails_new/.DS_Store
+- lib/rails_new/api.rb
+- lib/rails_new/version.rb
+- rails-new.gemspec
 homepage: ''
 licenses:
 - MIT

data/lib/rails/new/gem/version.rb

@@ -1,7 +0,0 @@
-module Rails
-  module New
-    module Gem
-      VERSION = "0.0.4"
-    end
-  end
-end

data/lib/rails/new/gem.rb

@@ -1,9 +0,0 @@
-require "rails/new/gem/version"
-
-module Rails
-  module New
-    module Gem
-      # Your code goes here...
-    end
-  end
-end