chili 0.0.1 → 0.0.2

data/README.md

@@ -2,12 +2,6 @@
 
 The spicy extension framework
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'chili'
-
 ## Roadmap
 
 ### Core features
@@ -20,22 +14,101 @@ Unobtrusively(!)...
 - 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
 
-### Utility features
-
-- make request specs understand paths
-- documentation
-
 ### Obstacles
 
-- resource route generator adds routes both to engine and main routes file
+- Resource route generator adds routes both to engine and main routes file
 - Deface caches overrides in production. Monkey patch?
-- Have to add gemspec to main app
 
 ### 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
-- Where to get the database.yml file from?
-- Rspec generators don't namespace properly
 - Need to use DSL branch from deface
+- Have to restart server when adding overrides
+- Request specs don't have access to path helpers
+
+## Docs...
+
+### Creating a new chili extension
+
+Assuming you want to add a new extension that adds "like" capabilities to a subset of users, run:
+
+    chili likes
+
+This is basically a shortcut for running the rails engine generator with
+a custom template:
+
+    rails plugin new chili_likes --mountable -m https://raw.github.com/balvig/chili/master/lib/chili/template.rb
+
+### Prepare main app
+
+- 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
+
+### Setting up activation conditions
+
+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.
+
+```ruby
+# lib/chili_likes.rb
+module ChiliLikes
+  extend Chili::Activatable
+  active_if { logged_in? && current_user.admin? } # Extension is only visible to logged in admin users
+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`:
+
+```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 %>
+```
+
+### 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_extension/likes` if 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
+
+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:
+
+```ruby
+# app/model/chili_likes/user.rb
+module ChiliLikes
+  class User < ::User
+    has_many :likes
+  end
+end
+```
+
+Access through the namespaced model:
+
+```erb
+<%= ChiliLikes::User.first.likes %>
+<%= current_user.becomes(ChiliLikes::User).likes %>
+```
+
+### Adding new stylesheets/javascripts
+
+Add files as usual in `app/assets/chili_likes/javascripts|stylesheets` and inject them into the layout using an override:
+
+```erb
+<% # app/overrides/layouts/application/chili_likes.html.erb.deface %>
+<!-- insert_bottom 'head' -->
+<%= stylesheet_link_tag 'chili_likes/application' %>
+<%= javascript_include_tag 'chili_likes/application' %>
+```

data/bin/chili

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+system "rails plugin new chili_#{ARGV.first} --mountable -m https://raw.github.com/balvig/chili/master/lib/chili/template.rb"

data/lib/chili/template.rb

@@ -1,6 +1,6 @@
 # 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 located?")
+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"
 

data/lib/chili/version.rb

@@ -1,3 +1,3 @@
 module Chili
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chili
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-09 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies: []
 description: The spicy extension framework (work in progress)
 email:
 - jens@balvig.com
-executables: []
+executables:
+- chili
 extensions: []
 extra_rdoc_files: []
 files:
@@ -24,6 +25,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/chili/application_controller.rb
+- bin/chili
 - chili.gemspec
 - lib/chili.rb
 - lib/chili/activatable.rb
@@ -46,21 +48,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1639324054153659084
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1639324054153659084
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: The spicy extension framework (work in progress)