chili 0.1.0 → 0.2.0

data/.gitignore

@@ -12,10 +12,11 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-spec/dummy/main_app/db/*.sqlite3
-spec/dummy/main_app/log/*.log
-spec/dummy/main_app/tmp/
-spec/dummy/main_app/.sass-cache
-spec/result
+spec/dummy/example/db/*.sqlite3
+spec/dummy/example/log/*.log
+spec/dummy/example/tmp/
+spec/dummy/example/.sass-cache
+spec/dummy/example/vendor/chili_template
+spec/dummy/example/Gemfile
 tmp
 .DS_Store

data/README.md

@@ -9,26 +9,32 @@ while leaving the main code untouched.
 
 ## Installation
 
-Install Chili on your system (no need to add it to your app's gemfile):
+First add chili to your app's Gemfile:
 
-    $ gem install chili
+```ruby
+gem 'chili'
+```
+
+...and run `bundle`.
 
 ## Usage
 
-Just like engines chili extensions are like mini apps that are created separately from the main app using the "chili" command.
+Chili extensions are like mini apps that are created inside your main app's vendor directory using using the "chili" command.
 
 ### Creating a new chili extension
 
-As an example, assuming you want to add a new extension named "social" that exposes a new social feature in the form of a like-button 
-to a subset of users, first run:
+As an example, assuming you want to add a new extension named "social" that exposes a new social feature in the form of a like-button
+to a subset of users, first run within your main app:
 
     $ chili social
 
 This is basically a shortcut for running the `rails plugin new` engine generator with a custom template and will:
 
-1. Create a directory named chili_social containing the basic structure for the extension
-2. Clone the app you are adding the extension to as a submodule into chili_social/main_app
-3. Add a reference to the extension to the main app gemfile for development/testing
+1. Create a the directory vendor/chili_social containing the basic structure for the extension
+2. Add a reference to the extension to the main app gemfile
+
+Since the extension is mounted as a gem you'll have to run `bundle`
+after this.
 
 ### Define who can see the extension
 
@@ -46,7 +52,7 @@ end
 ### Modifying view templates in main app
 
 Chili uses deface to modify existing view templates (see [deface docs](https://github.com/railsdog/deface#using-the-deface-dsl-deface-files) for details)
-Add overrides to the `app/overides` directory mirroing the path of the view you want to modify.
+Add overrides to the `app/overides` directory mirroring the path of the view you want to modify.
 For example, assuming the main app has the partial `app/views/posts/_post.html.erb`:
 
 ```erb
@@ -57,14 +63,23 @@ For example, assuming the main app has the partial `app/views/posts/_post.html.e
 
 ### Adding new resources
 
-Use `rails g scaffold Like` as usual when using engines. The new resource will be namespaced to ChiliSocial::Like
+Go to the extension's directory and use `rails g scaffold Like` as usual when using engines. The new resource will be namespaced to ChiliSocial::Like
 and automounted in the main app at `/chili/social/likes`, but only accessible when active_if is true.
 All the rules for using [engine-based models](http://railscasts.com/episodes/277-mountable-engines?view=asciicast) apply.
 
+
+### Migrations
+
+Migrations are handled exactly the same way as engines. Use the
+following commands after you've added a new migration to your extension:
+
+    $ rake chili_social:migrations:install
+    $ rake db:migrate
+
 ### Modifying existing models
 
-Create a model with the same name as the one you want to modify: `rails g model User --migration=false`
-and inherit from the original:
+Create a model with the same name as the one you want to modify by running: `rails g model User --migration=false` inside your extension's directory
+and edit it to inherit from the original:
 
 ```ruby
 # app/models/chili_social/user.rb
@@ -75,7 +90,7 @@ module ChiliSocial
 end
 ```
 
-Access through the namespaced model:
+Access in your overrides/extension views through the namespaced model:
 
 ```erb
 <%= ChiliSocial::User.first.likes %>
@@ -93,23 +108,6 @@ Add files as usual in `app/assets/chili_social/javascripts|stylesheets` and inje
 <%= javascript_include_tag 'chili_social/application' %>
 ```
 
-## Releasing to production
-
-Once your chili extension is ready to be released all you have to do is push the repo somewhere, 
-add the extension to the Gemfile of the app you are releasing it to:
-
-```ruby
-gem 'chili_social', git: 'git@github.com:githubuser/chili_social.git'
-```
-
-...and bundle and install any migrations (just like any other engine):
-
-``` 
-$ bundle
-$ rake chili_social:migrations:install
-$ rake db:migrate
-```
-
 ## Gotchas
 
 - Chili will not be able to automount if you use a catch-all route in your main app (ie `match '*a', to: 'errors#routing'`), you will have to remove the catch-all or manually add the engine to the main app's routes file.

data/Rakefile

@@ -6,8 +6,8 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/main_app/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
+# APP_RAKEFILE = File.expand_path("../spec/dummy/main_app/Rakefile", __FILE__)
+# load 'rails/tasks/engine.rake'
 
 require 'rspec/core/rake_task'
 

data/bin/chili

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 template_file = File.join(File.dirname(__FILE__), '..', 'lib', 'chili', 'template.rb')
-system "rails plugin new chili_#{ARGV.first} --mountable -m #{template_file}"
+system "rails plugin new vendor/chili_#{ARGV.first} --mountable -m #{template_file}"

data/lib/chili/tasks.rb

@@ -3,9 +3,5 @@ module Chili
     # App tasks
     require 'rails'
     load 'rails/tasks/engine.rake'
-
-    # Gem tasks
-    require 'bundler/gem_helper'
-    Bundler::GemHelper.install_tasks
   end
 end

data/lib/chili/template.rb

@@ -1,27 +1,18 @@
 # Edit gemspec
 require File.expand_path('../version', __FILE__)
-gemspec = "#{app_path}.gemspec"
+gemspec = "#{name}.gemspec"
 gsub_file gemspec, '# s.add_dependency "jquery-rails"', "s.add_dependency 'chili', '~> #{Chili::VERSION}'"
 gsub_file gemspec, 'TODO: Your name', `git config user.name`.chomp
 gsub_file gemspec, 'TODO: Your email', `git config user.email`.chomp
 gsub_file gemspec, /TODO(:\s)?/, ''
 gsub_file gemspec, 'Dir["test/**/*"]', 's.files.grep(%r{^(test|spec|features)/})'
 
-# Add main app as submodule
-# For some reason root when using git method is test/dummy so doing this manually
-main_app_git_repo = ENV['MAIN_APP'] || ask("Where is the main app you are extending located? (ie git://github.com/myname/myapp.git)")
-if main_app_git_repo.present?
-  run "cd #{destination_root} && git init"
-  run "cd #{destination_root} && git submodule add #{main_app_git_repo}  main_app"
-
-  # Add gem to main app Gemfile
-  append_to_file "main_app/Gemfile", "gem '#{app_path}', path: '../' # git: '...'"
-end
-
+# Add gem to main app Gemfile
+append_to_file "../../Gemfile", "gem '#{name}', path: '#{app_path}'"
 
 # Uses Chili::ApplicationController and the layout from the main app
-remove_dir "app/controllers/#{app_path}"
-remove_dir "app/helpers/#{app_path}"
+remove_dir "app/controllers/#{name}"
+remove_dir "app/helpers/#{name}"
 remove_dir 'app/views/layouts'
 
 # Uses Gemfile from main app
@@ -29,50 +20,23 @@ remove_file 'Gemfile'
 
 # Replace Rakefile
 remove_file 'Rakefile'
-create_file 'Rakefile' do <<-RUBY
-#!/usr/bin/env rake
-APP_RAKEFILE = File.expand_path("../main_app/Rakefile", __FILE__)
-require 'chili/tasks'
-RUBY
-end
 
 # Remove jquery stuff from application.js
-gsub_file "app/assets/javascripts/#{app_path}/application.js", "//= require jquery_ujs\n", ''
-gsub_file "app/assets/javascripts/#{app_path}/application.js", "//= require jquery\n", ''
+gsub_file "app/assets/javascripts/#{name}/application.js", "//= require jquery_ujs\n", ''
+gsub_file "app/assets/javascripts/#{name}/application.js", "//= require jquery\n", ''
 
 # Setup custom generator
-inject_into_file "lib/#{app_path}/engine.rb", :after => "isolate_namespace #{app_path.camelcase}\n" do <<-RUBY
+inject_into_file "lib/#{name}/engine.rb", after: "isolate_namespace #{name.camelcase}\n" do <<-RUBY
     config.generators do |g|
       g.scaffold_controller :chili
     end
 RUBY
 end
 
-# Setup rspec
+# Remove dummy stuff
 remove_dir 'test'
-create_file 'spec/spec_helper.rb' do <<-RUBY
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path("../../main_app/config/environment", __FILE__)
-require 'rspec/rails'
-require 'rspec/autorun'
-
-ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
-
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories in both main app and the extension.
-Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f }
-Dir[File.join(ENGINE_RAILS_ROOT, "spec/support/**/*.rb")].each {|f| require f }
-RUBY
-end
-
-append_to_file 'Rakefile' do <<-RUBY
-
-# Default rake task to rspec
-task default: 'app:spec'
-RUBY
-end
 
-inject_into_file "lib/#{app_path}/engine.rb", :after => " g.scaffold_controller :chili\n" do <<-RUBY
+inject_into_file "lib/#{name}/engine.rb", :after => " g.scaffold_controller :chili\n" do <<-RUBY
       g.test_framework :rspec, view_specs: false, routing_specs: false, controller_specs: false
       g.integration_tool :rspec
 RUBY
@@ -82,17 +46,17 @@ end
 gsub_file ".gitignore", /test\/dummy.*\n/, ''
 
 # Automount engine
-prepend_to_file 'config/routes.rb', "#{app_path.camelcase}::Engine.automount!\n"
+prepend_to_file 'config/routes.rb', "#{name.camelcase}::Engine.automount!\n"
 
 # Include chili libs
-prepend_to_file "lib/#{app_path}.rb" do <<-RUBY
+prepend_to_file "lib/#{name}.rb" do <<-RUBY
 require "chili"
 RUBY
 end
 
 
 # Include active_if
-inject_into_file "lib/#{app_path}.rb", :after => "module #{app_path.camelcase}\n" do <<-RUBY
+inject_into_file "lib/#{name}.rb", :after => "module #{name.camelcase}\n" do <<-RUBY
   extend Chili::Activatable
   active_if { logged_in? }
 RUBY
@@ -103,8 +67,8 @@ example_file_path = "app/overrides/layouts/application/example.html.erb.deface"
 create_file example_file_path do <<-RUBY
 <!-- insert_bottom 'body' -->
 <div style='background: #FFF;text-align: center; padding: 4px 0;position: fixed;width: 100%;z-index: 9999;top: 0;'>
-  #{app_path} active - edit/remove this file:<br/>
-  <strong>#{example_file_path}</strong><br/>
+  #{name} active - edit/remove this file:<br/>
+  <strong>#{app_path}/#{example_file_path}</strong><br/>
   <%= link_to 'deface docs', 'https://github.com/railsdog/deface', target: '_blank' %>
 </div>
 RUBY

data/lib/chili/version.rb

@@ -1,3 +1,3 @@
 module Chili
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/bin/chili_spec.rb

@@ -3,20 +3,21 @@ require 'spec_helper'
 describe 'Chili Binary' do
   describe 'chili EXTENSION_NAME' do
     let(:chili) { File.expand_path("../../../bin/chili", __FILE__) }
-    let(:result_path) { File.expand_path("../../result/", __FILE__) }
-    let(:source_path) { File.expand_path("../../dummy/chili_template", __FILE__) }
+    let(:app_path) { File.expand_path("../../dummy/example", __FILE__) }
+    let(:template_path) { File.expand_path("../../dummy/template", __FILE__) }
 
     before do
-      FileUtils.rm_rf(result_path)
-      FileUtils.mkdir(result_path)
+      FileUtils.rm_rf File.join(app_path, 'vendor/chili_template')
+      FileUtils.rm_rf File.join(app_path, 'Gemfile')
+      FileUtils.touch File.join(app_path, 'Gemfile')
     end
 
     it 'creates a new extension with a correct file structure' do
-      `cd #{result_path} && MAIN_APP= #{chili} template`
+      `cd #{app_path} && #{chili} template`
 
-      Dir.glob(File.join(source_path, "**/*")).reject { |f| File.directory?(f) }.each do |source|
-        result = File.join(result_path, 'chili_template', source.sub(source_path, ''))
-        File.open(source, 'rb').read.should == File.open(result, 'rb').read
+      Dir.glob(File.join(template_path, "**/*")).reject { |f| File.directory?(f) }.each do |source|
+        result = File.join(app_path, 'vendor/chili_template', source.sub(template_path, ''))
+        File.open(result, 'rb').read.should == File.open(source, 'rb').read
       end
     end
   end

data/spec/dummy/{main_app → example}/config/boot.rb

@@ -8,4 +8,4 @@ if File.exist?(gemfile)
 end
 
 $:.unshift File.expand_path('../../../../../lib', __FILE__)
-$:.unshift File.expand_path('../../../../../spec/dummy/chili_social/lib', __FILE__)
+$:.unshift File.expand_path('../../vendor/chili_social/lib', __FILE__)