chili 0.0.4 → 0.0.5

data/.gitignore

@@ -12,7 +12,9 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/tmp
-test/version_tmp
+spec/dummy/main_app/db/*.sqlite3
+spec/dummy/main_app/log/*.log
+spec/dummy/main_app/tmp/
+spec/dummy/main_app/.sass-cache
 tmp
-.DS_Store
+.DS_Store

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in chili.gemspec
 gemspec
 gem 'rake'
+gem 'deface', git: 'git://github.com/railsdog/deface.git', branch: 'dsl'

data/README.md

@@ -1,56 +1,35 @@
 # Chili
 
-The spicy extension framework
+Have you ever wanted to test out a new feature on only a subset of users?
+Did that implementation end up being lots of if/else statements embedded in the main code?
+If so, Chili can help.
 
-## Roadmap
-
-### Core features
+Chili is built on top of Rails Engines and Deface and allows you to conditionally add new/modify existing views,
+while leaving the main code untouched.
 
-Unobtrusively(!)...
+## Installation
 
-- add new models `done`
-- add new tables/migrations `done`
-- add new controllers and show/hide conditionally `done`
-- add new views and show/hide conditionally `done`
-- conditionally add to/edit existing views `done`
-- add methods to existing models `done`
-- add new stylesheets and javascripts `done`
-- modify existing controller actions
+Install Chili on your system (not in your app!):
 
-### Obstacles
+    gem install chili
 
-- Deface caches overrides in production. Monkey patch?
+## Usage
 
-### Minor niggles
-
-- Have to add gemspec to main app
-- Can only have one override per engine per partial due to the way I'm grabbing the class from the override
-- Need to use DSL branch from deface
-- Have to restart server when adding overrides
-- Request specs don't have access to path helpers
-
-## Docs...
+Just like engines chili extensions are like mini apps that are created separately from the main app using the "chili" command.
 
 ### Creating a new chili extension
 
-Assuming you want to add a new extension that adds "like" capabilities to a subset of users, run:
+Assuming you want to add a new extension that adds exposes a new "like" button feature to a subset of users, first run:
 
     chili likes
 
-This is basically a shortcut for running the `rails plugin new` engine generator with a custom template.
-
-The script will prompt you for the location of your main app repository to which you are adding the chili extension.
-The repo will be added as a submodule in the main_app directory.
-
-### Prepare main app
+This is basically a shortcut for running the `rails plugin new` engine generator with a custom template and will:
 
-- make sure that shared views (f.ex layouts) uses `main_app.` prefix for routes
-- add `gem 'deface', git: 'git://github.com/railsdog/deface.git', branch: 'dsl'` to Gemfile
-- add `gemspec path: '../'` to Gemfile
-- bundle
-- set up database
+1. Create a directory named chili_likes containing the basic structure for the extension
+2. Clone the app you are adding the extension to as a submodule into chili_likes/main_app
+3. Add a reference to the extensions gemspec to the main app gemfile for testing
 
-### Setting up activation conditions
+### Define who can see the extension
 
 Use the active_if block to control whether new controllers/overrides are visible or not.
 The context of the active_if block is the application controller so you can use any methods available to that.
@@ -65,19 +44,19 @@ end
 
 ### Modifying view templates in main app
 
-See [deface docs](https://github.com/railsdog/deface#readme) for details.
-As an example, assuming the main app has a partial at `app/views/posts/_post.html.erb`:
+Chili uses deface to modify existing view templates (see [deface docs](https://github.com/railsdog/deface#readme) for details)
+Add an override with the same name as the extension. As an example, assuming the main app has the partial `app/views/posts/_post.html.erb`:
 
 ```erb
-<% # app/overrides/posts/_post/chili_likes.html.erb.deface (folder should mimic main app view path) %>
-<!-- insert_bottom 'li' -->
-<%= link_to 'Show likes', chili_likes.likes_path %>
+<% # app/overrides/posts/_post/chili_likes.html.erb.deface (folder should mirror main app view path) %>
+<!-- insert_bottom 'tr' -->
+<td><%= link_to 'Like!', chili_likes.likes_path(like: {post_id: post}), method: :post %></td>
 ```
 
 ### Adding new resources
 
 Use `rails g scaffold Like` as usual when using engines. The new resource will be namespaced to ChiliLikes::Like
-and automounted in the main app at `/chili_likes/likes`, but only accessible when active_if is true. 
+and automounted in the main app at `/chili_likes/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.
 
 ### Modifying existing models
@@ -112,7 +91,20 @@ Add files as usual in `app/assets/chili_likes/javascripts|stylesheets` and injec
 <%= javascript_include_tag 'chili_likes/application' %>
 ```
 
-## Gotchas
+### 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.
-- Just like normal engines, Chili requires you to prepend path helpers with `main_app` (ie `main_app.root_path` etc) in view templates that are shared with the main app (such as the main app's application layout file).
+- Just like normal engines, Chili requires you to prepend path helpers with `main_app` (ie `main_app.root_path` etc) in view templates that are shared with the main app (such as the main app's application layout file).
+
+## Roadmap
+
+### Current Issues
+
+- Can only have one override per engine per partial due to the way I'm grabbing the class from the override
+- Haven't found a good way to modify existing controller actions
+- Need to use DSL branch from deface
+
+### Minor niggles
+
+- Have to add gemspec to main app
+- Request specs don't have access to path helpers

data/chili.gemspec

@@ -14,4 +14,11 @@ Gem::Specification.new do |gem|
   gem.name          = "chili"
   gem.require_paths = ["lib"]
   gem.version       = Chili::VERSION
+
+  gem.add_dependency "rails", "~> 3.2.3"
+  gem.add_development_dependency 'rspec', '2.9.0'
+  gem.add_development_dependency 'rspec-rails', '2.9.0'
+  gem.add_development_dependency 'jquery-rails'
+  gem.add_development_dependency 'capybara'
+  gem.add_development_dependency "sqlite3"
 end

data/lib/chili/template.rb

@@ -1,8 +1,19 @@
 # Add main app as submodule
 # For some reason root when using git method is test/dummy so doing this manually
-main_app_git_repo = ask("Where is the main app repository located?")
-run "cd #{destination_root} && git init"
-run "cd #{destination_root} && git submodule add #{main_app_git_repo}  main_app"
+main_app_git_repo = 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"
+end
+
+# Add gemspec and deface branch to  main app Gemfile
+append_to_file "main_app/Gemfile" do <<-RUBY
+
+# Chili dev dependencies
+gemspec path: '../'
+gem 'deface', git: 'git://github.com/railsdog/deface.git', branch: 'dsl'
+RUBY
+end
 
 # Uses Chili::ApplicationController and the layout from the main app
 remove_dir "app/controllers/#{app_path}"
@@ -78,10 +89,13 @@ RUBY
 end
 
 # Add dummy override
-create_file "app/overrides/layouts/application/#{app_path}.html.erb.deface" do <<-RUBY
+example_file_path = "app/overrides/layouts/application/#{app_path}.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} activated - <%= link_to 'deface docs', 'https://github.com/railsdog/deface', target: '_blank' %>
+  #{app_path} active - edit/remove this file:<br/>
+  <strong>#{example_file_path}</strong><br/>
+  <%= link_to 'deface docs', 'https://github.com/railsdog/deface', target: '_blank' %>
 </div>
 RUBY
 end

data/lib/chili/version.rb

@@ -1,3 +1,3 @@
 module Chili
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/dummy/chili_likes/app/assets/javascripts/chili_likes/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/chili_likes/app/assets/stylesheets/chili_likes/application.css.scss

@@ -0,0 +1,7 @@
+ol.ingredients li {
+  height: 60px;
+  img {
+    float:right;
+    height:60px;
+  }
+}

data/spec/dummy/chili_likes/app/controllers/chili_likes/likes_controller.rb

@@ -0,0 +1,14 @@
+module ChiliLikes
+  class LikesController < Chili::ApplicationController
+
+    def index
+      @likes = current_user.becomes(ChiliLikes::User).likes
+    end
+
+    def create
+      @like = current_user.becomes(ChiliLikes::User).likes.create!(params[:like])
+      redirect_to :back, notice: 'Post liked!'
+    end
+
+  end
+end

data/spec/dummy/chili_likes/app/models/chili_likes/like.rb

@@ -0,0 +1,7 @@
+module ChiliLikes
+  class Like < ActiveRecord::Base
+    belongs_to :post
+
+    attr_accessible :post_id
+  end
+end

data/spec/dummy/chili_likes/app/models/chili_likes/post.rb

@@ -0,0 +1,9 @@
+module ChiliLikes
+  class Post < ::Post
+    has_many :likes
+
+    def well_liked?
+      likes.size >= 3
+    end
+  end
+end

data/spec/dummy/chili_likes/app/models/chili_likes/user.rb

@@ -0,0 +1,5 @@
+module ChiliLikes
+  class User < ::User
+    has_many :likes
+  end
+end

data/spec/dummy/chili_likes/app/overrides/layouts/application/chili_likes.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_bottom 'head' -->
+<%# stylesheet_link_tag 'chili_likes/application' %>

data/spec/dummy/chili_likes/app/overrides/posts/_post/chili_likes.html.erb.deface

@@ -0,0 +1,6 @@
+<!-- insert_bottom 'tr' -->
+<% post.becomes(ChiliLikes::Post).tap do |post| %>
+  <td><%= link_to 'Like!', chili_likes.likes_path(like: {post_id: post}), method: :post %></td>
+  <td><%= pluralize post.likes.size, 'like' %></td>
+  <td><%= post.well_liked? ? 'This post is well liked!' : 'This post is boring...' %></td>
+<% end %>

data/spec/dummy/chili_likes/app/overrides/posts/index/chili_likes.html.erb.deface

@@ -0,0 +1,2 @@
+<!-- insert_before '#posts' -->
+<%= link_to 'See Your Likes', chili_likes.likes_path %>

data/spec/dummy/chili_likes/app/views/chili_likes/likes/index.html.erb

@@ -0,0 +1,9 @@
+<h1>Your Likes</h1>
+
+<ul>
+<% @likes.each do |like| %>
+  <li><%= like.created_at.to_date %> - <%= like.post.title %></li>
+<% end %>
+</ul>
+
+<%= link_to 'Go Back', main_app.posts_path %>

data/spec/dummy/chili_likes/config/routes.rb

@@ -0,0 +1,4 @@
+ChiliLikes::Engine.automount!
+ChiliLikes::Engine.routes.draw do
+  resources :likes
+end

data/spec/dummy/chili_likes/db/migrate/20120513031021_create_chili_likes_likes.rb

@@ -0,0 +1,10 @@
+class CreateChiliLikesLikes < ActiveRecord::Migration
+  def change
+    create_table :chili_likes_likes do |t|
+      t.integer :post_id
+      t.integer :user_id
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/chili_likes/lib/chili_likes.rb

@@ -0,0 +1,7 @@
+require "chili"
+require "chili_likes/engine"
+
+module ChiliLikes
+  extend Chili::Activatable
+  active_if { logged_in? && current_user.admin? }
+end

data/spec/dummy/chili_likes/lib/chili_likes/engine.rb

@@ -0,0 +1,10 @@
+module ChiliLikes
+  class Engine < ::Rails::Engine
+    isolate_namespace ChiliLikes
+    config.generators do |g|
+      g.scaffold_controller :chili
+      g.test_framework :rspec, view_specs: false, routing_specs: false, controller_specs: false
+      g.integration_tool :rspec
+    end
+  end
+end

data/spec/dummy/main_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.