chili 1.0.1 → 2.0.0

data/.gitignore

@@ -12,13 +12,13 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-spec/dummy/example_app/db/*.sqlite3
-spec/dummy/example_app/log/*.log
-spec/dummy/example_app/tmp/
-spec/dummy/example_app/.sass-cache
-spec/dummy/example_app/vendor/chili/blank_extension
-spec/dummy/example_app/vendor/chili/another_blank_extension
-spec/dummy/example_app/Gemfile
+spec/example_app/db/*.sqlite3
+spec/example_app/log/*.log
+spec/example_app/tmp/
+spec/example_app/.sass-cache
+spec/dummy/app/Gemfile
+spec/dummy/app/log/
+spec/dummy/app/lib/
 tmp
 .DS_Store
 .pt

data/README.md

@@ -28,32 +28,32 @@ and run `bundle`.
 
 ## Usage
 
-Chili extensions are like mini apps that are created inside your main app's vendor directory using using the "chili" generator.
+Chili features are like mini apps that are created inside your main app's lib/chili directory using using the "chili" generator.
 
-### Creating a new chili extension
+### Creating a new chili feature
 
-As an example, assuming you want to add a new extension named "social" that exposes a new feature in the form of a like-button
+As an example, assuming you want to add a beta feature named "social" that shows a new like-button
 to a subset of users, first within your main app run:
 
-    $ rails g chili:extension social
+    $ rails g chili:feature social
 
 This will:
 
-1. Create the directory `vendor/chili/social_extension` containing the basic structure for the extension
-2. Add a reference to the extension to the main app gemfile
+1. Create the directory `lib/chili/social_feature` containing the basic structure for the feature
+2. Add a reference to the feature to the main app gemfile
 
-Since the extension is mounted as a gem you'll have to restart the app.
+Since the feature is mounted as a gem you'll have to restart the app.
 
-### Define who can see the extension
+### Define who can see the feature
 
-Use the active_if block to control whether new the extension is active for each user.
+Use the active_if block to control whether new the feature is active for each user.
 The context of the active_if block is the application controller so you can use any methods available to that.
 
 ```ruby
-# lib/social_extension.rb
-module SocialExtension
+# lib/social_feature.rb
+module SocialFeature
   extend Chili::Activatable
-  active_if { logged_in? && current_user.admin? } # Extension is only visible to logged in admin users
+  active_if { logged_in? && current_user.admin? } # Feature is only visible to logged in admin users
 end
 ```
 
@@ -66,56 +66,61 @@ For example, assuming the main app has the partial `app/views/posts/_post.html.e
 ```erb
 <% # app/overrides/posts/_post/like_button.html.erb.deface (folder should mirror main app view path) %>
 <!-- insert_bottom 'tr' -->
-<td><%= link_to 'Like!', social_extension.likes_path(like: {post_id: post}), method: :post %></td>
+<td><%= link_to 'Like!', social_feature.likes_path(like: {post_id: post}), method: :post %></td>
 ```
 
 ### Adding new resources
 
-Run `rails g scaffold Like` from within the extension's directory. The new resource will be namespaced to `SocialExtension::Like`
-and automounted as an [isolated engine](http://railscasts.com/episodes/277-mountable-engines?view=asciicast) in the main app at `/chili/social_extension/likes`, 
+You can run the usual Rails generators for each feature by prepending
+the generator with the name of the feature:
+
+```bash
+$ rails g social_feature scaffold Like
+```
+
+The new resource will be namespaced to `SocialFeature::Like` and automounted as an [isolated engine](http://railscasts.com/episodes/277-mountable-engines?view=asciicast) in the main app at `/chili/social_feature/likes`,
 but will only be accessible when active_if is true.
 
 ### Migrations
 
 Migrations are handled the same way as engines. Use the
-following commands after you've added a new migration to your extension:
+following commands after you've added a new migration to a feature:
 
-    $ rake social_extension:migrations:install
+    $ rake social_feature:migrations:install
     $ rake db:migrate
 
 ### Modifying existing models
 
-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:
+Create a model with the same name as the one you want to modify by running: `rails g social_feature model User --migration=false` and edit it to inherit from the original:
 
 ```ruby
-# app/models/social_extension/user.rb
-module SocialExtension
+# app/models/social_feature/user.rb
+module SocialFeature
   class User < ::User
     has_many :likes
   end
 end
 ```
 
-Access in your overrides/extension views through the namespaced model:
+Access in your overrides/feature views through the namespaced model:
 
 ```erb
-<%= SocialExtension::User.first.likes %>
-<%= current_user.becomes(SocialExtension::User).likes %>
+<%= SocialFeature::User.first.likes %>
+<%= current_user.becomes(SocialFeature::User).likes %>
 ```
 
 ### Stylesheets/javascripts
 
-Files added to the extension's `app/assets/social_extension/javascripts|stylesheets` directory are automatically injected into the layout using a pre-generated override:
+Files added to the feature's `app/assets/social_feature/javascripts|stylesheets` directory are automatically injected into the layout using a pre-generated override:
 
 ```erb
 <% # app/overrides/layouts/application/assets.html.erb.deface %>
 <!-- insert_bottom 'head' -->
-<%= stylesheet_link_tag 'social_extension/application' %>
-<%= javascript_include_tag 'social_extension/application' %>
+<%= stylesheet_link_tag 'social_feature/application' %>
+<%= javascript_include_tag 'social_feature/application' %>
 ```
 
-If you don't need any css/js in your extension, you can remove this file.
+If you don't need any css/js in your feature, you can remove this file.
 
 ## Gotchas
 

data/Rakefile

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

data/app/controllers/chili/application_controller.rb

@@ -1,10 +1,10 @@
 module Chili
   class ApplicationController  < ::ApplicationController
-    before_filter :activate_extension
+    before_filter :activate_feature
 
     private
-    def activate_extension
-      raise ActionController::RoutingError, 'Extension Disabled' unless self.class.parent.active?(self)
+    def activate_feature
+      raise ActionController::RoutingError, 'Feature Disabled' unless self.class.parent.active?(self)
     end
   end
 end

data/chili.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/chili/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Jens Balvig"]
   gem.email         = ["jens@balvig.com"]
-  gem.description   = %q{The spicy extension framework}
-  gem.summary       = %q{The spicy extension framework}
+  gem.description   = %q{The spicy feature toggle framework}
+  gem.summary       = %q{The spicy feature toggle framework}
   gem.homepage      = "http://balvig.github.com/chili/"
 
   gem.files         = `git ls-files`.split($\)
@@ -22,5 +22,5 @@ Gem::Specification.new do |gem|
   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"
+  gem.add_development_dependency 'sqlite3'
 end

data/lib/chili.rb

@@ -1,7 +1,9 @@
 require "deface"
-require "chili/version"
-require "chili/engine"
-require "chili/overrides"
 require "chili/activatable"
 require "chili/bundler"
+require "chili/engine"
 require "chili/extensions/rails/engine"
+require "chili/feature"
+require "chili/overrides"
+require "chili/version"
+require "generators/chili/generator_proxy"

data/lib/chili/feature.rb

@@ -0,0 +1,15 @@
+module Chili
+  class Feature
+    def initialize(short_name)
+      @short_name = short_name
+    end
+
+    def name
+      @short_name.to_s.underscore.gsub('_feature','') + '_feature'
+    end
+
+    def path
+      "lib/chili/#{name}"
+    end
+  end
+end

data/lib/chili/version.rb

@@ -1,3 +1,3 @@
 module Chili
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/generators/chili/feature/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate a new chili feature
+
+Example:
+    rails generate chili:feature social
+
+    This will create:
+        basic chili feature structure in vendor/chili/social_feature

data/lib/generators/chili/{extension_generator.rb → feature/feature_generator.rb}

@@ -1,12 +1,10 @@
 module Chili
   module Generators
-    class ExtensionGenerator < Rails::Generators::NamedBase
-      NAME = "#{ARGV[0]}_extension"
-      PATH = "vendor/chili/#{NAME}"
+    class FeatureGenerator < Rails::Generators::NamedBase
 
       def run_plugin_generator
-        ARGV[0] = PATH
-        ARGV[1] = "--mountable"
+        ARGV[0] = feature.path
+        ARGV[1] = '--mountable'
         ARGV[2] = '--skip-test-unit'
         ARGV[3] = '--skip-bundle'
 
@@ -20,9 +18,9 @@ module Chili
       end
 
       def edit_gemspec
-        require File.expand_path('../../../chili/version', __FILE__)
-        gemspec = "#{NAME}.gemspec"
-        gsub_file gemspec, '# s.add_dependency "jquery-rails"', "s.add_dependency 'chili', '~> #{Chili::VERSION}'"
+        require File.expand_path('../../../../chili/version', __FILE__)
+        gemspec = "#{feature.name}.gemspec"
+        gsub_file gemspec, '# s.add_dependency "jquery-rails"', "s.add_dependency 'chili', '~> #{Chili::VERSION.sub(/\.\d+$/,'')}'"
         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)?/, ''
@@ -32,38 +30,25 @@ module Chili
         gemfile =  "../../../Gemfile"
         group = "group :chili do\n"
         append_to_file gemfile, group
-        append_to_file gemfile, "  gem '#{NAME}', path: '#{PATH}'\nend", after: group
+        append_to_file gemfile, "  gem '#{feature.name}', path: '#{feature.path}'\nend", after: group
         gsub_file gemfile, 'end  gem', '  gem' #nasty cleanup
       end
 
       def remove_unused_files
-        remove_dir "app/controllers/#{NAME}"
-        remove_dir "app/helpers/#{NAME}"
+        remove_dir "app/helpers/#{feature.name}"
         remove_dir 'app/views/layouts'
+        remove_dir 'script'
         remove_file 'Gemfile'
         remove_file 'Rakefile'
       end
 
       def remove_jquery_stuff
-        gsub_file "app/assets/javascripts/#{NAME}/application.js", "//= require jquery_ujs\n", ''
-        gsub_file "app/assets/javascripts/#{NAME}/application.js", "//= require jquery\n", ''
+        gsub_file "app/assets/javascripts/#{feature.name}/application.js", "//= require jquery_ujs\n", ''
+        gsub_file "app/assets/javascripts/#{feature.name}/application.js", "//= require jquery\n", ''
       end
 
-      def set_up_custom_generator
-        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
-      end
-
-      def set_up_rspec
-        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
-        end
+      def chilify_application_controller
+        gsub_file "app/controllers/#{feature.name}/application_controller.rb", "ActionController::Base", 'Chili::ApplicationController'
       end
 
       def clean_up_gitignore
@@ -71,17 +56,17 @@ module Chili
       end
 
       def automount_engine
-        prepend_to_file 'config/routes.rb', "#{NAME.camelcase}::Engine.automount!\n"
+        prepend_to_file 'config/routes.rb', "#{feature.name.camelcase}::Engine.automount!\n"
       end
 
       def include_chili_libs
-        prepend_to_file "lib/#{NAME}.rb", "require \"chili\"\n"
+        prepend_to_file "lib/#{feature.name}.rb", "require \"chili\"\n"
       end
 
       def include_active_if
-        inject_into_file "lib/#{NAME}.rb", after: "module #{NAME.camelcase}\n" do <<-RUBY
+        inject_into_file "lib/#{feature.name}.rb", after: "module #{feature.name.camelcase}\n" do <<-RUBY
   extend Chili::Activatable
-  active_if { true } # edit this to activate/deactivate extension at runtime
+  active_if { true } # edit this to activate/deactivate feature at runtime
         RUBY
         end
       end
@@ -91,8 +76,8 @@ module Chili
         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;'>
-  #{NAME} active - edit/remove this file:<br/>
-  <strong>#{PATH}/#{example_file_path}</strong><br/>
+  #{feature.name} active - edit/remove this file:<br/>
+  <strong>#{feature.path}/#{example_file_path}</strong><br/>
   <%= link_to 'deface docs', 'https://github.com/spree/deface', target: '_blank' %>
 </div>
         RUBY
@@ -102,12 +87,26 @@ module Chili
       def add_assets_override
         create_file 'app/overrides/layouts/application/assets.html.erb.deface' do <<-RUBY
 <!-- insert_bottom 'head' -->
-<%= stylesheet_link_tag '#{NAME}/application' %>
-<%= javascript_include_tag '#{NAME}/application' %>
+<%= stylesheet_link_tag '#{feature.name}/application' %>
+<%= javascript_include_tag '#{feature.name}/application' %>
         RUBY
         end
       end
-    end
 
+      def add_generator_proxy
+        create_file "lib/generators/#{feature.name}_generator.rb" do <<-RUBY
+class #{feature.name.camelcase}Generator < Rails::Generators::Base
+  include Chili::GeneratorProxy
+end
+        RUBY
+        end
+      end
+
+      protected
+
+      def feature
+        @feature ||= Chili::Feature.new(ARGV[0])
+      end
+    end
   end
 end

data/lib/generators/chili/generator_proxy.rb

@@ -0,0 +1,20 @@
+module Chili
+  module GeneratorProxy
+    def self.included(base)
+      base.class_eval do
+        argument :generator, type: :string
+        argument :generator_options, type: :array, default: [], banner: "GENERATOR_OPTIONS"
+
+        def self.desc
+          "Generates resources (scaffold, model, migration etc) for #{generator_name}"
+        end
+
+        def delegate
+          engine = self.class.generator_name.classify.constantize
+          Rails::Generators.namespace = engine
+          Rails::Generators.invoke ARGV.shift, ARGV, destination_root: Feature.new(engine).path, behavior: behavior
+        end
+      end
+    end
+  end
+end

data/spec/dummy/app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "chili"
+Dir.glob(File.expand_path('../../lib/chili/*', __FILE__)).each do |dir|
+  require File.basename(dir)
+end
+
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/spec/dummy/{example_app → app}/config/boot.rb

@@ -8,5 +8,4 @@ if File.exist?(gemfile)
 end
 
 $:.unshift File.expand_path('../../../../../lib', __FILE__)
-$:.unshift File.expand_path('../../vendor/chili/social_extension/lib', __FILE__)
-$:.unshift File.expand_path('../../vendor/chili/invites_extension/lib', __FILE__)
+$:.unshift File.expand_path('../../lib/chili/blank_feature/lib', __FILE__)

data/spec/dummy/blank_feature/README.rdoc

@@ -0,0 +1,3 @@
+= BlankFeature
+
+This project rocks and uses MIT-LICENSE.

data/spec/dummy/blank_feature/app/controllers/blank_feature/application_controller.rb

@@ -0,0 +1,4 @@
+module BlankFeature
+  class ApplicationController < Chili::ApplicationController
+  end
+end