potassium 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd782f1354793989cfaf9ee632caeeec257b26fc
-  data.tar.gz: d26ed0b7bb9b6a7d8283a0e174cffd5758079d0b
+  metadata.gz: dbbae269a8525af660d5f14aabf1fcfba6983e58
+  data.tar.gz: 5760d02a273c5c3bf4ab3d97c380206c224af897
 SHA512:
-  metadata.gz: 4a548bc74ca74368a90d165c2aa56f87d054f0de071b4fad939702658b815ee13e375e7418ef45cc29da7e72b9c515e8f58644f89b887321d6360c623ba2dd7e
-  data.tar.gz: 2239c068a29d5e4ae00325ba104f4e94c265cbe58b19143dfda6d3222ecb19eddabe23b07dcfe96960045167048b048776e0dd4911079f56eeb37a1e84876dc2
+  metadata.gz: 1fe7819245a24592988c21856d674125ee563ef441b9058cabec7c00d0913c6777e814061bdfcf62ce85262451589b1b8513bdd3bf6bb77b69594fd5d1a281eb
+  data.tar.gz: fa72ded8a7c6d245dd957e387e1abea1978c22e4ca3ec7be3249d55541ee69c2c8ce9e6d6e3e0cf21890af68c684914fa29760909b67d1f5ff026a11960f1059

data/README.md

@@ -1,31 +1,117 @@
 # Potassium
 
-TODO: Write a gem description
+A Rails application generator from [Platanus](https://github.com/platanus), inspired by [Suspenders](https://github.com/thoughtbot/suspenders).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Just install it globally:
 
-```ruby
-gem 'potassium'
-```
+    $ gem install potassium
 
-And then execute:
+## Usage
 
-    $ bundle
+Use the `potassium` command to create a new project:
 
-Or install it yourself as:
+    $ potassium create project-name
 
-    $ gem install potassium
+## What's inside Potassium?
 
-## Usage
+Potassium Rails apps includes the following gems and technologies:
 
-TODO: Write usage instructions here
+- [rbenv](https://github.com/sstephenson/rbenv) for managing the project's ruby version.
+- [rbenv-vars](https://github.com/sstephenson/rbenv-vars) for keeping secrets and by-server configurations.
+- [Bower](http://bower.io) for frontend assets packages.
+- [EditorConfig](http://editorconfig.org) for keeping all our editor configurations the same. 
+- [pry](http://pryrepl.org) and [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug) for a less painful debugging experience.
+- [RSpec](http://rspec.info) for unit and integration testing.
+- [FactoryGirl](https://github.com/thoughtbot/factory_girl) for test factories.
+- [Guard](http://guardgem.org) for continuous testing and other watch-related tasks.
+
+And some optional integrations that will be asked for on project's creation:
+
+- [PostgreSQL](http://www.postgresql.org) or [MySQL](https://www.mysql.com) for the database.
+- [Devise](https://github.com/plataformatec/devise) for authentication.
+- [ActiveAdmin](http://activeadmin.info) for admin interfaces.
+- [Pundit](https://github.com/elabs/pundit) for role-based authorization.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/potassium/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+### How do i add something new to Potassium?
+
+In the [lib/potassium/templates/application](lib/potassium/templates/application) folder, you will find [the template](lib/potassium/templates/application/template.rb). You should follow the next conventions to add something:
+
+*__NOTE:__ If you only want to use Potassium but not to add something new, the next parts shouldn't be necessary.*
+
+#### Ask
+
+If you need to ask something to the user before doing something, follow the next steps:
+
+1. Create a ruby file on the [recipes/asks](lib/potassium/templates/application/recipes/asks) folder.
+2. Then, ask something using the methods defined in [Inquirer](https://github.com/arlimus/inquirer.rb), that we use by default. Use the [DSL](docs/dsl.md) to store some information.
+3. Finally, register the **ask** you created in [the template](lib/potassium/templates/application/template.rb):
+
+  ```ruby
+  run_action(:asking) do
+    # ...
+    eval_file "recipes/asks/my_ask.rb"
+  end
+  ```
+
+#### Install
+
+Now, to add some behavior, thanks to the [DSL](docs/dsl.md) we have a kind of standard flow of what happens when a new project is created. To understand this better, please read [the template](lib/potassium/templates/application/template.rb). Anyway, the structure is like this:
+
+1. Clean the Gemfile and add the base gems that rails needs to work.
+2. Then, run all the **asks** recipes.
+3. Then, execute all the **recipes**, that are ruby files stored on the [recipes](lib/potassium/templates/application/recipes) folder. They specify what gems are needed and registers callbacks based on this process, usually to execute things after the gem installation happened or after some other recipe finished his work.
+4. Then, install the gems, filling the Gemfile before with all the gathered gems.
+5. Finally, create the database.
+
+The main step is the 3, when we run the recipes. A recipe can do anything (because is a ruby script) but what should be their main responsabilities are to gather gems and register callbacks for the process.
+
+For example, if we want to create an optional recipe to add a gem called `banana_split` that needs to run a generator, we can do the following.
+
+1. Create the **ask** file:
+
+  ```ruby
+  # application/recipes/ask/banana_split.rb
+  use_banana_split = Ask.confirm("Do you want to use Banana Split?")
+  set(:use_banana_split, true) if use_banana_split
+  ```
+
+2. Then, register the **ask**:
+
+  ```ruby
+  run_action(:asking) do
+    # ...
+    eval_file "recipes/asks/banana_split.rb"
+  end
+  ```
+
+3. Create the **recipe**. Register a gem using `gather_gem` and use a callback to run after the `gem_install` action succeded to run the generator. `gem_install` is one of the main actions that should be easily visible with a sneak peek in [the template](lib/potassium/templates/application/template.rb).
+
+  ```ruby
+  # application/recipes/banana_split.rb
+  if get(:use_banana_split)
+    gather_gem('banana_split', '~> 1.2')
+
+    after(:gem_install) do
+      generate('banana_split:install')
+    end
+  end
+  ```
+
+4. Register the **recipe**:
+
+  ```ruby
+  run_action(:recipe_loading) do
+    # ...
+    eval_file "recipes/banana_split.rb"
+  end
+  ```
+
+5. Ready, let's start working on your new project.
+
+#### The DSL
+
+To see some further documentation of what we added to the rails template's DSL, check the [DSL documentation](docs/dsl.md). Remember that the DSL we are documenting is an extension over the [Rails Application Template DSL](http://edgeguides.rubyonrails.org/rails_application_templates.html), that itself is a dsl based on [Thor](https://github.com/erikhuda/thor/wiki).

data/{lib/potassium/templates/application/README.md → docs/dsl.md}

@@ -1,21 +1,3 @@
-# Rails Template
-
-On this template, we base our Rails applications.
-
-## Usage
-
-Clone the template.
-
-```bash
-$ git clone git@github.com:platanus/rails_template.git
-```
-
-Create your new application based on template
-
-```bash
-$ rails new my_new_app -m /path_to_template_root/app_template.rb
-```
-
 ## The DSL
 
 The DSL to extend and add recipes defines methods divided in mixins called helpers.

data/lib/potassium/cli.rb

@@ -9,7 +9,5 @@ module Potassium::CLI
 
   commands_from 'potassium/cli/commands'
 
-  default_command :create
-
   exit Potassium::CLI.run(ARGV)
 end

data/lib/potassium/version.rb

@@ -1,3 +1,3 @@
 module Potassium
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potassium
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,11 +94,11 @@ files:
 - README.md
 - Rakefile
 - bin/potassium
+- docs/dsl.md
 - lib/potassium.rb
 - lib/potassium/cli.rb
 - lib/potassium/cli/commands/create.rb
 - lib/potassium/template_finder.rb
-- lib/potassium/templates/application/README.md
 - lib/potassium/templates/application/assets/.bowerrc
 - lib/potassium/templates/application/assets/.editorconfig
 - lib/potassium/templates/application/assets/.pryrc