sanji 1.0.0.pre → 1.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db57a4e0739187f622d2dfd0e997135ac62bb85d
-  data.tar.gz: fa9dc9a29f35da36a0cd46150927a579bfda400e
+  metadata.gz: 4f13d7a1af1f0d2edf708a58d578a712f907fee0
+  data.tar.gz: c7bad2377c6be921fb2eebcb0be840dffe3cfb61
 SHA512:
-  metadata.gz: 399f7e0e08d027a55c717a2bdcd0522adb6433e9b79d3f369a0ee14f5d8c3ddc583f584daaba233bfc9ec25f707bcbfe7cc2a57f0d247ce5c07bbf10d7c05e61
-  data.tar.gz: 18aed75ec1c1fe017eb316bf603c206ed6e6ac705c1630aec79232743ede32923a7200eb40c1412ec8cd8ff159d69c5660f1e5952b4f94f25547f2ffc0b378c9
+  metadata.gz: 699d5133e49fd48fbe0fa8f5ea938e84edb50423503ce924ce8934c97c6cf4364ea138882d79cf0bbfb89fa1a1ffba36fea06237cd8d441947ba37a49bdcd3de
+  data.tar.gz: 6261997f340b575fee6db4c7b1cbd2df0b4d148bd899eceab473c3583d7cce29d5c6d67d41a5e3fd1cdf52de1426464f70e4aa3191b81e441fd806c86976c370

data/README.md

@@ -1,3 +1,82 @@
 # sanji
 
+Customized Rails application generator.
+Inspired by [suspenders](https://github.com/thoughtbot/suspenders) and [rails_apps_composer](https://github.com/RailsApps/rails_apps_composer) gems.
+
 ![sanji](http://icons.iconarchive.com/icons/crountch/one-piece-character/256/Sanji-icon.png)
+
+## Installation
+
+```
+gem install sanji
+```
+
+## Basic usage
+
+```
+sanji app_name
+```
+
+## Local Recipe
+
+```ruby
+class Sanji::Locals::MyRecipe < Sanji::Recipe
+
+  def prompt
+    # return a string (boolean question) to make this recipe optional
+  end
+  
+  def after_create
+    # execute after app is created
+  end
+  
+  def after_bundle
+    # execute after bundle
+  end
+  
+  def after_everything
+    # execute after "after_bundle"
+  end
+
+end
+```
+
+## Local Setup
+
+- `.bash_profile`
+  ```
+  export SANJI_HOME=/path/to/sanji/
+  ```
+
+- `/path/to/sanji/sanji.yml`
+  ```ruby
+  cookbook: cookbook_name
+  recipes: /path/to/recipes
+  
+  cookbooks:
+    cookbook_name:
+    - recipe_name
+    - other_recipe_name
+    - another_recipe
+    
+    my_cookbook:
+    - my_recipe
+  ```
+
+## Inclusions
+
+- Gems
+  - pg - PostgreSQL adapter.
+  - seedbank - Organize seeds.
+  - annotate - Model annotations.
+  - figaro - Read environment variables.
+  - haml-rails - View template engine.
+  - draper - Decorator for views.
+  - reform - Form objects.
+  - virtus - Coercion for Form objects.
+  - bootstrap-sass - Twitter Bootstrap CSS and Javascripts (optional).
+  - normalize-rails - CSS Reset (if bootstrap is not selected).
+  - paperclip - Attachments for models.
+  - kaminari - Pagination.
+  - thin - Development web server.
+  - quiet_assets - Prevent asset logs.

data/lib/sanji/app_builder.rb

@@ -1,53 +1,51 @@
 module Sanji
   class AppBuilder < Rails::AppBuilder
 
-    RECIPES = [
-      :Setup,
-      :Annotate,
-      :Draper,
-      :Figaro,
-      :Haml,
-      :Paloma,
-      :Postgresql,
-      :Reform,
-      :Seedbank,
-      :Frontend,
-      :SimpleGems,
-      :Controllers,
-      :Devise,
-      :Cleanup
-    ]
-
     def after_create_tasks
-      RECIPES.each do |name|
-        self.get_recipe_instance(name).run_after_create
+      self.setup_recipe.run_after_create
+
+      self.recipe_classes.each do |recipe_class|
+        self.get_recipe_instance(recipe_class).run_after_create
       end
+
+      self.cleanup_recipe.run_after_create
     end
 
     def after_bundle_tasks
-      RECIPES.each do |name|
-        self.get_recipe_instance(name).run_after_bundle
+      self.setup_recipe.run_after_bundle
+
+      self.recipe_classes.each do |recipe_class|
+        self.get_recipe_instance(recipe_class).run_after_bundle
       end
+
+      self.cleanup_recipe.run_after_bundle
     end
 
     def after_everything_tasks
-      RECIPES.each do |name|
-        self.get_recipe_instance(name).run_after_everything
+      self.setup_recipe.run_after_everything
+
+      self.recipe_classes.each do |recipe_class|
+        self.get_recipe_instance(recipe_class).run_after_everything
       end
+
+      self.cleanup_recipe.run_after_everything
     end
 
 
 
     protected
 
-    def get_recipe_instance name
-      recipe = self.recipe_instances[name]
+    def recipe_classes
+      Options.instance.recipe_classes
+    end
+
+    def get_recipe_instance recipe_class
+      recipe = self.recipe_instances[recipe_class.name.to_sym]
       return recipe if recipe
 
-      recipe_class = ::Sanji::Recipes.const_get name
       recipe = recipe_class.new self
 
-      self.recipe_instances[name] = recipe
+      self.recipe_instances[recipe_class.name.to_sym] = recipe
       recipe
     end
 
@@ -55,5 +53,13 @@ module Sanji
       @recipe_instances ||= {}
     end
 
+    def setup_recipe
+      @setup_recipe ||= Sanji::Recipes::Setup.new(self)
+    end
+
+    def cleanup_recipe
+      @cleanup_recipe ||= Sanji::Recipes::Cleanup.new(self)
+    end
+
   end
 end

data/lib/sanji/config.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+class Sanji::Config
+
+  attr_reader :contents
+
+  def initialize filename = nil
+    @contents = YAML.load_file(filename) if filename
+  end
+
+  def cookbook
+    self.contents['cookbook'] if self.contents
+  end
+
+  def cookbooks
+    self.contents['cookbooks'] if self.contents
+  end
+
+  def has_cookbook? name
+    return false unless self.contents
+    self.cookbooks.has_key? name.to_s
+  end
+
+  def recipes
+    return [] unless self.contents
+    self.cookbooks[self.cookbook]
+  end
+
+  def recipes_path
+    self.contents['recipes'] if self.contents
+  end
+
+end

data/lib/sanji/options.rb

@@ -0,0 +1,91 @@
+class Sanji::Options
+
+  DEFAULT_HOME_PATH = "#{File.dirname(__FILE__)}/../"
+  HOME_PATH_ENV_VARIABLE = 'SANJI_HOME'
+
+  CONFIG_FILENAME = 'sanji.yml'
+  SANJI_ITEMS_PREFIX = '_'
+
+
+  def self.instance
+    @instance ||= self.new
+  end
+
+
+
+  def initialize
+    @default_config = Sanji::Config.new "#{DEFAULT_HOME_PATH}/#{CONFIG_FILENAME}"
+    @user_config = self.fetch_user_config
+  end
+
+  def user_recipes_path
+    return nil if self.user_home_path.blank?
+    "#{self.user_home_path}/#{@user_config.recipes_path}"
+  end
+
+  def cookbook
+    @cookbook ||= @user_config.cookbook || @default_config.cookbook
+  end
+
+  def sanji_cookbook?
+    self.is_sanji_item? self.cookbook
+  end
+
+  def recipe_classes
+    @recipes ||=
+      self.cookbook_recipe_names.map do |recipe_name|
+        self.get_recipe_class recipe_name
+      end
+  end
+
+  def cookbook_recipe_names
+    return @cookbook_entry if @cookbook_entry
+
+    cookbook_valid_name = self.valid_item_name self.cookbook
+
+    @cookbook_entry =
+      if self.sanji_cookbook?
+        @default_config.cookbooks[cookbook_valid_name]
+      else
+        @user_config.cookbooks[cookbook_valid_name]
+      end
+  end
+
+
+  protected
+
+  def user_home_path
+    @user_home_path ||= ENV[HOME_PATH_ENV_VARIABLE]
+  end
+
+  def fetch_user_config
+    filename =
+      user_home_path ? "#{self.user_home_path}/#{CONFIG_FILENAME}" : nil
+
+    Sanji::Config.new filename
+  end
+
+  def is_sanji_item? item_name
+    item_name.start_with? SANJI_ITEMS_PREFIX
+  end
+
+  def valid_item_name item_name
+    if self.is_sanji_item? item_name
+      return item_name.sub SANJI_ITEMS_PREFIX, ''
+    end
+
+    item_name
+  end
+
+  def get_recipe_class name
+    recipe_valid_name = self.valid_item_name name
+    recipe_class_name = recipe_valid_name.camelize
+
+    if self.is_sanji_item? name
+      Sanji::Recipes.const_get recipe_class_name
+    else
+      Sanji::Locals.const_get recipe_class_name
+    end
+  end
+
+end

data/lib/sanji/recipe.rb

@@ -4,21 +4,29 @@ class Sanji::Recipe
 
   def initialize builder
     @a = Sanji::Assistant.new self, builder
+    @disabled = false
   end
 
   def run_after_create
+    @disabled = a.no?(self.prompt) if self.prompt.present?
+    return if @disabled
+
     a.log_start :after_create
     self.after_create
     a.log_end :after_create
   end
 
   def run_after_bundle
+    return if @disabled
+
     a.log_start :after_bundle
     self.after_bundle
     a.log_end :after_bundle
   end
 
   def run_after_everything
+    return if @disabled
+
     a.log_start :after_everything
     self.after_everything
     a.log_end :after_everything
@@ -33,4 +41,7 @@ class Sanji::Recipe
   def after_everything
   end
 
+  def prompt
+  end
+
 end

data/lib/sanji/recipes/draper.rb

@@ -1,5 +1,9 @@
 class Sanji::Recipes::Draper < Sanji::Recipe
 
+  def prompt
+    'Do you want to use Draper?'
+  end
+
   def after_create
     a.add_gem 'draper'
     a.generator :decorator, false

data/lib/sanji.rb

@@ -2,24 +2,37 @@ module Sanji
   module Recipes
   end
 
+  module Locals
+  end
+
   module Utilities
   end
 end
 
+require 'sanji/config'
+require 'sanji/options'
+
 # Require all utilities
 Dir["#{File.dirname(__FILE__)}/sanji/utilities/*.rb"].each do |filename|
   require filename.sub('.rb', '')
 end
 
-
 require 'sanji/assistant'
 require 'sanji/recipe'
+require 'sanji/app_generator'
+require 'sanji/app_builder'
 
 # Require all recipes
 Dir["#{File.dirname(__FILE__)}/sanji/recipes/*.rb"].each do |filename|
   require filename.sub('.rb', '')
 end
 
-require 'sanji/app_generator'
-require 'sanji/app_builder'
+# Require user recipes
+if Sanji::Options.instance.user_recipes_path
+  Dir["#{Sanji::Options.instance.user_recipes_path}/*.rb"].each do |filename|
+    require filename.sub('.rb', '')
+  end
+end
+
+
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanji
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0.pre.1
 platform: ruby
 authors:
 - Karl Paragua
@@ -23,6 +23,8 @@ files:
 - lib/sanji/app_builder.rb
 - lib/sanji/app_generator.rb
 - lib/sanji/assistant.rb
+- lib/sanji/config.rb
+- lib/sanji/options.rb
 - lib/sanji/recipe.rb
 - lib/sanji/recipes/annotate.rb
 - lib/sanji/recipes/cleanup.rb